CA Output Management Web Viewer

Transcription

1 CA Output Management Web Viewer Installation Guide Version 12.0

2 This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to as the Documentation ) is for your informational purposes only and is subject to change or withdrawal by CA at any time. This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and may not be disclosed by you or used for any purpose other than as may be permitted in (i) a separate agreement between you and CA governing your use of the CA software to which the Documentation relates; or (ii) a separate confidentiality agreement between you and CA. Notwithstanding the foregoing, if you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make available a reasonable number of copies of the Documentation for internal use by you and your employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced copy. The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed. TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION AS IS WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE. The use of any software product referenced in the Documentation is governed by the applicable license agreement and such license agreement is not modified in any way by the terms of this notice. The manufacturer of this Documentation is CA. Provided with Restricted Rights. Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections , , and (c)(1) - (2) and DFARS Section (b)(3), as applicable, or their successors. Copyright 2011 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

3 CA Technologies Product References This document references the following CA Technologies products: CA Bundl CA Common Services Common Communications Interface (CCI) CA Deliver CA Dispatch CA Distributed Repository Access System (CA DRAS) CA View CA Output Management Web Viewer Version 12.0 (CA OM Web Viewer) Contact CA Technologies Contact CA Support For your convenience, CA Technologies provides one site where you can access the information that you need for your Home Office, Small Business, and Enterprise CA Technologies products. At you can access the following resources: Online and telephone contact information for technical assistance and customer services Information about user communities and forums Product and documentation downloads CA Support policies and guidelines Other helpful resources appropriate for your product Providing Feedback About Product Documentation If you have comments or questions about CA Technologies product documentation, you can send a message to [email protected]. To provide feedback about CA Technologies product documentation, complete our short customer survey which is available on the CA Support website at

4

5 Contents Chapter 1: Overview 9 The Purpose of This Guide... 9 Audience... 9 Conventions Used... 9 More Information Chapter 2: Preparing for Installation 11 Prerequisites Supported Operating Systems Java Web Application Server JVM (Java Virtual Machine) Version LDAP for User Authentication Disk and Memory Space Requirement Environment Variables Memory Settings and Hardware Requirements Default Administrator ID Based on a Mainframe User Account CA Deliver Users CCI and DRAS Servers CA Distributed Repository Access System (CA DRAS) Considerations Database Prerequisites Mode of Installation, GUI or Console Installation Scenarios Scenario 1 - One Java Web Application Server with an Embedded Database on One Machine Scenario 2 - One Java Web Application Server and an External Database on the Same Machine Scenario 3 - Java Web Server and the External Database Server Are on Different Machines Scenario 4 - Multiple Java Web Servers Scenario 5 - Load Balancing using Apache Web Server with Tomcat Servers Scalability Scenarios One CA OM Web Viewer with Multiple CA DRAS Started Tasks Chapter 3: Acquiring the Product Installer 25 Use a Web Browser Use the CD Contents 5

6 Chapter 4: Installing the Product 27 Installation Considerations Overview of Installation and Configuration Steps Start a CA Output Management Web Viewer Installer Windows Environment AIX Environment USS Environment HP-UX Environment Linux Environment z/linux Environment Solaris Environment Installation Modes Installation Using the GUI Wizard Installation Using the Console Mode Chapter 5: Environment Considerations 57 Change the Java Runtime Environment Parameter Required for Java CA OM Web Viewer and WebSphere Configure the Java Web application server Chapter 6: Start or Shut Down CA OM Web Viewer 59 Start CA OM Web Viewer Shut Down CA OM Web Viewer Chapter 7: Frequently Asked Questions 61 FAQs Appendix A: Configuring CA Output Management Web Viewer 65 Appendix B: Uninstalling CA Output Management Web Viewer 71 Appendix C: Upgrading from a Previous Release 73 Supported Configuration Settings Export the Database Export Using the Console Import the Database Additional Tasks Installation Guide

7 Appendix D: Updating CA Output Management Web Viewer Version 12 (or later) Using the Update Installer 81 Prerequisites Environment and Supported Operating Systems Java Web Application Server JVM (Java Virtual Machine) Version Update an Existing CA OM Web Viewer, Version 12 or Later Pre-Installation Tasks Start the CA Output Management Web Viewer Update Installer Windows Environment AIX Environment USS Environment HP-UX Environment Linux Environment z/linux Environment Solaris Environment Mac OS X Environment Installation Modes Installation Using the GUI Wizard Step 1. Introduction and License Agreements Step 2. Select an Update Target Step 3. Backup the Original CA OM Web Viewer Step 4. Additional Copy of the Updated CA OM Web Viewer Step 5. Complete the Installation Installation Using the Console Mode Step 1. Introduction and License Agreements Step 2. Select an Update Target Step 3. Backup the Original CA OM Web Viewer Step 4. Additional Copy of the Updated CA OM Web Viewer Step 5. Complete the Installation Appendix E: Sample JCL for Running a Bundled Tomcat Server as a Mainframe Started Task 99 JCL Examples Appendix F: Acknowledgments 105 Index 107 Contents 7

8

9 Chapter 1: Overview Today, more than ever, business success depends on quick access to mission critical information that is processed, printed, and stored in a business environment. This information needs to be treated accordingly as an important business asset. It must be secured, retained, and managed according to departmental, corporate, and government guidelines and regulations. CA Output Management Web Viewer Version 12.0 uses the internet to instantly and seamlessly let you view any part of any document stored in targeted output repositories. CA Output Management Web Viewer Version 12.0 is also referred to as CA OM Web Viewer throughout this document. This section contains the following topics: The Purpose of This Guide (see page 9) Audience (see page 9) Conventions Used (see page 9) More Information (see page 10) The Purpose of This Guide This guide introduces you to CA OM Web Viewer. It provides an overview of the wide scope of the product and its usability; it also supplies installation guidance and scenarios specific to your environment. Audience This guide is for the Administrators who install, use, and maintain the product. This guide assumes that you are familiar with the underlying operating systems such as Linux, Solaris, HP-UX, or Microsoft Windows systems, terms, and concepts. Conventions Used For conventions used in this documentation, see the Administration Guide. Chapter 1: Overview 9

10 More Information More Information After you read this Installation Guide, see the product CD. This CD contains instructional documents that describe your software and provide detailed explanations about the product's comprehensive, feature-rich components. 10 Installation Guide

11 Chapter 2: Preparing for Installation This section contains the following topics: Prerequisites (see page 11) Installation Scenarios (see page 19) Scalability Scenarios (see page 23) Prerequisites This section contains information about the supported operating systems, the Java Web application server and Tomcat server, disk, memory, hardware requirements, user accounts, and CCI and DRAS servers. Scenarios provide suggestions for specific environments and scalability options. Supported Operating Systems CA OM Web Viewer is a Java application that must be run on a Java virtual machine (JVM). Therefore, we expect that a Java-enabled operating environment with a supported version of the Java Runtime Environment is supported: Windows Linux z/linux AIX HP-UX PA HU-UX IA Solaris Mac OS USS Chapter 2: Preparing for Installation 11

12 Prerequisites Java Web Application Server CA OM Web Viewer is a Java application that must be deployed on a Java Web application server. Note: If there is no Java Web application server installed on your computer, you can install the bundled Apache Tomcat Java Web application server that is shipped with the install image. JVM (Java Virtual Machine) Version CA OM Web Viewer can run on Java Runtime Environment 1.5 or above. We recommend Java 1.6. If you plan to run CA OM Web Viewer on 64-bit computers, use 64-bit JVM to optimize performance. LDAP for User Authentication CA OM Web Viewer supports the LDAP 3.0 protocol. Disk and Memory Space Requirement To successfully install CA OM Web Viewer, you need at least 150MB free space in your computer temp folder for the installation. On UNIX or USS, the temp folder is /tmp On Windows, the user s temp folder is used. For example: C:\Users\USERID\AppData\Local\Temp. CA OM Web Viewer requires 500MB to 1GB of disk space and 1 to 2 GB in main memory. For a large number of users, more space is needed. There is no formula that can be used to calculate the required memory for CA OM Web Viewer because memory usage depends on the number of users, login user roles, and user runtime activities. For each Admin user, Advanced user, and Basic user, there will be substantial differences in memory consumption. The possible memory range is from 500kB to 1MB per user at runtime. Note: For information about how to change memory settings in your Java Runtime Environment, see the sections that follow. 12 Installation Guide

13 Prerequisites Environment Variables Do not include these parameters in the environment variables JAVA_TOOL_OPTIONS and _JAVA_OPTIONS: -agentlib:jvmhook -Xrunjvmhook Memory Settings and Hardware Requirements How Much Memory is Required? This section describes the hardware required for CA Output Management Web Viewer, and where to change the settings. Determine the following: How many users are expected to use CA OM Web Viewer at the same time? What are your database connection limits? How many concurrent connections are required for read access? How many concurrent connections are required for write access? Note: These values can be set during the installation and adjusted after the installation. For more information, see CA Distributed Repository Access System (CA DRAS) Considerations to calculate the number of concurrent users. Chapter 2: Preparing for Installation 13

14 Prerequisites Where Are the Memory Settings and How Are They Changed? Change the memory settings according to the product you are using. Java Web Application Server Add or change the following Java parameters when you launch the Java Web application server. -Xms the initial heap size when the Java application is starting -Xmx the maximum heap size For example, if you set "-Xms1024m and Xmx2048m" as your parameters, the Java virtual machines do the following: allocate 1024MB at the beginning allow up to 2048MB memory usage at run-time Apache Tomcat Java Web application server installed by the installer Go to the install directory, find the appropriate file and change the settings: Windows: In apache-tomcat/bin/catalina.bat find the line "set "CATALINA_OPTS=-Xms256m -Xmx1024m " Make the changes according to your requirements. Windows registered as a Windows service: In apache-tomcat/bin/service.bat, find the string "--JvmMs JvmMx 1024" Make the changes according to your requirements. Note: You need to re-install the service as follows: 1. Remove the existing service service.bat remove 2. Re-install the service service.bat install Other operating systems: WebLogic In apache-tomcat/bin/catalina.sh find the line "CATALINA_OPTS="-Xms256m -Xmx1024m " Make the changes according to your requirements. You can set the memory using the environment variable USER_MEM_ARGS. For example: 14 Installation Guide

15 Prerequisites USER_MEM_ARGS=-Xms256m -Xmx1024m -XX:CompileThreshold=8000 -XX:PermSize=48m -XX:MaxPermSize=1024m Default Administrator ID Based on a Mainframe User Account To function as the default CA OM Web Viewer administrator, you must have a mainframe user account. During the installation process, the installer prompts you for a default administrator s ID. This ID must belong to a current mainframe user. CA Deliver Users For CA Deliver users, the APAR RO34553 is required for using CA Deliver hyperlinks with CA OM Web Viewer CCI and DRAS Servers CA OM Web Viewer communicates with the mainframe through a Common Communications Interface (CCI) server and accesses reports through CA Distributed Repository Access System (CA DRAS) servers running on the mainframe. The CCI server should be the TCP/IP (non-gateway) version. Note: CA OM Web Viewer requires at least one CA DRAS r11.5 with the required APAR (RO41367) installed on the mainframe. Chapter 2: Preparing for Installation 15

16 Prerequisites CA Distributed Repository Access System (CA DRAS) Considerations You can calculate the number of concurrent users supported by a CA DRAS server connected to a CA View database based on the following formula: For CA View 11.7 Solve for maxusers: Databases = number of CA View databases Data sets = (number of data file data sets(extents) for ALL CA View databases) + (number of data file data sets(extents) for ALL CA Deliver databases) maxusers = ((maximum available below-the-line storage (databases * 1616) - (data sets * 528)) / 2424) and drop remainder Based on the formula in the example: Given four CA View databases, 134 View data sets (extents), 0 Deliver data sets(extents), and bytes of maximum below-the-line storage, up to 3428 users per DRAS server can be supported. For CA View 11.6 and Older Note: All supported versions of CA View are supported by CA Output Management Web Viewer Version Solve for maxusers: Data sets = (number of index file data sets(extents) for largest CA View database) + (number of data file data sets(extents) for largest CA View database) + (number of data sets(extents) for largest CA Deliver database) usedbelowthelinestorage = ((((data sets + 81) / 41 and drop remainder) * 8192) ) + ((data sets * 388) maxusers = ((maximum available below-the-line storage in bytes ) / usedbelowthelinestorage) and drop remainder The following is an example showing 12 Megabytes of free below the line storage: Data sets = (3) + (30) + (2) = 35 usedbelowthelinestorage = (((( ) / 41 and drop remainder) * 8192) ) + ((35 * 388) = maxusers = (( ) / 37957) and drop remainder = 328 users per DRAS server 16 Installation Guide

17 Prerequisites Load Balancing CA DRAS supports load balancing if multiple DRAS servers are installed on your mainframe computer. The architecture of CA OM Web Viewer allows server replication for reliability and load balancing. Because of server replication, load balancing can be achieved at both the Java web application server level and the DRAS server level. You can manage your arrangement based on your service level agreement. Database Prerequisites CA OM Web Viewer works with a database server to store administrative data and improve run-time performance by caching that administrative data. You can: Let CA OM Web Viewer create an embedded database (Apache Derby embedded database). Use an external database For best performance, we recommend that you use an external database server. Note: For more information, see the instructions specific to your chosen installation mode. Embedded Database If you choose the embedded database option, CA OM Web Viewer creates and initializes an embedded database (Apache Derby embedded database) with the proper settings. CA OM Web Viewer stores administrative data in this embedded database. Note: The embedded database is created under a directory according to the type of application server where CA OM Web Viewer is deployed. For example: Tomcat: apache-tomcat/webapps/caomwebviewer12/database WebSphere: WebSphere/AppServer/derby/database Important! Because an embedded database is a component that belongs to the installed CA OM Web Viewer application, undeploying or uninstalling (or both), CA OM Web Viewer also removes the embedded database if the embedded database is created under the application s working folder. This situation is applicable on some application servers such as Tomcat. To keep the content of an existing embedded database, you must manually back up and copy the database directory. Chapter 2: Preparing for Installation 17

18 Prerequisites External Database We recommend that you use an external database to keep administrative data from being affected by undeploying/uninstalling or redeploying/re-installing CA OM Web Viewer. Note: If you choose an external database server, a database needs to be set up by the system administrator. On the database server, a database specifically for CA OM Web Viewer must be created. This database must be writable with a valid user account that has permission to access it. The external database server must provide a JDBC-3 compliant interface. For DB2, you must set up and run your DB2 server in new-function mode (NFM). Be aware that the tables of the database can be created manually or automatically, depending on whether the account is granted with CREATE TABLE privileges: If this account has CREATE TABLE privileges, this database can be empty and CA OM Web Viewer automatically creates the necessary tables. If this account does not have CREATE TABLE privileges, ask your database administrator (DBA) to create tables according to the Data Description Language (DDL) statements provided with CA OM Web Viewer. Note: These DDL statements can be found under the ddl folder in your installation media or the installed directory. For each supported database type, a pair of SQL scripts is provided as follows: create.sql For creating tables in the pre-created database drop.sql For deleting tables from the pre-created database See the specific instructions in either the GUI or Console mode of installation. Note: Currently we provide DDLs for the following types of database: DB2, Derby, Oracle, and SQL Server. 18 Installation Guide

19 Installation Scenarios Mode of Installation, GUI or Console The installer provides two different running modes and determines which mode is the most appropriate for use in your execution environment. Note: Both modes provide the same functionality. GUI mode The installation wizard is shown with a graphical user interface. Console In a console environment, the installation wizard is presented in a text-only mode but provides the same functionality as the one with GUI. Installation Scenarios A CA OM Web Viewer installation involves the following entities: Java Web application server CA OM Web Viewer is a Java Web application that must be run on a Java Web application server. (Optional, but recommended) Database server CA OM Web Viewer can be configured to link to a Relational Database Management System (RDBMS) for administration, data persistence, and caching frequently used administrative information. CA OM Web Viewer requires a database having a Java Database Connectivity (JDBC) driver compliant to type-3 JDBC specifications. For best performance, we recommend that you use a standalone database server. However, if there is no database server, CA OM Web Viewer can create an embedded database (Apache Derby embedded database) with the product. The following sections provide examples of possible installation scenarios. Chapter 2: Preparing for Installation 19

20 Installation Scenarios Scenario 1 - One Java Web Application Server with an Embedded Database on One Machine In this scenario, there is one single server. We install CA OM Web Viewer on a Java web application server that is running on this server. The choice not to use an external database causes CA OM Web Viewer to create an embedded database (Apache Derby embedded Database) within its run-time environment. Scenario 2 - One Java Web Application Server and an External Database on the Same Machine. In this scenario, we have one Java web application and one database server running on the same computer. During the installation, choose the external database option and specify JDBC connection information to set up the connection between CA OM Web Viewer and the database server. 20 Installation Guide

21 Installation Scenarios Scenario 3 - Java Web Server and the External Database Server Are on Different Machines CA OM Web Viewer connects to an external database through the standard JDBC protocol. The external database can be hosted on a computer different from the computer where the Java web server is located. In this scenario, we have a dedicated database server. During the installation, choose the external database option and specify JDBC connection information to set up the connection between CA OM Web Viewer and the dedicated database server. Chapter 2: Preparing for Installation 21

22 Installation Scenarios Scenario 4 - Multiple Java Web Servers For better scalability, multiple instances of CA OM Web Viewer can be deployed on several Java Web application servers and set to connect to a centralized database server. During the installation for each CA OM Web Viewer, choose the external database option and specify JDBC connection information to set up connections to this database server. 22 Installation Guide

23 Scalability Scenarios Scenario 5 - Load Balancing using Apache Web Server with Tomcat Servers With multiple instances of CA OM Web Viewer, you can deploy another server as a load balancer to dispatch requests. Note: The load balancer needs to support session affinity or session stickiness to help ensure that requests of the same session are directed to the same server. For example, deploy an Apache web server as the front-end server with multiple Tomcat servers behind the scene. This front-end server not only provides a single entry point for a cluster of web application servers but also supports load balancing. Scalability Scenarios CA Output Management Web Viewer can be configured to optimize the number of active, concurrent users. If your response time is slow, you can consider one of the options explained in the following sections. Note: CA OM Web Viewer is a gateway to your mainframe reports stored in a CA View, CA Dispatch, or CA Bundl repository. Any mainframe CPU-intensive operation does not decrease when scaling CA OM Web Viewer. Chapter 2: Preparing for Installation 23

24 Scalability Scenarios One CA OM Web Viewer with Multiple CA DRAS Started Tasks You can install and run multiple CA DRAS started tasks with one CA OM Web Viewer. An administrator can configure one repository in CA OM Web Viewer to have multiple DRAS tasks or Repository Locations. In this scenario, each task connects to a specific ENF(CCI)/CA DRAS/CA View or a specific ENF(CCI)/CA DRAS/CA Dispatch repository (one default entry plus some alternate ones). CA OM Web Viewer distributes the load among these DRAS tasks to access this particular mainframe View/Dispatch repository. This graphic illustrates the concept of load balancing among several DRAS tasks. 24 Installation Guide

25 Chapter 3: Acquiring the Product Installer CA OM Web Viewer is shipped on a CD disc or is downloadable from the CA Support website. This section contains the following topics: Use a Web Browser (see page 25) Use the CD (see page 26) Use a Web Browser You can acquire CA Output Management Web Viewer through a web browser. To acquire the installer through a web browser 1. Open install.htm in a web browser. 2. Choose an installer according to your operating environment. 3. If there is no Java Runtime Environment (JRE) installed on your computer, you can choose an installer that includes a Java VM (Virtual Machine). For operating systems where we do not provide a bundled JVM, verify that a JVM is already installed on the target computer. Based on the operating environment type, you may need to acquire a JVM from the system vendors, such as IBM, Oracle, HP, or Apple. 4. Click to download the installer. Chapter 3: Acquiring the Product Installer 25

26 Use the CD Use the CD From the CD disk, follow these steps: To acquire the installer through a CD 1. Open the folder InstData. 2. Locate a folder from the following list based on your operating environment: Windows Windows or Windows_x64 Linux Linux or Linux_x64 z/linus zlinux AIX AIX zlinux z/linux HP-UX PA HP-UX PA HP-UX IA HP-UX IA Solaris Solaris Mac OS X Mac_OS_X USS USS 3. If there is no Java Runtime Environment (JRE) installed on your computer, you can select the installer under the VM (Virtual Machine) folder. NoVM VM (if it exists) Contains an installer, including no Java VM Contains an installer, including a bundled Java VM For operating systems where we do not provide a bundled JVM, verify that a JVM is already installed on the target computer. Based on the operating environment type, you may need to acquire a JVM from the system vendors, such as IBM, Oracle, HP, or Apple. 26 Installation Guide

27 Chapter 4: Installing the Product This section contains the following topics: Installation Considerations (see page 27) Overview of Installation and Configuration Steps (see page 27) Start a CA Output Management Web Viewer Installer (see page 27) Installation Modes (see page 29) Installation Considerations The CA Output Management Web Viewer installer provides CA OM Web Viewer which installs all components required to use the application, including the main Web Application Archive (WAR) file (CAOMWebViewer12.war), a supplementary WAR file (castylesr5.1.3.war), the Apache Tomcat web application server, configuration utilities, and database DDLs in the form of SQL scripts. Note: During installation, you can choose to produce a single EAR file that contains both the WAR files. Overview of Installation and Configuration Steps The following is an overview of the CA OM Web Viewer installation process: To install the application 1. (Optional) Install Java Runtime Environment (JRE), if there is no JRE installed on your computer. 2. (Optional) Install the Apache Tomcat Java web application server. You may choose to use your own Java web application servers such as WebSphere, WebLogic, or Tomcat. 3. Install CA OM Web Viewer. 4. Configure CA OM Web Viewer. Note: For more information about how to configure CA OM Web Viewer, see the Administration Guide. Start a CA Output Management Web Viewer Installer To start a CA OM Web Viewer installer, find the instructions that are specific to your operating environment. Chapter 4: Installing the Product 27

28 Start a CA Output Management Web Viewer Installer Windows Environment Execute CA_OMWEBVIEWER_12_0_SP0.exe AIX Environment Execute CA_OMWEBVIEWER_12_0_SP0.bin For example: sh./ca_omwebviewer_12_0_sp0.bin USS Environment Use ssh or telnet to connect to USS (if ssh or telnet connection is supported) or use OMVS to gain access to a USS console. Launch CA_OMWEBVIEWER_12_0_SP0.jar with Java For example: java -jar CA_OMWEBVIEWER_12_0_SP0.jar Important! Ensure there is a Java Runtime Environment (JRE) installed on your computer. HP-UX Environment Execute CA_OMWEBVIEWER_12_0_SP0.bin For example: sh./ca_omwebviewer_12_0_sp0.bin Important! Ensure there is a Java Runtime Environment (JRE) installed on your computer. 28 Installation Guide

29 Installation Modes Linux Environment Execute CA_OMWEBVIEWER_12_0_SP0.bin For example: sh./ca_omwebviewer_12_0_sp0.bin z/linux Environment Execute CA_OMWEBVIEWER_12_0_SP0.bin For example: sh./ca_omwebviewer_12_0_sp0.bin Important! Ensure there is a Java Runtime Environment (JRE) installed on your computer. Solaris Environment Execute CA_OMWEBVIEWER_12_0_SP0.bin For example: sh./ca_omwebviewer_12_0_sp0.bin Important! Ensure there is a Java Runtime Environment (JRE) installed on your computer. Installation Modes Depending on the running environment, the installer automatically runs in an appropriate mode. The CA OM Web Viewer installer can run in: Graphical user interface (GUI) mode Use the Install Wizard to quickly and easily install your CA Output Management Web Viewer. Console mode Instructions are provided for both modes. Chapter 4: Installing the Product 29

30 Installation Modes Installation Using the GUI Wizard Follow these steps to install using the GUI mode. Step 1. Introduction and License Agreements Follow these steps: 1. Review the Introduction panel for information about the Installer and click Next. 2. Review the license agreement. Multiple products are licensed in this agreement. 3. Scroll down, select the I accept...option and click Next. 30 Installation Guide

31 Installation Modes Step 2. Supply the Installation Information Specify the folder where you want to install CA Output Management Web Viewer. This folder contains the files generated by the installer. Chapter 4: Installing the Product 31

32 Installation Modes Step 3. Choose your Java Virtual Machine The installer searches for existing Java virtual machines (VMs) from default folders on the system. You can click Search Another Location to search other folders or click Choose Java Executable to select a particular Java executable. Select the Java Virtual Machine you want the installed CA OM Web Viewer to use. 32 Installation Guide

33 Installation Modes Step 4. Deployment Method Do one of the following: Click Install Tomcat application server if you want to install the Tomcat Java web server. Chapter 4: Installing the Product 33

34 Installation Modes Do the following: Specify a folder where you want to install the Tomcat application server. Enter an internet socket port number for the Tomcat application server. Note: If you are installing on Windows and choose this option, a Register Tomcat as Windows Service dialog appears. 34 Installation Guide

35 Installation Modes Click Yes or No to indicate whether you want to proceed with the registration. If Yes is selected, the Tomcat web application server will be registered as a Windows service with Manual startup type. You can change its startup type to Automatic after installation if needed. If you have an existing application server (such as WebSphere, WebLogic, or Tomcat) on your computer, you can use the existing application server. Click the Use an existing server option and select a file type of your deployable. After installation, the CA OM Web Viewer EAR file or a pair of WAR files (CAOMWebViewer12.war and a supplementary WAR file castylesr5.1.3.war) will be generated and placed in this target directory. Depending on how your own web application server is managed, you may need to take further steps to deploy the EAR or WAR file(s) on your web application server. Chapter 4: Installing the Product 35

36 Installation Modes Step 5. Supply CCI Server and DRAS Server Information Follow these steps: 1. Enter values for your CCI (Common Communications Interface) server and port. The CCI server provides an interface for exchanging messages with the mainframe. The server name and port number specified here will be used in all communication between CA OM Web Viewer and the mainframe. 36 Installation Guide

37 Installation Modes After entering the CCI information, click the Test button to verify the connection. A Connection Successful message tells you that your entries were valid; otherwise, modify the parameters and try it again. 2. Select a DRAS Server that you want to use. After entering information for a CCI server, the installer connects to the mainframe using the specified CCI server to discover available DRAS servers. At run-time, CA OM Web Viewer communicates with this DRAS server to access reports. A message is displayed to inform you that CA OM Web Viewer is being configured, then the list is displayed. Step 6. Connect to a Database 3. Select a DRAS server from the list to be your default DRAS server. CA OM Web Viewer uses a database system for data persistence and caching administrative data. You can use an external database or let CA OM Web Viewer create an embedded database (Apache Derby embedded database). For best performance, we recommend that you use an external database server. Do the following if you choose to use an embedded database: 1. Select Use embedded database. CA OM Web Viewer will create an Apache Derby embedded database upon the first time it is launched. 2. Click Next and proceed to Step 7. Chapter 4: Installing the Product 37

38 Installation Modes If you choose to use an external database, select Use external database and do the following: Be aware that a database account and a pre-created database are required. 1. Select a database type from the Database type drop-down list. The drop-down menu lists a number of database types; we provide their JDBC drivers. For DB2 database, you will be prompted to select an IBM DB2 license file. In this case, select your license file (for example, db2jcc_license_cisuz.jar) from your local system. 38 Installation Guide

39 Installation Modes 2. If the type of database you want is not on the list, do the following: a. Select Other - Select a local JDBC driver. A dialog opens. b. Select a JAR (Java Archive) file that contains an appropriate JDBC driver. A pop-up dialog that lists all available JDBC driver classes in this JAR file is displayed. c. Select a class which serves as the JDBC driver and click OK. 3. Supply all the database connection parameters. Host name Defines the name or IP address of the database server. Port number Defines the port number on which the database is running. Chapter 4: Installing the Product 39

40 Installation Modes Database name Defines the name of the database that is to be used by CA OM Web Viewer. User name Defines the name of the database user. Password Defines the password of the database user; this information is stored in an encrypted form. With CREATE TABLE privileges If the database account specified in the User name field has CREATE TABLE privileges, only an empty database is required. Select this check box, and CA OM Web Viewer will create all necessary tables the first time it is started. If this account does not have CREATE TABLE privileges, clear this check box and ask your database administrator (DBA) to create tables according to the Data Description Language (DDL) statements provided with CA OM Web Viewer. See Database Requirements for more information. Maximum connections Defines the maximum number of database concurrent connections allowed in the system. JDBC URL Provides a valid URL that is required to establish database connections. The initial value is provided according to the input to the other fields. Make necessary changes to this string, if required. 4. Click the Test button to verify the connection. A Connection Successful message tells you that your entries were valid, otherwise, modify the parameters and try it again. Note: The test function is unable to verify whether this database account has CREATE TABLE privileges. 40 Installation Guide

41 Installation Modes Step 7. Indicate LDAP User Authentication Indicate your user authentication preferences. If you chose LDAP authentication first, supply the following: LDAP Host LDAP Port Login Attribute: The attribute in your LDAP directory that is used for user authentication. Common attribute names are cn (common name) and uid. Chapter 4: Installing the Product 41

42 Installation Modes Base DN: Additional attributes that need to be added to a user s login attribute, to produce the distinguished name as desired. After entering the LDAP information, click the Test button to verify the connection. A Connection Successful message tells you that your server and port entries were valid; otherwise, modify the parameters and try it again. Note: The test function is unable to verify the correctness of Login Attribute and Base DN. 42 Installation Guide

43 Installation Modes Step 8. Complete the Installation To complete the installation 1. Supply the mainframe User ID that is to be used as the default administrator ID. This user will be granted the Super Admin privileges needed to set up initial Web Viewer configurations. Note: For more information about the role of Super Admin, see the Administration Guide. 2. Review the settings displayed in the Pre-Installation Summary. Chapter 4: Installing the Product 43

44 Installation Modes 3. Click Install. 4. Respond to any overwrite messages. 5. If you chose to install a new Tomcat Java web server, respond to the start server now question. The Tomcat web application server will be started up immediately if you choose Yes and click Next. 44 Installation Guide

45 Installation Modes 6. Review the Install Complete information and follow the instructions to use the URL to start CA Output Management Web Viewer in a web browser. Note that if you are using an existing Java web server, the URL is only a template. The actual URL may vary according to how you set up and deploy CA OM Web Viewer on your own Web application server. 7. Click Done. Installation Using the Console Mode Follow these steps to install using the Console mode. Chapter 4: Installing the Product 45

46 Installation Modes Step 1. Introduction and License Agreements Follow these steps: 1. Review the following Introduction. ======================================================================== Introduction InstallAnywhere will guide you through the installation of CA OM Web Viewer v12. It is strongly recommended that you quit all programs before continuing with this installation. Respond to each prompt to proceed to the next step in the installation. If you want to change something on a previous step, type 'back'. You can cancel this installation at any time by typing 'quit'. PRESS <ENTER> TO CONTINUE: 2. Press Enter to continue. 3. Review the License Agreements. Because multiple products are licensed in this agreement, you must continue to press Enter until you reach the end of the license agreement. DO YOU ACCEPT THE TERMS OF THIS LICENSE AGREEMENT? (Y/N): 4. Enter Y to accept the license agreement. Step 2. Supply the Installation Information Specify where you want to install CA Output Management Web Viewer. Do one of the following: Use the default folder. Enter a path to a specific folder. This folder will contain the files generated by the installer. ======================================================================= Choose Install Folder Where would you like to install? Default Install Folder: /usr/local/ca_om_web_viewer ENTER AN ABSOLUTE PATH, OR PRESS <ENTER> TO ACCEPT THE DEFAULT 46 Installation Guide

47 Installation Modes Step 3. Choose Your Java Virtual Machine Select the Java Virtual Machine you want the installed CA Output Management Web Viewer to use. Do one of the following: Enter 1 to have the installer search for existing Java VMs (virtual machine) from default folders on the computer. Enter 2 to choose a Java executable on your computer. Step 4. Choose a Deployment Method ====================================================================== Choose Java Virtual Machine Choose a Java VM for Use by the Installed Application ->1- Use the Java VM installed with this application 2- Choose a Java VM already installed on this computer ENTER THE NUMBER FOR THE JAVA VM, OR PRESS <ENTER> TO ACCEPT THE CURRENT SELECTION: Note: If you use a Java executable on your computer, you have to specify the full path including the file name of your Java executable. For example, /sys/java64bt/v6r0m0/usr/lpp/java/j6.0_64/bin/java Do one of the following: Choose 1 if you want to install the Tomcat Java web application server. ======================================================================= Deployment Method CA Output Management Web Viewer 12 should be deployed on an application server. If you have an existing application server, select "Use an existing server" and then choose to produce either EAR or WAR files to a target directory. If there is no existing application server installed on the computer, select "Install Apache Tomcat application server" to install Apache Tomcat. ->1- Install Apache Tomcat application server 2- Use an existing server (WebSphere, WebLogic, Tomcat, etc.) ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT: Specify a folder where the Tomcat application server is to be installed. Specify an internet socket port number for the Tomcat application server. ======================================================================= Specify a folder where you want to install Tomcat Enter requested information Specify a folder to install Tomcat (DEFAULT: /usr/local/ca_om_web_viewer) : Specify a port number (DEFAULT: 8080): Chapter 4: Installing the Product 47

48 Installation Modes Choose 2 if you have an existing application server on your computer and do not want to install Tomcat. ======================================================================= Specify the File Type of Your Deployable Enter requested information ->1- Produce an EAR file 2- Produce WAR files ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT: Select one of the options and enter the target directory. After installation, the CA OM Web Viewer EAR file or a pair of WAR files will be generated and placed in this target directory. Step 5. Supply CCI Server and DRAS Server Information The CCI server provides an interface for exchanging messages with the mainframe. The server name and port number specified here is used in all communication between CA OM Web Viewer and the mainframe. Do the following: Enter values for your CCI (Common Communications Interface) server and port. ===================================================================== CCI Server Information Enter CCI (Common Communications Interface) server information CCI (Common Communications Interface) Server (DEFAULT: ): CCI (Common Communications Interface) Port (DEFAULT: ): After entering the CCI information, select Test CCI connection to validate the connection. This provides a quick test on the CCI connection information. Choose one of the following options to continue: ->1- Test CCI connection 2- Accept the current CCI settings 3- Go back to edit CCI information Select an action: 48 Installation Guide

49 Installation Modes A query is made to the mainframe to discover available DRAS servers using the CCI server specified in the previous panel. Select one DRAS Server from the list as the default server. Step 6. Connect to a Database ===================================================================== Select A DRAS (Distributed Repository Access System) Server Discovering DRAS servers... Done. ->1- ENFSYS1:DRASSVR1 Select A DRAS Server: At run-time, CA OM Web Viewer communicates with this DRAS server to access reports. CA OM Web Viewer uses a database system for data persistence and caching administrative data. You can use an external database or let CA OM Web Viewer create an embedded database (Apache Derby embedded database). For best performance, we recommend that you use an external database server. Chapter 4: Installing the Product 49

50 Installation Modes Do one of the following: Select 1 to use an external database. Note: A database account and a pre-created database are required. ===================================================================== Database Connection >1- Use external database 2- Use embedded database (Apache Derby Embedded Database) Do you want to use an external database: 1 ->1- Derby 2- DB2 3- Oracle 4- MS SQL Server 5- Other - select a local JDBC driver Database type: 1 Host name: db.company.com Port number: 1527 Database name: AdminDB User name: admin Password: Encrypting password... Done. ->1- Yes, this account is granted with CREATE TABLE privileges. 2- No, this is a restricted account without CREATE TABLE privileges. Does this account have CREATE TABLE privileges?: Maximum number of connections for Read (DEFAULT: 100): Maximum number of connections for Write (DEFAULT: 100): JDBC URL (DEFAULT: jdbc:derby://db.company.com:1527/admindb;create=true): Choose one of the following options to continue: ->1- Test database connection 2- Accept the current database settings 3- Go back to edit connection information Select an action: Testing database connection... Connection successful. Choose one of the following options to continue: 1- Test database connection ->2- Accept the current database settings 3- Go back to edit connection information Select an action: 50 Installation Guide

51 Installation Modes Specify the following information. Database type Lists a number of database types for which we provide their JDBC (Java Database Connectivity) driver. For DB2 database, you will be prompted to select an IBM DB2 license file. In this case, select your license file (for example, db2jcc_license_cisuz.jar) from your local computer. If the type of database is not on the list, select Other to select a JDBC JAR file on your local computer. After selecting a JAR file, you will be asked to select a class which serves as the JDBC driver. Host name Defines the name or IP address of the database server. Port number Defines the port number on which the database is running. Database name Defines the name of the database to be used by CA OM Web Viewer. User name Defines the name of the database user. Password Defines the password of the database user; this information is encrypted and stored. With CREATE TABLE privileges If the database account specified in the User name field has CREATE TABLE privileges, only an empty database is required. Select this check box, and CA OM Web Viewer will create all necessary tables the first time it is started. If this account does not have CREATE TABLE privileges, clear this check box and ask your database administrator (DBA) to create tables according to the Data Description Language (DDL) statements provided with CA OM Web Viewer. See Database Prerequisites for more information. Maximum connections Defines the maximum number of database concurrent connections allowed in the computer. JDBC URL Provides a valid URL that is required to establish database connections. The initial value is provided according to the input to the other fields. Make necessary changes to this string, if required. Chapter 4: Installing the Product 51

52 Installation Modes After all information is entered, select Test database connection to validate the connection. This provides a quick test on the database connection information. Note: The test function is unable to verify whether this database account has CREATE TABLE privileges. Select 2 if you want to use an embedded database. ======================================================================== Database Connection Use external database Step 7. Indicate LDAP User Authentication ->2- Use embedded database (Apache Derby Embedded Database) Do you want to use an external database: 2 CA OM Web Viewer will create an Apache Derby embedded database the first time it is launched. Indicate your user authentication preferences. ========================================================================== LDAP Host Information If you would like user authentication through LDAP (Lightweight Directory Access Protocol) first, Select "LDAP authentication first" and enter an LDAP host information. ->1- Mainframe security first 2- LDAP authentication first ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT:: If you chose LDAP authentication first, supply the following: LDAP Host LDAP Port Login Attribute: The attribute in your LDAP directory that is used for user authentication. Common attribute names are cn (common name) and uid. 52 Installation Guide

53 Installation Modes Base DN: Additional attributes that need to be added to a user s login attribute, to produce the distinguished name as desired. ======================================================================= LDAP Host Information Enter LDAP (Lightweight Directory Access Protocol) host information LDAP Host (DEFAULT: ): LDAP Port (DEFAULT: ): Login Attribute (DEFAULT: ): Base DN (DEFAULT: ): After entering the LDAP information, select Test LDAP connection to validate the LDAP server connection. This provides a quick test on the LDAP connection information. Note: The test function is unable to verify the correctness of Login Attribute and Base DN. Choose one of the following options to continue: ->1- Test LDAP connection 2- Accept the current LDAP settings 3- Go back to edit LDAP information Select an action: Chapter 4: Installing the Product 53

54 Installation Modes Step 8. Complete the Installation To complete the installation 1. Supply the mainframe User ID that is to be used as the default administrator ID. This user will be granted the Super Admin privileges needed to set up initial Web Viewer configurations. Note: For more information about the role of Super Admin, see the Administration Guide. ========================================================================= Default Administrator ID Specify a mainframe user ID to be the default administrator Default Administrator ID (DEFAULT: ): 2. Review the settings displayed in the Pre-Installation Summary. =========================================================================== Pre-Installation Summary Review the Following Before Continuing: Product Name: CA Output Management Web Viewer r12 Install Folder: /usr/local/ca_om_web_viewer Java VM Installation Folder: /usr/local/ca_om_web_viewer/jre Target Directory /usr/local/ca_om_web_viewer/apache-tomcat /webapps DRAS System ID ENFSYS1 DRAS Server DRASSVR1 Default Administrator ID ADMIN01 Disk Space Information (for Installation Target): Required: 135,319,342 bytes Available: 16,332,423,168 bytes PRESS <ENTER> TO CONTINUE: 3. Click Install. ======================================================================== Ready To Install InstallAnywhere is now ready to install CA OM Web Viewer 12 onto your computer at the following location: /usr/local/ca_om_web_viewer PRESS <ENTER> TO INSTALL: 54 Installation Guide

55 Installation Modes 4. Respond to any overwrite messages. 5. If you chose to install a new Tomcat Java web server, respond to the start server now question. ======================================================================== Start Up the Tomcat Application Server The Tomcat application server has been installed in /usr/local/ca_om_web_viewer/apache-tomcat To start up the server, run /usr/local/ca_om_web_viewer/apache-tomcat /bin/startup.sh. Would you like to start up the Tomcat application server now? ->1- Yes, start up the Tomcat application server now. 2- No. ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT:: 6. Review the Install Complete information and follow the instructions to use the URL to start CA Output Management Web Viewer in a web browser. Note that if you are using an existing Java web server, the URL is only a template. The host name and port number still need to be filled in with the correct values. 7. Click Done. ===================================================================== Installation Complete Congratulations! CA Output Management Web Viewer v12 has been successfully installed to: /usr/local/ca_om_web_viewer To start using CA Output Management Web Viewer v12, be sure the application server is running, then open the following URL in a web browser: PRESS <ENTER> TO EXIT THE INSTALLER: Note: This is a sample URL. Set the server, company, and port settings to reflect the requirements of your site. Chapter 4: Installing the Product 55

56

57 Chapter 5: Environment Considerations The following environments may require special considerations. This section contains the following topics: Change the Java Runtime Environment (see page 57) Parameter Required for Java 1.6 (see page 57) CA OM Web Viewer and WebSphere (see page 58) Configure the Java Web application server (see page 58) Change the Java Runtime Environment If you installed the bundled Apache Tomcat Web application server shipped with CA OM Web Viewer, the Java Runtime Environment (JRE) can be changed as follows: To change the JRE, on Windows operating environment 1. Find the file under the directory where the Apache Tomcat Web application server is installed: apache-tomcat\bin\catalina.bat 2. Find the following line in this file set "JRE_HOME=C:\Program Files\..." 3. Change the directory pointing to the JRE you would like to use. To change the JRE, on other operating environments 1. Find the file under the directory where the Apache Tomcat Web application server is installed: apache-tomcat/bin/catalina.sh 2. Find the following line in this file JRE_HOME=C:\Program Files\ Change the directory pointing to the JRE you would like to use. Parameter Required for Java 1.6 If you are running on Java 1.6 and encounter the following error: Java.lang.ClassNotFoundException: [Ljava.lang.String; at loadclass( ) Chapter 5: Environment Considerations 57

58 CA OM Web Viewer and WebSphere Add the following Java parameter to the arguments you use to launch your Web application server; for example, the environment variable JAVA_OPT. Dsun.lang.ClassLoader.allowArraySyntax=true CA OM Web Viewer and WebSphere Before deploying CA OM Web Viewer on WebSphere, be sure all fixes for the WebSphere server have been applied. To run CA OM Web Viewer on WebSphere, you must set Class loader order to Classes loaded with local class loader first (parent last) to load libraries within the CA OM Web Viewer package first. However, if you selected to produce an EAR file during installation, this setting is automatically included in the EAR file, so you can deploy this EAR file on WebSphere without additional settings. Configure the Java Web application server CA Output Management Web Viewer uses a default home page name of Note: For more information about configuration, see the chapter Configuring CA OM Web Viewer in this guide, and the chapter Configuration and Customization in the Administration Guide. 58 Installation Guide

59 Chapter 6: Start or Shut Down CA OM Web Viewer If you installed the bundled Apache Tomcat web application server during installation, you can follow the instructions to start or shut down CA OM Web Viewer. This section contains the following topics: Start CA OM Web Viewer (see page 59) Shut Down CA OM Web Viewer (see page 60) Start CA OM Web Viewer Do the following: To start the application 1. Be sure that both the CA OM Web Viewer WAR file (CAOMWebViewer12.war) and the supplementary WAR file (castylesr5.1.3.war) are deployed. 2. Start the Web application server. If you installed the Tomcat Java Web application server accompanying CA OM Web Viewer, you can launch the server in one of the following ways according to your operating environment: Windows: Option 1: Find the shortcut Startup Tomcat in your Windows Start menu and run it. Chapter 6: Start or Shut Down CA OM Web Viewer 59

60 Shut Down CA OM Web Viewer Option 2: If you chose to register it as a Windows service, use the Services administration tool to find and start the service named Tomcat6forCAOMWebViewer12. Option 3: Go to 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: Go to 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: Shut Down CA OM Web Viewer If you installed the Tomcat Java Web application server accompanying with CA OM Web Viewer, you can shut down the server in one of the following ways according to your operating environment: Windows: Option 1: Find the shortcut Shutdown Tomcat in your Windows Start menu and run it. Option 2: If you chose to register it as a Windows service, use the Services administration tool to find and stop the service named Tomcat6forCAOMWebViewer12. Option 3: Go to the apache-tomcat folder where you installed the bundled Apache Tomcat web application server. Execute the script apache-tomcat\bin\shutdown.bat Other platforms: Go to the apache-tomcat folder where you installed the bundled Apache Tomcat web application server. Execute the script apache-tomcat/bin/shutdown.sh 60 Installation Guide

61 Chapter 7: Frequently Asked Questions This section presents some of the Frequently Asked Questions (FAQs) that assist in getting started with the product. This section contains the following topics: FAQs (see page 61) FAQs Which documents can I access? The administrator determines which documents (or parts of documents) you can access. The Report List displays information about the reports to which you have access. You can customize the Report List using date and report id filters with changing mode, recipient, or mail code to limit the display to those documents that interest you. Note: The administrator must know about the repositories that are in use. They must be able to set up, or request someone to set up, the infrastructure (CA DRAS for the mainframe) for web access. Cross-report Indexes, Indexes, and Logical Views allow viewing of sections of one or multiple CA View documents. You can use indexes and logical views to view sections of one or multiple CA Bundl documents. You can view text reports and reports in the following formats (provided you have the associated viewers or source applications on your PC): AFP reports CA Bundl reports CA Dispatch reports CA View reports Other PC application files Note: CA OM Web Viewer does not support Xerox format, therefore, we suggest that you convert these documents to PDF files. Where do the documents reside? CA Output Management Web Viewer provides easy access to documents that reside on a mainframe. The data is not stored on your computer, rather, the document resides in the product database; therefore, you can view the document without downloading it to your PC. Chapter 7: Frequently Asked Questions 61

62 FAQs How can I use the document data? CA Output Management Web Viewer lets you and save any type of document. It also enables you to view, print, and export text documents. You cannot edit an original document but you can save a copy of any document on your PC. You can also save documents created by PC applications (for example, Microsoft Word files and Microsoft Excel spreadsheets) by invoking the associated application. Do I have to install CA Output Management Web Viewer on my primary Java web server? Yes. CA Output Management Web Viewer must be running on the same server as Java web server. Do I have to be logged in to the CA Output Management Web Viewer computer to update users or repositories? Yes. CA Output Management Web Viewer 12 administration tools are integrated as a part of the web application. You need to log in to CA OM Web Viewer to make updates. What are the system requirements for cooperative processing using CA DRAS? To implement cooperative processing with CA Output Management Web Viewer, you must install CA Output Management Web Viewer on a Java web server. On the host computer, you will need TCP/IP, either the IBM version or CA TCPaccess Communication Server. In addition, you need to have CAICCI and the CCITCP task active. CA DRAS is a separate product that must be installed and configured to run with the mainframe solution you are currently running, which can include the following: CA Common Services r11 SP08 or higher CA View r11.6 or higher. For large user base environment, we recommend using CA View r11.7 which comes with XMS enhancement for better utilizing above-the-line storage. CA Dispatch r11 CA Bundl r5.0 Genlevel 0309 SP1 plus SYSMOD C$V Installation Guide

63 FAQs Do I need a database server to run CA Output Management Web Viewer? CA Output Management Web Viewer stores user ID and repository information in a JDBC-compliant database. You can also choose to use an embedded database automatically deployed by CA OM Web Viewer instead of an external one. Important! Because the embedded database is a component that belongs to the installed CA OM Web Viewer application, undeploying/uninstalling CA OM Web Viewer will also remove the embedded database, if the embedded database is created under the application s working folder. This situation is applicable on some application servers such as Tomcat. We recommend that you use an external database, to avoid administrative data from being affected by undeploying/uninstalling or redeploying/re-installing CA OM Web Viewer. Deployment consideration when using WebSphere If you selected to produce an EAR file during the installation, you can deploy this EAR file on WebSphere without additional settings. If you selected to produce WAR files, you will need to set class loader order to Classes loaded with local class loader first (parent last) in WebSphere for both application level and module level. In addition, when redeploying an application on WebSphere, you may need to remove those compiled class files remaining from the previous installation. Those files can be located under the temp folder such as the following: WebSphere/AppServer/profiles/AppSrv01/temp/ServerNode01/server1 Deployment consideration when using WebLogic You may need to modify the configuration file to turn on the show-archived-real-path-enabled attribute. To modify the configuration file 1. Find the following file: Oracle/Middleware/user_projects/domains/base_domain/config/config.xml 2. Add the following lines to this file: <web-app-container> <show-archived-real-path-enabled>true</show-archived-real-path-enabled> </web-app-container> Chapter 7: Frequently Asked Questions 63

64 FAQs How can I change the port number of the bundled Apache Tomcat server? Find the file apache-tomcat/conf/server.xml and edit it in ASCII mode. To change the port number, find the following line and change the setting. The string 8080 may be different if you specified another number during the installation. <Connector port="8080"> To change the shutdown port, find the following line in the same file and change the port number. You may set the port number to -1 if you want to turn off the shutdown daemon. <Server port="8005" shutdown="shutdown"> Does CA OM Web Viewer use the system temp folder at run-time? No, Web Viewer does not use the system temp folder at run-time. Be aware that CA OM Web Viewer is a Java EE application, so it may use the temp folder designated by the application server to which Web Viewer is deployed. How can I be sure that a User role is updated? Be sure to use the Configuration tab to change the login role. Does the performance of CA OM Web Viewer benefit from the use of HiperSockets? CA OM Web Viewer should see some benefit assuming HiperSockets are properly configured. What is the initial database file size required for the database setup for CA OM Web Viewer? There is no specific data file size for the database needed for CA OM Web Viewer in various database systems. The size depends on how many repositories, roles, and users would be set up and managed in the CA OM Web Viewer system. Approximately, it is up to 10 MB of table space to hold 100 repositories, 50 roles, and 1000 users, not including the audit log records that go into the database. 64 Installation Guide

65 Appendix A: Configuring CA Output Management Web Viewer CA OM Web Viewer comes with a configuration tool for changing initial settings after installation. The configuration tool is located under the util directory after installation. This tool can be used to modify settings in the following sections: CCI, DRAS, Database, LDAP, and Default Administrator. You may execute Configure_Web_Viewer to modify all sections or execute Change_CCI_Settings, Change_DRAS_Settings, Change_Database_Settings, Change_LDAP_Settings, or Change_Default_Administrator to modify each individual section. Note: On Windows servers, you may need to run the configuration tool as the Administrator. To run the configuration tool as the Administrator, press SHIFT, right-click the configuration tool shortcut, and then select Run as administrator. For USS users, you might need to use ssh or telnet to connect to USS (if ssh or telnet connection is supported) or use OMVS to gain access to a USS console. After the configuration tool is launched, it will prompt users for the target CA OM Web Viewer package. You can press the Enter key to use the default package or specify a Web Viewer package at a different location. The default package is the one installed from your initial installation. Note: If the package to be updated is a folder of CA Output Management Web Viewer on a Web application server, you will need to restart the server to make the changes take effect. If the package to be updated is an EAR or a WAR file, you will need to redeploy the archive CA Output Management Web Viewer 12 Configuration Tool Enter an EAR file, a WAR file, or a folder of CA Output Management Web Viewer 12 (Press [Enter] to use the default package) Default package: /usr/local/ca_om_web_viewer/apache-tomcat /webapps/caomwebviewer12 Enter a package: Appendix A: Configuring CA Output Management Web Viewer 65

66 FAQs After entering the target CA OM Web Viewer package, follow the procedure on the screen. =============================================================================== CA OM Web Viewer v12 Configuration Tool Enter new values or press [Enter] to accept the current value =============================================================================== CCI (Common Communications Interface) Server Information [CCI (Common Communications Interface) Server] The current value: server.company.com Enter a new value: [CCI (Common Communications Interface) Port] The current value: 1204 Enter a new value: =============================================================================== Connection Test for CCI Server Information : Test connection 2: Save settings changes 3: Re-edit settings [Select an option] Default selection: 1 Select an action: Testing connection... Connection successful. =============================================================================== Connection Test for CCI Server Information : Test connection 2: Save settings changes 3: Re-edit settings [Select an option] Default selection: 2 Select an action: 66 Installation Guide

67 FAQs =============================================================================== DRAS (Distributed Repository Access System) Server Information Discovering DRAS servers on server.company.com: : ENFSYS1:DRASSVR1 2: ENFSYS1:DRASSVR2 3: No Change (ENFSYS1:DRASSVR1) [DRAS (Distributed Repository Access System) Server] Current value: 3 Enter a new value: =============================================================================== Database Connection Settings [use an external database? (Enter 1 for Yes, 0 for No)] Current value: 1 Enter a new value: : Derby 2: DB2 - select a license file 3: Oracle 4: MS SQL Server 5: Other - select a local JDBC driver 6: No Change (Derby) [Database type] Current value: 6 Enter a new value: [Host name] Current value: db.company.com Enter a new value: [Port number] Current value: 1527 Enter a new value: [Database name] Current value: AdminDB Enter a new value: [User name] Current value: admin Enter a new value: Appendix A: Configuring CA Output Management Web Viewer 67

68 FAQs [Password] New password: (If you do not want to change the existing password, press [Enter].)* Using the current password [Does this account have CREATE TABLE privileges? (Enter 1 for Yes, 0 for No)] Current value: 1 Enter a new value: [Maximum number of connections for Read] Current value: 100 Enter a new value: [Maximum number of connections for Write] Current value: 100 Enter a new value: [JDBC URL] Recommended value: jdbc:derby://db.company.com:1527/admindb;create=true Current value: jdbc:derby://db.company.com:1527/admindb;create=true Enter a new value: =============================================================================== Connection Test for Database Information : Test connection 2: Save settings changes 3: Re-edit settings [Select an option] Default selection: 1 Select an action: Testing connection... Connection successful. =============================================================================== Connection Test for Database Information : Test connection 2: Save settings changes 3: Re-edit settings [Select an option] Default selection: 2 Select an action: 68 Installation Guide

69 FAQs =============================================================================== LDAP (Lightweight Directory Access Protocol) Host Information : Mainframe security first 1: LDAP authentication first [Authentication Preference] Current value: 0 Enter a new value: [LDAP Host] Current value: Enter a new value: ldap.company.com [LDAP Port] Current value: Enter a new value: [LDAP Login Attribute] Current value: Enter a new value: uid [LDAP Base DN] Current value: Enter a new value: ou=people,ou=northamerica =============================================================================== Connection Test for LDAP Information : Test connection 2: Save settings changes 3: Re-edit settings [Select an option] Default selection: 1 Select an action: Testing connection... Connection successful. Appendix A: Configuring CA Output Management Web Viewer 69

70 FAQs =============================================================================== Connection Test for LDAP Information : Test connection 2: Save settings changes 3: Re-edit settings [Select an option] Default selection: 2 Select an action: =============================================================================== Default Administrator's Mainframe ID [Default Administrator's Mainframe ID] Current value: ADMIN01 Enter a new value: =============================================================================== Updating... Done. Update successful to /usr/local/ca_om_web_viewer/apache-tomcat /webapps/caomwebviewer12 Please restart the server to make the changes take effect. Press [Enter] to finish Installation Guide

71 Appendix B: Uninstalling CA Output Management Web Viewer Do the following: To uninstall the application 1. Find the uninstaller. Windows: Find the uninstaller shortcut in the programs menu. Other operating systems: Under the uninstaller folder in your install directory, find a program called uninstaller or uninstaller.jar and run it; for example, type./uninstaller or java -jar./uninstaller.jar under this folder. 2. Run the uninstaller. Like the installer, CA OM Web Viewer uninstaller can be run in either GUI mode or Console mode. Follow the instructions given by the wizard. Appendix B: Uninstalling CA Output Management Web Viewer 71

72 FAQs 72 Installation Guide

73 Appendix C: Upgrading from a Previous Release CA OM Web Viewer Version 12.0 does not support a direct upgrade from a previous version. However, most of the configurations that were done can be migrated, using the Web Viewer 11.5 Database Export tool in the current version. The tool processes select configuration settings from an r11.0 or r11.5 database. The tool exports the settings to (three) XML files that can be then uploaded into the Version 12.0 administration database through the import feature in Version Important! The CA OM Web Viewer Version 12.0 installation does not replace, or otherwise impact, an existing r11.5 product installation. This includes the database upgrade procedure. The database upgrade does not alter the existing r11.5 database, but, only exports (copies) the r11.5 administrative configuration to a format that can then be imported into the Version 12.0 database. This section contains the following topics: Supported Configuration Settings (see page 73) Export the Database (see page 74) Import the Database (see page 78) Additional Tasks (see page 79) Supported Configuration Settings The following definitions can be migrated from the r11.0 or r11.5 database to Version 12.0: Folder definitions for the DRAS folder are migrated as Repository Objects. The Repository Object name is set to the Folder name. Local and Document Server folders support is dropped for Version 12.0 and are not migrated. Generic users with folder set definitions are combined and migrated as Role Objects. The Role Object name is set to the (generic) user name. Additionally, Role Objects are derived for defined (non-generic) Users. The Role Object name is set to a value like DerivedRole_ Appendix C: Upgrading from a Previous Release 73

74 Export the Database Defined (non-generic users that are defined through the AdmTool) and Personal User accounts are migrated as User Objects. The User Object name is set to the user name. Defined users are assigned to the Role Object derived from the user definition. Personal user accounts are assigned to the Role Object based on its generic user definition. Temporary users (users who log in using generic credentials) are not migrated. Export the Database Important! The CA OM Web Viewer r11.5 Database Export can be run from a computer which has access to the SQL Server system that holds the r11.0 or r11.5 database. You do not require access to the computer where Version 12.0 is installed (the copy/move of the resulting XML files are beyond the scope of this application). You can use the export tool on any platform of the CA OM Web Viewer install if a JDBC driver URL is provided. You can export the database any time after installing and deploying CA OM Web Viewer Version 12.0, but, before the repositories, roles, and users are exported. Export Using the Console The Web Viewer r11.5 Database export tool is located under the util directory, after installing CA OM Web Viewer. You can now start the application through the console and export the required database. Follow these steps: 1. Execute the following command to begin the export process: DVWEB_MigrationTool_Console_mode The introduction to the application displays. 2. Review the displayed instructions. a. Use the command back to modify a previous step. b. Use the command quit to end the export, at any time. 3. Press Enter to continue. 74 Installation Guide

75 Export the Database Enter the SQL Server Information Select the Database The CA OM Web Viewer r11.5 (or older) database resides on a Microsoft SQL Server. Enter the SQL Server information to connect to this database. Follow these steps: 1. Provide the required SQL Server information. SQL Node Name Defines the name of the computer where the SQL Server, that contains the r11.0 or r11.5 database, resides. (Optional) SQL Instance Name SQL Port Defines the SQL Server instance name, if you are not using the default instance. Note: Press Enter if you have no instance. Defines the SQL Server port. Press Enter to accept the default. If you are not using the default port (likely if using a named instance), enter the port number. Default: 1433 SQL UserID Defines the SQL Server user ID. SQL Password Defines the SQL Server password. The SQL information is validated and the CA OM Web Viewer databases are detected. If the information is incorrect, you are prompted to start again. You can select the required SQL Database from the list of displayed databases, by its number, and then press Enter. Example Select the SQL Database by number: 1 dvweb_r If the database you want to export is not displayed, you can exit through the quit command or change SQL Server information through the back command. Appendix C: Upgrading from a Previous Release 75

76 Export the Database Specify the Output Folder Enter the CCI Server Information You can specify the output folder directory to receive the XML files (exported settings). If the specified folder does not exist or you do not have sufficient write permissions, you are prompted to specify another folder. The export tool has to resolve mainframe repository information which entails a DRAS Discovery. This can be bypassed for the following: If the Common Communications Interface (CCI) Server is not accessible, enter yes. Important! If you select this option, the repository type value is incorrect for any non-ca View repository. You can review and correct the values, after import into Version 12.0, through repository administration. If all repositories are CA View, you can select (yes) Bypass DRAS Discovery for a quicker export. Follow these steps: 1. Complete the following information: Bypass DRAS discovery Defines if you want to perform DRAS Discovery. Default: no CCI (Common Communications Interface) Server Defines the CCI Server (mainframe name or IP address). CCI (Common Communications Interface) Port Defines the CCI Server Port number. Default: 1202 Review the Options and Complete the Export Review the entered information and your options through the selection summary and make any required changes. Example SQL Node Name Port sqlserver.ca.com Installation Guide

77 Export the Database SQL UserID userid SQL Password password Database Name dvweb_r11 Output Directory d:\temp CCI (Common Communications Interface) Server ca31.ca.com CCI (Common Communications Interface) Port 1202 Press Enter to export the database. When the export is complete, the file names and folder are listed in the results. Appendix C: Upgrading from a Previous Release 77

78 Import the Database Example DRAS Discovery Connecting to the source database... 0% done Creating Repository records... 5% done Creating Role records... 20% done Creating User records... 50% done Disconnecting from the source database... 70% done Preparing data for export... 75% done Export ending... 99% done Export Complete. Files... Repository.xml Role.xml User.xml created in folder d:\temp. Import the Database Note: For information about how to use the Admin Import interface, see the Online Help. 1. Log in to Web Viewer 12.0, using an account that has System Admin privileges. 2. Select the Administration tab, sub tab Repositories. 3. Click Import (above the Repository list). The Admin Object Import form displays. 4. Select Repository, and then browse and select the Repository.XML file that was created during export. 78 Installation Guide

79 Additional Tasks 5. (Optional) Select Role and User, and then browse and select the Role.XML and User.XML files that were created during export. Note: If you are doing individual imports, use the following order: Repository Role User Otherwise, Repository-to-Role and Role-to-User assignments can be lost. 6. Click Import to perform the import. a. If Role.XML was not previously processed, select the sub tab Roles and then repeat steps 3-6 for Roles. b. If User.XML was not previously processed, select the sub tab Users and then repeat steps 3-6 for Users. Additional Tasks After you import the repositories, roles, and users into Web Viewer Version 12.0, it is important to review the resulting 12.0 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 The result Role Object names are set to values like DerivedRole_ (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. Appendix C: Upgrading from a Previous Release 79

80 Additional Tasks Review User objects Review and update the user information as needed. 80 Installation Guide

81 Appendix D: Updating CA Output Management Web Viewer Version 12 (or later) Using the Update Installer CA provides an Update Installer to ship the updates and help you upgrade an existing CA OM Web Viewer in Version 12.0 or later. Prerequisites This section contains information about the prerequisites that must be in place to run the update installer. Environment and Supported Operating Systems CA Output Management Web Viewer Version 12 is a Java application; it must be run on a Java virtual machine (JVM). Therefore, CA Output Management Web Viewer expects that a Java-enabled operating environment with a supported version of the Java Runtime Environment is installed in your environment for these operating systems: Windows Linux z/linux AIX HP-UX Solaris Mac OS USS Java Web Application Server The CA OM Web Viewer Version 12.0 is a Java application; therefore, it must be deployed on a Java Web application server. Appendix D: Updating CA Output Management Web Viewer Version 12 (or later) Using the Update Installer 81

82 Pre-Installation Tasks JVM (Java Virtual Machine) Version You can run CA OM Web Viewer on Java Runtime Environment 1.5 or above. We recommend using Java 1.6. In addition, if you are planning to run CA OM Web Viewer on 64-bit computers, use the 64-bit JVM to optimize performance. Important! For Microsoft SQL Server users, be aware of the following: If the version of the Java Runtime Environment (JRE) is to be upgraded from 1.5 to 1.6, you must manually swap WEB-INF/bak/sqljdbc4.jar and WEB-INF/lib/sqljdbc.jar under the CAOMWebViewer12 application folder. If the JRE is to be changed from 1.6 to 1.5, you must manually swap WEB-INF/bak/sqljdbc.jar and WEB-INF/lib/sqljdbc4.jar. Update an Existing CA OM Web Viewer, Version 12 or Later The update installer is configured to apply updates to CA OM Web Viewer, Version 12.0 or later. Notes: Do not run the update installer unless CA OM Web Viewer Version 12.0 (or later) is already installed on your system. We strongly recommend that you backup your current CA OM Web Viewer according to your application server environment before you run the update installer. Pre-Installation Tasks We recommend that you complete the following tasks before you run the update installer: 1. Locate the original version of CA OM Web Viewer--this is the target to be updated. 2. (Optional, but recommended) select a folder for storing a backup of the original version of CA OM Web Viewer. 3. Select a folder for storing an additional copy of the updated CA OM Web Viewer. 82 Installation Guide

83 Start the CA Output Management Web Viewer Update Installer Start the CA Output Management Web Viewer Update Installer To start a CA OM Web Viewer Update Installer, find the instructions that are specific to your operating environment. Windows Environment Execute the following: CA_OMWEBVIEWER_12_0_SP0_Update.exe AIX Environment Execute CA_OMWEBVIEWER_12_0_SP0_Update.bin For example: sh./ca_omwebviewer_12_0_sp0_update.bin USS Environment Launch CA_OMWEBVIEWER_12_0_SP0_Update.jar with Java For example: java -jar CA_OMWEBVIEWER_12_0_SP0_Update.jar Important! Ensure there is a Java Runtime Environment (JRE) installed on your computer. HP-UX Environment Execute CA_OMWEBVIEWER_12_0_SP0_Update.bin. For example: sh./ca_omwebviewer_12_0_sp0_update.bin Important! Ensure there is a Java Runtime Environment (JRE) installed on your computer. Appendix D: Updating CA Output Management Web Viewer Version 12 (or later) Using the Update Installer 83

84 Start the CA Output Management Web Viewer Update Installer Linux Environment Execute CA_OMWEBVIEWER_12_0_SP0_Update.bin. For example: sh./ca_omwebviewer_12_0_sp0_update.bin z/linux Environment Execute CA_OMWEBVIEWER_12_0_SP0_Update.bin. For example: sh./ca_omwebviewer_12_0_sp0_update.bin Important! Ensure there is a Java Runtime Environment (JRE) installed on your computer. Solaris Environment Execute CA_OMWEBVIEWER_12_0_SP0_Update.bin. For example: sh./ca_omwebviewer_12_0_sp0_update.bin Important! Ensure there is a Java Runtime Environment (JRE) installed on your computer. Mac OS X Environment Execute the following: CA_OMWEBVIEWER_12_0_SP0_Update Important! Java must be installed on your computer. Stuffit Expander must recognize the compressed update installer and automatically expand after download. If it does not expand, you can manually expand using StuffIt Expander 6.0 or later. 84 Installation Guide

85 Installation Modes Installation Modes Depending on the running environment, the CA OM Web Viewer update installer automatically runs in the appropriate mode. The Update Installer can run in: Graphical user interface (GUI) mode Use the Install Wizard to quickly and easily install your CA Output Management Web Viewer. Console mode Note: Instructions are provided for both modes and both modes provide the same functionality. Installation Using the GUI Wizard Follow the steps in this section to install using the GUI mode. Appendix D: Updating CA Output Management Web Viewer Version 12 (or later) Using the Update Installer 85

86 Installation Using the GUI Wizard Step 1. Introduction and License Agreements Follow these steps: 1. Select a locale from the Choose Locale drop-down menu, and click OK. 2. Review the Introduction panel for information about the Update Installer and click Next. 3. Review the License Agreement. 4. Scroll down, select the I accept...option and click Next. Note: Multiple products are licensed in this agreement. 86 Installation Guide

87 Installation Using the GUI Wizard Step 2. Select an Update Target According to the deployment method of your previous version of CA OM Web Viewer, do one of the following: If the current CA OM Web Viewer is deployed on an Apache Tomcat web server, do the following: Click "Update Web Viewer running on an Apache Tomcat server" Select the home folder of the Apache Tomcat server. This folder should contain a "bin" sub-folder and a "webapps" sub-folder; for example: "C:\Program Files\CA\CA_OM_Web_Viewer\apache-tomcat " Appendix D: Updating CA Output Management Web Viewer Version 12 (or later) Using the Update Installer 87

88 Installation Using the GUI Wizard If you have a CA OM Web Viewer EAR file: Select "Update a Web Viewer EAR file" Specify the path of your EAR file CAOMWebViewer12.ear. Note: You will need to re-deploy the EAR file after the update. Important! For users of embedded databases, if the folder of the embedded database is not contained in the selected EAR file, it will also not be in the updated EAR file. If you produced CA OM Web Viewer WAR files in your previous installation: Select "Update Web Viewer WAR files" Specify the paths of your WAR files, including CAOMWebViewer12.war and the supplementary WAR file castylesr5.1.3.war. Note: You will need to re-deploy these WAR files after the update. Important! For embedded database users, if the folder of the embedded database is not contained in the selected CAOMWebViewer12.war file, it will not be in the updated WAR file as well. 88 Installation Guide

89 Installation Using the GUI Wizard Step 3. Backup the Original CA OM Web Viewer The update installer backs up your original CA OM Web Viewer as a pair of WAR files (CAOMWebViewer12.war and the supplementary WAR file castylesr5.1.3.war). These files are placed into a folder specified in this panel. The backup step is recommended. However, if you do not need a backup by the update installer, select "No backup." Note: Make sure you have write permission to the backup folder. The update installer will also check whether this folder exists. If this folder does not exist, it will be created after installation starts. Appendix D: Updating CA Output Management Web Viewer Version 12 (or later) Using the Update Installer 89

90 Installation Using the GUI Wizard Step 4. Additional Copy of the Updated CA OM Web Viewer The update installer generates an additional copy of the updated CA OM Web Viewer in terms of a pair of WAR files (CAOMWebViewer12.war and the supplementary WAR file castylesr5.1.3.war) into a folder specified in this panel. The additional copy is a backup of the updated CA OM Web Viewer and might be useful in case the target being updated is locked by some other process. Note: Make sure you have write permission to the folder. The update installer also checks to see if this folder exists. If this folder does not exist, it is created after installation starts. 90 Installation Guide

91 Installation Using the GUI Wizard Step 5. Complete the Installation To complete the installation: 1. Review the settings displayed in the Pre-Installation Summary. 2. Click Install. 3. Review the Install Complete information. Appendix D: Updating CA Output Management Web Viewer Version 12 (or later) Using the Update Installer 91

92 Installation Using the Console Mode 4. Click Done. Installation Using the Console Mode The steps in this section explain how to install CA Output Management Web Viewer using the Console mode. Step 1. Introduction and License Agreements Follow these steps: 1. Choose a locale and press Enter to continue. 2. Review the following Introduction. ==================================================================== ======== Introduction InstallAnywhere will guide you through the installation of CA Output Management Web Viewer It is strongly recommended that you quit all programs before continuing with this installation. Respond to each prompt to proceed to the next step in the installation. If you want to change something on a previous step, type 'back'. You may cancel this installation at any time by typing 'quit'. PRESS <ENTER> TO CONTINUE: 3. Press Enter to continue. 4. Review the License Agreements. Because multiple products are licensed in this agreement, you must continue to press Enter until you reach the end of the license agreement. DO YOU ACCEPT THE TERMS OF THIS LICENSE AGREEMENT? (Y/N): 5. Enter Y to accept the license agreement. 92 Installation Guide

93 Installation Using the Console Mode Step 2. Select an Update Target According to the deployment method of your previous version of CA OM Web Viewer, select one option from the list: ======================================================================== ===== Select an Update Target Enter requested information 1- Update Web Viewer running on an Apache Tomcat server 2- Update a Web Viewer EAR file 3- Update Web Viewer WAR files ENTER THE NUMBER OF THE DESIRED CHOICE: Be aware of the following: If the current CA OM Web Viewer is deployed on an Apache Tomcat web server do the following: Select "Update Web Viewer running on an Apache Tomcat server" Enter the home folder of the Apache Tomcat server. This folder should contain a "bin" sub-folder and a "webapps" sub-folder; for example: "/usr/local/ca_om_web_viewer/apache-tomcat " ============================================================================= Update Web Viewer running on an Apache Tomcat server Enter the home folder of the Apache Tomcat server (DEFAULT: ): If you have a CA OM Web Viewer EAR file: Select "Update a Web Viewer EAR file" Specify the path of your EAR file CAOMWebViewer12.ear. ============================================================================= Update a Web Viewer EAR file Enter the full path of the Web Viewer EAR file (DEFAULT: ): Appendix D: Updating CA Output Management Web Viewer Version 12 (or later) Using the Update Installer 93

94 Installation Using the Console Mode You must re-deploy the EAR file after the update. If you produced CA OM Web Viewer WAR files in your previous installation: Select "Update Web Viewer WAR files" Specify the paths of your WAR files, including CAOMWebViewer12.war and the supplementary WAR file castylesr5.1.3.war. ============================================================================= Update Web Viewer WAR files Enter the full path of the Web Viewer WAR file (DEFAULT: ): Enter the full path of the CA Styles WAR file (DEFAULT: ): You must re-deploy these WAR files after the update. 94 Installation Guide

95 Installation Using the Console Mode Step 3. Backup the Original CA OM Web Viewer The update installer backs up your original CA OM Web Viewer as a pair of WAR files (CAOMWebViewer12.war and the supplementary WAR file castylesr5.1.3.war) into a folder specified in this step. The back up step is recommended. If you do not need a backup by the update installer, select "No backup." ============================================================================= Backup the Original CA OM Web Viewer Enter requested information ->1- Backup the original CA OM Web Viewer (Recommended) 2- No backup ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT:: =============================================================================== Backup the Original CA OM Web Viewer Enter the full path of a folder to place the backup (DEFAULT: ): Note: Make sure you have write permission to the back up folder. The update installer will also check whether this folder exists. If this folder does not exist, it will be created after installation starts. Appendix D: Updating CA Output Management Web Viewer Version 12 (or later) Using the Update Installer 95

96 Installation Using the Console Mode Step 4. Additional Copy of the Updated CA OM Web Viewer The update installer generates an additional copy of the updated CA OM Web Viewer in a pair of WAR files (CAOMWebViewer12.war and the supplementary WAR file castylesr5.1.3.war) which is placed into the folder specified in this step. The additional copy is a back up of the updated CA OM Web Viewer and might be useful in case the target being updated is locked by some other process. =============================================================================== Additional Copy of the Updated CA OM Web Viewer Specify a folder to store an additional copy of the updated CA OM Web Viewer Enter the full path of the folder (DEFAULT: ): Note: Be sure you have write permission to the folder. The update installer also checks to see if this folder exists. If this folder does not exist, it is created after installation starts. 96 Installation Guide

97 Installation Using the Console Mode Step 5. Complete the Installation Follow these steps to complete the installation: 1. Review the settings displayed in the Pre-Installation Summary. =========================================================================== Pre-Installation Summary Please Review the Following Before Continuing: Product Name: CA Output Management Web Viewer Target to Apply the Updates /usr/local/ca_om_web_viewer/apache-tomcat Backup Folder Not available Additional Output Folder /root/output PRESS <ENTER> TO CONTINUE: 2. Press Enter to continue. ======================================================================== Ready To Install InstallAnywhere is now ready to install CA Output Management Web Viewer onto your system. PRESS <ENTER> TO INSTALL: 3. Review the Install Complete information. 4. Press Enter to install. ============================================================================= Installation Complete Congratulations! CA Output Management Web Viewer has been successfully installed to: /usr/local/ca_om_web_viewer/apache-tomcat Appendix D: Updating CA Output Management Web Viewer Version 12 (or later) Using the Update Installer 97

98 Installation Using the Console Mode Backup Folder: Not available Additional Output Folder: /root/output PRESS <ENTER> TO EXIT THE INSTALLER: 98 Installation Guide

99 Appendix E: Sample JCL for Running a Bundled Tomcat Server as a Mainframe Started Task If you are using the bundled Apache Tomcat server in the USS environment, be aware that the Apache Tomcat server can be alternatively run as a mainframe started task. This appendix presents three examples that show the JCL that is required to load an Apache Tomcat server using JZOS. Note: The program JVMLDM##, ## is a number that corresponds to the version of your Java program. The JCL examples are TOMCAT01, JZVM01, and PARM01. JZVM01 defines a procedure to execute JVMLDM60. TOMCAT01 loads this procedure in JZVM01 to start up Tomcat using the parameters defined in PARM01. PARM01 defines the required parameters. Follow these steps: 1. Be sure to make all the necessary adjustments according to your environment. 2. Submit the JCL TOMCAT01 to start the Apache Tomcat server. This section contains the following topics: JCL Examples (see page 100) Appendix E: Sample JCL for Running a Bundled Tomcat Server as a Mainframe Started Task 99

100 JCL Examples JCL Examples In the examples that follow, the JCL members are located in the data set USSUTIL.JCL. USSUTIL.JCL(TOMCAT01) //[-----JOBCARD-----] //* //JZVMLIB JCLLIB ORDER=USSUTIL.JCL //TOMCAT01 EXEC PROC=JZVM01,VERSION='60', // JAVACLS='org.apache.catalina.startup.Bootstrap', // ARGS='start',LEPARM='TERMTHDACT(UADUMP)' //STDENV DD DISP=SHR,DSN=CHEPO03.USSUTIL.JCL(PARM01) Be sure to include a job card. Change USSUTIL.JCL to the name of the data set where these JCL items are located. 60 is the number that corresponds to your Java program version. In this example, we use Java 6.0; execute the program JVMLDM60 to load the Apache Tomcat server. 100 Installation Guide

101 JCL Examples USSUTIL.JCL(JZVM01) //JZVM01 PROC JAVACLS=, < Fully Qfied Java class..rqd // ARGS=, < Args to Java class // VERSION='60', < Version of JZOSVM module // LOGLVL='+I', < Debug LVL: +I(info) +T(trc) // REGSIZE='0M', < EXECUTION REGION SIZE // LEPARM='' //JAVAJVM EXEC PGM=JVMLDM&VERSION,REGION=&REGSIZE, // PARM='&LEPARM/&LOGLVL &JAVACLS &ARGS' //SYSPRINT DD SYSOUT=* < System stdout //SYSOUT DD SYSOUT=* < System stderr //STDMSG DD SYSOUT=* < Rerouted stderr //STDOUT DD SYSOUT=* < Java System.out //STDERR DD SYSOUT=* < Java System.err //CEEDUMP DD SYSOUT=* //SYSUDUMP DD SYSOUT=4 //ABNLIGNR DD DUMMY //CADVSTOP DD DUMMY < Turn off CA-SYMDUMP processing // PEND USSUTIL.JCL(PARM01BK) # This is a shell script which configures # any environment variables for the Java JVM. # Variables must be exported to be seen by the launcher. export JAVA_HOME=/sys/java31bt/v6r0m1/usr/lpp/java/J6.0.1 TOMCAT_HOME=/CA_OM_Web_Viewer/apache-tomcat Appendix E: Sample JCL for Running a Bundled Tomcat Server as a Mainframe Started Task 101

102 JCL Examples LIBPATH=/lib:/usr/lib:"${JAVA_HOME}"/bin LIBPATH="$LIBPATH":"${JAVA_HOME}"/bin/classic LIBPATH="$LIBPATH":"${TOMCAT_HOME}"/lib export LIBPATH="$LIBPATH": CLASSPATH="${JAVA_HOME}/lib/tools.jar" CLASSPATH="$CLASSPATH":"${JAVA_HOME}/lib/security.jar" CLASSPATH="$CLASSPATH":"${TOMCAT_HOME}/bin/bootstrap.jar" CLASSPATH="$CLASSPATH":"${TOMCAT_HOME}"/lib export CLASSPATH="$CLASSPATH": # Configure JVM options IJO="-Xms256m -Xmx512m" IJO="$IJO -Dibm.serversocket.recover=true" IJO="$IJO -Dsun.lang.ClassLoader.allowArraySyntax=true" IJO="$IJO -Dfile.encoding=ISO8859-1" IJO="$IJO -Dcatalina.base=${TOMCAT_HOME}" IJO="$IJO -Dcatalina.home=${TOMCAT_HOME}" IJO="$IJO -Djava.io.tmpdir=${TOMCAT_HOME}/temp" IJO="$IJO -Dactivate.saf.manager=false" export IBM_JAVA_OPTIONS="$IJO " 102 Installation Guide

103 JCL Examples export JAVA_DUMP_HEAP=false export JAVA_PROPAGATE=NO export IBM_JAVA_ZOS_TDUMP=NO Be aware of the following: Modify /sys/java31bt/v6r0m1/usr/lpp/java/j6.0.1 to point to the directory where your JZOS is installed. CA_OM_Web_Viewer/apache-tomcat is the directory where the Apache Tomcat server is installed. 512m is the maximum memory usage that is allowed for the Apache Tomcat server. Appendix E: Sample JCL for Running a Bundled Tomcat Server as a Mainframe Started Task 103

104

105 Appendix F: Acknowledgments The following license agreements are available in the \Bookshelf Files\TPSA folder in the CA Bookshelf: Commons Pool Commons Codec Commons Collections Derby EclipseLink IBM DB2 Driver for JDBC and SQLJ JAXB JDBC Oracle JDBC Driver 10g JDBC Oracle JDBC driver 11g Log4j Novell JLDAP Quartz Sun JRE 1.6.0_26 Tomcat Appendix F: Acknowledgments 105

106

107 Index A Acknowledgments 105 Acquiring the Product Installer 25 Additional Tasks 79 AIX Environment 28, 83 Audience 9 C CA Deliver Users 15 CA Distributed Repository Access System (CA DRAS) Considerations 16 CA OM Web Viewer and WebSphere 58 CA Technologies Product References 3 CCI and DRAS Servers 15 Change the Java Runtime Environment 57 Configure the Java Web application server 58 Configuring CA Output Management Web Viewer 65 Contact CA Technologies 3 Conventions Used 9 D Database Prerequisites 17 Default Administrator ID Based on a Mainframe User Account 15 Disk and Memory Space Requirement 12 E Embedded Database 17 Enter the CCI Server Information 76 Enter the SQL Server Information 75 Environment and Supported Operating Systems 81 Environment Considerations 57 Environment Variables 13 Export the Database 74 Export Using the Console 74 External Database 18 F FAQs 61 Frequently Asked Questions 61 H How Much Memory is Required? 13 HP-UX Environment 28, 83 I Import the Database 78 Installation Considerations 27 Installation Modes 29, 85 Installation Scenarios 19 Installation Using the Console Mode 45, 92 Installation Using the GUI Wizard 30, 85 Installing the Product 27 J Java Web Application Server 12, 81 JCL Examples 100 JVM (Java Virtual Machine) Version 12, 82 L LDAP for User Authentication 12 Linux Environment 29, 84 Load Balancing 17 M Mac OS X Environment 84 Memory Settings and Hardware Requirements 13 Mode of Installation, GUI or Console 19 More Information 10 O One CA OM Web Viewer with Multiple CA DRAS Started Tasks 24 Overview 9 Overview of Installation and Configuration Steps 27 P Parameter Required for Java Pre-Installation Tasks 82 Preparing for Installation 11 Prerequisites 11, 81 Index 107

108 R Review the Options and Complete the Export 76 S Sample JCL for Running a Bundled Tomcat Server as a Mainframe Started Task 99 Scalability Scenarios 23 Scenario 1 - One Java Web Application Server with an Embedded Database on One Machine 20 Scenario 2 - One Java Web Application Server and an External Database on the Same Machine. 20 Scenario 3 - Java Web Server and the External Database Server Are on Different Machines 21 Scenario 4 - Multiple Java Web Servers 22 Scenario 5 - Load Balancing using Apache Web Server with Tomcat Servers 23 Select the Database 75 Shut Down CA OM Web Viewer 60 Solaris Environment 29, 84 Specify the Output Folder 76 Start a CA Output Management Web Viewer Installer 27 Start CA OM Web Viewer 59 Start or Shut Down CA OM Web Viewer 59 Start the CA Output Management Web Viewer Update Installer 83 Step 1. Introduction and License Agreements 30, 46, 86, 92 Step 2. Select an Update Target 87, 93 Step 2. Supply the Installation Information 31, 46 Step 3. Backup the Original CA OM Web Viewer 89, 95 Step 3. Choose your Java Virtual Machine 32 Step 3. Choose Your Java Virtual Machine 47 Step 4. Additional Copy of the Updated CA OM Web Viewer 90, 96 Step 4. Choose a Deployment Method 47 Step 4. Deployment Method 33 Step 5. Complete the Installation 91, 97 Step 5. Supply CCI Server and DRAS Server Information 36, 48 Step 6. Connect to a Database 37, 49 Step 7. Indicate LDAP User Authentication 41, 52 Step 8. Complete the Installation 43, 54 Supported Configuration Settings 73 Supported Operating Systems 11 T The Purpose of This Guide 9 U Uninstalling CA Output Management Web Viewer 71 Update an Existing CA OM Web Viewer, Version 12 or Later 82 Updating CA Output Management Web Viewer Version 12 (or later) Using the Update Installer 81 Upgrading from a Previous Release 73 Use a Web Browser 25 Use the CD 26 USS Environment 28, 83 W Where Are the Memory Settings and How Are They Changed? 14 Windows Environment 28, 83 Z z/linux Environment 29, Installation Guide