Install, Configure, and Deploy Multiple Instances on Multiple Computers

As a system administrator, you want to run more than one copy of the product on each Java EE Application Server, on multiple computers. For example, you want two
Web Viewer
instances running on your test computer, and two similar instances running on your production computer.
omerm10
As a system administrator, you want to run more than one copy of the product on each Java EE Application Server, on multiple computers. For example, you want two
Web Viewer
instances running on your test computer, and two similar instances running on your production computer.
Before you start this section, acquire the product installer. FTP your installer to a different computer if needed.
The following diagram shows how you install multiple instances on different computers:
Diagram that shows how to deploy multiple instances on different computers.
Choosing a Configuration Type
The following diagram describes the basic configuration types:
Diagram that shows the basic configuration types.
  • External System Level Configuration
    Lets you update your application easily, and then you copy the application to multiple systems, without having to reconfigure the product.
    Your configuration files are located in a directory outside of the
    Web Viewer
    web application on the same computer. The web application reads this directory location from the CAOMWV12_HOME Environment Variable.
    You are not required to redeploy your
    Web Viewer
    application after you modify the settings. Only a web application restart is required. This configuration option lets you update your application easily, and then copy the
    Web Viewer
    application WAR or EAR file to multiple systems, without having to reconfigure the WAR or EAR file.
    This configuration is recommended for most environments. However, there are certain situations when you want to use another configuration type.
  • Application Level External Configuration
    Lets you have two or more copies of the product on one Java application web server, or on one computer.
    Your configuration files are located in a directory outside of the
    Web Viewer
    web application on the same computer. The web application reads this directory location from a parameter within web.xml.
    In some situations, you are required to redeploy your
    Web Viewer
    application after settings changes. Often, only a web application restart is required.
    If you want to deploy the product to multiple servers using application level external configuration files, use the same path to your configuration files on all servers. If you do not use the same path, you have to apply patches to each system separately. With different configuration paths on each server, you cannot apply a patch to only one EAR or WAR file, for example, on a test computer, and then copy that same EAR or WAR file to each server where you to run the product, for example, on several production computers.
  • Application Level Internal Configuration
    Your site security restrictions do not allow web applications to access files outside of the web application.
    Your configuration files are located in a directory inside of the
    Web Viewer
    web application. The web application uses the default directory within the web application.
    You are required to redeploy your
    Web Viewer
    application after settings changes.
    If you want to deploy the product to multiple servers using internal configuration files, you have to apply patches to each system separately. With internal configuration, you cannot apply a patch to only one EAR or WAR file, for example, on a test computer, and then copy that same EAR or WAR file to each server where you to run the product, for example, on several production computers.
Deployment Prerequisites for WebSphere
Before you deploy
Web Viewer
on WebSphere, verify that you applied all fixes for the WebSphere server.
To deploy as a WAR file on WebSphere, set the Class loader order to
Classes loaded with local class loader first (parent last)
at both the module, and application level, in order to load libraries within the
Web Viewer
package first.
If you selected to produce an EAR file during installation, this setting is included in the EAR file automatically, so you can deploy this EAR file on WebSphere without changing this setting.
For a web server to host multiple instances of
Web Viewer
, Java memory space needs to be large enough.
Choose the appropriate configuration for your application.
  • System Level External Configuration
    If you are using a System Level External Configuration, you must set the CAOMWV12_HOME variable within WebSphere. You set up a new environment variable named CAOMWV12_HOME in the Java and Process Management > Process definition > Environment Entries section of your Application Server. Then, restart your WebSphere server in order for the setting to take effect.
    Add CAOMWV12_HOME as an environment variable not as a property in order for
    Web Viewer
    to recognize CAOMWV12_HOME
  • Application Level External Configuration
    When deploying using Application Level External Configuration, and you need to deploy more than one EAR file, be careful to use a different context path and application name for each web application deployed on WebSphere.
    1. (Optional) Rename the CAOMWebViewer12_ear application.
    2. (Required) Rename the second CAOMWebViewer12_ear application.
      The application names must not match.
    3. If you deploy three or more product instances, repeat Step 3 for each additional instance.
    4. (Optional) Map the context paths for CAOMWebViewer12.war Web Module to a different value.
      For example, a context path of CAOMWebViewer12_US produces a web address, such as http://<server>:CA Portal/CAOMWebViewer12_US.
    5. (Required) Map the context paths of the second CAOMWebViewer12.war Web Module to a different value.
      The context paths of each CAOMWebViewer12.war Web Module must not match.
    6. If you deploy three or more instances of
      Web Viewer
      , you repeat Step 5 for each additional instance.
    7. Map the context path of the CA Styles R5.1.3 Web Module in the second CAOMWebViewer12_ear application to an alternate value, and keep the CA Styles R5.1.3 Web Module untouched in the first CAOMWebViewer12_ear application.
      For example, define a context path of /castylesr5.1.3_alt.
    8. If you deploy three or more instances of
      Web Viewer
      , you repeat Step 7 for each additional instance.
      When deploying multiple
      Web Viewer
      instances with different configuration on WebSphere, the class loader policy for server-specific application settings must be set to Multiple. For more information about how to set server-specific application settings, see your WebSphere documentation.
      When using different database systems with different
      Web Viewer
      instances deployed on WebSphere, WebSphere variables for specific database JDBC driver paths may be required to resolve the JDBC driver class loading. For more information about WebSphere variable settings, see your WebSphere documentation.
      For more information about WebSphere settings, see your WebSphere documentation.
  • Application Level Internal Configuration
    Remove the CAOMWV12_HOME environment variable from within WebSphere, if it exists.
Deployment Prerequisites for Apache Tomcat
The following information describes the deployment prerequisites for Apache Tomcat:
  • System Level External Configuration
    If you are using this configuration, set the CAOMWV12_HOME variable on your system.
  • Application Level External Configuration
    The following information describes the deployment prerequisites for deploying multiple
    Web Viewer
    instances on Apache Tomcat:
    Rename your WAR files before deployment, so that each
    Web Viewer
    application WAR has a different name. This WAR file name also serves as the context path in the
    Web Viewer
    application web address.
    For example, a WAR file named CAOMWebViewer12_US.war produces a web address, such as http://<server>:CA Portal/CAOMWebViewer12_US.
  • Application Level Internal Configuration
    Remove the CAOMWV12_HOME variable from your system, if it exists.
Verify the Environment Requirements
Before you install and configure the product on the same computer and deploy the product on multiple computers, verify the environment requirements. These requirements let all instances of the product share a common configuration.
Follow these steps:
  1. Verify the configuration type for your environment:
    • External System Level Configuration
      (Recommended) Lets you update your application easily, and then you copy the application to multiple systems, without having to reconfigure the product.
    • Application Level External Configuration
      Lets you have two or more copies of the product on one Java application web server, or on one computer.
    • Application Level Internal Configuration
      Your site security restrictions do not allow web applications to access files outside of the web application.
  2. Verify that Java is installed so that the installer and configuration tool can run.
  3. Verify your network access (JDBC over TCP/IP) to the remote database server.
    This verification lets the configuration tool test the connection. You can execute the tool without a test, but we recommend that you verify a successful connection.
  4. Verify your network access (CCI over TCP/IP) to the mainframe where the primary CCI task runs.
    The configuration tool requires this access for the optional CCI connection test and the DRAS server discovery.
  5. Repeat Step 2 through Step 4 on all computers that you plan to use in your environment.
    For example, to deploy the product on other computers, complete the verification steps on all computers.
Run the Product Installer
You run the installer to run the wizard in your environment. You review the introduction panel for information about the installer, review and accept the license agreement, and follow the wizard prompts.
Follow these steps:
  1. Complete the appropriate steps for your environment:
    • Windows
      Run CAOMWV.exe.
    • Other Environments
      Use ssh or telnet to connect to USS (if ssh or telnet connection is supported). You can also use OMVS to gain access to a USS console.
      Launch CAOMWV.jar with Java:
      java -jar CAOMWV.jar
      The command java -jar assumes java is included in your PATH. Alternately, you must include the full path to the java executable in the command.
  2. Review the Introduction panel for information about the Installer, and click Next.
  3. Review the license agreement, and click Next.
  4. Complete one of the following steps:
    • Select Minimal to install either an EAR file, or a pair of WAR files that you can deploy to your Web Application server, and click Next.
    • Select Full to install
      Web Viewer
      and Apache Tomcat with the product pre-deployed on the server.
  5. Specify the folder where you want to install
    Web Viewer
    , and complete the remaining wizard prompts.
Deploy the Product
You deploy the product after the configuration completes successfully. Deployment lets you access the installed and configured product in a web browser.
After the Full install, never undeploy
Web Viewer
from the installed Apache Tomcat. Undeploying results in data loss, or even loss of the application. If you undeploy, you have to restore from a backup WAR file.
Follow these steps:
  1. Verify that CAOMWebViewer12.war and castylesr5.1.3.war deployed.
  2. Start the web application server.
    If you installed the Tomcat Java Web application server accompanying
    Web Viewer
    , launch the server in one of the following ways according to your operating environment:
    • Windows
      • Click Start, Programs, CA,
        Web Viewer
        , Apache Tomcat, Startup Tomcat.
      • If you chose to register it as a Windows service, use the
        Services
        administration tool to find and start the service named
        Tomcat7forCAOMWebViewer12
        .
      • Locate the apache-tomcat folder where you installed the bundled Apache Tomcat web application server. Execute the script apache-tomcat\bin\startup.bat.
    • Other operating systems
      • Locate the apache-tomcat folder where you installed the bundled Apache Tomcat web application server. Execute the script apache-tomcat/bin/startup.sh
  3. Open the following URL in a web browser:
    http://hostname:port/CAOMWebViewer12
  4. Log into
    Web Viewer
    to verify that the product deployed successfully.
Make Copies of the WAR or EAR File
If you want to run more than one copy of the product on the same Java Application Web Server, you make other copies of the CAOMWebViewer12 EAR or CAOMWebViewer12 WAR file.
You do not need to make extra copies of the castylesr5.1.3.war file.
Follow these steps:
  1. (Minimal Install Only) Go to the deployable folder:
    <installation_folder>/deployable
  2. Copy the CAOMWebViewer12.war or CAOMWebViewer12.ear file.
  3. Rename the copied file to CAOMWebViewer12_B.war or CAOMWebViewer12_B.ear.
    • You can use different names, but do not include any special characters or spaces in the name. Valid characters include A-Z, a-z, and 0-9.
    • The name of the WAR file also serves as your context path.
    • The name of the EAR file is less important, because it does not affect your context path. You can change the context path of that application during the product deployment.
  4. (Recommended) Keep the WAR and EAR files in the deployable directory for future use.
    You may need to apply fixes to the files, or deploy those same files to more than one computer when your environment or configuration changes.
Make Copies of the WAR File from the Installed Apache Tomcat
If you want to run more than one copy of the product on the same Java Application Web Server, you make other copies of the CAOMWebViewer12 WAR file from the installed Apache Tomcat.
You do not need to make extra copies of the castylesr5.1.3.war file.
Follow these steps:
  1. (Full Install Only) Go to the webapps folder:
    <apache_install>/webapps/
    Default folder:
    <installation_folder>/apache_tomcat-#.#.##/webapps/
  2. Copy the CAOMWebViewer12.war file.
  3. Rename the copied file to CAOMWebViewer12_B.war.
    • You can use different names, but do not include any special characters or spaces in the name. Valid characters include A-Z, a-z, and 0-9.
    • The name of the WAR file also serves as your context path.
  4. (Recommended) Keep the WAR file in the webapps directory for future use.
    You may need to apply fixes to the files, or deploy those same files to more than one computer when your environment or configuration changes.
Configure Each Copy of the Product
You must configure each of the EAR or WAR files (Minimal install) or WAR files (Full install) that you created separately. This environment setup requires application-level external configuration.
Follow these steps:
  1. Verify that the CAOMWV12_HOME variable exists, if you want to use external configuration.
  2. Locate the configuration tool in the following directory:
    <installation_directory>/util
  3. Execute the configuration tool as follows:
    • Windows
      • Set
        util
        as the current folder from the command prompt.
      • Execute configtool.bat.
    • Linux/UNIX
      • Set
        util
        as the current folder from the console.
      • Execute configtool.sh.
  4. Select Application Level External Configuration as your configuration type.
    This configuration lets you have two or more copies of the product on one Java application web server, or on one computer.
  5. Select a different Application Level External Configuration location for each WAR or EAR file (Minimal install) or each WAR file (Full install).
  6. Select the settings that you want to configure from the menu.
    If you are running the configuration tool for the first time, for example, the initial configuration after an install, select the All Web Viewer Settings menu option.
  7. Create the configuration by completing all the sections in the wizard.
    You can edit the configuration as often as necessary.
  8. Exit the utility after the configuration completes.
  9. (Optional) Copy configuration files to an alternate location, if you want to use the configuration files on a different computer.
  10. Restart the
    Web Viewer
    application or redeploy the application as needed, for the changes to take effect.
Deploy to Multiple Computers with Application Level External Settings
To deploy your WAR or EAR file to more than one computer, you copy the file and configuration locations to the other computer.
Follow these steps:
  1. Create a folder location on each other computer where you are going to copy the files.
  2. Copy the following directories from the computer where you installed the product:
    <install_folder>\deployable <install_folder>\util
    If you created additional copies of the WAR or EAR file, and you placed them in another directory, copy that directory to the other computer with, or in place of the deployable directory.
  3. Copy the Application Level External Configuration directories to the other computer.
    You created these directories with the configuration tool. The default path is <
    Web Viewer
    Home Var>/<WAR/EAR Name>
    If possible, verify that the paths to these directories are the same on each computer. This verification helps streamline your maintenance procedure.
  4. Consider the following example of configuration paths and context names:
    • Computer A
      • Web App Name 1: CAOMWebViewer12_US
      • Context Path 1: CAOMWebViewer12_US
      • Application Level External Configuration Path 1: C:\Program Files\CA\ CA_OM_Web_Viewer_Base\CAOMWebViewer12_US
      • Web App Name 2: CAOMWebViewer12_CA
      • Context Path 2: CAOMWebViewer12_CA
      • Application Level External Configuration Path 2: C:\Program Files\CA\ CA_OM_Web_Viewer_Base\CAOMWebViewer12_CA
    • Computer B
      • Web App Name 1: CAOMWebViewer12_US
      • Context Path 1: CAOMWebViewer12_US
      • Application Level External Configuration Path 1: C:\Program Files\CA\ CA_OM_Web_Viewer_Base\CAOMWebViewer12_US
      • Web App Name 2: CAOMWebViewer12_CA
      • Context Path 2: CAOMWebViewer12_CA
      • Application Level External Configuration Path 2: C:\Program Files\CA\ CA_OM_Web_Viewer_Base\CAOMWebViewer12_CA
        The Application Level External Configuration location matches on each computer.
  5. Deploy the product with each deployable file.
    Do
    not
    mix up the _US EAR or WAR with the _CA EAR or WAR when you deploy it to the second computer.
Deploy to Multiple Computers with Application Level External Settings from an Installed Apache Tomcat
To deploy your WAR file to more than one computer, you copy the file and configuration locations to the other computer.
Follow these steps:
  1. Create a folder location on each other computer where you are going to copy the files.
  2. Copy the following directories from the computer where you installed the product:
    <install_folder>\util
  3. Copy the application war files CAOMWebViewer12.war and castylesr5.1.3.war from the following directory.
    <installed tomcat location>\webapps
  4. Place these files on the new computer in a new folder named deployables.
    If you created additional copies of the CAOMWebViewer12 WAR file, and you placed them in another directory, copy that directory to the other computer with, or in place of the deployable directory.
  5. Copy the Application Level External Configuration directories to the other computer.
    You created these directories with the configuration tool. The default path is <
    Web Viewer
    Home Var>\<WAR Name>.
    If possible, verify that the paths to these directories are the same on each computer. This verification helps streamline your maintenance procedure.
  6. Consider the following example of configuration paths and context names:
    • Computer A
      • Web App Name 1: CAOMWebViewer12_US
      • Context Path 1: CAOMWebViewer12_US
      • Application Level External Configuration Path 1: C:\Program Files\CA\ CA_OM_Web_Viewer_Base\CAOMWebViewer12_US
      • Web App Name 2: CAOMWebViewer12_CA
      • Context Path 2: CAOMWebViewer12_CA
      • Application Level External Configuration Path 2: C:\Program Files\CA\ CA_OM_Web_Viewer_Base\CAOMWebViewer12_CA
    • Computer B
      • Web App Name 1: CAOMWebViewer12_US
      • Context Path 1: CAOMWebViewer12_US
      • Application Level External Configuration Path 1: C:\Program Files\CA\ CA_OM_Web_Viewer_Base\CAOMWebViewer12_US
      • Web App Name 2: CAOMWebViewer12_CA
      • Context Path 2: CAOMWebViewer12_CA
      • Application Level External Configuration Path 2: C:\Program Files\CA\ CA_OM_Web_Viewer_Base\CAOMWebViewer12_CA
        The Application Level External Configuration location matches on each computer.
  7. Deploy the product with each deployable file.
    Do
    not
    mix up the _US EAR or WAR with the _CA EAR or WAR when you deploy it to the second computer.
Deploy Multiple Copies to One Computer
You must deploy each copy of the WAR or EAR file that you created.
Follow these steps:
  • For the embedded Apache Tomcat
    Start your Java EE Application Server.
    The WAR files are predeployed on Apache Tomcat.
  • For WAR Files Deployment
  1. If you are deploying more than one copy of the CAOMWebViewer12.war file to Apache Tomcat, you do not deploy additional copies of the castylesr5.1.3.war file.
  2. Rename your WAR files before deployment, so that each
    Web Viewer
    application WAR has a different name. This WAR file name also serves as the context path in the
    Web Viewer
    application web address.
    For example, a WAR named CAOMWebViewer12_US.war produces a web address, such as http://<server>:CA Portal/CAOMWebViewer12_US.
    For more information about deploying to Apache Tomcat or context paths with Application Level External Configuration, see the deployment prerequisites for Apache Tomcat.
  • For EAR File Deployment
    When deploying the application, you must deploy both EAR files. However, be careful to use a different context path for each web application.
  1. (Optional) Rename the CAOMWebViewer12_ear application.
  2. (Required) Rename the second CAOMWebViewer12_ear application.
    The application names must not match.
  3. If you deploy three or more product instances, repeat Step 3 for each additional instance.
  4. (Optional) Map the context paths for CAOMWebViewer12.war Web Module to a different value.
    For example, a context path of CAOMWebViewer12_US produces a web address, such as http://<server>:CA Portal/CAOMWebViewer12_US.
  5. (Required) Map the context paths of the second CAOMWebViewer12.war Web Module to a different value.
    The context paths of each CAOMWebViewer12.war Web Module must not match.
  6. If you deploy three or more instances of
    Web Viewer
    , you repeat Step 5 for each additional instance.
  7. Map the context path of the CA Styles R5.1.3 Web Module in the second CAOMWebViewer12_ear application to an alternate value, and keep the CA Styles R5.1.3 Web Module untouched in the first CAOMWebViewer12_ear application.
    For example, define a context path of /castylesr5.1.3_alt.
  8. If you deploy three or more instances of
    Web Viewer
    , you repeat Step 7 for each additional instance.
    For more information about deploying to WebSphere or context paths with Application Level External Configuration on WebSphere, see the deployment prerequisites for WebSphere.