Rule Parameters

• General

• Rule Parameters – Summary

• Parameter Descriptions

• CONFCAL: Basic Scheduling Parameter

• CONTINUE SEARCH: General Parameter

• DATES: Basic Scheduling Parameter

• DAYS: Basic Scheduling Parameter

• DESCRIPTION: General Parameter

• DO Statement: Action Parameter

• DO ABENDRET: Action Parameter

• DO BYPASS: Action Parameter

• DO CONDITION: Action Statement

• DO DYNDS: Action Parameter

• DO DYNVOL: Action Parameter

• DO FASTPOS: Action Parameter

• DO FORCEJOB: Action Parameter

• DO LABEL: Action Parameter

• DO OVERJCL: Action Parameter

• DO OWNER: Action Parameter

• DO POOL: Action Parameter

• DO RECREATE: Action Parameter

• DO RESOURCE: Action Parameter

• DO RETENTION: Action Parameter

• DO SET: Action Parameter

• DO SHOUT: Action Parameter

• DO STACK: Action Parameter

• DO STKDEFSZ: Action Parameter

• DO STKGROUP: Action Parameter

• DO STKMODE: Action Parameter

• DO STKMXLBL: Action Parameter

• DO STKMXVOL: Action Parameter

• DO STKRULE: Action Parameter

• DO STKSRCHL: Action Parameter

• DO VAULT: Action Parameter

• DOCLIB: General Parameter

• DOCMEM: General Parameter

• GROUP: General Parameter

• MODE: General Parameter

• MONTHS: Basic Scheduling Parameter

• ON Statement: Selection Parameter

• OWNER: General Parameter

• Rule Parameters – Summary

• SEQUENCE PRIORITY: General Parameter

• WDAYS: Basic Scheduling Parameter

General

Each rule in Control-M/Tape consists of a rule definition, and each rule definition consists of rule parameters. Rule parameters specify the rule’s various instructions and selection criteria.

Rule definitions can be defined by the Rule Definition facility using preformatted screens.

BMC recommends that all Control-M/Tape users read the description of the Rule Definition facility in Online Facilities before reading this section.

Figure 109 Control-M/Tape Rule Definition Screen

RULE: JOB0099  LIB CTT.PROD.RULES                               TABLE: ADM0002
COMMAND ===>                                                    SCROLL===> CRSR
------------------------------------------------------------------------------
 RULE NAME   JOB0099   GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43       SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION SET VAULT PATTERN OF JOB0099 VOLUMES
 DOCMEM      JOBDOCS   DOCLIB CTT.PROD.DOC
===========================================================================
 ON DATASET   = *                                               And/Or/Not
============================================================================
 DO VAULT     = VAULTA
      UNTIL     DATE           0101 YEAR 1999                   And/Or
    VAULT     = VAULTB
      UNTIL     DATE           0101 YEAR 2000                   And/Or
    VAULT     = MAINLIB
      UNTIL     DATE           0101 YEAR 2001                   And/Or
    VAULT     = 
 DO CONDITION = JOB0099_CHANGE_VAULT ODAT +
           AT   CLOSE
 DO
============================================================================
============================================================================
 DAYS                                                          DCAL
                                                                      AND/OR
 WCAL
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
 DATES
 CONFCAL          SHIFT
======= >>>>>>>>>>>>>>> END OF RULE DEFINITION PARAMETERS <<<<<<<<<<<<<<< ====
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

All rule definitions are stored in members in standard user libraries. The Control-M/Tape term for a member of this type is "table." Each table is composed of definitions for a number of different rules, all of which usually relate to the same subject. Table maintenance within the library, and management of the rules within each table is carried out using the Rule Definition facility.

The parameters that can be specified for each rule fall into four basic categories:

Table 130 Parameter Categories

Categories A, B, and C are mandatory. Category D is optional.

This chapter presents a quick summary of the parameters in each of the categories listed above.

The summary is followed by a detailed description of each rule definition parameter (in alphabetical order).

Rule Parameters – Summary

General Parameters

General parameters provide basic information about the rule.

Table 131 General Parameters

Selection Parameters

Selection parameters specify the criteria (the ON block) under which actions are performed by Control-M/Tape. Each rule must contain one, and only one, ON block. The ON block can contain an unlimited number of ON statements joined by parameter And/Or/Not.

Table 132 Selection Parameters

For a detailed description of valid ON statements, see ON Statement: Selection Parameter.

Action Parameters

Action parameters (meaning, DO parameters) specify actions to be performed by Control-M/Tape. These actions are performed only after conditions specified in the selection parameters have been fulfilled.

The following actions, described in detail on the following pages, are supported:

Table 133 Action Parameters

It is possible to create a rule without specifying any Action parameters. One use for a rule without DO actions is to change the Control-M/Tape operation mode without performing other actions.

Action parameters are divided into the following categories:

• Parameters unique to Control-M/Tape (for example, DO ABENDRET, DO LABEL, DO OWNER, DO POOL, DO RETENTION, DO STACK, and DO VAULT).

• Other DO parameters (meaning, DO CONDITION, DO FORCEJOB, DO RESOURCE, DOSET, and DO SHOUT) interface with and/or are common to the INCONTROL family of products.

And/Or Subparameter Logic

And/Or is a conjunctional subparameter that permits the specification and linking of some of the subparameters specified with some of the DO parameters described in the following pages. Valid values:

Table 134 And/Or Subparameter Values

ON/DO Block Structures

Selection parameters and Action parameters are specified as blocks of information (parameters).

The ON block determines which volumes and/or data sets, when accessed, trigger the rule (for example, all data sets created by a certain job or program). The basic structure of an ON block is:

ON    selection           And/Or/Not
ON    selection           And/Or/Not
        .
        .
        .
ON    selection

The DO block specifies which actions are performed. The basic structure of a DO block is:

DO     action
DO     action
DO     action
        .
        .
        .
DO     action

Each Control-M/Tape rule is composed of General parameters, followed by one ON block and one DO block. Scheduling parameters can optionally be specified.

The structure of a simple rule is illustrated below in free format (not using Control-M/Tape’s actual syntax). The rule definition parameters are described in detail in this chapter.

Table 135 Control-M/Tape Rule Structure Example

Basic Scheduling Parameters

Basic Scheduling parameters determine on which day a rule can be loaded into the Real-time environment. For more details on the Real-time environment, refer to Real-Time Environment.

There are several different Basic Scheduling parameters and subparameters, each providing a different method of expressing a rule’s schedule. Each rule definition can use any one or several of these parameters, depending on scheduling requirements.

Based on the rule’s Basic Scheduling parameters, the New Day procedure determines whether the rule is a candidate for execution on a specific date. Valid parameters are:

Table 136 Control-M/Tape Basic Scheduling Parameters

Each Basic Scheduling parameter is described in detail in this chapter. However, the interrelationships between some of these parameters is described briefly below.

DAYS/DCAL, WDAYS/WCAL

These parameters are all optional.

Parameter DAYS identifies days of the month on which the rule is scheduled. For example, 1st day of the month, 3rd working day of the month, and so on. Several formats are available for specifying DAYS values.

Parameter WDAYS identifies days of the week on which the rule is scheduled. For example, the 1st day of the week, the 2nd working day of each week, and so on. Several formats are available for specifying WDAYS values.

A calendar name can be specified in the DCAL and/or WCAL fields. A calendar specifies days of the year on which a rule can be scheduled, known as working days. For more information on calendars and the IOA Calendar Facility, see IOA Calendar Facility.

When both the DAYS and DCAL parameters are specified, a date must appear in both parameter specifications for scheduling to result.

Similarly, when both WDAYS and WCAL are specified, a day must appear in both parameter specifications for rule scheduling to result.

When values for both DAYS (/DCAL) and WDAYS (/WCAL) are specified in the same rule definition, the resulting schedule is determined by the value specified in field AND/OR.

CONFCAL/SHIFT

A calendar specified in parameter CONFCAL is not used for rule scheduling, but is used instead for validating a schedule date. Only rules that have satisfied all other specified basic scheduling criteria are checked against the CONFCAL calendar. If the day is a working day in the CONFCAL calendar, the rule is scheduled on that day. Otherwise, the rule is either shifted to (scheduled on) another day according to the value specified in parameter SHIFT, or the rule is not scheduled (if no SHIFT value has been specified).

CONFCAL calendars are useful for handling holidays and other scheduling exceptions.

Defining a Schedule – Internal Scheduling Logic

The following logic is used by the IOA Scheduling facility to determine whether to order a rule on a specific day:

1. DAYS/DCAL parameters are checked independently and a first tentative scheduling decision is created.

2. WDAYS/WCAL parameters are checked independently and a second tentative scheduling decision is created.

3. A third scheduling decision is created based on the above two decisions and the AND/OR value linking them.

   If DAYS/DCAL are not specified, the third scheduling decision is identical to the second scheduling decision. If WDAYS/WCAL are not specified, this third scheduling decision is identical to the first scheduling decision.

4. If CONFCAL/SHIFT are specified, the third scheduling decision is adjusted according to the CONFCAL/SHIFT criteria.

5. The third scheduling decision (as adjusted, if necessary) becomes the final scheduling decision. The IOA Scheduling facility decides whether to schedule a rule based on this third scheduling decision.

Parameter Descriptions

This section contains detailed descriptions of all parameters available in the Control-M/Tape Rule Definition screen. Parameters are arranged in alphabetical order. Within each parameter, subparameters are arranged according to the order of the fields on the screen.

Each parameter begins on a new page, and includes the following:

• a brief explanation of the parameter’s purpose

• the format required for defining the parameter within an extract of the Control-O screen

• general information explaining the parameter and its usage

• where applicable, some practical examples illustrating implementation of the parameter

For more information on the Rule Definition facility, see Online Facilities.

CONFCAL: Basic Scheduling Parameter

Specifies the name of a calendar that is used to confirm whether a rule that is scheduled for a particular day according to other scheduling criteria, is either scheduled on that day, shifted to another day, or not scheduled at all.

For more information, see also DAYS and WDAYS.

Figure 110 CONFCAL Parameter Format

The CONFCAL subparameters are described below:

Table 137 CONFCAL Subparameters

General Information

CONFCAL calendars are useful for handling holidays and other scheduling exceptions.

CONFCAL is optional. If not specified, rules are scheduled according to other basic scheduling criteria without confirmation.

CONFCAL should not contain the name of a periodic calendar. If it does, no day passes the confirmation.

SHIFT cannot be specified unless CONFCAL is specified, and when CONFCAL is specified, SHIFT is optional (meaning, blank defaults to no shifting).

Example

This example is based on the following assumptions:

• The current month is September 2001.

• Working days are defined in the WORKDAYS calendar, which contains the following working days (indicated by Y) for September 2001:

---S-------------S-------------S-------------S-------------S---
 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 +
       Y Y Y Y     Y Y Y Y Y     Y Y Y Y Y     Y Y Y Y Y

• Start of the week is defined as Monday. Weeks start on the following dates in September: 3rd, 10th, 17th, and 24th.

Schedule the rule on the 1st, 7th and 15th day of the month if they are both Saturdays and working days in WORKDAYS. If the day of the month (1st, 7th, 15th) is not a Saturday, do not schedule the rule. If the day of the month is a Saturday but is not a working day, schedule the rule on the next working day.

DAYS    - 1,7,15
AND/OR  - AND
WDAYS   - 6
CONFCAL - WORKDAYS
SHIFT   - >

The rule is scheduled on the days of the month indicated by an asterisk:

Figure 111 CONFCAL Parameter Example

CONTINUE SEARCH: General Parameter

Determines whether to continue searching for additional rules if this rule meets the selection criteria.

Figure 112 CONTINUE SEARCH Parameter Format

Mandatory. Valid values are:

Table 138 CONTINUE SEARCH Values

Example

Control-M/Tape continues searching for matching rules even if this rule satisfies the selection criteria.

Figure 113 CONTINUE SEARCH Parameter Example

RULE: JOB0099  LIB CTT.PROD.RULES                               TABLE: ADM0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   JOB0099   GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43       SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)      
 DESCRIPTION SET VAULT PATTERN OF JOB0099 VOLUMES                           
 DOCMEM      JOBDOCS   DOCLIB CTT.PROD.DOC                                  
===========================================================================
 ON DATASET   = *                                               And/Or/Not  
============================================================================
 DO VAULT     = VAULTA                                                      
      UNTIL     DATE           0101 YEAR 1999                   And/Or    
    VAULT     = VAULTB                                                      
      UNTIL     DATE           0101 YEAR 2000                   And/Or
    VAULT     = MAINLIB                                                     
      UNTIL     DATE           0101 YEAR 2001                   And/Or      
    VAULT     =                                                             
 DO CONDITION = JOB0099_CHANGE_VAULT ODAT +                                 
           AT   CLOSE                                                        
 DO                                                                         
============================================================================
============================================================================
 DAYS                                                          DCAL        
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

DATES: Basic Scheduling Parameter

Specifies dates, by month and day, on that the rule is scheduled.

Figure 114 DATES Parameter Format

Optional. Valid values are 4-character dates, in either mmdd or ddmm format depending on the site standard.

A maximum of 12 dates can be specified.

General Information

The rule is scheduled only on the dates specified in the dates list.

This parameter cannot be used with parameters MONTHS, DAYS, and DCAL.

To specify more than 12 dates for one rule, the dates are defined in a calendar and the calendar is specified in DCAL (or WCAL).

The relationship between DATES and WDAYS/WCAL is OR. If the rule is scheduled according to the DATES parameter or according to the WDAYS/WCAL combination, it is scheduled.

Examples

DATES 0115

 DOCMEM      JOBDOCS   DOCLIB CTT.PROD.DOC
============================================================================
 ON DATASET   = *                                               And/Or/Not
============================================================================
 DO VAULT     = VAULTA
      UNTIL     DATE           0101 YEAR 1999                   And/Or
    VAULT     = VAULTB
      UNTIL     DATE           0101 YEAR 2000                   And/Or
    VAULT     = MAINLIB
      UNTIL     DATE           0101 YEAR 2001                   And/Or
    VAULT     =
 DO CONDITION = JOB0099_CHANGE_VAULT ODAT +
           AT   CLOSE
 DO
============================================================================
============================================================================
 DAYS                                                          DCAL
                                                                    AND/OR
 WDAYS   ALL                                                   WCAL
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
 DATES
 CONFCAL          SHIFT
 ======= >>>>>>>>>>>>>>> END OF RULE DEFINITION PARAMETERS <<<<<<<<<<<<<<< ====
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

DAYS: Basic Scheduling Parameter

Specifies the days of the month on that the rule is scheduled.

For more information, see also WDAYS and CONFCAL.

Figure 116 DAYS Parameter Format

Optional. DAYS specifies days of the month on that rules are scheduled, provided other scheduling criteria are met. Values for DAYS can be specified alone, or they can be specified together with a calendar specified in the DCAL subparameter. DAYS/DCAL can also be specified together with WDAYS/WCAL (described under WDAYS in this chapter).

Parameter DAYS consists of the following:

Table 139 DAYS Subparameters

Assuming all other scheduling criteria are met:

• When DAYS are specified without DCAL, the rule is scheduled on the specified days (in the specified months).

• When DCAL is specified without DAYS, the rule is scheduled on the working days marked in the DCAL calendar.

• When DAYS and DCAL are both specified, scheduling depends on how the working days defined in the calendar, and the values and format of the DAYS parameter combine (described below).

• When both DAYS and WDAYS criteria are specified, scheduling depends on the AND/OR subparameter connecting them.

Valid Formats for DAYS

Valid formats for the DAYS parameter, and how they relate to DCAL, are described below.

In the following non-periodic scheduling formats:

• n is an integer from 1 to 31.

• Multiple values can be specified (separated by commas) in any order.

• DCAL should not contain the name of a periodic calendar.

Table 140 Non-Periodic Scheduling Formats

In the following periodic scheduling formats:

• n is any integer from 1 through 63 and i is any valid period identifier (or * for all periods).

• An * can be specified as the n value in format DnPi to represent all days. (* is not a valid n value in formats –DnPi, LnPi, and –LnPi.)

• A period can span any number of days, but by default, no more than 33 days can elapse after the appearance of one identifier in a period until the appearance of the next matching identifier in the same period. Once a gap of 33 days has been reached, the period automatically closes. (The 33-day default can be changed by the INCONTROL administrator.)

The name of a periodic calendar must be specified in DCAL. For details concerning periodic calendars, see IOA Calendar Facility.

Table 141 Periodic Scheduling Formats

General Information

Negative values take precedence over positive values when determining whether a rule is scheduled on a certain date. If a negative value (meaning, format –n, –Dn, –Ln, –DnPi, or –LnPi) in either the DAYS or WDAYS field prevents a rule from being scheduled on a date, the rule is not scheduled on that date even if a positive value (for example, Ln) would otherwise result in the rule being scheduled on that date.

A maximum of eight periodic values (meaning, of type DnPi, –DnPi, LnPi, and –LnPi) can be designated in any desired order.

If periodic and non-periodic values are mixed when specifying parameter DAYS, processing depends on the type of calendar specified in parameter DCAL.

• If a non-periodic calendar is specified in the DCAL parameter, only non-periodic values in the DAYS parameter are processed; periodic values are ignored. In this case, negative periodic values (meaning, –DnPi, –LnPi) are also ignored and do not supersede other values.

• If a periodic calendar is specified in the DCAL parameter, all periodic values and the negative non-periodic value -n in the DAYS parameter are processed; all other non-periodic values are ignored.

Parameter MONTHS is ignored when periodic values are specified in parameter DAYS.

Parameter DAYS cannot be used with parameter DATES.

Examples

The examples in this chapter are based on the following assumptions:

• The current month is December 2001.

• Working days are defined in calendar WORKDAYS that contains the following working days (indicated by Y) for December 2001.

---S-------------S-------------S-------------S-------------S---
 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 + 1
     Y Y Y Y Y     Y Y Y Y Y     Y Y Y Y Y     Y   Y Y Y     Y

• WDAYS are defined as working days beginning on Monday.

• Periodic calendar PERIDAYS contains the following periodic definition for December2001. These examples assume that all other days of this calendar are blank.

---S-------------S-------------S-------------S-------------S---
 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 + 1
     B C A A B     B C A A B     B C A A B     B C A A B     B

• Start of the week is defined as Monday. Weeks start on the following dates in December 2001: 3th, 10th, 17th, 24th, and 31st.

At the end of each example, asterisks on a December 2001 calendar indicate the days on which the rule is scheduled.

DAYS    - 17,L01

DAYS    - +1,-6
DCAL    - WORKDAYS

DAYS    - -D1,-17,-L1
DCAL    - WORKDAYS

DAYS    - <8
DCAL    - WORKDAYS

DAYS    - -5,D1PA,-D2PB
DCAL    - PERIDAYS

DAYS    - 1
AND/OR  - OR
WDAYS   - 1

DAYS    - 3
AND/OR  - AND
WDAYS   - 1

DAYS    - L1,L2,L3,L4,L5,L6,L7
AND/OR  - AND
WDAYS   - 1

DAYS    - 1,7,15
AND/OR  - AND
WDAYS   - 6
CONFCAL - WORKDAYS
SHIFT   - >

DAYS     16,17,18,19,20,21,22
AND/OR   AND
WDAYS    5

DESCRIPTION: General Parameter

Description of the rule definition (in free text).

Figure 127 DESCRIPTION Parameter Format

The specified DESCRIPTION can include 1 through 61 characters per line. Multiple lines are allowed.

General Information

Parameter DESCRIPTION is an optional, free text description of the rule in any language. It serves as internal documentation to aid in the identification and description of individual rules under Control-M/Tape.

When text is typed on the last displayed description line and Enter is pressed, a new, blank description line is automatically displayed.

The first line of the description is displayed to the right of the rule name in the Rule List screen when the DESC command is entered in the COMMAND field of the Rule List screen.

For information on how to create more complete rule documentation, see Rule Documentation.

Example

Figure 128 DESCRIPTION Parameter Example

RULE: JOB0099  LIB CTT.PROD.RULES                               TABLE: ADM0002
COMMAND ===>                                                    SCROLL===> CRSR
------------------------------------------------------------------------------
 RULE NAME   JOB0099   GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43       SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)      
 DESCRIPTION SET VAULT PATTERN OF JOB0099 VOLUMES
 DOCMEM      JOBDOCS   DOCLIB CTT.PROD.DOC
============================================================================
 ON DATASET   = *                                               And/Or/Not  
============================================================================
 DO VAULT     = VAULTA
      UNTIL     DATE           0101 YEAR 1999                   And/Or
    VAULT     = VAULTB
      UNTIL     DATE           0101 YEAR 2000                   And/Or
    VAULT     = MAINLIB
      UNTIL     DATE           0101 YEAR 2001                   And/Or
    VAULT     =
 DO CONDITION = JOB0099_CHANGE_VAULT ODAT +
           AT   CLOSE 
 DO
============================================================================
============================================================================
 DAYS                                                          DCAL
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

DO Statement: Action Parameter

Actions performed when the ON selection criteria are satisfied.

Figure 129 DO Parameter Format

Optional. Specify DO statements as follows:

• Type the action keyword (for example, POOL) in the DO field and press Enter.

• In many cases, subparameter fields is displayed. Fill in the subparameters and press Enter again.

After entering a DO statement, another DO line is automatically displayed. Any number of DO statements can be specified.

The following are valid DO actions. Each is discussed in detail later in this chapter.

Table 142 DO Statement Actions

General Information

Control-M/Tape DO statements are divided into the following categories:

• DO statements that are unique to Control-M/Tape and do not interface with other INCONTROL products (for example, DO ABENDRET, DO LABEL, DO POOL, DO RETENTION, DO STACK and DO VAULT).

• DO statements that interface with or are common to other INCONTROL products. This category includes DO CONDITION, DO FORCEJOB, DO RESOURCE, DO SET, and DOSHOUT.

To add an empty DO statement between two existing DO statements, type the > character over the first letter in the DO field of the earlier DO statement, and press Enter.

Example

DO >CONDITION

Note that CONDITION is restored to its original value when Enter is pressed (meaning, the > character disappears).

To delete unwanted DO statements, either delete the DO keyword and press Enter or specify the appropriate Line Editing commands in the Edit environment, which is described in Editing Rule Definitions in the IOA Edit Environment.

DO ABENDRET: Action Parameter

Specifies a period during which a data set is retained (meaning, protected from being scratched or overwritten) following a job abend or a system crash that occurs while the data set is open.

Figure 130 DO ABENDRET Parameter Format

Optional. Type ABENDRET (or its abbreviation A) in the DO field and press Enter.

Specify an abend retention type to the right of the = prompt.

Only one DO ABENDRET statement can be specified per rule definition. A maximum of three retention types can be specified in the DO ABENDRET statement.

Depending on the abend retention type specified, different subparameters are displayed.

The abend retention types, their abbreviations, descriptions, and subparameters, are described Table 143.

Table 143 ABEND Retention Types

General Information

Normal data set retention periods are based on criteria defined by parameter DO RETENTION (see the description of parameter DO RETENTION in this chapter). However, alternate retention criteria can be used if an abend (or system crash) occurs. These alternate (abend) retention criteria are specified by parameter DO ABENDRET. As with normal retention periods, if the abend retention period has passed, 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 an abend occurs before the normal close of the data set, the current generation of the data set is the expiration date specified in a DO ABENDRET statement.

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.

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.

Examples

RULE: BKPSAVE  LIB CTT.PROD.RULES                               TABLE: BKP0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   BKPSAVE   GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 03 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION SETS RETENTION AND ABEND-RETENTION PERIODS FOR BACKUP FILES
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS
============================================================================
 DOC
============================================================================
 ON DATASET   = BKP*                                            And/Or/Not A
 ON PGM       = BKP*                                            And/Or/Not A
 ON USERID    = ADMIN                                           And/Or/Not
============================================================================
 DO RETENTION = DAYS              00030                         And/Or
 DO ABENDRET  = LAST ACCESS        0010                         And/Or      
 DO
============================================================================
 DAYS    ALL                                                   DCAL
                                                                    AND/OR  
 WDAYS                                                         WCAL
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

RULE: BKPSAVE  LIB CTT.PROD.RULES                               TABLE: BKP0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   BKPSAVE   GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 03 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION SETS RETENTION AND ABEND-RETENTION PERIODS FOR BACKUP FILES
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS
============================================================================
 DOC
============================================================================
 ON DATASET   = BKP*                                            And/Or/Not A
 ON PGM       = BKP*                                            And/Or/Not A
 ON USERID    = ADMIN                                           And/Or/Not
============================================================================
 DO RETENTION = DAYS              00365                         And/Or
 DO ABENDRET  = DAYS               0010                         And/Or
 DO
============================================================================
 DAYS    ALL                                                   DCAL
                                                                    AND/OR
 WDAYS                                                         WCAL
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

DO BYPASS: Action Parameter

Indicates that tape management activities are not be performed for the specified data sets.

Figure 133 DO BYPASS Parameter Format

Optional. Type BYPASS (or its abbreviation B) in the DO field and press Enter. Specify Y or N to the right of the = prompt.

Table 144 DO BYPASS Subparameters

Only one DO BYPASS statement can be specified per Control-M/Tape rule.

General Information

If the expression DO BYPASS=Y is specified in a Control-M/Tape rule, the data set or data sets specified in the ON DATASET statement of the rule are treated as if the expression EXPDT=98000 was specified for them in the JCL (meaning, no tape management activities are performed for these data sets).

WARNING: When the expression DO BYPASS=Y is specified, tapes may be inadvertently overwritten, because there the protection that is normally provided by Control-M/Tape when it is not bypassed is missing. Therefore, use this expression infrequently and carefully.

Example

RULE: ACCT4    LIB CTTP.PROD.RULES                              TABLE: SAMPLES
COMMAND ===>                                                    SCROLL===> CRSR
------------------------------------------------------------------------------
 RULE NAME   ACCT4     GROUP                           MODE PROD (Prod/Test)
 OWNER       N89       SEQUENCE PRIORITY    CONTINUE SEARCH N    (Y/N)
 DESCRIPTION SAMPLE FOR USER MANUAL
 DESCRIPTION
 DOCMEM      ACCT4     DOCLIB CTTP.PROD.DOC
============================================================================
 ON USERID    = SYS*                                            And/Or/Not
============================================================================
 DO BYPASS    = YES
 DO
============================================================================
============================================================================
 DAYS                                                          DCAL
                                                                    AND/OR
 WDAYS   ALL                                                   WCAL
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
 DATES
 CONFCAL          SHIFT
======= >>>>>>>>>>>>>>> END OF RULE DEFINITION PARAMETERS <<<<<<<<<<<<<<< ====
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    14.09.27

DO CONDITION: Action Statement

Specification of prerequisite conditions to be added or deleted.

Figure 135 DO CONDITION Parameter Format

Optional. Type CONDITION (or its abbreviation C) in the DO field and press Enter. The DO CONDITION statement consists of the following subparameters:

Table 145 DO CONDITION Subparameters

You can specify multiple DO CONDITION statements in a rule.

General Information

When DO CONDITION is specified, the designated prerequisite condition is added to, or deleted from, the IOA Conditions file (according to the option specified).

A prerequisite condition can define any user-specified situation. The following are examples of prerequisite conditions:

VOL-IN-USE
TAPE-MOUNTED

The creation or deletion of prerequisite conditions by a DO CONDITION statement can trigger (or prevent) the execution of processes in Control-M, Control-D, and other environments that require those prerequisite conditions as IN conditions.

Each prerequisite condition is associated with a specified scheduling date.

If two or more DO CONDITION statements contradict one another, the last executed statement overrides the preceding statements.

AutoEdit variables can be embedded only into the name of the condition in the DO CONDITION statement (but not the date reference). These variables are resolved (replaced) at time of rule activation. For information about AutoEdit variables, see AutoEdit Variables.

Example

Prerequisite condition CRNCY-FILE-PROCESSED is added when data set FOREIGN.CURRENCY.FILE is closed successfully. If the data set is closed under abend, the prerequisite condition CRNCY-FILE-PROC-FAILED is added. These conditions can be used to trigger jobs in Control-M.

Figure 136 DO CONDITION Parameter Example

RULE: FORGNCND LIB CTT.PROD.RULES                               TABLE: FOREIGN
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   FORGNCND  GROUP                           MODE PROD (Prod/Test)
 OWNER       N73       SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION THIS RULE TRIGGERS JOBS IN CONTROL-M ACCORDING TO THE
 DESCRIPTION SUCCESSFUL CLOSING OF THE CURRENCY FILE
 DESCRIPTION
 DOCMEM      FORGNCND  DOCLIB CTT.PROD.DOCS
============================================================================
 ON DATASET   = FOREIGN.CURRENCY.FILE                           And/Or/Not
============================================================================
 DO CONDITION = CRNCY-FILE-PROCESSED ODAT +
           AT   CLOSE
 DO CONDITION = CRNCY-FILE-PROC-FAIL ODAT +
           AT   CLOSE AFTER ABEND
 DO CONDITION   CRNCY-FILE-PROC-FAIL ODAT -
           AT   CLOSE
 DO CONDITION   CRNCY FILE PROCESSED ODAT -
           AT   CLOSE AFTER ABEND
 DO
===========================================================================
===========================================================================
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    17.25.32

DO DYNDS: Action Parameter

Indicates whether the specified data sets are added to the Media Database.

Figure 137 DO DYNDS Parameter Format

Optional. Type DYNDS (or its abbreviation DYND) in the DO field and press Enter. Specify Y or N to the right of the = prompt.

Table 146 DO DYNDS Subparameters

Only one DO DYNDS statement can be specified per rule.

General Information

If a job attempts to read or update a specific data set and the data set is not defined in the Media Database, this statement determines whether a data set record describing the data set is added to the Media Database.

If no DO DYNDS statement is specified in a rule, the value specified for Control-M/Tape installation parameter DYNDS determines whether a data set record is created in the Media Database.

Example

Allow dynamic definition of data sets with names prefixed by N70.DSNS.

Figure 138 DO DYNDS Parameter Example

RULE: ACCT5    LIB CTTP.PROD.RULES                              TABLE: SAMPLES
COMMAND ===>                                                    SCROLL===> CRSR
------------------------------------------------------------------------------
 RULE NAME   ACCT5     GROUP                           MODE PROD (Prod/Test)
 OWNER       N89       SEQUENCE PRIORITY    CONTINUE SEARCH N    (Y/N)
 DESCRIPTION ALLOW DYNAMIC DEFINITION OF DATASETS WITH AN N70.DSNS PREFIX
 DESCRIPTION
 DOCMEM      ACCT5     DOCLIB CTTP.PROD.DOC
============================================================================
 ON DATASET   = N70.DSNS*                                       And/Or/Not
============================================================================
 DO DYNDS     = YES
 DO
============================================================================
============================================================================
 DAYS                                                          DCAL
                                                                    AND/OR
 WDAYS   ALL                                                   WCAL
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
 DATES
 CONFCAL          SHIFT
======= >>>>>>>>>>>>>>> END OF RULE DEFINITION PARAMETERS <<<<<<<<<<<<<<< =====
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    14.18.50

DO DYNVOL: Action Parameter

Indicates whether the specified volumes are added dynamically to the Media Database.

Figure 139 DO DYNVOL Parameter Format

Optional. Type DYNVOL (or its abbreviation DYNV) in the DO field and press Enter. The following subparameter fields are displayed:

Table 147 DO DYNVOL Subparameters

Each of these fields must be filled in with one of the following values:

Table 148 DO DYNVOL Subparameter Values

Only one DO DYNVOL statement can be specified per rule.

General Information

If a job attempts to access a volume that is not defined in the Media Database, this statement determines whether a volume record describing the volume is added to the Media Database.

If no DO DYNVOL statement is specified in a rule, the value specified for Control-M/Tape installation parameter DYNVOL determines whether a volume record is created in the Media Database.

Example

If a data set is created on a volume in the range EVOL01 to EVOL99, that is not defined in the Media Database, either define the volume dynamically (for specific requests), or define it as an External Volume (for a Scratch request).

Figure 140 DO DYNVOL Parameter Example

RULE: ACCT6    LIB CTTP.PROD.RULES                              TABLE: SAMPLES
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   ACCT6     GROUP                           MODE PROD (Prod/Test)
 OWNER       N89       SEQUENCE PRIORITY    CONTINUE SEARCH N    (Y/N)
 DESCRIPTION LIMIT DYNAMIC VOLUME DEFINITION DEPENDING ON REQUEST TYPE.
 DESCRIPTION
 DOCMEM      ACCT6     DOCLIB CTTP.PROD.DOC
============================================================================
 ON DATASET   = *                                               And/Or/Not A
 ON VOLSER    = EVOL01 TO EVOL99                                And/Or/Not
============================================================================
 DO DYNVOL    = SPECIFIC REQUEST= Y    NON SPECIFIC REQUEST (SCRATCH)= E
 DO
============================================================================
============================================================================
 DAYS                                                          DCAL
                                                                    AND/OR
 WDAYS   ALL                                                   WCAL
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
 DATES
 CONFCAL          SHIFT
===== >>>>>>>>>>>>>>> END OF RULE DEFINITION PARAMETERS <<<<<<<<<<<<<<< =====
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT   15.35.11

DO FASTPOS: Action Parameter

Indicates that specified data sets are located using Fast Positioning.

Figure 141 DO FASTPOS Parameter Format

Optional. Type FASTPOS (or FA) in the DO field and press Enter. Specify YES (or Y), NO (N), OVERRIDE (O), or TEST (T) following the = prompt.

Table 149 DO FASTPOS Subparameters

General Information

MVS Fast Positioning dramatically cuts the time required to position a tape to a data set.

Fast Positioning by Control-M/Tape works as follows:

1. At time of data set creation, Control-M/Tape retrieves the blockID of the data set from the operating system, and stores it in the Control-M/Tape Media Database. The blockID identifies the data set location on the tape.

2. During subsequent access of the data set, Control-M/Tape retrieves the blockID from the Media Database, and passes it to the operating system, which then fast positions the tape to the specific location.

For more information on Fast Positioning, see Fast Positioning a Tape.

Example

RULE: ACCT13  LIB CTTP.PROD.RULES                              TABLE: SAMPLES
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   ACCT13    GROUP                           MODE PROD (Prod/Test) 
 OWNER       N70B      SEQUENCE PRIORITY    CONTINUE SEARCH Y    (Y/N)       
 DESCRIPTION LOCATE SALARY.DB.YEAR DATASETS USING FAST POSITIONING           
 DESCRIPTION                                                                 
 DOCMEM      ACCT13    DOCLIB CTTP.PROD.DOC                                  
============================================================================
 ON DATASET   = SALARY.DB.YEAR*                                 And/Or/Not   
============================================================================ 
 DO FASTPOS   = YES                                                          
 DO                                                                          
============================================================================ 
============================================================================ 
 DAYS                                                          DCAL        
                                                                    AND/OR 
 WDAYS   ALL                                                   WCAL        
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y    
 DATES                                                                     
 CONFCAL          SHIFT                                                    
======= >>>>>>>>>>>>>>> END OF RULE DEFINITION PARAMETERS <<<<<<<<<<<<<<< ====


FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    16.24.33

DO FORCEJOB: Action Parameter

Force a job under Control-M for z/OS.

Figure 143 DO FORCEJOB Parameter Format

Type the word FORCEJOB (or its abbreviation FO) in the DO field and press Enter. The following subparameters are displayed:

Table 150 DO FORCEJOB Subparameters

General Information

Control-M/Tape AutoEdit variables embedded in the TABLE, JOB, DATE, and LIBRARY subparameters are automatically resolved (replaced) at time of rule activation. For information about the use of AutoEdit variables, see AutoEdit Variables.

DO FORCEJOB requests that Control-M add the jobs to the Control-M Active Jobs file, even if the job’s basic scheduling criteria are not met. Using DO FORCEJOB is the same as using the FORCE option in the Control-M Job List screen.

Example

RULE: FORGNREP LIB CTT.PROD.RULES                               TABLE: FOREIGN
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   FORGNREP  GROUP                           MODE PROD (Prod/Test)
 OWNER       N73       SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION THIS RULE FORCES A CONTROL-M JOB THAT READS THE FOREIGN
 DESCRIPTION CURRENCY REPORT THAT IS CHECKED INTO THE SYSTEM.
 DESCRIPTION
 DOCMEM      FORGNREP  DOCLIB CTT.PROD.DOCS
============================================================================
 ON DATASET   = FOREIGN.CURRENCY.REPORT                         And/Or/Not
============================================================================
 DO FORCEJOB  = TABLE   FOREIGN      JOB FORGNREP             DATE ODAT
                LIBRARY CTM.PROD.SCHEDULE
           AT   CHECK IN VOLUMES
 DO SHOUT     = TO TSO-N73           URGENCY  R
    MESSAGE   CONTROL-M/TAPE RECEIVED A NEW FOREIGN TAPE %%VOL001
           AT   CHECK IN VOLUMES
 DO SHOUT     = TO TSO-N73           URGENCY  V
    MESSAGE   PROCESSING OF FOREIGN.CURRENCY.REPORT ABENDED.
           AT   CLOSE AFTER ABEND
 DO
============================================================================
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    17.13.09

DO LABEL: Action Parameter

Indicates whether an external (gummed) label is printed when the data set is created.

Figure 145 DO LABEL Parameter Format

Optional. Type LABEL (or its abbreviation L) in the DO field and press Enter. Type Y or N following the = prompt.

Table 151 DO LABEL Subparameters

Only one DO LABEL statement can be specified per rule.

General Information

External labels are printed in one of two formats, depending on whether the volume is an external volume:

Table 152 DO LABEL Label Format

Label format can be customized by Control-M/Tape Exit CTTX009. This exit can also be used to decide whether to print the label on the console printer or on the VTAM printer. Exit CTTX009 is described in the Exits chapter of the INCONTROL for z/OS Administrator Guide.

Example

RULE: STARTLBL LIB CTT.PROD.RULES                               TABLE: PRD0043
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   STARTLBL  GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)      
 DESCRIPTION THIS RULE CHANGES THE OWNER OF SPECIFIC M43 DATASETS TO M18.   
 DESCRIPTION                                                                
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS                                 
============================================================================
 DOC                                                                        
============================================================================
 ON DATASET   = *                                               And/Or/Not A
 ON VOLSER    = VOL001
============================================================================
 DO   LABEL   = Y                                                           
 DO
============================================================================
============================================================================
 DAYS    ALL                                                   DCAL         
                                                                    AND/OR  
 WDAYS                                                         WCAL         
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y     
 DATES                                                                      
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

DO OVERJCL: Action Parameter

Indicates whether Control-M/Tape rule definitions should override expiration dates set by the retention attributes of the operating system.

Figure 147 DO OVERJCL Parameter Format

Optional. Type OVERJCL (or its abbreviation OV) in the DO field and press Enter. Specify Y or N following the = prompt.

Table 153 DO OVERJCL Subparameters

Only one DO OVERJCL statement can be specified per rule.

General Information

The retention attributes of the operating system are derived from a combination of Retention Limit and Expiration attributes (if the Control-M/Tape/DFSMS interface is active) and JCL EXPDT/RETPD parameters. The DO OVERJCL statement can be used to indicate if the retention specified in Control-M/Tape rules should override operating system retention.

For more information about JCL EXPDT/RETPD parameters, see "Defining Management Class Attributes" in the IBM manual DFSMSdfp Storage Administration Reference.

If no DO OVERJCL statement is specified in a rule, the value specified for Control-M/Tape installation parameter OVERJCL determines whether operating system retention is overridden by retention specified in Control-M/Tape rules.

Example

RULE: ACCT7    LIB CTTP.PROD.RULES                              TABLE: SAMPLES
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   ACCT7     GROUP                           MODE PROD (Prod/Test)
 OWNER       N89       SEQUENCE PRIORITY    CONTINUE SEARCH N    (Y/N)
 DESCRIPTION OVERRIDE MVS RETENTION FOR DATASETS PREFIXED BY N70.BACKUP
 DESCRIPTION
 DOCMEM      ACCT7     DOCLIB CTTP.PROD.DOC
============================================================================
 ON DATASET   = N70.BACKUP*                                     And/Or/Not
============================================================================
 DO OVERJCL   = YES
 DO RETENTION = DAYS               00030                        And/Or
 DO
============================================================================
============================================================================
 DAYS                                                          DCAL
                                                                    AND/OR
 WDAYS   ALL                                                   WCAL
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
 DATES
 CONFCAL          SHIFT
======= >>>>>>>>>>>>>>> END OF RULE DEFINITION PARAMETERS <<<<<<<<<<<<<<< =====
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    16.26.25

DO OWNER: Action Parameter

Assigns an owner to a volume or data set.

Figure 149 DO OWNER Parameter Format

Optional. Type OWNER (or its abbreviation OW) in the DO field and press Enter. Specify the OWNER name to the right of the = prompt.

Table 154 DO OWNER Subparameter

General Information

DO OWNER specifies a user-defined name of the owner of the volumes or data sets.

Only one DO OWNER statement can be specified per rule.

Example

RULE: STARTLBL LIB CTT.PROD.RULES                               TABLE: PRD0043
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   STARTLBL  GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION THIS RULE CHANGES THE OWNER OF SPECIFIC M43 DATASETS TO M18.
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS
============================================================================
 DOC
============================================================================
 ON DATASET   = *                                               And/Or/Not A
 ON VOLSER    = SYS
============================================================================
 DO OWNER     = M18
 DO
============================================================================
============================================================================
 DAYS    ALL                                                   DCAL
                                                                    AND/OR
 WDAYS                                                         WCAL
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
 DATES
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

DO POOL: Action Parameter

Indicates the name of the pool from which scratch volumes are taken.

Figure 151 DO POOL Parameter Format

Optional. Type the word POOL (or its abbreviation P) in the DO field and press Enter. Specify following subparameter to the right of the = prompt:

Table 155 DO POOL Subparameter

General Information

DO POOL specifies the collection of volumes from that a scratch tape volume is requested. Each pool can contain any number of volumes.

Only one DO POOL statement can be specified per rule.

All pools are defined using the Pool Definition screen. By default, these definitions are stored in the Control-M/Tape PARM library in member $$POOL.

Example

RULE: POOLINIT LIB CTT.PROD.RULES                               TABLE: PRD0004
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   POOLINIT  GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 09 CONTINUE SEARCH Y    (Y/N)      
 DESCRIPTION THIS RULE ASSIGNS THE ACCOUNTING POOL FOR SCRATCH              
 DESCRIPTION PURPOSES TO JOBS STARTING WITH PRD.           
 DESCRIPTION                                                                
 DOCMEM      POOLINIT  DOCLIB CTT.PROD.DOCS                                 
============================================================================
 DOC                                                                        
============================================================================
 ON DATASET   = *                                               And/Or/Not A
 ON JOBNAME   = PRD*                                            And/Or/Not  
============================================================================
 DO POOL      = ACCOUNTING                                                  
 DO                                                                         
============================================================================
 DAYS    ALL                                                   DCAL         
                                                                    AND/OR  
 WDAYS                                                         WCAL         
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y     
 DATES                                                                      
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

DO RECREATE: Action Parameter

Indicates whether an existing data set can be overwritten by the specified data sets.

Figure 153 DO RECREATE Parameter Format

Optional. Type RECREATE (or its abbreviation REC) in the DO field and press Enter. Specify one of the following values to the right of the = prompt:

Table 156 DO RECREATE Parameter Values

Only one DO RECREATE statement can be specified per rule.

General Information

When Y (Yes) is specified, Control-M/Tape allows an existing data set to be overwritten if all of the following conditions are met:

• This is the last data set on the volume.

• The data set name is the same as that of the existing data set.

• The disposition is OLD (DISP=OLD).

• Y or P was specified for either the Control-M/Tape installation parameter RECREATE, or the DO RECREATE statement in a Control-M/Tape rule.

• The data set was not assigned permanent retention.

  However, there is an exception when the job that is accessing the data set is the same job that created the data set (meaning, a different step in the same job). In this case, the expression DISP=NEW is acceptable.

If no DO RECREATE statement is specified in a rule, the value specified for Control-M/Tape installation parameter RECREATE determines whether the data set can be recreated.

Example

RULE: ACCT8   LIB CTTP.PROD.RULES                               TABLE: SAMPLES
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   ACCT8    GROUP                            MODE PROD (Prod/Test)
 OWNER       N89       SEQUENCE PRIORITY    CONTINUE SEARCH N    (Y/N)
 DESCRIPTION ALLOW RECREATION OF DATASETS PREFIXED BY N70.NEW.DATASETS.
 DESCRIPTION
 DOCMEM      ACCT8    DOCLIB CTTP.PROD.DOC
============================================================================
 ON DATASET   = N70.NEW.DATASETS*                               And/Or/Not
============================================================================
 DO RECREATE  = YES
 DO
============================================================================
============================================================================
 DAYS                                                          DCAL
                                                                    AND/OR
 WDAYS   ALL                                                   WCAL
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
 DATES
 CONFCAL          SHIFT
======= >>>>>>>>>>>>>>> END OF RULE DEFINITION PARAMETERS <<<<<<<<<<<<<<< =====

FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    16.27.08

DO RESOURCE: Action Parameter

Modifies the quantity of available resources.

Figure 155 DO RESOURCE Parameter Format

Optional. Type RESOURCE (or its abbreviation RES) in the DO field and press Enter. The DO RESOURCE statement consists of the following subparameters:

Table 157 DO RESOURCE Subparameters

General Information

The DO RESOURCE statement adjusts the quantity of resources available at the site (for example, tape drives, CPU, or DB access). Upon rule activation, Control-M/Tape can change the quantity of an IOA Quantitative resource.

DO RESOURCE cannot be used to add new resources.

Multiple DO RESOURCE statements can be specified in a single rule.

AutoEdit variables embedded in the specified resource name are automatically resolved (replaced) at time of rule activation. For information about AutoEdit variables, see AutoEdit Variables.

Example

RULE: FREESLOT LIB CTTP.PROD.RULES                              TABLE: RULE1
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   FREESLOT  GROUP                           MODE PROD (Prod/Test) 
 OWNER       N44       SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)       
 DESCRIPTION THIS RULE DECREASES THE NUMBER OF FREE SLOTS WHEN A VOLUME      
 DESCRIPTION IS CHECKED IN                                                   
 DESCRIPTION                                                                 
 DOCMEM      FORGNVOL  DOCLIB CTT.PROD.DOCS                                  
============================================================================
 ON DATASET   = *                                               And/Or/Not   
============================================================================
 DO RESOURCE  = FREE-SLOTS           0001 -                                  
           AT   CHECK IN VOLUMES                                             
 DO                                                                          
============================================================================ 
============================================================================
 DAYS                                                          DCAL        
                                                                    AND/OR 
 WDAYS   ALL                                                   WCAL        
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y    
 DATES                                                                     
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    08.14.25

DO RETENTION: Action Parameter

Specifies a period during that a data set is protected from being scratched or overwritten.

Figure 157 DO RETENTION Parameter Format

Optional. Type RETENTION (or its abbreviation RET) in the DO field and press Enter. Specify a retention type to the right of the = prompt. Using the And/Or subparameter a maximum of three retention types can be specified.

Depending on the retention type specified, different subparameters are displayed.

The retention types and their abbreviations, descriptions, and subparameters are listed below:

General Information

Table 158 DO RETENTION Types

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.

Examples

ON DATASET=BKP*
DO RETENTION=CYCLES 0010 PREFIX Y

ON DATASET=BKP*
DO RETENTION CYCLES 0010 PREFIX N

RULE: BKPSAVE  LIB CTT.PROD.RULES                               TABLE: BKP0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   BKPSAVE   GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 03 CONTINUE SEARCH Y    (Y/N)      
 DESCRIPTION SETS RETENTION AND ABEND-RETENTION PERIODS FOR BACKUP FILES
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS                                 
============================================================================
 DOC                                                                        
============================================================================
 ON DATASET   = BKP*                                            And/Or/Not A
 ON PGM       = BKP*                                            And/Or/Not A
 ON USERID    = ADMIN                                           And/Or/Not  
============================================================================
 DO RETENTION = DAYS              00365                         And/Or
 DO ABENDRET  = DAYS               0010                         And/Or      
 DO                                                                         
============================================================================
============================================================================
 DAYS    ALL                                                   DCAL         
                                                                    AND/OR  
 WDAYS                                                         WCAL
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

RULE: BKPSAVE  LIB CTT.PROD.RULES                               TABLE: BKP0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   BKPSAVE   GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 03 CONTINUE SEARCH Y    (Y/N)      
 DESCRIPTION SETS RETENTION AND ABEND-RETENTION PERIODS FOR BACKUP FILES
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS                                 
============================================================================
 DOC                                                                        
============================================================================
 ON DATASET   = BKP*                                            And/Or/Not A
 ON PGM       = BKP*                                            And/Or/Not A
 ON USERID    = ADMIN                                           And/Or/Not  
============================================================================
 DO RETENTION = LAST ACCESS        0004                         And/Or     A
                CYCLES             0006     PREFIX Y  (Y/N)     And/Or     A
                JCL EXPDT                                                   
 DO ABENDRET  = CYCLES             0001     PREFIX Y  (Y/N)     And/Or      
 DO
============================================================================
============================================================================
 DAYS    ALL                                                   DCAL         
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

DO SET: Action Parameter

Assigns a value to an AutoEdit variable.

Figure 160 DO SET Parameter Format

Optional. Type SET (or its abbreviation SE) in the DO field and press Enter. The following subparameters are displayed:

Table 159 DO SET Subparameters

General Information

To take full advantage of this parameter, a familiarity with Control-M/Tape AutoEdit variables is essential.

The DO SET statement permits values to be set for variables.

Multiple DO SET statements can be included in each rule definition.

Control-M/Tape AutoEdit variables assigned or embedded in a DO SET statement are resolved (replaced) during rule activation.

Variables can be referenced by other INCONTROL products. For more information regarding the use of AutoEdit variables, see B AutoEdit Variables.

Example

RULE: FORGNDSN LIB CTT.PROD.RULES                               TABLE: FOREIGN
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   FORGNDSN  GROUP                           MODE PROD (Prod/Test)
 OWNER       N73       SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION THIS RULE UPDATES THE MEMBER CURRENCY IN CTT.PROD.PARM
 DESCRIPTION LIBRARY, WITH THE DSNAME AND VOLUME OF THE CHECKED IN
 DESCRIPTION VOLUME, AND FORCES THE FORGNREP JOB.
 DESCRIPTION
 DOCMEM      FORGNDSN  DOCLIB CTT.PROD.DOCS
============================================================================
 ON DATASET   = FOREIGN.CURRENCY.FILE*                          And/Or/Not
============================================================================
 DO SET       = %%DATASET=%%DSNAME
    MEMBER CURRENCY    LIBRARY CTT.PROD.PARM
           AT   CHECK IN VOLUMES
 DO SET       = %%VOLUMES=(%%JCLVOL)
    MEMBER CURRENCY    LIBRARY CTT.PROD.PARM
           AT   CHECK IN VOLUMES
 DO FORCEJOB  = TABLE   FOREIGN      JOB FORGNREP             DATE  ODAT
                LIBRARY CTM.PROD.SCHEDULE
           AT   CHECK IN VOLUMES
 DO
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    17.32.15

DO SHOUT: Action Parameter

Sends a user notification message to a particular destination.

Figure 162 DO SHOUT Parameter Format

Optional. Type SHOUT (or its abbreviation SH) in the DO field and press Enter. The following subparameters are displayed:

Table 160 DO SHOUT Subparameters

General Information

The message is sent to the required destination when the accompanying ON statement criteria are satisfied.

Multiple DO SHOUT statements can be specified in a rule definition.

Subparameter TO

Set TO to USERID-userid to write the message to the IOA Log file under the user ID specified in the parameter.

Set TO to OPER[–n] to send the message to the operator console (route code n). If the n value is omitted, the message is sent to all consoles to which route codes 1 or 11 are assigned. For more detailed information regarding route and descriptor codes, refer to the IBM publication Routing and Descriptor Codes, GC38-1102.

Set TO to OPER2[–n] to send a highlighted, unrollable message is sent to the operator console (route code n). If the n value is omitted, the message is sent to all consoles to which route codes 1 or 11 are assigned. For more detailed information regarding route and descriptor codes, refer to the IBM publication Routing and Descriptor Codes, GC38-1102.

Set TO to TSO-id or T-id to send the message to the logonid. The Shout facility first searches the IOA Dynamic Destination table for the specified ID. If the table contains an entry that matches the value, the entry’s content is used as the target for the shouted message. (The entire TO field is used. Therefore, when directing the message to a remote user, do not append Nn or Mm. Instead, do this in the IOA Dynamic Destination table itself). For more information, see the discussion of the Dynamic Destination table in the IOA administration chapter of the INCONTROL for z/OS Administrator Guide.

If no matching ID is found in the Dynamic Destination table, the Shout facility assumes the specified ID is a logonid. It then creates a TSO message that it hands over to the operating system, which sends the message to that logonid.

If the logonid does not exist, the operating system cannot send the message, but no error message is generated.

Subparameter URGENCY

The URGENCY value indicates the urgency level of the message.

In addition, if the destination is USERID-userid (or U-userid), the user can control, according to urgency, which messages are displayed when the IOA Log file is accessed. Urgent and very urgent messages are highlighted on the screen. For more details, see IOA Log Facility.

Example

RULE: FORGNREP LIB CTT.PROD.RULES                               TABLE: FOREIGN
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   FORGNREP  GROUP                           MODE PROD (Prod/Test)
 OWNER       N37       SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION THIS RULE FORCES A CONTROL-M JOB THAT READS THE FOREIGN
 DESCRIPTION CURRENCY REPORT THAT IS CHECKED INTO THE SYSTEM.
 DESCRIPTION
 DOCMEM      FORGNREP  DOCLIB CTT.PROD.DOCS
============================================================================
 ON DATASET   = FOREIGN.CURRENCY.REPORT                         And/Or/Not
============================================================================
 DO FORCEJOB  = TABLE   FOREIGN      JOB FORGNREP             DATE  ODAT
                LIBRARY CTM.PROD.SCHEDULE
           AT   CHECK IN VOLUMES
 DO SHOUT     = TO TSO-N73           URGENCY  R
    MESSAGE   CONTROL-M/TAPE RECEIVED A NEW FOREIGN TAPE %%VOL001
           AT   CHECK IN VOLUMES
 DO SHOUT     = TO TSO-N73           URGENCY  V
    MESSAGE   PROCESSING OF FOREIGN.CURRENCY.REPORT ABENDED.
           AT   CLOSE AFTER ABEND
 DO
============================================================================
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    19.30.34

DO STACK: Action Parameter

Indicates whether to stack a data set. (A data set is stacked by adding it to a volume that already contains one or more data sets.)

Figure 164 DO STACK Parameter Format

Optional. Type STACK (or its abbreviation STA) in the DO field and press Enter. Specify Y or N to the right of the = prompt.

• Y (Yes) – Stacking is performed.

• N (No) – Stacking is not performed.

If the expression DO STACK=N is specified, the following subparameter is displayed:

Table 161 DO STACK Subparameter

General Information

Only one DO STACK statement can be specified per rule definition.

Stacking directs a data set dynamically at the time of its creation to a volume that already contains one or more data sets but has space available. This enables more complete utilization of free space on active tapes in your library.

If a rule contains the expression DO STACK=Y, Control-M/Tape implements real-time (Dynamic) data set stacking (provided environmental conditions permit stacking to be performed).

If a rule contains the expression DO STACK=N, Control-M/Tape does not stack the data set, unless a more specific, or higher priority, rule that applies to the data set contains the expression DO STACK=Y.

If a rule contains the expression DO STACK=N and SCOPE DSN, Control-M/Tape may later stack other data sets on the same volume as the current data set. In other words, the current data set is the first, but not necessarily the only, data set on the volume.

If a rule contains the expression DO STACK=N and SCOPE VOL, Control-M/Tape does not stack other data sets on the same volume as the current data set. In other words, the current data set is the first and only data set on the volume.

If a rule does not contain a DO STACK statement, Control-M/Tape does not stack the data set unless another rule that applies to the data set contains the expression DO STACK=Y.

To stack data sets, Control-M/Tape tracks and calculates the average size of each data set (on the basis of the sizes of the various versions of the data set). This information is stored in the Stacking Database. Based on the average size, Control-M/Tape estimates whether a data set will fit on a specific volume.

When a data set is written to a volume, Control-M/Tape calculates the remaining space on the volume. This calculation is based on the volume’s capacity and the sizes of the data sets that the volume contains. By calculating the remaining space on a volume, Control-M/Tape can determine whether it is possible to stack a data set.

Using these calculations, when a job that creates a data set is submitted, Control-M/Tape checks if the data set can be stacked. If so, Control-M/Tape modifies the job’s JCL to direct the data set to a suitable volume.

For additional information about stacking, see the data set stacking chapter of the Control-M/Tape Implementation Guide.

Example

RULE: STARTSTK LIB CTT.PROD.RULES                               TABLE: PRD0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   STARTSTK  GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)     
 DESCRIPTION THIS RULE ENABLES STACKING FOR ALL DATA SETS.                 
 DESCRIPTION                                                               
 DOCMEM      STARTSTK  DOCLIB CTT.PROD.DOCS                                
============================================================================
 DOC                                                                       
============================================================================
 ON DATASET   = *                                               And/Or/Not 
============================================================================
 DO STACK     = Y                                             
 DO                                                                        
============================================================================
============================================================================
 DAYS    ALL                                                   DCAL        
                                                                    AND/OR 
 WDAYS                                                         WCAL        
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y    
 DATES                                                                     
 CONFCAL          SHIFT                                                    
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

DO STKDEFSZ: Action Parameter

Assigns a default size in megabytes for the data set to be stacked.

Figure 166 DO STKDEFSZ Parameter Format

Optional. Type STKDEFSZ (or its abbreviation STKD) in the DO field and press Enter. The following subparameter fields are displayed:

Table 162 DO STKDEFSZ Subparameters

Only one DO STKDEFSZ statement can be specified per rule.

General Information

Data sets are normally stacked according to statistics in the Control-M/Tape Stacking Database. This database is maintained by the stacking statistics utility CTTSTK that is usually run as part of the Control-M/Tape New Day procedure.

If no statistics have been gathered for a data set, a default number of megabytes is used to calculate how much space is needed to stack the data set. The default number of megabytes may be specified by either a DO STKDEFSZ statement in a Control-M/Tape rule, or by the STKDEFSZ installation parameter.

For more information about stacking statistics, see the description of the CTTSTK utility in the Control-M/Tape utilities chapter of the INCONTROL for z/OS Utilities Guide.

Logic for Determining Size of a Data Set to be Stacked

Control-M/Tape searches for a size for a data set to be stacked in the following locations. The first location that contains a value for size of the data set is used to stack the data set.

• a DO STKDEFSZ statement in a Control-M/Tape rule (if OVERRIDE STATISTICS is set to YES)

• the Stacking Database (called the Stacking Statistics file prior to version 5.1.4)

• a DO STKDEFSZ statement in a Control-M/Tape rule (if OVERRIDE STATISTICS is set to NO)

• Control-M/Tape installation parameter STKDEFSZ (in the CTTPARM parameter)

If no value is found in any of the above locations, the data set is not stacked.

Example

RULE: ACCT10   LIB CTTP.PROD.RULES                              TABLE: SAMPLES
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   ACCT10    GROUP                           MODE PROD (Prod/Test)
 OWNER       N70B      SEQUENCE PRIORITY    CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION
 DOCMEM      ACCT10    DOCLIB CTTP.PROD.DOC
============================================================================
 ON DATASET   = N70.DAILY.*                                     And/Or/Not
============================================================================
 DO STACK     = Y  (Y/N) 
 DO STKDEFSZ  = 0100  OVERRIDE STATISTICS NO
 DO
============================================================================
============================================================================
 DAYS                                                          DCAL        
                                                                    AND/OR 
 WDAYS   ALL                                                   WCAL        
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y    
 DATES                                                                     
 CONFCAL          SHIFT                                                    
======= >>>>>>>>>>>>>>> END OF RULE DEFINITION PARAMETERS <<<<<<<<<<<<<<< ====
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    09.07.23

DO STKGROUP: Action Parameter

Specifies a stacking group for the data set.

Figure 168 DO STKGROUP Parameter Format

Optional. Type STKGROUP (or its abbreviation STKG) in the DO field and press Enter. The following subparameter must be specified to the right of the = prompt:

Table 163 DO STKGROUP Subparameter

Only one DO STKGROUP statement can be specified in each Control-M/Tape rule.

General Information

If no DO STKGROUP statement is specified for a data set, that data set is assigned an unnamed default group, and can only be stacked with other data sets that have been assigned to that default group.

The following steps describe how stacking groups influence the logic used to choose a volume on which to stack a data set:

1. When a volume is first considered for stacking a data set, Control-M/Tape checks if the volume belongs to the same pool as the data set to be stacked.

2. Control-M/Tape next checks if the data sets already on the volume belong to the same group as the data set to be stacked (or have a group specification of *ANY).

3. If the data sets on the volume belong to an appropriate group, Control-M/Tape checks for DO STKRULE statements that might disallow stacking of the current data set with the data sets on the candidate volume.

4. If no DO STKRULE statements prohibit stacking on the current volume, the data set is stacked on the current volume.

Example

RULE: ACCT1    LIB CTT.PROD.RULES                               TABLE: SAMPLES
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   ACCT1     GROUP                           MODE PROD (Prod/Test)
 OWNER       N89       SEQUENCE PRIORITY    CONTINUE SEARCH N    (Y/N)
 DESCRIPTION ASSIGN A STACKING GROUP FOR ALL DATASETS PREFIXED BY N70.ACCT
 DESCRIPTION
 DOCMEM      ACCT1     DOCLIB CTTP.PROD.DOC
============================================================================
 DOC
============================================================================
 ON DATASET   = N70.ACCT*                                       And/Or/Not
============================================================================
 DO STKGROUP  = STKGRP1
 DO STKMXLBL  = 9999
 DO
============================================================================
============================================================================
 DAYS                                                          DCAL
                                                                    AND/OR
 WDAYS   ALL                                                   WCAL
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
 DATES
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    11.26.56

DO STKMODE: Action Parameter

Determines the algorithm used to search for a volume on which to stack the data set.

Figure 170 DO STKMODE Parameter Format

Optional. Type STKMODE (or its abbreviation STKMO) in the DO field and press Enter. Specify one of the following values to the right of the = prompt:

Table 164 DO STKMODE Parameter Values

Only one DO STKMODE statement can be specified per rule.

General Information

The value specified in statement DO STKMODE indicates how the Dynamic Dataset Stacking facility should search for a volume on which to stack the data set or data sets whose access triggered this rule. The selected search method can influence volume utilization and the resources required to search the Media Database for a matching volume.

If no DO STKMODE statement is specified in a rule, the value specified for Control-M/Tape installation parameter STKMODE determines the algorithm that is used to stack the data set.

Example

RULE: ACCT11   LIB CTTP.PROD.RULES                              TABLE: SAMPLES
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   ACCT11    GROUP                           MODE PROD (Prod/Test)
 OWNER       N70B      SEQUENCE PRIORITY    CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION SEARCH FOR VOLUMES WITH MATCHING VAULT AND RETENTION INFORMATION
 DESCRIPTION WHEN STACKING DATASETS PREFIXED BY N70.DAILY.
 DESCRIPTION
 DOCMEM      ACCT11    DOCLIB CTTP.PROD.DOC
============================================================================
 ON DATASET   = N70.DAILY.*                                   And/Or/Not
============================================================================
 DO STACK     = Y  (Y/N) 
 DO STKMODE   = ALL
 DO
============================================================================
============================================================================
 DAYS                                                          DCAL        
                                                                    AND/OR 
 WDAYS   ALL                                                   WCAL        
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y    
 DATES                                                                     
 CONFCAL          SHIFT                                                    
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    09.12.26

DO STKMXLBL: Action Parameter

Indicates a maximum number of data sets that can be stacked on a single volume or on a group of volumes.

Figure 172 DO STKMXLBL Parameter Format

Optional. Type STKMXLBL (or its abbreviation STKMXL) in the DO field and press Enter. Specify the maximum label number to the right of the = prompt.

The value specified for this parameter must be numeric. A number from 2 through 9999 can be specified.

General Information

DO STKMXLBL specifies the maximum label count per volume or group of volumes when the data set is to be stacked using the Dynamic Dataset Stacking facility. A volume or group of volumes that already has this number of data sets is not eligible for dynamic stacking.

Example

RULE: ACCT2    LIB CTTP.PROD.RULES                              TABLE: SAMPLES
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   ACCT2     GROUP                           MODE PROD (Prod/Test)
 OWNER       N89       SEQUENCE PRIORITY    CONTINUE SEARCH N    (Y/N)
 DESCRIPTION STACK DATASETS WITH A PREFIX OF N70.ACCT ON VOLUMES WITH NO
 DESCRIPTION MORE THAN FOUR DATASETS
 DESCRIPTION
 DOCMEM      ACCT2     DOCLIB CTTP.PROD.DOC
============================================================================
 DOC
===========================================================================
 ON DATASET   = N70.ACCT*                                       And/Or/Not
===========================================================================
 DO STACK     = Y  (Y/N)
 DO STKMXLBL  = 0005
 DO
===========================================================================
===========================================================================
 DAYS                                                          DCAL        
                                                                    AND/OR 
 WDAYS   ALL                                                   WCAL        
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y    
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    12.10.03

DO STKMXVOL: Action Parameter

Specifies the maximum number of volumes in a chain on that the data set can be stacked.

Figure 174 DO STKMXVOL Parameter Format

Optional. Type STKMXVOL (or its abbreviation STKMXV) in the DO field and press Enter. Specify the maximum number of volumes to the right of the = prompt.

General Information

DO STKMXVOL is used with Dynamic Dataset Stacking. When stacking data sets, DO STKMXVOL specifies the maximum number of volumes allowed in multi-volume chains. The number must be in a range from 1 through 9999.

Only one DO STKMXVOL statement can be specified per rule.

If no DO STKMXVOL statement is specified in a rule, an unlimited number of volumes are allowed in multi-volume chains.

Example

RULE: ACCT12   LIB CTTP.PROD.RULES                              TABLE: SAMPLES
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   ACCT12    GROUP                           MODE PROD (Prod/Test) 
 OWNER       N70B      SEQUENCE PRIORITY    CONTINUE SEARCH Y    (Y/N)      
 DESCRIPTION STACK EMPLOYEE.DB.. DATASETS IN CHAINS OF 2 VOLS MAXIMUM       
 DESCRIPTION                                                                
 DOCMEM      ACCT12    DOCLIB CTTP.PROD.DOC                                 
===========================================================================
 ON DATASET   = EMPLOYEE.DB.YEAR*                               And/Or/Not  
===========================================================================
 DO STACK     = Y  (Y/N)                                                    
 DO STKMXVOL  = 0002                                                        
 DO                                                                         
===========================================================================
===========================================================================
 DAYS                                                          DCAL        
                                                                    AND/OR 
 WDAYS   ALL                                                   WCAL        
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y    
 DATES                                                                     
 CONFCAL          SHIFT                                                    
======= >>>>>>>>>>>>>>> END OF RULE DEFINITION PARAMETERS <<<<<<<<<<<<<<< ====
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT     9.47.01

DO STKRULE: Action Parameter

Set a stacking limitation that denies stacking in certain situations.

Figure 176 DO STKRULE Parameter Format

Optional. Type STKRULE (or its abbreviation STKRU) in the DO field and press Enter. A value must be specified for at least one of the following subparameters:

Table 165 DO STKRULE Subparameters

Any number of DO STKRULE statements can be specified in one Control-M/Tape rule.

The expression DO STACK=Y must precede the first DO STKRULE statement in a rule. A DO STKRULE statement by itself does not cause Control-M/Tape to stack a data set.

General Information

Statement DO STKRULE indicates limitations regarding the tapes on that the current data set can be stacked.

• If a value is specified for only subparameter JOB, the data set cannot be stacked on a volume that already contains data sets that were created by the specified job name.

• If a value is specified for only subparameter DSN, the data set cannot be stacked on a volume that already contains data sets with the specified data set name.

• If values are specified for both subparameter JOB and subparameter DSN, the data set cannot be stacked on a volume that contains a data set with the specified name that was created by the specified job name.

DO STKRULE statements are applied within the group assigned to the specified data set. For more information about stacking groups, see DO STKGROUP in this chapter.

Example

RULE: ACCT3    LIB CTTP.PROD.RULES                              TABLE: SAMPLES
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   ACCT3     GROUP                           MODE PROD (Prod/Test)
 OWNER       N89       SEQUENCE PRIORITY    CONTINUE SEARCH N    (Y/N)
 DESCRIPTION INDICATE STACKING RULES FOR DATASETS PREFIXED BY N70.ACCT.
 DESCRIPTION
 DOCMEM      ACCT3     DOCLIB CTTP.PROD.DOC
===========================================================================
 DOC
===========================================================================
 ON DATASET   = N70.ACCT*                                       And/Or/Not
===========================================================================
 DO STACK     = Y  (Y/N)
 DO STKRULE   = NOT WITH JOB JOB1
                         DSN
 DO STKRULE   = NOT WITH JOB
                         DSN DSN1
 DO STKRULE   = NOT WITH JOB JOB2
                         DSN DSN2
 DO
===========================================================================
===========================================================================
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    13.16.46

DO STKSRCHL: Action Parameter

Specifies a maximum number of volumes that Control-M/Tape should consider for stacking the data set.

Figure 178 DO STKSRCHL Parameter Format

Optional. Type STKSRCHL (or its abbreviation STKS) in the DO field and press Enter. Specify the following subparameter to the right of the = prompt:

Table 166 DO STKSRCHL Subparameter

Only one DO STKSRCHL statement can be specified per rule.

General Information

If the maximum number of volumes is searched and none of them can be used to stack the data set, the data set is written to a scratch volume.

If no DO STKSRCHL statement is specified in a rule, the value specified for Control-M/Tape installation parameter STKSRCHL determines the number of volumes to be considered for stacking the data set.

Example

RULE: ACCT22   LIB CTTP.PROD.RULES                              TABLE: SAMPLES
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   ACCT22    GROUP                           MODE PROD (Prod/Test)
 OWNER       N89       SEQUENCE PRIORITY    CONTINUE SEARCH N    (Y/N)
 DESCRIPTION LIMIT SEARCH FOR STACKABLE VOLUME TO 300 FOR VOLUMES WITH A
 DESCRIPTION PREFIX OF N70.ACCT.
 DESCRIPTION
 DOCMEM      ACCT22    DOCLIB CTTP.PROD.DOC
===========================================================================
 DOC
===========================================================================
 ON DATASET   = N70.ACCT*                                       And/Or/Not
===========================================================================
 DO STACK     = Y  (Y/N)   SCOPE
 DO STKSRCHL  = 0300
 DO
===========================================================================
===========================================================================
 DAYS                                                          DCAL        
                                                                    AND/OR 
 WDAYS   ALL                                                   WCAL        
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y    
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    12.10.03

DO VAULT: Action Parameter

Identifies the name or location and retention specifications of a vault for volume storage.

Figure 180 DO VAULT Parameter Format

Optional. Type the word VAULT (or its abbreviation V) in the DO field and press Enter. The following subparameters are displayed:

Table 167 DO VAULT Subparameters

The UNTIL types and their abbreviations, descriptions, and subparameters are listed below:

Table 168 Types of DO VAULT Subparameter UNTIL

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.

Examples

ON DATASET=BKP*
DO VAULT=V1
     UNTIL   CYCLES 0010     PREFIX Y

ON DATASET=BKP*
DO VAULT=V1
     UNTIL   CYCLES 0010     PREFIX N

RULE: VAULTVOL LIB CTT.PROD.RULES                               TABLE: ACC0003
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   VAULTVOL  GROUP ACCOUNTING                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION THIS RULE VAULTS VOLUMES ACC001-ACC200 AT YEAR-END. THESE
 DESCRIPTION VOLUMES ARE RETAINED PERMANENTLY IN THE VAULT.
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS
===========================================================================
 DOC
===========================================================================
 ON DATASET   = ACC*                                            And/Or/Not A
 ON VOLSER    = ACC001 TO ACC200                                And/Or/Not
===========================================================================
 DO VAULT     = MAINLIB                     BY BOX    (Y/N)
      UNTIL   = DATE           0101 YEAR 2000                   And/Or
    VAULT     = VLT-ACC
      UNTIL     PERMANENT                                       And/Or
    VAULT     =
 DO
===========================================================================
===========================================================================
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

DOCLIB: General Parameter

Name of the library in which the rule documentation member resides.

Figure 182 DOCLIB Parameter Format

Optional. The DOCLIB parameter specifies a valid data set name of 1 through 44 characters.

General Information

The library can be any standard partitioned data set. The record length must be 80.

The default is defined in the profile library, or it is blank.

Any number of documentation libraries can be used at your site. However, only one documentation library can be specified in each rule definition.

Example

RULE: BKPSAVE  LIB CTT.PROD.RULES                               TABLE: BKP0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   BKPSAVE   GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 03 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION SETS RETENTION AND ABEND-RETENTION PERIODS FOR BACKUP FILES
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS
===========================================================================
 DOC
===========================================================================
 ON DATASET   = BKP*                                            And/Or/Not A
 ON PGM       = BKP*                                            And/Or/Not A
 ON USERID    = ADMIN                                           And/Or/Not
===========================================================================
 DO RETENTION = DAYS              00365                         And/Or
 DO ABENDRET  = CYCLES             0001     PREFIX Y  (Y/N)     And/Or
 DO
===========================================================================
===========================================================================
 DAYS    ALL                                                   DCAL
                                                                    AND/OR
 WDAYS                                                         WCAL
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

DOCMEM: General Parameter

Name of the member in which rule documentation resides.

Figure 184 DOCMEM Parameter Format

Optional. Parameter DOCMEM specifies a valid member name of 1 through 8 characters.

General Information

This member contains the detailed documentation written in the DOC lines of the Rule Definition screen.

As a default, the DOCMEM name is set to the same value as specified for RULE NAME.

Example

RULE: BKPSAVE  LIB CTT.PROD.RULES                               TABLE: BKP0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   BKPSAVE   GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 03 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION SETS RETENTION AND ABEND-RETENTION PERIODS FOR BACKUP FILES
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS
===========================================================================
 DOC
===========================================================================
 ON DATASET   = BKP*                                            And/Or/Not A
 ON PGM       = BKP*                                            And/Or/Not A
 ON USERID    = ADMIN                                           And/Or/Not
===========================================================================
 DO RETENTION = DAYS              00365                         And/Or
 DO ABENDRET  = CYCLES             0001     PREFIX Y  (Y/N)     And/Or
 DO
===========================================================================
===========================================================================
 DAYS    ALL                                                   DCAL
                                                                    AND/OR
 WDAYS                                                         WCAL
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

GROUP: General Parameter

Descriptive name for a group of rules that includes this rule.

Figure 186 GROUP Parameter Format

Optional. Parameter GROUP specifies a group name of 1 through 20 characters. No blanks (except trailing blanks) are allowed.

General Information

This parameter facilitates rule handling.

The group name appears in all important IOA Log messages relating to the group’s rules.

Example

RULE: BKPSAVE  LIB CTT.PROD.RULES                               TABLE: BKP0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   BKPSAVE   GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 03 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION SETS RETENTION AND ABEND-RETENTION PERIODS FOR BACKUP FILES
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS
===========================================================================
 DOC
===========================================================================
 ON DATASET   = BKP*                                            And/Or/Not A
 ON PGM       = BKP*                                            And/Or/Not A
 ON USERID    = ADMIN                                           And/Or/Not
===========================================================================
 DO RETENTION = DAYS              00365                         And/Or
 DO ABENDRET  = CYCLES             0001     PREFIX Y  (Y/N)     And/Or
 DO
===========================================================================
===========================================================================
 DAYS    ALL                                                   DCAL
                                                                    AND/OR
 WDAYS                                                         WCAL
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

MODE: General Parameter

Specifies the Control-M/Tape operation mode for this rule.

Figure 188 MODE Parameter Format

Parameter MODE determines whether Control-M/Tape should intervene in media management processes.

Table 169 MODE Subparameters

General Information

Test mode provides an opportunity to test the effects of a rule definition without performing actual processes.

Global Test mode (set using parameter MODE in member CTTPARM) overrides rule production mode.

Examples

RULE: BKPSAVE  LIB CTT.PROD.RULES                               TABLE: BKP0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   BKPSAVE   GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 03 CONTINUE SEARCH Y    (Y/N)     
 DESCRIPTION SETS RETENTION AND ABEND-RETENTION PERIODS FOR BACKUP FILES
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS                              
===========================================================================
 DOC                                                                       
===========================================================================
 ON DATASET   = BKP*                                            And/Or/Not A
 ON PGM       = BKP*                                            And/Or/Not 
===========================================================================
 DO RETENTION = DAYS              00365                         And/Or
 DO ABENDRET  = CYCLES             0001     PREFIX Y  (Y/N)     And/Or     
 DO                                                                        
===========================================================================
===========================================================================
 DAYS    ALL                                                   DCAL        
                                                                    AND/OR 
 WDAYS                                                         WCAL        
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y    
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

RULE: SETMODE  LIB CTT.TEST.RULES                               TABLE: ADM0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   SETMODE   GROUP TESTING                   MODE TEST (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION THIS RULE SETS THE MODE TO TEST FOR ALL DATA SETS.
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.TEST.DOCS
===========================================================================
 DOC
===========================================================================
 ON DATASET   = *                                               And/Or/Not
===========================================================================
 DO
===========================================================================
===========================================================================
 DAYS    ALL                                                   DCAL
                                                                   AND/OR
 WDAYS                                                         WCAL
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
 DATES
 CONFCAL          SHIFT
======= >>>>>>>>>>>>>>> END OF RULE DEFINITION PARAMETERS <<<<<<<<<<<<<<< ====
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

MONTHS: Basic Scheduling Parameter

Specifies months of the year when the rule is scheduled.

Figure 191 MONTHS Parameter Format

Optional. Each month in the year is identified separately (represented by numbers 1 through 12), and a value can be specified for each month. Valid values:

Table 170 MONTHS Parameter Values

General Information

The rule is scheduled for execution only during the months when a value of Y (Yes) is specified.

Parameter MONTHS cannot be used with parameter DATES.

When the MONTHS parameter is used, at least one of the following must be specified: DAYS, DCAL, WDAYS or WCAL.

Parameter MONTHS is ignored when periodic values are specified in the DAYS or WDAYS parameter.

Examples

ON Statement: Selection Parameter

Specification of selection criteria. The access of media that meet the selection criteria triggers the rule. Control-M/Tape can then perform DO actions on the media.

Figure 192 ON Parameter Format

Type a valid option (abbreviated V, D, J, A, US, P, ME, MG, or UC) in the ON field and press Enter. Specify subparameters for each option as prompted.

Table 171 ON Subparameters

ON DATASET=A.B.C

Examples

General Information

The ON statement specifies criteria for the triggering of the rule. When a data set or volume that meets these criteria is accessed, the rule is triggered, and actions (DO statements) specified in the rule, are performed.

ON MEDIA and ON VOLSER statements cannot be specified in either of the following cases:

• AT MOUNT is specified in a DO CONDITION, DO FORCEJOB, DO RESOURCE, DO SET or DO SHOUT statement in the rule.

• The volume specified in the ON statement was not defined in the Media Database when the current job started.

Within an ON block one, and only one, ON DATASET statement must be specified. Because no other ON DATASET statements are specified, Control-M/Tape automatically adds the ON DATASET=* expression to any ON block. All other media options (for example, VOLSER, MEDIA, and JOBNAME) can be specified an unlimited number of times.

Character masking is supported in all ON statements except ON MEDIA. For more information about masking, see Character Masking.

And/Or/Not Subparameter

This subparameter permits specification of multiple ON statements within one ON block (for specifying a combination of media selection criteria).

When specified, another ON line is opened for inputting selection criteria. The newly-opened line must be filled.

The ON block is considered satisfied, and the rule is activated, when a complete set of ON statements is satisfied according to Boolean logic:

Table 172 And/Or/Not subparameter values

Subparameter And/Or/Not uses standard Boolean relations. AND and NOT are applied before OR. NOT means AND NOT as represented below:

A AND B OR C NOT D

is interpreted as

[(A AND B) OR (C AND NOT D)]

Examples

RULE: STARTSTK LIB CTT.PROD.RULES                               TABLE: PRD0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   STARTSTK  GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION THIS RULE ENABLES STACKING FOR ALL DATA SETS.
 DESCRIPTION
 DOCMEM      STARTSTK  DOCLIB CTT.PROD.DOCS
===========================================================================
 DOC
===========================================================================
 ON DATASET   = *                                               And/Or/Not
===========================================================================
 DO STACK     = Y  (Y/N)
 DO
===========================================================================
===========================================================================
 DAYS    ALL                                                   DCAL
                                                                    AND/OR
 WDAYS                                                         WCAL
 MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
 DATES
 CONFCAL          SHIFT
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

RULE: TAPEUTIL LIB CTT.PROD.RULES                               TABLE: PRD0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   TAPEUTIL  GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION THIS RULE FORCES A CONTROL-M JOB WHICH REPORTS ON 3400 TAPE
 DESCRIPTION UTILIZATION.
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS
===========================================================================
 DOC
===========================================================================
 ON DATASET   = *                                               And/Or/Not A
 ON MEDIA     = 3400                                            And/Or/Not
===========================================================================
 DO FORCEJOB  = TABLE   CTMREPS      JOB REP3931              DATE  ODAT
                LIBRARY CTM.PROD.SCHEDULE
           AT   CLOSE
 DO CONDITION = CTM-JOB-REQUESTED    ODAT +
           AT   CLOSE
 DO SHOUT     = TO TSO-M38           URGENCY  R
    MESSAGE   REMINDER: INSERT REPORT INTO 3400 TAPE UTILIZATION LOG.
           AT   CLOSE
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

RULE: VAULTVOL LIB CTT.PROD.RULES                               TABLE: ACC0003
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   VAULTVOL  GROUP ACCOUNTING                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION THIS RULE VAULTS VOLUMES ACC001-ACC200 AT YEAR-END. THESE
 DESCRIPTION VOLUMES ARE RETAINED PERMANENTLY IN THE VAULT.
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS
===========================================================================
 DOC
===========================================================================
 ON DATASET   = ACC*                                            And/Or/Not A
 ON VOLSER    = ACC001 TO ACC200                                And/Or/Not
===========================================================================
 DO VAULT     = MAINLIB                     BY BOX N  (Y/N)
      UNTIL   = DATE           0101 YEAR 2000                   And/Or
    VAULT     = VLT-ACC
      UNTIL     PERMANENT                                       And/Or
    VAULT     =
 DO
===========================================================================
===========================================================================
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

RULE: BKPSAVE  LIB CTT.PROD.RULES                               TABLE: BKP0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   BKPSAVE   GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 03 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION SETS RETENTION AND ABEND-RETENTION PERIODS FOR BACKUP FILES
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS
===========================================================================
 DOC
===========================================================================
 ON DATASET   = BKP*                                            And/Or/Not A
 ON PGM       = BKP*                                            And/Or/Not A
 ON USERID    = ADMIN                                           And/Or/Not
===========================================================================
 DO RETENTION = DAYS              00365                         And/Or
 DO ABENDRET  = CYCLES             0001     PREFIX Y  (Y/N)     And/Or
 DO
===========================================================================
===========================================================================
 DAYS    ALL                                                   DCAL
 AND/OR
 WDAYS                                                         WCAL
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

OWNER: General Parameter

User ID of the user who created the rule. This parameter is used by the Control-M/Tape security mechanism and for documentation.

Figure 197 OWNER Parameter Format

Mandatory. The OWNER parameter must be 1 through 8 characters.

General Information

Upon initial entry into the Rule Definition screen, the OWNER field is set to the user’s logon ID.

Example

RULE: BKPSAVE  LIB CTT.PROD.RULES                               TABLE: BKP0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   BKPSAVE   GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 03 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION SETS RETENTION AND ABEND-RETENTION PERIODS FOR BACKUP FILES
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS
===========================================================================
 DOC
===========================================================================
 ON DATASET   = BKP*                                            And/Or/Not A
 ON PGM       = BKP*                                            And/Or/Not A
 ON USERID    = ADMIN                                           And/Or/Not
===========================================================================
 DO RETENTION = DAYS              00365                         And/Or
 DO ABENDRET  = CYCLES             0001     PREFIX Y  (Y/N)     And/Or
 DO
===========================================================================
===========================================================================
 DAYS    ALL                                                   DCAL
                                                                    AND/OR
 WDAYS                                                         WCAL
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT     15.49.41

RULE NAME: General Parameter

Name of the rule.

Figure 199 RULE NAME Parameter Format

Mandatory. Parameter RULE NAME specifies a valid rule name of 1 through 8 characters.

General Information

Parameter RULE NAME contains the name of the rule.

If this field is blank, specify the name of the new rule.

To modify the name of a rule, simply change the name as desired.

Example

RULE: BKPSAVE  LIB CTT.PROD.RULES                               TABLE: BKP0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   BKPSAVE   GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 03 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION SETS RETENTION AND ABEND-RETENTION PERIODS FOR BACKUP FILES
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS
===========================================================================
 DOC
===========================================================================
 ON DATASET   = BKP*                                            And/Or/Not A
 ON PGM       = BKP*                                            And/Or/Not A
 ON USERID    = ADMIN                                           And/Or/Not
===========================================================================
 DO RETENTION = DAYS              00365                         And/Or
 DO ABENDRET  = CYCLES             0001     PREFIX Y  (Y/N)     And/Or
 DO
 DATES
 CONFCAL          SHIFT
===========================================================================
===========================================================================
 DAYS    ALL                                                   DCAL
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

SEQUENCE PRIORITY: General Parameter

Internal Control-M/Tape rule scanning priority.

Figure 201 SEQUENCE PRIORITY Parameter Format

Parameter SEQUENCE PRIORITY must contain two alphanumeric characters or be blank.

Priority is determined in ascending order where blank<A<Z<0<9. Therefore, increasing priority order is: blank-AA-AZ-A0-A9-0A-0Z-00-09-9A-9Z-90-99.

The default SEQUENCE PRIORITY is blank (the lowest priority).

General Information

Sequence priority controls the order in which rules are scanned. When Control-M/Tape searches for a rule, the first rule that matches the selection criteria is activated. Therefore, the sort order of the rules in the currently active rule table is extremely important.

A Rule list is either sorted or unsorted, based on the value specified in the AUTOMATIC RULE SORTING field on the Rule Definition entry panel.

• If AUTOMATIC RULE SORTING is set to N (No), rules are listed in the order in which they were defined, and SEQUENCE PRIORITY has no effect on the order of the rules.

• If AUTOMATIC RULE SORTING is set to Y (Yes), rules are listed in Best Match order.

This order is described in Best Match Order. According to this order:

• The rule with the highest SEQUENCE PRIORITY is placed at the top of the list.
• The rule with the lowest SEQUENCE PRIORITY is placed at the bottom of the list.
• Rules with the same SEQUENCE PRIORITY are sorted according to their selection criteria.

Example

RULE: BKPSAVE  LIB CTT.PROD.RULES                               TABLE: BKP0002
COMMAND ===>                                                    SCROLL===> CRSR
-------------------------------------------------------------------------------
 RULE NAME   BKPSAVE   GROUP PRODUCTION                MODE PROD (Prod/Test)
 OWNER       M43A      SEQUENCE PRIORITY 03 CONTINUE SEARCH Y    (Y/N)
 DESCRIPTION SETS RETENTION AND ABEND-RETENTION PERIODS FOR BACKUP FILES
 DESCRIPTION
 DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOCS
===========================================================================
 DOC
===========================================================================
 ON DATASET   = BKP*                                            And/Or/Not A
 ON PGM       = BKP*                                            And/Or/Not A
 ON USERID    = ADMIN                                           And/Or/Not
===========================================================================
 DO RETENTION = DAYS              00365                         And/Or
 DO ABENDRET  = CYCLES             0001     PREFIX Y  (Y/N)     And/Or
 DO
 DATES
 CONFCAL          SHIFT
===========================================================================
===========================================================================
 DAYS    ALL                                                   DCAL
FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT     15.49.41

WDAYS: Basic Scheduling Parameter

Specifies days of the week on which the rule is scheduled.

See also DAYS and CONFCAL.

Figure 203 WDAYS Parameter Format

Optional. The WDAYS parameter specifies days of the week on which rules are scheduled, provided other scheduling criteria are met.

Values for WDAYS can be specified alone, or they can be specified together with a calendar specified in the WCAL subparameter. WDAYS/WCAL can also be specified together with DAYS/DCAL (described under DAYS in this chapter of the guide).

The WDAYS subparameters are described below:

Table 173 WDAYS Subparameters

Assuming all other basic scheduling criteria are met:

• When WDAYS are specified without WCAL, the rule is scheduled on the specified days of the week.

• When WCAL is specified without WDAYS, the rule is scheduled on the working days marked in the WCAL calendar.

• When WDAYS and WCAL are both specified, scheduling depends on the how the working days defined in the calendar, and the values and format of the WDAYS parameter combine (described below).

• When both DAYS and WDAYS criteria are specified, scheduling depends on the connecting AND/OR value specified. (For more information, see subparameter AND/OR in the DAYS parameter.)

Valid Formats for WDAYS

Valid formats for the WDAYS parameter, and how they relate to WCAL, are described below.

Non-periodic scheduling

The following rules govern the use of non-periodic scheduling formats:

• n is an integer from 0 to 6, where 1 is the first day of the week (Sunday or Monday, depending on the standards at your site) and 0 is the last day of the week (either Saturday or Sunday).

• Multiple values can be specified (separated by commas) in any order.

• If a calendar name is specified for WCAL, it should not designate a periodic calendar.

Table 174 Non-Periodic Scheduling Formats

Periodic scheduling

The following rules govern the use of periodic scheduling formats:

• n is any integer from 0 to 6, and i is any valid period identifier (or * for all periods).

• WDAYS period identifiers are counted on a week by week basis. Calculations do not cross week boundaries (unlike DAYS periodic identifiers that do cross month boundaries).

• The name of a periodic calendar must be specified in WCAL.

• A maximum of eight periodic values can be designated in any desired order.

Table 175 Periodic Scheduling Formats

General Information

Negative values take precedence over positive values when determining if a rule is scheduled on a certain date. If a negative value (meaning, format –n, –Dn, –Ln, –DnPi, or –LnPi) in either the DAYS or WDAYS field prevents a rule from being scheduled on a date, the rule is not scheduled on that date even if a positive value (for example, Ln) would otherwise result in the rule being scheduled on that date.

If periodic and non-periodic values are mixed when specifying parameter WDAYS, processing depends on the type of calendar specified in parameter WCAL.

• If a non-periodic calendar is specified in the WCAL parameter, only non-periodic values in the WDAYS parameter are processed; periodic values are ignored. In this case, negative periodic values (meaning, –DnPi, –LnPi) are also ignored and do not supersede other values.

• If a periodic calendar is specified in the WCAL parameter, all periodic values and the negative non-periodic value -n in the WDAYS parameter are processed; all nonnegative non-periodic values are ignored.

Parameter MONTHS is ignored when periodic values are specified in parameter WDAYS.

When Ln and/or Dn values are specified in a week that overlaps two months, it is the MONTHS value of the earlier month that determines whether Dn or Ln values are applied in the week.

• If the first day of the week falls in a month with a MONTHS value of Y, all Dn and Ln values in that week are applied, even those falling in the next or previous month when that month has a MONTHS value of N.

• If the first day of the week falls in a month with a MONTHS value of N, no Dn or Ln values in that week are applied (not even if those falling in the next or previous month when that month has a MONTHS value ofY).

Examples

The examples in this chapter are based on the following assumptions:

• The current month is December 2001.

• Working days are defined in calendar WORKDAYS that contains the following working days (indicated by Y) for December 2001:

---S-------------S-------------S-------------S-------------S---
 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 + 1
     Y Y Y Y Y     Y Y Y Y Y     Y Y Y Y Y     Y   Y Y Y     Y

• Periodic calendar PERIDAYS contains the following periodic definition for December2001. These examples assume that all other days of this calendar are blank.

---S-------------S-------------S-------------S-------------S---
 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 + 1
     B C A A B     B C A A B     B C A A B     B C A A B     B

• Start of the week is defined as Monday. Weeks start on the following dates in December2001: 3rd, 10th, 17th, 24th, and 31st.

At the end of each example, asterisks on a December 2001 calendar indicate the days on which the rule is scheduled.

WDAYS   - 0,1

WDAYS   - +6
WCAL    - WORKDAYS

WDAYS   - -5,<0
WCAL    - WORKDAYS

WDAYS   - D1W1

WDAYS   - -D1,-L1
WCAL    - WORKDAYS

WDAYS   - D1PA,-D2PB
WCAL    - PERIDAYS

DAYS    - 1
AND/OR  - OR
WDAYS   - 1

DAYS    - 3
AND/OR  - AND
WDAYS   - 1

DAYS    - L1,L2,L3,L4,L5,L6,L7
AND/OR  - AND
WDAYS   - 1

DAYS    - 1,7,15
AND/OR  - AND
WDAYS   - 6
CONFCAL - WORKDAYS
SHIFT   - >