-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #794 from orkes-io/liv-update
doc update
- Loading branch information
Showing
7 changed files
with
69 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
slug: "/developer-guides/task-and-workflow-status-in-conductor" | ||
description: "Find out the different workflow and task status in Conductor." | ||
--- | ||
|
||
# Workflow and Task Status | ||
|
||
The workflow and task statuses are crucial to understanding the execution mechanism in Conductor. You can check a workflow execution’s current status and task status [from the Conductor UI](debugging-workflows#searching-and-viewing-workflow-executions) or [using API](/reference-docs/api/workflow/search-workflow-executions). | ||
|
||
## Workflow status | ||
|
||
Once started, a workflow execution will either be in an ongoing or terminal status. | ||
|
||
| Status | Description | | ||
| --------------------------------- | --------------------------------- | | ||
| RUNNING | The workflow is in progress. | | ||
| PAUSED | The workflow is paused by a user or external event, and is waiting for a manual action to resume. | | ||
| COMPLETED | Terminal status where all the tasks in the workflow are completed. | | ||
| TIMED_OUT | Terminal status where one of the workflow tasks has timed out. | | ||
| TERMINATED | Terminal status where an incomplete workflow has been terminated by a user, event, or another workflow. | | ||
| FAILED | Terminal status where the workflow has encountered an error and failed. You can [retry the workflow execution from the failed task](debugging-workflows#recovering-from-failures). | | ||
|
||
## Task state transitions | ||
|
||
During a workflow execution, each task will go through the state transitions illustrated in the figure below. These states roughly correspond to the nine task statuses in Conductor. | ||
|
||
<p align="center"><img src="/content/img/conceptual-guides/workflow_lifecyle-task_states.png" alt="Task state transitions in Conductor." width="100%" height="auto"></img></p> | ||
|
||
### Task status | ||
Each task will be in a scheduled, ongoing, or terminal status. | ||
|
||
| Status | Description | | ||
| --------------------------------- | --------------------------------- | | ||
| SCHEDULED | The task has been scheduled to be picked up by a worker. | | ||
| IN_PROGRESS | The task is being executed by a worker. | | ||
| SKIPPED | The task is skipped without executing, and the workflow continues to the subsequent tasks. <br/><br/> Occurs if the [Skip Task API](/reference-docs/api/workflow/skip-task-from-workflow) is used during a currently running workflow. | | ||
| TIMED_OUT | The task times out without being completed. <br/><br/> Occurs if the task has been configured with the following timeout parameters in its task definition: <ul><li>timeOutPolicy.</li><li>timeOutSeconds</li><li>pollTimeoutSeconds</li><li>responseTimeoutSeconds</li></ul> | | ||
| CANCELED | The scheduled task has been canceled without being completed because the workflow has been terminated. | | ||
| FAILED | The task failed to complete due to an error, and the workflow can be [retried from the failed task](debugging-workflows#recovering-from-failures). | | ||
| FAILED_WITH_TERMINAL_ERROR | The task failed to complete due to an error and cannot be retried. | | ||
| COMPLETED_WITH_ERRORS | The task encountered some errors but is completed. <br/><br/> Occurs due to a variety of reasons. For example, if a task is set as optional and fails during execution. | | ||
| COMPLETED | The task has been successfully completed without any errors. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
30 changes: 0 additions & 30 deletions
30
docs/developer-guides/task-and-workflow-status-in-conductor.md
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.