Coding Each AOF Rule Type › Time-of-Day Rules › AOF Variables Available in a TOD Rule

AOF Variables Available in a TOD Rule

You can use all AOF variable types in TOD rules, as described in the chapter “AOF Rule Tools.” You can use the following unique AOF event variables in the )PROC section of a TOD rule, and you can manually interrogate the corresponding OPSLOG display field as an aid in debugging or implementing rule logic.

TOD.CATCHUP

A value indicating whether a TOD rule is executing as usual or in catch-up mode

Data Type: Character, read-only

Possible Values:

• Y-The rule is executing in catch-up mode
• N-The rule is executing as usual

Sample Value: Y

Notes:

• The TOD.CATCHUP variable is similar to the Automate &CATCHUP environmental variable.
• A rule is executing in catch-up mode when it first executes at CA OPS/MVS initialization and either:
  • The value of the catchup optional TOD qualifier is CATCHUPYES.
  • The value of the catchup optional TOD qualifier is CATCHUPMAN, and the reply of the operator to the WTOR concerning CATCHUPMAN rules is YES.

TOD.FIREMISSED

The TOD.FIREMISSED variable contains 5 pieces, or words, of information. The information in these words depends on whether the rule that is currently executing is executing as a result of catch-up processing:

• If the rule is executing as a result of catch-up processing, TOD.FIREMISSED contains information about the last time the rule should have executed but did not.
• If the rule is not executing as a result of catch-up processing, TOD.FIREMISSED contains information about the current execution of the rule.

Data Type: Character, read-only

Possible Values: This list explains the contents of the 5 words:

• Word 1-If the rule is executing in catch-up mode, this is the date when the rule was last scheduled to execute but did not, in the form yyyy/mm/dd. If the rule is not executing in catch-up mode, this is the current date, in the format yyyy/mm/dd.
• Word 2-If the rule is executing in catch-up mode, this is the time when the rule was last scheduled to execute but did not, in the form hh:mm:ss. If the rule is not executing in catch-up mode, this is the current time, in the format hh:mm:ss.
• Word 3-If the rule is executing in catch-up mode, this is the date when the rule was last scheduled to execute but did not, in Julian format: yyyyddd. If the rule is not executing in catch-up mode, this is the current date, in Julian format: yyyyddd.
• Word 4-If the rule is executing in catch-up mode, this is the time, calculated as seconds since January 1, 1980 (the date when IBM introduced the PC), when the rule was last scheduled to execute but did not. If the rule is not executing in catch-up mode, this is the current time, calculated as seconds since January 1, 1980.
• Word 5-If the rule is executing in catch-up mode, this is the day of the week (SUN, MON, TUE, WED, THU, FRI, SAT) when the rule was last scheduled to execute but did not. If the rule is not executing in catch-up mode, this is the current day of the week.

Sample Value: 2002/08/25 14:29:00 2002237 493828140 FRI

Note: The TOD.FIREMISSED variable was developed to support the Automate &CDATE, &CDAY, &CTIME, &CJULDATE, and &CCLOCK environmental variables.

TOD.NEXTFIRE

A value indicating the next time a rule will execute

Data Type: Character, read-only

Possible Values:

• The date and time the rule will execute, in yyyy/mm/dd hh:mm:ss format
• NONE if the rule will not execute again

Sample Value: 2002/08/25 14:30:00

Note: The next execute date in automateable message OPS3900O is in the yyyy/mm/dd format. For example:

OPS3900O RULE O.TODTEST FOR TOD 2002/08/25 14:30 SET

TOD.USER

An 8-byte variable providing communication between rules that execute for the same TOD event. The variable can contain any installation data that these rules need, and it can store a character string displayable through OPSLOG Browse.

Data Type: User-defined, read/write

Notes:

• Before AOF processing, this variable is initialized to binary zeros.
• The CA OPS/MVS Test Facility shows TOD events both before and after AOF processing.
• OPSLOG Browse does not show TOD events unless one of these conditions is true:
  • The CA OPS/MVS BROWSETOD parameter is set to YES, allowing the event to appear in OPSLOG Browse before AOF processing.
  • The CA OPS/MVS RULETRACE parameter is set to ON, allowing the event to appear in OPSLOG Browse after AOF processing.

For descriptions of the BROWSETOD and RULETRACE parameters, see the Parameter Reference.

OPSLOG Browse Column: USER