3.3.09. Standard reports – Coleopter

3.3.9.1. Detailed description

The report is used to list the indicated types of objects included in the repository of the Enterprise Architect project.

The report is divided into sections; each section includes the list of objects of the same type. In turn, each element of the section will display you the name of the object, its description included in the Notebook field – the component of Enterprise Architect tool as well as the status, stereotype, author (only for the objects of requirement type), if it is the external requirement (only for the objects of requirement type), type of the object (only for the objects of: class, use case, component, activity, actor type).

3.3.9.2. Input parameters

Figure 71. Coleopter Report Wizard. Elements of Data for the report tab.

3.3.9.3. Required input parameters

To generate the report it is required to provide:

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

· Types of the objects (at least one element of the list)

3.3.9.4. Optional input parameters

To generate the report you may indicate optionally:

· List of stereotypes

· List of statuses

· List of authors

3.3.9.5. Report’s realization

In order to generate the report select the Coleopter – Objects from the project option from the Reporting -> Advanced reports text menu.

Step 1. Selecting the Type of objects

You must select at least one, few or all types of objects which you wish to include 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.

Then click Refresh button.

Step 2. 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 3. 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 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 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 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 types of objects displayed in the List of objects should be smaller.

Example

For the following set of objects:

· Book a vehicle

· Rent the vehicle

· CRT Credit Card

· Manage the vehicle

· Add new car

· Book a car

· Account

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

· Book a vehicle

· Rent the vehicle

· Manage the vehicle

Step 6. Indicating the objects 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 7. 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 8. Generating the report

The last step is to click the 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 72. 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.9.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 divided into sections is presented below. Each section includes the list of objects of the same type, e.g. the first section includes the list of classes, the second section includes the list of use cases, etc. Each element of this list consists of:

· name of the object

· description of the object

· status

· stereotype

· author (only for the objects of requirement type)

· information if it is the external requirement (only for the objects of requirement type)

· type of the object (only for the objects of: class, use case, component, activity, actor type)

Exemplary result of the generated report is presented below.

Figure 73. Exemplary Coleopter Report.