HCL Workload Automation, Version 9.4

cancel

Describes the cancel Web service for HCL Workload Automation job streams.

Description
Use this service to cancel a job stream.

If you cancel the job stream before it is started, it does not start. If you cancel it after it was started, the jobs that have started complete, but no other jobs are launched.

You must have cancel 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.
isPending
The value can be true or false. True cancels the job stream only after its dependencies are resolved. False cancels the job stream immediately (and any jobs and job streams that are dependent on the cancelled job stream are released immediately from the dependency).
Output
The response cancelResponse is void if the service ran successfully; otherwise, it returns one of the errors described in Managing errors.