The primary function of the IBM® Rational® SoDA® integration is to retrieve information
from Rational Software
Architect or Rational Software
Modeler and use the information to generate customized documents
and reports using Microsoft® Word. SoDA is an acronym for Software Documentation
Automation.
SoDA is
a flexible, powerful documentation tool that can help you publish project
documents by retrieving information from your project software tools. You
can use the predefined Rational Software Architect or Rational Software
Modeler templates provided for you in SoDA or customize a template to meet your
specific needs.
Before you can use the SoDA integration feature, you must have IBM Rational SoDA for
Word Version 2003.06.14 with "SR4 HotFix" applied, or later installed. If
you have not already done so, please go to
http://www.ibm.com/software/awdtools/soda/support/ for information on obtaining and installing a copy.
To avoid duplicating functionality, virtually all document and
report generation occurs from within the SoDA product.
To use Rational SoDA for
Word:
- Enable the Common Reporting SoDA integration feature within Rational Software
Architect or Rational Software
Modeler by performing the following steps:
Note: The SoDA integration
feature is enabled by default.
- Click .
- In the Preferences window, click Common Reporting.
- In the page that opens on the right, select the Enable
SoDA integration check box.
- Click Apply to continue modifying preferences
or OK to save and exit.
Now that you have turned on the SoDA integration feature, you can start
using the document report generation tool. Note: Rational Software Architect or Rational Software
Modeler must be running in order to generate a SoDA report.
- Next, start SoDA by clicking .
- In the Getting Started: Introduction window
click Next.
- The Select Template window lists all available
templates. Scroll down until you see the list of rsa\ templates.
Select the template name that reflects the information you wish to generate
documentation from and click Next.
- The Save Template window opens in which
you must select a name and location to save the generated document. Click Browse to
select a name and location for your file or simply enter a path and file name
and click Next. In the Generate Report window click Generate to
start the report generation.
Microsoft Word will open displaying the generated
report. For detailed help on using SoDA, from the toolbar click to
display the complete SoDA online help.