Abort Flow Block
Stop the execution of the entire flow immediately, either successfully or with an error
Overview
The Abort Flow Block is used to stop the execution of the entire flow immediately. It can either “successfully” abort the flow (early-exit), or “error” abort the flow. This block is useful for stopping the flow under certain conditions or for handling errors.
Inputs
The message to abort the graph with. If provided as a string when error aborting, this will be used as the error message.
Whether to successfully abort the graph (early-exit), or error abort the graph. Only available when “Use Successfully Input” is enabled in settings.
Outputs
This block does not have any outputs.
Editor Settings
Whether to successfully abort the graph (early-exit), or error abort the graph. Can be overridden by the “successfully” input if “Use Successfully Input” is enabled.
When enabled, adds a “successfully” input port that can override the “Successfully Abort” setting.
The error message to use when error aborting (when not successfully aborting). Only used if no message is provided via the data input.
Example: Successfully aborting a flow
- Add an Abort Flow block to your flow.
- Make sure the “Successfully Abort” setting is checked.
- Connect any block to the
datainput of the Abort Flow block. - Run your flow. The flow will abort immediately after the Abort Flow block is processed.
Example: Aborting a flow with an error
- Add an Abort Flow block to your flow.
- Uncheck the “Successfully Abort” setting.
- Optionally, enter an error message in the “Error Message” setting.
- Connect any block to the
datainput of the Abort Flow block. - Run your flow. The flow will abort with an error message.
Error Handling
The Abort Flow Block does not produce any errors itself. However, it causes the entire flow to stop executing when it is processed, either successfully or with an error.
When error aborting, the error message is determined in this order:
- The trimmed string value from the
datainput, if provided - The “Error Message” setting value, if configured
- Default message: “Graph aborted with error”
Be cautious when using this block, as it will immediately stop the execution of your entire flow.
FAQ
What happens if I connect a non-string value to the `data` input?
What happens if I connect a non-string value to the `data` input?
When error aborting, non-string values will be ignored for the error message. The block will fall back to using the configured “Error Message” setting or the default error message.
What happens if I connect a block to the `successfully` input but 'Use Successfully Input' is disabled?
What happens if I connect a block to the `successfully` input but 'Use Successfully Input' is disabled?
The successfully input port won’t be available and the block will use the “Successfully Abort” setting value instead.
What happens if I don't connect anything to the `data` input or leave the 'Error Message' setting empty?
What happens if I don't connect anything to the `data` input or leave the 'Error Message' setting empty?
When error aborting, the flow will be aborted with the default error message “Graph aborted with error”.
See Also
Abort Flow Block
Stop the execution of the entire flow immediately, either successfully or with an error
Overview
The Abort Flow Block is used to stop the execution of the entire flow immediately. It can either “successfully” abort the flow (early-exit), or “error” abort the flow. This block is useful for stopping the flow under certain conditions or for handling errors.
Inputs
The message to abort the graph with. If provided as a string when error aborting, this will be used as the error message.
Whether to successfully abort the graph (early-exit), or error abort the graph. Only available when “Use Successfully Input” is enabled in settings.
Outputs
This block does not have any outputs.
Editor Settings
Whether to successfully abort the graph (early-exit), or error abort the graph. Can be overridden by the “successfully” input if “Use Successfully Input” is enabled.
When enabled, adds a “successfully” input port that can override the “Successfully Abort” setting.
The error message to use when error aborting (when not successfully aborting). Only used if no message is provided via the data input.
Example: Successfully aborting a flow
- Add an Abort Flow block to your flow.
- Make sure the “Successfully Abort” setting is checked.
- Connect any block to the
datainput of the Abort Flow block. - Run your flow. The flow will abort immediately after the Abort Flow block is processed.
Example: Aborting a flow with an error
- Add an Abort Flow block to your flow.
- Uncheck the “Successfully Abort” setting.
- Optionally, enter an error message in the “Error Message” setting.
- Connect any block to the
datainput of the Abort Flow block. - Run your flow. The flow will abort with an error message.
Error Handling
The Abort Flow Block does not produce any errors itself. However, it causes the entire flow to stop executing when it is processed, either successfully or with an error.
When error aborting, the error message is determined in this order:
- The trimmed string value from the
datainput, if provided - The “Error Message” setting value, if configured
- Default message: “Graph aborted with error”
Be cautious when using this block, as it will immediately stop the execution of your entire flow.
FAQ
What happens if I connect a non-string value to the `data` input?
What happens if I connect a non-string value to the `data` input?
When error aborting, non-string values will be ignored for the error message. The block will fall back to using the configured “Error Message” setting or the default error message.
What happens if I connect a block to the `successfully` input but 'Use Successfully Input' is disabled?
What happens if I connect a block to the `successfully` input but 'Use Successfully Input' is disabled?
The successfully input port won’t be available and the block will use the “Successfully Abort” setting value instead.
What happens if I don't connect anything to the `data` input or leave the 'Error Message' setting empty?
What happens if I don't connect anything to the `data` input or leave the 'Error Message' setting empty?
When error aborting, the flow will be aborted with the default error message “Graph aborted with error”.