The primary function of the IBM® Rational® SoDA® integration is to retrieve information
from the IBM Rational UML modeling products and use the information to generate
customized documents and reports using Microsoft Word. SoDA is an acronym
for Software Documentation Automation.
Before you begin
SoDA is
a flexible, powerful documentation tool that can help you publish project
documents by retrieving information from software tools. You can use the predefined
UML modeling product 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
installed IBM Rational SoDA for
Word Version 2003.06.14 with "SR4 HotFix" applied, or later. For installation
information, see:
http://www.ibm.com/software/awdtools/soda/support/
About this task
To avoid duplicating functionality, the SoDA product performs most of the document
and report generation.
To use Rational SoDA for Word:
Procedure
- Enable the Common Reporting SoDA integration feature within the UML
modeling product:
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 enabled the SoDA integration feature, you can use the
document report generation tool. Note: To generate a a SoDA report, the UML modeling product must
be running.
- Start SoDA: Click .
- In the Getting Started: Introduction window,
click Next.
- In the Select Template window, scroll down
until you see the list of rsa\ templates. Select the
template name that reflects the information you want to generate documentation
from and click Next.
- In the Save Template window, specify a name
and location for the generated document.
- To start generating the report, in the Generate Report window,
click Generate.
Results
Microsoft Word opens and displays the generated
report. To display the online help for using SoDA, on the toolbar, click .