Setting Sections for Reporting
As part of designing or editing a template for generating a document report, you define the content to deliver in your report, specifically:
- Which model features to report on (such as elements, attributes, linked documents and Tagged Values), using the 'Sections' panel of the Document Template Designer
- What information to provide on the instances of each feature (such as the name, type, phase, priority or author), using the 'Content' panel of the Document Template Designer
The information you define here determines the structure of the report, what sections it contains and the order of those sections.
Access Package | Documentation | Document Templates > Sections
Package | Documentation | Document Templates > Content
Select model components to be documented in the report
Expand the some or all of the hierarchy in the 'Sections' panel.
Select the checkbox next to the feature name; the feature name is then displayed as a pair of section tags in the 'Content' panel of the Document Template Designer.
For features in the lower levels of the hierarchy, selecting a child feature automatically selects the parent level(s) and adds the parent tags to the 'Content' panel.
If you want to change the sequence of sections, click on the appropriate feature name in the 'Sections' hierarchy and click on or to move the feature name up or down.
The position of the feature name within the 'Sections' hierarchy determines the position of the section documenting that feature in the 'Content' panel, and hence in the report. You can change the sequence either before or after you have selected the checkboxes, it makes no difference.
For each selected feature, click between the section tags in the 'Content' panel and add text, or right-click and select the 'Insert Fields' option to add fields.
|Add Section Content|
- More specific guidance is provided for selecting these features:
- Child objects
- Embedded elements
- Profiled Relationship Matrices
- Constraints and Scenarios
- Linked Documents and Document Artifact contents
- Elements held in external Packages
- Tagged Values
- Sections formatted as tables
- Using the Custom section for Custom Query Fragments
- Design Custom Document Templates
- Child Objects
- Report on Embedded Elements
- Reporting Profiled Relationship Matrices
- Report on Constraints and Scenarios
- Reporting Linked Documents
- Report Elements From External Packages
- Report on Tagged Values
- Create Sections as Tables
- Generate Documentation
- Custom Query Fragments
Learning Center topics
- Alt+F1 | Enterprise Architect | Reporting | RTF Templates | Add a Section