Upgrading from a Previous Release › Shutdown CA OM Web Viewer › Additional Tasks

Additional Tasks

After you import the repositories, roles, and users into Web Viewer Version r12.1, it is important to review the resulting r12.1 objects.

• Review Repository objects

  Important! If the DRAS Discovery was either bypassed during the r11.0 or r11.5 export or the DRAS tasks were inactive or inaccessible, the Repository Type is incorrect for any CA Dispatch or CA Bundl repository. You can correct the Repository Type before users can access.

  • If you plan to use DRAS load balancing, select Alternate Locations for the affected repositories.
  • Review and update, the repository Definition and Properties as needed.
  • Index rules defined in r11.5 are not exported. Rules must be redefined through Properties, Filter under the Index Filter section.
• Review Role objects
  • Nongeneric users defined in r11.0 or r11.5, derived roles are exported to Version r12.1. The result Role Object names are set to values like DerivedRole_00000001 (the actual name can be localized). Rename as appropriate.
  • Roles that are created from generic users are named after the generic account. Rename as appropriate.
  • Review and update the role Definition and Properties. In particular, the Role Type, as needed.
• Review User objects
  • Review and update the user information as needed.

Upgrading from 12.0 to 12.1

CA OM Web Viewer 12.1 is compatible with the prior 12.0 release, allowing for all settings (configuration files and database) to be migrated. The migration procedure is a set of steps that consist of backing up certain folders and files then using these when configuring the new release.

Important! If using an external database system, you may choose install and configure OM Web Viewer 12.1 to use the same database system thereby bypassing migration procedures that follow. The database contains the administrative customization (repository, role, and user definitions) and end-user personalization (saved preferences, Web Viewer-managed favorites, etc.). Performing the normal installation configuration tool steps, while referencing the prior release database, will also accomplish the migration. The one exception where migration is necessary is when the internal database option was used - the internal database must be migrated.

Determine your Upgrade Scenario

When upgrading from the 12.0 take the following information into consideration:

• Java web application server used.
  • Stand-alone Apache Tomcat using Web Viewer installer produced WAR files.
  • Apache Tomcat installed by Web Viewer using pre-deployed application files (no WAR).
  • IBM WebSphere using Web Viewer installer produced EAR file.
• Database application used.
  • Internal database option (Apache Derby embedded database). With IBM WebSphere, the database files may be stored either under the WebSphere program folder or under the deployed Web Viewer application folder; the database need not be backed up if under the WebSphere product folder.
  • External Database.

Select the configuration type to be used with 12.1 (refer to Choosing a Configuration Type topic in chapter 3 for more information):

• External System Level Configuration (recommended)
• Application Level External Configuration
• Application Level Internal Configuration

Back-up Needed Configuration Settings and Files

Migrating to the new release of Web Viewer consists of backing up (copying) select folders and files from the current release, for use in configuring the new release. This will preserve the prior configuration allowing for the new release to be ready to run with end-users experiencing no loss of customization.

Backup from deployed instance

Perform these steps before un-deploying the prior release from your Java web server.

1. Locate the deployed application folder.

   Apache Tomcat

   1. Locate the Tomcat webapps folder. For example, (stand-alone Tomcat) C:\Program Files\apache-tomcat-7.0.42\webapps\ or (Tomcat include with 12.0) C:\Program Files\CA\CA_OM_Web_Viewer\apache-tomcat-6.0.32\webapps
   2. Locate the Web Viewer application instance under the webapps folder. By default, folder CAOMWebViewer12.

   IBM Web Server

   1. Locate the WebSphere InstalledApps NodeCell folder. For example, C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\installedApps\MachinenameNode01Cell
   2. Locate the Web Viewer application instance under the NodeCell folder. By default, folder CAOMWebViewer12_ear.ear\CAOMWebViewer12.war
2. Under the application instance folder, locate the config folder.
3. Back-up this folder (config) to a location outside of C:\Program Files. These are the primary Web Viewer configuration files.
4. Optional: If using DB2 as the database server, backup the DB2 license file. These steps may be skipped if the DB2 license file is saved elsewhere.
   1. Under the application instance folder, locate the WEB-INF\lib folder.
   2. In the WEB-INF\lib folder, locate your DB2 license file. For example, db2jcc_license_cisuz.jar
   3. Backup this file to a location outside of C:\Program Files.
5. Optional: If using external "local JDBC driver" as the database server, backup the JDBC driver file. These steps may be skipped if the JDBC driver file is saved elsewhere.
   1. Under the application instance folder, locate the WEB-INF\lib folder.
   2. In the WEB-INF\lib folder, locate your JDBC driver file. For example, mysql-connector-java-5.1.26-bin.jar (for MySQL).
   3. Backup this file to a location outside of C:\Program Files.
6. Optional: If using the internal database option (Apache Derby embedded database), back-up the database folder and files. These steps may be skipped if using the external database option.

   Apache Tomcat

   1. Stop the Java web server. The database files may be in use at the time of the backup step, potentially resulting in a corrupt backup.
   2. Locate the Tomcat webapps folder. For example, (stand-alone Tomcat) C:\Program Files\apache-tomcat-7.0.42\webapps\ or (Tomcat include with 12.0) C:\Program Files\CA\CA_OM_Web_Viewer\apache-tomcat-6.0.32\webapps
   3. Locate the Web Viewer application instance under the webapps folder. By default, folder CAOMWebViewer12.
   4. Under the application instance folder, locate the database\AdminDB folder.
   5. Back-up this folder (AdminDB). These are DerbyDB database files - the Web Viewer administration and end-user settings.

   IBM Web Server

   1. These steps are not required if the database files are stored under the WebSphere program folder. Only needed if the files are under the deployed Web Viewer application folder.
   2. Stop the Java web server. The database files may be in use at the time of the backup step, potentially resulting in a corrupt backup.
   3. Locate the WebSphere InstalledApps NodeCell folder. For example, C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\installedApps\MachinenameNode01Cell
   4. Locate the Web Viewer application instance under the NodeCell folder. By default, folder CAOMWebViewer12_ear.ear\CAOMWebViewer12.war
   5. Under the application instance folder, locate the database\AdminDB folder.
   6. Back-up this folder (AdminDB). These are DerbyDB database files - the Web Viewer administration and end-user settings.

Backup from a WAR file

Perform these steps before un-installing the prior release. If using the internal database option (Apache Derby embedded database), the database backup steps must be performed before un-deploying the prior release from your Java web server.

1. Locate the WAR file with the current settings. By default, C:\Program Files\CA\CA_OM_Web_Viewer\deployable\CAOMWebViewer12.war
2. Extract the config folder & files from the WAR file using a ZIP-compatible utility.

   Example (using the JAR command from the Java JDK):

   jar -xvf CAOMWebViewer12.war config/

3. Backup this folder (config). These are the primary Web Viewer configuration files.
4. Optional: If using DB2 as the database server, backup the DB2 license file. These steps may be skipped if the DB2 license file is saved elsewhere.
   1. Determine the name of the DB2 license file. For example, db2jcc_license_cisuz.jar
   2. Extract the DB2 license file from the WAR file using a ZIP-compatible utility.

      Example (using the JAR command from the Java JDK):

      jar -xvf CAOMWebViewer12.war WEB-INF/lib/db2jcc_license_cisuz.jar

   3. Backup this file.
5. Optional: If using external "local JDBC driver" as the database server, backup the JDBC driver file. These steps may be skipped if the JDBC driver file is saved elsewhere.
   1. Determine the name of the local JDBC driver. For example, mysql-connector-java-5.1.26-bin.jar (for MySQL).
   2. Extract the local JDBC driver file from the WAR file using a ZIP-compatible utility.

      Example (using the JAR command from the Java JDK):

      jar -xvf CAOMWebViewer12.war WEB-INF/lib/mysql-connector-java-5.1.26-bin.jar

   3. Backup this file.
6. Optional: If using the internal database option (Apache Derby embedded database), back-up the database folder and files. These steps may be skipped if using the external database option.

   Apache Tomcat

   1. Stop the Java web server. The database files may be in use at the time of the backup step, potentially resulting in a corrupt backup.
   2. Locate the Tomcat webapps folder. For example, (stand-alone Tomcat) C:\Program Files\apache-tomcat-7.0.42\webapps\ or (Tomcat include with 12.0) C:\Program Files\CA\CA_OM_Web_Viewer\apache-tomcat-6.0.32\webapps
   3. Locate the Web Viewer application instance under the webapps folder. By default, folder CAOMWebViewer12.
   4. Under the application instance folder, locate the database\AdminDB folder.
   5. Back-up this folder (AdminDB). These are DerbyDB database files - the Web Viewer administration and end-user settings.

Backup from EAR file

Perform these steps before un-installing the prior release. If using the internal database option (Apache Derby embedded database), the database backup steps must be performed before un-deploying the prior release from your Java web server.

1. Locate the EAR file with the current settings. By default, C:\Program Files\CA\CA_OM_Web_Viewer\deployable\CAOMWebViewer12.ear
2. Extract the WAR file from EAR file using a ZIP-compatible utility.

   Example (using the JAR command from the Java JDK):

   jar -xvf CAOMWebViewer12.ear CAOMWebViewer12.war

3. From the WAR file that resulted in the prior step, extract the config folder & files from the WAR file.

   Example (using the JAR command from the Java JDK):

   jar -xvf CAOMWebViewer12.war config/

4. Backup this folder (config). These are the primary Web Viewer configuration files.
5. Optional: If using DB2 as the database server, backup the DB2 license file. These steps may be skipped if the DB2 license file is saved elsewhere.
   1. Determine the name of the DB2 license file. For example, db2jcc_license_cisuz.jar
   2. Extract the DB2 license file from the WAR file using a ZIP-compatible utility.

      Example (using the JAR command from the Java JDK):

      jar -xvf CAOMWebViewer12.war WEB-INF/lib/db2jcc_license_cisuz.jar

   3. Backup this file.
6. Optional: If using external "local JDBC driver" as the database server, backup the JDBC driver file. These steps may be skipped if the JDBC driver file is saved elsewhere.
   1. Determine the name of the local JDBC driver. For example, mysql-connector-java-5.1.26-bin.jar (for MySQL).
   2. Extract the local JDBC driver file from the WAR file using a ZIP-compatible utility.

      Example (using the JAR command from the Java JDK):

      jar -xvf CAOMWebViewer12.war WEB-INF/lib/mysql-connector-java-5.1.26-bin.jar

   3. Backup this file.
7. Optional: If using the internal database option (Apache Derby embedded database), back-up the database folder and files. These steps may be skipped if using the external database option.

   IBM WebSphere

   1. Stop the Java web server. The database files may be in use at the time of the backup step, potentially resulting in a corrupt backup.
   2. Locate the WebSphere InstalledApps NodeCell folder. For example, C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\installedApps\MachinenameNode01Cell
   3. Locate the Web Viewer application instance under the NodeCell folder. By default, folder CAOMWebViewer12_ear.ear\CAOMWebViewer12.war.
   4. Under the application instance folder, locate the database\AdminDB folder.
   5. Back-up this folder (AdminDB). These are DerbyDB database files - the Web Viewer administration and end-user settings.

Upgrade Configuration Settings and Files

Once the new release of Web Viewer is installed, the files backed up from the prior release can be migrated, minimizing the amount of further customization.

Upgrade using External System Level Configuration (Recommended)

Perform these steps after installing Web Viewer 12.1, but before performing configuration.

Important! If configuration of the new system has been done, this procedure replaces any settings already defined.

1. Locate the Web Viewer home folder (CAOMWV12_HOME). For example, C:\Program Files\CA\CA_OM_Web_Viewer
2. Locate the config folder.
3. Replace the contents of the 12.1 config folder with the backup files from the 12.0 config folder.
4. Optional: If using DB2 as the database server, use the backup DB2 license file.
   1. Under the 12.1 config folder, create a sub-folder named external_JDBC_lib (if the folder does not already exist).
   2. Copy the backup DB2 license file to the 12.1 config/external_JDBC_lib folder.
5. Optional: If using external "local JDBC driver" as the database server, use the backup JDBC driver file.
   1. Under the 12.1 config folder, create a sub-folder named external_JDBC_lib (if the folder does not already exist).
   2. Copy the backup JDBC driver file to the 12.1 config/external_JDBC_lib folder.
6. Optional: If using the internal database option (Apache Derby embedded database), use the backup database files.
   1. Under the 12.1 home folder (CAOMWV12_HOME), create a sub-folder named database (if the folder does not already exist).
   2. Copy the backup AdminDB folder into the database folder.
7. Run the OM Web Viewer configuration tool selecting Configuration Type 1 System Level External Configuration and then choose All Settings. Review all settings to ensure they are accurate. For the Database Settings for an external database, be sure to reselect your database (not the No Change selection) and then review each value.

Upgrade using Application Level External Configuration

Perform these steps after installing Web Viewer 12.1, but before performing configuration.

Important! If configuration of the new system has been done, this procedure replaces any settings already defined.

1. Determine the application context name. For example, CAOMWebViewer12_US. This value should match the name intended for the application-specific WAR or EAR file.
2. Locate the folder to store the application settings. By default, this would be the Web Viewer home folder (CAOMWV12_HOME). For example, C:\Program Files\CA\CA_OM_Web_Viewer
3. Create a sub-folder named after the application context name.
4. Copy the 12.0 config folder under the application-specific folder.
5. Optional: If using DB2 as the database server, use the backup DB2 license file.
   • Under the application-specific config folder (i.e. ./CAOMWebViewer12_US/config), create a sub-folder named external_JDBC_lib (if the folder does not already exist).
   • Copy the backup DB2 license file to the 12.1 config/external_JDBC_lib folder.
6. Optional: If using external "local JDBC driver" as the database server, use the backup JDBC driver file.
   • Under the application-specific config folder (i.e. /CAOMWebViewer12_US/config), create a sub-folder named external_JDBC_lib (if the folder does not already exist).
   • Copy the backup JDBC driver file to the 12.1 config/external_JDBC_lib folder.
7. Optional: If using the internal database option (Apache Derby embedded database), use the backup database files.
   • Under the application-specific (i.e. /CAOMWebViewer12_US), create a sub-folder named database (if the folder does not already exist).
   • Copy the backup AdminDB folder into the database folder.
8. Run the OM Web Viewer configuration tool selecting Configuration Type 2 Application Level External Configuration, select the WAR/EAR file, and then choose All Settings. Review all settings to ensure they are accurate. For the Database Settings for an external database, be sure to reselect your database (not the No Change selection) and then review each value.
9. Repeat all steps if setting up additional application instances.

Upgrade using Application Level Internal Configuration

Perform these steps after installing Web Viewer 12.1, but before performing configuration.

Important! If configuration of the new system has been done, this procedure replaces any settings already defined.

1. Locate the WAR or EAR file to be deployed. By default, C:\Program Files\CA\CA_OM_Web_Viewer\deployable file CAOMWebViewer12.war or CAOMWebViewer12.ear
2. If using the EAR file, extract the WAR file from EAR file using a ZIP-compatible utility.

   Example (using the JAR command from the Java JDK):

   jar -xvf CAOMWebViewer12.ear CAOMWebViewer12.war

3. In the same folder that contains the WAR file to receive the internal configuration, create the following folder structure:

   \<folder containing the WAR file>

   \config

   \WEB-INF

   \lib

4. Copy the files from the backup 12.0 config folder to the new config folder.
5. Optional: If using DB2 as the database server, use the backup DB2 license file.
   1. Copy the backup DB2 license file to the new WEB-INF\lib folder.
6. Optional: If using external "local JDBC driver" as the database server, use the backup JDBC driver file.
   1. Copy the backup JDBC driver file to the new WEB-INF\lib folder.
7. Add the config and WEB-INF\lib folders to the WAR maintaining the folder structure using a ZIP-compatible utility.

   Example (using the JAR command from the Java JDK):

   jar -uvf CAOMWebViewer12.war config/

   jar -uvf CAOMWebViewer12.war WEB-INF/

8. If using the EAR file, refresh the WAR file in the EAR file using a ZIP-compatible utility.

   Example (using the JAR command from the Java JDK):

   jar -uvf CAOMWebViewer12.ear CAOMWebViewer12.war

9. Run the OM Web Viewer configuration tool selecting Configuration Type 3 Internal Configuration, select the WAR/EAR file, and then choose All Settings. Review all settings to ensure they are accurate. For the Database Settings for an external database, be sure to reselect your database (not the No Change selection) and then review each value.
10. Optional: If using the internal database option (Apache Derby embedded database), use the backup database files. The internal database files should be migrated after Web Viewer has been deployed to the Java web server.

    Apache Tomcat

    1. After deploying the WAR file and ensuring the files have been deployed, stop the web server.
    2. Locate the deployed application folder.
    3. Locate the Tomcat webapps folder. For example, (stand-alone Tomcat) C:\Program Files\apache-tomcat-7.0.42\webapps\ or (Tomcat included with 12.0) C:\Program Files\CA\CA_OM_Web_Viewer\apache-tomcat-7.0.42\webapps
    4. Locate the Web Viewer application instance under the webapps folder. By default, folder CAOMWebViewer12.
    5. Under the application instance folder, locate the database\AdminDB folder. If this folder does not exist, create it.
    6. Copy the backup AdminDB files to the new AdminDB folders.

    IBM WebSphere

    1. These steps are not required if the database files are stored under the WebSphere program folder. Only needed if the files are under the deployed Web Viewer application folder.
    2. After deploying the EAR file and ensuring the files have been deployed, stop the web server.
    3. Locate the WebSphere InstalledApps NodeCell folder. For example, C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\installedApps\MachinenameNode01Cell
    4. Locate the Web Viewer application instance under the NodeCell folder. By default, folder CAOMWebViewer12_ear.ear\CAOMWebViewer12.war
    5. Under the application instance folder, locate the database\AdminDB folder. If this folder does not exist, create it.
    6. Copy the backup AdminDB files to the new AdminDB folders.