IBM® Rational® SoDA® for Word Release Notes

Windows


Version 2003.06.13

Release Date: September 2004

Last Updated: 08/03/2004

Material ID/Part Number: GI11-5905-03


© Copyright IBM Corporation.  1996, 2004.  All Rights Reserved.

Any reproduction or distribution of this work is expressly prohibited without the prior written consent of IBM Corporation.

Legal Notices Information


These Release Notes are accurate at the time this product was prepared for release. The most recent version of this file is available in the IBM Publications at www.ibm.com/shop/publications/order. Search for GI11-5905-03 to find the latest version of these Release Notes in the IBM Publications Center. (To search for the IBM Publications Center, go to www.ibm.com and enter "IBM Publications Center" in the Search field.)


Scope

These IBM Rational SoDA release notes provide:

Updated versions of the release notes will periodically be posted on the World Wide Web. Please check the IBM Rational Web site at http://www.ibm.com/software/rational/support/ to ensure that you are using the latest version of this document.

Go to Rational SoDA Service Release Notes if you are upgrading for Service Release note information.

When you are ready to install IBM Rational SoDA for Word, be sure to check the Web for the latest available downloads:

1.       Go to http://www.ibm.com/software/rational/support/.

2.       Then, go to the Download Center and navigate to Rational patches and service releases.

Contents

Important Notice !! (Read before Installing)
What's New in This Release
Product Documentation
Hardware/Software Information

Installation, Upgrading, and Licensing

Installation Information

Installation Issues

Upgrading from Previous Versions of SoDA for Word

Licensing

Compatibility Issues 
with Rational Products

with Third-Party Products

Restrictions and Guidelines on Using Rational SoDA for Word

Known Issues and Change Requests

SoDA Comments in Word

Information for Word 2002 Users

Information for Word 2003 Users

Documentation Updates

Additional Information

Contacting IBM Rational Technical Support

What’s New in This Release

This section contains information about new and updated features included in Rational SoDA for Word v2003.06.00, v2003.06.12 and v2003.06.13.

Product Documentation

Documentation for IBM Rational is available on-line at http://www.ibm.com/software/rational/support/documentation/.

Hardware/Software Information

System and Software Requirements

This section describes the system and software requirements for installing and running IBM Rational SoDA for Word.

Additional System and Software Requirements

The following table describes the additional system and software requirements for IBM Rational SoDA.

IBM Rational SoDA for Word Requirements

Item

Minimum Requirements

Operating Systems

  • Windows NT 4.0 with Service Pack 6a and SRP (Security Rollup Package)
  • Windows 2000 with Service Pack 2, 3 or 4 (English OS)
  • Windows XP Professional with Service Pack 1 or Service Pack 2

Note   Windows XP Home Edition is not supported in this release.

Hardware Requirements

Recommended

  • 256 MB RAM
  • 600 MB Disk Space

Minimum

  • 128 MB RAM
  • 150 MB Disk Space
Word Processor
  • Microsoft Word 2000, Service Pack 1, 2, 3
  • Microsoft Word 2002, Service Pack 1, 2
  • Microsoft Word 2003, Service Pack 1
 

Installing, Upgrading, and Licensing

Installation Information

The Rational Setup Wizard removes earlier versions of Rational SoDA for Word and associated licenses.

You must install SoDA for Word on the same machine as the Rational products on which you want to report.

The following files from LEAD Technologies, Inc., are included in this release:

Installation Issues

IMPORTANT NOTICE!! Microsoft Windows 2000 NTFS "Change Journal" defect can cause file system corruption during installation of Rational products

Under certain circumstances, file system corruption can result from installing Rational Version 2003 products on Windows 2000 to an NTFS partition that has enabled the Windows "Change Journal" (log). This corruption is caused by a defect in Windows 2000.  Before you install any Rational Version 2003 product on Computer that is running Windows 2000:

  1. Disable all virus detection software
  2. Read IBM Support Technote 1135295. Go to http://www-1.ibm.com/support/us/search/index.html and search for "Rational Installer Change Journal."
  3. Read Microsoft Knowledge Base article 820888 at http://support.microsoft.com/default.aspx?scid=kb;[LN];820888.  This article includes information about an update from Microsoft that fixes the defect.

Difficulty Installing SoDA for Word on a French Windows NT SP6a Operating System

SoDA for Word will not install successfully on a French Windows NT4 SP6a operating system unless Internet Explorer (IE) 6.0 and the Microsoft Security Roll-Up Patch (SRP) [that is, Windows NT 4.0 Service Pack 6a (SP6a) Hotfix] are already installed. If the following message is displayed while you are installing SoDA for Word:

"This product to restrict installs to NT4SP6a and up, W2K SP2 and up, and WinXP"

Cancel the installation, install IE 6.0 and the Microsoft SRP, and then install SoDA for Word.

Upgrading from Previous Versions of SoDA for Word

There are no known issues regarding upgrading this product.

However, if you store user-defined templates in the Rational installation directory, we recommend that you make a backup copy of those templates in another directory.

Licensing

This version of SoDA for Word, v 2003.06.13, requires a license for version 2003.06.00.  A license for a previous release will not work. 

Compatibility Issues

This section identifies special considerations for using SoDA for Word with other products, including Rational products and third-party software products.

With Rational Products

SoDA for Word version 2003.06.xx can report on Rational products of the same version, 2003.06.xx.  SoDA is backwards compatible in the same way that any Rational point product is backwards compatible (i.e. if an individual Rational product version 2003.06.xx can read data from an earlier version of that product, then SoDA can also read that data and report on it).

Rational XDE

Rational XDE version 2003.06.00 (excluding Rational XDE tester) will be compatible with Rational SoDA for Word; previous versions of Rational XDE are not supported. For more information about Rational XDE, go to the Rational Support Web site.

With Third-Party Products

Installing SoDA for Word in a Window Terminal Server Environment

You can install and run SoDA for Word on a Windows Terminal Server console system as you would on any other supported Windows NT Server or Windows 2000 Server system.

Terminal Server configurations are limited by the Terminal Server's resources.  SoDA is a memory-intensive application due to its dependency on Word.  For best performance, real memory on the Terminal Server (RAM) should be as large as possible, and virtual memory should be left unrestricted.

To use Rational products on a Terminal Server client, you must configure your console system to use floating licenses.

Restrictions and Guidelines on Using Rational SoDA for Word

There are no known restrictions associated with this product.

Known Issues and Change Requests

The following outlines known defects and limitations in this release.

Defect

Description

RATLC00009488

If you use SoDA for Word with a non-English version of Microsoft Word, you cannot retrieve Headings from the Word domain, because the source code defines "Heading" as a Paragraph with the Style of "Heading" (using the English word, Heading), instead of the local translation used in Word.

Workaround: In your SoDA template, modify the REPEAT Paragraph command, select the Advanced check box, and then create an And Where statement like this:
   1.   On the left operand, click Click here to add.
   2.   Expand Self.
   3.   Select Style.
   4.   Select the LIKE operator.
   5.   On the right operand, click Click here to add.
   6.   Click Literal.
   7.   Enter the non-English word for "Heading".
So, the filter will look like this:
  <Self>.Style LIKE "<non_English word for Heading>"

RATLC00016147

If Rational RequisitePro Integration with Word is installed on your machine, and you have never started Word on the machine, SoDA for Word does not start correctly.

Workaround: On a machine on which Word has never been started:
   1.   Start and then quit Word.
   2.   Start SoDA for Word.
   3.   Start RequisitePro and then open a RequisitePro project.
   4.   Click Tools > Generate SoDA Report.
The SoDA for Word dialog box is displayed normally.

RATLC00019981

The built-in template "Data Dictionary of Classes with Attributes and Operations" (ClassesAttrsOps.doc) is not available through Rose RealTime.  If you start Rose RealTime, open a sample Rose RealTime model, and then click Report > SoDA Report, the Generate Rose RealTime Report dialog box does not list the built-in template.

Workaround: To work around this problem:

  1. In Windows Explorer, navigate to the following folder:
    Program Files\Rational\SoDAWord\template\rosert
  2. Right-click the ClassesAttrsOps.doc file, and then click Properties on the shortcut menu.
  3. On the Summary tab, in the Value column next to the Keywords property, delete SoDA Template.
  4. Click OK.

RATLC00020353

If you start Template Builder and click ProjectConsole > Template View, and you then start SoDA for Word and click SoDA > Template View, the template Builder Template View dialog box is displayed.

Workaround: Quit Template Builder before you use SoDA for Word.

RATLC00046972

On a non-English operating system, diagram images extracted from Rose RealTime are missing, cropped or scaled incorrectly when Word's measurement units are "Centimeters".

Workaround: On the General tab of the Tools > Options dialog, change the measurement units used by Word to "Inches" or "Millimeters".

RATLC00248424

If you open Help for SoDA in Internet Explorer 6.0 and display the Table of Contents, you may see an error message about not being able to move the focus to a control.

Workaround: To use the Help system without further interruption, close the message box by clicking either OK or No (depending on your environment).

RATLC00027119

Messages are truncated on sequence diagrams.

Workaround: In Rose, display the affected diagram and click Format > Autosize All.

RATLC00364847

Tight integration with SoDA open and minimized causes unexpected behavior.

Workaround: Do not minimize SoDA when using tight integration.

RATLC00367282

When a SoDA report runs against an XDE model, you cannot modify the model because it is opened in the background by the SoDA data access layer.

Workaround: Wait for the SoDA session to complete, then close SoDA before updating your model.

RATLC00368817

All data returned through SoDA is returned as a String. Therefore, the comparators compare the string value, not the numeric value, so 100 is less than 99.

RATLC00370610

To run a report on XDE data, XDE must be running.

Workaround: Start XDE before reporting on it.

RATLC00370695

A Word 2000 template that is upgraded to Word 2002 can produce graphics that are sized incorrectly. This is caused by the Word upgrade process, which may reset the display size to a default too small for the desired graphic.

Workaround: Manually reset the graphic to the correct size.

RATLC00370976

Opening a Word 2002 template from the Rose tight integration and then saving it with SoDA commands visible generates a Word internal error.

Workaround: Hide the SoDA commands before you save a template that you open in this context.

RATLC00959454 / IC41721 Unable to use SoDA tight integration by multiple users in a Teminal Server Environment as all settings are saved in one location, in the soda.ini file in the ..program files\rational\sodaword\ directory.

 

SoDA Comments in Word

SoDA uses the Word comment feature to store the arguments it needs to extract and display information in a SoDA report.

Information for Word 2002 Users

Because comments have a different appearance and different behavior in Word 2002 than they do in Word 2000, you interact with the comment feature differently in the two versions of Word.

SoDA Help does not include Word 2002 procedures. Therefore, if you are going to use Word 2002 with SoDA, review the Word 2002 information in Rational’s Solutions Knowledge Base to get this information.

Information for Word 2003 Users

The behavior of comments in SoDA for Word Version 2003.06.12 using Word 2003 is slightly different from Word 2002 and similar to Word 2000. This difference is not documented in Help but is provided here.

Like Word 2002, Word 2003 requires Markup to be turned ON to display Word comments (and SoDA commands).  However, in this version of SoDA, the default Markup setting is ON and the color is white, which makes Markup invisible to the user.  This does not affect comment functions for normal Word usage. Now that Markup setting is always ON in SoDA, you can use the Word Show/Hide icon to toggle the display of SoDA commands. The placement of the cursor in relation to the marker is irrelevant in this version (this is different from Word 2002).

Documentation Updates

There are no known documentation issues at this time.

Additional Information

The domain name TeamTest has changed to TestManager. It is possible that not all references to this have been changed in the documentation and software. The two terms should be considered synonymous.

Contacting IBM Rational Customer Support

The IBM software support Internet site provides you with self-help resources and electronic problem submission. The IBM Software Support homepage can be found at http://www.ibm.com/software/support.

Voice Support is available to all current contract holders via a telephone number in your country (where available). For specific country phone numbers, please refer to the IBM Software Support Handbook, Appendix B: Contact Information, found at http://www.ibm.com/software/support.