Expanded Retention Parameters

Expanded retention initialization parameter statements follow the same syntax and restrictions as the initialization parameter statements. Several of these initialization parameters work in conjunction with parameters that are specified in the Expanded Retention table.
view122
Expanded retention initialization parameter statements follow the same syntax and restrictions as the initialization parameter statements. Several of these initialization parameters work in conjunction with parameters that are specified in the Expanded Retention table.
The Expanded Retention Option must be installed and operational to use the following parameter statements.
DSK2DAYS
This parameter is used by secondary storage device drivers such as Centera disks. For more information, see Optical Disk Interface.
Syntax:
DSK2DAYS=
nnn
The default is 999.
Valid values are 0-999.
DSK2DRVR
This parameter is used by secondary storage device drivers such as optical disks. For more information, see Optical Disk Interface .
Syntax:
DSK2DRVR=
driver
There is no default.
DSK2INTV
This parameter is used by secondary storage device drivers such as optical disks.
Syntax:
DSK2INTV=
hhmm
where:
  • hh
    Indicates hours from 00-24.
  • mm
    Indicates minutes from 00-59.
The maximum value for this parameter is 2400.
A value of zero is converted to the default of 0015.
DSK2MIGD
This parameter is used by secondary storage device drivers such as optical disks.
Syntax:
DSK2MIGD=xxxxxxx
The default is BBBBBBB
DSK2PARM
This parameter is used by secondary storage device drivers such as optical disks.
Syntax:
DSK2PARM=
xxxxxxxxxx
There is no default.
DSK2TIME
This parameter is used by secondary storage device drivers such as optical disks. For more information, see Optical Disk Interface.
Syntax:
DSK2TIME=
nnnn-nnnn,nnnn-nnnn,nnnn-nnnn,nnnn-nnnn
There is no default.
EROOPT
This parameter specifies whether the Expanded Retention Option is being used. Indicate YES to retain Expanded Retention Initialization parameters, or NO to delete reference to all expanded retention initialization parameters.
Syntax:
EROOPT=YES|NO
For an existing database, EROOPT defaults to YES if Expanded Retention Initialization parameters exist or new Expanded Retention Initialization parameters are being set; otherwise, this parameter defaults to NO.
For a new database, EROOPT defaults to YES if Expanded Retention Initialization parameters are specified; otherwise, this parameter defaults to NO.
If using the SARINIT ARCHCHG=yyyy parameter to establish a baseyear, EROOPT must be set to YES.
EROPRO
The EROPRO parameter directs the processing decisions made by the Expanded Retention Option as they pertain to SYSOUTs not currently under ERO control.
This parameter does not dictate how ERO applies to or maintains retention parameters for SYSOUT already under ERO control.
  • Changes to retention parameters that can affect a SYSOUT that is already under ERO control are reflected in all SYSOUTs regardless of the setting of the EROPRO parameter and regardless of when the SYSOUT was created.
    As an example, a change to the retention value in an ERO Table entry for a SYSOUT or group of SYSOUTs are to be retroactively applied to all SYSOUTs regardless of the setting of the EROPRO parameter.
  • SYSOUTs that are not under the control of ERO are affected by the setting of the EROPRO parameter.
    As an example, if a catch-all entry is added to the ERO Table (/*....) and the EROPRO parameter is set to NEW, only SYSOUTs in the current generation are to have the new ERO retention applied to them. SYSOUTs created in previous generations are not affected.
    If the EROPRO parameter is set to YES (or ALL), and the catch-all entry is added to the ERO table, then ALL SYSOUTs receive ERO retention regardless of when they were created.
We recommend that EROPRO be set to YES and left that way unless a large percentage of the database is under standard retention; then we recommend a value of NEW.
If using the SARINIT ARCHCHG=yyyy parameter to establish a baseyear, EROPRO must be set to YES.
Reports under ERO control have a location of PERM, DSK, PTAP, PTMP, PDK2, and PRM2. Reports not under ERO control have a location of DISK, TAPE, and TEMP.
Syntax:
EROPRO=NEW|YES|ALL
The default is NEW.
Values are as follows:
  • NEW
    Only SYSOUTs in the current generation are eligible to switch to ERO retention.
  • YES
    ALL SYSOUTs are considered, and the parameter is not reset to NEW at the end of the backup cycle.
  • ALL
    A one-time request to reconsider the entire database.
    This is reset to NEW at the end of the backup cycle.
PCOPIES
This parameter specifies the number of copies of each SYSOUT that are maintained for each unique SYSOUT identifier.
Syntax:
PCOPIES=
nnnnn
The default is 2.
Valid values are 1-32767.
PMXTAPES
This parameter specifies the maximum number of tapes that can be consolidated in any one execution of the SARPAC tape consolidation program.
Syntax:
PMXTAPES=
nnnnn
The default is 20.
Valid values are 1-32767.
PMXYEARS
This parameter specifies the maximum number of years that data can reside on a tape and is used by the SARPAC tape consolidation program. When the creation date for the tape exceeds this value, the tape is selected for consolidation.
Syntax:
PMXYEARS=
nnnnn
The default is 3.
Valid values are 0-32767.
Specifying a maximum number of years is important, because tapes tend to have I/O problems as they age. Value of zero disables this SARPAC feature.
POPT
This parameter specifies how SYSOUT is assigned for expanded retention.
The parameter has two different implementation effects:
  • Effect 1: Its assignment as the default for ERO table entries that do not specifically code ALL, LAST, or MARK. An ERO table entry normally contains report identification, report selection, and report retention period:
    • The report identification can be a complete report name or a partial report name with wildcards.
    • The retention specification can define days, generations, or copies for both the disk retention and total database retention.
    • The report selection can identify ALL reports with this name, only the LAST report with this name, or only reports that have been identified with the MARK (K) command on the SYSOUT Selection panel.
    A retention table entry that does not specifically code the report selection operand obtains a default value as defined by the POPT parameter. The operand value of A causes the retention table entry default to be ALL, L is LAST, and M is MARK.
  • Effect 2: The effect this parameter has on the implementation of ERO to determine the retention of reports not specifically identified with retention table entries. The PRETAIN and PCOPIES initialization parameters affect this default retention.
Syntax:
POPT=M|L|A
The default is M.
Values are as given following:
  • M
    Only SYSOUTs marked from the online or batch facility are to be given expanded retention.
  • L
    The last (most recent) SYSOUT for each unique SYSOUT identifier in the current generation is given expanded retention. If you specify L, and a SYSOUT identifier is marked online for expanded retention, the marked SYSOUT is given expanded retention instead of the last (most recent) SYSOUTs.
  • A
    All SYSOUTs from the current generation are to be given expanded retention.
PRETAIN
This parameter specifies the expiration parameters of ERO (Expanded Retention Option) reports.
Syntax:
PRETAIN=INIT|TABLE
The default is INIT.
Retention is as follows:
  • PRETAIN=TABLE
    Specifies that an operand value of TABLE for the PRETAIN initialization parameter directs the system to use ERO only for reports that have a matching retention table entry. Be aware of the following:
    • The operand value of the PCOPIES parameter is used as default for all reports not specifically identified by a retention table entry and
    • The operand value of POPT is used only as a default for retention table entries that do not specifically code a report selection option.
      If POPT=A, then all non-matching reports should be retained for PCOPIES.
      If POPT=L, then only the last or latest copy of a non-matching report must be retained for PCOPIES.
      If POPT=M, then only non-matching reports that have been identified with the MARK (K) command on the SYSOUT Selection panel should be retained for PCOPIES.
  • PRETAIN=INIT
    Specifies that an operand value of INIT for the PRETAIN initialization parameter directs the system to use POPT and the larger of the values PCOPIES and NGEND or NGENT. This larger value is used as the default for all reports not specifically identified by a retention table entry.
    The value of POPT determines if PCOPIES should be applied to ALL, LAST, or MARK reports that do not have a matching table entry.
    • If POPT=A, all non-matching reports must be retained for PCOPIES.
      After PCOPIES has been satisfied, the report retention can revert to the values associated with the NGEND and NGENT initialization parameters. The numeric value of NGEND and NGENT can be smaller than PCOPIES and can cause the document to be deleted.
    • If POPT=L, the last or latest copy of a non-matching report should be retained for PCOPIES.
      After PCOPIES is satisfied, the report retention reverts to the values associated with the NGEND and NGENT initialization parameters. The numeric value of NGEND and NGENT can be small and can cause the document to be deleted. All copies of the report other than the LAST copy are retained based on NGEND and NGENT.
    • If POPT=M, only non-matching reports that have been identified with the MARK (K) command on the SYSOUT Selection panel must be retained for PCOPIES.
      After PCOPIES is satisfied, the report reverts to the values associated with the NGEND and NGENT initialization parameters. The numeric value of NGEND and NGENT can be small and can cause the document to be deleted. All copies of any report not specifically MARKed are retained based on NGEND and NGENT.
    We recommend that you set PRETAIN=TABLE and include an ERO table entry 'catch-all' (that is a /* entry). This makes the ERO table statements the single point of control for the retention of ERO reports. With PRETAIN=TABLE, when a report has satisfied the ERO table statement that controls is deleted.
  • If PRETAIN=TABLE is specified and no SARPATAB DD statement is provided in the archival task (SARSTC) job stream, message SARPAR09 SARPATAB DD STATEMENT MISSING is issued, and the backup cycle terminates with a U1009 user abend.
  • If a SARPATAB DD statement is present but points to an empty file, message SARPAR10 SARPATAB DATA SET EMPTY is issued, and the backup cycle terminates with U1010 user abend.
PTEXT1 to PTEXT5
This parameter specifies unique text used for scanning archival data to locate the SYSOUT identifier used to name the SYSOUT group.
Syntax:
PTEXT1=xxxxxxxxxx PTEXT2=xxxxxxxxxx PTEXT3=xxxxxxxxxx PTEXT4=xxxxxxxxxx PTEXT5=xxxxxxxxxx
There is no default.
PTHRESH
This parameter specifies the percentage of active SYSOUT groups on a tape as a threshold value and is used by the SARPAC tape consolidation program to determine whether to consolidate a tape. When the percentage of active SYSOUT groups on a tape is less than this threshold value, the tape is selected for consolidation.
Syntax:
PTHRESH=
nnn
The default is 50.
Valid values are 1-100.
Note:
Setting PTHRESH to 100 percent allows SARPAC to consolidate all tapes regardless of the percentage of active reports. It enables SARPAC to be used to convert media or create new tapes.
PXCOND
This parameter specifies whether exceptional conditions are included in the expanded retention process.
Syntax:
PXCOND=YES|NO
The default is YES.
STORGRP1 to STORGRP9
STORGRP1 through STORGRP9 allow you to define up to nine tape storage groups in addition to the default group, STORGRP0. Creating STORGRP1 through STORGRP9 in addition to the default, STORGRP0, allows you to do the following options:
  • Separate reports into groups by how often they are viewed. This organization can be used to maximize performance of the Expanded Access Server, which allows you to view from tape without loading to disk.
  • Separate reports into groups by their retention requirements. This organization lessens the need for tape consolidation.
  • Use tape duplexing on some reports, not on others
  • Use an alternate high-level index for certain tapes
  • Use a different number of generations that are written to different tapes
  • Use separate ranges of tape volumes that are used for the backup tapes
New storage groups take the default values for the several sub parameters unless explicitly entered. They do not inherit the initial values from STORGRP0.
To delete a storage group, specify it without parameters. For example, the following definition deletes STORGRP3:
STORGRP3=
The STORGRP=
group-name
ERO table parameter assigns reports to storage groups. If you define tape storage groups, assign the group containing the most reports as STORGRP1 to enhance backup cycle performance.
STORGRX1 to STORGRX9
STORGRX1 through STORGRX9 allow you to define up to nine tape storage group EXTENSIONS.
To delete a storage group extension, specify it without parameters. For example, the following definition deletes STORGRX3:
STORGRX3=
Storage group extension STORGRX
n
is valid only if the corresponding STORGRPn parameter is defined.
The STORGRP=group-name ERO table parameter assigns reports to storage groups.
The following parameters are only valid with the Expanded Retention Option (ERO). Use the following chart to determine if a task must be recycled to activate a new or modified ERO Initialization parameter.
ERO PARMS
SARSTC
SARFSS
SARXMS
EROPRO
N
 
 
DSK2DAYS
Y
 
 
DSK2DRVR
N
 
 
DSK2INTV
N
 
 
DSK2MIGD
N
 
 
DSK2PARM
N
 
 
DSK2TIME
Y
 
 
PCOPIES
Y
 
 
PMXTAPES
Y
 
 
PMXYEARS
Y
 
 
POPT
N
 
 
PRETAIN
N
 
 
PTEXT1
Y
Y
 
PTEXT2
Y
Y
 
PTEXT3
Y
Y
 
PTEXT4
Y
Y
 
PTEXT5
Y
Y
 
PTHRESH
 
 
 
PXCOND
Y
 
 
STORGRP1
N
 
 
STORGRP2
N
 
 
STORGRP3
N
 
 
STORGRP4
N
 
 
STORGRP5
N
 
 
STORGRP6
N
 
 
STORGRP7
N
 
 
STORGRP8
N
 
 
STORGRP9
N
 
 
STORGRX1
N
 
 
STORGRX2
N
 
 
STORGRX3
N
 
 
STORGRX4
N
 
 
STORGRX5
N
 
 
STORGRX6
N
 
 
STORGRX7
N
 
 
STORGRX8
N
 
 
STORGRX9
N
 
 
Where
  • Y
    The task must be recycled for the parameter to become active.
  • L
    The end-user's session must be recycled (Logoff/Logon) for the parameter to become active.
  • N or blank
    The task need not be recycled.