3.3.16. System reports – Grass snake

List of elements connected with the selected interfaces.

3.3.16.1. Detailed description

The report is used to list the signals and components connected with the selected interfaces by means of the connectors of Information Flow type.

The report is divided into sections, the title element of the section includes the name of the indicated object, and there is the list of interfaces and the list of components inside every section. The description of each signal includes the name of the object, the list of authors, as well as the list of references to the files connected with the object. Additionally, the attributes and selected properties of the object are displayed for every interface and component.

3.3.16.2. Input parameters

Figure 92. Grass snake Report Wizard. Elements of Data for the report tab.

3.3.16.3. Required input parameters

To generate the report it is required to provide:

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

3.3.16.4. Optional input parameters

To generate the report you may indicate optionally:

· Name fragment

· Fragment of the author’s name

· Version fragment

3.3.16.5. Report’s realization

In order to generate the report select the Interfaces option from the Reporting -> System reports text menu.

Step 1. Filtering the objects according to

the name

Enter the fragment of the object’s name in the Name fragment field to limit the list of interfaces available for the report and leave the field empty if you do not wish to filter the interfaces by the name.

Step 2. Filtering the objects according to the authors

Enter the fragment of the author’s name in the Author field to limit the list of the interfaces available for the report or leave the field empty if you do not wish to filter the interfaces by the author. This field concerns the Resource content for Resource Allocation in the project Management in Enterprise Architect.

Step 3. Filtering the objects according to the version

Enter the fragment of the version’s name in the Version field to limit the list of the interfaces available for the report or leave the field empty if you do not wish to filter the interfaces by the version.

Step 4. Adding the objects with the <<interface>> stereotype

By default, the report generator will include the objects of the Interface type in the project’s repository. The generator allows you to add the objects of other type having the interface stereotype to the report. In order to do this, select the Include all elements with the <<interface >> stereotype selection field.

Step 5. Indicating objects for reporting

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

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 93. 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.16.1. 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 divided into sections is presented below. Each section includes the interface’s description, connected signals and components. Each element consists of:

· name of the object

· authors

· references to the objects

· attributes (interfaces and components only)

· selected properties (interfaces and components only)

Exemplary result of the generated report is presented below.

Figure 94. Exemplary Grass snake report.