rs_upgrade script

Use this script to upgrade your installed version of Jazz® Reporting Service to Report Builder version 7.0.1.

Location

The rs_upgrade script upgrades Jazz Reporting Service all releases of version 6 and later to Report Builder version 7.0.1. Although the script file is in the upgrade/rs directory, you must run it from the JRS_7.0.1_install_dir/server directory. When you run the script, if the file 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.
Tip: 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 rs_params files are in the JRS_7.0.1_install_dir/server/upgrade/rs/params directory. Open rs_params, or a translated version of the file, and specify values for each parameter. You must set the path parameter to point to the OLD_APPLICATION_HOME directory, which must be an existing directory whose name ends with server/conf.

Purpose

The script performs the following tasks:
  • Step 0: Runs the -migration_rs_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 Reporting Service application app.properties file.
    • Verify that the server root URI, denoted by the server.root.url property, is correct.
    • Verify that the application name, denoted by the appName property, is correct.
    • Verify that the database properties are correct.
    When done, save your changes, if any, and close the editor to continue the script execution.

Parameters

Attribute Description Required Default
-oldApplicationHome Full path to the old Jazz Reporting Service application configuration directory of the old installation.

The path must not contain any spaces. In a typical installation, this path is old_JRS_install_dir/server/conf.

Yes N/A
-applicationContextRoot Report Builder context root. No rs
-oldApplicationVersion The version of Jazz Reporting Service that is being upgraded. No none
-newApplicationHome Path to the Report Builder application configuration directory of the new installation. No conf
-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
-importReportsOnStartup Automatically import the ready-to-use reports. If this argument is specified, the latest version of the ready-to-use reports will automatically be imported on server startup, overriding any existing ready-to-use reports. Alternatively, these reports can be imported through the UI via the Admin page. No none
-newJTSHome Path to the Jazz Team Server configuration directory of the new version installation.

By default, the -newJTSHome parameter value is derived from the -newApplicationHome parameter value.

No none
-jtsContextRoot The new version Jazz Team Server context root. No jts
-noVerify Do not perform verification of properties in the Jazz Team Server teamserver.properties file and the Report Builder app.properties file. No none
-overwrite Whether to overwrite any existing file. No no
-noStepPrompt Do not prompt before executing a step. No false
-noPrompt Do not prompt before creating or modifying the tables. No none
-noEditor The -noEditor parameter eliminates opening an editor during the execution of the upgrade script to review or modify the app.properties file. The -noEditor parameter in conjunction with -noStepPrompt, -noVerify, and -noPrompt parameters can be used for a fully automated upgrade script without any user interactions. If you need to review or modify the app.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 Apache Tomcat home directory of the old Jazz Reporting Service installation. Must be an existing directory. By default, the -oldApplicationTomcatHome parameter is derived from the -oldApplicationHome parameter value. No N/A

Example upgrade scripts

This is a graphical icon for Windows.
cd C:\Program Files\IBM\JazzTeamServer_7.0.1\server\
upgrade\rs\rs_upgrade.bat -oldApplicationHome JRS_old_version_install_dir\server\conf -newJTSHome JTS_7.0.1_install_dir\server\conf
This is a graphical icon for Linux.
cd /opt/IBM/JazzTeamServer_7.0.1/server
upgrade/rs/rs_upgrade.sh -oldApplicationHome JRS_old_version_install_dir/server/conf -newJTSHome JTS_7.0.1_install_dir/server/conf