Abort workflow

Description

The Abort workflow action immediately stops (aborts) a running workflow.

Use the abort action if you want to explicitly terminate a workflow and mark it as failed with an (optional) error message.

The workflow is always marked as failed, whatever the action before the abort returned. A parent workflow calling this workflow will follow its failure hop.

Options

Option Description

Option	Description
Action name	The name of the workflow action. This name has to be unique in a single workflow. A workflow action can be placed several times on the canvas, however it will be the same workflow action.
Message	Message to add in log when aborting
Log level of the message	The log level to write the message with, `Error` by default. Lower the log level if you don’t want the message to show up as an error in the log. This only changes the logging: the workflow is marked as failed either way.

Action name

The name of the workflow action. This name has to be unique in a single workflow. A workflow action can be placed several times on the canvas, however it will be the same workflow action.

Message

Message to add in log when aborting

Log level of the message

The log level to write the message with, Error by default. Lower the log level if you don’t want the message to show up as an error in the log. This only changes the logging: the workflow is marked as failed either way.

Result

What this action passes on to the next action. See Action results for how results travel through a workflow.

Result	Value
False	Always, with 1 error. The workflow stops: no hop from the action is followed, not even an unconditional one, and the workflow ends as failed (hop-run ends with exit code 1).
Result files	No action in this workflow receives them, as the workflow stops. A parent workflow that runs this workflow with a Workflow action receives the result files of the actions before the Abort.
Result rows	As for the result files: a parent workflow receives the result rows of the actions before the Abort.

Result

Value

False

Always, with 1 error. The workflow stops: no hop from the action is followed, not even an unconditional one, and the workflow ends as failed (hop-run ends with exit code 1).

Result files

No action in this workflow receives them, as the workflow stops. A parent workflow that runs this workflow with a Workflow action receives the result files of the actions before the Abort.

Result rows

As for the result files: a parent workflow receives the result rows of the actions before the Abort.