Show the other guides in this set
Table of Contents Previous section Next section

Reporting in the UML suite

Standard and customized reports

The UML suite offers a set of standard reports that can be run from the Browser and diagram editors. This section covers only these standard reports. For information on the following topics, refer to Chapter 11, Customizing Reports, in The UML Suite Customization Guide:

Reporting versus document generation

The Report tool is ideal for obtaining information on the state of your project on an ad-hoc basis. If you need formal documentation on a particular part of your project, use the Document Generator instead. This tool is typically used when a phase in a project is finished. For information on the Document Generator, see The UML Suite Document Generation Guide.

How to run a report

ÿ To run a report:

  1. In the Browser or a diagram editor, from the Reports menu, select the report that you want to run.
    Where you run a report from determines its scope. For example, if you run the Classes report in the CD editor, the report includes only those classes in the current diagram. If you run the Classes report on Phase level in the Browser, the report includes all classes in the current phase.
  2. From the Report Tool dialog box, select the report options that you want to use.
  3. Select OK.

    The UML suite displays the report in a Monitor window.

List of reports

This table briefly lists each report, the Browser level or diagram from which it can be accessed, a brief description, and its Show... options. The Show... options are listed in the Report Tool dialog box. You select the options that you want to include in the report.

Report WHere Visible contents Show... options
Browser Levels Corporate, Project, Config, Phase, Package Lists name, type, version, status, and link type of each Browser level. Corporate Projects Config versions Phase versions Package versions Note: Not all options are available at all levels.
Class Definition Files Phase, Package Lists each CDM and the diagrams (if any) in which it is referenced. Referenced CDs Unreferenced CDs
Graphical Components Package, all diagrams Lists name, type, and containing diagram of each component. None.
Items Corporate, Project, Config, Phase, Package, all diagrams Lists name, type, status, and scope of each item. None.
Metric Information Corporate, Project, Config, Phase, Package Lists the selected metric and the matching count. Class defs per package CDs per package UCDs per package Classes per file Use cases per file Associations per class Methods per class Attributes per class Depth of inheritance Children per class Associations per use case
Communication Phase, Package, all diagrams Lists name, type, starting component, ending component, and containing diagram of each communication connection. AD events AD transitions CD associations CCD messages COD links COD messages DFD flows SD events STD transitions STD messages UCD associations Dependencies Note: Not all options are available in all diagrams.
Class Hierarchy Phase, Package, CD Lists each class, indenting under it its child classes (if any). None.
Objects|Activities Phase, Package, AD Lists name, containing diagram, and containing package of each activity. Transitions Object Flows
Objects|Actors Phase, Package, COD, SD, UCD Lists name, containing diagram, and containing package of each actor. COD links COD messages SD events UCD associations Connected notes Note: Not all options are available in all diagrams.
Objects|Classes Phase, Package, CD, STD Lists name, containing diagram, and containing package of each class. Attributes Methods Generalizations Associations Method and assoc. props. Definition File Scope of the class Status of the class Connected Notes
Objects|Instances Phase, Package, COD, SD Lists name, containing diagram, and containing package of each instance. COD messages COD links SD events Class definition Connected notes Note: Not all options are available in all diagrams.
Objects|States Phase, Package, STD Lists name, containing diagram, and containing package of each state. Transitions Connected notes
Objects|Use Cases Phase, Package, UCD Lists name, containing diagram, and containing package of each use case. Decompositions Associations Generalizations Connected notes
Roles and Users Corporate, Project, Config, Phase, Package Requires Security module. For each role, lists the user links (user and link status) defined at each level. For each user, lists the roles that can be activated at each level. Roles and their users Users and their roles
Access Corporate, Project, Config, Phase, Package Requires Security module. Lists the access rules for each controlled object.
Smalltalk Categories Package, CD Requires Smalltalk module. Lists each category and its classes.

Report headers

Each page of a standard report contains this general information.

Field Shows
Report The name of the report
Date The date the report was created
Creator The user running the report
Project The name of the current project
Configuration version The name of the current configuration version
Phase version The name of the current phase
Package version The name of the current package

The names of the project, configuration version, phase version, and package version are output only if you are on one of these levels.

Example of a report header

-------------------------------------------------------------------------------------
Object | Report : Classes 29 Jul 1998 12:04:59
Team | Creator : docu
8.1.1 | Project : hlkproj Phase Version : Analysis.HLKConfig:1
| Config Version: HLKConfig.1 packageVersion : HLKpackage.HLKConfig.1
-------------------------------------------------------------------------------------


Table of Contents Previous section Next section

Copyright © 2000, Telelogic AB. All rights reserved.