System Document Templates

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.

Diagrams

Document Bookmarks

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.

Project Glossary

Virtual Documents

Maintenance Report

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

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

Requirements Report - Summary

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 Model Report template.

Requirements

Dependency Report

Implementation Report

Internal Requirements

Specification Manager List

Test Report

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

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

Model Document Master

Model Document templates are used when creating 'virtual documents'. The Master template provides the common features for 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