System Document Templates

When you generate reports on your model, you select one of the report templates to extract information on specific key aspects of your model. There are several system templates available to use, either to generate a report straight away or to copy and customize to suit your own requirements. Each of the system templates supports a specific aspect of modeling or model management.

You usually generate reports on Packages selected from the Project Browser; these can be used to produce great hierarchical reports on parts of your model, or the whole model if you wish. There are also system templates for reporting the diagrams in a Package, and you can use the system templates to report on elements returned in search results - such reports are non-hierarchical, as they extract specific information from different areas of the model.

Access - copy existing templates for editing

Display the Document Template editor window, select a template, then click on the 'Save As New' toolbar icon.

Ribbon

Publish > Documentation > Document Templates : select a particular template > (toolbar icon)

Access - select a template for report generation

Use one of the methods outlined here to display the 'Generate Documentation' dialog, then use the 'Template' drop-down list to select which template to use for generating the report.

Ribbon	Publish > Documentation > Document > Generate Documentation > select from the 'Template' drop-down list.
Context Menu	Right-click on Package \| Documentation \| Generate Documentation \| select from the 'Template' drop-down list.
Keyboard Shortcuts	F8 \| select from the 'Template' drop-down list.

Available Predefined Templates

Template	Description	See also
Audit Report - Detailed	Incorporates information from the latest Audit runs.	Auditing
Data Modeling Report	Used for reporting on Physical database models of any of the three types - UML DDL, Information Engineering and IDEF1X. With data modeling, a Class represents a Table and its attributes represent Table fields. In the Data Modeling template, the section and field names are selected to represent the Tables, Columns (fields) and specific Column attributes.	Physical Data Model
Diagram Report	Extracts information on the diagrams for a Package. It is primarily used for outputting diagram graphics and titles. A common use of this template is where diagrams linked into an external Word master document (where virtual documents are not being used) are to be refreshed. Using the bookmarks generated with the documents, you can refresh the master document diagrams.	Document Bookmarks Diagrams
Glossary	Extracts the Glossary terms and their types, defined in the Project Glossary. This is commonly used in Virtual documents for appending the Glossary to a larger document.	Virtual Documents Project Glossary
Maintenance Report	Extracts the Change, Defect and Issue details for all elements in a selected Package. This is the information defined on the Maintenance window.	Working on Maintenance Items
Model Report	The most generalized template, which includes all of the commonly used Sections and fields. It is more appropriate in its use of field names to UML Classes. This template provides table formatting for most of the Elements sub-groups, such as Scenarios, Constraints, Attributes and Operations.	Setting Sections for Reporting
Project Issues	Extracts information on the set of issues that are logged globally in the repository. To report on the non-global, element-specific issues, see the Element > Issue section in the Model Report template.	Project Issues
Project Management Report	Shows the Resource allocation, Effort, Metric and Risk details for each element in the selected Package.
Requirements Report - Details	Extracts full information on the external Requirements of the selected Package, including the model structure each forms a part of, and the internal responsibilities, scenarios and project management and resource records that might exist to support requirements management.	Requirements Implementation Report Dependency Report Internal Requirements
Requirements Report - Summary	Provides a brief description of each Requirement element in the selected Package.
Specification Manager List	Lists the elements and sub-Packages, and their subordinate elements, under the current Specification Package in the Specification Manager. Items within a level are listed in alphabetical order.	Specification Manager
Test Report	Extracts the Test details for all elements in a selected Package, as defined on the Testing window, and the test data generated by xUnit testing and Testpoint code testing.	Working on Test Records Record Test Results The Testpoints Window
Use Case Details	Extracts information on the Use Cases in a selected Package, including the details of any scenarios. This template also excludes child structures. If you want to include sub-element Use Cases, select the Element > Child Elements section.	Scenarios
Use Case Summary	Extracts basic element description information on the Use Cases in a selected Package. This excludes scenario details and child structures (to filter out the information on any Sequence diagrams set as child diagrams of the Use Case elements).	Use Case

Notes

The facility to use the 'Diagram > Element' section to report elements contained in a diagram but defined in another Package, is inactive in system templates

Learn more