Archive SYSOUT

The started task SARSTC performs SYSOUT archival. SARSTC is started at system IPL time and remains active until the operating system is brought down. SARSTC uses the standard subsystem interface (SAPI) to JES2 or JES3 to request SYSOUT for archival. It remains in a wait state during the periods when no SYSOUT is available for archival.
view
The started task SARSTC performs SYSOUT archival. SARSTC is started at system IPL time and remains active until the operating system is brought down. SARSTC uses the standard subsystem interface (SAPI) to JES2 or JES3 to request SYSOUT for archival. It remains in a wait state during the periods when no SYSOUT is available for archival.
For spool datasets that are encrypted with JES2 Spool encryption, the CA View and CA Deliver started tasks require read access to the encryption keys. Without read access to the encryption keys, the CA View started task terminates with error messages from the security product and the CA Deliver started task terminates with user abend code U0003, with the result that the respective datasets are not archived.
Contents
Archival Selection Criteria
The initialization parameters shown in the following table are available for specifying the criteria used for selecting SYSOUT for archival.
  • CLSL
    Specifies a character string made up of one to eight SYSOUT classes.
  • DEST
    Specifies the Destination.
  • FORM
    Specifies the Forms name.
You can specify each parameter. If you specify more than one parameter, the SYSOUT
must
meet all the specifications for it to be archived.
For example, suppose you specify MSGCLASS=P on the JOB statements for all production jobs at your site, and the reports produced by the jobs are output to SYSOUT classes C, D, E, F, and G. To archive the production JCL listings, specify:
CLSL=P
To archive the production reports, specify:
CLSL=CDEFG
If you wanted to archive only production reports destined to be printed at remote 10, specify:
CLSL=CDEFG DEST=RMT10
CA View receives its SYSOUT from JES similar to that of a printer. If a printer is set with the same attributes as the CA View archival criteria, the printer and CA View compete for SYSOUT from JES. Therefore, ensure that none of your printers is set to the CA View archival criteria; otherwise, some of your SYSOUT is printed directly, rather than passed to CA View for archival.
Record Length
Logical records for reports processed by the product cannot exceed 32752 for fixed-length records or 32756 for variable-length records and also includes the carriage control character.
Viewing AFP Reports
You have several options for viewing AFP reports through the online system. You can:
  • View the report as printed, with CA Output Management Document Viewer.
  • View the text portions of the report on a 3270 terminal, by selecting the report.
Method of Operation and the Backup Cycle
The CA View archival started task receives SYSOUT from the job entry subsystem using the standard subsystem interface (SAPI).
CA View receives SYSOUT from JES, writes it out as its current disk generation to its database, and records its location and characteristics in a master index that also resides in its database. At specified intervals, it automatically performs a backup cycle while continuing to archive SYSOUT. Two types of backup cycles can be performed:
  • For non-baseyear databases (ARCHCHG=NO), the
    standard backup cycle
    increments the current generation number by one, so that archival of SYSOUT continues to a new generation.
  • The
    interim backup cycle
    does not increment the generation number or start the microfiche task. After an interim backup, archival of SYSOUT continues to the same generation.
  • For baseyear databases (ARCHCHG=yyyy), the generation number is incremented either when the first report is archived after midnight, or when the first standard backup cycle is run after midnight.
Both types of backup cycles are asynchronous, that is, the backup cycle executes concurrently with archival of SYSOUT.
The backup cycle consists of the following list:
  • Creating a new current generation (standard backup only)
  • Backing up SYSOUT not currently on tape media
  • Purging entries for "old" SYSOUT from the master index
  • Cleaning up and recovering space for SYSOUT groups that were
    • migrated to tape status
    • loaded temporarily to disk
    • created actively before a system crash or abend
  • Backing up the master index to tape
  • Updating the CA View recovery file
  • Un-catalog tape data sets no longer required
  • Starting the microfiche task (standard backup only)
In addition to the automatic initiation of the backup cycle by CA View, you can initiate a backup cycle at any time using the operator commands.
A tape is considered expired, when:
  • There are no active reports, that is, all reports have expired
  • There are no active Master Index backups, that is, the difference between the Current Generation Number and the Generation Number of the Master Index backups on the tape is greater than the number of index generations to be saved (initialization parameter NGENI=)
  • The tape is at least five days old.
The Backup Cycle Report (SARBKLST) lists the fully-qualified tape dataset names and the volume serial number containing the backup data. The volume serial number shown on the report represents the current volume serial number. This number can differ from the original volume serial number if the tape was copied to a new volume with the Tape Copy Utility (SARTCP). The volume serial number can also be shown as "*NOCAT" if the dataset is no longer cataloged.
Reports
The SARBKLST DD statement instructs CA View to automatically create the following report list:
  • All reports that were backed up to tape
  • All reports that were deleted from the database
  • All archival and DR backup tapes that were uncataloged. The SARDRLST DD statement produces a list of all reports backed up to the DR tape.
Note:
Archiving the SARBKLST report through CA Deliver using direct archival to the CA View database can cause S138 allocation abends during the CA View backup cycle.
If the SARBKLST report in the CA View started task is defined to CA Deliver, and CA Deliver is coded to archive this report by direct archival to the CA View database, S138 allocation errors can occur during the CA View backup cycle. This result depends on system activity, dispatch priorities, and so on. To avoid this error, do not archive the SARBKLST report direct from CA Deliver to CA View. Define the SARBKLST report to CA Deliver with a new ARCH
x
parameter that sends the archive copy to the JES spool, and then CA View archives the SARBKLST report from the JES spool.
Also, define the SARBKLST report if you are archiving into the same CA View that produced it, so that CA Deliver picks it up post-spool. That is, direct the output to the CA Deliver NETCLSL/NETDEST/NETFORM. Attempting to handle it in pre-spool (JOBCLSL/SYSCLSL) results in SARSTC07 archive failures.
The following is an example of a SARBKLST report:
11/10/2013 18:37:46 CA View Output Archival and Viewing (nn.n) PAGE 1 SARBKLST VIEW.SYSTEM1 System Archival Task - Backup List Standard Backup of Gen 00026 Seq=00047 Vol=428119 Duplex=*NONE* Storgrp=DEFAULT Dsname=VIEW.SYSTEM1.SARTAPE.0000047 Id Jobname Jobid Gen Seq Arc Date Arc Time Loc Lines Pages Dasd Blks File Time ------------------------------- -------- -------- --- --- ---------- -------- ---- ----- ----- --------- ---- -------- REPORT1 COOCH03B JOB01396 25 12 11/10/2013 17:29:42 DISK 12600 200 265 1 18:37:46 REPORT1 COOCH03B JOB01395 25 11 11/10/2013 17:29:39 DISK 12600 200 265 2 18:37:48 REPORT1 COOCH03B JOB01394 25 10 11/10/2013 17:29:35 DISK 12600 200 265 3 18:37:49 REPORT1 COOCH03B JOB01392 25 9 11/10/2013 17:29:32 DISK 12600 200 265 4 18:37:51 REPORT1 COOCH03B JOB01391 25 8 11/10/2013 17:29:28 DISK 12600 200 265 5 18:37:52 REPORT1 COOCH03B JOB01187 25 3 11/10/2013 16:17:45 DISK 12600 200 265 6 18:37:54 Total reports backed up to tape = 6 ______________________________________________________________________________________________________________________________ 11/10/2013 18:37:46 CA View Output Archival and Viewing (nn.n) PAGE 2 SARBKLST VIEW.SYSTEM1 Sysout Archival Task - Reports and Resource Groups Deleted Standard Backup of Gen 00026 Id Jobname Jobid Gen Seq Arc Date Arc Time Loc Lines Pages Dasd Blks File Time ------------------------------- -------- -------- ---- ---- ---------- -------- ---- ----- ----- --------- ---- -------- D68D50AE SARFSSCC STC01203 *PPS RSRC* 11/10/2013 17:44:11 DISK 227 70 1 18:37:56 F268B60C SARFSSCC STC03326 *PPS RSRC* 11/10/2013 15:57:30 DISK 157 47 2 18:37:56 779AA128 SARFSSCC STC01181 *PPS RSRC* 11/10/2013 15:58:42 DISK 100 23 1 18:37:56 Total reports and resource groups deleted = 3 ______________________________________________________________________________________________________________________________ 11/10/2013 18:37:46 CA View Output Archival and Viewing (nn.n) PAGE 3 SARBKLST VIEW.SYSTEM1 Sysout Archival Task - Backup List Standard Backup of Gen 00026 Id Jobname Jobid Gen Seq Arc Date Arc Time Loc Lines Pages Dasd Blks File Time ------------------------------- -------- -------- ---- ---- ---------- -------- ---- ----- ----- --------- ---- -------- Seq=00047 Vol=428119 Duplex=*NONE* Storgrp=DEFAULT Dsname=VIEW.SYSTEM1.SARTAPE.0000047 ------------------------------------------------------------------------------------------------------------------------------ Master index backed up at file 7 on Vol 428119 ______________________________________________________________________________________________________________________________ 11/10/2013 18:37:46 CA View Output Archival and Viewing (nn.n) PAGE 4 SARBKLST VIEW.SYSTEM1 Sysout Archival Task - Tapes Uncataloged Standard Backup of Gen 00026 Tape Dataset Name Volser -------------------------------------------- ------ VIEW.SYSTEM1.SARTAPE.T0000021 434675 VIEW.SYSTEM1.SARTAPE.T0000022 410838 VIEW.SYSTEM1.SARTAPE.T0000023 434804 VIEW.SYSTEM1.SARTAPE.T0000025 413175 VIEW.SYSTEM1.SARTAPE.T0000026 433066 VIEW.SYSTEM1.SARTAPE.T0000027 425245 VIEW.SYSTEM1.SARTAPE.T0000031 483693 VIEW.SYSTEM1.SARTAPE.T0000032 484218 VIEW.SYSTEM1.SARTAPE.T0000033 482487 VIEW.SYSTEM1.SARTAPE.T0000034 482060 VIEW.SYSTEM1.SARTAPE.T0000039 460308 VIEW.SYSTEM1.SARTAPE.T0000040 478871
Backup Status Report
The Backup Status report is produced during a Backup Cycle when a SARBKLST DD Statement is present in the Started Task (SARSTC) JCL.
The following are the four sections of the report:
  • Reports backed
  • Reports deleted (expired)
  • Master Index backup information
  • Tapes uncataloged (expired)
Master Index Backup Report Sections
Information pertaining to the Master Index backup is displayed on separate pages. The general format on the page contains:
  • Tape sequence number
  • Primary tape volume serial number
  • Optional duplex tape volume serial number
  • Backup generation number
  • Primary tape dataset name.
The body of the report contains
  • The file sequence number of the Master Index on the primary and optional duplex tapes
  • The primary tape volume serial number.
One page is displayed when the Master Index resides on a single tape as shown in the following illustration.
11/10/2013 09:23:22 CA View Output Archival and Viewing (nn.n) PAGE 3 SARBKLST VIEW.SYSTEM1 Sysout Archival Task - Backup List Standard Backup of Gen 000005 Id Jobname Jobid Gen Seq Arc Date Arc Time Loc Lines Pages Dasd Blks File Time ------------------------------- -------- -------- ---- ---- ---------- -------- ---- ----- ----- --------- ---- -------- Seq=00009 Vol=264388 Duplex=*264603 Storgrp=DEFAULT Dsname=VIEW.SYSTEM1.SARTAPE.0000009 ------------------------------------------------------------------------------------------------------------------------------ Master index backed up at file 2 on Vol 264388+
Multiple pages are displayed when the Master Index resides on more than one tape. Each page header contains:
  • Tape sequence number
  • Primary tape volume serial number
  • Optional duplex tape volume serial number
  • Backup generation number
  • Primary tape data set name
Archival and Database Space
If CA View runs out of space in its database while archiving SYSOUT, it prompts the operator for a recovery option. The operator can:
  • Add additional space to the database while the archival task waits, then request the archival task to retry
  • Request the archival task to perform its standard backup cycle and then retry
  • Request the archival task to terminate
Archival Generations
The time interval during which CA View logically archives SYSOUT in a group for reference purposes is defined as a generation. For non-baseyear databases (ARCHCHG=NO), a generation can be defined as the period from one standard backup cycle to the next, because it is the backup cycle that creates a generation. The site has complete control over the beginning and length of time of the generation with the TIME and INTERVAL initialization parameters. For most sites, the interval is 24 hours and comprises the daily production cycle of the site.
For a baseyear database (ARCHCHG=yyyy), a generation is defined as the number of calendar days since the first day of the baseyear specified. For example, if the baseyear is set to 2014 (ARCHCHG=2014), January 1,2014 is considered generation 1, January 2, 2014 is considered generation 2, and so forth.
Note:
You can perform interim backups by specifying the NBACKUP initialization parameter. Automatic interim backups are dependent on the standard backup. If no standard backup is performed, TBACKUP=NO, or DAYS=NNNNNN, no interim backups are performed.
You can suppress a backup cycle for any day of the week with the DAYS initialization parameter. For example, assume that the site is "closed" on Sundays, with no operator on hand to mount tapes for the backup cycle. In this case, the site suppresses the automatic backup cycle on Sundays by setting DAYS=YYYYYYN.
You use the NGEND and NGENT initialization parameters, respectively, to specify the number of generations of SYSOUT maintained on disk and the number maintained on tape. For example, to keep three generations of SYSOUT on disk and 90 generations on tape, specify:
NGEND=3 NGENT=90
In this example, CA View retains 90 total generations. In a non-baseyear database, immediately after a job runs, three generations of the job are on disk. The most recent generation resides on disk only and the next two generations reside both on disk and tape. The remaining 87 generations reside on tape only. Immediately after a standard backup cycle, only the two most recent generations reside on disk and tape; the remaining 87 generations reside on tape only. The NGENT value includes the NGEND value.
Direct-to-Tape Archival
For large reports, or other SYSOUT for which the site does not require immediate access but for which archival is desired, the site can define from one to eight classes to be archived directly to tape. The initialization parameter used to define direct-to-tape archival classes is TAPECLSL.
For example, if you want to archive all SYSOUT with a form name of VIEW and, of the SYSOUT that is archived, you want any class T or U SYSOUT archived directly to tape with no disk storage being used, specify the following parameters:
FORM=VIEW TAPECLSL=TU
Due to the sequential nature of tape, some restrictions exist for SYSOUT archived directly to tape. These restrictions are:
  • Exceptional conditions do not cause the automatic printing of the SYSOUT
  • The microfiche started task does not process the SYSOUT
For performance reasons, after a SYSOUT data set is selected for archival, a tape drive is allocated. It remains allocated through the next backup cycle or until the archival task is stopped. Alternatively, you can specify the UNLOAD initialization parameter to unload and free the tape drive after each SYSOUT group is archived to tape.
Note:
If SYSOUT is being archived to tape when a backup cycle is initiated, archiving is suspended until the backup has been completed.
All direct-to-tape SYSOUT is written to STORGRP0, the default tape storage group. If you specify a group other than STORGRP0 for the SYSOUT, the consolidation program SARPAC honors that group when it processes the tape.
No Archival Option
CA View can process SYSOUT without actually archiving it to any disk or tape file. A site can choose to use this facility for certain classes of SYSOUT to take advantage of the user exits available with the product. For example, a site can create special banner pages for its SYSOUT with CA view, even if there is no archival.
The site can specify from one to eight SYSOUT classes for which no archival is done with the NARCCLSL initialization parameter. The same two restrictions listed for direct-to-tape archival also apply to the no archival option.
Exceptional Condition Processing
During SYSOUT processing, CA View scans for exceptional conditions. The type of conditions that are treated as exceptions are specified in a table of control statements to the archival started task. This table can be updated and refreshed while the product is executing through an operator command. User exit SARSTCUX can also be used to specify exceptional conditions.
The ROUT, DESC, and XPRINT parameters specify the action taken whenever an exceptional condition occurs. A message is issued to the operator identifying the exceptional condition when a nonzero route code is specified. The ROUT and DESC operands specify the route and descriptor codes, respectively.
XPRINT=YES causes the SYSOUT to print automatically whenever an exceptional condition occurs. CA View dynamically allocates a SYSOUT data set.
The default exceptional conditions for which CA View checks are:
  • Nonzero condition code
  • System or user abend
  • JCL error
  • Data set cataloging error
  • Data set not deleted error
  • Operator cancel of allocation request
CA View can also check for a user-specified text string as an exceptional condition in the SYSOUT.
The conditions can be modified using control statements specified earlier in this section.
Printing SYSOUT
You can specify one to eight classes of SYSOUT for automatic printing at time of archival using the PRTCLSL initialization parameter. Any SYSOUT group that is being archived whose class matches one of the classes specified with the PRTCLSL initialization parameter is written back out to SYSOUT by CA View.
When printing SYSOUT, CA View dynamically allocates a SYSOUT data set and writes the archived SYSOUT to it either because its class matches one of the PRTCLSL classes or because XPRINT=YES is specified and an exceptional condition occurs. You can override the original class, destination, and form attributes by using the NEWCLSL, NEWDEST, and NEWFORM parameters, respectively. All other attributes remain the same.
Archival of JCL Listings
The key to archiving JCL listings (including the job log and allocation messages) is in separating the JCL listing SYSOUT from the report SYSOUT produced by a job based on one or more of the following archival selection criteria: class, destination, and forms name. This separation can be accomplished in several ways, including:
  • Assigning a different SYSOUT class in the MSGCLASS JOB statement parameter from those classes specified in the SYSOUT DD statements for the jobs
  • Assigning a special forms name or destination to the JCL listings for a job with the /*OUTPUT SYS JES2 control statement
  • Assigning a special forms name or destination to the JCL listings for a job with the //*FORMAT PR JES3 control statement for ddnames: SYSMSG, JESJCL, and JESMSG
  • Assigning a special forms name, destination, or SYSOUT class to the JCL listings for a job with the //
    name
    OUTPUT JESDS=ALL JCL statement
You can archive some or all of the report SYSOUT for a job and its JCL listing. But, ensure that the SYSOUT attributes of the DD statements you want to archive match the JCL listing attributes.
Archival of Report SYSOUT
Report SYSOUT
refers to any SYSOUT produced for a job using DD statements (both those contained in the JCL and those dynamically allocated).
You can handle Report SYSOUT as follows:
  • Directly by CA View as with the JCL listings
  • Indirectly by archiving a copy of the report SYSOUT that has been produced by the automatic report archival feature of system extensions.
Whether you choose to archive reports directly with CA View or indirectly using the automatic report archival feature depends primarily if you want to print the reports or track the reports under JES.
Direct archival of reports with CA View is the easiest and most straightforward approach. You specify the archival selection criteria to CA View. The PRTCLSL initialization parameter in CA View reprints. Because CA View automatically reprints the reports, they are identified to JES under the name of the archival started task and not under the name of the creating job. When reports are printed, the CA View produced banner pages identify the creating job.
Alternatively, with the automatic report archival feature, JES directly prints the reports and are identified to it under the name of the creating job. The automatic report archival feature for "spin-off" to CA View produces a copy of the reports.
Do not have a channel skip statement in the last line of any page of a report. If a report has a channel skip statement at the bottom of a page, follow it with a blank line; otherwise, the channel skipping is not honored.
Archival of SYSLOG Data
You can select SYSLOG data for archival by SYSOUT class. When SYSLOG data is queued for print using the WRITELOG operator command or at IPL time, it can be archived by CA View. Therefore, if you want to archive SYSLOG data, have your SYSLOG data queued for print at regular intervals. The length of the interval determines the age of the most current archival group of SYSLOG data.
You can use the automatic command facility to queue SYSLOG data at regular intervals. For example, to queue SYSLOG data on an hourly basis for archival to CA View, establish the following automatic command as part of your IPL procedure:
$TA,I=3600,'$VS''W'''
Coordinate the process of implementing archival of SYSLOG data with your systems programming staff.
Additional FSS/VIEW Archival
The SARSTC task must complete archival of a SYSOUT before starting archival of the next sysout. The single threading can lead to a backlog of reports in the JES spool. To improve this situation, additional FSS/VIEW archiver collectors can be defined to JES to allow multiple SYSOUTs to be archived concurrently.