rm_upgrade script

Use this script to upgrade Requirements Management (RM) application.


The rm_upgrade script upgrades some releases of Requirements Management applications version 6 to 7.0.1.
Note: The only supported versions that can be upgraded to version 7.0.1 are 6.0.2, 6.0.6, and If your current Requirements Management application is at a different version, you must first upgrade it to any of these supported versions before you can upgrade to version 7.0.1.
Although the script file is located under the upgrade/rm directory, it must be run from the RM_7.0.1_install_dir/server directory. Also 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's parameters file, modify the default values, and run an abbreviated form of the command line.

The English and translated versions of the rm_params files are located in the RM_7.0.1_install_dir/server/upgrade/rm/params directory. Open rm_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:
  • Step 0: Runs the -migration_rm_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 Requirements Management 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 RM repository database.

For -migrateLinkValidity usage, see the Interactive Upgrade Guide.


Attribute Description Required Default
-oldApplicationHome Full path to the old Requirements Management application server configuration directory. The path must not contain any spaces. In a typical installation, this path is old_RM_install_dir/server/conf. Yes none
-applicationContextRoot The RM application context root. Must be valid directory single name without a leading slash. No none
-oldApplicationVersion The RM version that is being upgraded. By default, this is determined by running repotools -version against the old application. It should be a complete version string. For example, 6.0.0 or No none
-updateAppServerFiles By default, this option is set to yes to update the Tomcat configuration files when migrating to Liberty. Set this parameter to no if you are using WebSphere® Application Server. No yes
-newApplicationHome Path to the Requirements Management application configuration directory of the 7.0.1 installation. No conf

For example, RM_7.0.1_install_dir/server/conf

-newJTSHome Path to the Jazz Team Server configuration directory of the 7.0.1 installation. By default, the -newJTSHome parameter value is derived from the -newApplicationHome parameter value. No none
-jtsContextRoot Context root of the 7.0.1 Jazz Team Server. Must be valid directory single name without a leading slash. No jts
-noPrompt Do not prompt before creating or modifying the tables. The only valid values are empty or -noPrompt. No none
-noResumePrompt Do not prompt when resuming an upgrade step. No false
-noVerify Do not perform teamserver.properties file verification. The only valid values are empty or -noVerify. No none
-noStepPrompt Do not prompt before executing 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 Application Server environment where the index location might be relative to the profile directory, do not use this parameter. 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. This parameter must be provided if upgrading in Apache Tomcat and Tomcat is installed in a separate directory than ELM. No N/A
-migrateLinkValidity Migrate link validity data, if necessary. No None
-jtsRepositoryUrl Jazz Team Server root URL. Only used if -migrateLinkValidity is used.
Note: This is the URL that is defined in the Jazz Team Server Shared Validity provider URL advanced property. If no URL is defined, then use the URL of the Jazz Team Server that the Requirements Management application is connected to.
No https://localhost:9443/jts
-adminUserId Administrator user ID to login to the repository. Only used if -migrateLinkValidity is used and no credentials file is supplied. No ADMIN
-adminPassword Administrator password to login to the repository. Only used if -migrateLinkValidity is used and no credentials file is supplied. No ADMIN
-credentialsFile The file containing the administrator user's login credentials. Only used if -migrateLinkValidity is used. No credentials.properties


For Windows operating system Open a command prompt and enter this command:

cd C:\Program Files\IBM\JazzTeamServer_7.0.1\Server\
upgrade\rm\rm_upgrade.bat -oldApplicationHome old_RM_install_dir\server\conf -newJTSHome new_RM_install_dir\server\conf

For Unix operating systems Open a command line and enter this command:

cd /opt/IBM/JazzTeamServer_7.0.1/Server/
./upgrade/rm/rm_upgrade.sh -oldApplicationHome old_RM_install_dir/server/conf -newJTSHome new_RM_install_dir/server/conf