|
|
|
|
|
Table 158 DO RETENTION Types
Type |
Description |
|---|---|
CYCLE (CY) |
Retention is based on the number of cycles (meaning, versions, or generations) of a data set. For a more detailed explanation, see the CYCLECNT parameter in the INCONTROL for z/OS Installation Guide: Installing. Syntax: CYCLES=number_cycles where number_cycles is the number of cycles of a data set. A maximum of 4 digits can be specified. Mandatory. After the number of cycles is entered, the PREFIX field is displayed. The value in the PREFIX field determines whether data set versions are identified according to their prefixes (as specified in the ON DATASET statement), or according to their full names, for counting cycles. Mandatory. Valid values: Y (Yes) – Consider data sets with the same prefix as versions of the same data set, and make a unified count of all versions (for example, assuming prefix mask BKP*, make a single count of versions of data sets BKP01 and BKP02). N (No) – Ignore prefixes, and consider the entire data set name (for example, count versions of BKP01 separately from versions of BKP02). And/Or – When A (And) or O (Or) is specified, an additional retention field is opened on the screen. See And/Or Subparameter Logic. Note: For MVS GDG data sets, always use PREIX=N. |
DATE (DAT) |
Retention is based on a specific expiration date. Syntax: DATE=expire_date where expire_date is the expiration date. If date is specified at the same time as the retention type, date must be specified in 6-digit or 8-digit format according to the site standard. For example, the date can be specified in mmddyy or mmddyyyy format. Mandatory. Alternatively, the date can be specified in a 4-digit format, and the YEAR field is displayed. For example, specify mmdd and press Enter; the YEAR field is displayed. Specify the YEAR parameter in 2-digit (yy) or 4-digit (yyyy) format. And/Or – When A (And) or O (Or) is specified, an additional retention field is opened on the screen. See And/Or Subparameter Logic. |
DAYS (DAY) |
Retention is based on the number of days since the data set was created. Syntax: DAYS=number_days where number_days is the number of days since the data set was created. A maximum of 5 digits can be specified. Mandatory. And/Or–When A (And) or O (Or) is specified, an additional retention field is opened on the screen. See And/Or Subparameter Logic. |
EDM (ED) |
Retention is controlled by an External Data Manager (EDM). No subparameters are specified with this retention type. No other retention types can be combined with this retention type (meaning, using And/Or). |
JCL EXPDT (J) |
Retention is based on the expiration date specified in the JCL EXPDT, RETPD or DATACLAS parameter. And/Or–When A (And) or O (Or) is specified, an additional retention field is opened on the screen. See And/Or Subparameter Logic. |
LAST ACCESS (L) |
Retention is based on the number of days since the data set was last accessed. Syntax: LAST ACCESS=number_days where number_days is the number of days since the data set was last accessed. A maximum of 4 digits can be specified. Mandatory. And/Or–When A (And) or O (Or) is specified, an additional retention field is opened on the screen. See And/Or Subparameter Logic. |
MVS CATALOG (M or CA) |
Retention is based on the existence of the data set in the operating system catalog. If the catalog still controls the data set, the data set is retained by Control-M/Tape. Otherwise, the data set is no longer retained by Control-M/Tape. And/Or–When A (And) or O (Or) is specified, an additional retention field is opened on the screen. See And/Or Subparameter Logic. |
PERMANENT (P) |
Data set is retained indefinitely. This retention type allows manual data set or volume expiration by the EXPIRE option in the Inquire/Update screen. No subparameters are specified with this retention type. No other retention types can be combined with this retention type (meaning, using And/Or). |
RET FROM VAULT (R) |
Retention is based on the volume’s return from the vault (meaning, as soon as the volume is sent back to the MAINLIB library, it is expired). No subparameters are specified with this retention type. No other retention types can be combined with this retention type (meaning, using And/Or). |
Only one DO RETENTION statement can be specified per rule definition. A maximum of three retention criteria can be specified per DO RETENTION statement.
For retention periods based on expiration dates (meaning, retention type DATE), the retention period of a volume is based on the expiration dates of all its data sets. A volume is scratched only when all data sets on the volume have scratch status (meaning, their expiration dates have passed).
The expiration conditions for each data set are set at time of data set creation according to parameter DO RETENTION. When the expiration conditions have been satisfied, the data set can be overwritten – even if the data set is located on a non-scratch volume.
When a data set is opened, Control-M/Tape scans the rules to determine abend retention expiration dates. If a system abend occurs before the normal close of the data set, the current generation of the data set is the expiration date specified by parameter DO ABENDRET. For additional information, see DO ABENDRET: Action Parameter.
When a data set is closed normally, Control-M/Tape scans the rules to determine normal retention expiration dates.
For additional information on retention periods, see Retention Management.
CYCLES Retention Type
The expression DO RETENTION=CYCLES specifies that Control-M/Tape should retain a specified number of versions of a data sets. Depending on conventions in use at the site, different versions of the same data set can be distinguished by a unique identifier (for example, time stamp) appended to a prefix in the data set name. In such cases, different versions of the same data set are the same prefix, but their full names are different.
Therefore, when counting data set cycles, it is necessary to instruct Control-M/Tape whether to identify data sets by their entire name, or by the prefix specified in the ON DATASET statement. This is done by subparameter PREFIX. Specifying PREFIX Y instructs Control-M/Tape to take a unified count of all data set versions with the same prefix. Specifying N (No) instructs Control-M/Tape to identify data set versions by their full name.
If a DO RETENTION statement and a DO ABENDRET statement are included in a rule definition and both these statements specify the CYCLES retention type, the value for subparameter PREFIX in these statements must be identical. The setting for subparameter PREFIX however, does not have to match the setting for this subparameter in a DO VAULT statement specifying the CYCLES retention type.
Multiple Retention Types
The Dynamic Stacking facility uses only the first retention parameter to determine the volumes on that a data set can be stacked. If installation parameter STKMODE is set to R or A and multiple retention types (meaning, DATE or DAYS and other retention types) are specified, it is recommended that the DATE or DAYS retention parameter be specified first.
Parent Topic |