AROPTS
Purpose
The AROPTS statement defines run-time options for automatic job and started-task recovery. It is used by a controller or standby controller where OPCOPTS RECOVERY(YES) is specified.
AROPTS is defined in the member of the EQQPARM library as specified by the ARPARM parameter on the OPCOPTS statement.
Format
>>-AROPTS--+---------------------------+------------------------> | .-JCLUSER---. | '-AUTHUSER(-+-GROUP-----+-)-' +-JCLEDITOR-+ '-OWNER-----' >--+-----------------------+--+---------------------+-----------> | .-NO--. | | .-2359-. | '-CHKRESTART(-+-YES-+-)-' '-ENDTIME(-+-hhmm-+-)-' >--+---------------------------+--------------------------------> | .-NOAR-----. | '-EXCLUDECC(-+---code---+-)-' >--+--------------------------------------------------+---------> | .-6-------------------------------. | '-EXCLUDERC(-+-highest no-recovery return code-+-)-' >--+--------------------------------------------+---------------> '-PREDWS(---predecessor workstation name---)-' >--+-----------------------+--+--------------------+----------->< | .-0000-. | | .-NO--. | '-STARTTIME(-+-hhmm-+-)-' '-USERREQ(-+-YES-+-)-'
Parameters
- AUTHUSER(GROUP|JCLEDITOR|OWNER|JCLUSER)
- Defines where Tivoli Workload Scheduler for z/OS should retrieve the name that is used for
authority checking in automatic recovery:
- GROUP
- The authority group ID of the failing occurrence.
- JCLEDITOR
- The name in the JCL repository (EQQJSnDS) file. If the JCL has not been updated through the dialogs or PIF, Tivoli Workload Scheduler for z/OS does not perform authority checking. The name in the ISPF statistics of the job library (EQQJBLIB) is not used.
- OWNER
- The owner ID of the failing occurrence. Owner ID is truncated if it is more than 8 characters.
- JCLUSER
- The name of the user who created or last updated the JCL. JCLUSER is the default value. If the JCL has not been updated through the dialogs or PIF, Tivoli Workload Scheduler for z/OS uses the name in the ISPF statistics of the job library (EQQJBLIB). If no statistics exist, Tivoli Workload Scheduler for z/OS does not perform authority checking.
- CHKRESTART(YES/NO)
- Usually the Automatic Recovery function postpones the recovery
actions, whenever cleanup type is Immediate, until any cleanup actions
have been successfully completed. This is done even if the recovery
actions do not require the operation to be restarted, for example
when ADDAPPL is the required recovery action. This is the default
behavior and corresponds to AROPTS CHKRESTART(NO).
If you want the postpone mechanism (wait for cleanup actions to complete) to occur only when recovery actions require a job or step restart, you must specify AROPTS CHKRESTART(YES). When AROPTS CHKRESTART(YES) is specified, and the recovery actions do not require a restart, the recovery actions are performed immediately and then the immediate cleanup actions start, but there is no waiting for their completion.
Cleanup types None and Immediate are compatible with Automatic Recovery in all scenarios. Cleanup types Manual and Automatic are only compatible with Automatic Recovery if AROPTS CHKRESTART(YES) is specified and the recovery actions do not require a job or step restart (recovery proceeds, in this case). If AROPTS CHKRESTART(NO) is specified, or the recovery actions require a job or step restart and the failing operation cleanup type is Manual or Automatic, the Automatic Recovery function issues an appropriate error message and stops processing the related operation.
- ENDTIME(hhmm|2359)
- Defines the end of the time range for which automatic recovery is performed for jobs and started tasks that contain a RECOVER statement without a TIME specification. This default end time-of-day is specified in the format hhmm, where hh is the hour in the range 00–23, and mm is the minute in the range 00–59.
- EXCLUDECC(code|NOAR)
- Defines an individual error code or a case code for which no automatic recovery is performed unless explicitly requested by a RECOVER statement in the failing job or started task. A case code is a group of abend and return codes. Case codes are defined in the EQQCASEM module using the EQQCASEC macro. The default case code is NOAR, which contains S122, S222, CAN, JCLI, JCL, and JCCE. For more information about case codes, see Creating case-code-definition modules.
- EXCLUDERC(highest no-recovery return code|6)
- Defines the maximum step-completion-code value for which no automatic recovery is performed unless explicitly requested by a RECOVER statement in the job or started task.
- PREDWS(predecessor workstation name)
- Defines a default predecessor workstation name that is used
by automatic recovery to create an external dependency when a predecessor
occurrence to a failing operation is added to the current plan. The
default is used if no specific predecessor operation is found. This
might occur, for example, if an operation has been deleted or a workstation
name has been changed. The highest operation number in the predecessor
occurrence with a workstation name that matches the PREDWS definition
is set up as the predecessor.
If PREDWS is not specified or if there is no match on the workstation name, the end point in the predecessor occurrence is used to establish the dependency. If the predecessor occurrence contains multiple end points, the end point with the highest operation number is used.
The workstation name can be specified generically.
- STARTTIME(hhmm|0000)
- Defines the start of the time range for which automatic recovery is performed for jobs and started tasks that contain a RECOVER statement without a TIME specification. The default start time-of-day is specified in the format hhmm, where hh is the hour in the range 00–23, and mm is the minute in the range 00–59.
- USERREQ(YES|NO)
- Defines if automatic recovery should be permitted to update
the current plan when no user ID can be established or when the user
ID is not known to the security product. The value that is specified
for AUTHUSER determines where Tivoli Workload Scheduler for z/OS attempts to retrieve a name for
authority checking.
Specify YES if a valid user ID is required. Specify NO if automatic recovery should be permitted to update the current plan, even though no user ID is available or the user ID is not known to the security product. NO is the default value.