Purpose

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

Related Rational Unified Process information:

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, or Windows XP, Solaris or HP-UX.

To create a Use-Case Report using SoDA, use the procedure for your version of the product:

Use Rational SoDA/Word to generate a Use-Case Report To top of page

  1. In a use-case diagram in Rational Rose, select the use case you want to document.
  2. Click Report > SoDA Report.
  3. When the list of available reports appears in SoDA, select Rational Unified Process Use-Case Report.
    If this report is not on the list, cancel and make sure you have a use case selected in the use-case diagram.
  4. Click OK.
  5. When prompted for the UseCaseSpecification, enter or browse for the Word file to be included in this report.
  6. Click OK to generate the report.

2. Use Rational SoDA/FrameMaker to generate a Use-Case Report To top of page

  1. From the FrameMaker button-bar, click New. Double-click SoDA, then double-click RoseDomain and choose the RUPUseCaseReport.fm template.
  2. Edit the first Connector and enter the name of the model, package and use case.
  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 use case; for example, MaintainLoansReport.fm.
  4. Click SoDA > Generate Document.
  5. When prompted for the UseCaseSpecification, enter or browse for the FrameMaker file to be included in this report.
  6. Click OK to generate the report.
  7. Review the generated document.

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

© Copyright IBM Corp. 1987, 2004. All Rights Reserved.

Rational Unified Process   2003.06.13