Skip to content

Commit

Permalink
Merge pull request #647 from RizaFarheen/main
Browse files Browse the repository at this point in the history
Wait Doc Update
  • Loading branch information
nhandt2021 authored Apr 23, 2024
2 parents 62e28f1 + cf25735 commit a399d27
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/reference-docs/operators/wait.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ The wait task is used when the workflow needs to be paused for an external signa

|Parameter | Description |
| -------- | ----------- |
| Wait type | Indicates the type of wait period. Supported types include **_until_**, **_duration_**, and **_signal_**.<ul><li>**Until** - Used to wait until a specified date & time, including the timezone. The date/time can be supplied in the format: **YYYY-MM-DD hh:mm a/pm**. For example, 2024-04-30 15:20 GMT+04:00.<ul><li>On choosing the date & time, it displays the computed value. This value can also be [passed as a variable](https://orkes.io/content/developer-guides/passing-inputs-to-task-in-conductor).</li></ul></li><li>**Duration** - Specifies the wait duration in the format **x hours x days x minutes x seconds**. The accepted units in this field are _days_, _d_, _hrs_, _hours_, _h_, _minutes_, _mins_, _m_, _seconds_, _secs_, and _s_.</li><ul><li>**_Variable_** - The duration can also be [passed as a variable](https://orkes.io/content/developer-guides/passing-inputs-to-task-in-conductor).</li></ul><li>**Signal** - Configure this option if the workflow needs to wait for an external signal, such as a manual approval.</li></ul> |
| inputParameters | Configure the input parameters required for the task. It can also be [passed as a variable](https://orkes.io/content/developer-guides/passing-inputs-to-task-in-conductor). |
| Wait type | Indicates the type of wait period. Supported types include **_until_**, **_duration_**, and **_signal_**.<ul><li>**Until** - Used to wait until a specified date & time, including the timezone. The date/time can be supplied in the format: **YYYY-MM-DD hh:mm a/pm**. For example, 2024-04-30 15:20 GMT+04:00.<ul><li>On choosing the date & time, it displays the computed value. This value can also be [passed as a variable](https://orkes.io/content/developer-guides/passing-inputs-to-task-in-conductor#expression).</li></ul></li><li>**Duration** - Specifies the wait duration in the format **x days x hours x minutes x seconds**. The accepted units in this field are _days_, _d_, _hrs_, _hours_, _h_, _minutes_, _mins_, _m_, _seconds_, _secs_, and _s_.</li>**Note**: You can use the duration format to configure the wait period according to your requirements. For example, if you need to wait for 10 mins, you can use this format in your JSON `"inputParameters": {"duration": "10 minutes" }`. Or, you can provide 10 in the minute's field from the UI as shown below:<p align="center"><img src="/content/img/wait-for-10-mins.png" alt="Wait for 10 mins example" width="70%" height="auto"></img></p><ul><li>**_Variable_** - The duration can also be [passed as a variable](https://orkes.io/content/developer-guides/passing-inputs-to-task-in-conductor#expression).</li></ul><li>**Signal** - Configure this option if the workflow needs to wait for an external signal, such as a manual approval.</li></ul> |
| inputParameters | Configure the input parameters required for the task. It can also be [passed as a variable](https://orkes.io/content/developer-guides/passing-inputs-to-task-in-conductor#expression). |

## Examples

Expand Down
Binary file added static/img/wait-for-10-mins.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a399d27

Please sign in to comment.