3.3.11. Advanced reports – Earthworm

The list of requirements connected with other requirements by means of aggregation.

3.3.11.1. Detailed description

The report is used to list the indicated requirements included in the repository of the Enterprise Architect project, which are connected with other requirement by means of aggregation relation.

The report is divided into sections; each section includes the main requirement and the list of requirements which are connected to it by means of aggregation relation. In turn, every requirement of such list will display you the name of the requirement, its description included in the Notebook field – the component of the Enterprise Architect tool, as well as the status, stereotype and the information whether it is the external requirement.

The report includes the view of aggregation relation in both directions from the main requirement to the aggregates of requirements and inversely from the aggregates of requirements to the main requirement.

3.3.11.2. Input parameters

Figure 77. Earthworm Report Wizard. Elements of Data for the report tab.

3.3.11.3. Required input parameters

To generate the report it is required to provide:

· List of selected requirements (at least one element of the list)

3.3.11.4. Optional input parameters

To generate the report you may indicate optionally:

· List of statuses

· List of difficulty levels

· List of priorities

· List of authors

3.3.11.5. Report’s realization

In order to generate the report select the Earthworm – List of requirements connected with other requirement by means of aggregation option from the Reporting -> Advanced reports text menu.

Step 1. Determining the Type of statuses

You must select at least one, few or all statuses which you wish to include in the report or deselect those which 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 difficulty levels

You may select one, few or all difficulty levels 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 priorities

You may select one, few or all priorities 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. 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 5. Filtering the list of objects

It is often the case that the number of requirements 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 requirements displayed in the List of objects should be smaller.

Example

For the following set of objects:

· Confirmation of rental

· Availability of the system

· Printout of confirmation of rental

If you enter the phrase “printout” in the Fragment of the name field and then click Filter button, the List of requirements will display the option:

· Printout of confirmation of rental

Step 7. Indicating the requirements for reporting

Now you have to transfer the components that you want to include in the report from the List of requirements to the List of selected requirements. 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 8. Editing the report’s 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.

Step 9. Generating the report

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

Step 10. Presenting the report

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

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

Using the tools from 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.11.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 all project’s requirements divided into sections is presented below. Each section includes the connection with the particular requirement by means of the relation aggregation, regardless of whether the requirement is its aggregate or the main requirement. Each component of the list (requirement) consists of:

· the name of the requirement

· description of the requirement

· status

· stereotype

· author of the requirement

· information if it is the external requirement

Exemplary result of the generated report is presented below.

Figure 79. Exemplary report.