Previous Topic: Additional Variable OutputNext Topic: ELEMNAME Argument

OPS/REXX Built-in Functions › OPSARM Function › Function Argument

Function Argument

The function argument describes the ARM service to be performed. The typical sequence of ARM functions is as follows:

  1. Issues a REGISTER request when the job or task starts. You must provide a sysplex-unique element name.
  2. If the register request indicates that an ARM restart is being performed, issues a WAITPRED request to ensure that it restarted properly, in accordance with the ARM policy in the couple data set.
  3. Issues a READY request when the job or task is fully operational.
  4. Issues a DEREGISTER request when the job or task terminates as usual and no automatic restart is desired.

The following lists the ARM functions and provides an explanation for each:

REGISTER

This request causes the current job or task to be placed under ARM control for automatic restart if the job or task ends without issuing a DEREGISTER request. Supply the element name argument. All other arguments are optional.

arc = OPSARM('REGISTER','IDMSONSYS1',,'ELEMTERM')
WAITPRED

Issue this function during an automatic restart if this element depends on a predecessor element in the ARM policy definition. The job or task waits for the predecessor elements to issue their READY requests or for the policy wait time limit to be exceeded. No other arguments beyond the function may be specified. The exception is the addition of the token for an abstract element.

arc = OPSARM('WAITPRED'{,opsrmtoken})
READY

Indicates that job or task is fully initialized and ready to process work. This function primarily applies to transaction processing tasks such as CICS. The exception is the addition of the token for an abstract element.

arc = OPSARM('READY'{,opsrmtoken})
DEREGISTER

Terminates ARM control of the job or task. No automatic restart is performed once the job or task deregisters. No other arguments beyond the function may be specified. The exception is the addition of the token for an abstract element.

arc = OPSARM('DEREGISTER'{,opsrmtoken})
ASSOCIATE

This function is provided for a backup job or task such as an XRF task to override the automatic restart of a currently registered element. The task that initially registered the element name is not restarted until the task that issues the associate request deregisters itself. No other arguments beyond the element name may be specified. The exception is the addition of the token for an abstract element.

arc = OPSARM('ASSOCIATE'{,opsrmtoken})