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. The Class Report can be generated by SoDA either with the Microsoft Word or Adobe FrameMaker versions of the product.

Related Rational Unified Process™ information:

• Report: Class Report
• Artifact: Design Class

Overview

This tool mentor is applicable when running Windows 98, Windows 2000, NT 4.0, or UNIX.

To create a class report using Rational SoDA, choose one of the following options:

1. Use Rational SoDA/Word to generate a Class Report
2. Use Rational SoDA/FrameMaker to generate a Class Report

1. Use Rational SoDA/Word to generate a Class Report

1. From Rational Rose, in a diagram click on the class you wish to document.
2. Select Report=>SoDA Report.
3. From the list of available reports, select Rational Unified Process Class Report. If you do not see that report, cancel and make sure you have a class selected in your class diagram.
4. Click OK.
5. Review the generated report.

2. Use Rational SoDA/FrameMaker to generate a Class Report

1. From the FrameMaker program, select File=>New. Click on SoDA, then the Rational RoseTemplates, then RationalUnifiedProcessClassReport.fm.
2. Edit the Connector and enter the name of the model file and the name of the class.
3. Use File=>Save As to save the template to a personal or project directory. You may wish to change the name of the template to reflect the name of the class, such as LoanApplicationReport.fm.
4. Select 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.

Copyright  © 1987 - 2001 Rational Software Corporation

Rational Unified Process