Workflow Automation
Purpose: Manage published workflows and recover interrupted executions without repeating completed work unnecessarily.
What You Can Do Here
- Save Draft: Save an unpublished version while the currently published workflow continues receiving events.
- Publish: Validate and publish the intended version. Executions already in progress retain their pinned version.
- Run Published: Start the displayed published version. Drafts, unsaved edits, and inactive workflows cannot run from the designer.
- Run & Inspect: Start a real execution and open its details. This is not a simulation; actions can affect live services.
- Cancel: Stop future steps. Cancellation cannot undo an external action that already completed.
Recovery and Operator Review
- Pending work: Missing jobs are reconciled automatically after a one-minute grace period, in bounded passes every 30 seconds. Original delay deadlines and retry backoff are preserved.
- Interrupted action: A failed execution with error
Engine.InterruptedActionhas an unknown external outcome. Verify whether the email, webhook, or remote update already completed before retrying or replaying. - Capacity pressure: Events remain available for retry until the workflow can accept them. Permanently oversized events are preserved in
automation-rejected-events.dlqfor technical review. - Version changed: Refresh the designer after another administrator publishes a different version; a stale run request is rejected.
- Remote retries: External operations are not guaranteed exactly once. Prefer idempotent actions and verify outcomes before manual replay.
Switch Branches
- Add a Switch: Choose Switch from Flow Control in a form workflow or the global workflow designer, then select the field to compare.
- Configure cases: Give each case a clear name, select its comparison, and enter a value. Missing/null or empty-field comparisons do not need a value. A switch supports up to 20 cases.
- Set priority: Use the arrow controls to reorder cases. The first matching case wins; later cases do not run even if they also match.
- Connect outputs: Connect each named output and Default. Default runs when no case matches. Global switches accept one connection per output; connect subsequent actions in that branch.
- Edit safely: Renaming and reordering preserve connections. Removing a case removes its connections. Save the draft and validate before publishing; published versions remain unchanged until publication.
Publication Snapshot Safety
- Save and publish: The displayed graph is validated before a new publication draft is created. Invalid results appear in Validation Results instead of publication confirmation.
- Newer edits: Changes made while saving or validating remain unsaved. Validate and save again before publishing them. A successful publication does not close the editor when newer changes exist.
- Refresh: Background refreshes of the same immutable version preserve local edits. Run and Inspect still execute only the clean displayed publication, not an unsaved draft.
Data and Durable Control Steps
- Calculate and Date Operation: Select allowlisted arithmetic or UTC date operations. Use explicit numbers or source paths; missing or invalid values fail instead of becoming zero or the current date.
- Collection: Filter, sort, deduplicate, take, aggregate or map up to 1000 rows. Choose numeric comparisons explicitly. Aggregate outputs use value; collection outputs use rows and count.
- Wait for Approval and Wait for Event: Connect every named outcome. Deadlines are saved and retained through recovery. Event waits require a registered topic and matching correlation field.
- Run Workflow, For Each and Parallel Workflows: Select active workflows and published versions, then explicitly map child input fields from root, item and index. Configure bounded parallelism, iteration limits and timeout. All children join into one success, failure or timeout outcome.
- Safety: Graph cycles and recursive child calls are not supported. Cancellation stops owned descendants but cannot undo a remote action already accepted. Never assume an external timeout proves no side effect occurred.
Resolve Durable Workflow Waits
- Approve or Reject: Authorized operators can confirm a live approval decision with an optional note. Identity comes from authentication, not the request body.
- Failure recovery: A failed or competing decision keeps the dialog and note. Refresh the execution before retrying. Duplicate identical accepted decisions do not repeat successors.
- Waiting and child work: Active details refresh automatically. Waiting executions remain cancellable. Inspect saved deadlines, child execution references and exclusive outcomes in the step journal.
Business Event Triggers
- Orders: Select Order Created, Order Shipped, Order Delivered, Order Delayed, Order Confirmation Requested, or Guest Tracking Link Requested. Order Created is emitted when an order is confirmed: after verified payment for Stripe orders, or on confirmation for invoice orders.
- Keep resends separate: Order Confirmation Requested only requests another confirmation email for an existing order. Do not use it to create another order, charge a payment, or reserve stock again.
- Returns and inquiries: Return Denied complements Return Approved. Inquiry Reply Sent covers non-internal customer and agent replies; filter authorType when only one side should start a workflow.
- Use event fields: Payload suggestions match the published event. Order Delayed exposes reason and estimatedShipDate; Guest Tracking Link Requested exposes email and trackingToken. Confirmation resends share the order-created fields.
- Other business changes: Use CQRS Command Executed and select a command when there is no dedicated event. This observes command execution, not external delivery or payment settlement.
- Activate deliberately: Save and publish the workflow after selecting its event. New catalog entries require the updated Automation service; an explicit Automation:Topics override must include the selected topic.