Halt Execution¶
Stops the current workflow on demand or based on a condition. It acts as a passthrough until triggered, then either cancels the entire run or blocks any downstream nodes connected after it. Optionally emits an alert when the halt occurs.
Usage¶
Insert this node mid-flow where you want the option to stop further processing. Feed your ongoing data into the Input so it can pass through when not halting. Use the 'method' to choose between fully canceling the run or only blocking subsequent nodes connected after this node. Combine with conditional logic (e.g., toggling 'disable' via another node) to halt only under specific conditions. Use 'run_after' to enforce execution order relative to another node.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| disable | True | BOOLEAN | When True, halting is disabled and execution continues. When False, the node can halt the run according to the selected method. | False |
| method | True | BOOLEAN | Selects the halt behavior: False = Cancel Prompt (interrupts the entire run immediately), True = Block Execution (prevents nodes that follow this one from running, while allowing other branches to continue). | False |
| alert_on_trigger | True | BOOLEAN | If True, emits an alert/error when the node halts execution to make the stop explicit. | True |
| input | True | ANY | The data stream to pass through this node. When halting is not triggered, this value is forwarded unchanged. | Any value or structure (e.g., an image object, text, or dict) |
| run_after | False | ANY | Optional dependency-only input. Connect the output of a node here to ensure this node executes after that node completes (ordering aid; the value is not used). | Output from a prior node to enforce order |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| * | ANY | Passes through the input data when not halting. When halting, returns a signal or empty value depending on the chosen method, preventing downstream processing. | Same value as 'input' if not halted; otherwise a stop/block signal or null-equivalent |
Important Notes¶
- Passthrough behavior: When halting is disabled or not triggered, the node returns exactly what it receives in 'input'.
- Two halt modes: Cancel Prompt (False) stops the entire run immediately. Block Execution (True) prevents only downstream nodes connected after this node from running.
- Alert option: Enabling 'alert_on_trigger' will surface a clear alert/error when a halt occurs, helping diagnose why/where the stop happened.
- Ordering aid: The 'run_after' input is only for execution order control and does not affect the data flowing through.
- Conditional control: Convert or drive 'disable' from other logic to create conditional halts (e.g., stop on validation failure).
Troubleshooting¶
- The node doesn't halt when expected: Ensure 'disable' is set to False and 'input' is not empty/null. Verify that your condition logic actually sends False into 'disable' when the halt should occur.
- Downstream nodes still run after Block Execution: Confirm those nodes are directly or indirectly dependent on this node’s output. If they are not connected after this node, they may continue in parallel.
- Entire run stops unexpectedly: Check if 'method' is set to Cancel Prompt (False) and whether 'alert_on_trigger' is enabled, which will surface an alert/error.
- Node executes too early or late: Use the 'run_after' input to enforce ordering by connecting it to the node that must complete before this one runs.
- No output when not halting: Verify the upstream 'input' value is present and valid; the node forwards the 'input' unchanged when halting is not triggered.