To upgrade Rational® Engineering
Lifecycle Manager,
install the new product version, update configuration files, add,
or update tables in existing database repositories, and migrate your
data to version 5.0.1.
Before you begin
- If you are updating products that are integrated with Rational Engineering
Lifecycle Manager,
follow the sequence in Checklist for upgrading the Rational Engineering Lifecycle Manager product stack.
- If you upgrade from version 4.x, you must obtain new licenses
for version 5.x applications. Version 5.x applications do not work
with version 4.x licenses. However, version 4.x applications work
with version 5.x licenses. For more information about licenses, go
to Managing licenses.
- If you upgrade from version 4.x, remove the Rational Engineering
Lifecycle Manager data
source from the Lifecycle
Query Engine.
- Open the Lifecycle
Query Engine administrative
page: https://lqe_host_name:port/lqe/web.
- Click . Select the Rational Engineering
Lifecycle Manager data
source.
- On the Data Sources pane, click Remove,
and save.
Procedure
- Install Rational Engineering Lifecycle
Manager.
This step installs:
- Rational Engineering
Lifecycle Manager 5.0.1
- Jazz™ Team Server 5.0.1
- Configuration Management application 5.0.1
Important: - Select a different package group and directory than the original
installation.
- Select the same context root as your previous installation.
If
you upgrade from Rational Engineering
Lifecycle Manager version 5.0 or
older versions, your existing Jazz
Reporting Service or
SPARQL Gateway context root is SPARQL_Gateway,
and your application file name is SPARQL_Gateway.war.
When you install Rational Engineering
Lifecycle Manager 5.0.1,
select the custom context root option, and enter SPARQL_Gateway in
the Application context root values field.
- Configure your application server.
- Ensure that your old server is running.
- Back up the WebSphere® Application
Server profile.
- Open a command prompt and change to the bin directory
of the WebSphere Application
Server installation directory.
- Run this command. If the WebSphere Application
Server security is turned on, specify the user name and password.
Tip: The directory path to the compressed file must exist before
you start the backup process.
backupConfig.sh <Path_to_a_new_compressed_file_to_create_backup_of_profile> -username <WAS_primary_administrative_user_name> -password <WAS_administrative_password>
For
example: backupConfig.sh /root/WAS_backup/relm_50_profile.zip -username <WAS_admin> -password <WAS_admin_password>
backupConfig.bat <Path_to_a_new_compressed_file_to_create_backup_of_profile> -username <WAS_primary_administrative_user_name> -password <WAS_administrative_password>
For
example: backupConfig.bat C:\WAS_backup\relm_50_profile.zip -username <WAS_admin> -password <WAS_admin_password>
The command shuts down the server before starting
the backup process.
- Uninstall the existing applications from WebSphere Application Server.
- Start the server.
- Log on to the WebSphere Application
Server Integrated Solutions Console at https://host_name:9043/ibm/console/logon.jsp
- Click .
- Stop and uninstall the following applications: relm.war,
relmhelp.war, vvc.war, lqe.war, SPARQL_Gateway.war.
- Save the changes to the master configuration when prompted.
- Update JAZZ_HOME and log4j.configuration custom
properties.
- Log on to the WebSphere Application
Server Integrated Solutions Console at https://host_name:9043/ibm/console/logon.jsp.
- Click .
- Click the server name to open it. The default server name is server1.
- Under the Server infrastructure section,
click .
- Under Additional properties, click Java
Virtual Machine.
- Change the path for the Lifecycle
Query Engine and Jazz
Reporting Service to
the new location.
- Locate the Generic JVM arguments text field,
and add this environment variable to the JVM startup process:
-Dlqe.config.location=file://drive:/lqe_installation_dir/server/conf/lqe
- Under Additional properties click Custom
properties.
- Click JAZZ_HOME and update its value to file:///<new_version_install_dir>/server/conf.
For
example, file:///C:/PROGRA~2/IBM/JazzTeamServer_5.0.1/server/conf.
- Click log4j.configuration and update its
value to file:///<new_version_install_dir>/server/conf/startup_log4j.properties.
For
example, file:///C:/PROGRA~2/IBM/JazzTeamServer_5.0.1/server/conf/startup.log4j.properties.
- If you are connecting to an Oracle database, ensure that ORACLE_JDBC_DRIVER_FILE is
pointing to the correct JDBC driver file.
- Save the changes to the master configuration when prompted.
- Set the Jazz
Reporting Service shared
library.
- On the administrative console, go to .
- In the list, click JRS Shared Library.
- Change the class path from the existing Jazz
Reporting Service installation
location to the new one.
For example: 5.0.1_install_dir/server/conf/SPARQL_Gateway/SharedLibrary
- Under Class Loading, ensure that Use
an isolated class loader for the shared library is selected.
Click Apply, and Save.
- Stop WebSphere Application
Server.
Run the stopServer.sh command.
Run the stopServer.bat command.
- Clean up the WebSphere Application
Server temp directories.
Remove
the Rational Engineering Lifecycle
Manager related
content from the wscache and temp directories
in the profile. Depending on what applications were installed, these
directories might be in the profile, and can be removed: relm_war, lqe_war, sparql,
and Configuration Management application-related data.

WAS_profile_root/wscache (for example: opt/IBM/WebSphere/AppServer/profiles/AppSrv01/temp/wscache)
WAS_profile_root/temp (for example: opt/IBM/WebSphere/AppServer/profiles/AppSrv01/temp)

WAS_profile_root\wscache (for example: C:\IBM\WebSphere\AppServer\profiles\AppSrv01\wscache)
WAS_profile_root\temp (for example: C:\IBM\WebSphere\AppServer\profiles\AppSrv01\temp)
- Clean up the WebSphere Application
Server logs directory.
Go to each application server,
and remove the
Rational Engineering Lifecycle
Manager related
logs form the logs directory in the profile. A typical logs directory
is :
opt/IBM/WebSphere/AppServer/profiles/AppSrv01/logs
C:\IBM\WebSphere\AppServer\profiles\AppSrv01\logs
- Start your WebSphere application
server.
Run the startServer.sh command.
Run the startServer.bat command.
- Migrate or back up your database.
Ensure
that the Oracle JDBC driver ojdbc.jar is available
in the $newRELMHome/JazzTeamServer/server/oracle directory.
- Upgrade the Configuration Management
application.
Run the vvc_upgrade script
to upgrade the configuration and database files, and to rebuild the
text indices.
This is a parameters example:
cd $newRELMHome/server/
upgrade/vvc/vvc_upgrade.sh -oldApplicationHome oldRELMHome/server/conf
Tip: The Configuration Management application
can also be installed with Rhapsody® Design
Manager. When you are installing Rational Engineering
Lifecycle Manager,
select the Configuration Management application if you want to install
the component on a different machine than your Rhapsody Design Manager system. Integrate
only one Configuration Management application with the Rational Engineering Lifecycle
Manager.
If you choose to install the component on multiple servers, ensure
that you select the correct component for installing and upgrading.
- Upgrade Rational Engineering Lifecycle
Manager.
Run the
relm_upgrade.sh command
to upgrade configuration and database files, and to rebuild the text
indices.
$newRELMHome/server/upgrade/relm/relm_upgrade.sh -oldApplicationHome oldRELMHome/server/conf
- Port the Lifecycle
Query Engine and
the existing Jazz
Reporting Service or
SPARQL Gateway configuration information to the new product version.
Copy the contents of the
SPARQL_Gateway directory
in the old installation to the new
SPARQL_Gateway directory.
cp -R $oldRELMHome/server/conf/SPARQL_Gateway/* $newRELMHome/server/conf/SPARQL_Gateway
If you are upgrading from version 5.0 to 5.0.1, proceed
to Step 7.
If you are upgrading from version 4.x to 5.0.1,
use a text editor to add the following properties to
$newRELMHome/server/conf/SPARQL_Gateway/SPARQL_Gateway.properties.
- support.query.editing=false
- support.db.derby=false
- support.dwse=false
- query.results.limit=3000
- query.results.cache.timeout=300
- user.account.cache.timeout=480
Remove
app.properties from
SPARQL_Gateway rm $newRELMHome/server/conf/SPARQL_Gateway/app.properties
Rename
SPARQL_Gateway.properties to
app.properties.
mv $newRELMHome/server/conf/SPARQL_Gateway/SPARQL_Gateway.properties $newRELMHome/server/conf/SPARQL_Gateway/app.properties
Rename
SPARQL_Gateway_runtime.properties to
app_runtime.properties.
(By default,
SPARQL_Gateway_runtime.properties does
not exist, but you can create the file if you need to configure the
connection timeout setting.)
mv $newRELMHome/server/conf/SPARQL_Gateway/SPARQL_Gateway_runtime.properties $newRELMHome/server/conf/SPARQL_Gateway/app_runtime.properties
- Deploy the relm.war, relmhelp.war, vvc.war, lqe.war,
and SPARQL_Gateway.war files.
- From the WebSphere Application
Server administrative console, select .
- On the Enterprise Applications page,
click Install.
- In Path to the new application,
select $newRELMHome/server/webapps/relm.war,
and click Open.
- Select Fast Path, and then Next.
- Accept the default values, and click Next in
the setup wizard. On the Map context roots for Web modules page,
enter the context root /relm. Then, click Finish.
- A message states that relm.war installed
successfully. Click the Save directly to the master configuration.
- Install the Rational Engineering Lifecycle
Manager documentation, relmhelp.war.
Use the steps a-f above. Use $newRELMHome/server/webapps/relmhelp.war for
the path, and /relmhelp as the context root.
- Install the Configuration Management application, vvc.war.
Use the steps a-f above. Use $newRELMHome/server/webapps/vvc.war for
the path, and /vvc as the context root.
- Set up your WebSphere application
server for the Lifecycle
Query Engine,
and deploy the lqe.war file.
- Install the Jazz
Reporting Service application, SPARQL_Gateway.war.
Use the steps a-f above. Use $newRELMHome/server/webapps/SPARQL_Gateway.war for
the path. Use SPARQL_Gateway as the context
root.
- Add the Jazz
Reporting Service library
reference.
- Go to , and click SPARQL_Gateway_war in
the application list.
- In the Reference section, click Shared
library references.
- Select the check box next to SPARQL_Gateway_war,
and click Reference shared libraries.
- Select JRS Shared Library, and click the
right arrow.
- Click OK. Then, click OK again
to save your settings to the master configuration.
- Ensure that the Jazz
Reporting Service class
loading order is configured correctly.
- Go to , and click SPARQL_Gateway_war in
the application list.
- In the Detail Properties section, click Class
loading and update detection.
- In the Class loader order section, select Classes
loaded with local class loader first (parent last).
- Click OK, and Save to master
configuration.
- Restart WebSphere Application
Server.
- If you upgrade from version 4.x, upgrade
the Lifecycle
Query Engine.
Open the Lifecycle
Query Engine administration
page https://relm_host_name:port/lqe/web/admin.
A message states that the Lifecycle
Query Engine upgrade
is in progress, and that the application is unavailable. Click Start
Upgrade. When the upgrade process completes, the data
sources are available.
- Upgrade the Configuration Management
application.
- Ensure that a credentials.txt file
exists, and contains: adminUserId, adminPassword, repositoryURL,
smartCard, certificateFile .
If the file does
not exist, create the file. A credentials file example is:
adminUserId=yourAdminUserId
adminPassword=yourAdminPassword
repositoryURL=https://yourserver.com:9443/vvc
smartCard=<none>
certificateFile=<none>
- Run the repotools-vvc command from
your Configuration_Application_install_dir/server directory.
./repotools-vvc.sh -vvc_online_migrationCommand
credentialsFile=credentials.txt fromVersion=<previous_version>
logPort=52000 logLevel=DEBUG
repotools-vvc.bat -vvc_online_migrationCommand
credentialsFile=credentials.txt fromVersion=<previous_version>
logPort=52000 logLevel=DEBUG
- Restart the Jazz Team Server.
The Configuration Management application repotools command
sends a request to the running Configuration Management application
and waits for a response. If the repotools-vvc command
stops immediately with an authorization error, verify that the server
is running, and that the user ID and password in the credentials file
are correct.
- Restart your application server.
Run the stopServer.sh and
the startServer.sh command.
Run the stopServer.bat and
the startServer.bat command.
- Restart your Rational Engineering Lifecycle
Manager server
to automatically upgrade migrated data to the format that is required
in the new application version. This process is called online
upgrade. Log on if you want to see the upgrade status page.
Results
When the online upgrade is successful, the
web browser refreshes and opens the
Rational Engineering
Lifecycle Manager welcome
page. If an upgrade step fails, examine the
relm.log file
to determine what caused the failure. If you have a large number of
products defined in
Rational Engineering
Lifecycle Manager,
the online upgrade takes a long time to complete (up to several hours).