relm_upgrade script reference

The relm_upgrade script is used when updating from an older version of Rational® Engineering Lifecycle Manager.

Purpose

The complete Rational Engineering Lifecycle Manager upgrade process is described in Upgrading Rational Engineering Lifecycle Manager. The parameters in the upgrade script may need to be modified if you are using non-default values.

The relm_upgrade script upgrades Rational Engineering Lifecycle Manager 1.0, 1.0.0.1, 4.0.3 or 4.0.4 to 4.0.6. Although the script file is located under the upgrade/relm directory, it must be run from the RELM_4.0.6_install_dir/server directory. Also if your path contains spaces, ensure that you enclose the path name in double quotation marks.

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

The English and translated versions of the relm_params files are located in the RELM_4.0.6_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 ended by server/conf.

The script performs the following tasks:
  • Runs the -migration_relm_updateConfigurationFiles command that updates the configuration and Tomcat files (if updateTomcatFiles is not set to No). Enter [E] to execute the command, [S] to skip the step, or hit [Enter] to cancel the script execution.
  • Updates the teamserver.proprties files based on the information from the previous version. After the configuration files are merged successfully, enter [C] to continue. An editor opens in which you can verify the Change and Configuration Management application teamserver.properties file. 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.
  • In a Tomcat environment, merges the content of server.xml and web.xml files with the new version and copies the old version tomcat-users.xml file.
  • Adds tables to the Rational Engineering Lifecycle Manager repository database.

Parameters

Attribute Description Required Default
oldApplicationHome Full path to the old Rational Engineering Lifecycle Manager configuration directory. The path must not contain any spaces. In a typical installation, this path is old_relm_install_dir/server/conf. Yes none
applicationContextRoot Rational Engineering Lifecycle Manager context root. No relm
oldApplicationVersion The Rational Engineering Lifecycle Manager version that is being upgraded. No 4.0.4
newApplicationHome Path to the Rational Engineering Lifecycle Manager application configuration directory of the 4.0.6 installation. No relm_4.0.6_install_dir/server/conf
updateTomcatFiles Whether to update the Tomcat configuration files. Set this value to "no" if you are using WebSphere® Application Server. No yes
oldApplicationTomcatHome Full path to the Tomcat home directory of previous version installation. By default, the oldTomcatHome parameter is derived from the oldApplicationHome parameter value. No none
newApplicationTomcatHome Path to the Rational Engineering Lifecycle Manager application Tomcat home directory of the 4.0.6 installation. By default, the newApplicationTomcatHome parameter value is derived from the newApplicationHome parameter value. No none
newJTSHome Path to the Jazz™ Team Server configuration directory of the 4.0.6 installation. By default, the newJTSHome parameter value is derived from the newApplicationHome parameter value. No none
jtsContextRoot Context root of the 4.0.6 Jazz Team Server. No jts
noPrompt Do not prompt before creating or modifying 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 executing a step. No none
Windows:
cd C:\Program Files\IBM\JazzTeamServer\Server\
upgrade\relm\relm_upgrade.bat -oldApplicationHome old_relm_install_dir\server\conf
Linux:
cd opt/IBM/JazzTeamServer/Server/
./upgrade/relm/relm_upgrade.sh -oldApplicationHome old_relm_install_dir/server/conf

Feedback