Summary of OCL instructions
The OCL instructions are specified in a data set referenced by the SYSIN DD card. For an example of an OCL job, the EQQYRJCL member of the EQQMISC data set, see Sample job and procedure.
Here is a brief description of the instructions:
- ADD
- Inserts applications or an application group into the scheduler current plan or into the long-term plan.
- ADDCOND
- Adds a condition definition to an operation in the scheduler current plan.
- ADDOP
- Inserts an operation into an occurrence in the current plan.
- ADDPRED
- Adds a predecessor dependency definition to an occurrence in the scheduler current plan.
- ADDRES
- Adds a special resource to an operation in the scheduler current plan.
- ADDSIMP
- Adds a single dependency definition to a condition in the scheduler current plan.
- ADOPSAI
- Specifies system automation information for the operation (command text, automated function, security element, and completion information).
- CALL
- Invokes a REXX procedure.
- CHGEXTNAME
- Defines or modifies the extended job information associated with the operations of an occurrence in the scheduler current plan. You can also use CHGEXTNAME to delete the extended job information associated with the operations of an occurrence in the scheduler current plan.
- CHGJOB
- Changes the jobname associated with the operations of an occurrence in the scheduler current plan.
- CHGOPSAI
- Defines or modifies the system automation information associated with the operations of an occurrence in the scheduler current plan. You can use CHGOPSAI also to delete the system automation information.
- CHKAPPL
- Verifies the presence of occurrences in the scheduler current plan; when keywords STATUS(E) and ALERT(YES) are set, it checks operations that ended in error and sends to TSO users a message containing the related error information.
- CHKDATE
- Checks the validity of an input date in the following formats: YYYY/MM/DD, YY/MM/DD, YYYYMMDD, YYMMDD, DD/MM/YYYY, DD/MM/YY, DDMMYYYY, DDMMYY, and assigns to variables values it derives from the input date.
- COMPL
- Completes occurrences or specific operations of the occurrences in the scheduler current plan.
- DEL
- Deletes an occurrence or an operation from the scheduler current plan or from the long-term plan.
- DELCOND
- Deletes a condition from an operation in the scheduler current plan.
- DELPRED
- Deletes a dependency definition from an occurrence in the scheduler current plan with a predecessor operation.
- DELRES
- Deletes a special resource from an operation in the scheduler current plan.
- DELSIMP
- Deletes a single dependency definition from a condition in the scheduler current plan.
- EXIT
- Sets the program exit return code.
- FORCE
- Forces the execution of the application.
- GOTO
- Moves to a point specified by a LABEL statement within the OCL program.
- HOLD
- Sets the operations of an occurrence to HOLD status.
- IF-THEN-ELSE
- Performs a relational test and, depending on the result, executes one of the following instructions: SET, UPD, SETUPD, GOTO, CALL, EXIT, CHKAPPL, ADD, ADDOP, DEL, COMPL, ADDPRED, DELPRED, ADDRES, DELRES, CHGJOB, JSUACT, OPSTAT, SRSTAT, WSSTAT, CHKDATE, RELSUCC, RELOP, FORCE, RELEASE, HOLD, NOP, UNNOP, MODOP, or IF-THEN-ELSE.
- JSUACT
- Activates or inactivates the job submission function in the z/OSĀ® environment, in the distributed environment, or in both environments.
- INIT
- Specifies the ID of the scheduler variable table in which the job variables are described and specifies the scheduler subsystem ID.
- KILLJOB
- Stops a job that is already running. Applies only to operations running on IBM Z Workload Scheduler Agents or on distributed workstations that are directly connected to the end-to-end server (OPCMASTER).
- KILLREC
- Stops a recovery job that is already running.
Applies only to
operations running on distributed workstations that are directly connected
to the end-to-end server (OPCMASTER).
This action can be taken only on recovery jobs that are in the EXECUTING status, so that their operation number is known. The application number is required (the operation number is optional, but if you do not specify it, all the operations in the application are killed) to identify the operation that is to be killed.
- LABEL
- Defines labels within the OCL program SYSIN.
- MODCOND
- Modifies the condition defined for an operation in the scheduler current plan.
- MODOP
- Modifies the operations details.
- NOP
- Removes an operation from the current plan. When a NOP operation is ready to be started, it is immediately set to C status.
- OPSTAT
- Changes the status of an operation in the scheduler current plan.
- PROMPTN
- Specifies that NO is the reply to a recovery prompt issued for an abended operation.
- PROMPTY
- Specifies that YES is the reply to a recovery prompt issued for an abended operation.
- RELEASE
- Releases the operations of an occurrence that are in HOLD status.
- RELOP
- Releases the internal successors of an operation.
- RELSUCC
- Releases the successors of the occurrence by deleting the external dependency definition.
- SET
- Sets a user variable.
- SETUPD
- Sets a user variable and updates its default value in an scheduler variable table. This instruction is equivalent to the SET and UPD instructions together.
- SRSTAT
- Modifies the availability status of a special resource.
- UNNOP
- Restores an operation from NOP status.
- UPD
- Updates the default value of a user variable in an scheduler variable table.
- WSSTAT
- Modifies the status of a workstation.
- WTO
- Displays messages on the system console and waits for a reply.
If
the OCL PARMLIB TSOCMD parameter is set to YES, you can also
specify a TSO command or a REXX expression other than those listed
here. For example:
DO X = 1 TO 3;,
SAY 'HELLO';,
END
Select;,
when var1 = 'OK' then ADD APPL(TEST01);,
when var1 = 'KO' then EXIT 16;,
otherwise nop;,
End
For punctuation rules, see Specifying OCL instructions.