Purpose

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

Related Rational Unified Process information:

• Report: Business Entity
• Artifact: Business Entity

Overview

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

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

• Use Rational SoDA/Word to generate a Business Entity Report
• Use Rational SoDA/FrameMaker to generate a Business Entity Report

Use Rational SoDA/Word to generate a Business Entity Report

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

Use Rational SoDA/FrameMaker to generate a Business Entity Report

1. From the FrameMaker button-bar, click New. Double-click SoDA, then double-click RoseDomain and choose the RUPBusinessEntityReport.fm template.
2. Edit the Connector and enter the name of the model, package, and business entity.
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 business entity; for example, BoardingPassReport.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 click SoDA > Generate Document.