CTLGWAIT

Defines the number of wait days before the CTTRTM utility checks a catalog-controlled data set (meaning, one for that the DO RETENTION parameter is set to MVS CATALOG). In some cases, a data set is created during a job step and cataloged at the end of a later job step. If the CTTRTM utility is executed after the data set is created but before it is cataloged, the utility expires the data set. The CTLGWAIT parameter causes the CTTRTM utility to wait a specified number of days before checking if the data set is cataloged.

CYCLECNT

Defines how to calculate cyclic data sets. Valid values are:

• DATE — Handles data sets with the same data set name and creation date as a single cycle. Default.
• NONE — Handles data sets with the same data set name as separate cycles. The creation date is ignored.
• JOB — Handles data sets with the same data set name and job name as a single cycle. The creation date is ignored.
• JOBDATE — Handles data sets with the same data set name, creation date and job name as a single cycle.

EXPCAT

Controls whether to expire cataloged datasets or not. Valid values are:

• Y (Yes) – Expire cataloged datasets according to the Control-M/Tape retention logic. Default.
• N (No) – Do not expire cataloged datasets. Only after the dataset expires according to Control-M/Tape retention logic, and it is removed from the catalog, does Control-M/Tape expire the dataset.
• G – Do not expire GDG cataloged datasets.

EXPDTYPE

Determines expiration logic depending on the type of retention criteria and value specified.

When DATE or DAYS retention criteria are assigned to a data set

• CA1 — CA-1 expiration logic applies. DATE or DAYS specifies the day on that the data set volumes with "vault until date" are moved to the next vault or are returned to mainlib on the same day as mentioned in the rule. Default.
• TLMS — TLMS expiration logic applies. DATE or DAYS specifies the last day of retention. Volumes only move to the next vault on the next day, one day later than mentioned in rule.
• NONE — Expiration date in standard MVS format.

When cyclic retention criteria are specified

• CA1 — CA-1 expiration logic applies. Only primary data sets (data sets with LABEL set to 1) are considered in the expiration calculation. Default.
• Other — All cyclic data sets are considered regardless of label number.

GRACECAT

Defines the number of extended retention days added to the catalog controlled data set (when DO RETENTION is set to MVS CATALOG).

GRACECYC

Defines the number of extended retention days added to the cycle controlled data set (when DO RETENTION is set to CYCLES).

MODE

Determines whether to uncatalog expired data sets in the operating system catalog. Valid values are:

• TEST — Data sets are not uncataloged.
• PROD or PHASE — Data sets are uncataloged if no TEST rules match the expired data sets. For details, see the TESTRUL parameter in this table.

RTNTYPE

Determines whether retention is performed on a data set level or on a volume level, or on a multi-volume group. The parameter statement includes two options separated by a comma. The first option is the retention type for a single volume. The second option is the retention type for a multi-volume group.

Valid values for a single volume are:

• DSN   - Each data set expires according to its own specified expiration date. That is, the data set becomes scratched regardless of the volume.
• VOL   - All files of a multifile volume expire at the same time (meaning, when the last one expires). This is compatible with other tape management retention methods. Default.

Valid values for a multi-volume group are:

• DSN   - - Each data set expires according to its own specified expiration date. That is, the data set becomes scratched regardless of the multi-volume group.
• GROUP - All files of a multi-volume group expire at the same time (meaning, when the last one expires). This is compatible with other tape management retention methods. Default.

Note: A volume becomes SCRATCH by the CTTRTM utility only after all its data sets have expired. The CTTRTM utility ignore the retention of the volume except for external volumes, or volumes without any datasets.

SMSINTR

Determines whether the Control-M/Tape to DF/SMS interface is active. If this interface is active and expiration dates are defined by SMS-managed classes, retention is dependent on expiration dates specified in SMS Management Classes.

• Yes — The Control-M/Tape to DF/SMS interface is active.

Note: If CDAM files are allocated on SMS volumes, these volumes must be defined with PARTIAL RELEASE set to NO

• No — The Control-M/Tape to DF/SMS interface is not active.

TESTRUL

Determines whether test rules are used in the production environment (global MODE is set to PROD or PHASED). If an expired data set matches a test rule, do not uncatalog the data set.

• Yes — Test rules are used. The utility loads and scans the Control-M/Tape rules.
• No — Test rules are not used. The utility does not load and scan the Control-M/Tape rules. Default.