3RM Install
3RM Install
3RM Install
RM-Install
User’s Reference
Micro Focus
The Lawn
22-30 Old Bath Road
Newbury, Berkshire RG14 1QN
UK
http://www.microfocus.com
The only warranties for products and services of Micro Focus and its affiliates and licensors
(“Micro Focus”) are as may be set forth in the express warranty statements accompanying
such products and services. Nothing herein should be construed as constituting an
additional warranty. Micro Focus shall not be liable for technical or editorial errors or
omissions contained herein. The information contained herein is subject to change without
notice.
This document describes RM-Install first, and then discusses the details of the Windows
Installer package files for each RM component, beginning in the section, Windows Installer
Packages for RM Components (see page 6). It also explains more advanced installation
alternatives for system administrators in Administrative Network Installations (see page 37).
RM-Install
The following topics discuss how to run and configure the RM-Install program.
Running RM-Install
The RM-Install program may be started and run by any number of methods, including one of
the following:
• Open RM-Install.exe in a Windows Explorer window (as a standard Windows program).
• Use the Start | Run menu.
• Enter the name of the program, RM-Install, in a command window.
• Create an autorun configuration file.
• Invoke RM-Install from another program.
When RM-Install begins running, the program searches for any RM license certificate files
(files with the extension .lic). RM-Install starts the search in the current working directory
and then looks in subdirectories for components to be installed. A series of self-explanatory
dialog boxes are displayed: Welcome, License Agreement, Customer Information, License
Certificates, Certificate Activation, Installation Type, Product Selection, Installation Folders,
Ready To Begin Installations, and Installation Status.
To suppress the display of any of these dialog boxes, or to otherwise control the standard
behavior of RM-Install, see the following topic, “Configuring RM-Install.”
Configuring RM-Install
If there are multiple RM product components to be installed, or if the installation of the RM
product components is not closely coupled with the installation of your COBOL application
program, the preferred solution is to configure the behavior of RM-Install rather than
invoking the installation package directly. RM-Install can be configured using a simple
initialization file (.ini) named RM-Install.ini, which is located in the current working
directory.
Note: For backward compatibility, if a file named RM-Install.ini is not present in the current
working directory, RM-Install will then attempt to open a file named LiantInstall.ini.
The configuration file is a simple line-oriented text file. It contains one or more section
headers, which are distinguished by lines that begin with an open square bracket ( [ ) and that
end with a close square bracket ( ] ). The text between the brackets is the name of the section.
Each section header is followed by one or more keyword value pairs. The keyword begins the
line and is delimited by an equals sign (=). The value is the remainder of the line. Keywords
themselves may not contain an equals sign. The white space around the equals sign is not
ignored. Spaces preceding the equals sign will be treated as part of the keyword. Spaces after
the equals sign are treated as part of the value.
[RM-Install]
BypassWelcomeDialog=Y
[Trace Options]
TraceFile=C:\temp\trace.log
This example shows two sections, RM-Install and Trace Options. The RM-Install section
has a single keyword, BypassWelcomeDialog, and it has the value Y. The Trace Options
section also has a single keyword, TraceFile, and it has the value C:\temp\trace.log.
Value Formats
RM-Install has three standard interpretations of keyword values:
• String. String values are straight text and have no further interpretation for formatting
restrictions.
• Integer. Integer values are signed decimal numbers.
• Boolean. Boolean values can be signed decimal numbers, in which case the value 0 is
interpreted as FALSE and any other value is interpreted as TRUE. If the value is not a
valid signed decimal number, the first character of the value is examined. If the first
character is Y or y, the value is interpreted as TRUE. If the first character is N or n, the
value is interpreted as FALSE. Any other value results in an error.
Sections
The RM-Install.ini initialization file has two standard sections with fixed names: RM-Install
and Trace Options. All other sections are treated as configuration sections for the specific
component installations.
Note: If the LiantInstall.ini initialization file was located, the RM-Install section will instead
be named LiantInstall.
RM-Install Section
The RM-Install section is the main configuration area for the RM-Install program, and it is
the main section that you will most likely modify if you wish to install multiple RM
components without combining these installations with the installation of your COBOL
application program. This section supports the following keywords:
• BypassInstallFoldersDialog. This Boolean keyword controls the display of the Install
Folders dialog box. The default value of FALSE causes the dialog box to be displayed.
If the Install Folders dialog box is bypassed, all product executables are installed in a
product-specific directory in the Micro Focus\RM directory within the Program Files
directory of the machine, usually C:\Program Files. Also, the products install their
shortcuts in a RMCOBOL folder within the Program Start menu.
• BypassInstallTypeDialog. This Boolean keyword controls the display of the Install
Type dialog box. The default value of FALSE causes the dialog box to be displayed. If
the Install Type dialog box is bypassed, a Standard installation is performed.
• InstallType. This string keyword controls the type of installation initially presented in
the Install Type dialog box. If the Install Type dialog is bypassed, InstallType indicates
the type of installation performed. The values for this keyword, which are case
insensitive, include Standard, Custom, Administrative, and Network.
The Trace Options section is intended to direct tracing for the RM-Install program, and deals
mostly with the log file. This section supports the following keywords:
• AppendLog. This Boolean keyword indicates that the trace file should not be erased on
each execution, but should be allowed to accumulate tracing. The default value is
FALSE.
• DeleteLog. This Boolean keyword indicates the initial state of the Delete Log File on
Exit flag. The default value is TRUE. Note, however, that in the event an installation
fails, RM-Install will reset this flag to FALSE.
• TraceDirectory. This string keyword contains the name of the directory in which to
place the trace file. The default is the temporary directory of the current user. On
Windows XP, the location of this temporary directory is C:\Documents and
Settings\UserName\Local Settings\Temp. On Windows Vista and later, the location of
this temporary directory is C:\Users\UserName\AppData\Local\Temp.
• TraceFile. This string keyword contains the name of the trace file. The default is RM-
Install.txt. If this is an absolute path, the contents of the TraceDirectory keyword are
ignored.
• WindowsInstallerOptions. This string keyword contains the Windows Installer log
options to pass on the command line of each MSI installation. Specifying the + (append
to existing file) and '!' (flush each line to the log) options are not necessary, as these are
always supplied by RM-Install. The default value is “iwemo”, which logs Informative
messages, Warning messages, Error messages, out-of-Memory or fatal error messages,
and Out-of- disk space messages. Use “*v” for maximum tracing.
For more information, see MSI Command Line Options (on page 7).
Component Sections
The name of the configuration section for each RM component is given below.
where:
• /i indicates that an installation is to be performed.
• /f indicates that an installation is to be repaired. The following RepairOptions are
supported:
− p reinstalls only if file is missing.
− o reinstalls only if file is missing or an older version is installed.
− e reinstalls only if file is missing or an equal or older version is installed.
− d reinstalls only if file is missing or a different version is installed.
− c reinstalls only if file is missing or calculated checksum is different.
− a forces all files to be reinstalled.
− u rewrites all user-specific registry entries.
− m rewrites all computer specific registry entries.
− s overwrites all existing shortcuts.
− v runs from source (media) and re-caches the local package.
Note Do not use this option with the initial installation.
• /a indicates that an Administrative Installation is to be performed (that is, install a
product component on the network). For more information, see Perform an
Administrative Installation to the Network Share (on page 40).
• /x indicates that a product is to be uninstalled.
• /p indicates that a product is to be patched.
where:
NAME must be all capital letters.
value must be quoted if it contains spaces. If value contains double quotes, they are
escaped by supplying a pair of double quotes.
The MSI installation properties common to most RM components include the following:
• ACTCODE. This RM-defined property contains four, four-letter words separated by
spaces that are used to activate the base license certificate contained in the
LICENSEFILES property.
• ADDLOCAL. This Microsoft-defined property contains a comma-separated list of
features to install. This list is case sensitive. See the specific component installation
details for available features, beginning on 11. Use the value of ALL to install all
features in the installation package.
• ALLUSERS. This Microsoft-defined property indicates that the component is to be
installed for all users.
− The value 1 indicates installation for all users. If the current user does not have
sufficient permissions to perform an installation, an error is generated and the
installation is cancelled.
− The value 2 indicates installation for all users, assuming the current user has
sufficient permissions; otherwise, the component is installed for the current user only
and no error message is generated.
The default is to install the component for the current user.
• COMPANYNAME. This Microsoft-defined property contains the default company
name for the installation. The default is the string stored at:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\Current
Version\RegisteredOrganization.
• INSTALLDIR. This Microsoft-defined property contains the absolute path of the
directory into which the component is to be installed. The presence of this property
overrides the value contained in the RMDIR property.
• INSTALLMENU. This RM-defined property contains the complete name of the Start
Menu folder where the installation will store shortcuts. The presence of this property
overrides the value contained in the RMMENU property.
• LDI. This RM-defined property indicates that an installation is being invoked by the
RMInstall program. In the User Interface sequence, this property will cause the
installation to bypass the Welcome, License Agreement, User Information, and Setup
Type dialog boxes and display the Custom Setup dialog box directly. Furthermore, in an
Administrative Installation, the LDI option causes the NETWORKDIR option to be
taken as the complete name of the target directory into which the installation is to take
place.
• RMDIR. This RM-defined property contains the name of a directory where the
installation will create its own directory for storing the executables. The default value is
C:\Program Files\Micro Focus\RM.
• RMMENU. This RM-defined property contains either a prefix or a folder where the
installation will create its own folder for storing shortcuts. On Windows 10, RMMENU
is a prefix for the folder that the installation will create for storing its shortcuts. The
default prefix is RM. On Windows 7 and earlier, RMMENU contains the name of a Start
Menu folder where the installation will create its own folder for storing shortcuts. The
default value is RMCOBOL.
• LICENSEFILES. This RM-defined property contains a semicolon-separated list of
license certificate files to be used in installing a component.
• NETWORKDIR. This RM-defined property contains the name of a directory where the
installation will create its own directory for storing an Administrative Installation. This
property is valid only during an Administrative Installation. The default value is the root
of the first (alphabetically) network drive letter defined on the current machine.
• NOCOMPANYNAME. This Microsoft-defined property indicates whether the
installation should determine the company name from information in the Windows
registry.
− The value 1 indicates suppressing use of the registry to initialize the
COMPANYNAME option.
− Any other value will enable the use of the registry to initialize the
COMPANYNAME option.
• NOUSERNAME. This Microsoft-defined property indicates whether the installation
should determine the user name from information in the Windows registry.
− The value 1 indicates suppressing use of the registry to initialize the USERNAME
option.
− Any other value will enable the use of the registry to initialize the USERNAME
option.
• REMOVE. This Microsoft-defined property contains a comma-separated list of features
to uninstall. This list is case sensitive. For a list of component-specific features, see the
discussions of the actual component installations in RM Component-Specific Installation
Details (on page 11).
• REBOOT. This Microsoft-defined property indicates how the installation should handle
rebooting. Note that only the first character of the value is necessary.
− The value Force indicates that the installation should always reboot following a
successful installation. If the user interface is running, the installation prompts for
permission to reboot. If the user interface is not running, the installation reboots the
system automatically.
− The value Suppress indicates that the installation should suppress reboots, even if
the installation encountered a file that is in use.
− The value ReallySuppress indicates that the installation should never reboot.
• REBOOTPROMPT. This Microsoft-defined property indicates how the installation
should handle the prompting for reboot. Note that only the first character of the value is
necessary.
− The value Suppress indicates that the installation should perform any necessary
reboots without prompting.
− Any other value indicates that the installation should perform any necessary reboots
with prompts.
• USERNAME. This Microsoft-defined property contains the default user name for the
installation. The default is the string stored at:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\Current
Version\RegisteredOwner.
Filename
The name of the Relativity Data Client’s 32-bit package file is Dclient.msi. The name of the
Relativity Data Client’s 64-bit package file is Dclient64.msi. These files are located in the
RM product directory Dclient\046.
Properties
Note The following table lists the original command line options previously used to automate
the installation of the Relativity Data Client. The second column lists the equivalent
command line options (or properties) provided for the component in the MSI Windows
Installer program. For more information, see Installation Command Line Options (on page
7).
-_AUTO /q
-_DELETE Not supported
-_DRIVER DRIVERNAME
-_FOLDER INSTALLMENU
-_MFFH Not supported
-_MOVE=Y Standard behavior
-_ORG COMPANYNAME
-_SERVER SERVER
Features
The Relativity Data Client package includes the following installation features:
• DataClient installs the Relativity Data Client ODBC Driver.
• ServerAdministrator installs the Relativity Server Administrator.
• DriverHelpFiles installs the help files for the Relativity Data Client.
• InstallKit installs the Relativity Installation Kit library.
• QueryPlanViewer installs the Query Plan Viewer utility.
• ReadMes installs the README files for the Relativity Data Client.
• SupportTools installs the RM support tools.
The ADDLOCAL property (see page 9) is a comma-separated list of features that are to be
installed.
To install all of the features, enter the following:
To install all of the features, except the Relativity Server Administrator, enter the following:
Filename
The name of the Relativity Data Manager’s package file is DManager.msi. This file is
located in the RM product directory DManager\046.
Properties
Note The following table lists the original command line options previously used to automate
the installation of the Relativity Data Manager. The second column lists the equivalent
command line options (or properties) provided for the component in the MSI Windows
Installer program. For more information, see Installation Command Line Options (on page
7).
-_AUTO /q
-_BTRIEVE ADDLOCAL=Btrieve
-_DELETE Not supported
-_DRIVER DRIVERNAME
-_FILEMGR FILEMGR
-_FOLDER INSTALLMENU
-_INFOEXPRESS ADDLOCAL=InfoExpress
-_LICENSE LICENSEFILES
-_MFFH MFFM
-_MOVE=Y Standard behavior
-_ORG COMPANYNAME
-_SAMPLES ADDLOCAL=Samples
-SMS Not required
-_STARTMTR Standard behavior
-_TARGETDIR INSTALLDIR
-_USERNAME USERNAME
Features
To install all of the features, except the Btrieve and RM/InfoExpress clients, enter the
following:
Filename
The name of the Relativity Data Server’s package file is DServer.msi. This file is located in
the RM product directory DServer\046.
Properties
Note The following table lists the original command line options previously used to automate
the installation of the Relativity Data Server. The second column lists the equivalent
command line options (or properties) provided for the component in the MSI Windows
Installer program. For more information, see Installation Command Line Options (see page
7).
-_ACCOUNT ACCOUNT
-_AUTO /q
-_FILEMGR FILEMGR
-_FOLDER INSTALLMENU
-_LICENSE LICENSEFILES
-_ORG COMPANYNAME
-_PASSWORD PASSWORD
-_PORTNUMBER PORTNUMBER
-SMS Not required
-_TARGETDIR INSTALLDIR
-_USERNAME USERNAME
Features
To install all of the features, except the Btrieve and RM/InfoExpress clients, enter the
following:
This section explains how to invoke the Relativity Database Administrator (DBA) installation
package directly. It also describes the name of the package file, and the DBA-specific
features that are supplied to the MSI installation by means of the command line option,
Property (see page 8).
Filename
The name of the Relativity DBA’s package file is DBA.msi. The file is located in the RM
product directory DBA.
Properties
The Relativity DBA package does not support any additional, component-specific installation
properties.
Note The following table lists the original command line options previously used to automate
the installation of the Relativity DBA. The second column lists the equivalent command line
options (or properties) provided for the component in the MSI Windows Installer program.
For more information, see Installation Command Line Options (see page 7).
-_AUTO /q
-_FOLDER INSTALLMENU
-_LICENSE LICENSEFILES
-_ORG COMPANYNAME
-SMS Not required
-_TARGETDIR INSTALLDIR
-_USERNAME USERNAME
Features
To install all of the features, except the Report Scripts files, enter the following:
Filename
The name of the Relativity Designer’s package file is RelDesigner.msi. This file is located in
the RM product directory Designer.
Properties
The Relativity Designer package does not support any additional, component-specific
installation properties.
Features
To install all of the features, except the Micro Focus COBOL Shirt sample files, enter the
following:
Filename
The name of the Relativity Java Client’s package file is JClient.msi. This file is located in
the RM product directory JDBC.
Properties
The Relativity Java Client package does not support any additional, component-specific
installation properties.
Features
To install all of the features, except the sample files, enter the following:
Filename
The name of the RM/COBOL CodeWatch integrated development environment’s package file
is CodeWatch.msi. This file is located in the RM product directory 046.
Properties
Features
To install all of the features, except the BIS sample files, enter the following:
Filename
The name of the RM/COBOL Compiler’s package file is Compiler.msi. For the 32-bit
version of the RM/COBOL Compiler, this file is located in the RM product directory 046.
For the 64-bit version of the RM/COBOL Compiler, this file is located in the RM product
directory 075.
Properties
Features
To install all of the features, except the verification suite source, enter the following:
Filename
The name of the RM/COBOL Recover1 Utility’s package file is Recover1.msi. For the 32-
bit version of Recover1, this file is located in the RM product directory 046. For the 64-bit
version of Recover1, this file is located in the RM product directory 075.
Properties
Features
To install all of the features, except the support tools, enter the following:
Filename
The name of the RM/COBOL Runtime’s package file is Runtime.msi. For the 32-bit version
of the RM/COBOL runtime, this file is located in the RM product directory 046. For the 64-
bit version of the RM/COBOL runtime, this file is located in the RM product directory 075.
Properties
Features
To install all of the features, except the non-COBOL development tools, enter the following:
Filename
The name of the RM/InfoExpress’ package file is InfoExpress.msi. For the 32-bit version of
RM/InfoExpress, this file is located in the RM product directory 046. For the 64-bit version
of RM/InfoExpress, this file is located in the RM product directory 075.
Properties
Features
To install all of the features, except the RM/InfoExpress Viewer program, enter the following:
Filename
The name of the WOW Extensions Designer’s package file is WowDesigner.msi. This file is
located in the RM product directory 046.
Properties
The WOW Extensions Designer package does not support any additional, component-specific
installation properties.
Features
The ADDLOCAL property (see page 9) is a comma-separated list of features that are to be
installed.
To install all of the features, enter the following:
To install all of the features, except the RM/Panels sample files, enter the following:
Filename
The name of the WOW Thin Client’s package file is TClient.msi. For 32-bit version of the
WOW Thin Client, this is located in the RM product directory 046. For 64-bit version of the
WOW Thin Client, this is located in the RM product directory 075.
Properties
The WOW Thin Client package does not support any additional, component-specific
installation properties.
Features
To install all of the features, except the README files, enter the following:
Filename
Properties
Features
The Xcentrisity Business Information Server (BIS) package includes the following features:
• BusinessInformationServer installs the BIS Request Handler and Service Engine.
• Documentation installs the Xcentrisity Business Information Server documentation.
• ExternalAccessMethod installs the Btrieve and RM/InfoExpress external access
support.
• ReadMes installs the README files for the Xcentrisity Business Information Server.
• Samples installs the common files for the samples.
• Sample1 installs the Program-driven sample application.
• Sample2 installs the Transform-driven sample application.
• Sample4 installs the AccountInfo Web Service sample application.
To install all of the features, except all of the samples, enter the following:
As an optional step, you may also create an autorun.inf file in the root directory of the
network share with the following contents:
[AutoRun]
icon=RM-Install.exe
open=RM-Install
shell\Install\command=RM-Install.exe
shell\Install=RM Install
In this case:
• If the Windows client machine has autorun enabled, RM-Install will start automatically
when the network share is opened on the client machine.
• If an autorun.inf file is not placed in the root directory of the network share, the end
users must open RM-Install to initiate an installation.
After RMInstall is invoked, the installation will proceed as normal. When the Installation
Type dialog box is displayed, the users can select Network Installation. If the installation of
the product component supports that installation type, the installation will run from the
network share. To determine whether an installation component supports this capability, see
the NETWORKINSTALL property in the specific installation detail sections for the
following:
• RM/COBOL CodeWatch Integrated Development Environment (see page 22)
• RM/COBOL Compiler (see page 24)
• RM/COBOL Recover1 Utility (see page 26)
• RM/COBOL Runtime (see page 28)
ComponentName\Version\PlatformKey\ComponentName.msi
The value in the PlatformKey directory is a number that RM uses to distinguish between
various hardware and software platforms. In the case of components that run on only one
platform, there will be no PlatformKey directory present in the Version directory. The
PlatformKey value for 32-bit Windows is 046. The PlatformKey value for 64-bit
Windows is 075.
Note In this technique, it is necessary for the RM-Install program to preserve the
directory structure. Since RM-Install installs only Windows components, you need only
copy the Version directory for the components that you wish end users to install and the
046 or 075 value of the PlatformKey directory, if present, for those components. Other
PlatformKey directories will contain the components for UNIX platforms and are not
necessary to copy to the workstation.
3. Copy the RM license certificate files for the components to be installed into the network
share.
If you place multiple license certificates into the root directory of the network share, you
will need to give them unique names. As long as these files have the extension of .lic, the
RM-Install program will be able to locate them. You may also place these files into the
directories, ComponentName, Version, or PlatformKey, in which case, they may continue
to have the name liant.lic.
4. Following the instructions on how to configure RM-Install (see page 2). Create a RM-
Install.ini file into the root directory of the network share to control the dialog boxes that
end users will see.
As an optional step, you may also create an autorun.inf file in the root directory of the
network share with the following contents:
[AutoRun]
icon=RM-Install.exe
open=RM-Install
shell\Install\command=RM-Install.exe
shell\Install=RM Install
In this case:
• If the Windows client machine has autorun enabled, RM-Install will start automatically
when the network share is opened on the client machine.
• If an autorun.inf file is not placed in the root directory of the network share, the end
users must open RM-Install to initiate an installation.
ComponentName\Version\PlatformKey\ComponentName.msi
The value in the PlatformKey directory is a number that RM uses to distinguish between
various hardware and software platforms. In the case of components that run on only one
platform, there will no PlatformKey directory present in the Version directory. The
PlatformKey value for 32-bit Windows is 046. The PlatformKey value for 64-bit
Windows is 075.
Note In this technique, it is not necessary for the RM-Install program to preserve the
directory structure. It is only necessary to copy the MSI installation file from the 046
PlatformKey directory, if present, for the components you wish end users to install. It is
also not necessary to preserve the name of the MSI installation file. You may rename it
to any name that is meaningful to you and your end users.
2. Copy the RM license certificate files for the component to be installed into the root
directory of the network share. The license certificate must have the name liant.lic.
To initiate an installation, end users must locate the MSI installation file for the desired
component and open it. You may also create a shortcut or command script to encapsulate the
invocation of the installation and its command line options.
msiexec /a ComponentName.msi
3. When the installation prompts for a Network location, enter either the root directory of
the network share or the desired name of a subdirectory within the network share where
the installation should be unpacked.
4. Place the RM license certificate file for the component into the directory specified for the
Network location.
To initiate an installation, the end user must locate the MSI installation file for the desired
component and open it. You may also create a shortcut or command script to encapsulate the
invocation of the installation and its command line options.