Tool Mentor:  Creating a Use-Case Report Using Rational SoDA

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

Related Rational Unified Process™ information:

• Report: Use-Case
• Artifact: Use Case

Overview

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

To create a Use Case Report using Rational SoDA, choose one of the following options:

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

1. Use Rational SoDA/Word to generate a Use-Case Report

1. From Rational Rose, in a diagram click on the use case you wish to document.
2. Select Report=>SoDA Report.
3. From the list of available reports, select Rational Unified Process Use Case Report. If you do not see that report, cancel and make sure you have a use case selected in your use-case diagram.
4. Click OK.
5. When prompted, enter the filename of the Rational Requisite®Pro project and document to be included in the report.
6. Review the generated report.

If you plan to generate this report frequently. you will find it easier to attach the template to the use case as part of the Rational Rose model. Follow these steps:

1. From Microsoft Word, select File=>New. Click on SoDA Getting Started.wiz
2. After reading (or skipping) the introduction in the first panel, select rose\RUP Use Case Report.doc in the second panel.
3. In the third panel, save the template to the directory that contains the model. Change the name of the template to reflect the name of the use case, such as Maintain Loans Report.doc
4. In the fourth panel, click Generate.
5. When prompted enter the filename of the model, the parent package, and the name of the use case.
6. When prompted again, enter the filename of the Rational RequisitePro project and document to be included in the report.
7. Review the generated report.
8. Back in Rational Rose, bring up the specification of the use case. In the Files tab, right-click and chose Insert. Locate the file from step 3.

The next time you want to generate the report, double-click on the document from the Rose browser. Once the document is displayed in Word, choose SoDA=>Generate Report.

2. Use Rational SoDA/FrameMaker to generate a Use-Case Report

1. From the FrameMaker program, select File=>New. Click on SoDA, then the Rational RoseTemplates, then RationalUnifiedProcessUseCaseReport.fm.
2. Edit the first Connector and enter the name of the model file, the parent package, and the name of the use case.
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 use case, such as MaintainLoansReport.fm.
4. Select SoDA=>Generate Document.
5. Review the generated document.

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

Copyright  © 1987 - 2001 Rational Software Corporation

Rational Unified Process