Tool Mentor: Using SoDA to Create a Use-Case Report

Purpose

This tool guide describes how to use 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 Word or Frame versions of the product.

Related Rational Unified Process Report:

• Use-Case Report

Related Rational Unified Process Artifact:

• Use Case

Overview

This Tool Mentor is applicable when running Windows NT 4.0 or UNIX.

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

1. Using SoDA/Word to generate a Use Case Report
2. Using SoDA/Frame to generate a Use Case Report

1.  Using SoDA/Word to generate a Use Case Report  

1. From Rose, 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 Generate.
5. When prompted, enter the filename of the RequisitePro 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 Rose model. Follow these steps:

1. From 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 RequisitePro project and document to be included in the report.
7. Review the generated report.
8. Back in 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, simply double-click on the document from the Rose browser. Once the document is displayed in Word, choose SoDA=>Generate Report.

2.  Using SoDA/Frame to generate a Use Case Report  

1. From Frame, select File=>New. Click on SoDA, then 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, simply open the document and select SoDA=>Generate Document.