bw:pause_tool
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
bw:pause_tool [2019/03/07 11:59] runger [Introduction] |
bw:pause_tool [2022/08/02 17:01] (current) akoehler |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Introduction (Pause) ====== | ====== Introduction (Pause) ====== | ||
| - | This document | + | This page describes the use of the Bizweaver **Pause** tool. |
| - | + | ||
| - | ====== Audience ====== | + | |
| - | + | ||
| - | This document is intended for developers of Bizweaver workflows. | + | |
| ====== Related Documents ====== | ====== Related Documents ====== | ||
| - | The following | + | The following |
| - | * None | + | * **[[ bw: |
| - | ====== General Workflow Step Information ====== | ||
| - | - Each workflow step must have a unique name. | + | <WRAP center round tip 80%> |
| - | - The application will assign a default name, but we recommend that you change | + | Beginning with Bizweaver v2.3, it is not necessary to use the Pause tool to control |
| - | - The name cannot have spaces or special characters other than and underscore (_). | + | </ |
| ====== Pause Tool ====== | ====== Pause Tool ====== | ||
| Line 23: | Line 19: | ||
| The Bizweaver **Pause** tool | The Bizweaver **Pause** tool | ||
| - | {{: | + | {{ : |
| is used to temporarily suspend the processing of a Bizweaver workflow. There are two options available: Sleep and Delay. A Pause step can be inserted anywhere in a workflow. | is used to temporarily suspend the processing of a Bizweaver workflow. There are two options available: Sleep and Delay. A Pause step can be inserted anywhere in a workflow. | ||
| Line 33: | Line 29: | ||
| The **Sleep** option is the most common Pause function. It is used when the workflow processing needs completely pause before continuing to the next step. None of the subsequent steps in the workflow will execute until the pause period is complete. | The **Sleep** option is the most common Pause function. It is used when the workflow processing needs completely pause before continuing to the next step. None of the subsequent steps in the workflow will execute until the pause period is complete. | ||
| - | {{: | + | {{ : |
| The amount of pause time is expressed in seconds. | The amount of pause time is expressed in seconds. | ||
| Line 41: | Line 37: | ||
| The **Delay** option can be used but it is intended to support future functionality. It will be used when the workflow processing needs to continue while a specific step is paused. More information regarding the use of this option will be provided in future Bizweaver releases. | The **Delay** option can be used but it is intended to support future functionality. It will be used when the workflow processing needs to continue while a specific step is paused. More information regarding the use of this option will be provided in future Bizweaver releases. | ||
| - | {{: | + | {{ : |
| + | |||
| + | ====Pause Tool Variables==== | ||
| + | ^Name ^Description^ | ||
| + | |IsDelay|True or False If the delay option is selected| | ||
| + | |TimeOut|Total number of seconds entered| | ||
| + | |StepMessage|During a failure the reason for failure will be populated here| | ||
| + | |StepStatus|True or False| | ||
bw/pause_tool.1551977973.txt.gz · Last modified: 2019/03/07 11:59 by runger
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial 4.0 International
