IBM® Rational® Rhapsody® ReporterPLUS provides many standard templates. These templates can be used as they are or modified to meet your needs. The following table lists all these pre-defined templates with a description of each and the preferred output formats. The rich text format (.rtf) and plain text (.txt) formats are not listed in the following table because the design capabilities of those output formats is simplified and can be used for any of these templates. However, HTML, Microsoft Word and PowerPoint provide more formatting capabilities, so some of the generic templates look better in one or more of the other three formats.
| Template Name | Preferred Output Formats | Description |
|---|---|---|
| class.tpl | HTML or Word | This template defines the information about the classes in
the project. It prints the documentation of the following elements
of the class:
|
| ClassHierarchyBrowser.tpl | HTML | This template generates a list of the model class hierarchies with descriptions and a hyperlinked index. |
| ClassHierarchyBrowser2.tpl | HTML | This template generates the model root classes with a title page and hyperlinked index. |
| ClassHierarchyBrowser3.tpl | HTML | This template generates the model class hierarchies including Java script, a title page, and a hyperlinked index. |
| ClassOverviewPresentation.tpl | PowerPoint | This template shows an overview of the classes in Packages as a presentation. |
| ClassReport.tpl | Word | This template extracts the attribute and operation information for all classes in the model. |
| DetailedClassReport.tpl | Word | This template produces a Table of Contents and lists all classes along with their attributes and operations. |
| DiagramOrientedReport.tpl | Word | This template shows all packages that have object model diagrams. For each package, it displays all the object model diagrams, with each diagram followed by the contained elements appearing on that diagram. |
| DiagramReport_Hierarchy.tpl | Word | This template defines the information related to the diagrams
of the project. It includes both project level and package level diagrams
for: 1. Collaboration Diagrams 2. Component Diagrams 3. Deployment Diagrams 4. Object Model Diagrams 5. Sequence Diagrams 6. Use Case Diagrams 7. Statecharts and Activity Diagrams |
| Diagrams.tpl | Word & PowerPoint | Displays titles and all diagrams in the model. |
| EgalitarianPackageReport.tpl | Word | This template generates a diagram-oriented report. The diagrams represented in the report are object model, use case, sequence, deployment, collaboration, and component diagrams. |
| EgalitarianPackageReport2.tpl | Word | This template generates a diagram-oriented report of the classes in the project. The diagrams represented in the report are object model, use case, sequence, deployment, collaboration, and component diagrams. |
| FullDetailedProjectReport.tpl | Word, PowerPoint, or HTML | This generic template defines the information about the complete project. It includes all the model elements of the project and all the diagrams of the project. |
| GetStarted.tpl | Word & PowerPoint | Shows all diagrams and classes in a model. |
| HierarchicalPackageReport.tpl | Word | Recursively descend through packages showing their diagrams, classes, and nested packages. |
| IndexedClassReport.tpl | Word | Print object model diagrams and classes in a package. |
| MetamodelReport.tpl | Word | Show all packages that have object model diagrams. For each package, it displays all the object model diagrams and classes within the package. For each class, the template extracts the attributes, operations, and associations of a class. |
| ModelMetrics.tpl | Word or HTML | This prints out metrics for the entire model and each package in the model |
| OverriddenProperties.tpl | Word | This template defines the information about the overridden properties. It includes overridden properties of all the metaclasses of the model. It prints the metaclass names followed by a table of overridden properties for each metaclass. It has Q expressions to exclude the metaclasses, which do not have any overridden properties. |
| PackageReport.tpl | Word | This template defines the information related to the packages
and all the elements of in these packages:
It does not include project level information. |
| PackageReportFiles.tpl | Word | This template defines the information related to the packages
and all the elements of in these packages:
It does not include project level information. |
| ProjectReport.tpl | Word | This generic template defines the information about the complete project. It includes all the model elements and all the diagrams in the project. It includes a title page and table of contents. |
| RequirementsTable.tpl | Word | This template lists the requirements, use cases, actors, and all diagrams. |
| IBM Rational RhapsodyHTML Exporter.tpl | HTML only | The template generates a comprehensive HTML report of the project. The template defines the information about the complete project including model elements by label. |
| SequenceDiagramWithClasses.tpl | Word & PowerPoint | This template provides information about the sequence diagrams and the classes participating in the sequence diagrams. It includes a title page and table of contents. |
| Statechart.tpl | Word | This template provides information about the statecharts of the project. It includes the statecharts, states, and the list of elements contained in each of these statecharts. |
| SysMLDataFlowInPackage.tpl | HTML or Word | This specialized template lists the data imported from System Architect (SA) into aRational Rhapsody package. |
| SysMLreport.tpl | Word or HTML | This template uses the SysML profile to provide the underlying
stereotypes to generate a document. If SysML was not selected as the
Project Type when it was created, you cannot take full advantage of
the features of this template. The main sections the document produces are in the following order (if they exist):
The document produced is hyperlinked where appropriate. |
| TabularViews.tpl | any selected format | This template displays all the diagrams in the model. |
| UseCaseDiagramsDetailedReport.tpl | Word | This template supplies the information about use case diagrams, use cases, and actors of the project. It lists all the use case diagrams followed by actors and use cases related to the use case diagram. |
| UseCaseReport.tpl | Word | This template prints all the use cases and use case diagrams in a model. |