System RTF Templates

When you generate RTF reports on your model, you select one of the RTF 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. In a list of templates, system template names are enclosed in parentheses.

You usually generate RTF 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     Project | Documentation | Document Template Designer (for review/copying)
                   Project Browser Object: ( F8 ) > General (to select to generate a report)

Available Predefined Templates

Basic
Basic + Audit
Data model
Interaction Messages
Diagrams
Maintenance
Testing
Efforts, metrics & risks
Resource Allocation
Model Glossary
Project Issues
Model Document - Master
Model Document - Basic
Model Document  - Data Modeling
Requirements
Use Case
Use Case Scenarios
 

Basic Template Variations

Template

Description

See also

Basic

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

Basic + Audit

A variation of the Basic template that incorporates information from the latest Audit runs.

 

Auditing

Data Model

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 Model template, the section and field names are selected to represent the Tables, Columns (fields) and specific Column attributes.

 

Physical Data Model

Interaction Messages

Used for generating documentation on Sequence diagrams and other Interaction diagrams. It represents connectors specifically as Messages, as well as listing the message sequence details (which is not included in the Basic template).

 

Sequence Diagram

Diagrams

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.

 

Diagrams

 

 

RTF Bookmarks

Sub-Element Details

Template

Description

See also

Maintenance

Extracts the Element | Change, Element | Defect and Element | Issue details for all  elements in a selected package. This is the information defined on the Maintenance window.

 

Working on Maintenance Items

Testing

Extracts the Element | 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

 

Efforts, metrics and risks

Extracts the efforts, metrics and risks associated with the elements in a selected package.  It is useful in getting details for analyzing the time/costing on projects.

This reflects the information defined on the Project Management window.

 

Use Case Estimation

Project Estimation Using Use Case Metrics

The Project Management Window

 

Resource Allocation

Reports the assignment of tasks to people (Authors and Resources).

The template extracts the details defined in the Resource Allocation tab of the Project Management window, and any Gantt chart assignment of resources to a package or elements. It principally reports the Element | Resource section.

 

Resource Allocation

Project Specific

Template

Description

See also

Model Glossary

Extracts the Glossary terms and their types, defined in the Model Glossary.

This is commonly used in Virtual documents for appending the Glossary to a larger document.

 

Project Glossary

Virtual Documents

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 Basic template.

 

Project Issues

Virtual Document

Template

Description

See also

Model Document Master

Model Document templates are used when creating 'virtual documents'. The Master template provides the introductory page to a series of documents generated from other templates.

Virtual documents do not have to have a Master Document - a single model document template can provide the basis for a generated document. This allows Package details (such as Package | Package Element |Tagged Value) to be defined in Model Documents; these sections are not available in Master Documents.

If you do use a Master template, set any Table of Contents you require in the first Model Document template, to ensure that a Header text is available to create a TOC. A Master document often does not have Header text and hence a TOC cannot be created.

 

Create Master Document

Create Model Document

Model Document Basic

Model Document Data Model

Use Case/Requirements

Template

Description

See also

Requirements

Extracts information on external requirement elements associated with other elements (often Use Cases). The specific report section Element | External Requirements is selected in the template.

To extract information on each element's internal requirements (responsibilities), you would select the Element | Requirements section, as in the Basic template.

 

Requirements

Dependency Report

Implementation Report

Internal Requirements

Use Case

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

Use Case Scenarios

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

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