View Install ENU
View Install ENU
Installation Guide
Version 12.0
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 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or
their successors.
Copyright © 2012 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to
their respective companies.
CA Technologies Product References
This document references the following CA Technologies products:
■ CA 1®
■ CA ACF2™
■ CA Balancing™
■ CA Common Services
■ CA Connect™
■ CA Deliver™
■ CA DRAS™
■ CA Easytrieve® Report Generator
■ CA Mainframe Software Manager (CA MSM)
■ CA Output Management Web Viewer
■ CA Output Management Document Viewer
■ CA Roscoe®
■ CA Spool™
■ CA TLC (CA Total License Care)
■ CA Top Secret® for z/OS
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 http://ca.com/support, 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
Contents 5
Concurrent Release Considerations .................................................................................................................... 32
Relationship between Versions of CA View and CA Deliver ................................................................................ 33
6 Installation Guide
External HOLDDATA ............................................................................................................................................ 72
Contents 7
Step 16: (Optional) Install Optional Features .................................................................................................... 114
Step 17: (Optional) Download the EMC Centera API for CA View .................................................................... 114
Step 18: Add the Archival Task Start Procedure ............................................................................................... 114
Step 19: Use SARINIT to Set the Final Initialization Parameter Values ............................................................. 116
Step 20. (Optional) Customize and Configure CA DRAS .................................................................................... 117
Post-Installation Considerations .............................................................................................................................. 117
8 Installation Guide
TSO, ISPF, CA Roscoe and Cross-Memory Address Spaces ............................................................................... 222
Multiple Cross-Memory Region Requirements ................................................................................................. 222
Prepare to Start the Cross Memory Task .......................................................................................................... 223
Start the Cross Memory Task ............................................................................................................................ 223
Contents 9
Appendix A: Installation Worksheets 261
Data Set Qualifiers and SMP Parameters ................................................................................................................. 261
Initialization Parameter Worksheet ......................................................................................................................... 262
Expanded Retention Option (ERO) Initialization Parameters ................................................................................... 266
Archival Started Task Worksheet ............................................................................................................................. 267
Accounting Data ................................................................................................................................................ 267
Create Backup Report ....................................................................................................................................... 267
Create Optical Migration Report ....................................................................................................................... 267
Tracking Backup Tapes (Highly Recommended) ............................................................................................... 268
Exceptional Condition Checking Control Statements ....................................................................................... 268
Expanded Retention Option (ERO) Control Statements ................................................................................... 268
Index 275
10 Installation Guide
Chapter 1: Overview
This guide describes how to install and implement CA View.
Audience
This guide is targeted to the systems programmer who will install, use, and maintain CA
View.
This guide assumes you are familiar with CA View and IBM computer system terms and
concepts. You should also have a working knowledge of MVS online facilities such as
ISPF, since the CA View panels behave in a similar fashion.
Chapter 1: Overview 11
How the Installation Process Works
Note: If you do not have CA MSM, you can download it from the Download Center at
the CA Support Online website. Follow the installation instructions in the CA Mainframe
Software Manager documentation bookshelf on the CA Mainframe Software Manager
product page. The standardized installation process can also be completed manually.
12 Installation Guide
How the Installation Process Works
Chapter 1: Overview 13
How the Installation Process Works
Installation Considerations
Before installation, you must prepare your system, assemble your materials, and then
follow the installation steps exactly and in order. Use the following list as a guide for the
installation process.
1. Verify that CA Common Services are installed on your system, and that the required
hardware, software, and libraries are prepared.
– CA View uses the CAI Resource Initialization Manager CAIRIM portion of the CA
Common Services.
– CAIRIM prepares the operating system for CA products and components, and
then executes them.
– CA DRAS requires the CAIENF (Event Notification Facility) and the CAICCI
(Common Communications Interface) components of the CA Common Services.
Note: For more information about system requirements, see the chapter "System
Requirements".
2. Install CA View using one of the four installation methods -- CA MSM, PAX Enhanced
ESD, DVD, or from a product tape.
3. Use options and initialization parameters to customize the solution according to the
needs of your site, as follows:
■ Configure your CA View system.
■ Install the online interfaces including the cross-memory and online retrieval
options for ISPF, TSO, VTAM, CA Roscoe Interactive Environment (CA Roscoe),
CICS and IMS.
Note: For more information about installing online interfaces, see the chapter
"Installing Online Interfaces."
■ Install the features including:
■ ERO, the VTAM print option
■ The CA Spool interface option
■ The CA View ACIF interface, the CA View Proprietary Print Stream (PPS)
Viewing Option for Xerox interface
■ CA GSS, the Global Subsystem interface
■ FSS, the Functional Subsystem Collector.
Note: See the chapter "Installing Features" for more information.
4. Optionally, configure and customize CA DRAS. For more information, see the CA
DRAS Operations Guide.
14 Installation Guide
First Time Installation or Upgrade
Important! Although much of the JCL is similar to the previous release, you must use the
new version because the naming conventions have changed and new files have been
introduced. Be sure to retain your previous CA View JCL files and load libraries
Chapter 1: Overview 15
Chapter 2: Preparing for Installation
This section describes what you need to know and do before you install the product.
Hardware Requirements
This section describes the hardware and libraries that are required for CA View and CA
DRAS.
Notes:
■ Because CA View uses a clear key, it does not require the use of the Cryptographic
Express2 coprocessor (CEX2C).
■ To run ICSF without a CEX2C coprocessor, you will need ICFS release FMID
HCR7751or higher.
■ If you are running an older release of ICSF, you must purchase a CEX2C coprocessor
because older releases of ICSF required that specific hardware to initialize the CKDS
data set.
18 Installation Guide
Hardware Requirements
Important! Do not reblock the libraries listed above; storage problems could occur.
20 Installation Guide
Software Requirements
Software Requirements
This software is required for CA View:
■ IBM Supported release of z/OS r1.9 or higher
■ SMP/E
The next sections list the Version 12.0 component SYSMODs for CA View and CA DRAS.
Note: The optional EBC CICS FMID has been incorporated into the EBC common
component FMID beginning with Release r11.6.
Note: The CA View/CA Spool API and foreign language FMID's have been incorporated
into the CA View base FMID.
Note: If you intend to use CA MSM for your installation and maintenance tasks, there
might be certain additional CA Common Service requirements. For more information,
see the Software Requirements section in the CA Mainframe Software Manager Product
Guide.
Note: If other CA products are installed at your site, some of these services may already
be installed.
22 Installation Guide
CA Common Services Requirements
CAIRIM
CAIRIM (CAI Resource Initialization Manager) is the common driver for a collection of
dynamic initialization routines. These initialization routines eliminate the need for user
SVCs, SMF exits, subsystems, and other installation requirements that you might
commonly encounter when you install systems software
CAIRIM prepares the operating system for CA products and components, and then
executes them.
CA LMP
The CA License Management Program (CA LMP) is a standardized automated approach
to the tracking of licensed software that uses common real time enforcement software
to validate the user's configuration. CA LMP reports on activities related to the license,
usage, and financial activity of program solutions. CA LMP features include:
■ A common key data set that can be shared among many CPUs
■ The use of "check digits" to detect errors in transcribing key information
■ Execution keys that can be entered without affecting any CA software solution
already running
■ No special maintenance requirements
CA Common Services for z/OS must be installed or maintained at the genlevel indicated
on the cover letter for the product
CAIENF
CAICCI
Full support for all forms of distributed processing provides the highest degree of
flexibility for the enterprise.
CA DRAS uses the CAICCI service to provide communication between client applications
and the servers. CAICCI is a facility that allows CA products to communicate with other
applications in a simple, straightforward manner.
CAICCI builds a layer on top of today's communication and network software so that an
application can be isolated from the specifics of its environment.
CAICCI provides robust TCP/IP support, and this protocol can be used to efficiently
connect a wide variety of platforms and applications. Mainframes, PCs, and UNIX
systems can all be inter-connected, using TCP/IP.
24 Installation Guide
CA Common Services Requirements
CA View links to the CA Health Checker Common Service product to provide a standard
access to the operating system's health checker services. The CA Health Checker
Common Service runs under the IBM Health Checker for z/OS.
Note: To successfully register CA checks, the IBM Health Checker must be active. For
more information about the IBM Health Checker, see the IBM Health Checker for z/OS
User's Guide – as appropriate for your release of z/OS.
26 Installation Guide
CA DRAS Is Included with CA View
Security Requirements
For information about the security requirements that are related to the ability to access
a CA View database, or reports and data within the CA View database, see the "Security"
chapter in the CA View Reference Guide.
28 Installation Guide
Storage Requirements
■ All CA View started tasks, batch jobs, utilities, and online users that access report
data in a CA View database require at a minimum READ access to the ICSF keys.
The following started tasks, batch jobs, utilities, and online users require WRITE access
to ICSF keys:
■ Archival started tasks which includes the CA View started task, CA View FSS Archival
tasks, and any application job where data will be written directly to the CA View
database
■ Batch jobs that execute SARINIT
■ Batch jobs that execute SARDBASE to COPY, LOAD, MERGE, or RESTORE a CA View
database
■ Batch jobs that execute SARBCH to LOAD a report or report index to a CA View
database
■ Batch jobs that execute SARBCH to reindex a report in a CA View database
■ Online users that are able to perform an online LOAD of a report or a report index
to a CA View database
Storage Requirements
Be sure that the following storage is available:
■ If you are installing with ESD, 100 cylinders for the downloaded files.
■ For installation and setup:
– Installation = 200 cylinders
■ SMP/E temporary libraries = 20 cylinders
Other Requirements
These sections explain additional requirements.
Verify that the data sets are allocated with at least 100 cylinders.
The CA View SDUMP program supports MVS/ESA dump analysis and elimination
processing. This MVS/ESA feature eliminates the possibility of duplicate SVC dumps
being written to the SYS1.DUMP.nn. data sets.
To use this feature, the SYS1.DAE data set must be allocated and the following
parameter members must be updated in SYS1.PARMLIB:
IEACMDxx
SET DAE = xx
ADYSETxx
DAE=START,RECORDS(sss),SVCDUMP(MATCH,UPDATE,SUPPRESS
For this storage area to be dumped correctly, the IEADMRxx. member in SYS1.PARMLIB
should contain the SDATA RGN parameter:
SDATA=(...,RGN,...)
The IEADMPxx. member in SYS1.PARMLIB should contain the SDATA LSQA parameter:
SDATA=(...,LSQA,...)
Important! If these dump parameters are not specified as shown in the previous
example, certain storage areas could be missing from dumps, which can hinder support
efforts.
JCL Procedures
During the installation of the product, CA View procedures are copied into CVDEPROC,
the CA View Procedure Library. These procedures are used later during normal
execution of the product.
We recommend that you add the CVDEPROC library to the system PROCLIB
concatenation.
30 Installation Guide
Concurrent Releases
Concurrent Releases
You can install this release of CA View and continue to use an older release in another
SMP/E CSI environment. If you plan to continue to run a previous release, consider the
following points:
■ When installing into an existing SMP/E environment, this installation deletes
previous releases in that environment.
■ If you acquired your product from tape or with Pax-Enhanced ESD, select different
target and distribution zones for your new release from where your current release
is installed. The new zones use different libraries than your current release.
Note: CA MSM installs into a new CSI by default.
■ Define DDDEF entries in your new zones to point SMP/E to the proper libraries for
installation. Ensure that they point to the new release libraries.
If you are upgrading in an SMP/E CSI that contains a different version or release of
Deliver, you must define new SMP/E target and distribution zones for CA View Version
12.0. CA View Version 12.0 cannot be installed into an SMP/E zone that contains a prior
release of CA Deliver. However, CA View Version 12.0 can share an SMP/E zone with CA
Deliver Version 12.0.
The diagram that follows shows the relationship between multiple versions of CA View
and CA Deliver.
32 Installation Guide
Concurrent Releases
Before using these topics, you must already have CA MSM installed at your site. If you
do not have CA MSM installed, you can download it from the Download Center at the
CA Support Online website, which also contains links to the complete documentation for
CA MSM.
Note: The information in this section applies to the latest version of CA MSM. If you are
using an earlier version, see the appropriate bookshelf on the CA Mainframe Software
Manager product page.
You can use the following scenarios to guide you through the process:
1. Acquire the new product (see page 35).
2. Install the new product (see page 36).
3. Maintain products already installed in your environment (see page 37).
4. Deploy the product to your target systems (see page 38).
5. Configure the deployed product to your target systems (see page 39).
You can use the PAS component of CA MSM to acquire a CA Technologies product.
After the acquisition process completes, the product is ready for you to install or
maintain.
You can use the SIS component of CA MSM to install a CA Technologies product.
36 Installation Guide
How to Use CA MSM: Scenarios
After the installation process completes, check for and install available product
maintenance. The product is ready for you to deploy. Sometimes there are other steps
to perform manually outside of CA MSM before beginning the deployment process.
You can use the PAS and SIS to maintain a CA Technologies product.
Note: You can also install maintenance to a particular CSI from the SMP/E Environments
tab.
After the maintenance process completes, the product is ready for you to deploy. You
may have to perform other steps manually outside of CA MSM before beginning the
deployment process.
You can use the SDS component of CA MSM to deploy a CA Technologies product that
you have already acquired and installed.
After the deployment process completes, the product is ready for you to configure. You
may have to perform other steps manually outside of CA MSM before beginning the
configuration process.
38 Installation Guide
How to Use CA MSM: Scenarios
You can use the SCS component of CA MSM to configure a CA Technologies product that
you have already acquired, installed, and deployed.
After the configuration process completes, the product is ready for you to use. You may
have to perform other steps manually outside of CA MSM.
More information:
Important! If your site uses proxies, review your proxy credentials on the User Settings,
Software Acquisition page.
40 Installation Guide
Chapter 4: Installing Your Product from
Pax-Enhanced ESD
This section contains the following topics:
How to Install a Product Using Pax-Enhanced ESD (see page 41)
Allocate and Mount a File System (see page 47)
Copy the Product Pax Files into Your USS Directory (see page 50)
Create a Product Directory from the Pax File (see page 55)
Copy Installation Files to z/OS Data Sets (see page 56)
Receive the SMP/E Package (see page 57)
Clean Up the USS Directory (see page 60)
Apply Maintenance (see page 61)
Important! Downloading pax files for the SMP/E installation as part of the Pax-Enhanced
ESD process requires write authority to the UNIX System Services (USS) directories used
for the ESD process.
If you prefer not to involve all CA Technologies product installers with z/OS UNIX System
Services, assign a group familiar with USS to perform Steps 1 through 4 and provide the
list of the unpacked MVS data sets to the product installer. USS is not required for the
actual SMP/E RECEIVE of the product or for any of the remaining installation steps.
2. Copy the product pax files into your USS directory. To download files, choose one of
the following options:
■ Download a zip file from CA Support Online to your PC, unzip the file, and then
upload the product pax files to your USS file system.
■ FTP the pax files from CA Support Online directly to your USS directory.
Note: Perform Steps 3 through 6 for each pax file that you upload to your USS
directory.
3. Create a product directory from the pax file. Set the current working directory to
the directory containing the pax file, and create a new directory in your USS
directory by entering the following command:
pax -rvf pax-filename
4. Use the SMP/E GIMUNZIP utility to create z/OS installation data sets. The file
UNZIPJCL in the directory created by the pax command in Step 3 contains a sample
job to GIMUNZIP the installation package. Edit and submit the UNZIPJCL job.
5. Receive the SMP/E package. For this step, use the data sets created by GIMUNZIP in
Step 4. Perform a standard SMP/E RECEIVE using the SMPPTFIN and SMPHOLD (if
applicable) DASD data sets. Also, specify the high-level qualifier for the RELFILEs on
the RFPREFIX parameter of the RECEIVE command.
6. Proceed with product installation. Consult product-specific documentation,
including AREADME files and installation notes to complete the product installation.
7. (Optional) Clean up the USS directory. Delete the pax file, the directory created by
the pax command, all of the files in it, and the SMP/E RELFILEs, SMPMCS, and
HOLDDATA data sets.
More Information:
42 Installation Guide
How to Install a Product Using Pax-Enhanced ESD
The following illustration shows sample product files. It lists all components of the
product. You can use the Download Cart by checking one or more components that you
need or check the box for Add All to cart. If you prefer to immediately download a
component, click the Download link.
44 Installation Guide
How to Install a Product Using Pax-Enhanced ESD
Clicking the link for an individual component takes you to the Download Method page.
Depending on the size and quantity of product files ordered, the Download Method
screen could also have these options:
Note: For mainframe downloads using this HTTP method, click the Learn More link.
The HTTP method lets you start downloading immediately. The FTP method takes you to
the Review Orders page that displays your order, first in a Pending status changing to
Ready when your order has been processed.
Preferred FTP uses the new content delivery network (CDN). Alternate FTP uses the CA
Technologies New York-based FTP servers.
The Create a Zip File option first creates the zip, and when ready, offers the options
shown by the Zip Download Request examples in the next screen.
46 Installation Guide
Allocate and Mount a File System
We recommend that you allocate and mount a file system dedicated to Pax-Enhanced
ESD. The amount of space that you need for the file system depends on the following
variables:
■ The size of the pax files that you intend to download.
■ Whether you plan to keep the pax files after unpacking them. We do not
recommend this practice.
We recommend that you use one directory for downloading and unpacking pax files.
Reusing the same directory minimizes USS setup. You need to complete the USS setup
only one time. You reuse the same directory for subsequent downloads. Alternatively,
you can create a new directory for each pax download.
Important! Downloading pax files for the SMP/E installation as part of the Pax-Enhanced
ESD process requires write authority to the UNIX System Services (USS) directories used
for the ESD process. In the file system that contains the ESD directories, you also need
free space approximately 3.5 times the pax file size to download the pax file and unpack
its contents. For example, to download and unpack a 14 MB pax file, you need
approximately 49 MB of free space in the file system hosting your ESD directory.
48 Installation Guide
Allocate and Mount a File System
2. Create a mount point for the file system. This example shows how to create a
/CA/CAESD directory in an existing directory, /u/maint. From the TSO OMVS shell,
enter the following commands:
cd /u/maint/
mkdir CA
cd CA
mkdir CAESD
This section includes a sample batch job to download a product pax file from the CA
Support Online FTP server directly to a USS directory on your z/OS system and sample
commands to upload a pax file from your PC to a USS directory on your z/OS system.
Important! The FTP procedures vary due to local firewall and other security settings.
Consult your local network administrators to determine the appropriate FTP procedure
to use at your site.
Ensure that sufficient free space is available in the USS file system you are using for
Pax-Enhanced ESD to hold the product pax file. If you do not have sufficient free space,
error messages similar to the following appear:
When the download finishes, the pax file size in your USS directory matches the value in
the Size column for the corresponding pax file on the CA Technologies Products
Download window.
More Information:
50 Installation Guide
Copy the Product Pax Files into Your USS Directory
Important! To simplify the Pax-Enhanced ESD process, the PDF version of this guide
includes a sample JCL job that you can copy directly to the mainframe. To access this
job, click the paper clip icon at the left of the PDF reader. A window displaying
attachments opens. Double-click the file to view the sample JCL.
52 Installation Guide
Copy the Product Pax Files into Your USS Directory
This list is a sample of FTP commands to upload the pax file from your PC to your USS
Pax-Enhanced ESD directory:
ftp mainframe
userid
password
bin
lcd C:\PC\folder\for\thePAXfile
cd /yourUSSESDdirectory/
put paxfile.pax.Z
quit
exit
54 Installation Guide
Create a Product Directory from the Pax File
Important! To simplify the Pax-Enhanced ESD process, the PDF version of this guide
includes a sample JCL job that you can copy directly to the mainframe. To access this
job, click the paper clip icon at the left of the PDF reader. A window displaying
attachments opens. Double-click the file to view the sample JCL.
Note: If the PARM= statement exceeds 71 characters, uncomment and use the second
form of UNPAXDIR instead. This sample job uses an X in column 72 to continue the
PARM= parameters to a second line.
56 Installation Guide
Receive the SMP/E Package
3. Change the SMPDIR DD PATH to the product-specific directory created by the pax
command.
Your view is of the product-specific directory.
4. If ICSF is not active, perform the following steps:
a. Change the SMPJHOME DD PATH to your Java runtime directory. This directory
varies from system to system.
b. Perform one of the following steps:
■ Change the SMPCPATH DD PATH to your SMP/E Java application classes
directory, typically /usr/lpp/smp/classes/.
■ Change HASH=YES to HASH=NO on the GIMUNZIP parameter.
One of the following occurs: ICSF is active or you are using Java.
5. Change all occurrences of yourHLQ to the high-level qualifier (HLQ) for z/OS data
sets used by the installation process. We suggest that you use a unique HLQ for
each expanded pax file to identify uniquely the package. Do not use the same value
for yourHLQ as you use for the SMP/E RELFILEs.
All occurrences of yourHLQ are set to your high-level qualifier for z/OS data sets.
6. Submit the UNZIPJCL job.
The UNZIPJCL job completes with a zero return code. Messages GIM69158I and
GIM48101I in the output and IKJ56228I in the JES log are acceptable.
GIMUNZIP creates z/OS data sets with the high-level qualifier you specified in the
UNZIPJCL job. You use these data sets to perform the product installation. The pax
file and product-specific directory are no longer needed.
Note: For more information, see the IBM reference guide, SMP/E for z/OS
Reference (SA22-7772).
Complete the SMP/E RECEIVE using files on DASD that the UNZIPJCL job created. Consult
the product sample JCL library that contains a sample job customized to receive the
product from DASD. Specifically, you specify the following values:
■ DASD data set names for SMPPTFIN and SMPHOLD (if applicable)
■ The HLQ that you used in the UNZIPJCL job on the RFPREFIX parameter on the
RECEIVE command
For information about the members, see the comments in the JCL.
58 Installation Guide
Receive the SMP/E Package
4. Open the SAMPJCL member BRM2CSI in an edit session and execute the BRMSEDIT
macro from the command line.
BRM2CSI is customized.
Note: When upgrading into an existing CSI, comment out any allocation DD
statements for existing files and delete the CREATCSI step. Change all ADD’s to
REP’s.
5. Submit BRM2CSI.
This job produces the following results:
■ The CSI data set is defined.
■ The SMPPTS and SMPLOG data sets are allocated.
■ The global, target, and distribution zones are initialized.
■ The DDDEF entries for your product are created.
■ The DDDEFs for the required SMP/E data sets are created.
5. Open the SAMPJCL member BRM5ACC in an edit session and execute the BRMSEDIT
macro from the command line.
BRM5ACC is customized.
6. Submit the yourhlq.SAMPJCL member BRM5ACC to accept SMP/E base functions.
Your product is accepted and now resides in the distribution libraries.
To free file system disk space for subsequent downloads after downloading and
processing the pax files for your CA Technologies product, we recommend removing the
files from your USS directory and deleting unnecessary MVS data sets. You can delete
the following items:
■ Pax file
■ Product-specific directory created by the pax command and all of the files in it
■ SMP/E RELFILEs, SMPMCS, and HOLDDATA MVS data sets
These data sets have the HLQ that you assigned in the UNZIPJCL job.
60 Installation Guide
Apply Maintenance
paxfile
Specifies the name of the CA Technologies pax file that you downloaded.
The pax file is deleted.
3. Delete the product-specific directory by entering the following command:
rm -r product-specific-directory
product-specific-directory
Specifies the product-specific directory created by the pax command.
The product-specific directory is deleted.
Note: You can also use TSO ISHELL to navigate to the pax file and product-specific
directory, and delete them using the D line command.
Apply Maintenance
CA Support Online has maintenance and HOLDDATA published since the installation
data was created. After the maintenance process completes, the product is ready to
deploy.
HOLDDATA
When you apply maintenance, you typically encounter SMP/E HOLDDATA. We use
HOLDDATA to notify your SMP/E system of SYSMODs that have errors or special
conditions. We support system and external HOLDDATA.
System HOLDDATA
System HOLDDATA indicates data that is an in-stream part of the SYSMOD, informing
you of special conditions. The following reasons are used with SYSTEM HOLDDATA for
CA View:
ACTION
Indicates that you must perform special processing before or after you apply this
SYSMOD.
AO
Affects automated operations. It changes either the message identifier or the
displacement of a field inside the message.
DB2BIND
Indicates that DBRMs have changed and packages need to be rebound.
62 Installation Guide
Apply Maintenance
DDDEF
Indicates that data sets and DDDEFs are being added or modified.
DELETE
Deletes the SYSMOD load module. You cannot reverse this type of SYSMOD with
the SMP/E RESTORE command.
DEP
Indicates a dependency for this SYSMOD that you must externally verify.
DOC
Indicates a documentation change with this SYSMOD.
DYNACT
Describes the steps to dynamically activate this fix without performing an IPL.
EC
Indicates that this SYSMOD requires a hardware engineering change. An EC hold
SYSMOD usually does not affect the product unless the EC is present on the
hardware device.
ENH
Introduces a small programming enhancement. The hold contains the instructions
to implement the enhancement. If no action is needed to implement the
enhancement, give a summary of the enhancement.
EXIT
Indicates that changes delivered by this SYSMOD require reassembly of user exits.
EXRF
Indicates that the SYSMOD must be installed in both the Active and Alternate
Extended Recovery Facility Systems.
IPL
Indicates that an IPL is required for this SYSMOD to take effect. This is used only
when there is no alternative for dynamic activation.
MSGSKEL
Indicates that the SYSMOD contains internationalized message versions which must
be run through the message compiler for each language.
MULTSYS
Apply this SYSMOD to multiple systems for either pre-conditioning, coexistence, or
exploitation.
RESTART
Indicates that after applying this SYSMOD, the site must perform a special restart as
opposed to a routine restart.
SQLBIND
Indicates that a bind is required for a database system other than DB2.
SYSMOD
Indicates that some or all of the elements delivered by this SYSMOD are to be
downloaded to a workstation.
Code a bypass operand on your APPLY command to install SYSMODs that have internal
holds. Code the bypass operand only after you have performed the required action, or if
you are performing the action after the APPLY, if that is appropriate.
External HOLDDATA
External HOLDDATA is not part of the PTF. It resides in a separate file. It is commonly
used for SYSMODs that have been distributed and later are discovered to cause
problems.
Download the external HOLDDATA from CA Support to a DASD file, and allocate the file
to the SMPHOLD DD statement. To take care of the external HOLDDATA, receive it into
your SMP/E environment. SMP/E receives the HOLDDATA from CA-supplied jobs.
If a SYSMOD has an unresolved hold error, SMP/E does not install it unless you add a
bypass to your APPLY command. You can bypass an error hold in situations that are not
applicable to you. Error holds that are not applicable to you can include a problem that
happens only with a hardware device that you do not have or in a product feature that
you do not use.
When CA publishes a SYSMOD that resolves the hold, the resolving SYSMOD supersedes
the hold error. This action lets you apply the original SYSMOD in conjunction with the
fixing SYSMOD.
A special HOLDDATA class called ERREL exists. We have determined that the problem
fixed by the SYSMOD is more important than the one that it causes. We recommend
that you apply these SYSMODs.
The only manual task is running a REPORT ERRSYSMODS. This report identifies the
following:
■ Any held SYSMODs already applied to your system.
■ Any resolving SYSMODs that are in RECEIVE status.
64 Installation Guide
Chapter 5: Installing Your Product from
Tape
This section contains the following topics:
Unload the Sample JCL from Tape (see page 66)
How to Install Products Using Native SMP/E JCL (see page 67)
Apply Maintenance (see page 69)
Note: The sample JCL to install the product is also provided in the CAI.SAMPJCL library
on the distribution tape.
unitname
Specifies the tape unit to mount the tape.
nnnnnnn
Specifies the tape volume serial number.
yourHLQ
Specifies the data set prefix for the installation.
sysda
Specifies the DASD where you want to place the installation software.
The SAMPJCL data set is created and its contents are downloaded from the tape.
2. Continue with one of the following options:
■ If you already have set up the SMP/E environment, go to Run the Installation
Jobs for a Tape Installation.
■ If you have not set up the SMP/E environment, go to Prepare the SMP/E
Environment for Tape Installation.
66 Installation Guide
How to Install Products Using Native SMP/E JCL
For information about the members, see the comments in the JCL.
4. Open the SAMPJCL member BRM2CSI in an edit session and execute the BRMSEDIT
macro from the command line.
BRM2CSI is customized.
Note: When upgrading into an existing CSI, comment out any allocation DD
statements for existing files and delete the CREATCSI step. Change all ADD’s to
REP’s.
5. Submit BRM2CSI.
This job produces the following results:
■ The CSI data set is defined.
■ The SMPPTS and SMPLOG data sets are allocated.
■ The global, target, and distribution zones are initialized.
■ The DDDEF entries for your product are created.
■ The DDDEFs for the required SMP/E data sets are created.
68 Installation Guide
Apply Maintenance
5. Open the SAMPJCL member BRM5ACC in an edit session and execute the BRMSEDIT
macro from the command line.
BRM5ACC is customized.
6. Submit the yourhlq.SAMPJCL member BRM5ACC to accept SMP/E base functions.
Your product is accepted and now resides in the distribution libraries.
Apply Maintenance
CA Support Online has maintenance and HOLDDATA published since the installation
data was created. After the maintenance process completes, the product is ready to
deploy.
9. (Optional) Open the SAMPJCL member BRM8ACCP in an edit session and execute
the BRMSEDIT macro from the command line.
BRM8ACCP is customized.
10. (Optional) Submit yourHLQ.SAMPJCL member BRM8ACCP.
The PTFs are accepted.
Note: You do not have to submit the job at this time. You can accept the PTFs
according to your site policy.
HOLDDATA
When you apply maintenance, you typically encounter SMP/E HOLDDATA. We use
HOLDDATA to notify your SMP/E system of SYSMODs that have errors or special
conditions. We support system and external HOLDDATA.
System HOLDDATA
System HOLDDATA indicates data that is an in-stream part of the SYSMOD, informing
you of special conditions. The following reasons are used with SYSTEM HOLDDATA for
CA View:
ACTION
Indicates that you must perform special processing before or after you apply this
SYSMOD.
AO
Affects automated operations. It changes either the message identifier or the
displacement of a field inside the message.
DB2BIND
Indicates that DBRMs have changed and packages need to be rebound.
DDDEF
Indicates that data sets and DDDEFs are being added or modified.
SYSMOD
Indicates that some or all of the elements delivered by this SYSMOD are to be
downloaded to a workstation.
DELETE
Deletes the SYSMOD load module. You cannot reverse this type of SYSMOD with
the SMP/E RESTORE command.
70 Installation Guide
Apply Maintenance
DEP
Indicates a dependency for this SYSMOD that you must externally verify.
DOC
Indicates a documentation change with this SYSMOD.
DYNACT
Describes the steps to dynamically activate this fix without performing an IPL.
EC
Indicates that this SYSMOD requires a hardware engineering change. An EC hold
SYSMOD usually does not affect the product unless the EC is present on the
hardware device.
ENH
Introduces a small programming enhancement. The hold contains the instructions
to implement the enhancement. If no action is needed to implement the
enhancement, give a summary of the enhancement.
EXIT
Indicates that changes delivered by this SYSMOD require reassembly of user exits.
EXRF
Indicates that the SYSMOD must be installed in both the Active and Alternate
Extended Recovery Facility Systems.
IPL
Indicates that an IPL is required for this SYSMOD to take effect. This is used only
when there is no alternative for dynamic activation.
MSGSKEL
Indicates that the SYSMOD contains internationalized message versions which must
be run through the message compiler for each language.
MULTSYS
Apply this SYSMOD to multiple systems for either pre-conditioning, coexistence, or
exploitation.
RESTART
Indicates that after applying this SYSMOD, the site must perform a special restart as
opposed to a routine restart.
SQLBIND
Indicates that a bind is required for a database system other than DB2.
Code a bypass operand on your APPLY command to install SYSMODs that have internal
holds. Code the bypass operand only after you have performed the required action, or if
you are performing the action after the APPLY, if that is appropriate.
External HOLDDATA
External HOLDDATA is not part of the PTF. It resides in a separate file. It is commonly
used for SYSMODs that have been distributed and later are discovered to cause
problems.
Download the external HOLDDATA from CA Support to a DASD file, and allocate the file
to the SMPHOLD DD statement. To take care of the external HOLDDATA, receive it into
your SMP/E environment. SMP/E receives the HOLDDATA from CA-supplied jobs.
If a SYSMOD has an unresolved hold error, SMP/E does not install it unless you add a
bypass to your APPLY command. You can bypass an error hold in situations that are not
applicable to you. Error holds that are not applicable to you can include a problem that
happens only with a hardware device that you do not have or in a product feature that
you do not use.
When CA publishes a SYSMOD that resolves the hold, the resolving SYSMOD supersedes
the hold error. This action lets you apply the original SYSMOD in conjunction with the
fixing SYSMOD.
A special HOLDDATA class called ERREL exists. We have determined that the problem
fixed by the SYSMOD is more important than the one that it causes. We recommend
that you apply these SYSMODs.
The only manual task is running a REPORT ERRSYSMODS. This report identifies the
following:
■ Any held SYSMODs already applied to your system.
■ Any resolving SYSMODs that are in RECEIVE status.
72 Installation Guide
Chapter 6: Installing Your Product from
DVD
This section contains the following topics:
Overview (see page 73)
Introduction to Electronic Software Delivery (see page 76)
Pax-Enhanced ESD Procedures (see page 79)
References (see page 83)
Overview
Purpose
Welcome to the CA Electronic Software Delivery (ESD) program using the Pax-Enhanced
ESD process for SMP/E installations for z/OS systems. This guide provides the
information and steps that you need to copy your CA products from the CA products
DVD using the Pax-Enhanced ESD process.
Audience
We created this guide to explain the entire Pax-Enhanced ESD process for novice users.
Each chapter explicitly states the required steps. We strongly suggest that you read this
entire document and follow the procedures the first time you copy a product from a
DVD using the Pax-Enhanced ESD program.
The enhanced process lets you download software directly to your mainframe and
eliminates the need to download files to tape. We implemented the Pax-Enhanced ESD
process in response to customer requests.
When using the traditional ESD process, you upload the ESD file to the mainframe and
create a product installation tape using a utility program provided by CA.
The Pax-Enhanced ESD process eliminates the need for a tape and uses superior
compression technology that reduces file transfer times. This process uses a UNIX
portable archive interchange (pax) file. Standard z/OS utilities can read and expand the
file directly to your mainframe system.
#3: Why did CA choose to use and require customers to use UNIX System Services
(USS)?
To improve the CA product installation process for our customers. The following list
details some of the benefits of using the USS pax format to distribute software
packages:
■ Supports all z/OS data types including, VSAM, PDS, PDSE, HFS, and zFS.
■ Allows a large number of MVS data sets to be zipped into a single file that can be
received in a single download.
■ Can be un-packed using standard utilities that are available on every z/OS system.
No additional utilities or licensed products are required.
■ Supports the CA Mainframe Software Manager (MSM). CA MSM makes it faster and
easier to install all CA products from a browser-based user interface and eliminates
many of the complexities and software knowledge of SMP/E, JCL, and other utilities.
#4: Do I need to do anything differently as a result? Are there any new requirements
or any dependencies? Am I required to have an in-depth knowledge of UNIX System
Services (USS) to use the Pax-Enhanced ESD process?
A basic understanding of USS is sufficient if you understand UNIX and follow the steps in
this guide. The appendix in this guide lists and defines common USS commands. In
addition, the appendix lists IBM documents that provide detailed information about
USS.
#5: What can I expect when I transition to the Pax-Enhanced ESD process?
You may experience a slight learning curve the first time you use the enhanced process.
We recommend reading this guide in its entirety before using the Pax-Enhanced ESD
process.
74 Installation Guide
Overview
In addition, Pax-Enhanced ESD is one of the first deliverables based on our Mainframe
2.0 strategy, which is designed to simplify software installation and other system
administration functions on z/OS. We invite you to visit
http://www.ca.com/mainframe2 to learn more about Mainframe 2.0.
Yes. You can still order cartridge tapes. However, we strongly recommend using the
Pax-Enhanced ESD process because it is faster and more secure than the physical tape
delivery method.
#8: Are there software prerequisites for the Pax-Enhanced ESD process?
Yes. The Pax-Enhanced ESD process requires SMP/E 3.4 with IBM APAR IO07810 (or
higher). You can get the latest release of SMP/E from IBM at no charge.
The Pax-Enhanced ESD process does not require Java. If the Integrated Cryptographic
Services Facility (ICFS) is not active, the GIMUNZIP SMP/E utility requires Java 1.4 or
higher to generate an SHA-1 hash value.
No. You can use Pax Enhanced-ESD on any supported version of z/OS.
#11: How do I know that the files I'm working with are the most current?
Check the https://support.ca.com/ site. Log in and click Download Center. The product
files on this online site will always be the most up-to-date.
CA Product Documentation
After completing the procedures in this ESD guide, you are ready to begin the standard
installation procedure. To continue the installation process, see your CA product-specific
documentation.
Each CA product documentation set includes the latest technology available for online
viewing, keyword searching, book marking, and printing. Documentation sets reside in
one repository and are available at the CA Support Online web site. You can view and
download all CA product documentation from this central repository. The following
procedure details how to access product documentation.
The CA Electronic Software Delivery (ESD) process lets you download a product package
in a zip file or compressed individual product components from the CA Support Online
Download Center or from directories on your CA product DVD. This guide explains the
steps to copy pax files from a product DVD. To download pax files from support online,
go to the Download Center on https://support.ca.com/.
76 Installation Guide
Introduction to Electronic Software Delivery
The steps in this guide provide instructions for SMP/E CA product installation on z/OS
systems.
The pax (see page 78) format provides several advantages for ESD:
■ It supports virtually any file type or data set type, including those for products that
are based on new technology (for example, Java).
■ It supports combining a large number of data sets into a single file to receive in a
single download.
■ It can be unpacked using standard utilities that are available on every z/OS system.
Customers no longer have to install CA-proprietary utility programs or download
additional software to complete the installation process.
The Pax Enhanced ESD process is the foundation on which the CA Mainframe Software
Manager (MSM) was built. CA MSM can perform the required un-packing tasks.
Important! Most CA products have transitioned to the pax format and must be
processed using the Pax-Enhanced ESD process. A small number of products are still
packaged using the traditional ESD format or as legacy .AWS or .CDTAPE files. For
traditional installation downloads, see the Traditional ESD User Guide.
The DVD contains folders that include the pax files for the base product and a README
file.
See Check for the Latest Updates (see page 77) for currency information and the Pax
Command (see page 78) for an explanation about how this command works.
Important! The files provided for copy from the CA product DVD might not be the most
current.
Go to https://support.ca.com/, log in, and click Download Center. The files on this online
site will always have the most current product updates.
Important! If your package includes file types other than those types in the following
list, see the Traditional Electronic Software Delivery (ESD) Guide. To access this guide, go
to https://support.ca.com/, log in, and click Download Center. A link to the guide
appears under the Download Help heading.
If you download the product from a CA product DVD, you see one or more files with the
following file types:
Documentation Files:
readme_CA_VIEW_DVD.html or Readme.html
Lists a description of the files and instructions for accessing product installation
documentation. The actual file name may differ based on the product name.
Important! The product-specific directory may also contain an AREADME file that
describes the pax download and installation process for your CA product or
maintenance update. Read the AREADME file before running UNZIPJCL. If your directory
includes install notes, read them before continuing. Failure to read these files impacts
your installation.
Important! Ensure that you have sufficient free space in the USS file system that you are
using for Pax ESD to hold the directory created by the pax command and its contents.
You need approximately 3.5 times the pax file size in free space.
If you do not have sufficient free space, you receive EDC5133I error messages similar to
the following:
78 Installation Guide
Pax-Enhanced ESD Procedures
Important! Downloading pax files for the SMP/E installation as part of the Pax-Enhanced
ESD process requires write authority to the UNIX System Services (USS) directories used
for the ESD process.
Important! If you prefer not to involve all CA product installers with z/OS UNIX System
Services, assign a group familiar with USS to perform Steps 1 through 3 and provide the
list of the unpacked MVS data sets to the product installer. Be aware that some
products may require USS and/or USS SuperUser authority for additional installation
steps.
More Information:
After copying the pax.Z files to your PC, do the following to upload the files from your PC
to your z/OS USS directory.
80 Installation Guide
Pax-Enhanced ESD Procedures
bin
lcd C:\PC\folder\for\thePAXfile
cd /yourUSSESDdirectory/
put paxfile.pax.Z
quit
exit
Important! The sample job Unpackage.txt (see page 82) simplifies the Pax-Enhanced
ESD process; you can copy this JCL job directly to the mainframe.
To create a product installation directory using the Unpackage.txt sample job
1. Supply a valid JOB statement.
2. Replace yourUSSESDdirectory with the name of the USS directory that you use for
ESD downloads.
The job points to your specific directory.
3. Replace paxfile.pax.Z with the name of the pax file.
The job points to your specific pax file.
4. Submit the job.
The job runs and creates the product directory.
Note: After making the changes noted in the job, if the PARM= statement exceeds
71 characters, uncomment and use the second form of UNPAXDIR instead. This
sample job uses an X in column 72 to continue the PARM= parameters to a second
line.
At this point, the product has been copied from the DVD onto the PC and the file has
been FTP’d to USS and is now ready to be unpaxed.
To complete the installation
1. Access the Installation Guide in the documentation set for your product.
2. See the "Installing your product from PAX-Enhanced Electronic Software Delivery"
chapter:
In the How to Install a Product Using Pax-Enhanced ESD topic, see the Use the
SMP/E GIMUNZIP Utility step to proceed with the installation.
82 Installation Guide
References
References
lp
Directs output to line printer.
ls
Lists the file in a directory.
man
Displays the UNIX help for a command. For example, man chmod displays the UNIX
help for the chmod command.
mkdir
Creates a directory.
mv
Moves or renames one or more files or directories.
nm
Displays the symbol table from an executable file.
rm
Deletes a file or directory.
od
Produces an octal dump of a file. Also does hexadecimal dumps.
ps
Displays information about active processes.
strings
Lists text strings in an executable file.
wall
Sends a message to all logged in users.
whence
Identifies the location of an executable file.
who
Displays the logged on users and information about them.
84 Installation Guide
Chapter 7: Starting Your Product
This section describes what you need to do to start CA View.
Perform one of the following to either authorize the program load library or copy the
modules to a system authorized library:
■ If you want CA View to execute from its own target library APF-authorize the target
library by adding an entry for CAI.CVDELOAD to member PROGxx of SYS1.PARMLIB.
Note: Authorization does not take effect until the next IPL.
■ If you do not want to APF authorize the CA View target library copy the load
modules in CAI.CVDELOAD to an existing authorized library such as SYS1.LINKLIB or
any other library in the linklist.
Important! We recommend that you authorize CVDELOAD rather than copying the
modules. The load modules must reside in an authorized library.
86 Installation Guide
How to Complete Configuration With CA MSM
The CA LMP execution key, provided on the key certificate, must be added to the
CAIRIM parameters to ensure proper initialization of the CA software solution.
To define a CA LMP execution key to the CAIRIM parameters, modify member KEYS in
OPTLIB data set.
Syntax is as follows:
where:
pp
Specifies the two-character product code (required).
For any given CA LMP software solution, this code agrees with the product code
already in use by the CAIRIM initialization parameters for earlier service packs of CA
View.
ddmmmyy
Specifies the CA LMP licensing agreement expiration date (required).
tttt-mmmm
Specifies the CPU type and model (for example, 3090-600) on which the CA LMP
software solution is to run (required).
If the CPU type or model requires less than four characters, blank spaces are
inserted for the unused characters.
ssssss
Specifies the serial number of the CPU on which the CA LMP software solution is to
run (required).
kkkkkkkkkkkkk
Specifies the execution key required to run the CA LMP software solution
(required).
This CA LMP execution key is provided on the Key Certificate shipped with each CA
LMP software solution.
The following example shows a control statement for the CA LMP execution software
parameter. The CA LMP execution key is invalid and is provided only as an example.
Note: For more information about the procedure for defining the CA LMP execution key
to the CAIRIM parameters, see the CA Common Services Getting Started.
Note: For more information about security, see the chapter "Security" in the Reference
Guide.
Note: For more information about the ISPF Online Retrieval Option, see the chapter
"Online Interface Administration" in the Reference Guide.
88 Installation Guide
How to Complete Configuration With CA MSM
The action you take in this step depends on what you did during the base-product
installation—specifically, did you:
■ Authorize the program load library
or
■ Copy the modules to a system authorized library
If the CA View load modules were not copied to one of the libraries in the linklist,
proceed with this step; otherwise go to the next step.
If your system runs CA View under ISPF, proceed with this step.
Step 3: (Optional) Add the Mount Attribute to the TSO User IDs
If you want to add the mount attribute to your TSO user IDs, proceed with this step;
otherwise, go to the next step.
Assign the mount attribute to all TSO users who are authorized to browse SYSOUT
directly from an archival tape.
Use the TSO ACCOUNT command as follows to assign the mount attribute:
ACCOUNT
C (userid) MOUNT
END
Note: TSO users do not need the MOUNT attribute to access reports through the
Expanded Access Tape Server (EAS), because the tape is mounted by the EAS started
task and not the user's TSO session.
If you want to add a selection code for the online retrieval feature to one of the ISPF
selection menus, proceed with this step; otherwise, your detailed instructions for ISPF
are complete.
Use the value next to the NAME parameter on your Initialization Parameter Worksheet
for PARM(high-level-database-name).
Note: Adding a selection code allows you to select the online retrieval feature in the
same way you would select other ISPF options.
Panel Libraries
The names of the panel libraries vary from site to site and for the different releases of
SPF ISPF. These panel libraries are allocated to the ISPPLIB DD statement under TSO. Be
aware that some installations do not allow direct modifications of IBM panels and
libraries. In this case, modified panels can be placed in user or site-specific libraries and
concatenated ahead of the IBM libraries. Consult your ISPF administrator or systems
administrator for procedures and guidelines for modifying ISPF panels.
Note: The selection menus shown in the following examples are part of the program
product SPF ISPF, and are copyrighted by IBM.
90 Installation Guide
How to Complete Configuration With CA MSM
Note: For more information about the TSO Online Retrieval option, see the chapter
"Online Interface Administration" in the Reference Guide.
1. (Optional) Add STEPLIB DD statements to the TSO LOGON procedures if the load
modules are not in a linklist library.
2. (Optional) Add the mount attribute to the TSO user IDs.
The action you take in this step depends on what you did during the base-product
installation—specifically, did you:
■ Authorize the program load library
or
■ Copy the modules to a system authorized library
If the load modules were not copied to one of the libraries in the linklist:
■ Add a STEPLIB DD statement (for the library containing the load modules) to the
TSO LOGON procedures for those TSO users who are to use the native TSO online
retrieval option.
If the load modules were copied to one of the libraries in the linklist, no STEPLIB DD
statements are required.
Note: If you have CA View, the CA View load modules either must also be in the linklist,
or placed in a STEPLIB statement with this step.
Assign the mount attribute to all TSO user IDs authorized to browse SYSOUT directly
from an archival tape. Use the TSO ACCOUNT command to assign the mount attribute as
follows:
ACCOUNT
C (userid) MOUNT
END
Note: TSO users do not need the MOUNT attribute to access reports through the
Expanded Access Tape Server (EAS), because the tape is mounted by the EAS started
task and not the user's TSO session.
This section describes the configuration tasks needed before CA View can be started,
customized, and used in your environment.
Follow these steps to configure your product. Some steps are required; others are
optional according to the needs of your site.
Perform one of the following options to either authorize the program load library or
copy the modules to a system authorized library:
■ If you want CA View to execute from its own target library:
APF-authorize the target library by adding an entry for CAI.CVDELOAD to member
PROGxx of SYS1.PARMLIB.
Note: Authorization does not take effect until the next IPL.
■ If you do not want to APF authorize the CA View target library:
Copy the load modules in CAI.CVDELOAD to an existing authorized library such as
SYS1.LINKLIB or any other library in the linklist.
Use one of the following to copy the load modules:
– ISPF option 3.3
– Member HBRMCAPF in CAI.CVDEJCL
This batch job can be run to copy the load modules from CAI.CVDELOAD to
USER.APFLIB.
Note: The load modules must reside in an authorized library.
Important! We strongly recommend that you authorize and run from the
CAI.CVDELOAD target library. We also recommend that you add CAI.CVDELOAD to your
linklist.
92 Installation Guide
How to Configure Without CA MSM
Product Code
Specifies a two-character code that corresponds to CA View.
CPU ID
Specifies the code that identifies the specific CPU for which installation of your CA
View is valid.
The CA LMP execution key, provided on the key certificate, must be added to the
CAIRIM parameters to ensure proper initialization of the CA software solution.
To define a CA LMP execution key to the CAIRIM parameters, modify member KEYS in
OPTLIB data set.
Syntax is as follows:
where:
pp
Specifies the two-character product code (required).
For any given CA LMP software solution, this code agrees with the product code
already in use by the CAIRIM initialization parameters for earlier service packs of CA
View.
ddmmmyy
Specifies the CA LMP licensing agreement expiration date (required).
tttt-mmmm
Specifies the CPU type and model (for example, 3090-600) on which the CA LMP
software solution is to run (required).
If the CPU type or model requires less than four characters, blank spaces are
inserted for the unused characters.
ssssss
Specifies the serial number of the CPU on which the CA LMP software solution is to
run (required).
kkkkkkkkkkkkk
Specifies the execution key required to run the CA LMP software solution
(required).
This CA LMP execution key is provided on the Key Certificate shipped with each CA
LMP software solution.
94 Installation Guide
How to Configure Without CA MSM
The following example shows a control statement for the CA LMP execution software
parameter. The CA LMP execution key is invalid and is provided only as an example.
Note: For more information about the procedure for defining the CA LMP execution key
to the CAIRIM parameters, see the CA Common Services Getting Started.
CA View consists of the base product and several components (options) that are
purchased separately. Because each component has its own LMP code, you are required
to supply an LMP code for each component you purchased. The following table lists the
component product codes:
pp Component Description
VA CA View base product
VB CICS online interface
VC Expanded retention option
VD IMS/DC online interface
VG Native TSO online interface
VH Optical disk interface
VI Expanded access server option
VK CA Roscoe online interface
VN ISPF online interface
VQ VTAM online interface
0A PPS for Xerox option
06 EMC Centera option
0W AFP-to-PDF transform
Note: For more information about the components, see the chapters "Installing Online
Interfaces" and "Installing Features."
Most tape management systems have functions whereby any output tapes created by
started tasks or batch jobs that have abended or been canceled are kept for only a
specified default period. This can pose problems with CA View archive tapes if the
started task (SARSTC) or the archive tape consolidation utility (SARPAC) is canceled or
abends.
To ensure that valid data is not lost, your tape management system probably provides a
way to override this default retention period based on specific information such as a
data set qualifier, creating program name, job name.
The archive tapes use the same qualifier as your CA View database, unless a different
qualifier was specified on the STORGRP0-9 initialization parameters. The program name
for the started task is SARSTC and the program name for the tape consolidation utility is
SARPAC.
CA 1
For CA 1 Tape Management (CA 1), the ABE parameter determines how many days
to keep tapes that are created from a job that abnormally terminates. To override
the default, CA 1 provides a customizable exit called TMSUX2B that can be modified
to prevent CA View tapes from being scratched or overwritten in the event of an
abnormal termination.
Note: For more information about the installation of this exit, see the chapter "User
Exits and Interfaces" in the CA 1 Tape Management Systems Programmer Guide, or
contact Technical Support for assistance with CA 1.
CA Dynam/TLMS
For CA Dynam/TLMS Tape Management (CA Dynam/TLMS), the ABEND parameter
in your TLMSIPO systems option member controls how long to keep tapes that
were created from jobs and tasks that were abnormally terminated. To bypass this
option for CA View generated tape output, the TLMSXCLS user exits can be
customized to retain the tapes generated in the event of an abnormal termination.
Note: For more information about user exits, see the chapter "User Exits and
Macros" in the CA Dynam/TLMS Tape Management Systems Programmer Guide, or
contact Technical Support for assistance with CA Dynam/TLMS.
For other tape management systems, consult with your software vendor.
96 Installation Guide
How to Configure Without CA MSM
Upgrade Considerations
Note: For more information about upgrading and additional instructions, see the
Upgrading from a Prior Release section.
New Installations
The CA View database is comprised of index and data file data sets.
■ The data file data sets hold the report data, report index data, online panels, and
banner page members.
■ The index file data sets retain initialization parameter settings, user profile data,
definition data, and report references.
Both index and data file data sets must be allocated for a new database. These data
sets are allocated with the ADDDS INDEX and ADDDS DATA control statements of the
SARDBASE utility.
Note: For more information about creating the database, including formulas for
estimating both the DATA and INDEX areas and important details regarding database
extent placement, see the ADDDS section of the SARDBASE Control Statements in the
"Database Utilities" chapter in the Reference Guide.
Sample JCL to create an index file and database is provided in member HBRMADDS in
CAI.CVDEJCL.
Examine and make any necessary changes to the skeleton JCL by editing member
SAxJCL1 in the OLIB data sets as explained in the following sections.
The skeleton JCL is used by the online task to submit a background job to reprint or
retrieve SYSOUT.
If you want to have panels for multiple languages in your database, change the skeleton
JCL for each language you install.
Select the languages you want to use from the following table, and then modify the
corresponding data sets (which contain the online panels) and skeleton JCL members:
Skeleton JCL
Language Data Set Name Member
English CAI.CVDEPENU SARJCL1
Danish CAI.CVDEPDAN (optional) SADJCL1
French Canadian CAI.CVDEPFRC (optional) SACJCL1
German CAI.CVDEPDEU (optional) SAGJCL1
If you want to use a language other than English as the default for your panels, use the
LANGUAGE initialization parameter to specify your chosen language. You may also want
to record this information next to the LANGUAGE parameter on your Initialization
Parameter Worksheet.
Skeleton JCL
The SAxJCL1 skeleton JCL member is processed by CA View when a batch job, such as, a
batch reprint or loading of a report from tape is submitted.
The member contains symbolic parameters (variables which begin with an ampersand)
which are substituted with the actual values when the job is submitted. The symbolic
parameters used here are similar to the symbolic parameters in a JCL procedure.
Modify the SAxJCL1 member for STEPLIB references and tape setup processing.
&SJC1
&SJC2
&SJC3
&SJC4
//*
//* MODIFY //*SETUP AS NECESSARY
//*
)DOT SARTVARS
//*SETUP &TVSER (&TDSN)
)ENDDOT
//STEP1 EXEC PGM=SARBCH
)DOT SAROUTPT
&OJCL
)ENDDOT
//*
//* MODIFY OR REMOVE STEPLIB AS NECESSARY
//*
//STEPLIB DD DSN=CAI.HAC0.CVDELOAD,DISP=SHR
// DD DSN=CAI.HBC0.CVDELOAD,DISP=SHR
//SYSUDUMP DD SYSOUT=*
//SYSPRINT DD SYSOUT=*
//SYSIN DD *
/DBASE NAME=&IDX
98 Installation Guide
How to Configure Without CA MSM
Following are the four variables which can be optionally used to construct JCL:
The Distribution Id, and SJC1-4 are populated from the user's database profile. If any of
the SJC1-4 are not defined when the user's profile was created, they default to JCL
Comment statements (//*).
Optionally, there are two system variables which can be used to construct the JCL:
The Product Name is always initialized to CA View, the maintenance level is initialized
from an entry in the program library (CVDELOAD). This maintenance level is sometimes
referred as GENLEVEL, which is the year and month of the current maintenance level of
CA View, therefore 0801 was created in January 2008.
There are two re-occurring tape setup variables which can be optionally used to
construct the JCL:
These variables can be used for tape SETUP requirements. The sites may require a
/*SETUP or a //*SETUP statement in the job stream before the data center can pull
tapes. These two variables are called 're-occurring' because more than one tape may be
required to complete the batch process.
The ")DOT SARTVARS" and ")ENDDOT" statements form a loop and create the
"//*SETUP &TVSER (&TDSN)" statement for each tape referenced in the batch control
cards.
The setup statements can be removed from the SAxJCL1 member if they are not
required. They can also be used anywhere within the SAxJCL1 member, such as, creating
a SARBCH Comment statement for documentation purposes:
/DBASE NAME=&IDX
)DOT SARTVARS
* DSNAME=&TDSN VOL=SER=&TVSER
)ENDDOT
/DBASE NAME=.......db_hlq........
* DSNAME=.....tape_hlq.......SARTAPE.T00nnnnn VOL=SER=vvvvvv
* DSNAME=.....tape_hlq.......SARTAPE.T00nnnnn VOL=SER=vvvvvv
The SAxJCL1 JCL is combined with the JCL from the user's database profile. This JCL is
presented to the user when the SUBMIT Command in entered from any panel. The user
can modify these statements. You can ignore these JCL Statements and code all JCL in
the SAxJCL1 member.
A SAxJCL1 member can have a JOB card which contains the user's id. The following is an
example of a JOB Statement which may be coded in the SAxJCL1:
Note: The job id modifier character is not incremented and in this example, is always be
'A'.
You can define four JCL Statements in the user's database profile using the
SARBCH/DEFUSER Control Statement. These JCL Statements can be a job statement and
other setup JCL or comment statements.
Issuing the SUBMIT command from an interactive session displays the 'BATCH JOB JCL'
panel:
COMMAND ===>
The user can change or delete any of these statements before they are submitted with
the JCL from the SAxJCL1 member; the SARBCH Control Cards are generated to fulfill the
requested batch functions.
You can bypass the Job Statement submission panel if a standard job statement is coded
in the SAxJCL1 member or if the end-user is not allowed to change the job statements
saved in the user's profile. The 'BATCH JOB JCL' panel can be bypassed with a simple
SARSUBUX exit.
The following sample SARSUBUX statement bypasses the 'BATCH JOB JCL' panel and
immediately submits the batch job:
SARSUBUX CSECT
EBCMODE
USING SARSUBUX,15
C 0,=F'12'
BNE RC0
RC4 LA 15,4
BR 14
RC0 SR 15,15
BR 14
END
STEPLIB References
The action you take in this step depends on decisions you made in Step 8: Authorize
Program Load Libraries.
The SAxJCL1 skeleton JCL contains a STEPLIB DD statement. This DD statement must be
updated if you have not link listed CAI.CVDELOAD or the library you copied the load
modules to in the Authorize Program Load Libraries step. If you are running from a
linklist library, you can remove the STEPLIB DD statement.
If you have CA Deliver installed into a separate load library, add it to the STEPLIB DD if
this library is not in the linklist. You must concatenate the CA Deliver load library after
the CA View load library in the STEPLIB statement.
If you have CA Spool installed into a separate load library and want to use the CA View
to CA Spool interface, add this library to the STEPLIB DD if this library is not in the
linklist. Supply this DD after the CA View and CA Deliver load library DD statements.
Upgrade Considerations
Note: For more information about upgrading and information that applies to this step,
see the chapter Migration Information.
Load the panel, message, and skeleton JCL members in the online library to the
database.
The OLOAD control statement of the SARDBASE utility is used to load the online library
to the database. The online library is defined with the DD statement SAROLIB.
The high-level name of the database must have been previously defined with the NAME
control statement (or the PARM parameter of the EXEC JCL statement).
Syntax is as follows:
OLOAD
Note: For more information about how to load the members of the online library to the
CA View database, see OLOAD in the SARDBASE Control Statements section in the
"Database Utilities" chapter in the Reference Guide.
You can display the panels in any of several languages in your database. The language
panels displayed for a specific end user are determined by the setting of the LANGUAGE
parameter on the Batch DEFUSER control statement.
Note: For more information about control statements, see "SARBCH Control
Statements" in the Reference Guide.
You can load all of the languages, or only those languages your database uses. Each
language requires approximately four cylinders of the database.
The following table shows the data sets containing online panels and their languages:
The data sets listed above contain the BROWSE and HELP panels; you can modify them
within the following limitations:
■ Constants:
Constants can be modified and their length can be increased or decreased. The new
text displays as coded.
■ Variables:
– Most variables can be moved around the screen as long as the original variable
names are retained, but be aware that the relative position of some variables is
critical.
– The length of a variable can be changed, but be aware that the product pads
the value with blanks (or truncates it) to conform to its internal length.
– Any variable can be deleted from a panel.
– An attempt to add a variable to a screen results in the variable name itself
appearing on the screen, without interpretation.
Note: For these attributes, the colors used must be red, white, blue, or green.
Define color and highlight attributes on the CA Deliver panels according to the rules
listed in the IBM manual Dialog Management Guide for ISPF.
The following hexadecimal characters are reserved and cannot be defined as attribute
statements on a panel:
Hex Represents
00 Null character
0E Shift out
0F Shift in
40 Blank
50 Ampersand (&)
Upgrade Considerations
For more information about upgrading and information that applies to this step, see the
chapter Migration Information.
Upload Considerations
The BLOAD control statement of the SARDBASE utility is used to load the model banner
page library to the database. The model banner page library is defined with the DD
statement SARBLIB.
The high-level name of the database must have been previously defined with the NAME
control statement (or the PARM parameter of the EXEC JCL statement).
Syntax is as follows:
BLOAD
Note: For more information about how to load the model banner page members to the
CA View database, see BLOAD in the SARDBASE Control Statements in the chapter
"Database Utilities" in the Reference Guide.
If you have not added CAI.CVDEPROC to your procedure library concatenation, add the
microfiche start procedure JCL to SYS1.PROCLIB. Sample JCL for this job is provided in
member CBRMSMFP of CAI.CVDEPROC.
This JCL contains a STEPLIB DD statement. This DD statement must be updated if you
have not link listed CAI.CVDELOAD or the library that you copied the load modules to in
the Authorize Program Load Libraries step. If you are running from a linklist library, you
can remove the STEPLIB DD statement.
Automatic Microfiche
For more information about how to have CA View automatically produce microfiche, see
the following sections in the Reference Guide:
■ Microfiche Processing with SARMFP in the "Configuring" chapter
■ START in the Initialization Parameter Descriptions section in the "Initialization
Parameters" chapter
Note: To save the information for a later step, be sure to record the member name of
the microfiche procedure next to the START parameter on your Initialization Parameter
Worksheet.
Index Parameter
Set the index parameter in the EXEC statement to the high-level name of the CA View
database. Use the value next to the NAME parameter on your Initialization Parameter
Worksheet.
The SYSOUT DD statement defines the SORT messages; this DD statement can be
"dummied out" by specifying it as a comment.
The OUT DD statement must define a sequential output file so that it contains
microfiche output. Sample file types are as follows:
■ Tape data set processed by an offline microfiche processor
■ Temporary data set passed to a microfiche processor
■ SYSOUT data set for an online microfiche processor
The OUT DD statement DCB attributes can be specified as fixed or variable length. These
attributes can be omitted; however, if they are omitted the DCB attributes are copied
from the input disk archival generation.
Upgrade Considerations
For more information about upgrading and information that applies to this step, see the
chapter Migration Information.
If you want the started task to capture the job accounting data, see the Job Accounting
section in the chapter "Configuring" in the Reference Guide. Also, you may want to
review the topic "Formatting the Accounting File" in that chapter.
Note: To save the information for a later step, be sure to record the name of your
accounting data set next to the SARACT ddname on your Archival Started Task
Worksheet.
Upgrade Considerations
For more information about upgrading and information that applies to this step, see the
chapter Migration Information.
Note: We strongly recommend that you use this recovery data set feature.
The started task can automatically track tapes used in the backup process. See the
following sections in the Reference Guide:
■ The Recovery Data Set section in the chapter "Configuring"
■ The chapter "Database Backup and Recovery"
Note: To save the information for a later step, be sure to record the name of your
recovery data set next to the SARRECV ddname on your Archival Started Task
Worksheet.
Upgrade Considerations
For more information about upgrading and information that applies to this step, see the
chapter Migration Information.
Before installing a new version of SARXTD, ensure that the old system extensions have
been withdrawn.
S SARXTD,PARM=OFF
To add the extensions, if you have not added CAI.CVDEPROC to your procedure library
concatenation, add the following start procedure JCL as member CBRMSXTD of
SYS1.PROCLIB. Sample JCL for this job is provided in member CBRMSXTD of
CAI.CVDEPROC.
Note: Use the value next to the SARACT ddname on your Archival Started Task
Worksheet for your SARACT data set name.
Library Authorization
The JCL for this job contains a STEPLIB DD statement. This DD statement must be
updated if you have not link listed CAI.CVDELOAD, or the library you copied the load
modules to in the Authorize Program Load Libraries step. If you are running from a
linklist library, you can remove the STEPLIB DD statement.
The parameters passed to the program through the PARM field on the EXEC statement
apply to data set security and automatic report archival.
Note: For more information, see Systems Extensions (SARXTD) in the "Configuring"
chapter in the Reference Guide.
Job Accounting
If you do not want job accounting, do not include the SARACT DD statement.
Upgrade Considerations
For more information about upgrading and information that applies to this step, see the
chapter Migration Information.
CA View records job-end condition codes and stores them with the SYSOUT. Certain CA
View features (such as the Expanded Retention Option and the XPRINT initialization
parameters) use these condition codes to determine processing. The product provides
the following system default exceptional condition specifications:
■ Non-zero condition code
■ Data set not deleted
■ Data set not cataloged
■ Data set not recataloged
■ Data set not uncataloged
■ JCL error
■ Operator cancel in allocation recovery
■ System ABEND
■ User ABEND
■ User defined character strings
If these defaults are not correct for your system, proceed with this step; otherwise go to
the next step.
Note: For more information about exceptional condition, see Exceptional Condition
Checking in the chapter "Archival" in the Reference Guide.
The DD statement SARXCTAB in your SARSTC startup JCL and SARFSS JCL points to the
file that contains your exceptional condition code checking statements.
Note: To save the information for a later step, be sure to enter the name of your
exceptional condition statements data set next to the SARXCTAB ddname on your
Archival Started Task Worksheet.
Upgrade Considerations
For more information about upgrading and information that applies to this step, see the
chapter Migration Information.
For each user exit that you have tailored in previous releases, update the new CA View
skeleton version and assemble it using the macros in CAI.CVDEMAC. See the comments
in the sample exits before updating them.
The following table lists the user exits and the CAIOPTN members that you can use to
install them.
Note: For more information about user exits, see the chapter "User Exits" in the
Reference Guide.
Note: Sample JCL is provided to assist with the installation of most CA View user exits in
two formats. One sample format provides JCL for SMP/E-controlled USERMOD
installation, and one sample format provides JCL to install outside of SMP.
The non-SMP/E samples have been provided in this release to help facilitate improved
management of multiple sets of target libraries that have been deployed on more than
a single LPAR and have different configuration criteria. To safely manage user exits
outside of SMP/E, link the exits into a separate, independent load library that can be
link-listed or concatenated before the CA View product load library. We recommend
that you test the product before customizing exits.
For more information about User Exits, see the Reference Guide.
Upgrade Considerations
For more information about upgrading and information that applies to this step, see the
chapter Migration Information.
If a CA View database is accessed from multiple CPUs or LPARs, all PROCs, JCL, CLISTS,
and so forth that access the database must also be upgraded.
If you use a system integrity product, make the required changes to accommodate the
new CA View database. RESERVES are issued against both the first index extent and the
first data extent; therefore, a review of local configurations is required.
The product issues ENQs and RESERVEs as necessary to maintain the integrity of its data
sets. The primary ENQ (QNAME=SARSTC) is used by the archival task to ensure that only
one archival task starts using a specific database. The ENQ is defined as SYSTEMS which
will be propagated to all LPARs in a PLEX. This queue name need not be defined to a
system integrity product. A secondary ENQ (QNAME=SARPAC) is used by the tape
consolidation utility SARPAC. This is also defined as SYSTEMS and need not be defined to
a system integrity product.
The RESERVE issued by CA View is normally short-lived but causes deadlock conditions
unless properly defined. Convert them to global enqueues; however, if your
environment dictates, the reserves need not be converted. If a database's first index
extent AND the first data extent are on dedicated volumes with no other data sets, you
do not need to convert RESERVES to global enqueues.
The following table shows how CA View uses ENQ and RESERVE:
Place the first extent of the index and the database on dedicated volumes because
the RESERVE processing uses the data set name and volume of the first extent to
serialize all accesses. If multiple database or index extents are on the same volume, then
RESERVE can prevent access to the other database or index extents.
Note: For more information about installing optional online interfaces, see the chapter
"Installing Online Interfaces."
Upgrade Considerations
For more information about upgrading and information that applies to this step, see the
chapter Migration Information.
Review the chapter "Installing Features" and ensure that any STEPLIBs in your JCL
reference the new CAI.CVDELOAD and that you use the new ERO parameters.
Step 17: (Optional) Download the EMC Centera API for CA View
The CA View Option for EMC Centera enables you to migrate and retrieve reports
to/from a Centera disk cluster to the CA View database for viewing or printing.
The EMC Centera API is part of a separate, chargeable option for CA View, which is
distributed on a separate cartridge that contains all the data required for the
installation.
Sample JCL for downloading the EMC Centera API load library from the cartridge is
provided in member HBRMCENT of CAI.CVDEJCL. Customize the JCL member to reflect a
valid JOB statement, data set names, and volume serial numbers.
Note: For more information about the EMC Centera Option, see the chapter "EMC
Centera Disk Option" in the Reference Guide.
Upgrade Considerations
For more information about upgrading and information that applies to this step, see the
chapter Migration Information.
All CA Deliver started tasks (RMOSTC) that are writing to a Version 12.0 CA View
database must use the CA View Version 12.0 CVDELOAD load library.
Note: The CA View databases referenced by those CA Deliver started tasks can be at
release level r11, r11.5, r11.6, r11.7, or Version 12.0.
If CAI.CVDEPROC is not in your system procedure library concatenation, add the archival
task startup procedure to SYS1.PROCLIB. Sample JCL statements for this job are in
member CBRMSSTC of CAI.CVDEPROC.
Library Authorization
The JCL for this job contains a STEPLIB DD statement. This DD statement must be
updated if you have not link listed CAI.CVDELOAD, or the library you copied the load
modules to in the Authorize Program Load Libraries step. If you are running from a
linklist library, you can remove the STEPLIB DD statement.
Set the DB symbolic on the PROC statement to the high-level name of the database.
Use the value next to the NAME parameter on your Initialization Parameter Worksheet.
The Backup List report shows SYSOUTs that were backed up to tape, with their
corresponding tape numbers.
The DR Tape Backup List report shows SYSOUTs that were backed up to the DR tape,
with their corresponding tape numbers.
The Optical Migration report (secondary disk) shows SYSOUTs that were backed up to
optical disk.
Optional Functions
Several of the optional functions need DD statements in the started task JCL (SARSTC).
If you installed an optional function, include the DD statement with the appropriate
data set name (from your Archival Started Task Worksheet) in SARSTC.
Note: Do not include DD statements for functions you did not install.
Step 19: Use SARINIT to Set the Final Initialization Parameter Values
All users must perform this step.
Upgrade Considerations
For more information about upgrading and information that applies to this step, see the
chapter Migration Information.
Review all of the parameters on your Initialization Parameter Worksheet. Verify that all
options have been appropriately set.
Note: Any parameter that you do not modify is set to its default value.
Run SARINIT
Use the following procedure to run SARINIT. Sample JCL for this job is provided in
member SARINIT of CAI.CVDEJCL.
1. Create the SARINIT control statements using the Initialization Parameter Worksheet
in the appendix "Installation Worksheets."
2. Run SARINIT.
3. Save this JCL and control statements.
Note: For information about customizing and configuring CA DRAS, see the CA DRAS
Operations Guide.
Post-Installation Considerations
Now that you have successfully installed CA View, consider the following:
■ For information about shutting down CA View, see the User Guide.
This section contains the information you need to upgrade to CA View Version 12.0 from
CA View Releases r11.7, r11.6, r11.5, or r11.
For an overview of the changes in this release, see the Release Notes.
Modify the steps according to the supplementary instructions in the tables in the
following sections:
■ Installation Steps to Upgrade to Version12.0
■ Configuration Steps to Upgrade to Version12.0
Existing Release r11.7, r11.6, r11.5, or r11 users will install the product in almost the
same way as new users with one exception; instead of creating a database you version
your existing database. This process updates several records in the database and
executes in a few minutes.
Note: To revert to Release r11.7, r11.6, or r11.5, see the chapter Reverting to a Prior
Installation.
The Step column lists the step and the Upgrade Instructions column explains what you
must do if the step needs to be modified or replaced.
The Step column lists the step and the Upgrade Instructions column explains what you
must do if the step needs to be modified or replaced.
Revert to r11.6
If you decide to revert to CA View r11.6, follow these steps:
1. Use the CA View Version 12.0 SARDBASE utility to set the version of your CA View
database back to a CA View r11.6 database. The format of the VERSION control
statement is:
VERSION 11.6
Note: If your CA View database is currently versioned to release level r11.6 or
earlier, skip steps 1 and 2.
2. Use the CA View r11.6 release SARDBASE utility to OLOAD the r11.6 online panel
library into your database.
3. Use the CA View r11.6 release SARDBASE utility to BLOAD the r11.6 banner page
library to your database.
4. If you modified any of the CA View user exits, revert to your r11.6 versions of the
exits.
5. Change your JCL, Procs, and started task JCL to point to the r11.6 libraries.
6. If the Version 12.0 load library was link listed, revert to the r11.6 link listed library.
7. Ensure that PTF RO28310 is applied to release r11.6; this ensures that Release r11.7
and Version 12.0 tapes can be read by release r11.6.
Revert to r11.5
If you decide to revert to CA View r11.5, follow these steps:
1. Use the CA View Version 12.0 SARDBASE utility to set the version of your CA View
database back to a CA View r11.5 database. The format of the VERSION control
statement is:
VERSION 11.5
Note: If your CA View database is currently versioned to release level r11.5 or
earlier, skip steps 1 and 2.
2. Use the CA View r11.5 release SARDBASE utility to OLOAD the r11.5 online panel
library into your database.
3. Use the CA View r11.5 release SARDBASE utility to BLOAD the r11.5 banner page
library to your database.
4. If you modified any of the CA View user exits, revert to your r11.5 versions of the
exits.
5. Change your JCL, Procs, and started task JCL to point to the r11.5 libraries.
6. If the Version 12.0 load library was link listed, revert to the r11.5 link listed library.
7. Ensure that PTF RO17278 and PTF RO31552 are applied to r11.5; this ensures that
r11.6, Release r11.7, and Version 12.0 tapes can be read by release r11.5.
Note: If the database contains encrypted data or large format data sets (data sets
allocated with more than 4369 cylinders), unload the database and reload to a new
database before reverting to r11.5. Allocate the data sets for the new database with
4369 cylinders or less. Before unloading the database, be sure that the ENCRYPT
initialization parameter is set to NO and SARPAC any backup tapes and DR tapes that
contain encrypted data.
The EBC Common Component Configuration Option includes several external tasks that
are required to complete the configuration.
2. Verify that the correct PGMname is defined for the new facility, where PGMname is
either the first three characters or all the eight characters of the program name that
is going to make security calls (EC0 or EC0DRV).
3. Create region ACID for the facility.
TSS CRE(viewxms)pass(nopw,0) type(user) dept(dept) mastfac(viewxms NODSNCHK
NORESCHK NOVOLCHK NOLCFCHK NOSUBCHK
Note: In the JCL for the cross-memory services task, the parameter XMSSUB must be set
to YES.
Installation Steps
The following steps are required to install the ISPF/cross-memory online retrieval
option. Each step is explained in detail later in the sections that follow.
1. (Optional) Add STEPLIB DD Statements to the TSO LOGON procedures if the load
modules were not copied to a linklist library.
2. Add the panel and command table libraries to the TSO logon procedures. (For ISPF
only, not for SPF.)
3. (Optional) Modify an SPF selection menu to select the online retrieval feature.
Note: For more information about the ISPF/cross memory online retrieval option, see
the chapter "Online Interface Administration" in the Reference Guide.
The action you take in this step depends on what you did during the base-product
installation—specifically, did you:
■ Authorize the program load library
or
■ Copy the modules to a system authorized library
If the CA View load modules were not copied to one of the libraries in the linklist,
proceed with this step; otherwise go to the next step.
For this interface, the libraries do not have to be APF authorized. Authorization is
provided in the cross-memory installation. Multiple versions of this online interface can
coexist in one TSO library concatenation.
Note: If multiple versions are going to be running simultaneously, or you also want to
run a previous version of SARSPF or SARTSO, concatenate the load library you want
SARSPF or SARTSO to use first.
More information:
If you are going to run CA View under ISPF, proceed with this step. For Version 3 or
higher, both the command table library and the panel library are used.
To add panel and command table libraries to the TSO LOGON procedure:
■ Concatenate the command table library CAI.CVDETBL0 to DD statement ISPTLIB.
■ Concatenate the panel library CAI.CVDEPNL0 to DD statement ISPPLIB.
Note: If you also plan to use SARSPF (the ISPF interface), and multiple versions of CA
View, concatenate CAI.CVDETBL0 first. Use the CAI.CVDETBL0 from the most current
release.
If you want to add a selection code to one of the ISPF selection menus for the online
retrieval feature, proceed with this step; otherwise, your ISPF detailed instructions are
complete.
Note: If you add a selection code, you can select the online retrieval feature in the same
way you select other ISPF options.
Use the value next to the NAME parameter on your Initialization Parameter Worksheet
for PARM(high-level-database-name).
Panel Libraries
The names of the panel libraries vary from site to site and for the different releases of
ISPF. These panel libraries are allocated to the ISPPLIB DD statement under TSO.
Be aware that some installations do not allow direct modifications of IBM panels and
libraries. In this case, you can place the modified panels in user or site-specific libraries
and concatenate them ahead of the IBM libraries.
Ask your system administrator for the specific ISPF panel library that applies to your site
and contains the panel ISR@PRIM.
Note: The selection menus shown in the following examples are part of the program
products SPF and ISPF, and are copyrighted by IBM.
Example 1
The following example shows you how to add selection code R to the primary option
menu ISR@PRIM for ISPF. The bright, offset text identifies the inserted lines.
%OPTION ===>_ZCMD +
% +USERID - &ZUSER
% 0 +ISPF PARMS - Specify terminal and user parameters +TIME - &ZTIME
% 1 +BROWSE - Display source data or output listings +TERMINAL - &ZTERM
% 2 +EDIT - Create or change source data +PF KEYS - &ZKEYS
% 3 +UTILITIES - Perform utility functions
% 4 +FOREGROUND - Invoke language processors in foreground
% 5 +BATCH - Submit job for language processing
% 6 +COMMAND - Enter TSO Command, CLIST, or REXX exec
% 7 +DIALOG TEST - Perform dialog testing
% 8 +LM UTILITIES- Perform library administrator utility functions
% C +CHANGES - Display summary of changes for this release
% R +SARSPF - Retrieve SYSOUT
% T +TUTORIAL - Display information about ISPF/PDF
% X +EXIT - Terminate ISPF using log and list defaults
%
+Enter%END+command to terminate ISPF.
)INIT
.HELP = ISR00003
&ZPRIM = YES /* ALWAYS A PRIMARY OPTION MENU */
&ZHTOP = ISR00003 /* TUTORIAL TABLE OF CONTENTS */
&ZHINDEX = ISR91000 /* TUTORIAL INDEX - 1ST PAGE */
)PROC
&ZSEL = TRANS( TRUNC (&ZCMD,'.')
0,'PANEL(ISPOPTA)'
1,'PGM(ISRBRO) PARM(ISRBRO01)'
2,'PGM(ISREDIT) PARM(P,ISREDM01)'
3,'PANEL(ISRUTIL)'
4,'PANEL(ISRFPA)'
5,'PGM(ISRJB1) PARM(ISRJPA) NOCHECK'
6,'PGM(ISRPTC)'
7,'PGM(ISPYXDR) PARM(ISR) NOCHECK'
8,'PANEL(ISRLPRIM)'
C,'PGM(ISPTUTOR) PARM(ISR00005)'
R,'PGM(EC0XMSPF) PARM(VIEW.SYSTEM1) NEWAPPL(SAR)'
T,'PGM(ISPTUTOR) PARM(ISR00000)'
' ',' '
X,'EXIT'
*,'?' )
&ZTRAIL = .TRAIL
)END
Note:
■ NEWAPPL(SAR) is required and must be specified as shown previously in this
section.
This parameter is used with the command table library concatenation from Step 3
of the ISPF Installation Instructions.
■ NEWAPPL(SAR) allows CA View to correctly interpret commands and program
function key invocation.
If this parameter is not specified, certain PF keys such as the scroll keys may not
function.
Example 2
The following example shows you how to add selection code R to the primary option
menu ISP@PRIM for SPF. Shading identifies the inserted lines.
%OPTION ===>_OPT
% +USERID -
% 0 +ISPF PARMS - SPECIFY TERMINAL AND USER PARAMETERS +TIME -
% 1 +BROWSE - DISPLAY SOURCE DATA OR OUTPUT LISTINGS +TERMINAL –
% 2 +EDIT - CREATE OR CHANGE SOURCE DATA +PF KEYS -
% 3 +UTILITIES - PERFORM SPF UTILITY FUNCTIONS
% 4 +FOREGROUND - COMPILE, ASSEMBLE, OR DEBUG
% 5 +BACKGROUND - COMPILE, ASSEMBLE, OR LINK EDIT
% 6 +COMMAND - ENTER TSO COMMAND OR CLIST
% 7 +SUPPORT - TEST DIALOG OR CONVERT MENU/MESSAGE FORMATS
% 8 +LM UTILITIES- PERFORM LIBRARY ADMINISTRATOR UTILITY FUNCTIONS
% R +SARSPF - RETRIEVE SYSOUT
% T +TUTORIAL - DISPLAY INFORMATION ABOUT SPF
% X +EXIT - TERMINATE SPF USING LIST/LOG DEFAULTS
%
+PRESS%END KEY TO TERMINATE SPF+
%
)INIT
.HELP = TTUTOR
&ZHTOP = TTUTOR /* TUTORIAL TABLE OF CONTENTS */
&ZHINDEX = TINDEX /* TUTORIAL INDEX - 1ST PAGE */
)PROC
&ZSEL = TRANS( TRUNC (&OPT,'.')
0,'PANEL(ISPOPT)'
1,'PGM(ISRBRO)'
2,'PGM(ISPEDIT)'
3,'PANEL(ISPUTIL)'
4,'PANEL(ISPFORA)'
5,'PANEL(ISRJOB)'
6,'PGM(ISPTSO)'
7,'PANEL(ISPOTAC)'
R,'PGM(EC0XMSPF) PARM(VIEW.SYSTEM1)'
T,'PGM(ISPTUTOR) PARM(T)'
' ',' '
X,'EXIT'
*,'?' )
)END
Example 3
This example shows you how to add selection code 3.R as a sub-option to the utilities
menu ISPUTIL for ISPF. Shading identifies the inserted lines.
%OPTION ===>_OPT +
% +
% 1 +LIBRARY LIBRARY UTILITY:
+ PRINT INDEX LISTING OR ENTIRE DATASET
+ PRINT, RENAME, DELETE, OR BROWSE MEMBERS
+ COMPRESS DATASET
% 2 +DATASET DATASET UTILITY:
+ DISPLAY DATASET INFORMATION
+ ALLOCATE, RENAME, OR DELETE ENTIRE DATASET
+ CATALOG OR UNCATALOG DATASET
% 3 +MOVE/COPY MOVE OR COPY MEMBERS OR DATASETS
% 4 +CATALOG CATALOG MANAGEMENT:
+ DISPLAY OR PRINT CATALOG ENTRIES
+ INITIALIZE OR DELETE USER CATALOG ALIAS
% 5 +RESET RESET STATISTICS FOR MEMBERS OF SPF LIBRARY
% 6 +HARDCOPY INITIATE HARDCOPY OUTPUT
% 7 +VTOC DISPLAY OR PRINT VTOC ENTRIES FOR A DASD VOLUME
% 8 +OUTLIST DISPLAY, DELETE, OR PRINT HELD JOB OUTPUT
% 9 +SCRIPT/VS FORMAT,DISPLAY, AND OPTIONALLY PRINT SCRIPT TEXT
% R +SARSPF RETRIEVE SYSOUT
)INIT
.HELP = TU
)PROC
&SEL = TRANS( TRUNC (&OPT,'.')
1,'PGM(ISPUDA) PARM(UDA1)'
2,'PGM(ISPUDA) PARM(UDA1)'
3,'PGM(ISPUMC)'
4,'PGM(ISPUCA)'
5,'PGM(ISPURS)'
6,'PGM(ISPUHC)'
7,'PGM(ISPUVT)'
8,'PGM(ISPUOL) PARM(UOL01)'
9,'PGM(ISPUSC) PARM(SCRPTA)'
R,'PGM(EC0XMSPF) PARM(VIEW.SYSTEM1)'
' ',' '
*,'?' )
)END
The EBCXMTRN macro also contains options for the specific database as follows:
■ SUBSYS= parameter of the cross-memory task must match the SUBSYS= parameter
specified in the EBCXMCTR table entry.
■ RECON=YES can be used to allow reconnection (after an ISPF terminal error) at the
point of exit.
■ TIMEOUT= specifies how long ISPF waits for the XMS session to respond after the
user enters input, in seconds.
We recommend as high a value as possible but not less than 240 (4 minutes).
To abort the XMS session and return the user to ISPF or the TSO command prompt,
press the ATTN key.
Note: The SUBMAX= parameter controls the number of user connections, not the
USERMAX= parameter. USERMAX= only applies when you are using the subtask with the
CICS interface.
Note: The parameter XMSSUB must be set to YES in the JCL for the cross-memory
services task.
Installation Steps
The following steps are required to install the TSO/cross-memory online retrieval
option. Each step is explained in detail in the sections that follow.
1. (Optional) Add STEPLIB DD Statements to the TSO LOGON procedures if the load
modules were not copied to a linklist library.
2. (Optional) Create user CLISTs to execute the CA View TSO/XMS driver program.
The action you take in this step depends on what you did during the base-product
installation—specifically, did you:
■ Authorize the program load library
or
■ Copy the modules to a system authorized library
If the CA View load modules were not copied to one of the libraries in the linklist,
proceed with this step; otherwise go to the next step.
To add STEPLIB DD statements (for the library containing the CA View load modules) to
the TSO LOGON procedures, do the following:
■ Add a STEPLIB DD statement for the library that contains the CA View load modules
to the LOGON procedures for those TSO users who are to use the
TSO/Cross-Memory Online Retrieval Option.
For more information about executing the CA View TSOXMS driver program, see the
chapter "Online Interface Administration" in the Reference Guide.
To create user CLISTs to execute the CA View TSOXMS driver program, issue the
following command:
EC0XMTSO highlevel.databasename
Note: For more information about executing the CA View TSOXMS driver program, see
the chapter "Online Interface Administration" in the Reference Guide.
The EBCXMTRN macro also contains options for the specific database as follows:
■ SUBSYS= parameter of the cross-memory task must match the SUBSYS= parameter
specified in the EBCXMCTR table entry.
■ RECON=YES can be used to allow reconnection (after a TSO terminal error) at the
point of exit.
■ TIMEOUT= specifies how long TSO is to wait for the XMS session to respond after
the user enters input, in seconds.
We recommend as high a value as possible but not less than 240 (4 minutes).
To abort the XMS session and return the user to ISPF or the TSO command prompt,
press the ATTN key.
Note: The SUBMAX= parameter controls the number of user connections, not the
USERMAX= parameter. USERMAX= only applies when you are using the subtask with the
CICS interface.
Note: For more information about the cross-memory feature, see the Install Cross
Memory Services section in this chapter.
Installation Steps
The following steps are required to install the VTAM online retrieval option. Each step is
explained in detail in the sections that follow.
1. Define the APPL definition statement to VTAM.
2. (Optional) Create a USS definition table.
* SYS1.VTAMLST(sarmajor)
sarmajor VBUILD TYPE=APPL
sarvtam APPL ACBNAME=sarvtam,AUTH=(PASS,ACQ),EAS=nn
where:
sarmajor
Specifies the application program major node name.
Use the SYS1.VTAMLST member name. The member name must be unique and
must not be the same as the names on the APPL statement.
AUTH=(PASS,ACQ)
Is required when the cross-memory parameter VTAMPASS=YES is used to support
multiple cross-memory regions.
If VTAMPASS=NO, you can specify AUTH=(ACQ). For more information about the
VTAMPASS parameter, see the topic, Add the Start Procedure for the
Cross-Memory Online Task, later in this chapter.
EAS=nn
Specifies the approximate number of concurrent sessions.
sarvtam
Specifies the application program minor node name.
■ This name must be unique within the network domain; it is the APPLID
referenced in the USS definition table or LOGON command.
■ This name is also specified on the cross-memory SARAPPL parameter.
■ If not specified, the network-unique name (the name of the APPL definition
statement) is used.
To simplify the manner in which a user logs on to VTAM online retrieval, you can create
a USS definition table for CA View.
Example
Assume that two CA View systems have been created. The databases for the two
systems have high-level names of VIEW.SYSTEM1 and VIEW.SYSTEM2, and you want a
user to simply enter one of the following to log on to VTAM online retrieval for the
respective systems:
VIEW1
VIEW2
USSTAB
*
* ENTRY FOR VIEW1
*
USSCMD CMD=VIEW1,REP=LOGON,FORMAT=PL1
USSPARM PARM=APPLID,DEFAULT=SARVTAM
USSPARM PARM=LOGMODE
USSPARM PARM=DATA,DEFAULT=VIEW.SYSTEM1
*
* ENTRY FOR VIEW2
*
USSCMD CMD=VIEW2,REP=LOGON,FORMAT=PL1
USSPARM PARM=APPLID,DEFAULT=SARVTAM
USSPARM PARM=LOGMODE
USSPARM PARM=DATA,DEFAULT=VIEW.SYSTEM2
USSEND
Specifying the common VTAM generic resource name in the session request can initiate
VTAM cross-memory sessions to any of the EMAS members.
When you are using the VTAM generic resource name, by default VTAM tries to request
a session with an EMAS member in the same MVS image.
If it is not possible to get the session that was requested, VTAM uses normal load
balancing when passing the session request to one of the active EMAS members.
Installation Steps
The following steps are required to install the CA Roscoe/Cross Memory Online Retrieval
option. Each step is explained in detail in the sections that follow.
1. (Optional) Concatenate the Load Module Library to the ETSOLIB DD statement, if
the load modules were not copied to a linklist library.
2. Add the control statement for the SARROS command processor to the Eligible
Program List (EPL).
3. Invoke CA Roscoe/Cross Memory Online Retrieval.
If the load modules were not copied to a linklist library, concatenate the library that
contains the load modules to the ETSOLIB DD statement in the CA Roscoe start up JCL.
Note: If you have CA Deliver, the CA Deliver load modules must also be either in the
linklist, or in a ETSOLIB statement with this step.
Columns Contents
1-8 EC0XMROS
9 Blank
10-12 Number of users allowed to access CA View at one time
13 Blank
14-17 CPU time slice
Use 9999 to prevent premature termination.
18 Blank
Columns Contents
19-24 Maximum memory (in KB) below the 16 MB line
This memory is only for the cross-memory driver program (50 KB is
ample).
25 Blank
26-31 Maximum memory (in KB) below the line that CA View can acquire at
one time
Use 999999 so that GETMAINs will not be limited.
32 Blank
33-38 Maximum memory (in KB) above the 16 MB line
This memory is only for the cross-memory driver program (50 KB is
ample).
39 Blank
40-45 Maximum memory (in KB) above the line that CA View can acquire at
one time
Use 999999 so that GETMAINs will not be limited.
46 Blank
47 N – Suppress Dump
48 Blank
49 Y – Application authorized to issue MODESET SVC
50 Blank
51-52 CP to call EC0XMROS as a TSO command processor
53-255 Ignored
Note: For more information about how to invoke the CA Roscoe/cross-memory online
retrieval feature, see the chapter "Online Interface Administration" in the Reference
Guide.
The EBCXMTRN macro also contains options for the specific database as follows:
■ SUBSYS= parameter of the cross-memory task must match the SUBSYS= parameter
specified in the EBCXMCTR table entry.
■ RECON=YES can be used to allow reconnection (after a TSO terminal error) at the
point of exit.
■ TIMEOUT= specifies how long TSO is to wait for the XMS session to respond after
the user enters input, in seconds.
We recommend as high a value as possible but not less than 240 (4 minutes).
Note: The SUBMAX= parameter controls the number of user connections, not the
USERMAX= parameter. USERMAX= only applies when you are using the subtask with the
CICS interface.
Note: For more information about cross-memory, see Install Cross Memory Services.
Installation Steps
The following steps are required to install the CICS Pseudo Conversational Option. Each
step is explained in detail in the sections that follow.
1. Place the CA View load libraries into DFHRPL and STEPLIB.
2. Code the PCT and PPT Table Entries to CICS.
3. (Optional) Prepare the interface to a user-written CICS menu system.
The CA View load library is required in the CICS DFHRPL and in the STEPLIB in the CICS
region.
Note: If the CAI.CVDELOAD load library is in the linklist, it does not have to be included
as a STEPLIB in the CICS region.
Be sure the following modules are available in the DFHRPL concatenation of libraries:
■ EC0CICUX
■ EC0CIEND
■ EC0CINIT
■ EC0CISRV
■ EC0XMCIC
■ EC0Crelease-number
Where:
release-number represents the CICS release number.
– CTS 3.1 release number: 0640
– CTS 3.2 release number: 0650
– CTS 4.1 release number: 0660
– CTS 4.2 release number: 0670
– CTS 5.1 release number: 0680
You can copy the six modules to the DD statement DFHRPL in your CICS task. However,
we strongly recommend that you concatenate CAI.CVDELOAD to the DD statement
DFHRPL.
Note: Several CA View modules are loaded (MVS load) from the CICS STEPLIB or
LINKLIST. Verify that the entire CA View load library is defined in the CICS STEPLIB or is
included in the linklist.
The CICS transactions and programs were previously defined in the MSM configuration
step. Review the following points to determine if they are applicable to your installation.
If you have CICS storage protection activated, the following resource definition online
settings are required:
■ For all transactions
TASKDATALOC=ANY
TASKDATAKEY=CICS
EXECKEY=CICS
Add these table entries to the last phase of the PLT startup list to initialize the subtask
that is used for cross-memory access:
DFHPLT TYPE=ENTRY,PROGRAM=DFHDELIM
DFHPLT TYPE=ENTRY,PROGRAM=EC0CINIT
Add this table entry to the first phase of the PLT shutdown list to be sure that the
subtask that executes as part of the online facility shuts down correctly when CICS shuts
down:
DFHPLT TYPE=ENTRY,PROGRAM=EC0CIEND
DFHPLT TYPE=ENTRY,PROGRAM=DFHDELIM
Specify a value for the DESTID parameter in the EBCXMOPT macro in the EC0XMCTR
module and corresponding DCT entries. This value defines a transient data destination
for messages issued by the subtask.
Note: Specify a blank for DESTID to suppress the generation of informational messages
from the subtask.
If you want to invoke CA View from a user-written CICS menu system, and then return
to that menu system when you exit from CA View, do the following:
Invoke CA View from the menu system using the following CICS command:
where:
TRANSID(VIEW transaction-id)
Specifies the CA View transaction ID.
TERMID(EIBTRMID)
Specifies the terminal that a CA View transaction will communicate with.
FROM(data-area)
Specifies the optional variable length character string.
The format of the data-area parameter is:
tran,mode,sysoutid,jobnum,code
where:
tran
Specifies the return menu CICS transaction to be started when CA View finishes
mode
Specifies the CA View user mode (ALL, SAR, SARO, EXP, EXPO) for this user
If mode is not specified, the last mode that the user was in is used.
sysoutid
Specifies the SYSOUT ID or generic ID (with *) to be selected
jobnum
Specifies the JES2 job number of the SYSOUT ID to be selected
code
Indicates the selection code to be used (S, Pn, Vn, Jn, and so on)
If code is not specified, the user is presented with the SYSOUT Selection List.
Note: None of the data-area parameters is required.
LENGTH (4)
Specifies the number of bytes in the data field being passed.
When CA View receives control, it retrieves the four-byte return transaction ID and
saves it from iteration to iteration.
If the retrieve fails, CA View retains the information that it was started directly from a
terminal, not a menu system.
If there is a saved transaction ID, the product starts the return transaction before it exits
to CICS by issuing:
CICS Notes
The cross-memory CICS access involves two different address spaces: the CICS address
spaces and the XMS address spaces.
The user's CICS transactions and the cross memory support subtask reside in these
address spaces.
■ If multiple CICS regions are used to access CA View, each CICS region will have an
XMS support subtask
■ If you are using CICS/MRO, CA View normally runs in an AOR (application region).
The EBCXMTRN macro also contains options for the specific database as follows:
■ SUBSYS= parameter can be used to route the CA View transaction to an alternate
XMS subsystem ID. The SUBSYS= of the cross-memory task must match the
SUBSYS= parameter specified in the EBCXMCTR table entry.
■ TRANID=parameter specifies the CA View transaction identifier for CICS.
■ RECON=YES can be used to allow reconnection (after a CICS terminal error) at the
point of exit.
Note: Do not specify RECON=YES if you use a multi-session manager that assigns LU
names from a pool of names. Coding RECON=YES under these conditions could
allow you to be connected to another user's session.
For more information, see Multi-Session Managers later in this chapter.
■ TIMEOUT= specifies how long CICS is to wait for the XMS session to respond after
the user enters input, in seconds.
We recommend as high a value as possible but not less than 240 (4 minutes).
Until the XMS subtask is started, expect the transactions referencing EC0XMCIC to
terminate with an error message that indicates that the XMS subtask is not active
Note:
■ When the CICS region is terminated, the DFHPLTSD definition is to be used to
terminate the XMS subtask.
You can manually terminate the XMS subtask through a user application program
that links the EC0CIEND, or you can use the optional transaction defined for
EC0CIEND for manual termination.
■ If you want to terminate the XMS subtask manually, we recommend that you use
the DFHPLTSD entry to terminate the XMS subtask. This definition is needed to
clean up linkages to the XMS address spaces.
■ To prevent users from shutting down the XMS subtask, secure the optional
transaction for program EC0CIEND.
Multi-session manager products, for example CA TPX Session Management (CA TPX),
can be configured to assign an LU name to a user's terminal at the time the user selects
the CICS application.
Important! This assignment means that a user can enter CICS each time with a different
terminal ID which can cause problems for CA View application.
For example: If a user uses a multi-session manager to end a session, or shuts the PC
down, CA View does not know that the user has left. Another user might select CICS, be
assigned to the same LU name as the previous user, and enter CA View with the same
terminal ID as the previous user. CA View believes that there are two active users on the
same terminal.
To prevent this situation, you can add a small amount of code to the CICS Autoinstall
Control Program.
Note: The default name of this program is DFHZATDX and its source is located in
SDFHSAMP.
If you are not a CICS systems programmer, discuss this situation with the person in your
company who is responsible for CICS support and maintenance.
The sample code that follows shows how to clear an active user from the CA View
application at terminal deletion time. Insert this code in your Autoinstall Control
Program.
LOAD EP=EC0XSLOC,ERRET=RETURN
LR R6,R0 GET EBCXSLOC ADDRESS
ICM R8,B'1111',0(R6) ADDR OF MAIN CONTROL BLOCK
BZ RETURN GET OUT IF NONE
LA R7,4(,R8) LOOK LIKE FIRST USER BLOCK
XSU_LOOP DS OH
ICM R7,B'1111',8(R7) USER BLOCK ADDR
BZ RETURN GET OUT IF DONE
CLC DELETE_TERM_ID,104(R7) FOR THIS TERMINAL?
BNE XSU_LOOP NO
TM 120(R7),X'01' ACTIVE ENTRY?
BZ XSU_LOOP NO
OI 120(R7),X'02' SHOW SESSION DONE
B RETURN EXIT PROGRAM
If you implement this change to the terminal deletion section of the Autoinstall Control
Program, you can prevent the problems caused by the methods that were used to leave
the CA View application.
Important! This facility uses the cross-memory feature distributed with CA View and
must be installed with that feature.
Note: For more information about cross-memory, see the topic Installing Cross-Memory
Services in this chapter.
Installation Steps
This list summarizes the steps required to install the IMS Online Retrieval Option.
Detailed instructions are in the sections that follow.
1. Code the IMS TRANSACT, PSB, and APPLCTN macros.
2. Run the PSB, ACB, and SYSGEN procedures.
3. Load EC0IMSUX Modules
Move load modules to IMSVS.PGMLIB.
Important! All JCL and macros provided in this section are provided as general
examples only and must be modified according for your site's systems and standards.
Use the examples in this section as a guide as you code these macros, and implement
them in your IMS system.
■ (IMS) TRANSACT macro
■ PSB macros
■ APPLCTN macro
TRANSACT Macro
One or more transactions must be defined for the IMS online retrieval program
SARXMIMS. Normally, only one transaction identifier is defined, although you can define
multiple transactions.
TRANSACT NAME=EC0XMIMS,SPA=(18)
PSB Macros
PCB TYPE=TP,ALTRESP=YES,MODIFY=YES
PSBGEN PSBNAME=EC0XMIMS,LANG=ASSEM,COMPAT=YES
APPLCTN Macro
APPLCTN PSB=EC0XMIMS
Use the macros created in Step 1. Code the Macros as input for the following
procedures:
PSBGEN
ACBGEN
IMS SYSGEN
For example, a 3278-5 with a 27 x 132 screen size would be (27 * 132 * 1.5) = 5346.
If the SEGSIZE= is too small, the terminal user will get an RC= "A6" message
indicating that a message insert failed.
The EBCXMTRN macro also contains options for the specific database as follows:
■ SUBSYS= parameter of the cross-memory task
The parameter must match the SUBSYS= parameter specified in the EBCXMCTR
table entry.
■ RECON=YES can be used to allow reconnection (after an ISPF terminal error) at the
point of exit..
■ TIMEOUT= specifies how long ISPF is to wait for the XMS session to respond after
the user enters input, in seconds.
We recommend a value as high as possible but not less than 240 (4 minutes).
To abort the XMS session and return the user to ISPF or the TSO command prompt,
press the ATTN key.
Note:
■ The SUBMAX= parameter controls the number of user connections, not the
USERMAX= parameter. USERMAX= only applies when you are using the subtask
with the CICS interface.
■ For more information about the IMS online interface, see the chapter "Online
Interface Administration" in the Reference Guide.
To control screen size manually, use these operands. The SNA query command can also
be used to determine the device characteristics.
This section also describes the online interface options, the cross-memory drivers, and
how to install the online interfaces, including these topics:
■ Online and cross-memory interfaces
■ Cross-memory drivers for ISPF, TSO, and CA Roscoe interfaces
■ Installation of these options:
– ISPF online retrieval option
– TSO online retrieval option
– CA Roscoe online retrieval option
– Cross-memory services
– ISPF/cross-memory online retrieval option
– TSO/cross-memory online retrieval option
– VTAM online retrieval option
– CA Roscoe/cross-memory online retrieval option
– CICS pseudo-conversational option
– IMS online retrieval option
Online Interfaces
The following table lists the online interfaces, whether cross-memory services (XMS)
must be installed and any special advantages of using the interface.
The parameters in the startup procedure for the cross-memory task allow you to
control:
■ The maximum number of users allowed on the system
■ Whether to cancel users when they are inactive for a specified time (CANCEL and
LONGWAIT)
Note: For information about startup parameters, see Installing Cross-Memory Services
later in this chapter.
The operator commands available to modify the cross-memory task allow you to:
■ Cancel users
■ Suspend additional logons
■ List online usage statistics
■ Modify selected cross-memory startup JCL parameters
Note: For more information about online interface, see the chapter "Online Interface
Administration" in the Reference Guide.
You can also run multiple versions of the online interfaces simultaneously.
Restrictions
These restrictions apply when you execute the program using the cross-memory drivers
for TSO, ISPF, and CA Roscoe:
■ TSO SUBMIT is not used. The SUBMIT occurs from the connected cross memory
region.
■ Direct reprints from the user have the JES banner pages of the cross memory
region. The internal system banner page can be used to check the user requesting
the reprint.
User Exits
User exits run in the cross-memory region and do not have access to TSO or CA Roscoe
allocations.
Note: For more information about the ISPF Online Retrieval Option, see the chapter
"Online Interface Administration" in the Reference Guide.
Installation Steps
This list summarizes the steps to install the ISPF online retrieval option. Detailed
instructions are in the sections that follow.
1. (Optional) Add STEPLIB DD statements to the TSO LOGON procedures if the load
modules are not in a linklist library.
2. (Not SPF) Add the panel and command table libraries to the TSO logon procedures.
3. (Optional) Add the mount attribute to the TSO user IDs.
4. (Optional) Modify an ISPF Selection Menu to Select Online Retrieval feature.
The action you take in this step depends on what you did during the base-product
installation—specifically, did you:
■ Authorize the program load library
or
■ Copy the modules to a system authorized library
If the CA View load modules were not copied to one of the libraries in the linklist,
proceed with this step; otherwise go to the next step.
If your system runs CA View under ISPF, proceed with this step.
Step 3: (Optional) Add the Mount Attribute to the TSO User IDs
If you want to add the mount attribute to your TSO user IDs, proceed with this step;
otherwise, go to the next step.
Assign the mount attribute to all TSO users who are authorized to browse SYSOUT
directly from an archival tape.
Use the TSO ACCOUNT command as follows to assign the mount attribute:
ACCOUNT
C (userid) MOUNT
END
Note: TSO users do not need the MOUNT attribute to access reports through the
Expanded Access Tape Server (EAS), because the tape is mounted by the EAS started
task and not the user's TSO session.
If you want to add a selection code for the online retrieval feature to one of the ISPF
selection menus, proceed with this step; otherwise, your detailed instructions for ISPF
are complete.
Use the value next to the NAME parameter on your Initialization Parameter Worksheet
for PARM(high-level-database-name).
Note: Adding a selection code allows you to select the online retrieval feature in the
same way you would select other ISPF options.
Panel Libraries
The names of the panel libraries vary from site to site and for the different releases of
ISPF. These panel libraries are allocated to the ISPPLIB DD statement under TSO.
Be aware that some installations do not allow direct modifications of IBM panels and
libraries. In this case, you can place the modified panels in user or site-specific libraries
and concatenate them ahead of the IBM libraries.
Ask your system administrator for the specific ISPF panel library that applies to your site
and contains the panel ISR@PRIM.
Note: The selection menus shown in the following examples are part of the program
products SPF and ISPF, and are copyrighted by IBM.
Example 1
This example shows you how to add selection code R to the primary option menu
ISR@PRIM for ISPF. Shaded lines identify the inserted lines.
%OPTION ===>_ZCMD +
% +USERID - &ZUSER
% 0 +ISPF PARMS - Specify terminal and user parameters +TIME - &ZTIME
% 1 +BROWSE - Display source data or output listings +TERMINAL - &ZTERM
% 2 +EDIT - Create or change source data +PF KEYS - &ZKEYS
% 3 +UTILITIES - Perform utility functions
% 4 +FOREGROUND - Invoke language processors in foreground
% 5 +BATCH - Submit job for language processing
% 6 +COMMAND - Enter TSO Command, CLIST, or REXX exec
% 7 +DIALOG TEST - Perform dialog testing
% 8 +LM UTILITIES - Perform library administrator utility functions
% C +CHANGES - Display summary of changes for this release
% R +SARSPF - Retrieve SYSOUT
% T +TUTORIAL - Display information about ISPF/PDF
% X +EXIT - Terminate ISPF using log and list defaults
%
+Enter%END+command to terminate ISPF.
)INIT
.HELP = ISR00003
&ZPRIM = YES /* ALWAYS A PRIMARY OPTION MENU */
&ZHTOP = ISR00003 /* TUTORIAL TABLE OF CONTENTS */
&ZHINDEX = ISR91000 /* TUTORIAL INDEX - 1ST PAGE */
)PROC
&ZSEL = TRANS( TRUNC (&ZCMD,'.')
0,'PANEL(ISPOPTA)'
1,'PGM(ISRBRO) PARM(ISRBRO01)'
2,'PGM(ISREDIT) PARM(P,ISREDM01)'
3,'PANEL(ISRUTIL)'
4,'PANEL(ISRFPA)'
5,'PGM(ISRJB1) PARM(ISRJPA) NOCHECK'
6,'PGM(ISRPTC)'
7,'PGM(ISPYXDR) PARM(ISR) NOCHECK'
8,'PANEL(ISRLPRIM)'
C,'PGM(ISPTUTOR) PARM(ISR00005)'
R,'PGM(SARSPF) PARM(VIEW.SYSTEM1) NEWAPPL(SAR)'
T,'PGM(ISPTUTOR) PARM(ISR00000)'
' ',' '
X,'EXIT'
*,'?' )
&ZTRAIL = .TRAIL
)END
Note:
■ NEWAPPL(SAR) is required and must be specified as shown previously in this
section.
This parameter is used with the command table library concatenation from Step 3
of the ISPF Installation Instructions.
■ NEWAPPL(SAR) allows CA View to correctly interpret commands and program
function key invocation.
If this parameter is not specified, certain PF keys such as the scroll keys may not
function.
Example 2
This example shows you how to add selection code R to the primary option menu
ISP@PRIM for SPF. Shading identifies the inserted lines.
Example 3
This example shows you how to add selection code 3.R as a sub-option to the utilities
menu ISRUTIL for SPF. Shaded lines identify the inserted lines.
%Option ===>_Z +
%1 +Library Compress or print data set. Print index listing. Print,
+ rename, delete, browse, edit or view members
%2 +Data Set Allocate, rename, delete, catalog, uncatalog, or display
+ information of an entire data set
%3 +Move/Copy Move, or copy members or data sets
%4 +Dslist Print or display (to process) list of data set names.
+ Print or display VTOC information
%5 +Reset Reset statistics for members of ISPF library
%6 +Hardcopy Initiate hardcopy output
%7 +Transfer Download ISPF Client/Server or Transfer data set
%8 +Outlist Display, delete, or print held job output
%9 +Commands Create/change an application command table
%11+Format Format definition for formatted data Edit/Browse
%12+SuperC Compare data sets (Standard Dialog)
%13+SuperCE Compare data sets Extended (Standard Dialog)
%14+Search-For Search data sets for strings of data (Standard Dialog)
%15+Search-ForE Search data sets for strings of data Extended (Extended Dialog)
%R +SARSPF Retrieve SYSOUT
)INIT
.ZVARS = '(ZCMD)'
.HELP = ISR30000
.ATTR (ZCMD) = 'PADC(USER)'
)PROC
&ZCMDWRK = TRUNC(&ZCMD,'.')
&ZTRAIL=.TRAIL
&ZSEL = TRANS (TRUNC (&ZCMD,'.')
1,'PGM(ISRUDA) PARM(ISRUDA1) SCRNAME(LIBUTIL)'
2,'PGM(ISRUDA) PARM(ISRUDA2) SCRNAME(DSUTIL)'
3,'PGM(ISRUMC) SCRNAME(MCOPY)'
4,'PGM(ISRUDL) PARM(ISRUDLP) SCRNAME(DSLIST)'
5,'PGM(ISRURS) SCRNAME(RESET)'
6,'PGM(ISRUHC) SCRNAME(HARDCOPY)'
7,'PANEL(ISPUDL) SCRNAME(DOWNLOAD)'
8,'PGM(ISRUOLP) SCRNAME(OUTLIST)'
9,'PANEL(ISPUCMA) ADDPOP SCRNAME(CMDTABLE)'
11,'PGM(ISRFMT) SCRNAME(FORMAT)'
12,'PGM(ISRSSM) SCRNAME(SUPERC)'
13,'PGM(ISRSEPRM) SCRNAME(SUPERCE) NOCHECK'
14,'PGM(ISRSFM) SCRNAME(SRCHFOR)'
15,'PGM(ISRSEPRM) PARM(S4) SCRNAME(SRCHFORE) NOCHECK'
R,'PGM(SARSPF) PARM(VIEW.SYSTEM1)'
' ',' '
*,'?' )
)END
Note: For more information about the TSO Online Retrieval option, see the chapter
"Online Interface Administration" in the Reference Guide.
1. (Optional) Add STEPLIB DD statements to the TSO LOGON procedures if the load
modules are not in a linklist library.
2. (Optional) Add the mount attribute to the TSO user IDs.
The action you take in this step depends on what you did during the base-product
installation—specifically, did you:
■ Authorize the program load library
or
■ Copy the modules to a system authorized library
If the load modules were not copied to one of the libraries in the linklist:
■ Add a STEPLIB DD statement (for the library containing the load modules) to the
TSO LOGON procedures for those TSO users who are to use the native TSO online
retrieval option.
If the load modules were copied to one of the libraries in the linklist, no STEPLIB DD
statements are required.
Note: If you have CA View, the CA View load modules either must also be in the linklist,
or placed in a STEPLIB statement with this step.
Assign the mount attribute to all TSO user IDs authorized to browse SYSOUT directly
from an archival tape. Use the TSO ACCOUNT command to assign the mount attribute as
follows:
ACCOUNT
C (userid) MOUNT
END
Note: TSO users do not need the MOUNT attribute to access reports through the
Expanded Access Tape Server (EAS), because the tape is mounted by the EAS started
task and not the user's TSO session.
If the load modules were not copied to a linklist library, concatenate the library that
contains the load modules to the ETSOLIB DD statement in the CA Roscoe startup JCL.
Note: If you have CA Deliver, the CA Deliver load modules must also be either in the
linklist or in an ETSOLIB statement with this step.
Columns Contents
1–8 SARROS
9 Blank
10–12 Number of users allowed to access CA View at one time
13 Blank
14–17 CPU time slice
Use 9999 to prevent premature termination.
18 Blank
19–24 Maximum memory (in KB) below the 16 MB line
This value can vary depending on size of database and other factors
(0001000 should be adequate).
25 Blank
26–31 Maximum memory (in KB) below the line that CA View can acquire at
one time; use 999999 so that GETMAINs will not be limited
32 Blank
Columns Contents
33–38 Maximum memory (in KB) above the 16 MB line
This value can vary depending on features used (000512 should be
adequate).
39 Blank
40–45 Maximum memory (in KB) above the line that CA View can acquire at
one time
Use 999999 so that GETMAINs will not be limited.
46 Blank
47 N – Suppress dump
48 Blank
49 Y – Application authorized to issue MODESET SVC
50 Blank
51-52 CP to call SARROS as a TSO command processor
53-255 Ignore
Note: For more information about how to invoke the CA Roscoe online retrieval facility,
see the chapter "Online Interface Administration" in the Reference Guide.
This list summarizes the steps to install the cross-memory services. Detailed instructions
are in the sections that follow.
1. (Optional) Add the start procedure to PROCLIB for the cross-memory online task.
2. (Optional) Modify, assemble, and link edit the EC0XMCTR module.
3. Define security requirements.
The VTAM and XMS (cross-memory services) interfaces operate in one or more
cross-memory online regions.
For example, if you specified a REGION of 120 MB, you could specify:
USERMAX=200
If more users are needed, multiple regions can be started under the same SUBSYS=
value and will be chained together.
Note: The REGION ID specified in the parameters must be different for each region, and
if VTAM interface is used, a different SARAPPL= name will be needed for each region.
This table lists the optional and required parameters for each interface.
Note: The numbers next to the interface values refer to note references.
– The OVERRIDE parameter does not have any sub-parameters and it is coded as
is in the execute statement PARM field.
– If this parameter is coded in the SYSIN data set, error message "EBCDRV99
OVERRIDE KEYWORD NOT ALLOWED IN SYSIN STATEMENTS - RUN ENDED
U0016" is going to be displayed in the XMS job log and XMS will terminate with
a return code of 16.
Step 1: Add the Start Procedure for the Cross-Memory Online Task
Add this start-procedure JCL for the cross-memory online retrieval task as member
CBROSDRV to SYS1.PROCLIB. Sample JCL for this PROC is provided in member
CBROSDRV of CAI.CVDEPROC.
The REGIONID parameter is positional and must be specified in the PARM= statement of
the cross-memory task JCL.
You can use SYSIN DD statements to specify the other cross-memory parameters.
If you are going to run multiple regions, specify these parameters in the PARM=
statement:
SUBSYS=
SARAPPL=
XMS=
You can specify the rest of the parameters with SYSIN DD statements. If you place the
SYSIN statements in a PDS member, you can alter the parameters without shutting
down the cross-memory region. Be aware that the parameters do not take effect until
the next time the region is shut down and restarted.
Note:
■ SYSIN parameters for cross memory services must start in column #1. Any
parameter that does not begin in column #1 is treated as a comment and is ignored.
■ The OVERRIDE parameter cannot be coded in the SYSIN data set.
– If the OVERRIDE parameter is coded in the execute statement PARM field, a
duplicate parameter in the PARM field and the SYSIN data set will be set to the
value specified in the PARM field parameter.
– If the OVERRIDE parameter is not coded in the execute statement PARM field, a
duplicate parameter in the PARM field and the SYSIN data set will be set to the
value specified in the SYSIN.
More information:
XMSSYS01 (in the PARM statement) specifies the one- to eight-character REGIONID. The
REGIONID is positional—it must be the first value of the PARM= statement.
This value is used to define separate cross-memory regions attached to one MVS
subsystem (specified by the SUBSYS parameter).
Note: Each separate SARXMS region has its own REGIONID. We suggest using the PROC
name of the cross-memory-started task.
CANCEL=YES|NO
Indicates one of the following:
– CANCEL=YES specifies that a user who is inactive (no commands entered) for
the time specified by the LONGWAIT parameter will be canceled, and the
session will be terminated. With CANCEL=YES, all users are automatically
canceled if the region is shut down by an operator command.
– CANCEL=NO specifies that the connection is not to be canceled, and the user
status changes to LONGWAIT.
Default: NO
LGNFMT=n
Specifies the format of the data parameter when logging on to a VTAM region
where n is a digit (1 through 3), as follows:
1 database//userid/password/newpass
2 userID/password/newpass/database/mode
3 database/mode
Default: 1.
LGNPROP=YES|NO
Indicates whether the CA View user ID is to be passed to MVS for propagation
during submit processing.
This parameter is only valid if LGNSEC=YES is specified.
Default: YES.
LGNSEC=YES|NO|PASSWORD|YESP
Indicates whether there will be RACROUTE security checking.
LGNSEC must be YES or YESP if you are accessing a database that has the CA View
initialization parameter SECURITY=EXTERNAL specified.
Modifications to default logon exit (SARUSXUX) is not required to implement
external security. This exit is only provided so that you can customize the exit to
provide any necessary functionality.
For example, to access external security packages directly, without SAF, you must
modify and install the SARUSXUX user exit.
These values for LGNSEC are effective when the default exits are implemented:
Value
Result
YES
External security checking is performed using SAF calls.
External security verifies userid only for all cross-memory interfaces (with no
interruption to the user).
A panel is presented to the user to verify userid and password.
Note: This panel is only presented when the user interface does not
automatically send the userid to the XMS region.
Because the password is not forwarded, RACF or CA ACF2R Security (eTrust
CA-ACF2) requires additional specifications. For RACF or CA ACF2, see
Bypassing Password Verification in the chapter "Security" in the Reference
Guide for implementation instructions.
NO
No SAF call to external security is performed.
The user ID is checked internally against CA View definitions.
If no match is found, CA View might or might not dynamically create a user ID
depending on the value of your DEFMODE initialization parameter.
Review your DEFMODE values to be sure that they are appropriate.
PASSWORD
No call to external security is performed.
Internally, userid and password are verified.
YESP
External security checking is performed using SAF calls.
External security verifies userid and password for all cross-memory interfaces
(with no interruption to the user).
A panel is presented to the user to verify the userid and password. This panel is
only presented when the user interface does not automatically send the userid
and password to the XMS region.
Default: NO.
LONGWAIT=nn
Specifies the number of minutes of inactivity (no commands entered) before a
user's session is terminated.
You must specify VTAMSAA=NO or these terminals are not able to log onto the
SARVTAM interface.
VTAMSAA=NO causes more overhead in logging on terminals than can be queried,
and is only to be used when required.
XMS=YES|NO
Indicates whether cross-memory users are allowed to sign on to the region.
Set XMS=NO if this is a VTAM only region, and cross-memory is not to be
supported.
Note: If XMS=NO, be sure that there is a VTAM ACB name coded in the SARAPPL=
parameter.
Default: YES.
XMSSUB=YES|NO
XMSSUB=YES is required for ISPF cross-memory, TSO cross-memory, and CA Roscoe
cross-memory sessions
All other interface users are to be set XMSSUB=NO.
Default: NO.
The optional SARLOG DD statement is used to specify where to write the log of user
subtask messages.
The optional SYSPRINT DD statement is used to specify where to write the log of
cross-memory (SARXMS) messages.
EBCUDUMP DD Statement
This output is critical to resolving SARXMS abends and should be submitted to Technical
Support with the region or task dump created with an ABEND.
Note:
■ On ABEND Output, only regular MVS dump output should be collected. Output from
dump compression and analysis programs is not helpful to technical support—you
might be required to recreate the dump.
■ Acceptable types include SYSUDUMP, SYSMDUMP, or SYSABEND output, in
print-record format. IPCS/SVC dumps and CICS transaction or region dumps are also
acceptable, but must be formatted for printing before they are placed on the tape.
■ The RMOXMS region uses the operator facility to abort a user's task for various
problems. These problems might be a LONGWAIT time out, a VTAM I/O error, or a
detected internal error, which appear in the log followed by a U0522 ABEND of the
user subtask. No dump is generated.
The action you take in this step depends on what you did during the base-product
installation. Specifically, did you:
■ Authorize the program load library
or
■ Copy the modules to a system authorized library
The EC0XMCTR module defines the relationship between a transaction identifier and
the database, and session attributes. Also, the execution options for the cross-memory
subtask system are also defined in this module. All interfaces except VTAM require the
EC0XMCTR table.
The first statement defines the system options and has this format:
EBCXMOPT DESTID=dest,SRVTRAN=transaction,MSGLVL=level, X
DESTID=CICS-dest,LOGWAIT=timout-val,SGNCNT=nn, X
USERMAX=user-number,WAITCNT=maxcount
The next group of statements is for each transaction and or database to be accessed;
they have this format:
EBCXMTRN TYPE=SAR, X
TRANID=tranid,INDEX=high-level-name,TIMEOUT=sec, X
SUBSYS=subsysid,RECON=yes|no, X
MSGSUPP=yes|no
EBCXMTRN TYPE=GEN
END
Indicates the amount of time a user is to wait to log on before the user's session
times out.
Default: 200 (2 minutes, 00 seconds).
SUBMAX=nn
Indicates the total number of user control blocks that are allocated when a
cross-memory subtask (other than CICS) is initialized.
Default: 500.
USERMAX=nn
Indicates the number of user control blocks that are allocated when CICS is
initialized.
Default: 500.
SGNCNT=nn
Controls the number of logon control blocks allocated. These blocks are only used
during the logon process. They are then reused and made available to other users
attempting to log on.
When you increase the SGNCNT value, be aware that 256 bytes of ECSA are needed
each time SGNCNT is increased by 1. Typically, 5 logon blocks are enough, but the
value cannot exceed 50.
Default: 5.
WAITCNT=nnn
Indicates the number of sessions for which the subtask can wait.
Default: 256.
IMSMENU
Indicates the IMS/DC conversational menu to transfer to when CA View terminates.
If this value is not specified, the transaction in the SPA will be set to blanks.
IMSSPA
Indicates the size of the IMS/DC SPA.
The SPA size must be at least 18, but cannot exceed 100.
Default: 18.
RECON=YES|NO
Indicates whether a user can reconnect to a lost session.
Default: NO.
MSGSUPP=YES|NO
Indicates whether a termination message is displayed when a session is terminated
by a user.
Default: NO. This does not suppress messages generated from abnormal
termination.
The databases for the two systems have high-level names of VIEW.SYSTEM1 and
VIEW.SYSTEM2. A user must enter transaction identifier VW1 for the first system and
VW2 for the second. The source for program EC0XMCTR contains the following control
statements:
EBCXMOPT MSGLVL=CRIT,USERMAX=50
EBCXMTRN TRANID=VW1,INDEX=VIEW.SYSTEM1
EBCXMTRN TRANID=VW2,INDEX=VIEW.SYSTEM2
EBCXMTRN TYPE=GEN
END
EBCXMTRN TYPE=GEN must be the last statement before the END. This statement
causes the EBCXMCTR CSECT to be generated.
Sample JCL
Sample JCL for this job is provided in member BROSXCTR of CAI.CVDEJCL. This job
provides an SMP/E USERMOD that assembles and links an installation-dependent
version of EC0XMCTR.
The EC0XMCTR table defines the way linkages between the online drivers and the XMS
region are established. Some of the parameters are used only in specific environments
and others are used in all environments.
You must:
■ Assemble the table during installation to define the relationship between CA View
and CA Deliver database high-level qualifiers and the session options that are to be
used
■ Provide the information that is used to build the XMS database table.
Note: Be aware if both CA View and CA Deliver are installed and the CA View interface is
doing any access to an associated DLVR database, the associated DLVR database needs
to be added as an entry in the EC0XMCTR table.
The numbers in parentheses are explained in the notes section that follows the table.
Note: The numbers next to the table values refer to note references.
You can define security requirements for CA Top Secret Security (eTrust CA Top Secret):
Be sure that the correct PGMname is defined for the new facility, where PGMname
is either the first three characters or all the eight characters of the program name
that is to make security calls (EC0 or EC0DRV).
2. Create region ACID for the facility:
TSS CRE(viewxms) pass(nopw,0) type(user) dept(dept)
Note: In the JCL for the cross-memory services task, the parameter XMSSUB must be set
to YES.
Installation Steps
The following steps are required to install the ISPF/cross-memory online retrieval
option. Each step is explained in detail later in the sections that follow.
1. (Optional) Add STEPLIB DD Statements to the TSO LOGON procedures if the load
modules were not copied to a linklist library.
2. Add the panel and command table libraries to the TSO logon procedures. (For ISPF
only, not for SPF.)
3. (Optional) Modify an SPF selection menu to select the online retrieval feature.
Note: For more information about the ISPF/cross memory online retrieval option, see
the chapter "Online Interface Administration" in the Reference Guide.
The action you take in this step depends on what you did during the base-product
installation—specifically, did you:
■ Authorize the program load library
or
■ Copy the modules to a system authorized library
If the CA View load modules were not copied to one of the libraries in the linklist,
proceed with this step; otherwise go to the next step.
For this interface, the libraries do not have to be APF authorized. Authorization is
provided in the cross-memory installation. Multiple versions of this online interface can
coexist in one TSO library concatenation.
Note: If multiple versions are going to be running simultaneously, or you also want to
run a previous version of SARSPF or SARTSO, concatenate the load library you want
SARSPF or SARTSO to use first.
More information:
If you are going to run CA View under ISPF, proceed with this step. For Version 3 or
higher, both the command table library and the panel library are used.
To add panel and command table libraries to the TSO LOGON procedure:
■ Concatenate the command table library CAI.CVDETBL0 to DD statement ISPTLIB.
■ Concatenate the panel library CAI.CVDEPNL0 to DD statement ISPPLIB.
Note: If you also plan to use SARSPF (the ISPF interface), and multiple versions of CA
View, concatenate CAI.CVDETBL0 first. Use the CAI.CVDETBL0 from the most current
release.
If you want to add a selection code to one of the ISPF selection menus for the online
retrieval feature, proceed with this step; otherwise, your ISPF detailed instructions are
complete.
Note: If you add a selection code, you can select the online retrieval feature in the same
way you select other ISPF options.
Use the value next to the NAME parameter on your Initialization Parameter Worksheet
for PARM(high-level-database-name).
Panel Libraries
The names of the panel libraries vary from site to site and for the different releases of
ISPF. These panel libraries are allocated to the ISPPLIB DD statement under TSO.
Be aware that some installations do not allow direct modifications of IBM panels and
libraries. In this case, you can place the modified panels in user or site-specific libraries
and concatenate them ahead of the IBM libraries.
Ask your system administrator for the specific ISPF panel library that applies to your site
and contains the panel ISR@PRIM.
Note: The selection menus shown in the following examples are part of the program
products SPF and ISPF, and are copyrighted by IBM.
Example 1
The following example shows you how to add selection code R to the primary option
menu ISR@PRIM for ISPF. The bright, offset text identifies the inserted lines.
%OPTION ===>_ZCMD +
% +USERID - &ZUSER
% 0 +ISPF PARMS - Specify terminal and user parameters +TIME - &ZTIME
% 1 +BROWSE - Display source data or output listings +TERMINAL - &ZTERM
% 2 +EDIT - Create or change source data +PF KEYS - &ZKEYS
% 3 +UTILITIES - Perform utility functions
% 4 +FOREGROUND - Invoke language processors in foreground
% 5 +BATCH - Submit job for language processing
% 6 +COMMAND - Enter TSO Command, CLIST, or REXX exec
% 7 +DIALOG TEST - Perform dialog testing
% 8 +LM UTILITIES- Perform library administrator utility functions
% C +CHANGES - Display summary of changes for this release
% R +SARSPF - Retrieve SYSOUT
% T +TUTORIAL - Display information about ISPF/PDF
% X +EXIT - Terminate ISPF using log and list defaults
%
+Enter%END+command to terminate ISPF.
)INIT
.HELP = ISR00003
&ZPRIM = YES /* ALWAYS A PRIMARY OPTION MENU */
&ZHTOP = ISR00003 /* TUTORIAL TABLE OF CONTENTS */
&ZHINDEX = ISR91000 /* TUTORIAL INDEX - 1ST PAGE */
)PROC
&ZSEL = TRANS( TRUNC (&ZCMD,'.')
0,'PANEL(ISPOPTA)'
1,'PGM(ISRBRO) PARM(ISRBRO01)'
2,'PGM(ISREDIT) PARM(P,ISREDM01)'
3,'PANEL(ISRUTIL)'
4,'PANEL(ISRFPA)'
5,'PGM(ISRJB1) PARM(ISRJPA) NOCHECK'
6,'PGM(ISRPTC)'
7,'PGM(ISPYXDR) PARM(ISR) NOCHECK'
8,'PANEL(ISRLPRIM)'
C,'PGM(ISPTUTOR) PARM(ISR00005)'
R,'PGM(EC0XMSPF) PARM(VIEW.SYSTEM1) NEWAPPL(SAR)'
T,'PGM(ISPTUTOR) PARM(ISR00000)'
' ',' '
X,'EXIT'
*,'?' )
&ZTRAIL = .TRAIL
)END
Note:
■ NEWAPPL(SAR) is required and must be specified as shown previously in this
section.
This parameter is used with the command table library concatenation from Step 3
of the ISPF Installation Instructions.
■ NEWAPPL(SAR) allows CA View to correctly interpret commands and program
function key invocation.
If this parameter is not specified, certain PF keys such as the scroll keys may not
function.
Example 2
The following example shows you how to add selection code R to the primary option
menu ISP@PRIM for SPF. Shading identifies the inserted lines.
%OPTION ===>_OPT
% +USERID -
% 0 +ISPF PARMS - SPECIFY TERMINAL AND USER PARAMETERS +TIME -
% 1 +BROWSE - DISPLAY SOURCE DATA OR OUTPUT LISTINGS +TERMINAL –
% 2 +EDIT - CREATE OR CHANGE SOURCE DATA +PF KEYS -
% 3 +UTILITIES - PERFORM SPF UTILITY FUNCTIONS
% 4 +FOREGROUND - COMPILE, ASSEMBLE, OR DEBUG
% 5 +BACKGROUND - COMPILE, ASSEMBLE, OR LINK EDIT
% 6 +COMMAND - ENTER TSO COMMAND OR CLIST
% 7 +SUPPORT - TEST DIALOG OR CONVERT MENU/MESSAGE FORMATS
% 8 +LM UTILITIES- PERFORM LIBRARY ADMINISTRATOR UTILITY FUNCTIONS
% R +SARSPF - RETRIEVE SYSOUT
% T +TUTORIAL - DISPLAY INFORMATION ABOUT SPF
% X +EXIT - TERMINATE SPF USING LIST/LOG DEFAULTS
%
+PRESS%END KEY TO TERMINATE SPF+
%
)INIT
.HELP = TTUTOR
&ZHTOP = TTUTOR /* TUTORIAL TABLE OF CONTENTS */
&ZHINDEX = TINDEX /* TUTORIAL INDEX - 1ST PAGE */
)PROC
&ZSEL = TRANS( TRUNC (&OPT,'.')
0,'PANEL(ISPOPT)'
1,'PGM(ISRBRO)'
2,'PGM(ISPEDIT)'
3,'PANEL(ISPUTIL)'
4,'PANEL(ISPFORA)'
5,'PANEL(ISRJOB)'
6,'PGM(ISPTSO)'
7,'PANEL(ISPOTAC)'
R,'PGM(EC0XMSPF) PARM(VIEW.SYSTEM1)'
T,'PGM(ISPTUTOR) PARM(T)'
' ',' '
X,'EXIT'
*,'?' )
)END
Example 3
This example shows you how to add selection code 3.R as a sub-option to the utilities
menu ISPUTIL for ISPF. Shading identifies the inserted lines.
%OPTION ===>_OPT +
% +
% 1 +LIBRARY LIBRARY UTILITY:
+ PRINT INDEX LISTING OR ENTIRE DATASET
+ PRINT, RENAME, DELETE, OR BROWSE MEMBERS
+ COMPRESS DATASET
% 2 +DATASET DATASET UTILITY:
+ DISPLAY DATASET INFORMATION
+ ALLOCATE, RENAME, OR DELETE ENTIRE DATASET
+ CATALOG OR UNCATALOG DATASET
% 3 +MOVE/COPY MOVE OR COPY MEMBERS OR DATASETS
% 4 +CATALOG CATALOG MANAGEMENT:
+ DISPLAY OR PRINT CATALOG ENTRIES
+ INITIALIZE OR DELETE USER CATALOG ALIAS
% 5 +RESET RESET STATISTICS FOR MEMBERS OF SPF LIBRARY
% 6 +HARDCOPY INITIATE HARDCOPY OUTPUT
% 7 +VTOC DISPLAY OR PRINT VTOC ENTRIES FOR A DASD VOLUME
% 8 +OUTLIST DISPLAY, DELETE, OR PRINT HELD JOB OUTPUT
% 9 +SCRIPT/VS FORMAT,DISPLAY, AND OPTIONALLY PRINT SCRIPT TEXT
% R +SARSPF RETRIEVE SYSOUT
)INIT
.HELP = TU
)PROC
&SEL = TRANS( TRUNC (&OPT,'.')
1,'PGM(ISPUDA) PARM(UDA1)'
2,'PGM(ISPUDA) PARM(UDA1)'
3,'PGM(ISPUMC)'
4,'PGM(ISPUCA)'
5,'PGM(ISPURS)'
6,'PGM(ISPUHC)'
7,'PGM(ISPUVT)'
8,'PGM(ISPUOL) PARM(UOL01)'
9,'PGM(ISPUSC) PARM(SCRPTA)'
R,'PGM(EC0XMSPF) PARM(VIEW.SYSTEM1)'
' ',' '
*,'?' )
)END
The EBCXMTRN macro also contains options for the specific database as follows:
■ SUBSYS= parameter of the cross-memory task must match the SUBSYS= parameter
specified in the EBCXMCTR table entry.
■ RECON=YES can be used to allow reconnection (after an ISPF terminal error) at the
point of exit.
■ TIMEOUT= specifies how long ISPF waits for the XMS session to respond after the
user enters input, in seconds.
We recommend as high a value as possible but not less than 240 (4 minutes).
To abort the XMS session and return the user to ISPF or the TSO command prompt,
press the ATTN key.
Note: The SUBMAX= parameter controls the number of user connections, not the
USERMAX= parameter. USERMAX= only applies when you are using the subtask with the
CICS interface.
Note: The parameter XMSSUB must be set to YES in the JCL for the cross-memory
services task.
Installation Steps
The following steps are required to install the TSO/cross-memory online retrieval
option. Each step is explained in detail in the sections that follow.
1. (Optional) Add STEPLIB DD Statements to the TSO LOGON procedures if the load
modules were not copied to a linklist library.
2. (Optional) Create user CLISTs to execute the CA View TSO/XMS driver program.
The action you take in this step depends on what you did during the base-product
installation—specifically, did you:
■ Authorize the program load library
or
■ Copy the modules to a system authorized library
If the CA View load modules were not copied to one of the libraries in the linklist,
proceed with this step; otherwise go to the next step.
To add STEPLIB DD statements (for the library containing the CA View load modules) to
the TSO LOGON procedures, do the following:
■ Add a STEPLIB DD statement for the library that contains the CA View load modules
to the LOGON procedures for those TSO users who are to use the
TSO/Cross-Memory Online Retrieval Option.
For more information about executing the CA View TSOXMS driver program, see the
chapter "Online Interface Administration" in the Reference Guide.
To create user CLISTs to execute the CA View TSOXMS driver program, issue the
following command:
EC0XMTSO highlevel.databasename
Note: For more information about executing the CA View TSOXMS driver program, see
the chapter "Online Interface Administration" in the Reference Guide.
The EBCXMTRN macro also contains options for the specific database as follows:
■ SUBSYS= parameter of the cross-memory task must match the SUBSYS= parameter
specified in the EBCXMCTR table entry.
■ RECON=YES can be used to allow reconnection (after a TSO terminal error) at the
point of exit.
■ TIMEOUT= specifies how long TSO is to wait for the XMS session to respond after
the user enters input, in seconds.
We recommend as high a value as possible but not less than 240 (4 minutes).
To abort the XMS session and return the user to ISPF or the TSO command prompt,
press the ATTN key.
Note: The SUBMAX= parameter controls the number of user connections, not the
USERMAX= parameter. USERMAX= only applies when you are using the subtask with the
CICS interface.
Note: For more information about the cross-memory feature, see the Install Cross
Memory Services section in this chapter.
Installation Steps
The following steps are required to install the VTAM online retrieval option. Each step is
explained in detail in the sections that follow.
1. Define the APPL definition statement to VTAM.
2. (Optional) Create a USS definition table.
* SYS1.VTAMLST(sarmajor)
sarmajor VBUILD TYPE=APPL
sarvtam APPL ACBNAME=sarvtam,AUTH=(PASS,ACQ),EAS=nn
where:
sarmajor
Specifies the application program major node name.
Use the SYS1.VTAMLST member name. The member name must be unique and
must not be the same as the names on the APPL statement.
AUTH=(PASS,ACQ)
Is required when the cross-memory parameter VTAMPASS=YES is used to support
multiple cross-memory regions.
If VTAMPASS=NO, you can specify AUTH=(ACQ). For more information about the
VTAMPASS parameter, see the topic, Add the Start Procedure for the
Cross-Memory Online Task, later in this chapter.
EAS=nn
Specifies the approximate number of concurrent sessions.
sarvtam
Specifies the application program minor node name.
■ This name must be unique within the network domain; it is the APPLID
referenced in the USS definition table or LOGON command.
■ This name is also specified on the cross-memory SARAPPL parameter.
■ If not specified, the network-unique name (the name of the APPL definition
statement) is used.
To simplify the manner in which a user logs on to VTAM online retrieval, you can create
a USS definition table for CA View.
Example
Assume that two CA View systems have been created. The databases for the two
systems have high-level names of VIEW.SYSTEM1 and VIEW.SYSTEM2, and you want a
user to simply enter one of the following to log on to VTAM online retrieval for the
respective systems:
VIEW1
VIEW2
USSTAB
*
* ENTRY FOR VIEW1
*
USSCMD CMD=VIEW1,REP=LOGON,FORMAT=PL1
USSPARM PARM=APPLID,DEFAULT=SARVTAM
USSPARM PARM=LOGMODE
USSPARM PARM=DATA,DEFAULT=VIEW.SYSTEM1
*
* ENTRY FOR VIEW2
*
USSCMD CMD=VIEW2,REP=LOGON,FORMAT=PL1
USSPARM PARM=APPLID,DEFAULT=SARVTAM
USSPARM PARM=LOGMODE
USSPARM PARM=DATA,DEFAULT=VIEW.SYSTEM2
USSEND
Specifying the common VTAM generic resource name in the session request can initiate
VTAM cross-memory sessions to any of the EMAS members.
When you are using the VTAM generic resource name, by default VTAM tries to request
a session with an EMAS member in the same MVS image.
If it is not possible to get the session that was requested, VTAM uses normal load
balancing when passing the session request to one of the active EMAS members.
Installation Steps
The following steps are required to install the CA Roscoe/Cross Memory Online Retrieval
option. Each step is explained in detail in the sections that follow.
1. (Optional) Concatenate the Load Module Library to the ETSOLIB DD statement, if
the load modules were not copied to a linklist library.
2. Add the control statement for the SARROS command processor to the Eligible
Program List (EPL).
3. Invoke CA Roscoe/Cross Memory Online Retrieval.
If the load modules were not copied to a linklist library, concatenate the library that
contains the load modules to the ETSOLIB DD statement in the CA Roscoe start up JCL.
Note: If you have CA Deliver, the CA Deliver load modules must also be either in the
linklist, or in a ETSOLIB statement with this step.
Columns Contents
1-8 EC0XMROS
9 Blank
10-12 Number of users allowed to access CA View at one time
13 Blank
14-17 CPU time slice
Use 9999 to prevent premature termination.
18 Blank
Columns Contents
19-24 Maximum memory (in KB) below the 16 MB line
This memory is only for the cross-memory driver program (50 KB is
ample).
25 Blank
26-31 Maximum memory (in KB) below the line that CA View can acquire at
one time
Use 999999 so that GETMAINs will not be limited.
32 Blank
33-38 Maximum memory (in KB) above the 16 MB line
This memory is only for the cross-memory driver program (50 KB is
ample).
39 Blank
40-45 Maximum memory (in KB) above the line that CA View can acquire at
one time
Use 999999 so that GETMAINs will not be limited.
46 Blank
47 N – Suppress Dump
48 Blank
49 Y – Application authorized to issue MODESET SVC
50 Blank
51-52 CP to call EC0XMROS as a TSO command processor
53-255 Ignored
Note: For more information about how to invoke the CA Roscoe/cross-memory online
retrieval feature, see the chapter "Online Interface Administration" in the Reference
Guide.
The EBCXMTRN macro also contains options for the specific database as follows:
■ SUBSYS= parameter of the cross-memory task must match the SUBSYS= parameter
specified in the EBCXMCTR table entry.
■ RECON=YES can be used to allow reconnection (after a TSO terminal error) at the
point of exit.
■ TIMEOUT= specifies how long TSO is to wait for the XMS session to respond after
the user enters input, in seconds.
We recommend as high a value as possible but not less than 240 (4 minutes).
Note: The SUBMAX= parameter controls the number of user connections, not the
USERMAX= parameter. USERMAX= only applies when you are using the subtask with the
CICS interface.
Note: For more information about cross-memory, see Install Cross Memory Services.
Installation Steps
The following steps are required to install the CICS Pseudo Conversational Option. Each
step is explained in detail in the sections that follow.
1. Place the CA View load libraries into DFHRPL and STEPLIB.
2. Code the PCT and PPT Table Entries to CICS.
3. (Optional) Prepare the interface to a user-written CICS menu system.
The CA View load library is required in the CICS DFHRPL and in the STEPLIB in the CICS
region.
Note: If the CAI.CVDELOAD load library is in the linklist, it does not have to be included
as a STEPLIB in the CICS region.
Be sure the following modules are available in the DFHRPL concatenation of libraries:
■ EC0CICUX
■ EC0CIEND
■ EC0CINIT
■ EC0CISRV
■ EC0XMCIC
■ EC0Crelease-number
Where:
release-number represents the CICS release number.
– CTS 3.1 release number: 0640
– CTS 3.2 release number: 0650
– CTS 4.1 release number: 0660
– CTS 4.2 release number: 0670
– CTS 5.1 release number: 0680
You can copy the six modules to the DD statement DFHRPL in your CICS task. However,
we strongly recommend that you concatenate CAI.CVDELOAD to the DD statement
DFHRPL.
Note: Several CA View modules are loaded (MVS load) from the CICS STEPLIB or
LINKLIST. Verify that the entire CA View load library is defined in the CICS STEPLIB or is
included in the linklist.
To access CA View using CICS, define the required transactions and programs for the
CICS interface.
Note:
■ You must define a separate, unique transaction identifier for each CA View
database you want to access under CICS.
■ The sample job is located in CVDEJCL member CICSDEF.
//* *
//* ** OPTIONAL ** *
//* DEFINE YOUR SITE SPECIFIC VIEW TRANSACTION. USE THE DEFINE *
//* STATEMENTS FOR THE SAMPLE VW1 TRANSACTION AS YOUR MODEL. *
//* *
//* THE FOLLOWING PARAMETERS DEFINE VIEW TRANSACTION ID: VWC0 *
//* *
//* DEFINE TRANS(VWC0) GROUP(GGGGGG) PROG(EC0XMCIC) *
//* TASKDATAL(ANY) TASKDATAK(CICS) *
//* *
//* WHERE GGGGGG IS THE CICS DEFINED GROUP FOR YOUR *
//* CA VIEW CICS DEFINITIONS. *
//*********************************************************************
//STEP1 EXEC PGM=DFHCSDUP,REGION=1024K
//STEPLIB DD DSN=&CICSLOAD,DISP=SHR
//DFHCSD DD DSN=&CICSCSD,DISP=SHR
//SYSPRINT DD SYSOUT=*
//SYSIN DD DUMMY
//*
// PEND
//CICSXMS EXEC CICSXMS
//STEP1.SYSIN DD *
DEFINE TRANS(VW1) GROUP(GGGGGG) PROG(EC0XMCIC)
TASKDATAL(ANY) TASKDATAK(CICS)
DEFINE TRANS(XMC0) GROUP(GGGGGG) PROG(EC0CISRV)
TASKDATAL(ANY) TASKDATAK(CICS)
DEFINE TRANS(VWI) GROUP(GGGGGG) PROG(EC0CINIT)
TASKDATAL(ANY) TASKDATAK(CICS)
DEFINE TRANS(VWT) GROUP(GGGGGG) PROG(EC0CIEND)
TASKDATAL(ANY) TASKDATAK(CICS)
DEFINE PROG(EC0CICUX) GROUP(GGGGGG) LANGUAGE(ASSEMBLER)
DATALOCATION(ANY) EXECKEY(CICS)
DEFINE PROG(EC0XMCIC) GROUP(GGGGGG) LANGUAGE(ASSEMBLER)
DATALOCATION(ANY) EXECKEY(CICS)
DEFINE PROG(EC0CISRV) GROUP(GGGGGG) LANGUAGE(ASSEMBLER)
DATALOCATION(ANY) EXECKEY(CICS)
DEFINE PROG(EC0CINIT) GROUP(GGGGGG) LANGUAGE(ASSEMBLER)
DATALOCATION(ANY) EXECKEY(CICS)
DEFINE PROG(EC0CIEND) GROUP(GGGGGG) LANGUAGE(ASSEMBLER)
DATALOCATION(ANY) EXECKEY(CICS)
If you have CICS storage protection activated, the following resource definition online
settings are required:
■ For all transactions
TASKDATALOC=ANY
TASKDATAKEY=CICS
EXECKEY=CICS
Add these table entries to the last phase of the PLT startup list to initialize the subtask
that is used for cross-memory access:
DFHPLT TYPE=ENTRY,PROGRAM=DFHDELIM
DFHPLT TYPE=ENTRY,PROGRAM=EC0CINIT
Add this table entry to the first phase of the PLT shutdown list to be sure that the
subtask that executes as part of the online facility shuts down correctly when CICS shuts
down:
DFHPLT TYPE=ENTRY,PROGRAM=EC0CIEND
DFHPLT TYPE=ENTRY,PROGRAM=DFHDELIM
Specify a value for the DESTID parameter in the EBCXMOPT macro in the EC0XMCTR
module and corresponding DCT entries. This value defines a transient data destination
for messages issued by the subtask.
Note: Specify a blank for DESTID to suppress the generation of informational messages
from the subtask.
If you want to invoke CA View from a user-written CICS menu system, and then return
to that menu system when you exit from CA View, do the following:
Invoke CA View from the menu system using the following CICS command:
where:
TRANSID(VIEW transaction-id)
Specifies the CA View transaction ID.
TERMID(EIBTRMID)
Specifies the terminal that a CA View transaction will communicate with.
FROM(data-area)
Specifies the optional variable length character string.
The format of the data-area parameter is:
tran,mode,sysoutid,jobnum,code
where:
tran
Specifies the return menu CICS transaction to be started when CA View finishes
mode
Specifies the CA View user mode (ALL, SAR, SARO, EXP, EXPO) for this user
If mode is not specified, the last mode that the user was in is used.
sysoutid
Specifies the SYSOUT ID or generic ID (with *) to be selected
jobnum
Specifies the JES2 job number of the SYSOUT ID to be selected
code
Indicates the selection code to be used (S, Pn, Vn, Jn, and so on)
If code is not specified, the user is presented with the SYSOUT Selection List.
Note: None of the data-area parameters is required.
LENGTH (4)
Specifies the number of bytes in the data field being passed.
When CA View receives control, it retrieves the four-byte return transaction ID and
saves it from iteration to iteration.
If the retrieve fails, CA View retains the information that it was started directly from a
terminal, not a menu system.
If there is a saved transaction ID, the product starts the return transaction before it exits
to CICS by issuing:
CICS Notes
The cross-memory CICS access involves two different address spaces: the CICS address
spaces and the XMS address spaces.
The user's CICS transactions and the cross memory support subtask reside in these
address spaces.
■ If multiple CICS regions are used to access CA View, each CICS region will have an
XMS support subtask
■ If you are using CICS/MRO, CA View normally runs in an AOR (application region).
The EBCXMTRN macro also contains options for the specific database as follows:
■ SUBSYS= parameter can be used to route the CA View transaction to an alternate
XMS subsystem ID. The SUBSYS= of the cross-memory task must match the
SUBSYS= parameter specified in the EBCXMCTR table entry.
■ TRANID=parameter specifies the CA View transaction identifier for CICS.
■ RECON=YES can be used to allow reconnection (after a CICS terminal error) at the
point of exit.
Note: Do not specify RECON=YES if you use a multi-session manager that assigns LU
names from a pool of names. Coding RECON=YES under these conditions could
allow you to be connected to another user's session.
For more information, see Multi-Session Managers later in this chapter.
■ TIMEOUT= specifies how long CICS is to wait for the XMS session to respond after
the user enters input, in seconds.
We recommend as high a value as possible but not less than 240 (4 minutes).
Until the XMS subtask is started, expect the transactions referencing EC0XMCIC to
terminate with an error message that indicates that the XMS subtask is not active
Note:
■ When the CICS region is terminated, the DFHPLTSD definition is to be used to
terminate the XMS subtask.
You can manually terminate the XMS subtask through a user application program
that links the EC0CIEND, or you can use the optional transaction defined for
EC0CIEND for manual termination.
■ If you want to terminate the XMS subtask manually, we recommend that you use
the DFHPLTSD entry to terminate the XMS subtask. This definition is needed to
clean up linkages to the XMS address spaces.
■ To prevent users from shutting down the XMS subtask, secure the optional
transaction for program EC0CIEND.
Multi-session manager products, for example CA TPX Session Management (CA TPX),
can be configured to assign an LU name to a user's terminal at the time the user selects
the CICS application.
Important! This assignment means that a user can enter CICS each time with a different
terminal ID which can cause problems for CA View application.
For example: If a user uses a multi-session manager to end a session, or shuts the PC
down, CA View does not know that the user has left. Another user might select CICS, be
assigned to the same LU name as the previous user, and enter CA View with the same
terminal ID as the previous user. CA View believes that there are two active users on the
same terminal.
To prevent this situation, you can add a small amount of code to the CICS Autoinstall
Control Program.
Note: The default name of this program is DFHZATDX and its source is located in
SDFHSAMP.
If you are not a CICS systems programmer, discuss this situation with the person in your
company who is responsible for CICS support and maintenance.
The sample code that follows shows how to clear an active user from the CA View
application at terminal deletion time. Insert this code in your Autoinstall Control
Program.
LOAD EP=EC0XSLOC,ERRET=RETURN
LR R6,R0 GET EBCXSLOC ADDRESS
ICM R8,B'1111',0(R6) ADDR OF MAIN CONTROL BLOCK
BZ RETURN GET OUT IF NONE
LA R7,4(,R8) LOOK LIKE FIRST USER BLOCK
XSU_LOOP DS OH
ICM R7,B'1111',8(R7) USER BLOCK ADDR
BZ RETURN GET OUT IF DONE
CLC DELETE_TERM_ID,104(R7) FOR THIS TERMINAL?
BNE XSU_LOOP NO
TM 120(R7),X'01' ACTIVE ENTRY?
BZ XSU_LOOP NO
OI 120(R7),X'02' SHOW SESSION DONE
B RETURN EXIT PROGRAM
If you implement this change to the terminal deletion section of the Autoinstall Control
Program, you can prevent the problems caused by the methods that were used to leave
the CA View application.
Important! This facility uses the cross-memory feature distributed with CA View and
must be installed with that feature.
Note: For more information about cross-memory, see the topic Installing Cross-Memory
Services in this chapter.
Installation Steps
This list summarizes the steps required to install the IMS Online Retrieval Option.
Detailed instructions are in the sections that follow.
1. Code the IMS TRANSACT, PSB, and APPLCTN macros.
2. Run the PSB, ACB, and SYSGEN procedures.
3. Load EC0IMSUX Modules
Move load modules to IMSVS.PGMLIB.
Important! All JCL and macros provided in this section are provided as general
examples only and must be modified according for your site's systems and standards.
Use the examples in this section as a guide as you code these macros, and implement
them in your IMS system.
■ (IMS) TRANSACT macro
■ PSB macros
■ APPLCTN macro
TRANSACT Macro
One or more transactions must be defined for the IMS online retrieval program
SARXMIMS. Normally, only one transaction identifier is defined, although you can define
multiple transactions.
TRANSACT NAME=EC0XMIMS,SPA=(18)
PSB Macros
PCB TYPE=TP,ALTRESP=YES,MODIFY=YES
PSBGEN PSBNAME=EC0XMIMS,LANG=ASSEM,COMPAT=YES
APPLCTN Macro
APPLCTN PSB=EC0XMIMS
Use the macros created in Step 1. Code the Macros as input for the following
procedures:
PSBGEN
ACBGEN
IMS SYSGEN
For example, a 3278-5 with a 27 x 132 screen size would be (27 * 132 * 1.5) = 5346.
If the SEGSIZE= is too small, the terminal user will get an RC= "A6" message
indicating that a message insert failed.
The EBCXMTRN macro also contains options for the specific database as follows:
■ SUBSYS= parameter of the cross-memory task
The parameter must match the SUBSYS= parameter specified in the EBCXMCTR
table entry.
■ RECON=YES can be used to allow reconnection (after an ISPF terminal error) at the
point of exit..
■ TIMEOUT= specifies how long ISPF is to wait for the XMS session to respond after
the user enters input, in seconds.
We recommend a value as high as possible but not less than 240 (4 minutes).
To abort the XMS session and return the user to ISPF or the TSO command prompt,
press the ATTN key.
Note:
■ The SUBMAX= parameter controls the number of user connections, not the
USERMAX= parameter. USERMAX= only applies when you are using the subtask
with the CICS interface.
■ For more information about the IMS online interface, see the chapter "Online
Interface Administration" in the Reference Guide.
To control screen size manually, use these operands. The SNA query command can also
be used to determine the device characteristics.
See this table for the XMSSUB values. Specify XMSSUB=NO for all other started regions.
Note:
■ You must specify XMS=YES for all other started regions except for VTAM-only
regions where XMS=NO is permissible.
■ Each VTAM cross-memory region requires a different applid. The applid is specified
using the SARAPPL= parameter.
■ Each VTAM cross-memory region requires VTAMPASS=YES.
■ The VTAM administrator must verify that each VTAM cross memory applid has this
setting:
AUTH=(PASS,ACO)
Install ERO
The ERO (Expanded Retention Option) option allows you to specify particular SYSOUTs
as having expanded retention, beyond the expiration for selected reports. These
SYSOUTs can be given separate retention criteria. Read these instructions thoroughly
before installing the option.
If you want selective permanent archival of SYSOUT, place the control statements in a
card image data set and include a SARPATAB DD statement for the data set in the
archival started task JCL.
Record the name of your expanded retention control statement data set next to the
SARPATAB ddname on the Archival Started Task Worksheet.
Configuration Requirements
The VTAM print option is designed for an IBM 3287 printer configuration with LU type =
3. Consult your VTAM systems programmer if necessary.
RELREQ=(YES,YES)
RELREQ ---->YES
DISCREQ --->YES
Note: For information about the initialization parameters, see the chapters
"Configuring" and "Initialization Parameters" in the Reference Guide.
Record the VTAM print option initialization parameter values on the Initialization
Parameter Worksheet in the appendix "Installation Worksheets."
The CA Spool interface option is installed during SMP/E RECEIVE and APPLY.
CA Spool Requirement
For the interface to work properly, you must have CA Spool r2.0 (or later).
Initialization Parameters
Follow these steps:
■ Specify initialization parameter CMASPOOL.
■ Evaluate all other initialization parameters that begin with CMA.
Note:
■ For more information about archiving AFP reports to CA View, ACIF control
statements, and a complete example of the process, see the "Archival" chapter in
the Reference Guide.
■ ACIF indexing on AFP reports requires a functional subsystem definition (FSS).
FSS printers can be installed under JES2, JES3, or CA Spool. If you are planning to
use CA Spool to host the ACIF FSS collector, see the CA Spool documentation for
information about how to install and operate FSS printers under CA Spool.
After you have defined the CA View FSS printer to CA Spool, skip Step 1 and Step 2
and continue with Step 3.
Use the sample FSS definition as a guide and place the JES2 initialization statements in
the JES2 PARMLIB or in a SYS1.PARMLIB.
Note: For more information about JES2 statements and a description of all of the
FSSDEF parameters, see the IBM JES2 Initialization and Tuning Reference for your
operating system.
PRMODE=(ACIF),
MODE=FSS,
CLASS=AJQ,
DRAIN,
ROUTECDE=(R10),
NOSEP,
WS=(PRM,Q,R)
The FSSDEF initialization statement defines an FSS to JES2. The following explanations of
the JES2 initialization statements are used in the definition of a CA View ACIF archiver.
The syntax is as follows:
FSSDEF Statement
The FSSDEF statement is associated with one or more PRTnnnn statements that define
each archiver FSA. The FSSDEF initialization parameter is optional, but recommended. If
it is omitted, JES2 generates a default for that archiver.
PRINTER(nnnn)
FORMS
Defines the form identifier used for selecting data sets for archival.
This parameter is only needed when F is specified as the work selection (WS)
criterion.
WRITER
Defines the writer name used for selecting data sets for archival.
This parameter is only needed when W is specified as the work selection (WS)
criterion.
WS
Defines the work selection criteria for archival.
Examples of WS are:
WS=(PRM),PRMODE=ACIF
Selects all data sets having a process mode of ACIF.
WS=(Q),CLASS=S
Selects all data sets having a SYSOUT class of S.
Use the sample FSS definition as a guide and place the JES3 initialization statements in a
SYS1.PARMLIB.
Note: For more information about JES3 statements, see the IBM JES3 Initialization and
Tuning Reference for your operating system.
FSSDEF,TYPE=WTR,FSSNAME=VBRMFSSS,PNAME=CVRMSFSS
DEVICE,JNAME=PRT1,DTYPE=SARACIF,MODE=FSS,
PM=ACIF,WS=(PM),HEADER=NO
The FSSDEF initialization parameter defines an FSS to JES3. The following explanations of
the JES3 initialization statements are used in the definition of the CA View ACIF
archivers. The syntax is as follows:
FSSDEF Statement
A DEVICE statement is required for each archival FSA. The DEVICE parameters create
JES3 default values that are used unless other values are specified in the JCL application
program. The DEVICE statement can contain the following parameters:
DTYPE
Indicates a parameter that is ignored by CA View ACIF, but must be specified.
Any name can be used.
FSSNAME
Specifies a unique FSS for this CA View ACIF archiver DEVICE statement.
The value must match the value coded for the FSSNAME parameter in the
corresponding FSSDEF statement. This parameter is required.
HEADER=NO
Indicates that no data set header pages are printed.
JNAME
Indicates the 1- to 8-character name of the CA View ACIF archiver FSA.
Each archiver FSA must have a unique JNAME. This JNAME must correspond to the
name on the DEVICE DD statement in the procedure for starting the CA View ACIF
FSS. This parameter is required.
JUNIT
Specifies the JUNIT = (,,,OFF) for CA View ACIF archival.
MODE
Indicates that the archiver is managed by an FSS.
This parameter is required.
WS=()
Defines the work selection criteria.
The options are:
CL
Specifies selection by SYSOUT class.
PM
Specifies selection by process mode.
Before starting a CA View ACIF archiver, ensure you have a cataloged startup PROC in
SYS1.PROCLIB or a procedure library concatenated to it. Use the sample JCL for CA View
ACIF startup procedure in the next section as a guide.
Use the sample ACIF device control statements as a guide. Place these statements in a
product PARMLIB or in SYS1.PARMLIB.
Information about the coding rules of the FSA Device Control Statements is documented
in the IBM manual, Advanced Function Presentation, Conversion and Indexing Facility
Application Programming Guide.
This example shows the CA View ACIF device control statements. Place these
statements in a program product PARMLIB, or SYS1.PARMLIB.
TYPE=ACIF
NAME=highlevelindex.view.database
ARCHMSG=LOG
NOGRPID=
CHARS=(GT15,GS15,GU15,GU15)
FDEFLIB=SYS1.FDEFLIB,USER.AFPLIB
FONTLIB=SYS1.FONTLIBB,USER.AFPLIB
FORMDEF=A10110
OVLYLIB=SYS1.OVERLIB,USER.AFPLIB
PAGEDEF=V06683
PDEFLIB=SYS1.PDEFLIB,USER.AFPLIB
PSEGLIB=SYS1.PSEGLIB,USER.AFPLIB
NEWCLASS=T
NEWDEST=
NEWFORM=
NEWPRMOD=
NEWWTR=
The following list describes the CA View ACIF device control statements:
TYPE=ACIF
Indicates that the FSA is identified as a ACIF archive.
Code TYPE=ACIF as the first statement.
NAME=
Specifies the high-level name of the CA View database.
ARCHMSG=YES|NO|LOG
Specifies whether to issue a SARACI22 message every time that CA View archives a
SYSOUT data set. LOG specifies that no WTO console messages are produced (only
SARLOG messages are created, if SARLOG is present).
NOGRPID=PROCESS | FAIL
Specifies the action to be taken if the SARINDEX Library does not contain a member
identified by the GROUPID= parameter on the //name OUTPUT JCL statement..
PROCESS =
Issues the message SARACI06, and archive the Sysout with the default
specifications.
FAIL=
Issues the message SARACI06, mark the report in CA View as 'ACIF' in the
Exception Code Field, the SARACI06 with other APKACIF messages are stored in
the CA View report, and the JES 'Release/Hold' command is executed against
the Sysout.
Default: PROCESS.
CHARS=
Specifies up to four different default font names.
A font name must be from 1–4 alphanumeric or national characters.
FDEFLIB
Specifies up to eight form definition libraries.
FONTLIB
Specifies up to eight font libraries.
FORMDEF
Specifies the default form definition.
OVLYLIB
Specifies up to eight overlay libraries.
PAGEDEF
Specifies the default page definitions.
PDEFLIB
Specifies up to eight page definition libraries.
PSEGLIB
Specifies up to eight page-segment libraries.
NEWCLASS
Specifies the new SYSOUT CLASS under which to archive.
This class becomes the default SYSOUT CLASS for reprinting. It is not used for
archival data created by CA Deliver or CA View systems extensions.
The value of this parameter, if specified, becomes the class value for the report in
the CA View database. Reprint Class translation, as specified by the SARINIT
parameter NEWCLSL, can still occur whether NEWCLASS is specified, if the report is
not a CA Deliver report.
NEWDEST
Specifies the new SYSOUT DEST under which to archive.
This DEST becomes the default SYSOUT DEST for reprinting. It is not used for
archival data created by CA Deliver or CA View systems extensions.
The value of this parameter, if specified, becomes the destination value for the
report in the CA View database. The SARINIT parameter NEWDEST, if specified,
overrides this parameter when the report is reprinted.
NEWFORM
Specifies the new SYSOUT FORM under which to archive.
This form becomes the default SYSOUT FORM for reprinting. It is not used for
archival data created by CA Deliver or CA View systems extensions.
The value of this parameter, if specified, becomes the forms value for the report in
the CA View database. The SARINIT parameter NEWFORM, if specified, overrides
this parameter when the report is reprinted.
NEWPRMOD
Specifies the new SYSOUT process mode under which to archive.
This mode becomes the default SYSOUT process mode for reprinting. It is not used
for archival data created by CA Deliver or CA View systems extensions.
NEWWTR
Specifies the new SYSOUT WRITER name under which to archive.
This name becomes the default SYSOUT WRITER name for reprinting. It is not used
for archival data created by CA Deliver or CA View systems extensions.
Note: For more information about archiving PDF reports to CA View, control statements
and a complete example of the process, see the chapter "Archival" in the Reference
Guide.
Note: FSS printers can be installed under JES2, JES3, or CA Spool. If you are planning to
use CA Spool to host the PDF FSS collector, see the CA Spool documentation for more
information about how to install and operate FSS printers under CA Spool.
After you have defined the CA View FSS printer to CA Spool, Skip Steps 1 and 2 and
continue with Step 3 in this section.
Use the sample FSS definition as a guide and place the JES2 initialization statements in
the JES2 PARMLIB or in a SYS1.PARMLIB.
Note: For more information about JES2 statements and a description of all of the
FSSDEF parameters, see the IBM JES2 Initialization and Tuning Reference for your
operating system.
FSSDEF,TYPE=WTR,FSSNAME=FSSSAR,PNAME=PDFCOLCT
DEVICE,JNAME=PRT1,DTYPE=SARPDF,MODE=FSS,
PM=PDFC,WS=(PM),HEADER=NO
The FSSDEF initialization statement defines an FSS to JES2.The following explains the
JES2 initialization statements used in the definition of a CA View PDF archiver. The
syntax is as follows:
FSSDEF Statement
The FSSDEF statement is associated with one or more PRTnnnn statements that define
each archiver FSA. The FSSDEF initialization parameter is optional, but recommended. If
it is omitted, JES2 generates a default for that archiver.
PRINTER(nnnn)
FORMS
Defines the form identifier used for selecting data sets for archival.
This parameter is only needed when F is specified as the work selection (WS)
criterion.
WRITER
Defines the writer name used for selecting data sets for archival.
This parameter is only needed when W is specified as the work selection (WS)
criterion.
WS
Defines the work selection criteria for archival.
Examples of WS are:
WS=(PRM),PRMODE=PDFC
Selects all data sets having a process mode of PDF.
WS=(Q),CLASS=S
Selects all data sets having a SYSOUT class of S.
Use the sample FSS definition as a guide and place the JES3 initialization statements in a
SYS1.PARMLIB.
Note: For more information about JES3 statements, see the IBM JES3 Initialization and
Tuning Reference for your operating system.
FSSDEF,TYPE=WTR,FSSNAME=FSSSAR,PNAME=PDFCOLCT
DEVICE,JNAME=PRT1,DTYPE=SARPDF,MODE=FSS,
PM=PDFC,WS=(PM),HEADER=NO
The FSSDEF initialization parameter defines an FSS to JES3. The following explains the
JES3 initialization statements used in the definition of the CA View PDF archivers. The
syntax is as follows:
FSSDEF Statement
A DEVICE statement is required for each archival FSA. The DEVICE parameters create
JES3 default values that are used unless other values are specified in the JCL application
program. The DEVICE statement can contain the following parameters:
DTYPE
Defines a parameter that is ignored by CA View PDF, but must be specified.
Any name can be used.
FSSNAME
Specifies a unique FSS for this CA View PDF archiver DEVICE statement.
The value must match the value coded for the FSSNAME parameter in the
corresponding FSSDEF statement. This parameter is required.
HEADER=NO
Indicates that no data set header pages are printed.
JNAME
Specifies the 1- to 8-character name of the CA View PDF archiver FSA.
Each archiver FSA must have a unique JNAME. This JNAME must correspond to the
name on the DEVICE DD statement in the procedure for starting the CA View PDS
FSS. This parameter is required.
JUNIT
Specifies the JUNIT = (,,,OFF) for CA View PDF archival.
MODE
Indicates that the archiver is managed by an FSS.
This parameter is required.
WS=()
The work selection criteria.
The options are:
PM
Specifies selection by SYSOUT class.
CL
Specifies selection by process mode.
Before starting a CA View PDF archiver, ensure you have a cataloged startup PROC in
SYS1.PROCLIB or a procedure library concatenated to it. Use the sample JCL for CA View
PDF startup procedure in the next section as a guide.
Use the sample PDF device control statements as a guide. Place these statements in a
product PARMLIB or in SYS1.PARMLIB.
For more information about the coding rules of the FSA device control statements, see
the IBM manual, Advanced Function Presentation, Conversion and Indexing Facility
Application Programming Guide.
The following list describes the CA View PDF device control statements:
TYPE=PDF
Indicates that the FSA is identified as a PDF archive.
Code TYPE=PDF as the first statement.
NAME=
Specifies the high-level name of the CA View database.
ARCHMSG=YES|NO|LOG
Specifies whether to issue a CAHPDF01I message every time that CA View archives a
SYSOUT data set. LOG specifies that no WTO console messages are produced (only
SARLOG messages are created, if SARLOG is present).
NEWCLASS
Specifies the new SYSOUT CLASS under which to archive.
This class becomes the default SYSOUT CLASS for reprinting. It is not used for
archival data created by CA Deliver or CA View systems extensions.
The value of this parameter, if specified, becomes the class value for the report in
the CA View database. Reprint Class translation, as specified by the SARINIT
parameter NEWCLSL, can still occur whether NEWCLASS is specified, if the report is
not a CA Deliver report.
NEWDEST
Specifies the new SYSOUT DEST under which to archive.
This DEST becomes the default SYSOUT DEST for reprinting. It is not used for
archival data created by CA Deliver or CA View systems extensions.
The value of this parameter, if specified, becomes the destination value for the
report in the CA View database. The SARINIT parameter NEWDEST, if specified,
overrides this parameter when the report is reprinted.
NEWFORM
Specifies the new SYSOUT FORM under which to archive.
This form becomes the default SYSOUT FORM for reprinting. It is not used for
archival data created by CA Deliver or CA View systems extensions.
The value of this parameter, if specified, becomes the forms value for the report in
the CA View database. The SARINIT parameter NEWFORM, if specified, overrides
this parameter when the report is reprinted.
NEWPRMOD
Specifies the new SYSOUT process mode under which to archive.
This mode becomes the default SYSOUT process mode for reprinting. It is not used
for archival data created by CA Deliver or CA View systems extensions.
NEWWTR
Specifies the new SYSOUT WRITER name under which to archive.
This name becomes the default SYSOUT WRITER name for reprinting. It is not used
for archival data created by CA Deliver or CA View systems extensions.
Note: For more information about the implementation of CA GSS, see the chapter
"Batch Processing" in the Reference Guide.
This topic provides the instructions for installing and implementing the CA View FSS
Collector. Read the instructions thoroughly before installing the collector.
Important! Backup and Direct-To-Tape archival are only performed by the CA View
archival task.
Installation Steps
The following is an overview of the steps to install the CA View FSS Collector. Each step
is explained in detail in the following topics.
1. Define JES2 initialization statements (for JES2 sites).
2. Define JES3 initialization statements (for JES3 sites).
3. Define an FSS Archiver PROC.
4. Define FSA (Functional Subsystem Application) device control statements.
5. Define FSS report control statements.
Note: FSS printers can be installed under JES2, JES3, or CA Spool. If you are planning to
use CA Spool to host the PDF FSS collector, see the CA Spool documentation for more
information about how to install and operate FSS printers under CA Spool.
After you have defined the CA View FSS printer to CA Spool, skip Steps 1 and 2 and
continue with Step 3 in this section.
This section explains the JES2 initialization statements used in the definition of a CA
View FSS archiver. For more information about JES2 statements, see the IBM JES2
initialization and tuning publication for your operating system.
FSSDEF Statement
The FSSDEF initialization statement defines an FSS to JES2. The FSSDEF statement is
associated with one or more PRTnnnn statements that define each archiver FSA.
For a description of all of the FSSDEF parameters, see the IBM JES2 initialization and
tuning publication for your operating system.
PRINTER(nnnn) Statement
The PRINTER(nnnn) parameters define JES2 default values. The JES2 PRINTER(nnnn)
statement contains the following parameters:
CLASS
Specifies the output class to be used for selecting data sets to be archived.
The CLASS parameter is only needed when Q is specified as a work selection (WS)
criterion.
DRAIN|START DRAIN
Specifies that the archiver can be started by operator command.
START
Specifies that the archiver is started automatically when JES2 begins
processing.
FSS
Specifies the FSS for the archiver and must match the value coded for an FSSNAME
parameter for the corresponding FSSDEF statement.
The FSS parameter is required.
MODE
Specifies that the printer is managed by an FSS (MODE=FSS).
The MODE parameter is required.
PRMODE
Specifies the processing mode used for selecting data sets to be archived
The PRMODE parameter is only needed when PRM is specified as a work selection
(WS) criterion.
NOSEP
Specifies that no separator pages are produced.
TRKCELL=YES
Specifies that track-cell de-spooling is used with this printer.
ROUTECDE
Specifies the route code used for selecting data sets to be archived,
The ROUTECDE parameter is only needed when R is specified as a work selection
(WS) criterion.
FORMS
Specifies the form identifier used for selecting data sets for archival.
The FORMS parameter is only needed when F is specified as a work selection (WS)
criterion.
WRITER
Specifies the writer name used for selecting data sets for archival.
The WRITER parameter is only needed when W is specified as a work selection (WS)
criterion.
WS
Specifies the work selection criteria for archival.
Examples of WS are:
WS=(PRM),PRMODE=LINE
Selects all data sets having a process mode of LINE.
WS=(Q),CLASS=S
Selects all data sets having a SYSOUT class of S.
The following explanations of the JES3 initialization statements are used in the
definition of the FSS archivers. For more information about JES3 statements, see the
IBM JES3 initialization and tuning publication for your operating system.
FSSDEF Statement
The FSSDEF initialization parameter defines an FSS to JES3. The FSSDEF initialization
statement is optional, but recommended. If it is omitted, JES3 generates a default for
that archiver.
A DEVICE statement is required for each archival FSA. The DEVICE parameters create
JES3 default values that are used unless other values are specified in the JCL application
program.
FSSNAME
Specifies a unique FSS for this CA View FSS archiver DEVICE statement.
The value must match the value coded for the FSSNAME parameter in the
corresponding FSSDEF statement. The FSSNAME parameter is required.
HEADER = NO
Specifies that no data set header pages are printed.
JNAME
Specifies the 1- to 8-character name of the FSS archiver FSA.
Each archiver FSA must have a unique JNAME. This JNAME must correspond to the
name on the DEVICE DD statement in the procedure for starting the CA View FSS.
The JNAME parameter is required.
JUNIT
Specifies JUNIT = (,,,OFF) for FSS archival.
MODE
Specifies that the archiver is managed by an FSS.
The MODE parameter is required.
WS=()
Specifies the work selection criteria.
The options are:
PM WS=(PM)
Selects by process mode.
CL WS=(CL)
Selects by SYSOUT class.
■ STEPLIB DD
The CA View load library must be in an authorized STEPLIB concatenation or in an
LNKLSTxx library.
■ SARINDEX DD
SARINDEX specifies PDS members containing the VIEW control statements.
Note: For more information about coding these statements, see the chapter "Archival"
in the Reference Guide.
PRTnnnn DD Statements
The PRTnnnn DD statements contain parameters for each VIEW archiver. The ddname
must match that of the corresponding JES2 PRINTER(nnnn) device or JES3 JNAME value.
Multiple PRTnnnn DD statements can be specified for each CA View Functional
Subsystem archiver.
SARLOG DD Statement
The SARLOG DD statement is optional. If specified, CA View messages are written to it.
The Message Guide documents these messages.
SARACT DD Statement
The SARACT DD statement is optional. If specified, this DD performs the same function
as in the VIEW archival started task.
SARXCTAB DD Statement
keyword=value
The following example shows FSS device control statements. These statements should
be placed in a program product PARMLIB or SYS1.PARMLIB.
Sample Definition
TYPE=VIEW
NAME=highlevelindex.view.database
ARCHMSG=LOG
NEWCLASS=T
NEWDEST=
NEWFORM=
NEWPRMOD=
NEWWTR=
CHARS=(GT15,GS15,GU15,GU15)
FORMDEF=A10110
PAGEDEF=V06683
SYSTEM
Indicates the system_name or system_name.dest.
If this statement is not coded, the default value of DEST=DEFAULT is used.
Note: This statement has the same functionality as provided in CA View r11.
NAME
Specifies the high-level name of the CA View database.
NEWCLASS
Specifies the new SYSOUT CLASS under which to archive.
This class becomes the default SYSOUT CLASS for reprinting. It is not used for
archival data created by CA Deliver or CA View Systems extensions.
NEWDEST
Specifies the new SYSOUT DEST under which to archive.
This becomes the default SYSOUT DEST for reprinting. It is not used for archival data
created by CA Deliver or CA View Systems extensions.
NEWFORM
Specifies the new SYSOUT FORM under which to archive.
This form becomes the default SYSOUT FORM for reprinting. It is not used for
archival data created by CA Deliver or CA View Systems extensions.
NEWPRMOD
Specifies the new SYSOUT process mode under which to archive.
This process becomes the default SYSOUT process mode for reprinting. It is not
used for archival data created by CA Deliver or CA View Systems extensions.
NEWWTR
Specifies the new SYSOUT WRITER name under which to archive.
The writer name is used as a SYSOUT ID. It is not used for archival data created by
Deliver or CA View Systems extensions.
TYPE=VIEW
Identifies the FSA as an FSS archiver.
Code TYPE=VIEW as the first statement.
CHARS,FORMDEF,PAGEDEF
These statements act as defaults and do not override existing report attributes.
Note: For JES3 sites, the GROUPID parameter is supported in JES3 version 4.2 and
higher.
Note: For more information about installing and configuring the EMC Centera Disk
Option, see the chapter "EMC Centera Disk Option" in the Reference Guide.
■ Enter the data set high-level qualifiers you plan to assign to the CA View
product libraries.
Default: **CAI** ='CAI.' **CAI**= _______________
■ Enter the data set high-level qualifier you plan to assign to the SMP data
sets to be used for this installation.
Default: **CAISMPE** ='CAISMPE.' **CAISMPE**= __________
■ Enter the Volser name to be used to allocate the SMP/E VSAM cluster for
your CSI..
Default: **SMPVOL**= **SMPVOL**=____________
■ If you are doing an installation from tape, enter the generic unit name of
your 6250 bpi tape drive.
Default: **CART**= **CART**= ______________
■ If you are not using SMS, enter the name of the Volser on which to
allocate the data sets.
Default: VOLSER = VOLSER = ______________
■ If you are using SMS for data set allocations, enter the name of your SMS
storage class.
Default: STORCL = STORCL = _____________
■ Enter the TSO CLIST name to use to initiate online interaction with CA
View. See CAI.CAICLS0 for examples.
TSOC=_________________
■ Enter the DASD volume on which the system databases are to reside.
SYSVOL= _____________
■ Conversion data:
Enter the report class/destination/form combination currently being used by CLSL= _____________
the archive criteria. DEST= _____________
FORM= _____________
Parameter Value
ACIFCOMP
ACIFRES
AFPSPACE
ANNODLFT
ARCHCOPY
ARCHMSG
ARCHSWAP
BCHMAXRC
Parameter Value
BNDWDAYS
CCONDISP
CENTADR
CENTPDSN
CENTNAME
CLEAN
CLSL
CMAMAX
CMASPOOL
CODEPAGE
DAYS
DBMSGFRQ
DBTHRESH
DEFMODE
DELETE
DESC
DEST
DIRALLOC
DRMOD
DRTAPE
DRTIDX
DRTSEQ
DRUNITB
DRUNITP
EASTDPLX
EASTMAXW
EASTNAM1-
EASTNAM3
ENCRYPT
EXPDT
Parameter Value
EXPOPRV
EXPRESS
EXTPRTn
FEATURE
FINDLAST
FINDLIM
FINDPREV
FORM
FREEPRT
GEN
GRPUSER
HOLDTEMP
IMMRPT
INTERVAL
JCLASS
JES3ID
LANGUAGE
LGNRETRY
LOGO
MASTER
MAXLINES
MOUNT
MSORT1 –
MSORT5
NAME
NARCCLSL
NBACKUP
NEWCLSL
NEWDEST
NEWFORM
Parameter Value
NEWPASS
NGEND
NGENI
NGENT
OUTLIM
PAGEMARK
PRTALL
PRTASA
PRTCLSL
RCVPRIM
RCVSEC
RCVSPACE
RCVUNIT
REDISP
RETPD
ROUT
ROUTBKP
SECID
SECLIST
SECURITY
SETPAGE
SMF
SMFTYPE
STACKBU
START
STORGRP0
STORGRX0
TAPECLSL
TAPEOPT
TAPESEQ
Parameter Value
TBACKUP
TIME
TPO54
TSOCLS
TSODEST
TSOFORM
TSOSCHED
UNITSPEC
UNLOAD
USERLIB
USERLVL
VPRTAPPL
VPRTMAXO
VPRTONL
VPRTPRINT
VPRTRTRY
WAIT
WRITER
XPRINT
Parameter Value
DSK2DAYS
DSK2DRVR
DSK2INTV
DSK2MIGD
DSK2PARM
DSK2TIME
EROOPT
Parameter Value
EROPRO
PCOPIES
PMXTAPES
PMXYEARS
POPT
PRETAIN
PTEXT1 – PTEXT5
PTHRESH
PXCOND
STORGRP1-9
STORGRX1-9
Accounting Data
DDname: SARACT
Overview
CA View provides seamless integration with CA OPS/MVS by automatically
communicating both active status events and heart beat events to CA OPS/MVS. The
enabling technology for this is through a generic event API call that CA OPS/MVS
provides the other mainframe products so that they can communicate events to CA
OPS/MVS.
You do not need to do anything for CA View to enable this event communication
interface to CA OPS/MVS. If CA View and CA OPS/MVS are active in the same z/OS
image, CA View automatically communicates these automation events to CA OPS/MVS.
By generating active status events CA View and other CA products are able to
communicate to CA OPS/MVS’s System State Manager (SSM) component when they are
starting, up, stopping or down.
SSM is a built-in feature that uses an internal relational data framework to proactively
monitor and manage started tasks, online applications, subsystems, JES initiators, and
other z/OS resources including your CA mainframe products. SSM compares the current
state of online systems, hardware devices, and the other resources with their desired
state, and then automatically makes the necessary corrections when a resource is not in
its desired state. This provides proactive and reactive state management of critical
resources.
Before the CA OPS/MVS interface existed, CA OPS/MVS could automate active status
events for your CA products; however this typically required monitoring unique
messages for each CA product. With this interface, CA OPS/MVS can capture these
events for any of your CA products with a single automation event rule.
With the heart beat event, CA View can communicate a normal, warning, or problem
overall health status and reasoning to CA OPS/MVS on a regular interval. Once CA View
begins generating heart beat events for CA OPS/MVS, CA OPS/MVS can also react to the
lack of a heart beat event from CA View, treating this as an indication that there is either
a potential problem with CA View, or there is a larger system-level problem that is
taking place.
The CA View product active state is presented to CA OPS/MVS and can be processed by
the following rule:
)API CASTATE
The available OPS/REXX variables for CA View product state management are:
API.APPLICATION CA View
API.VERSION Current release
API.LEVEL 00
API.EVENTID CASTATE
API.MSGID CASTATE
API.TEXT State of CA View
appl_id
Specifies the same value as the API.APPLICATION variable
current_state
STARTING
Indicates that CA View is initializing
UP
Indicates that CA View is active
STOPPING
Indicates that CA View is terminating
DOWN
Indicates that CA View is exiting the system
For more information on how to use the CASTATE API, see the member SSMCAAPI of
opsmvsHLQ.STATEMAN.RULES.
CA View issues a heartbeat update every nnnn seconds that notifies CA OPS/MVS of the
current operational health of the CA View product.
CA OPS/MVS can also react to the lack of a heartbeat update from CA View and an
indication that there is either a potential problem with CA View, or there is a larger
system level problem that is taking place.
)API CAHEARTBT
API.APPLICATION CA View
API.VERSION Current release
API.LEVEL 00
API.EVENTID CAHEARTBT
API.MSGID CAHEARTBT
API.TEXT State of CA View
For information on how you use the CAHEARTBT API, see members APIHRTB1,
APIHRTB2, and APIHRTB3 of opsmvsHLQ.SAMPLE.RULES.
Index 275
FSA, definition of • 249 CA Roscoe cross-memory online retrieval option
FSS Collector • 257 • 144
defining • 257 CA Spool interface option • 228
FSA device control statements • 257 cross-memory interfaces • 161
FSS, definition of • 249 ERO • 225
FSSDEF statement (JES2) • 251 from Pax-Enhanced ESD • 41
parameters • 251 from tape • 65
AUTOSTOP • 251 FSS Collector • 249
FSSNAME • 251 Global Subsystem interfaceSee CA GSS • 248
HASPFSSM • 251 IMS online retrieval option • 155
PROC • 251 ISPF cross-memory online retrieval option • 132
FSSDEF statement (JES3) • 254 online interfaces • 131
parameters • 254 system extensions • 107
FSSNAME • 254 TSO cross-memory online retrieval option • 139
PNAME • 254 TSO online retrieval option • 91
SYSTEM • 254 VTAM online retrieval option • 140
TERM = YES|NO • 254 VTAM print option • 226
TYPE • 254 Integrated Cryptographic Services Facility (ICSF) • 56
FSSNAME parameter • 251, 254 internal HOLDDATA • 62
ISPF • 132, 162
G cross-memory online retrieval option, installing •
GIMUNZIP utility • 56 132
Global Subsystem interfaceSee CA GSS • 248 interface driver • 162
GSS interfaceSee CA GSS • 248
J
H Java version support • 56
hardware requirements • 17 JES2 initialization statements • 229, 239, 251, 252
hash setting • 56 defining • 229, 239
HASPFSSM parameter • 251 FSSDEF statement • 251
HEADER = NO parameter • 254 PRINTER(nnnn) statement • 252
HELP panel • 102 JES3 initialization statements • 232, 242, 254
choosing languages • 102 defining • 232, 242
HELP panel, customizing the • 103 DEVICE statement • 254
hexadecimal characters, reserved • 103 FSSDEF statement • 254
high-level qualifier • 56 JNAME parameter • 254
highlight attributes • 103 JUNIT parameter • 254
HOLDDATA • 62
L
I language • 97, 102
IEBCOPY • 66 for HELP panels, setting • 102
IMS online retrieval option, installing • 155 for panels, setting • 97
IMS/DC access • 157 length of variables • 103
Initialization Parameter Worksheet • 262 LMP • 23, 86
installing • 91, 107, 131, 132, 139, 140, 144, 155, key certificate • 86
161, 225, 226, 228, 238, 248, 249 overview • 23
ACIF interface • 228, 238 LU names • 152
CA GSS interface • 248 virtual • 152
Index 277
V
variables • 103
adding • 103
deleting • 103
length of • 103
position of • 103
VIEW archiver PROC, defining • 256, 257
SARACT DD statement • 256
SARLOG DD statement • 256
SARXCTAB DD statement • 257
VTAM • 140, 226
online retrieval option, installing • 140
print option, installing • 226
W
worksheets • 262, 266, 267
Archival Started Task • 267
Expanded Retention Option • 266
Initialization Parameter • 262
WRITER parameter • 252
WS parameter • 252
WS=() parameter • 254
X
XMS (cross-memory services) • 152
alternate subsystem ID • 152
controlling subtask start-up options • 152
session timeout • 152