setProperties
Describes the setProperties Web service for HCL Workload Automation job streams.
- Description
- Use this service to define additional properties for a job stream in the plan.
You must have submit 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.
- properties
- An array containing the properties you want to set. The properties can be:
- limit
- The number of jobs in the job stream that can run simultaneously on the same workstation.
- priority
- The execution priority. Can be one (or a range of values) of the following:
- A number ranging from 0 to 99
- hi
- go
- isCarryForward
- The value is either true or false.
- isMonitored
- The job stream is monitored. The value is either true or false.
- startTime
- The time when the job stream must start in YYYYMMDD HHMM format or milliseconds.
- lateststartTime
- The latest time when the job stream must start in YYYYMMDD HHMM format or milliseconds.
- lateststartAction
- The action that will be taken if the job stream exceeds its latest start time. Can be CANCEL, CONTINUE, or SUPPRESS.
- deadlineTime
- The time within which the job stream must complete in YYYYMMDD HHMM format or milliseconds.
- Output
- If the service ran successfully, the response setPropertiesResponse returns the identifier of the modified job stream; otherwise, it returns one of the errors described in Managing errors.