2.2 Manage Workflow Executions
Start workflows asynchronously or synchronously, pass input data, set a version, correlation ID, priority, or idempotency key, and track the returned workflow ID. You can view execution status, include task details, find workflows by correlation ID, list running workflows, search workflow history, pause or resume an execution, skip a task, rerun, restart, retry, terminate, or remove workflow executions.
A workflow execution is a running or completed instance of a workflow definition. MicroTx Workflows stores execution details so you can track workflow progress, inspect task status, review execution history, and troubleshoot failures.
You can start a workflow asynchronously or synchronously, pass workflow input, specify a workflow version, use correlation IDs to group related executions, and use idempotency keys to avoid duplicate execution requests. After a workflow starts, you can view its status by workflow ID, include task details, search execution history, find executions by correlation ID, and list running workflows.
You can also manage active or completed executions by pausing, resuming, retrying, rerunning, restarting, skipping tasks, terminating, or removing workflow executions.
Topics
- Run or Execute a Workflow
Use Workbench to run a workflow from the MicroTx Workflows console. It is useful for testing workflow definitions, validating input, and inspecting execution results. - About Workflow Status
A workflow status indicates the current state of a workflow execution. Understanding workflow statuses helps you determine which actions are available, whether the workflow is still active, and how to troubleshoot failures. - About Idempotent Workflows and Tasks
Idempotency ensures that repeated attempts to process the same logical request do not create duplicate workflow executions or duplicate task side effects. This is useful in distributed systems where clients, schedulers, workers, or AI agents may retry an operation after a timeout, network failure, or partial failure. - Update and Rerun a Workflow Execution
Workbench stores the details of the executed workflows in your browser's local storage. - View Details of a Workflow Execution
- Search and View Executed Workflows
You can search for workflow executions and view execution details such as status, start time, end time, failed tasks, input and output payload paths, and the reason for failure or termination. - Perform Actions on Multiple Executed Workflows
You can perform the same action on multiple workflow executions at the same time. Bulk actions are applied independently to each selected workflow. If an action succeeds for some workflows and fails for others, MicroTx Workflows displays the successful workflow IDs and the reason for each failure. - Handle Workflow Execution Failures
Learn about the issues you may encounter, how to identify their causes, and how to work around them.
Parent topic: Workflows