abort
Aborts the execution of a job. This function is typically used inside a condition to deliberately end the job when that condition is true. It is the equivalent of a throw or raise function in a programming language. This function does not return a value.
| Note: | When the abort function is included in an Error/Success Handling block, this function causes the Error/Success block to restart and does not terminate the job. |
Parameters
Name | Type | Description |
|---|---|---|
Message | string | Mandatory string parameter. Specifies the message to output when aborting the job. |
Examples
In the job below, the abort function is used to finish the job with an error if the value of a checked list exceeds 10 items. If the number of items in the list is less than or equal to 10, the job writes the text The list has less than 10 items to a file on the local system.
