Differences

This shows you the differences between two versions of the page.

--- bw2:pause_tool [2020/12/15 13:55]
akoehler created
+++ bw2:pause_tool [2024/09/24 16:06] (current)
dlee [Pause Tool Variables]
@@ Line 1: / Line 1: @@
-====== Introduction (Pause) ======
-This page describes the use of the Bizweaver **Pause** tool.
-====== Related Documents ======
-The following pagescontain additional information that may be helpful with the development of Bizweaver workflows using the Pause tool.
-  * **[[  bw2:web_service_tool|WebService Tool  ]]**
-<WRAP center round tip 80%>
-Beginning with Bizweaver v2.3, it is not necessary to use the Pause tool to control the execution of Bizweaver WebService steps.  The WebService tool has its own "pause" function built in.
-</WRAP>
 ====== Pause Tool ======
-The Bizweaver **Pause** tool
+The Bizweaver **Pause** tool is used to suspend the processing of a Bizweaver workflow temporarily. There are two options available: Sleep and Delay. A Pause step can be inserted anywhere in a workflow.
-{{  :bw:pauseimage1.png?68x80  }}
+There are no specific rules about where and when to use the Pause tool. In general, you may want to use the tool if you find that a workflow is failing because the workflow is moving to the next step before the current step has completed all its processing. An example of this might be a web service call where the call is complete, but all the retrieved information has not been fully processed before the next step begins. If you find you are getting processing errors because data isn’t available, try adding a Pause step. You may also need to experiment with the amount of time you specify for the pause.
-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.
-There are no specific rules about where and when to use the Pause tool. In general, you may want to use the tool if you find that a workflow is failing because the workflow is moving to the next step before the current step has completed all its processing. An example of this might be a web service call where the call is complete, but all the information that was retrieved has not been fully processed before the next step begins. If you find you are getting processing errors because data isn’t available; try adding a Pause step. You may also need to experiment with the amount of time you specify for the pause.
 ===== Sleep Option =====
-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/delay the execution before continuing to the next step. This will block the current thread for the time specified. None of the subsequent steps in the workflow will execute until the pause period is complete. During sleep, the thread will not be able to communicate with the events so the workflow will go into sleep mode
-{{  :bw:pausemage2.png?384x229  }}
+{{ :bw2:bizweaverpause1.png |}}
 The amount of pause time is expressed in seconds.
@@ Line 35: / Line 18: @@
 ===== Delay Option =====
-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.
+Logical delay without blocking the thread, Bizweaver will continue to process events during the delay. Background processes on the current thread will continue to execute.
+{{ :bw2:bizweaverpause2.png |}}
-{{  :bw:pauseimage3.png?384x228  }}
+====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|
+----
+**[[bizweaver:Home|Home]]**

Wiki

User Tools

Site Tools

Differences

Page Tools