3.3.13. Advanced reports- Newt

The report displays the list of objects connected with the requirement by means of the relation realization.

3.3.13.1. Detailed description

The report is used to list the indicated types of objects connected with the requirements by means of the relation realization included in the repository of the Enterprise Architect project.

In other words, the report displays the list of selected objects which realize indicated requirements. Main emphasis is placed on displaying the details of the realized requirements. Each requirement in the report is described by providing the name of the requirement, description, status and the type of connected object.

3.3.13.2. Input parameters

Figure 83. Newt Report Wizard. Elements of Data for the report tab.

3.3.13.3. Required input parameters

To generate the report it is required to provide:

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

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

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

3.3.13.4. Optional input parameters

To generate the report you may indicate optionally:

· List of stereotypes

· List of statuses

· List of authors

3.3.13.5. Report’s realization

In order to generate the report select the Newt – List of objects connected with the requirement by means of relation realization option from the Reporting -> Advanced reports text menu.

Step 1.Selecting the Types of objects

You must select one, few or all types of objects 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 requirements

You must select at least one, few or all requirements which you wish to include in the report or deselect those which you do not wish to include in the report. The requirements which you select will be included in the report provided that they are connected with the selected objects from Step 1 by means of relation realization. The method of using the functionality of the form element has been described in section 3.2.1 Functionality of the lists.

Then click Refresh (Odśwież) button. The list of objects will be completed with the properly connected elements which may be included in the report.

Step.3. Determining the List of stereotypes

You must select one, few or 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 4. Determining the List of statuses

You must 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 5. Determining the List of authors

You must 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. 6. Filtering the List of objects

It is often the case that the number of objects 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 objects, you may enter the phrase corresponding to the name of the object in the Name fragment field. After clicking Filter button, the number of objects displayed in the List of objects should be smaller.

Example

For the following set of objects:

· Book the vehicle

· Verify the Credit Card

· Rent the Vehicle

· Manage the vehicle

· Rent the vehicle

If you enter the phrase “veh” into the Name fragment field and click Filter button, the List of objects will display:

· Book the vehicle

· Rent the vehicle

· Manage the vehicle

· Rent the vehicle

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

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.

Figure 84. 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.13.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 objects from the project and the requirements realized by it are presented below. The main emphasis is placed on presenting the details of realized requirements. Each requirement in the report is described by:

· name of the requirement

· description

· status

· type of connected object

Exemplary result of the generated report is presented below.

Figure 85. Exemplary Newt report.