Stop Workflow
The Stop Workflow component stops the current workflow execution when triggered, preventing any further processing in that execution. It allows users to control the workflow execution flow and stop processing when a specific condition is met or when continuing is no longer required.
Usage Note: Place this component at the point in the workflow where termination is required.
Parameters
| Parameter | Description |
|---|---|
| Input Text | Specifies an optional message explaining why the workflow is stopped or providing relevant status details. |
| Input | Specifies the data passed to the component as part of the stop operation. |
Outputs
| Output | Description |
|---|---|
| StopFlow_Status | Indicates whether the stop request was processed successfully. This status can be used to check the result of the stop operation. |
Behavior
a. Stops the workflow execution when the stop operation is triggered.
b. Accepts an optional message through Input Text.
c. Accepts input data through the Input parameter.
d. Returns the stop operation status through StopFlow_Status.
e. Prevents subsequent workflow steps from running when the workflow is terminated.
Stop Behavior with a Single Component
When a workflow contains a single Stop Workflow component, the behavior depends on when the stop request is initiated through Manager.
Before the component runs: The workflow stops.
While the component is running or after it has run: The workflow continues execution instead of stopping immediately at that component.
Stop Behavior with Multiple Components
When a workflow contains multiple Stop Workflow components, the workflow continues toward the next Stop Workflow component if the stop request is initiated while the current component is running or after it has run.
a. Before the first component runs: The workflow stops.
b. While the first component is running or after it has run: The workflow continues toward the next Stop Workflow component.
c. At subsequent Stop Workflow components: The same behavior applies. If the stop request is initiated while a component is running or after it has run, the workflow continues toward the next Stop Workflow component, if one exists.
Usage Scenario
Use the Stop Workflow component when a workflow needs to stop before completing its normal execution.
For example, if a validation step identifies invalid data, route the execution to the Stop Workflow component. The workflow stops when the stop request is processed before the component runs. If the request is initiated while the component is running or after it has run, execution continues according to the stop behavior described above.
Tool Mode
Tool Mode exposes the Stop Workflow component to an Agent through the supported action. The Agent can use the action to check whether a stop request has been initiated for the current job.
Available Output Actions
GET_VALIDATE_IS_STOP_FLOW_INITIATED: Checks whether a stop request has been initiated for the current job.
Configuration Steps
1. Enable Tool Mode in the component’s configuration panel.
2. Configure the required component parameters.
3. Make the component available to the Agent through the supported action.
4. Integrate the component into the Agent-driven workflow.
Note: The available action checks the stop-request status. Actual workflow termination behavior depends on the component’s runtime implementation.
