The report displays the specification of use cases.

3.3.8.1. Detailed description

The report is used to list all use cases together with their specification included in the repository of the Enterprise Architect project.

For every use case, the report will display the name of the use case, its description included in the Notebook field – the component of Enterprise Architect tool as well as the use case specification.

Use case specification often includes the basic scenario of use case realization as well as the alternative scenarios.

3.3.8.2. Input parameters

clip_image002[1]

Figure 68. Ladybird Report Wizard. Elements of Data for the report tab.

3.3.8.3. Required input parameters

To generate the report it is required to provide:

· List of selected objects – use cases (at least one element of the list)

3.3.8.4. Optional input parameters

To generate the report you may indicate optionally:

· List of stereotypes

· List of statuses

· List of authors

3.3.8.5. Report’s realization

In order to generate the report select the Ladybird – Use case properties option from the Reporting -> Standard reports text menu.

Step 1. Determining the List of stereotypes

You may select one, few or all stereotypes in order to include them in the report or deselect them when you do not wish to include them in the report. The method of using the functionality of the form element has been described in section 3.2.1 Functionality of the lists.

Step 2. Determining the List of statuses

You may select one, few or all statuses in order to include them in the report or deselect them when you do not wish to include them in the report. The method of using the functionality of the form element has been described in section 3.2.1 Functionality of the lists.

Step 3. Determining the List of authors

You may select one, few or all authors in order to include them in the report or deselect them when you do not wish to include them in the report. The method of using the functionality of the form element has been described in section 3.2.1 Functionality of the lists.

Step 4. Filtering the list of objects

It is often the case that the number of components in the project’s repository from which the report may be generated is so big that you may find it difficult to find the elements that are interesting for you and which are to be contained in the report. In order to filter these components, you may enter the phrase corresponding to the name of the object in the Name fragment field. After clicking Filter button, the number of components displayed in the List of objects should be smaller.

Example

For the following set of objects:

· Book a vehicle

· Rent the vehicle

· Verify the Credit Card

· Manage the vehicle

· Add new car

· Book a car

· Charge the account

If you enter the phrase “vehicle” in the Name Fragment field and click Filter button, the List of objects will display:

· Book a vehicle

· Rent the vehicle

· Manage the vehicle

Step 5. Indicating the objects for reporting

Now you have to transfer the components that you want to include in the report from the List of objects to the List of selected objects. The method of using the functionality of the form element has been described in the section 3.1.1. Tab: Data for the report.

Step 6. Edition of the report’ description

You may also edit few displayed parameters of the report in the Report’s description tab. You may propose other values for: report’s title, author’s name, date of generation, version or report’s description here.

Step7. Generating the report

The last step is to click Generate the report button. You should receive your report after a while.

Step 8. Presenting the report

Generated report is displayed in the new Report’s preview window.

clip_image004[1]

Figure 69. Toolbar of the Report’s preview window.

Using the tools placed in the toolbar on the top of the screen you may save the copy of the report in one of the following formats:

· Jasper Reports

· PDF

· RTF

· ODT

· DOCX

· HTML

· XLS

· CSV

· XML

· Embedded Images XML

What is more, the tools of the Report’s preview allow you to print the report, display the pages of the report, adjust the report to the window or scale the size of the displayed report.

3.3.8.6. Result

The first page of the report includes the following information:

· version of the report

· title of the report

· date of creation

· name of the author

· description of the report

The list of use cases is presented below. Each element of this list consists of:

· name of the use case

· short description of the use case

· use case specification

  • basic scenario
  • alternative scenarios

Exemplary result of the generated report is presented below.

clip_image006[1]

Figure 70. Exemplary Ladybird report.