Previous Topic

Next Topic

Book Contents

Book Index

General Information

The DO VAULT statement specifies the location to be used for off-site storage of volumes and how long the volumes are stored at that location.

The combination of DO VAULT subparameters specified in a rule definition establishes the vault pattern for the specified volumes.

Multiple DO VAULT statements can be specified in a rule, but the "DO" keyword only appears in the first DO VAULT statement.

All vaulting is either by box or not by box. Therefore, if multiple VAULT statements are defined, the value specified in the BY BOX subparameters (of the first VAULT statement) applies to all VAULT statements.

Specification of the expression DO VAULT=MAINLIB indicates the return of a vaulted volume to the active library. When a volume is returned to the active library, the expiration date of the volume is checked. If the volume has expired, its status is changed to Pend-Scratch.

All vaults are defined in a member whose default name is $$VAULT in the Control-M/Tape PARM library. A vault must be defined before its name can be specified in a DO VAULT statement.

Vaulting is not performed when a job abends.

Vaulting for multi-volume chains is also supported. For additional information, see Vault Management.

For general information on vaults, see Vault Management.

CYCLES Retention Type

UNTIL CYCLES indicates that Control-M/Tape is to retain a specified number of versions of a data set. 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 have 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 using subparameter PREFIX. Specifying Y (Yes) in the PREFIX subparameter 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.

Within the same rule definition, the value for subparameter PREFIX in DO VAULT statements specifying UNTIL CYCLES is independent of, and can be different from, the value specified for subparameter PREFIX in DO RETENTION and DO ABENDRET statements that specify the CYCLES retention type.

However, the PREFIX must be the same for each vault specified within the same DO VAULT statement.

Parent Topic

DO VAULT: Action Parameter