Configuring with environment variables

In addition to the properties, numerous environment variables are used to configure the IBM® Rational® Rhapsody® environment. These environment variables are stored in the rhapsody.ini file, normally located under C:\Winnt on Windows systems.

The following table lists the environment variables used by Rational Rhapsody. For ease of use, the environment variables are listed by section in the order in which they occur in the file.

Environment Variable Description
General section
OMROOT = path Specifies the location of the Share subdirectory of the Rational Rhapsody installation.

For example, if during the installation you specify D:\Rhapsody for the destination folder, the value of OMROOT is as follows:

$OMROOT = D:\Rhapsody\Share

OMDOCROOT = path Specifies the root directory for some Rational Rhapsody documentation as PDF files.
OMHELPROOT = path Specifies the root directory for the Rational Rhapsody online help.
RY_LICENSE_FILE Specifies licensing information needed by FLEXlm. This variable is set to one of the following values:
  • The path to the license.dat file
  • 1717@hostname, where 1717 is the port number (any number in the range 1024 - 65534) and hostname is the name of the Rational Rhapsody license server machine
AnimationPortNumber=6423 Specifies the port number used for communicating with the animation server.
UseVBA = Boolean Specifies whether VBA macros can be used.

For example:

UseVBA = TRUE

EnableWebDownload = Boolean Enables or disables the Download from Web feature.

For example:

EnableWebDownload=TRUE

DefaultEdition = edition Specifies the default edition of Rational Rhapsody to use.

For example:

DefaultEdition = Developer

The values that can be used for this variable are Developer, SystemArchitect, SystemDesigner, Architect, Modeler, and ModelerCorporate.

DefaultLanguage = language Specifies the default programming language for Rational Rhapsody.

For example:

DefaultLanguage = c++

The values that can be used for this variable are c++, cpp, c, java, ada, csharp.

ImplementBaseClasses=TRUE Controls whether the Implement Base Classes window is displayed in implicit requests. By default, this window is displayed only when you explicitly open it.

If you select the Automatically show this window check box on the window, Rational Rhapsody writes this line to the rhapsody.ini file. If wanted, you can add this line directly to the rhapsody.ini file to automatically display the window.

RHAPSODY_AFFINITY = number Sets the affinity of the Rational Rhapsody process. This variable is designed to address the situation where Rational Rhapsody has a problem when there is more than one processor available.

For example, to run Rational Rhapsody on a single processor, add the following line to the rhapsody.ini file:

RHAPSODY_AFFINITY=1

A zero value or lack of this variable disables the mechanism.

NO_OUTPUT_WINDOW=TRUE Disables the output window for reverse engineering (RE) messages to increase performance. RE messages are logged in the file ReverseEngineering.log.
Helpers section
name<#>= string Specifies the name of the helper.

For example:

name1=Reverse Engineer Ada Source Files

command<#> = path to .exe Specifies the invocation command for the helper.

For example:

command1=J:\Rhapsody5\
AdaRevEng\bin\AdaRevEng.exe

initialDir<#> = path Specifies the initial directory for the helper.

For example:

initialDir1=J:\Rhapsody5\
AdaRevEng

isVisible<#> = 0 or 1 Specifies whether the helper is visible in the Tools menu.

For example:

isVisible1=1

isMacro<#> = 0 or 1 Specifies whether the helper is a VBA macro.

For example:

isMacro1=0

arguments<#> = string Specifies the command-line arguments for the helper.

For example:

arguments1=-mode IMPORT

numberOfElements = number Specifies the number of helpers.

For example:

numberOfElements=1

CodeGen section
ExternalGenerator = path Specifies the path to the external generator (if used).

For example:

ExternalGenerator=
J:\Rhapsody5\Sodius\
Launch_Sodius.bat

Note that this variable applies only to IBM Rational Rhapsody Developer for Ada.

Tip section
TimeStamp = Specifies the date and time you ran the Rational Rhapsody installation.

For example:

TimeStamp=Mon Apr 21
09:34:31 2003

StartUp = Boolean Specifies whether to display the Tip of the Day when you start Rational Rhapsody.

For example:

StartUp = 1

Animation section
ViewCallStack = 0 or 1 Specifies whether the call stack should be visible in the next animation session.

For example:

ViewCallStack=0

ViewEventQueue = 0 or 1 Specifies whether the event queue should be visible in the next animation session.

For example:

ViewEventQueue=0

BarsLayout section
BrowserVisible = Boolean Specifies whether the browser should be visible, according to the settings from the last session.

For example:

BrowserVisible=TRUE

FeaturesVisible = Boolean Specifies whether the Features window should be visible, according to the settings from the last session.

For example:

FeaturesVisible=FALSE

FeaturesFloating = Boolean Specifies whether the Features window should be floating or docked, according to the settings from the last session.

For example:

FeaturesFloating=TRUE

BrowserFloating = Boolean Specifies whether the browser should be floating or docked, according to the settings from the last session.

For example:

BrowserFloating=FALSE

Bar<#> Groups the settings corresponding to each toolbar.

For example:

[BarsLayout-Bar29]

BarsLayout-Summary section
Bars = number Specifies the number of toolbars.

For example:

Bars=30

ScreenCX = resolution Specifies the user screen resolution on the X scale.

For example:

ScreenCX=1024

ScreenCY = resolution Specifies the user screen resolution on the Y scale.

For example:

ScreenCY=768

Plug-in section
MTT<Version number> = path Specifies the path to the TestConductor DLL.

For example:

MTT4.1=L:\Rhapsody\v41\
TestConductor\
TestConductor.dll

Tornado section
DefaultTargetServerName = string Specifies the default target-server name used with Tornado.
RecentFilesList section
File<#> = path Lists the .rpy files that have been loaded recently. The maximum number of files listed is four.

For example:

File1=J:\Rhapsody5\ProjectAda\
NewFunc\NewFunc.rpy
File2=J:\Rhapsody5\CPPProjects\
NewFunc\NewStuff\NewStuff.rpy
File3=J:\Rhapsody41MR2\AdaProject\
Dishwasher\Dishwasher\Dishwasher.rpy

Feedback