What is Workflow Flood Protection?
Workflow Flood Protection is a feature designed to prevent unintended workflow executions due to trigger misconfigurations or a sudden surge in events. When the system detects excessive executions, it automatically pauses (throttles) the workflow to protect against unintended consequences.
How It Works
When a workflow experiences excessive executions, it enters a Throttled
state. Notifications are sent to all Torii Admins with the Workflow take action scope via email, providing details such as the workflow name and the reason for throttling.
The workflows are also visually flagged with banners on the Workflows Page and the Workflow Details Page.
Administrators can review pending executions directly from the Workflow Details Page by clicking Review Executions.
Once the user clicks Review Executions, the following dialog box appears, allowing them to unthrottle the workflow after reviewing the pending records. Note that some types of triggers do not offer the ability to view pending records.
When the user clicks Unthrottle, the workflow will run on those entities, and the user will be able to see the workflow executions as usual. The workflow will then return to its normal state.
Managing Throttled Workflows
Once notified, administrators have two options to manage throttled workflows:
-
Unthrottle Workflow: Resume the workflow and process the pending executions by clicking the Unthrottle button in the review dialog.
-
Disable/Delete Workflow: Clear the pending executions and stop further processing by disabling or deleting the workflow.
All actions taken are logged in the audit trail, ensuring accountability and transparency. Logs include details such as who resumed the workflow and the actions performed.
FAQ
Q: What triggers Workflow Flood Protection?
A: The feature is activated when a workflow experiences excessive executions. This can be due to misconfigured triggers or a sudden spike in events.
Q: Can I customize the throttling threshold?
A: Not at this time. The threshold is fixed per trigger type, meaning different trigger types have different thresholds, but each type has a predefined limit to maintain consistency and system stability.
The limits are as follows:
- User Meets Criteria: 200
- Application Meets Criteria: 100
- Contract Meets Criteria: 100
- User Details Changed: 500
- Default: 300
Q: Will I lose data if my workflow is throttled?
A: Generally, no. Pending executions are held in the queue until you decide to process them or disable/delete the workflow. However, if the trigger has a date condition, some records may no longer meet the trigger criteria as time passes, potentially leading to data loss.
Q: Who receives email notifications when a workflow is throttled?
A: All Torii Admins with the Workflow take action scope will receive the notifications.