Tool Mentor: Creating a Class Report Using Rational SoDA

Purpose

This tool mentor describes how to use Rational SoDA to create a Class Report. SoDA automates the generation of the report so that it is created quickly and accurately. You can generate a Class Report with either the Microsoft® Word® or Adobe® FrameMaker® version of SoDA.

Related Rational Unified Process information:

• Report: Class Report
• Artifact: Design Class

This section provides links to additional information related to this tool mentor.

Overview

This tool mentor is applicable when running Windows 2000, NT 4.0, Windows XP, Solaris, or HP-UX.

To create a class report using Rational SoDA, use the procedure for your version of the product:

• Use Rational SoDA/Word to generate a Class Report
• Use Rational SoDA/FrameMaker to generate a Class Report

Use Rational SoDA/Word to generate a Class Report

1. In a class diagram in Rational Rose, select the class you want to document.
2. Click Report > SoDA Report.
3. When the list of available reports appears in SoDA, select Rational Unified Process Class Report. If this report is not on the list, cancel and make sure you have a class selected in the class diagram.
4. Click OK to generate the report.

Use Rational SoDA/FrameMaker to generate a Class Report

1. From the FrameMaker button-bar, click New. Double-click SoDA, then double-click RoseDomain and choose RUPClassReport.fm.
2. Edit the Connector and enter the name of the model file, package, and class.
3. Click File > Save As to save the template to a personal or project directory. You may want to change the name of the template to reflect the name of the class; for example, LoanApplicationReport.fm.
4. Click SoDA > Generate Document.
5. Review the generated document.

The next time you want to generate this same document, simply open the document and select SoDA=>Generate Document.

Rational Unified Process