Deploy the Product to a CCS Apache Tomcat Server

This section explains how to configure and deploy the product to a CSS Apache Tomcat server.
view140
This section explains how to configure and deploy
Web Viewer
to a CSS Apache Tomcat server.
Configure the CCS Apache Tomcat Instance server.xml File
Starting with version 8.0.39, Apache Tomcat supports reading your
server.xml
file from a PDS data set in EBCDIC, and from the
conf/
directory in ASCII. We recommend that you use the
server.xml
file in the
conf/ 
directory.
For more information about how to configure the CCS Apache Tomcat server.xml file, see
Deploy and Configure CCS Apache Tomcat
in the CA Common Services for z/OS documentation.
If you have completed the CCS instructions for installing, your
server.xml
file is already configured.
You need to add several settings to the connector defined in your
server.xml
file:
connectionTimeout="30000" disableUploadTimeout="true" enableLookups="false" maxHttpHeaderSize="8192" maxThreads="250" minSpareThreads="50"
Ensure that your connector port includes the recommended values for
Web Viewer
.
Configure the CCS Apache Tomcat Instance
The sample JCL in the following locations describes how to configure the instances of CCS Apache Tomcat so that you can run
Web Viewer
:
Java v8 64-bit is a pre-requisite for
Web Viewer
  • Data Set
    YourCAViewHLQ.
    CVDEOPTN(CAHVTOMX)
  • ENV File
    YourCAViewHLQ.
    CVDEOPTN(CAHVCENV)
  • CEEOPTS File
    YourCAViewHLQ.
    CVDEOPTN(CAHVCOPT)
    At this point, the edit macro may have updated this file. However, you still want to review some optional changes in the JCL.
    Follow these steps:
    1. Review instructions in the JCL for optional steps, and to assure correctness of edit macro changes.
    2. Review the C runtime options for
      Web Viewer
      . Note the CEEOPTS DD.
Start and Verify the CCS Apache Tomcat Instance
To start an instance of CCS Apache Tomcat, use the sample JCL in
YourCAViewHLQ
.CVDEOPTN(CAHVTOMX)
in the previous step.
For
Web Viewer
to authenticate users properly, the
userid
that starts the CCS Apache Tomcat Instance must have read access to IBM Facility BPX.SERVER. For more information, see Security Requirements.
Verify the CCS Apache Tomcat Instance
To verify that the CCS Apache Tomcat Instance has started, follow these steps:
  1. Open the file
    STDERR
    .
  2. Verify that no exception errors exist.
  3. Verify that the following message appears:
    INFO: Server startup in nnnnn ms
Deploy the
Web Viewer
WAR File
Web Viewer
is delivered as a WAR file (web-viewer.war) in the installation directory. To deploy the WAR file to the CCS Apache Tomcat instance, use
one
of the following procedures:
If you wish to change the context path under which the application is accessible, rename the web-viewer.war file prior to deployment to the desired name followed by the .war extension.
Example:
If you want the deployed application to be accessible under
host:port/MTC-ContentViewer
, rename the web-viewer.war file to MTC-ContentViewer.war before you execute the chosen deployment procedure.
Procedure 1: JCL Based
Data Sets
YourdeployHLQ.
CAW0JCL(TOMSEDIT)
YourdeployHLQ.
CAW0JCL(TOMWAR)
Follow these steps:
  1. Customize the TOMWAR JCL for your environment with the instructions that the JCL includes.
  2. Customize the TOMSEDIT configuration member.
    • Set the WARFNAME variable to web-viewer.war
      Example:
      WARFNAME=web-viewer.war
    • Set the WARFROM variable to the
      Web Viewer
      installation directory.
      Example:
      WARFROM=/cai/CASoftware/CCAFE00/webviewer
  3. Submit the TOMWAR JCL and check the return code.
  4. Restart your Apache Tomcat server after the deployment.
    You need to restart your Apache Tomcat server after each deployment.
  5. Access your deployed application:
    host:port/web-viewer
Procedure 2: Deploy the CCS Apache Tomcat Instance Manager Application
In order to deploy web applications to your server, we suggest using the Apache Tomcat manager application.  This application comes with Apache Tomcat.
Follow these steps:
  1. Open the following file:
    <CCS TOMCAT Mount Point>/CCS/tpv/tomcat/conf/tomcat-users.xml
  2. In the Tomcat users section, add the role
    manager-gui:
    <role rolename="manager-gui"/>
  3. In the Tomcat users section, add a user:
    <user username="tomcat" password="<must-be-changed>" roles="manager-gui"/>
    You will use this login to deploy
    Web Viewer
    .
  4. Start or restart your CCS Apache Tomcat instance.
  5. Browse to the Apache Tomcat manager application:
    <server>:<port>/manager/html
  6. In the deploy section, deploy
    web-viewer.war
    :
    1. Enter the following Context Path:
      web-viewer
    2. Enter the following WAR or Directory URL:
      <
      Web Viewer Install Home
      >/web-viewer.war
    3. Deploy.
  7. Restart your Apache Tomcat server after the deployment.
    You must restart your Apache Tomcat server after each deployment.
  8. Access your deployed application:
    host:port/web-viewer
Stop the CCS Apache Tomcat Instance
You stop the CCS Apache Tomcat instances before you apply maintenance to your CCS Apache Tomcat implementation. You also stop the instances when you want to deploy your product WAR files.
To stop CCS Apache Tomcat on z/OS systems, issue the following MVS console command:
'P CAHVTOMX'
You can also stop the instance using the JZOS batch launcher by updating your configured CAHVTOMX startup JCL as follows:
//TOMCAT EXEC PGM=JVMLDM&VERSION,REGION=0M, // PARM='&LEPARM/&LOGLVL &JAVACLS &SRVXML stop'
Data Set
YourCAViewHLQ
.CVDEOPTN(CAHVTOMX)