3.3.01. Standard reports – Termite

The report includes the list of use cases together with the detailed description of the realized (mapped) requirements.

3.3.1.1. Detailed description

The report is used to show connections of the use cases with other requirements which are to be realized within the particular use case. In other words, the report shows mapping (connection of Realize type from the repository of the Enterprise Architect project) of use cases (UseCases objects from the repository of the Enterprise Architect project) into the requirements (Requirements objects from the repository of the Enterprise Architect project).

For every use case (as far as it realizes any requirements e.g. functional or non-functional ones) the report will display the name of the realized requirement, description of this requirement, the name of the requirement’s author, the type of the requirement, assigned stereotype and the requirement’s status. It is displayed in the readable tabular form.

3.3.1.2. Input parameters

Figure 47. Termite Report Wizard. Elements of the Data for the report tab.

3.3.1.3. Required input parameters

To generate the report it is required to provide:

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

3.3.1.4. Optional input parameters

To generate the report you may indicate optionally:

· List of stereotypes

· List of statuses

· List of authors

3.3.1.5. Report’s realization

In order to generate the report, select Termite – Requirements realized by use cases 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 objects of 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 elements, you may enter the phrase corresponding to the name of the object in the Name Fragment field. After clicking Filter (Filtruj) button, the number of objects displayed in the List of objects should be smaller.

Example

For the following set of objects:

· Manage the users

· Book the vehicle

· Rent the vehicle

· Manage the vehicle

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

· Book the vehicle

· Rent the vehicle

Step 5. Indicating the objects for reporting

Now you have to transfer the objects that you want to include in the report from the List of objects to the List of selected objects. The way 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.

Step 7. 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.

Figure 48. 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.1.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

· name of the requirement which is being realized by particular use case

· description of the realized requirement

· type of the requirement

· assigned stereotype

· status of the requirement

Exemplary result of the generated report is presented below.

Figure 49. Exemplary Termite report.