HCL Workload Automation, Version 9.4

getProperties (z/OS®)

Describes the getProperties Web service for IBM Workload Scheduler for z/OS operations.

Description
Use this service to display information about an operation.
Input parameters
engineName
The name of the IBM Workload Scheduler for z/OS controller.
jobId
The operation identifier in the current plan. Note that the plan object identifiers returned contain the '\0' character. This is not a valid character and must be replaced by a blank.
Output
The response getPropertiesResponse returns an array getPropertiesReturn containing the following information fields:
occurrenceToken
The identifier of the occurrence that includes the operation.
extendedStatus
The extended status code assigned to the operation.
errorCode
The error code that terminated the operation.
operationCommand
Can be one of the following: BD = Bind shadow; job EX = Execute operation; KJ = Kill operation; KR = Kill recovery job; MH = Hold operation; MR = Release operation; NP = NOP operation; PN = Prompt reply no; PY = Prompt reply yes; UN = Un-NOP operation.
authorityGroup
The name of the authority group that the operation belongs to.
cleanUpStatus
Can be one of the following: Blank=none C=Completed E=Ended in error I=Initiated O=Avail opinfo R=Request opinfo S=Started W=Waiting opinfo
latestOutPassed
The operation exceeded its latest starting time and is late. Can be true or false.
latestOut
The latest possible time, calculated at plan-creation-time, that the operation can start to meet the deadline time (HHMM).
actualArrival
The actual run time of the operation (HHMM).
actualEnd
The time the operation is reported as complete or ended-in-error (HHMM).

If the service did not run successfully, getPropertiesResponse returns one of the errors described in Managing errors.