Backing Up and Replacing ELM Application WAR Files

Learn how to back up and replace Web Application Archive (WAR) files for Engineering Lifecycle Management (ELM) applications deployed on WebSphere Liberty server.

About this task

Before making changes to your Engineering Lifecycle Management deployment, it is a good idea to make a backup to ensure that you can recover from any changes that cause problems for you.

The following table lists the Engineering Lifecycle Management applications and their corresponding Web Application Archive (WAR) files:

Application Web Application Archive (WAR)
Jazz Team Server jts.war
Engineering Workflow Manager ccm.war
Engineering Test Manager qm.war
Doors Next Generation rm.war
Global Configuration Management gc.war
Data Collection Component dcc.war
Engineering Insights relm.war

Procedure

Backing Up Engineering Lifecycle Management Application WAR Files

  1. In the JAZZ_HOME installation folder, create an app-war-bkup folder.
    It is recommended that the folder contain the version or ifix value as well, depending on your naming convention. Example: app-war-bkup-ifix003
  2. Stop the WebSphere Liberty server for [application].
  3. Copy your original [app].war to the backup folder from: 
    <APP_installation_directory>/server/liberty/servers/clm/apps/[app].war
  4. Perform this operation for each [app].war you intend to change.
  5. When complete, make your changes or start the server.

Installing New WAR Files

  1. Stop the WebSphere Liberty server for [application].
  2. Rename the [application].war file as [application].war.zip
  3. Backup your original [application].war in case you need to revert the patch: 
    <APP_installation_directory>/server/liberty/servers/clm/apps/[app].war
  4. Delete the following files: 
    <APP_installation_directory>/server/liberty/servers/clm/apps/[app].war
<APP_installation_directory>/server/liberty/clmServerTemplate/apps/[app].war
  5. Delete the following directories: 
    <APP_installation_directory>/server/liberty/servers/clm/apps/[app].war
<APP_installation_directory>/server/liberty/clmServerTemplate/apps/[app].war
  6. Place the new [app].war file in the following directories: 
    <APP_installation_directory>/server/liberty/servers/clm/apps
<APP_installation_directory>/server/liberty/clmServerTemplate/apps
  7. Unzip the new [app].war file into the following directories: 
    <APP_installation_directory>/server/liberty/servers/clm/apps/[app].war
<APP_installation_directory>/server/liberty/clmServerTemplate/apps/[app].war
  8. Start the server with the -clean switch:
    • Linux: server.startup.sh -clean
    • Windows: server.startup.bat -clean

Verifying the Installation

  1. After the server starts, open the application home page and navigate to About.
  2. Verify that the build ID is the same as specified in the interim fix.

Uninstalling New WAR Files

  1. Stop the WebSphere Liberty Server for the [application].
  2. Restore the original [app].war file that was backed up during the installation to the following directories: 
    <APP_installation_directory>/server/liberty/servers/clm/apps
<APP_installation_directory>/server/liberty/clmServerTemplate/apps
  3. Delete the following directories: 
    <APP_installation_directory>/server/liberty/servers/clm/apps/[app].war
<APP_installation_directory>/server/liberty/clmServerTemplate/apps/[app].war
  4. Unzip the original [app].war file into the following directories: 
    <APP_installation_directory>/server/liberty/servers/clm/apps/[app].war
<APP_installation_directory>/server/liberty/clmServerTemplate/apps/[app].war
  5. Start the server with the -clean switch:
    • Linux: server.startup.sh -clean
    • Windows: server.startup.bat -clean

Results

Important: When installing applications using install manager, you have the option to change the context root of the application. The table above lists the default context roots. If you have changed a context root in your deployment, you must rename the [app] portion of the WAR file to match your context root.

Example: If the context root for your Jazz Team Server is jazz, you would rename jts.war to jazz.war and jts.war to jazz.war respectively.

Note: [application] and [app] refer to the seven potential default context roots listed in the table. You would replace [app] with the context root of the application you are updating, or alternatively, if you renamed the context root, you would rename that WAR file and replace the application WAR with that renamed WAR file.