ADRUN – Run cycle

Table 1. Keywords for ADRUN
Keyword	Description
`SEQ`	When using `OPTIONS DBMODE(UPDATE)`, the SEQ keyword can be used to identify a specific run cycle. The value must be the numeric sequence number of the run cycle. Note: This must be the sequence as shown by Workload Automation Programming Language when the application is output. Do not rely on the sequence as displayed through the dialogs, because you may have sorted the display.
`NAME`	For rule-based run cycles, this is the name of the rule (up to 8 characters) and unique for this application. Specify `NAME`, and type `R` or `E`, if you are creating a rule-based run cycle.
`PERIOD`	For offset-based run cycles, this is the name of a cyclic or noncyclic period defined in the calendar database, or a run cycle group. Specify `PERIOD`, and type `N` or `X`, if you are creating an offset-based run cycle.
`JCLVTAB`	Specifies the JCL variable table to be used for the occurrences generated by this run cycle. For offset-based run cycles, this JCL variable table overrides the one specified for the period. For rule-based run cycles, specify the JCL variable table here, because HCL Workload Automation for Z ignores any JCL variable table associated with the period. The first character must be alphabetic, up to 16 characters. Formerly `ADRJTAB` with EQQYLTOP.
`DESCR`	A free-format description of the run cycle, up to 50 characters
`DLDAY`	Specifies the number of days from the input arrival day that the application should be completed in: 0 means that the deadline is on the same day as the input arrival day. This must be an integer.
`DLTIME`	Specifies the time on the deadline day that the application should be completed by, in the format `hhmm`.
`EIADAYS`	Depending on the `TYPE` keyword, this keyword specifies one or more days relative to the start of the period when the application should be scheduled (`TYPE(N)`) or when it should not be scheduled (`TYPE(X)`). The numbers count from the end of the period; 1 is the last day.
`IADAYS`	Depending on the `TYPE` keyword, this keyword specifies one or more days relative to the start of the period when the application should be scheduled (`TYPE(N)`) or when it should not be scheduled (`TYPE(X)`). The numbers count from the start of the period; 1 is the first day.
`IATIME`	Specifies the time, in the format `hhmm`, that the application is to arrive at the first workstation.
`RPTEND`	Specifies the repeat end time for the EVERY options, in the format `hhmm`. It must be a time between the IA time of the run cycle and the calendar work day end time of the application.
`RPTEVRY`	Specifies the repeating frequency for the EVERY options, in the format `hhmm`. It specifies that the application has an occurrence in the long-term plan every `hhmm`, starting from the IA time to the repeat end time (`RPTENDT` keyword). If this keyword is not set, only the occurrence related to the IA time is added to the long-term plan.
`RULE`	Defines which free-day rule is in effect: `E` Count only work days when using the rule or offset. That is, free days are excluded. This option ensures that the scheduled day will always be a work day. This is the default for offset-based run cycles. `1` Count work days and free days when using the rule or offset. If this gives a free day, schedule the application on the closest work day before the free day. `2` Count work days and free days when using the rule or offset. If this gives a free day, schedule the application on the closest work day after the free day. `3` Count work days and free days when using the rule or offset. If this gives a free day, schedule the application on the free day. This is the default for rule-based run cycles. `4` Count work days and free days when using the rule or offset. If this gives a free day, do not schedule the application at all.
`SHIFT`	The number of days to shift the rule dates. This field is optional. It provides the means to define a run cycle relative to another, where the run cycle without the shifting offset is used to schedule an application in relation to which, using the same rule with a negative or positive shift of days, another application is scheduled. By default, the value is considered positive, and will make the new date be after the original run cycle group. Prefix the number with the minus sign (-) to shift the date before the run cycle group. Note: The `SHSIGN` keyword is supported, but not necessary for Workload Automation Programming Language, because + and – can be used within `SHIFT`. The `SHIFT` keyword is available only starting from HCL Workload Automation for Z V9.1, or later.
`SHTYPE`	Defines the type of days that are to be counted for the shift. `W` implies work days, while `D` implies any day in the calendar. This keyword is required if you used `SHIFT`. Note: The `SHTYPE` keyword is available only starting from HCL Workload Automation for Z V9.1, or later.
`TYPE`	Specify `R` (Regular) or `E` (Exclusion) without `IADAYS` or `EIADAYS` when you create a rule-based run cycle. You must specify the `NAME` keyword, and an `ADRULE` statement must follow this `ADRUN` statement. `R` means that the `ADRULE` statement specifies days when the application should be scheduled. `E` means that the `ADRULE` statement specifies days when the application should not be scheduled. Specify `N` (Normal) or `X` (Negative) together with `IADAYS` or `EIADAYS` when you create an offset-based run cycle. You must specify the `PERIOD` keyword. `N` means that the `IADAYS` and `EIADAYS` parameters define days when the application should be scheduled. `X` means that the `IADAYS` and `EIADAYS` parameters define days when the application should not be scheduled.
`VALFROM`	The start date of validity of this run cycle, in the format `yymmdd`. See the note described for `VALTO`.
`VALTO`	The end date of validity of this run cycle, in the format `yymmdd`. Note: HCL Workload Automation for Z interprets the `yy` part in the `VALTO` and `VALFROM` keywords as follows: `YY Year 72 - 99 1972 - 1999 00 - 71 2000 – 2071` Note: `VALTO` specifies the last day when the run cycle is valid. This is not the same as displayed in the ISPF panels, which uses “Out of effect” date that shows the first date when the run cycle is no longer valid. The “Out of effect” date is the day after the `VALTO` date, with the exception of the use of `HIGHDATE` (711231) as `VALTO`, which will show the same in the ISPF panels.

SEQ

When using OPTIONS DBMODE(UPDATE), the SEQ keyword can be used to identify a specific run cycle. The value must be the numeric sequence number of the run cycle.

Note: This must be the sequence as shown by Workload Automation Programming Language when the application is output. Do not rely on the sequence as displayed through the dialogs, because you may have sorted the display.

NAME

For rule-based run cycles, this is the name of the rule (up to 8 characters) and unique for this application. Specify NAME, and type R or E, if you are creating a rule-based run cycle.

PERIOD

For offset-based run cycles, this is the name of a cyclic or noncyclic period defined in the calendar database, or a run cycle group. Specify PERIOD, and type N or X, if you are creating an offset-based run cycle.

JCLVTAB

Specifies the JCL variable table to be used for the occurrences generated by this run cycle. For offset-based run cycles, this JCL variable table overrides the one specified for the period. For rule-based run cycles, specify the JCL variable table here, because HCL Workload Automation for Z ignores any JCL variable table associated with the period. The first character must be alphabetic, up to 16 characters.

Formerly ADRJTAB with EQQYLTOP.

DESCR

A free-format description of the run cycle, up to 50 characters

DLDAY

Specifies the number of days from the input arrival day that the application should be completed in: 0 means that the deadline is on the same day as the input arrival day. This must be an integer.

DLTIME

Specifies the time on the deadline day that the application should be completed by, in the format hhmm.

EIADAYS

Depending on the TYPE keyword, this keyword specifies one or more days relative to the start of the period when the application should be scheduled (TYPE(N)) or when it should not be scheduled (TYPE(X)). The numbers count from the end of the period; 1 is the last day.

IADAYS

Depending on the TYPE keyword, this keyword specifies one or more days relative to the start of the period when the application should be scheduled (TYPE(N)) or when it should not be scheduled (TYPE(X)). The numbers count from the start of the period; 1 is the first day.

IATIME

Specifies the time, in the format hhmm, that the application is to arrive at the first workstation.

RPTEND

Specifies the repeat end time for the EVERY options, in the format hhmm. It must be a time between the IA time of the run cycle and the calendar work day end time of the application.

RPTEVRY

Specifies the repeating frequency for the EVERY options, in the format hhmm. It specifies that the application has an occurrence in the long-term plan every hhmm, starting from the IA time to the repeat end time (RPTENDT keyword). If this keyword is not set, only the occurrence related to the IA time is added to the long-term plan.

RULE

Defines which free-day rule is in effect:

E: Count only work days when using the rule or offset. That is, free days are excluded. This option ensures that the scheduled day will always be a work day. This is the default for offset-based run cycles.
1: Count work days and free days when using the rule or offset. If this gives a free day, schedule the application on the closest work day before the free day.
2: Count work days and free days when using the rule or offset. If this gives a free day, schedule the application on the closest work day after the free day.
3: Count work days and free days when using the rule or offset. If this gives a free day, schedule the application on the free day. This is the default for rule-based run cycles.
4: Count work days and free days when using the rule or offset. If this gives a free day, do not schedule the application at all.

SHIFT

The number of days to shift the rule dates. This field is optional. It provides the means to define a run cycle relative to another, where the run cycle without the shifting offset is used to schedule an application in relation to which, using the same rule with a negative or positive shift of days, another application is scheduled.

By default, the value is considered positive, and will make the new date be after the original run cycle group. Prefix the number with the minus sign (-) to shift the date before the run cycle group.

Note:

The SHSIGN keyword is supported, but not necessary for Workload Automation Programming Language, because + and – can be used within SHIFT.
The SHIFT keyword is available only starting from HCL Workload Automation for Z V9.1, or later.

SHTYPE

Defines the type of days that are to be counted for the shift. W implies work days, while D implies any day in the calendar. This keyword is required if you used SHIFT.

Note: The SHTYPE keyword is available only starting from HCL Workload Automation for Z V9.1, or later.

TYPE

Specify R (Regular) or E (Exclusion) without IADAYS or EIADAYS when you create a rule-based run cycle. You must specify the NAME keyword, and an ADRULE statement must follow this ADRUN statement. R means that the ADRULE statement specifies days when the application should be scheduled. E means that the ADRULE statement specifies days when the application should not be scheduled.

Specify N (Normal) or X (Negative) together with IADAYS or EIADAYS when you create an offset-based run cycle. You must specify the PERIOD keyword. N means that the IADAYS and EIADAYS parameters define days when the application should be scheduled. X means that the IADAYS and EIADAYS parameters define days when the application should not be scheduled.

VALFROM

The start date of validity of this run cycle, in the format yymmdd. See the note described for VALTO.

VALTO

The end date of validity of this run cycle, in the format yymmdd.

Note: HCL Workload Automation for Z interprets the yy part in the VALTO and VALFROM keywords as follows:

YY Year 
72 - 99 1972 - 1999 
00 - 71 2000 – 2071

Note: VALTO specifies the last day when the run cycle is valid. This is not the same as displayed in the ISPF panels, which uses “Out of effect” date that shows the first date when the run cycle is no longer valid. The “Out of effect” date is the day after the VALTO date, with the exception of the use of HIGHDATE (711231) as VALTO, which will show the same in the ISPF panels.