Archive PDF Documents

You can archive PDF documents with the CA View PDF (PDF Indexing Facility) archiver. A PDF archiver is a Functional Subsystem Application (FSA) that runs under a separate address space called a Functional Subsystem (FSS). A Functional Subsystem Interface (FSI) maintains communication between the FSS and the JES global address space.
view
You can archive PDF documents with the CA View PDF (PDF Indexing Facility) archiver. A PDF archiver is a Functional Subsystem Application (FSA) that runs under a separate address space called a Functional Subsystem (FSS). A Functional Subsystem Interface (FSI) maintains communication between the FSS and the JES global address space.
Use the PDF Indexing Facility to:
  • Create indexes of PDF documents so that they can be retrieved and displayed using the CA Output Management Web Viewer.
  • Archive PDF documents that require no indexing.
For CA Deliver clients, PDF data
cannot
be archived using CA Deliver direct to CA View archival; it must be archived to JES.
For spool datasets that are encrypted with JES2 Spool encryption, the SARFSS collector task requires read access to the encryption keys. Without read access to the encryption keys, the respective datasets are not collected.
Contents
2
2
Starting and Stopping PDF Archival
Under JES2, a PDF archiver FSA can be started as follows:
  • An operator can enter the START DEVICE JES2 command
  • Automatically, when JES2 is brought up
    The PRT
    nnnn
    statement for the printer FSA must contain the START parameter
  • Under JES3, a PDF archiver FSA can be started as follows:
  • An operator can enter the START WRITER JES3 command
  • JES3 starts the PDF archival when printing is scheduled for a printer FSA
If you do not want archiving to stop after each job, you can define the FSS as a JES3 "hot writer," keeping the address space active.
Note:
The PDF archival FSA differs from normal printers in that it can only be started and stopped. Positioning commands, such as those to interrupt a printer, forward space, or backspace the printer, cannot be used.
Viewing PDF Documents
The following two methods are available:
  • You can view the PDF documents through the CA View system by using CA Output Management Document Viewer.
  • You can do the following actions:
    1. Use a CA View batch JCL deck to offload the document to the mainframe.
    2. Use FTP to upload the document to the user's PC.
    3. View the document using Adobe Acrobat reader.
Indexing PDF Documents
For each SYSOUT data set to be processed by a CA View PDF archiver, a set of control statements can be used to define indexing criteria and provide other attributes for archival.
These control statements are created as members of the PDFINDEX PDS, specified in the CA View PDF start procedure.
The name of the member can be coded on the JES FORMS=, Writer=. If neither value is specified, the PDF collector looks for a member name of the JES JOBNAME.
JES FORMS= and WRITER= can be set as a parameter of the //OUTPUT JCL statement for the SYSOUT data set. The selection sequence for these member names is as follows: Writer=, is searched first then FORMS=, and finally JES JOBNAME.
If no member is found, an error message is displayed. The PDF document is held on the JES print queue until a valid member name is created in the PDFINDEX PDS data set. The document is released from the JES print queue to process through the PDF collector again.
Archiving a PDF that is Not Indexed
If no indexing is required for a PDF document, a default member with no indexing commands lets you capture the PDF document for archiving without any indexing in CA View.
PDF Report Archival Example
The following example describes how to implement the CA View PDF archival interface to archive a PDF document.
If you defined a CA View PDF archiver to JES2 as device PRT18, JES2 is to select any data set for this archiver with a processing mode of PDFC. The name of the start procedure is CBRMSPDF.
JES2 Commands
The following dynamic z/OS JES commands define a JES FSS and JES Printer to test with:
Note:
After an IPL, the JES FSS and printer are redefined, though not recommended for production use.
$ADD FSSDEF(CBRMSPDF),PROC=CBRMSPDF $T FSS(CAHAB6PD),AUTOSTOP=YES $ADD PRT18,MODE=FSS,FSS=CAHAC0PD $T PRT18,CLASS=J,FORMS=,PRMODE=(PDFC) $T PRT18,WRITER=,JOBNAME=* $T PRT18,WS=(Q,PRM/F,W,R,LIM,UCS,FCB) $S PRT18
JES2 Control Statements
The following JES2 control statements are coded for this example:
FSSDEF(CBRMSPDF) PROC=CBRMSPDF PRT18 FSS=CBRMSPDF, MODE=FSS, NOSEP, NOSEPDS, PRMODE=(PDFC), WS=(Q,PRM/F,W,R)
Start Procedure for CBRMSPDF
The start procedure for CBRMSPDF is as follows:
//CBRMSPDF PROC //CBRMSPDF EXEC PGM=SARFSS,TIME=1440,REGION=2M //STEPLIB DD DSN=CAI.CVDELOAD,DISP=SHR //SYSUDUMP DD SYSOUT=X //PDFINDEX DD DSN=VIEW.PDFINDEX,DISP=SHR //PRT18 DD DSN=CAI.CVDEOPTN(PRT18),DISP=SHR //SARLOG DD SYSOUT=X //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=CBRMSPDF
Device Control Statements for PRT DD Statement
The following are the JES2 device control statements for PRT18 of our example:
TYPE=PDF ARCHMSG=LOG NAME=VIEWDB.HLQ
Sample Application Job
The following sample job generates SYSOUT to be indexed by the CA View PDF collector and archived:
//TESTJOB1 JOB ...... //PDFOUT OUTPUT FORMS=DOCIX101,PRMODE=PDFC //STEP1 EXEC PGM=IEBGENER //SYSPRINT DD SYSOUT=* //SYSIN DD DUMMY //SYSUT2 DD SYSOUT=J,COPIES=1,OUTPUT=(*.PDFOUT) //SYSUT1 DD DSN=TEST.PDF.TEST.CASES(PDFNOTES)
The FSS collector for the PDF document generates the following report. The DD name is PDFREPT.
JOBNAME=TESTJOB1 JOBID=JOB10150 STEP = STEP1 SYSUT2 STARTING **** START **** PDF Page data - PDF OBJECT NUMBER IS 00000180 0 PDF POSIITON--------DATA START----+----20---+----30---+----40---+----50---+----6 78 735.0601 78 735.0601 78 671.82 Section 4: Upgrade Considerations 78 671.82 78 654.0601 78 654.0601 186 630.66 The extensive changes will require specific actions before you begin the upgrade. This section information about the following: 186 588.66 190.5 588.66 Pre-upgrade Requirements Index NAME REQUIRE record above - Index VALUE is Requirements 190.5 588.66 204 570.66 The minimum release requirements 19.24 0 that you -19.24 -1.333 must be running before you can upgrade
PDF Control Statements
The following PDF control statements are in member DOCIX101 of the PDFINDEX PDS. They are indexing report commands for the PDF document.
/********************************************************************** /* PDF PAGE DATA INDEX DEFINITIONS FOR REPORT /* LINES WITH SLASH ASTERISK IN COLUMN 1 ARE COMMENT LINES /* NAME PDF LOCATION 15 = MAXIMUM LENGTH OF FIELD /********************************************************************** INDEX=(REQUIRE,*,EQ,Requirements) <---Any position look for the word Requirements MEMORY=9000, MEMORY IN KB DEFAULT = 96801 MAXOBJCT=1500, DEFAULT MAXIMUM IS 30000 PDF OBJECTS /*TRACE=ALL PDF TRACE COMMAND FOR DOCUMENT /*TRACEDDN=PDFTRC83 PRINTER PROC DEFAULT DDNAME FOR PDFTRACE DDN /*REPRTDDN=PDFREP83 PRINTER PROC DEFAULT DDNAME FOR PDFTRACE DDN XYDUMP=YES PRINT A PDF REPORT (YES OR NO) XYPAGES=10 DEFAULT NUMBER OF PDF PAGES TO PRINT; 0=NOPRINT
Important Considerations
Create the index members for each report by specifying XYDUMP=YES in the PDFINDEX member. So, when you load the PDF document into the CA View database, you see a PDFREPT data set created for that document which is used to create the index criteria control statements.
These control statements specify the location of each field within the PDF document; use them as the PDF location value and when defining the index.
The Index=(NAME,,,,) in the previous example for member DOCIX101 are defined in the CA View panels to enable cross-report indexing for each field. It also ensures that CA Web Viewer uses the indexes to display the PDF indexed document.
The Define VIEW command is used to define this Index member name (DOCIX101) as the VIEW ID in the panels. It also helps define each named index field with a unique View number.