Version 7.0.0.02
Windows
Material ID/Part number GI11-6305-00
Before using this information, be sure to read the general information under Notices.
7th edition, June 2006
This edition applies to version 7.0.0.02 of IBM Rational SoDA for Microsoft Word (product number 5724-G53) and to all subsequent releases and modifications until otherwise indicated in new editions. This edition replaces GI11-5905-05.
Copyright International Business Machines
Corporation 1996, 2006. All rights reserved.
US Government Users Restricted Rights -- Use, duplication or disclosure
restricted by GSA ADP Schedule Contract with IBM Corp.
Contacting IBM
Customer Support for Rational software products
Latest version of this document
New features in version 7.0.0.02
Hardware and software information
Installing, upgrading, and licensing Rational SoDA
Restrictions and guidelines for Rational SoDA
Rational SoDA comments in Microsoft Word
Information for Microsoft Word 2002 users
Information for Microsoft Word 2003 users
Required software for using the IBM Rational
Software Architect Domain for Rational SoDA
Diagram images from Rational Rose RealTime
Updating XDE models when running a Rational SoDA
report
Integration with menu systems for other Rational
products
Rational SoDA documentation updates
Mismatch between Help text and Rational SoDA icons
Additional Rational SoDA information
This document provides information about installing and using IBM(R) Rational(R) SoDA(R), including hardware and software requirements, known issues, and compatibility issues.
The product changes described in this document apply to version 7.0.0.02 of
Rational SoDA for Word.
This document is intended for system administrators and users of Rational
SoDA.
These release notes are accurate at the time this product was prepared for release. The most recent version of this document is available from the IBM Publications Center.
For more information about installing, upgrading, configuring, and using Rational SoDA, see the IBM Rational SoDA Installation and Upgrade Guide.
Product documentation is available on the IBM Publications Center, where you can download documents or purchase printed copies. To find documentation:
IBM developerWorks(R) Rational http://www.ibm.com/developerworks/rational/ is an online community that provides information and an exchange of ideas and best practices. Content on the site has been edited for quality and relevance, and organized by technology and process. There are also links to Web-based training. You can use the site to for the following purposes:
This manual uses the following typographical conventions:
In certain contexts, you can use "..." within a pathname as a wildcard, similar to "*" or "?". For more information, see the wildcards_ccase reference page.
· lsc/heckout
If you have questions about installing, using, or maintaining this product, contact IBM Customer Support as follows:
The IBM software support Internet site provides you with self-help resources and electronic problem submission. The IBM Software Support Home page for Rational products can be found at http://www.ibm.com/software/rational/support/.
Voice Support is available to all current contract holders by dialing a
telephone number in your country (where available). For specific country phone
numbers, go to http://www.ibm.com/planetwide/.
When you contact IBM Customer Support, please be prepared to supply the following information:
The IBM Support Assistant (ISA) is a locally installed serviceability workbench that makes it both easier and simpler to resolve software product problems. ISA is a free, stand-alone application that you download from IBM and install on any number of machines. It runs on AIX(R), (RedHat Enterprise Linux(R) AS), HP-UX, Solaris, and Windows(R) platforms.
ISA includes these features:
For more information about ISA, including instructions for downloading and installing ISA and product plug-ins, go to the ISA Software Support page.
IBM Support Assistant: http://www.ibm.com/software/support/isa/
This chapter contains information about new features and describes changes
to version 7.0.0.02 of Rational SoDA.
The latest version of this document is available from the IBM Publications Center.
To obtain this version:
These release notes provide the following information:
Updated versions of the release notes are periodically posted on the IBM Rational Web site at http://www.ibm.com/software/rational/support/ . Ensure that you are viewing the latest version of this document.
When you are ready to install Rational SoDA, be sure to check the IBM Web site for the latest available downloads:
This section describes new product features in version 7.0.0.02 of Rational SoDA.
This release of Rational SoDA contains the following new features:
This section contains announcements about important changes to Rational SoDA.
The following software and features are no longer supported in this release:
This chapter describes updates to the documentation that pertain to
installing Rational SoDA.
Table
1 provides the recommendations and requirements for operating Rational SoDA
for Word in your environment. You can use the software on computers that may
not meet all the hardware recommendations. The recommendations in this table
provide guidelines for good operating performance.
This section contains information relevant to installation, upgrade, and
licensing tasks for version 7.0.0.02 or Rational SoDA.
Keep the following information in mind when you install version 7.0.0.02 of Rational SoDA.
Under certain circumstances, file system corruption can result from installing the software on a computer running 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 Rational SoDA on a computer that is running Windows 2000, perform the following actions:
There are no known issues regarding upgrading this product. However, if you
store user-defined templates in the Rational installation directory, make a
backup copy of those templates in another directory.
This version of Rational SoDA requires a license for version 7.0. You cannot
use a license for an earlier version of the software with version 7.0.
This section identifies special considerations for using Rational SoDA with
other products, including Rational products and vendor software products.
Rational SoDA version 7.0 can report on Rational products of the same
version and is also backwards compatible.
This section describes compatibility issues to consider when using Rational
SoDA with vendor software products.
You can install and run Rational SoDA on a Windows Terminal Server console system as you would on any other supported Windows system.
Windows Terminal Server configurations are limited by the resources of Windows Terminal Server. Rational SoDA is a memory-intensive application due to its dependency on Microsoft Word. For best performance, real memory on the Windows Terminal Server (RAM) should be as large as possible, and virtual memory should be left unrestricted.
To use Rational products on a Windows Terminal Server client, you must configure
your console system to use floating licenses.
This section describes noteworthy restrictions and guidelines that affect
the use of Rational SoDA. These are not considered defects because the behavior
is not expected to change in a future release.
Rational SoDA uses the Microsoft Word comment feature to store the arguments
it needs to extract and display information in a Rational SoDA report.
Because comments have a different appearance and different behavior in Microsoft Word 2002 than they do in Microsoft Word 2000, you use the comment feature differently in the two versions of Microsoft Word.
The Rational SoDA Help does not include Microsoft Word 2002 procedures. Therefore, if you are going to use Microsoft Word 2002 with Rational SoDA, review the Microsoft Word 2002 information in the Rational knowledge base on the Web site for IBM Customer Support for Rational software products. to get this information. The Help contains topics which provide the following information:
The behavior of comments in Rational SoDA using Microsoft Word 2003 is slightly different from Microsoft Word 2002 and similar to Microsoft Word 2000. This difference is not documented in the Help, but it is provided here.
Like Microsoft Word 2002, Microsoft Word 2003 requires Markup to be turned
ON to display Microsoft Word comments (and Rational SoDA commands). However, in
version 7.0 of Rational 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 Microsoft Word usage. In this release of Rational SoDA,
the Markup value is always set to ON, and you can use the Microsoft Word Show/Hide
icon to toggle the display of Rational SoDA commands. The placement of the
cursor in relation to the marker is irrelevant in this version (this is
different from Microsoft Word 2002).
The IBM Rational Software Architect Domain for Rational SoDA supports the following software:
The integration feature is available to Rational Software Architect or Rational Software Modeler users through the Rational Product Update functionality contained in these products.
Additional information for the integration can be found in the IBM Rational Software Architect / IBM Rational Software Modeler documentation.
Table
2 lists the limitations specific to this domain.
In versions of Rational SoDA earlier than version 2003.06.12, menu items were implemented through Microsoft Word macros. In version 2003.06.12, some of these macros were removed from the Rational SoDA release because of the addition of COM Add-In functionality. Due to customer request, the majority of the macros were reinstituted in version 2003.06.13 and are also available in this release. The following macros are available:
On a non-English operating system, diagram images extracted from Rational Rose RealTime are missing, cropped or scaled incorrectly when Microsoft Word's measurement units are centimeters.
Workaround: Click Tools > Options,
and on the General page of the Options window, change the measurement units
used by Microsoft Word by selecting Inches or Millimeters
from the Measurement Units drop-down list.
When a Rational SoDA report runs against an XDE(TM) model, you cannot modify the model because it is opened in the background by the Rational SoDA data access layer.
Workaround: Wait for the Rational SoDA session to complete,
then close Rational SoDA before updating your model.
A number of Rational products provide tight integration with Rational SoDA through their own menu systems. Certain default values were persistent in the soda.ini file found in ...\rational\sodaword\. This was problematic for supporting Rational SoDA a Windows Terminal Server Environment if two users accessed these tight integrations at the same time.
Windows Terminal Server users need to copy the soda.ini file to the $SODAHOME\$USERNAME
folder if they desire user specific settings where $SODAHOME is the Rational
SoDA installation directory (for example, ...\rational\sodaword) and $USERNAME
is the Windows login user name of the user.
This section describes updates and changes to documentation for Rational
SoDA.
In some cases, there is a mismatch between the icons and on-screen logos
shown in Rational SoDA Help topics and those that display as part of the Rational
SoDA interface. In these cases, the Rational SoDA interface displays the most
current information. The Help documentation will be updated in a later release.
For important information about getting started with Rational SoDA, go to http://www.ibm.com/developerworks/rational/
and see the article "Understanding IBM Rational SoDA."
This section lists defects fixed in this release and known issues and change
requests.
Table
3 lists the defects fixed in this release of Rational SoDA.
Component |
ID |
Description |
Rational SoDA |
RATLC01021324 APARPK44175 |
REPEATing directly on a requirement type with filter does not return expected results |
Rational SoDA |
RATLC01030798 APARPK50298 |
SoDA should retrieve data based on the storage order |
Rational SoDA |
RATLC00378008 APARIC41720 |
No commands under "TestCaseResult.LogEvent" returns data |
Rational SoDA |
RATLC00705347 APARIC38674 |
It is not possible to get Test Manager DefectID's in a SoDA report |
Rational SoDA |
RATLC01030354 APARPK49992 |
SoDA v.7.0.1 MASTER and ENDREP commands are misplaced |
Rational SoDA |
RATLC01025847 APARPK47194 |
Generated reported in HTM format displays OPEN command |
Rational SoDA |
RATLC01023339 APARPK45301 |
Table of Contents in SoDA command of a generated document is not hidden |
Rational SoDA |
RATLC01203645 APARPK45800 |
Wrong SoDA templates displayed when launch SoDA From Rose |
Rational SoDA |
RATLC01200593 APARPK43295 |
Adding a display commands corrupts SoDA table |
Rational SoDA |
RATLC01017405 APARPK42252 |
SoDA/Rose: Running report from Rose menu gives an incorrect report |
Rational SoDA |
RATLC01027063 APARPK48188 |
Blank rows are displayed in the middle when using a repeat with filter in a table |
Rational SoDA |
RATLC01030037 |
Unreadable characters in SoDA Report generated from a ReqPro doc created in Word 2007 |
Rational SoDA |
RATLC00394073 |
SoDA error: "Last Word error was #512 (Error: internalError)" |
Rational SoDA |
RATLC01188907 |
Error while generating SoDA (for Word 2007) report thru Rose / Rose RT |
Rational SoDA |
RATLC01188375 |
SoDA does not open for Standard user in Vista Ultimate |
Rational SoDA |
RATLC01199925 |
SoDA prompt feature does not work with generate web page option |
Rational SoDA |
RATLC01020911 |
REPEAT command TMTestCase.ParentTestCases.Requirements_List does not work in SoDA |
Rational SoDA |
RATLC01210862 |
SoDA Cannot read custom CQ query |
Rational SoDA |
RATLC01014011 |
SoDA Report generation - insufficient memory |
Rational SoDA |
RATLC01039348 |
Separate dependency and related relationships |
Rational SoDA |
RATLC01210626 |
SoDA - Add a REPEAT command to Repeat over Parents |
Rational SoDA |
RATLC00560153 |
SODA-RSM-XP: Editing a template the first time after generating a report crashes Word |
Rational SoDA |
RATLC01188428 |
Error while adding / modifying commands through Template View |
Rational SoDA |
RATLC01189202 |
Template corrupts after editing SoDA Template having XDE Artifacts |
Rational SoDA |
RATLC01214788 |
RFE: option/macro to remove blank rows after report generation |
Table
4 outlines known defects and limitations in this release of Rational SoDA.
This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation North Castle Drive
Armonk, NY 10504-1785
U.S.A.
For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:
IBM World Trade Asia Corporation Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106, Japan
The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.
This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:
IBM Corporation
Department BCFB
20 Maguire Road
Lexington, MA 02421
U.S.A.
Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.
The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.
Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurement may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment.
Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.
COPYRIGHT LICENSE:
This information contains sample application programs in source language, which illustrates programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. You may copy, modify, and distribute these sample programs in any form without payment to IBM for the purposes of developing, using, marketing, or distributing application programs conforming to IBM's application programming interfaces.
Each copy or any portion of these sample programs or any derivative work, must include a copyright notice as follows:
(c) (your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs. (c) Copyright IBM Corp. _enter the year or years_. All rights reserved.
Additional legal notices are described in the legal_information.html file that is included in your Rational software installation.
Trademarks
Current, ProjectConsole, Rational, Rational Rose, SoDA, and XDE are trademarks of International Business Machines Corporation in the United States, other countries, or both.
Java and all Java-based trademarks and logos are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other countries.
Linux is a trademark of Linus Torvalds in the United States, other countries, or both.
Other company, product or service names may be trademarks or service marks
of others.