getProperties
Describes the getProperties Web service for HCL Workload Automation job streams.
- Description
- Use this service to display information about a job stream instance.
You must have list access to the job stream in the security file to run this service.
- Input parameters
-
- engineName
- Not used; set to null.
- jobStreamId
- The job stream identifier in the plan: either workstationName#jobStreamName(hhmm[ date]) or workstation#jobstream_id. See the HCL Workload Automation: User's Guide and Reference for details.
- Output
- The response getPropertiesResponse returns an array getPropertiesReturn containing the following information fields:
- jobStreamId
- The job stream instance identifier.
- jobStreamName
- The name of the job stream.
- aliasJobStreamName
- The job stream alias name.
- originalJobStreamName
- The name of the job stream as defined in the database.
- workstationName
- The name of the workstation associated with the job stream.
- status
- Can be one of the following:
- BLOCKED
- CANCELLED
- ERROR
- HELD
- READY
- RUNNING
- SUCCESSFUL
- UNDECIDED
- WAITING
- internalStatus
- Can be one of the following:
- ABEND
- ABENDP
- CANCP
- DONE
- ERROR
- EXEC
- EXTRN
- FAIL
- FENCE
- HOLD
- INTRO
- PEND
- READY
- RJOB
- SCHED
- SUCC
- SUCCP
- SUSP
- USER
- WAIT
- WAITD
- limit
- The job limit of the job stream.
- priority
- The execution priority defined for the job stream. Can be one (or a range of values) of the following:
- A number ranging from 0 to 99
- hi
- go
- numberOfJobs
- The number of jobs included in the job stream.
- canceled
- The job stream instance is in the cancelled status. Can be true or false.
- carriedForward
- The job stream instance was carried forward. Can be true or false.
- carryForward
- The job stream was scheduled with the carryforward option. Can be true or false.
- external
- The job stream is a predecessor to another job stream or to one of its jobs located in another HCL Workload Automation network. Can be true or false.
- lateJobStream
- The job stream instance passed its completion deadline. Can be true or false.
- pendingCancellation
- The job stream is pending cancellation. Cancellation is deferred until all of the dependencies, including an at time, are resolved. Can be true or false.
- released
- The job stream was released from its dependencies. Can be true or false.
- startTime
- The start time defined for the job stream in YYYYMMDD HHMM format or milliseconds.
- lateststartTime
- The value of the until restriction of the job stream in YYYYMMDD HHMM format or milliseconds.
- lateststartAction
- The action taken after the until restriction time elapsed. Can be CANCEL, CONTINUE, or SUPPRESS.
- deadlineTime
- The value of the deadline restriction of the job stream instance in YYYYMMDD HHMM format or milliseconds.
If the service did not run successfully, getPropertiesResponse returns one of the errors described in Managing errors.