Engineering Insights upgrade script

Use the relm_upgrade script to update your IBM® Engineering Lifecycle Optimization Engineering Insights version.

Purpose

The relm_upgrade script upgrades all releases of Engineering Insights to version 7.0.3.. Although the script file is located under the upgrade/relm directory, it must be run from the ENI/_install_dir/server directory. If your path contains spaces, ensure that you enclose the path name in double quotation marks. Enter [E] to execute the command, [S] to skip a step, or hit [Enter] to cancel the script execution.

As an alternative to running the script and all its command-line arguments, you can open the script parameters file, modify the default values, and run an abbreviated form of the script.

The English and translated versions of the relm_params files are in the ENI/_install_dir/server/upgrade/relm/params directory. Open relm_params or a translated version of it for editing and specify values for each parameter. One of the parameters that must be set is the path to the OLD_APPLICATION_HOME directory. This must be an existing directory that is ended by server/conf.

The script performs the following steps:
  • Step 0: Runs the -migration_relm_updateConfigurationFiles command that updates the server configuration files. After the configuration files are merged successfully, enter [C] to continue. An editor opens in which you can verify the Jazz® Team Server and the Engineering Insights application teamserver.properties files. Verify that the Public URI root denoted by the com.ibm.team.repository.server.webapp.url property is correct. Also verify that the database properties are correct. When done, save your changes, if any, and close the editor to continue the script execution.
  • Step 1: Adds tables to the Engineering Insights repository database.

In a distributed environment where applications are installed on separate servers and you want to upgrade all applications from one server (to use either the Upgrade script or Upgrade script in silent mode options), you must be able to access the drive or file system where other applications are installed.

The mounted drive must be configured with read-write-execute privileges for the administrator account. If you cannot access the shared drives from one server, then select Manual Upgrade option and physically go to each server and perform the upgrade.

For Windows
operating systemIf using network shares on Windows systems for example, the mount must be in this format: mounted_drive_letter:\server\conf. An absolute path, such as \\computer name\JTS_install_dir\server\conf, will not work.

For Unix
operating systemsOn UNIX systems for example, the mount must be in this format: mount -t nfs IP Address of the server:/opt/IBM/JazzTeamServer.

Parameters

Attribute Description Required Default
-oldApplicationHome Full path to the old Engineering Insights configuration directory. The path must not contain any spaces. In a typical installation, this path is old_ENI_install_dir/server/conf. Yes none
-applicationContextRoot Engineering Insights context root. No relm
-oldApplicationVersion The Engineering Insights version that is being upgraded. No By default, the version of the Rational® Engineering Lifecycle Manager to be upgraded is detected automatically.
-newApplicationHome Path to the Engineering Insights application configuration directory of the 7.0.3. installation. No ENI_install_dir/server/conf
-updateAppServerFiles By default, this option is set to yes to update the new IBM WebSphere® Liberty configuration files with the old Liberty configuration.
Important: The yes attribute used to copy files to a new application server is deprecated. However, if you are upgrading to 7.1.0 SR1 interim fix 4, you must use the parameter with the no attribute.
No yes
-newJTSHome Path to the Jazz Team Server configuration directory of the 7.0.3. installation. By default, the -newJTSHome parameter value is derived from the -newApplicationHome parameter value. Yes none
-jtsContextRoot Context root of the 7.0.3. Jazz Team Server. No jts
-noPrompt Do not prompt before you create or modify the tables. No none
-noVerify Do not perform teamserver.properties file verification. No none
-overwrite Whether to overwrite any existing file. No no
-noStepPrompt Do not prompt before you execute a step. No false
-noEditor The -noEditor parameter eliminates opening an editor during the execution of the upgrade script to review or modify the teamserver.properties file. The -noEditor parameter in conjunction with -noStepPrompt, -noVerify, -noResumePrompt, and -noPrompt parameters can be used for a fully automated upgrade script without any user interactions. If you need to review or modify the teamserver.properties file during the upgrade, such as in a WebSphere Liberty server environment where the index location might be relative to the profile directory, do not use this parameter. No false
-noResumePrompt Do not prompt when resuming an upgrade step. No false
-oldApplicationTomcatHome Full path to the Tomcat root directory in the old installation. Must be an existing directory. By default, the -oldApplicationTomcatHome parameter is derived from the -oldApplicationHome parameter value. No N/A

Example

Open a command prompt and enter this command:

Option Description
Windows
cd "C:\Program Files\IBM\JazzTeamServer\server\"
upgrade\relm\relm_upgrade.bat -oldApplicationHome old_ENI_install_dir\server\conf -newJTSHome new_JTS_install_dir\server\conf
Linux®
cd /opt/IBM/JazzTeamServer/server/
./upgrade/relm/relm_upgrade.sh -oldApplicationHome old_ENI_install_dir/server/conf -newJTSHome new_JTS_install_dir/server/conf
Note: If you want to run the upgrade command in the silent mode, add the -noPrompt, -noResumePrompt, -noVerify, -noStepPrompt, and -noEditor parameters in the upgrade command.