Configure and Deploy CA Spool

This article describes how to configure and deploy .
casp14
This article describes how to configure and deploy
CA Spool
.
2
2
Run UCLIN
Run member CBQ4JCL(BQ4JIUCL) to update SMP/E with information about the relationship between source and macros. A return code of 04 is acceptable.
APF Authorize the
CA Spool
Libraries
APF authorize the
CA Spool
CAILIB library by adding the following to the PROG
xx
member in SYS1.PARMLIB:
APF ADD DSNAME(cai.CBQ4LOAD) VOLUME(volume)
Use the MVS System Command SET PROG=xx to activate the updated SYS1.PARMLIB PROGxx member.
Add the JCL Procedure
The CAI Common Procedure library (CBQ4PROC) contains all the procedures relevant to
CA Spool
. These procedures were placed in this library during SMP APPLY processing.
Edit each JCL procedure to conform to your site's installation standards.
After completing these modifications, you can do either of the following:
  • Copy the procedures into a PROCLIB of your choice.
  • Copy the following procedure into a common procedure library, which can be added to the system PROCLIB concatenations.
    //CAIQPOOL PROC MEMBER=CAIQPARM, * Initialization Parms // LOADLIB='CAI.SPOOL.CBQ4LOAD', * CA Spool Load Library // PARMLIB='CAI.CBQ4PARM', * Parmlib library // OPTION=WARM * Start options //********************************************************************* //* * //* CA Spool 14.0.00 * //* * //* Tailor the Proc as required by your setup * //* * //* Copyright (c) 2017 CA. All rights reserved. * //********************************************************************* //IEFPROC EXEC PGM=ESFMAIN,TIME=1440,REGION=0M,PARM=&OPTION //STEPLIB DD DISP=SHR,DSN=CEE.SCEERUN * LE run-time library // DD DISP=SHR,DSN=&LOADLIB * CA Spool Load Library //* DD DISP=SHR,DSN=CAI.VIEW.CBRMLOAD * CA View Load Library //* DD DISP=SHR,DSN=CAI.XCOM.CBGXLOAD * CA XCOM Load Library //* DD DISP=SHR,DSN=$CD.LINKLIB * Connect:Direct Load Lib //ESFPARM DD DISP=SHR,DSN=&PARMLIB(&MEMBER) * Initialization Parms //ESFLIST DD SYSOUT=*,OUTLIM=0 //SYSPRINT DD SYSOUT=* //SYSTERM DD DUMMY //SYMDUMP DD DUMMY //*NJESNAP DD SYSOUT=* * NJE trace //*SAPISNAP DD SYSOUT=* * SAPI trace //*SECUSNAP DD SYSOUT=* * SAF trace //*-------------------------------------------------------------------* //* Local IMAGELIB libraries. * //*-------------------------------------------------------------------* //IMAGELIB DD DISP=SHR,DSN=SYS1.IMAGELIB //* DD DISP=SHR,DSN=**YOUR**.IMAGELIB //*-------------------------------------------------------------------* //* Local TCPIP.DATA file. * //*-------------------------------------------------------------------* //*SYSTCPD DD DISP=SHR,DSN=**YOUR**.TCPIP.DATA.FILE //*-------------------------------------------------------------------* //* CA Spool Print formatting resource libraries. * //*-------------------------------------------------------------------* //*PJLLIB DD DISP=SHR,DSN=**YOUR**.PJL.RESOURCE.LIBRARY //*PCLLIB DD DISP=SHR,DSN=**YOUR**.PCL.RESOURCE.LIBRARY //*BINLIB DD DISP=SHR,DSN=**YOUR**.BIN.RESOURCE.LIBRARY //*OVLYLIB DD DISP=SHR,DSN=**YOUR**.OVLY.RESOURCE.LIBRARY //*HTMLIB DD DISP=SHR,DSN=**YOUR**.HTML.RESOURCE.LIBRARY //*MAILLIB DD DISP=SHR,DSN=**YOUR**.MAILBOOK.RESOURCE.LIBRARY //*-------------------------------------------------------------------* //* Common FTP, CA XCOM and Connect:Direct userid/password file * //*-------------------------------------------------------------------* //*NETRC DD DISP=SHR,DSN=&PARMLIB(IQNETRC) //*-------------------------------------------------------------------* //* CA XCOM libraries. * //*-------------------------------------------------------------------* //*XCOMCNTL DD DISP=SHR,DSN=CAI.XCOM.CBXGPARM //*XCOMSYSI DD DISP=SHR,DSN=&PARMLIB(IQXCOMPR) //*SYSIN01 DD DSN=&SYSIN01,UNIT=SYSDA,SPACE=(TRK,(1,1)) //*LCLDS01 DD DSN=&LCLDS01,UNIT=SYSDA,SPACE=(CYL,(10,10)) //*-------------------------------------------------------------------* //* Connect:Direct libraries. * //*-------------------------------------------------------------------* //*DMNETMAP DD DISP=SHR,DSN=$CD.NETMAP //*DMPUBLIB DD DISP=SHR,DSN=$CD.PROCESS //*DMMSGFIL DD DISP=SHR,DSN=$CD.MSG //*DMPRINT DD SYSOUT=* //*
Standard Data Sets
The standard
CA Spool
data sets are as follows:
  • STEPLIB
    Points to the
    CA Spool
    load library and the LE run-time library. If you are not using the STEPLIB DD statement, these libraries must be in linklist and APF authorized.
    If the direct interface to CA View is used, or the CA Roscoe menu interface is used, or the CA XCOM or Connect:Direct print drivers are used. The load libraries from these products must also be included in the steplib or in linklist and be APF authorized.
  • ESFPARM
    Points to the
    CA Spool
    initialization parameter file.
  • ESFLIST
    The
    CA Spool
    initialization parameters are listed here if PARM=LIST was specified when the task was started.
  • SYMDUMP
    Used in conjunction with the CA SymDump System for abend debugging.
  • NJESNAP
    Points to the NJE trace file.
  • SAPISNAP
    Points to the SAPI trace file.
  • SECUSNAP
    Points to the security trace file.
  • IMAGELIB
    Points to the system image library.
  • SYSTCPD
    Points to the optional TCPIP.DATA file.
  • PJLLIB
    Points to the PJL resource library.
  • PCLLIB
    Points to the PCL resource library.
  • BINLIB
    Points to the binary resource library.
  • OVLYLIB
    Points to the OVLY resource library.
  • HTMLIB
    Points to the email HTML skeleton resource library.
  • MAILLIB
    Points to the email MAILBOOK resource library.
Enter the LMP Code
CA Spool
requires CA LMP (License Management Program), one of the CA Common services to initialize correctly. CA LMP provides a standardized, automated approach to the tracking of licensed software. Examine the CA LMP Key Certificate you received with your installation cartridge. The
CA Spool
LMP product code is as follows:
  • OI
    CA Spool
    Package (
    CA Spool
    Base and all the above options)
    CA Spool
    Print Management Plus (same as
    CA Spool
    package)
Add the VTAM Resource Definition
Run job BQ4JVTAM in CBQ4JCL to add the special
CA Spool
VTAM resource definition member APPLESF to SYS1.VTAMLST. This member only contains the definition of the VTAM application ESF.
This job is self-documenting. Be sure to adjust the JCL deck to your site's standards and assign proper values to various installation-dependent parameters.
Add the JES Initialization Parameters (Optional)
This step is optional.
Run
one
of the following jobs in CBQ4JCL, depending on which version of JES you are running, and how your JES system is configured:
  • BQ4JJES2
    If JES2 is configured with DESTDEF NODENAME= OPTIONAL, which is the JES2 default, there is no need to define the destination ESF to JES2, and this step can be skipped.
    If JES2 is configured with DESTDEF NODENAME= REQUIRED, run this job to add the destination identifier ESF to the JES2 initialization parameter deck (JES2PARM) and associate an unused local JES2 route code.
    You can also define the destination ESF with a JES2 $ADD command, as follows:
    $ADD DESTID(ESF),DEST=Unnn
    where U
    nnn
    must specify an unused local JES2 route code.
  • BQ4JJES3
    This job adds the destination identifier ESF to the JES3 initialization-parameter deck (JES3IN).
Unless it was added dynamically, JES2 or JES3 has to be restarted to make the destination ESF known. The Automatic File Transfer interface JESTOESF cannot be used until the destination is known to JES, but all the remaining
CA Spool
facilities will function.
This job is self-documenting. Be sure to adjust the JCL to your site's standards and assign proper values to various installation-dependent parameters.
Configure TCP/IP Setup
To use the
CA Spool
TCP/IP interfaces, the
CA Spool
Started Task User ID must have an OMVS segment assigned. Contact your security administrator to have an OMVS segment defined for your
CA Spool
user ID.
Define directories for the
CA Spool
Web Interface
Run the BQ4JHFSD job in CBQ4JCL to define swap and logs directories for use by the
CA Spool
Web Interface. The job must be run with a userid that has the required permissions to define the directories and allow access to these directories.
Allocate the Spool and Checkpoint Data Sets
Run the BQ4JALOC job in CBQ4JCL to allocate the
CA Spool
spool and checkpoint data sets onto any type of disk storage.
This job is self-documenting. Be sure to adjust the JCL deck to your site's standards and assign proper values to various installation-dependent parameters.
Assign Values to the Initialization Parameters
Assign suitable values to initialization parameters in the member CAIQPARM in CBQ4PARM. Define a test network group containing printer nodes and user IDs, and for internal security, the user IDs should also be defined.
SVCCODE
The SVCCODE statement specifies the user SVC number used by
CA Spool
. The
CA Spool
SVC is designed so it can run as a normal type-4 user SVC routine. The system administrator responsible for the MVS system must decide which unused Type 4 SVC number to use.
During startup,
CA Spool
verifies if the specified SVC number in the SVC table points to a valid SVC routine. If the SVC table entry corresponding to the specified SVC number is not in use,
CA Spool
dynamically loads the SVC routine module into the CSA and updates the SVC table entry to point to it.
  • If both the ESRCODE and SVCCODE statements are specified, the ESRCODE definition is used and the SVCCODE definition is ignored.
  • During startup verifies if the specified SVC number in the SVC table points to a valid SVC routine.
  • If the SVC table entry corresponding to the specified SVC number is not in use, dynamically loads the SVC routine module into the CSA and updates the SVC table entry to point to it.
  • If an installation wants to pre-load the SVC routine into the PLPA during IPL, the supplied ESFSVC module must be renamed to the SVC module name matching the specified SVC number and made accessible using LPALSTxx or MLPA. For example, if SVCCODE=241 is specified, then the corresponding SVC module name must be IGC0024A.
ESRCODE
The
CA Spool
SVC is designed to use the extended SVC-router (ESR) support. This means that the
CA Spool
SVC does not need to occupy an SVC number by itself. ESR is called (SVC 109) with a routing code in register 15, indicating the module to be given control.
  • If both the ESRCODE and SVCCODE statements are specified, the ESRCODE definition is used and the SVCCODE definition is ignored.
  • During startup
    CA Spool
    verifies if the specified ESR number in the ESR table points to a valid
    CA Spool
    SVC routine.
  • If the ESR table entry corresponding to the specified ESR number is not in use,
    CA Spool
    dynamically loads the SVC routine module into the CSA and updates the ESR table entry to point to it.
  • If an installation wants to pre-load the
    CA Spool
    SVC routine into the PLPA during IPL, the supplied ESFSVC module must be renamed to the SVC module name matching the specified ESR number and made accessible using LPALSTxx or MLPA. For example, if ESRCODE=241 is specified, then the corresponding
    CA Spool
    SVC module name must be IGX00241.
Run Post-Install Jobs as Required for Other Environments
CA Spool
has interfaces to a number of different environments. In some environments, some of these interfaces require that you run extra installation jobs. The jobs are in the CBQ4JCL data set and begin with "BQ4J" and the remaining characters indicate the relevant environment.
BQ4J
xxxx
are SMP/E jobs that update SMP/E with the information that a foreign product is present. Some of the source distributed with
CA Spool
assembles differently when a BQ4J
xxxx
job is executed.
You no longer need to run the following post-installation jobs to implement interfaces to other products:
  • BQ4JCICS
  • BQ4JNATU
  • BQ4JROSC
  • BQ4JIDMS
  • BQ4JIMS
  • BQ4JCOMP
These interfaces are now activated using the SUBSAPI parameter in the ESFPARM initialization parameter file.
Run Any Other Optional Jobs
Run the following jobs according to the needs of your site:
  • BQ4JIU*** jobs for usermod maintenance
  • BQ4JF*** jobs for fix applies
Start
CA Spool
for the First Time
Follow these steps:
  1. Enter the following command to activate the
    CA Spool
    VTAM resource:
    V NET,ACT,ID=aaaaaaaa
    where
    aaaaaaaa
    is the applid defined for
    CA Spool
    . Perform the following to start the system:
    1. Enter the following MVS start command on the MVS operator console:
      S procname,OPTION=FORMAT
    where
    procname
    is the member name of the
    CA Spool
    proc in your system procedure library.
    The following WTOR message asks you to confirm that the checkpoint data set must be overwritten:
    *yy ESF053 REPLY Y OR N TO CONFIRM CHECKPOINT RECORD CHANGE
  2. To confirm, enter:
    R yy,Y
  3. CA Spool
    displays initialization progress with the following WTO messages:
    -ESF059 CHKPTDS1 COLD-START IS IN PROGRESS -ESF024 FORMATTING VOLUME=vvvvvv DSN=dddddddd.ssssssss.nnnnnnnn -ESF024 FORMAT COMPLETE V=vvvvvv DSN=dddddddd.ssssssss.nnnnnnnn -ESF041 INTERNAL TRACE REQUESTED, 512 ENTRIES ALLOCATED -ESF719 CA Spool BASE option enabled -ESF4117 Transformer Interface initialized -ESF100 SIMPLE COLD START COMPLETED -ESF301 VIRTUAL PRINTER INTERFACE STARTED -ESF490 NETWORK INTERFACE STARTED
    The message NETWORK INTERFACE STARTED confirms a successful initialization.
  4. As a quick check, enter the following display-status command from the MVS operator console (where "-“ is a communication character defined by COMCHAR statement in CAIQPARM):
    -DS
    CA Spool
    responds by writing the following messages to the MVS console:
    -ESF809 VERSION.LEVEL CA Spool 14.0.00 -ESF816 0 OUTSTANDING I/O-REQUESTS -ESF817 OPEN FILE COUNT: 0/ 0 OUTPUT, 0/ 0 INPUT -ESF818 0 % SPOOL UTILIZATION / HWM UTILIZATION 0 % -ESF820 0 FILE QUEUE ELEMENTS IN USE - MAX 500 / HWM 0 -ESF823 VTAM ACB OPEN - LOGONS ENABLED -ESF865 NO ACTIVE COMMUNICATION CHANNELS -ESF889 SUBSYS Interface is active -ESF857 Printers Defined( 1) Remaining( 10) -ESF853 TCP/IP printer subtasks: 0 -ESF318 VPS 10( 0) ACB(S) 0( 0) STG( 9K) -ESF827 SAR INTERFACE IS NOT ACTIVE -ESF878 Transformer Interface is active, 0 files -ESF886 LPD Interface is undefined -ESF885 A(ESFSSSM )=X'25270000' A(ESFUSS )=X'254E74C0' -ESF854 Current Hour Max Hour Grand Total -ESF854 Files printed: 0 0 0 -ESF854 Pages printed: 0 0 0 -ESF854 Lines printed: 0 0 0
    If there are no errors, you can proceed to the Verify the Installation step.
Verify the Installation
This section contains information that lets you verify the installation of the basic system and optional features.
The CBQ4JCL library includes some sample IVP (Installation Verification Program) test jobs. These IVP jobs are self-documenting but each job should be adjusted to your local JCL standards.
The
CA Spool
CBQ4LOAD must be available to the user's session in linklist or STEPLIB to complete some of the following steps.
Basic System Verification
Verification of the basic system normally includes these steps:
  1. To operate from a 3270 display terminal, first log on through VTAM. To start a session, enter the logon APPLID. For example:
    LOGON APPLID(ESF)
    1. CA Spool
      prompts for a user ID and password. Enter the userid and password which is specified in CAIQPARM.
      When the session is successfully established,
      CA Spool
      formats the screen into a message-output area and a command-entry area.
    2. Enter the display-file command. For example:
      DF
      CA Spool
      responds to the display-file command with the message:
      ESF840 QUEUE EMPTY
  2. Run the supplied sample job IVPBPRNT to test the ESFPRINT utility in batch mode, to generate the first
    CA Spool
    file.
    After the job has terminated, start the specified
    CA Spool
    printer.
    CA Spool
    starts printing the spool file if the printer setup matches the file setup.
  3. To test the
    CA Spool
    to JES file transfer interface, enter the following:
    RF1,ND=LOCAL => ESF850 1 FILE(S) ROUTED RF1 => ESF850 1 FILE(S) REQUEUED
    The file is copied to a JES2 or JES3 spin-off SYSOUT data set.
  4. Run the supplied sample job IVPBJESX to test the automatic JESTOESF file transfer interface.
    After the job has terminated, a new file starts printing on the specified printer.
  5. To test the ESFPRINT/DSPRINT TSO command, start a TSO session:
    ESFPRINT DSN('CAI.CBQ4PARM(CAIQPARM)') DEST(destination) SUB(ESF)
    Specify the name of the test printer as the destination.
SUBSYS Verification
To verify the SUBSYS parameter interface, follow these steps:
  1. Run the supplied sample job IVPBSUBS to test the SUBSYS-parameter interface.
    After the job has terminated, a new file starts printing on the specified CA Spool printer.
  2. To test the ESFALLOC TSO command, first start a TSO session. After the session is started, you can use the ESFALLOC command, as follows:
    ALLOC DUMMY FILE(SYSPRINT) ALLOC DUMMY FILE(SYSIN) ALLOC CAI.CBQ4PARM(CAIQPARM) FILE(SYSUT1) SHR ESFALLOC SYSUT2 DEST(destination) SUBSYS(ESF) CALL 'SYS1.LINKLIB(IEBGENER)' FREE FILE(SYSPRINT,SYSIN,SYSUT1,SYSUT2)
    Specify the name of the test printer as the destination.
Menu Verification
To verify the menu system and the Advanced Communication Interface
  1. Start a TSO session and test the menu system from TSO.
  2. Start the menu system by entering the native TSO command:
    ESFMTSO
Post-Installation Considerations
Now that you have successfully installed
CA Spool
, consider the following: