Previous Topic: Install ERONext Topic: Install the Viewing Option Interface


Sample FSS Definition

This example shows JES3 statements for a CA View ACIF archiver.

Place these statements in SYS1.PARMLIB.

FSSDEF,TYPE=WTR,FSSNAME=VBRMFSSS,PNAME=CVRMSFSS
DEVICE,JNAME=PRT1,DTYPE=SARACIF,MODE=FSS,
       PM=ACIF,WS=(PM),HEADER=NO

A sample PROC is in CAI.CVDEPROC.

JES3 Initialization Statements

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

The FSSDEF initialization statement is optional, but recommended. If it is omitted, JES3 generates a default for that archiver. The FSSDEF statement can contain the following parameters:

TYPE

Specifies that the FSS is an output writer for deferred printing (TYPE=WTR).

This parameter is required.

FSSNAME

Defines the unique 1- to 8-character name of an FSS.

This parameter is required.

PNAME

Defines a procedure for starting a specific CA View ACIF FSS.

The procedure (which must be defined before that FSS is started) is a member of the procedure library defined by the STCPROC parameter of the STANDARDS statement, or of the IATPLBST procedure library (the default). Different FSSDEF initialization parameters can refer to the same startup procedure.

SYSTEM

The JES3 processor on which the FSS runs.

The name must be the same as specified on the NAME parameter of the MAINPROC statement for the processor.

TERM = YES|NO

YES specifies that the FSS is terminated if the JES3 global address space terminates by a *RETURN or *DUMP operator command.

JES3 Device 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.

Step 3: Define an ACIF Archiver PROC

This PROC specifies initialization parameters and libraries that contain system and installation resources for the CA View ACIF archiver.

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.

Sample JCL for an ACIF Startup PROC

//VIEWFSS   EXEC PGM=SARFSS,TIME=1440,REGION=2M
//STEPLIB  DD DISP=SHR,DSN=CAI.CVDELOAD
           DD DISP=SHR,DSN=ACIF.LOADLIB
//SYSUDUMP DD SYSOUT=A
//SARINDEX DD DISP=SHR,DSN=CAI.CVDEOPTN
//PRT68    DD DISP=SHR,DSN=CAI.CVDEOPTN(PRT68)
//SARLOG   DD SYSOUT=A

Note: A sample PROC is in CAI.CVDEPROC.

The following explains the statements in the example:

STEPLIB DD: authorization

Defines that the CA View CAI.CVDELOAD and the ACIF load library (containing the APKACIF utility) must be in an authorized STEPLIB concatenation, or in a LNKLSTxx library.

SARINDEX DD

Specifies the PDS members containing the ACIF control statements.

For information about coding these statements, see the chapter "Archival" in the Reference Guide.

PRTnnnn DD statements

Contains parameters for each CA View ACIF archive.

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 ACIF archive.

(Optional) SARLOG DD

Specifies that CA View ACIF messages are written to it. These messages are documented in the IBM manual, Advanced Function Presentation, Conversion and Indexing Facility Application Programming Guide.

Step 4: Define FSA Device Control Statements

CA View FSA device control statements are defined in the CA View ACIF FSS start procedure with PRTnnnn DD statements. Each PRTnnnn DD statement must have a JES device initialization parameter statement (see Step 1: Define JES2 Initialization Statements and Step 2: Define JES3 Initialization Statements earlier in this chapter).

Use the sample ACIF device control statements as a guide. Place these statements in a product PARMLIB or in SYS1.PARMLIB.

Coding the Statements

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.

Sample ACIF Device Control Statements

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.

Install a CA View PDF Archiver

The following steps are required to install the CA View PDF Archiver. Each step is explained in detail in the following sections.

  1. (For JES2 sites) Define JES2 initialization statements.
  2. (For JES3 sites) Define JES3 initialization statements.
  3. Define a CA View PDF archiver PROC.
  4. Define CA View FSA device control statements.

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.

PDF indexing/archiver requires a functional subsystem definition (FSS).

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.

Step 1: Define JES2 Initialization Statements

This step provides a sample FSS definition, JES2 initialization statements, and a JES2 print statement.

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.

Sample FSS Definition

This example shows JES3 statements for a CA View PDF archiver.

Place these statements in SYS1.PARMLIB.

FSSDEF,TYPE=WTR,FSSNAME=FSSSAR,PNAME=PDFCOLCT
DEVICE,JNAME=PRT1,DTYPE=SARPDF,MODE=FSS,
       PM=PDFC,WS=(PM),HEADER=NO

A sample PROC is in CAI.CVDEPROC.

JES2 Initialization Statements

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.

The FSSDEF statement contains the following parameters:

FSSNAME

Defines the unique 1- to 8-character name of an FSS,

When you start the first CA View PDF archiver that has an FSA definition for that FSS, an FSS address space is created for the archiver. The CA View PDF interface manages this FSS and the archival FSA for the first CA View PDF archiver. If you start a second archiver with an FSA definition for the same FSS, the CA View PDF interface manages a separate FSA for the second archival FSA in that FSS.

Under JES2, each FSS can support a maximum of 24 FSAs. The actual number of FSAs per FSS depends on several factors, such as the size of resources used in the print jobs and the available virtual storage.

This parameter is required.

PROC

Defines a procedure for starting the CA View PDF FSS.

The procedure (which must be defined before this FSS is started) is a member of either SYS1.PROCLIB or a library concatenated to SYS1.PROCLIB. Different FSSDEF initialization parameters can refer to the same startup procedure.

HASPFSSM

Defines the 1- to 8-character name of the load module that is loaded into the PSF FSS address space.

This load module contains the various JES2-supplied FSI service routines. For CA View PDF, specify the default value (HASPFSSM = HASPFSSM).

JES2 PRINTER(nnnn) Statement

A PRINTER(nnnn) statement (required to define each FSA) is associated with an FSSDEF statement. Each archival FSA should have a unique PRINTER(nnnn) name. This unique PRINTER(nnnn) must match the label on the device parameter DD statement in the procedure for starting the CA View PDF FSS.

PRINTER(nnnn)

The PRINTER(nnnn) parameters define JES2 default values. The PRINTER(nnnn) statement contains the following parameters:

CLASS

Defines the output class used for selecting data sets to be archived.

This parameter is only needed when Q is specified as the work selection (WS) criterion.

DRAIN|START

One of the following:

DRAIN

Specifies that the archiver can be started by operator command.

START

Specifies that the archiver is started automatically when JES2 begins processing.

FSS

Defines the FSS for the archiver.

This value must match the value coded for an FSSNAME parameter for the corresponding FSSDEF statement. This parameter is required.

MODE

Indicates that the printer is managed by an FSS (MODE=FSS).

This parameter is required.

PRMODE

Defines the processing mode used for selecting data sets to be archived.

This parameter is only needed when PRM is specified as the 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

Defines the route code used for selecting data sets to be archived.

This parameter is only needed when R is specified as the work selection (WS) criterion.

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.

Step 2: Define JES3 Initialization Statements

This step provides a sample FSS definition, JES3 initialization statements, and a JES3 device statement.

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.

Sample FSS Definition

This example shows JES3 statements for a CA View PDF archiver.

Place these statements in SYS1.PARMLIB.

FSSDEF,TYPE=WTR,FSSNAME=FSSSAR,PNAME=PDFCOLCT
DEVICE,JNAME=PRT1,DTYPE=SARPDF,MODE=FSS,
       PM=PDFC,WS=(PM),HEADER=NO

A sample PROC is in CAI.CVDEPROC.

JES3 Initialization Statements

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

The FSSDEF initialization statement is optional, but recommended. If it is omitted, JES3 generates a default for that archiver. The FSSDEF statement can contain the following parameters:

TYPE

Specifies that the FSS is an output writer for deferred printing (TYPE=WTR).

This parameter is required.

FSSNAME

The unique 1- to 8-character name of an FSS.

This parameter is required.

PNAME

A procedure for starting a specific CA View PDF FSS.

The procedure (which must be defined before that FSS is started) is a member of the procedure library defined by the STCPROC parameter of the STANDARDS statement, or of the IATPLBST procedure library (the default). Different FSSDEF initialization parameters can refer to the same startup procedure.

SYSTEM

The JES3 processor on which the FSS runs.

The name must be the same as specified on the NAME parameter of the MAINPROC statement for the processor.

TERM = YES|NO

YES specifies that the FSS is terminated if the JES3 global address space terminates by a *RETURN or *DUMP operator command.

JES3 Device 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.

Step 3: Define a PDF Archiver PROC

This PROC specifies initialization parameters and libraries that contain system and installation resources for the CA View PDF archiver.

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.

Sample JCL for an PDF Startup PROC

//PDFCOLCT PROC
//PDFCOLCT EXEC PGM=SARFSS,TIME=1440,
//         REGION=2M
//STEPLIB  DD DSN=CAI.CVDELOAD,DISP=SHR
//SYSUDUMP DD SYSOUT=A
//PDFINDEX DD DSN=VIEW.PDFINDEX,DISP=SHR
//PRT11    DD DSN=CAI.CVDEOPTN(PRT11),DISP=SHR
//SARLOG   DD SYSOUT=A
//PDFREPRT DD SYSOUT=X         <----  DEFAULT PDF REPORT DATASET
//PDFTRACE DD SYSOUT=X         <----  DEFAULT PDF TRACE REPORT DATASET
//SARLOG   DD SYSOUT=X            <----  DEFAULT SARLOG OUTPUT.
//SYSOUT   DD SYSOUT=X            <-- -  Informationary messages from PDF DEFLATE.
//STDERR   DD SYSOUT=X        
//        PEND
//VIEWPDF EXEC PROC=PDFCOLCT

Note: A sample PROC is in CAI.CVDEPROC.

The following explains the statements in the example:

STEPLIB DD: authorization

Defines the CA View CAI.CVDELOAD must be in an authorized STEPLIB concatenation, or in a LNKLSTxx library.

PDFINDEX DD

Specifies the PDS members containing the PDF control statements.

For information about coding these statements, see the chapter "Archival" in the Reference Guide.

PRTnnnn DD statements

Contains parameters for each CA View PDF archive.

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 PDF archive.

SARLOG DD

Specifies that CA View PDF messages are written to it. These messages are documented in the Message Guide. The SARLOG DD statement is optional.

Step 4: Define FSA Device Control Statements

CA View FSA device control statements are defined in the CA View PDF FSS start procedure with PRTnnnn DD statements. Each PRTnnnn DD statement must have a JES device initialization parameter statement (see Step 1: Define JES2 Initialization Statements and Step 2: Define JES3 Initialization Statements earlier in this chapter).

Use the sample PDF device control statements as a guide. Place these statements in a product PARMLIB or in SYS1.PARMLIB.

Code the Statements

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.

Sample PDF Device Control Statements

TYPE=PDF
ARCHMSG=LOG
NAME=CA VIEW.SAR.DATABASE.TO.RECIEVE.INTO

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.