Element summary

An element summary is a component in a report template, indicating the need of looping (i.e. walking through) specific type(s) of diagram/model element, and presenting their properties in tabular form. For example, to loop all use cases in a project and form a table consisting of use case IDs and documentation. By default, a table of element names will be printed. You are expected to add property column(s) under an element summary to indicate the element properties to print in the table.

Showing a property table for elements in project

To loop specific type(s) of model elements in project for listing their properties in a table, create element summary at template root. To create element summary at template root:

1. In the template editor, click on the  on toolbar.
2. On the right hand side of the template editor, select the type of model element(s) to loop and click  to confirm the selection.
   

   Select to loop use case

   NOTE:

   By default, element summary added to project root enables the looping of root level elements. If you want to change to access elements in all levels, change the option Root Level above the element list. Notice that changing the value of Root Level is not about changing available element selection, but also the end result, whether to access only root level elements or not.

3. If you generate report with a template like this, you will obtain a table of element names, provided that there exists element(s) of the chosen type(s). If you need to print specific element properties in table other than just name, click on the Add Property Column button in the toolbar of element summary, then select the property(ies) to add into the table as column(s). For more details about the use of property, read the chapter Property.
   

   To add a property column in element summary

Switching from element summary to element loop/paragraph

An element loop indicates the need of looping specific type(s) of model/diagram element, while an element paragraph indicates the need of looping specific type(s) of diagram/model element for constructing paragraphs of properties.

You can convert an element summary to element loop/paragraph by right clicking on an element summary and selecting Change to Element Loop/Paragraph from popup menu.

To convert a element summary to element loop/paragraph