Time-of-day (TOD) events

Edit online

A time-of-day event occurs when the z/OS® timer that is associated with a rule expires.

To specify the header statement, use the following syntax:
/*TOD todspec, interval, endspec, maxexecs
where:
  • todspec is the date or time. You must specify either todspec or interval. Use one of the following formats to specify todspec:

    • ddMMMyyyy, where dd is a 2-digit integer (01 - 31) that represents the day of the month; MMM is a 3-character abbreviation for the month (JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DEC); and yyyy is a 4-digit year.

    • yymmday, where yy is a 2-digit year; mm is a 2-digit month; and day is the full name of a day of the week, for example, SUNDAY or MONDAY.

    • hh:mm:ss, where hhis a 2-digit integer (00 - 23) for the hour; mmis a 2-digit integer (00 - 59) for the minute; and ss is a 2-digit integer (00 - 59) for the seconds after the minute. The ss value is optional.

  • interval is the amount of time to wait before running the rule again. You must specify either todspec or interval. Use the following format to specify the interval:

    • n units, where n is an integer that represents the number of times to run the rule, and units is the time to wait before running the rule again. For units, specify one of the following: DAY, DAYS, WEEK, WEEKS, HOUR, HOURS, MINUTE, MINUTES, SECOND, SECONDS.

  • endspec is the time or date after which the rule stops running. This parameter is optional.

  • maxexecs is an integer that represents the maximum number of times to run the rule. This parameter is optional.

Note: If you omit any parameter, code a comma in its place.

The value that is returned from a TOD rule has no special meaning.

When a TOD event occurs, the system extracts information about the event and creates the following variables. These variables are instantiated when the rule is scheduled for execution.
Criterion Variable Contents Data type
ALL TOD.NEXTFIRE A value that indicates the next time that the rule runs. The following are valid values:

  • The date and time in yyyy/mm/dd hh:mm:ss format.

  • NONE if the rule will not run again.

 Character, read-only
ALL TOD.USER An 8-byte field for passing information among multiple rules. This field is initialized to binary zeroes. Character, read-write