Readme for Rational Rhapsody 8.2 iFix003

Note that the installation of this iFix requires you to manually extract the content of a number of .zip files after you run the executable file provided. See the installation instructions at the end of this document for details.

Changes in iFix003

Changes in iFix002

Changes in iFix001

Installation instructions

Improvements for Rhapsody Design Manager users

This iFix is required to complement Rhapsody DM 6.0.3 iFix006 (available on jazz.net).

Rhapsody APARs Fixed with 8.2 iFix003

iFix003 for Rhapsody 8.2 includes the following fixes, which were included in iFix002.

Rhapsody APARs Fixed with 8.2 iFix002

Improvements included in iFix002 for Rhapsody users

Code generation - location of descriptions for guarded operations

Prior to release 8.2., when C code was generated, the descriptions for guarded operations were generated in the implementation file rather than in the specification file. This issue was corrected in 8.2, however, the parts of the description that are taken from arguments and requirements were not included in the fix for the problem. In ifix002 for 8.2, this remaining issue has been corrected. To preserve the previous code generation behavior for models created prior to the 8.2 release, the property C_CG::Operation::UsePre821GuardedOperationDescriptionLocation was added to the backward compatibility settings for C with a value of True.

Note that if you plan to use this iFix with models that were created with Rational Rhapsody 8.2 or 8.2 iFix001, the updated backward compatibility settings will not be loaded automatically. If you want to retain the previous code generation behavior for such cases, you will have to add the property UsePre821GuardedOperationDescriptionLocation with a value of True in your site.prp file.

Rhapsody API - methods that cannot accept NULL as parameter

Prior to this release, when a NULL value was passed to an API method that expects a non-NULL parameter, the message "Element Deleted" was displayed. Beginning with this release, the error message that is displayed in such cases is "Invalid parameter".

iFix003 for Rhapsody 8.2 includes the following fixes, which were included in iFix001.

Rhapsody APARs Fixed with 8.2 iFix001

Improvements included in iFix001 for Rhapsody users

New command-line option added

-cmd=close_all_diagrams

This new command closes all diagrams that are currently open.

Shortcut list for graphic elements - improvements

All elements that can contain compartments now have a property called QuickNavigationCategory, which is used to compose the shortcut list. The property can include any of the following categories:

• MainBehavior
• MainDiagram
• Hyperlinks
• InternalBlockDiagrams (for SysML only)
• Diagrams
• StateCharts
• Activities
• References
• DiagramReferences

In addition, the shortcut list is now available on boxes in Structure mode as well (not just Specification mode).

The shortcut list can be enabled/disabled by modifying the value of the property General::Graphics::EnableQuickNavigation. After changing the value of the property, you have to refresh the diagram (F5) or reopen the model for the change to take effect.

Code generation - new property - FullQualifiedTypeName

The following properties were added to the C++ factory. If the value is changed to True, it forces generation of full qualified name. Note that to activate the fix for PI73079 (Namespace CG conflict causes truncated path in operation return type), you must add these properties to the site.prp file with a value of True.

Subject CPP_CG
	Metaclass Operation
	    Property FullQualifiedTypeName Bool "False"
	end 
	Metaclass Argument
	    Property FullQualifiedTypeName Bool "False"
	end
	Metaclass Attribute
	    Property FullQualifiedTypeName Bool "False"
	end
	Metaclass Relation
	    Property FullQualifiedTypeName Bool "False"
	end
end

Rhapsody API - errorMessage() and getErrorMessage() - change in behavior

Previously, the errorMessage() and getErrorMessage() methods would return the most recent error. So if a method call resulted in an exception, and you called additional methods afterwards, you could still get the original error, provided that the additional calls were all successful.

Now, the most recent error is cleared when a method is called successfully. So in order to get the error message, getErrorMessage() must be called immediately after the method that failed. This applies to:

• IRPApplication.errorMessage()
• IRPApplication.getErrorMessage()
• IRPModelElement.errorMessage()
• IRPModelElement.getErrorMessage()

Support for ReporterPlus in 64-bit version of Rational Rhapsody

In addition to the iFix files, a separate executable file has been provided for adding support for ReporterPlus to the 64-bit version of Rational Rhapsody. To add support for ReporterPlus:

1. Install the iFix according to the instructions in this document.
2. Extract the files contained in RhapsodyReporter82iFix1_X64.zip
3. Run the executable file that was extracted.

Conditional property syntax - additional options added

When using the conditional property syntax, you can now include the following options.

• $<Env::MY_ENV_VAR> - use to include the value of an environment variable
• $<INI::Section,VarName> - use to include the value of a variable from the rhapsody.ini file
• $<ProjectPath> - use to include the path to the .rpy file for the project
• $<ProjectName> - use to include the name of the project

Constraints, comments, and requirements - changes in appearance

For constraints, comments, and requirements in diagrams, minor changes have been made to the icon that is displayed in the corner of the element - in terms of the location and background color of the icon.

Applying the iFix

A number of steps in this section refer to the Share directory as being a subdirectory of the main Rhapsody installation directory. Note that if you performed a "split" installation of Rhapsody - meaning that you did not use the "Install all Rhapsody files in one location" option - then the Share directory will be located in the user home directory, for example, C:\Users\<username>\IBM\Rational\Rhapsody.

On Windows - using MSI installation to install iFix for 32-bit version of Rhapsody

1. Verify that you have installed IBM Rational Rhapsody 8.2 (BuildNumber-9794446).
2. Make sure that Rhapsody is not currently running.
3. Download the .zip file for the iFix: Rhapsody82iFix003_x86.zip
4. Back up the folder <Rhapsody installation directory>\Eclipse by moving its content to a different folder.
5. Back up the folder <Rhapsody installation directory>\RTCIntegration by moving its content to a different folder.
6. After extracting the contents of the .zip file, run the executable file Rhapsody82iFix_x86.exe
7. Click Update in the InstallShield Wizard.
8. Click Finish when the installation is done.
9. In the folder <Rhapsody installation directory>, locate the file RhapsodyRoot.zip.
10. Use "extract here" to extract the contents of RhapsodyRoot.zip
11. Back up the folder <Rhapsody installation directory>\Share\LangC\mxf by moving its content to a different folder.
12. Open the folder <Rhapsody installation directory> and locate the file RhapsodyShare.zip. (If you performed a "split" installation, the RhapsodyShare.zip file will be located in the folder that contains the Share folder.)
13. Use "extract here" to extract the contents of RhapsodyShare.zip

On Windows - using MSI installation to install iFix for 64-bit version of Rhapsody

1. Verify that you have installed IBM Rational Rhapsody 8.2 (BuildNumber-9794446).
2. Make sure that Rhapsody is not currently running.
3. Download the .zip file for the iFix: Rhapsody82iFix003_x64_a.zip
4. Back up the folder <Rhapsody installation directory>\Eclipse by moving its content to a different folder.
5. Back up the folder <Rhapsody installation directory>\RTCIntegration by moving its content to a different folder.
6. After extracting the contents of the .zip file, run the executable file Rhapsody82iFix_x64.exe
7. Click Update in the InstallShield Wizard.
8. Click Finish when the installation is done.
9. In the folder <Rhapsody installation directory>, locate the file RhapsodyRoot.zip.
10. Use "extract here" to extract the contents of RhapsodyRoot.zip.
11. Back up the folder <Rhapsody installation directory>\Share\LangC\mxf by moving its content to a different folder.
12. Open the folder <Rhapsody installation directory> and locate the file RhapsodyShare.zip. (If you performed a "split" installation, the RhapsodyShare.zip file will be located in the folder that contains the Share folder.)
13. Use "extract here" to extract the contents of RhapsodyShare.zip

On Windows - using archived files to install iFix for 32-bit version of Rhapsody

1. Verify that you have installed IBM Rational Rhapsody 8.2 (BuildNumber-9794446)
2. Make sure that Rhapsody is not currently running.
3. Download the .zip file for the iFix: Rhapsody82iFix003_Win32_manual.zip
4. After extracting the contents of the .zip file, carry out the following steps:
   1. Copy RhapsodyRoot.zip into the <Rhapsody installation directory> folder.
   2. Back up the folder <Rhapsody installation directory> by copying all .exe and .dll files to a different folder.
   3. Back up the folder <Rhapsody installation directory>\RTCIntegration by moving its content to a different folder.
   4. Back up the folder <Rhapsody installation directory>\Eclipse by moving its content to a different folder.
   5. Open RhapsodyRoot.zip to see which files are going to be replaced, and decide if you want to back up any additional files from your current installation of Rhapsody. (You will need these files if you decide later to uninstall the iFix.)
   6. Use "extract here" to extract the contents of RhapsodyRoot.zip, answering "yes" to override existing files.
   7. If you installed TestConductor previously:
      1. Copy TestConductor.zip into the <Rhapsody installation directory> folder.
      2. Back up the folder <Rhapsody installation directory>\TestConductor by moving its content to a different folder.
      3. Use "extract here" to extract the contents of TestConductor.zip, answering "yes" to override existing files.
   8. Copy RhapsodyShare.zip into the <Rhapsody installation directory>\Share folder. (If you performed a "split" installation, copy the RhapsodyShare.zip file into the Share folder, usually located under C:\Users\<username>\IBM\Rational\Rhapsody.)
   9. Open RhapsodyShare.zip to see which files are going to be replaced, and decide if you want to back up any of these files from your current installation of Rhapsody. (You will need these files if you decide later to uninstall the iFix.)
   10. Use "extract here" to extract the contents of RhapsodyShare.zip, answering "yes" to override existing files.
   11. Copy RhapsodySamples.zip into the <Rhapsody installation directory>\Samples folder
   12. Open RhapsodySamples.zip to see which files are going to be replaced, and decide if you want to back up any of these files from your current installation of Rhapsody. (You will need these files if you decide later to uninstall the iFix.)
   13. Use "extract here" to extract the contents of RhapsodySamples.zip, answering "yes" to override existing files.

On Windows - using archived files to install iFix for 64-bit version of Rhapsody

1. Verify that you have installed IBM Rational Rhapsody 8.2 (BuildNumber-9794446)
2. Make sure that Rhapsody is not currently running.
3. Download the .zip file for the iFix: Rhapsody82iFix003_x64_manual.zip
4. After extracting the contents of the .zip file, carry out the following steps:
   1. Copy RhapsodyRoot.zip into the <Rhapsody installation directory> folder.
   2. Back up the folder <Rhapsody installation directory> by copying all .exe and .dll files to a different folder.
   3. Back up the folder <Rhapsody installation directory>\RTCIntegration by moving its content to a different folder.
   4. Back up the folder <Rhapsody installation directory>\Eclipse by moving its content to a different folder.
   5. Open RhapsodyRoot.zip to see which files are going to be replaced, and decide if you want to back up any additional files from your current installation of Rhapsody. (You will need these files if you decide later to uninstall the iFix.)
   6. Use "extract here" to extract the contents of RhapsodyRoot.zip, answering "yes" to override existing files.
   7. If you installed TestConductor previously:
      1. Copy TestConductor.zip into the <Rhapsody installation directory> folder.
      2. Back up the folder <Rhapsody installation directory>\TestConductor by moving its content to a different folder.
      3. Use "extract here" to extract the contents of TestConductor.zip, answering "yes" to override existing files.
   8. Copy RhapsodyShare.zip into the <Rhapsody installation directory>\Share folder. (If you performed a "split" installation, copy the RhapsodyShare.zip file into the Share folder, usually located under C:\Users\<username>\IBM\Rational\Rhapsody.)
   9. Open RhapsodyShare.zip to see which files are going to be replaced, and decide if you want to back up any of these files from your current installation of Rhapsody. (You will need these files if you decide later to uninstall the iFix.)
   10. Use "extract here" to extract the contents of RhapsodyShare.zip, answering "yes" to override existing files.
   11. Copy RhapsodySamples.zip into the <Rhapsody installation directory>\Samples folder
   12. Open RhapsodySamples.zip to see which files are going to be replaced, and decide if you want to back up any of these files from your current installation of Rhapsody. (You will need these files if you decide later to uninstall the iFix.)
   13. Use "extract here" to extract the contents of RhapsodySamples.zip, answering "yes" to override existing files.

On Linux

1. Verify that you have installed IBM Rational Rhapsody 8.2 (BuildNumber-9794446)
2. Make sure that Rhapsody is not currently running.
3. Download the .zip file for the iFix: Rhapsody82iFix003-Linux.zip
4. After extracting the contents of the .zip file, open IBM Installation Manager.
5. From the menu, select File --> Preferences.
6. Select "Add Repository".
7. Click "Browse..." and select the file <Rhapsody8.2_iFix3 extract folder>\repository.config
8. Clear the "search service repositories during installation and updates" check box.
9. Click "OK" to close the Preferences dialog.
10. Click "Update".
11. Select "IBM Rational Rhapsody Developer 8.2" installation and click "Next".
12. Select "IBM Rational Rhapsody Developer 8.2 iFix 003" and click "Next".
13. Click "Update" to start the update process.
14. Click Finish when the installation is done.

Uninstalling the iFix

On Windows - using MSI installation

1. Open the folder: <Rhapsody installation directory>\Share\LangC\mxf
2. Restore the content of this folder from the backup created during the installation
3. Go to Control Panel > All Control Panel Items > Programs and Features, and select "View installed updates".
4. Select the relevant entry under IBM Rational Rhapsody 8.2xxxx
5. Delete the current contents of the directory <Rhapsody installation directory>\Eclipse.
6. Restore the content of the Eclipse folder from the backup that you created during the installation
7. Delete the current contents of the directory <Rhapsody installation directory>\RTCIntegration.
8. Restore the content of the RTCIntegration folder from the backup that you created during the installation

On Windows - using archived files

1. Restore the folder <Rhapsody installation directory>:
   1. Delete the current contents of the directory <Rhapsody installation directory>\Eclipse.
   2. Delete the current contents of the directory <Rhapsody installation directory>\RTCIntegration.
   3. Restore the following folders from the backup that you created during the installation:
      • <Rhapsody installation directory>
      • <Rhapsody installation directory>\RTCIntegration
      • <Rhapsody installation directory>\Eclipse
      • <Rhapsody installation directory>\TestConductor (if you have TestConductor installed)
   4. Remove the file RhapsodyRoot.zip
   5. Remove the file TestConductor.zip
2. Restore the folder <Rhapsody installation directory>\Share:
   1. Restore the content of any folders that you backed up during the installation
   2. Remove the file RhapsodyShare.zip
3. Restore the folder <Rhapsody installation directory>\Samples:
   1. Restore the content of any folders that you backed up during the installation
   2. Remove the file RhapsodySamples.zip

On Linux

1. Open IBM Installation Manager.
2. Click "Uninstall".
3. Select "IBM Rational Rhapsody Developer 8.2 (iFix 003)" and click "Next".
4. Click Finish when done.