3.3.02. Standard reports – Butterfly

The report displays the list of requirements with the specific properties.

3.3.2.1. Detailed description

The report is used to list the functional requirements and/or non-functional requirements included in the repository of the Enterprise Architect project.

For every requirement, the report will display you the name of the requirement, element’s description included in the Notebook field – the component of Enterprise Architect tool, the type of the requirement (if it is External requirement or not), requirement’s stereotype, the author and the requirement status.

3.3.2.2. Input parameters

Figure 50. Butterfly Report Wizard. Elements of Data for the report tab.

3.3.2.3. Required input parameters

To generate the report it is required to indicate:

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

3.3.2.4. Optional input parameters

To generate the report you may specify optionally:

· List of statuses

· List of difficulty levels

· List of priorities

· List of authors

3.3.2.5. Report’s realization

In order to generate the report, select Butterfly – Requirements according to the properties option from the Reporting -> Standard reports text menu.

Step 1. 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 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 4. Filtering the list of objects

In most cases it happens 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 requirements you may enter the phrase corresponding to the name of the requirement in the Name fragment field. After clicking Filter button, the number of objects displayed in the List of requirements should be smaller.

Example

For the following set of requirements:

· Searching the cars

· KK verification

· Price list

· Vehicle Card

· Register of renting

· Types of Interface

· Confirmation of renting

· System availability

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

· KK verification

· Vehicle Card

Step 6. Indicating the objects for reporting

Now you have to transfer the requirements 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 7. Edition of 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 8. Generating the report

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

Step 9. Presenting the report

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

Figure 51. Toolbar of the Report 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.2.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 requirements is presented below. Each element of this list consists of:

· name of the requirement

· description of the requirement

· type of the requirement (if it is the External requirement)

· requirement’s stereotype

· author

· status of the requirement

Figure 52. Exemplary Butterfly report.