Wiki

Scale Your Enterprise

User Tools

Site Tools

Trace: • Save a Bizweaver Workflow • Pause Tool • downloads • about
bw2:error_handling

Differences

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

Link to this comparison view

bw2:error_handling [2021/02/05 16:56]
akoehler created 		bw2:error_handling [2021/02/09 09:31] (current)
akoehler
Line 4: Line 4:
 </WRAP> </WRAP>
  
-Error handling in Bizweaver allows the designer/administrator to easily handle error conditions in a workflow. There are two levels of error handling: workflow level and step level. The configuration of these levels is described in the following sections.+Error handling in Bizweaver allows the designer/administrator to handle error conditions in a workflow easily. There are two levels of error handling: workflow level and step level. The configuration of these levels is described in the following sections.
  
 <WRAP center round important> <WRAP center round important>
-Third Wave highly recommends that you enable error handling on all workflows, both existing and new. Doing the basic setup as described in the “Workflow” section below will provide information to help ensure that your Bizweaver workflows are functioning as expected.+Third Wave highly recommends that you enable error handling on all workflows, both existing and new. Doing the basic setup described in the “Workflow” section below will provide information to help ensure that your Bizweaver workflows are functioning as expected.
 </WRAP> </WRAP>
  
Line 13: Line 13:
 ====== Before You Begin ====== ====== Before You Begin ======
  
-Bizweaver error handling supports sending an email to designated persons when a problem is encountered. To do this at least one SMTP global connection is required. And in this connection a valid user must be defined using the “SMTP Credentials” option as shown below. This is a valid email user that can access the SMTP server and is used as the “From” user when an email is sent.+Bizweaver error handling supports sending an email to designated persons when a problem is encountered. To do this, at least one SMTP global connection is required. And in this connection, a valid user must be defined using the “SMTP Credentials” option as shown below. This is a valid email user that can access the SMTP server and is used as the “From” user when an email is sent.
  
-{{:bw:eeimage1.png?384x242}}+{{ :bw2:bizweavererrorh1.png |}}
  
 ====== Enabling Error Handling ====== ====== Enabling Error Handling ======
Line 21: Line 21:
 Error handling is enabled for a workflow by selecting the “Error Handling and Notifications” checkbox as shown here. Error handling is enabled for a workflow by selecting the “Error Handling and Notifications” checkbox as shown here.
  
-{{:bw:eeimage2.png?528x46}}+{{ :bw2:bizweavererrorh2.png |}}
  
 **Step level error handling cannot be used unless this option is selected.** **Step level error handling cannot be used unless this option is selected.**
Line 27: Line 27:
 ====== Workflow Level ====== ====== Workflow Level ======
  
-{{:bw:eeimage3.png?384x324}}+{{ :bw2:bizweavererrorh3.png |}}
  
   * Leave the "Continue on Error" and "Enable Notifications" checkboxes selected as shown.   * Leave the "Continue on Error" and "Enable Notifications" checkboxes selected as shown.
-    * These options only apply to Step-level reporting, but must be selected here to allow workflow level handling to function AND to be available for step-level reporting..+    * These options only apply to Step-level reporting but must be selected here to allow workflow level handling to function and be available for step-level reporting.
     * The section highlighted <color #22b14c>green</color> is for information only in case you wish to create your own format.     * The section highlighted <color #22b14c>green</color> is for information only in case you wish to create your own format.
   * Select the desired SMTP connection from the drop-down list.   * Select the desired SMTP connection from the drop-down list.
Line 37: Line 37:
     * Separate multiple recipients with a semi-colon (user1@twbs.com**;**user2@twbs.com).     * Separate multiple recipients with a semi-colon (user1@twbs.com**;**user2@twbs.com).
   * Define the email Content.   * Define the email Content.
-    * A default email layout at the workflow level is provided as shown in the image above. It should be adequate for most installations.+    * A default email layout at the workflow level is provided, as shown in the image above. It should be adequate for most installations.
     * Items in < … > are selected from the “Add Tags” drop-down list. This allows you to create your own message layout if you prefer.     * Items in < … > are selected from the “Add Tags” drop-down list. This allows you to create your own message layout if you prefer.
     * The tag <STEPLEVELERRORINFO> is used to present the information from a step-level error. If step-level notification is enabled, the information from a failed step is included in the email. However, if step-level notification is not enabled, the information shown between <HEADER_CONTENT> and </HEADER_CONTENT> is displayed.     * The tag <STEPLEVELERRORINFO> is used to present the information from a step-level error. If step-level notification is enabled, the information from a failed step is included in the email. However, if step-level notification is not enabled, the information shown between <HEADER_CONTENT> and </HEADER_CONTENT> is displayed.
Line 45: Line 45:
 To access step level error handling options, click the >> link in the upper right corner of the step page. To access step level error handling options, click the >> link in the upper right corner of the step page.
  
-{{:bw:eeimage4.png?399x81}}+{{ :bw2:bizweavererrorh4.png |}}
  
-A default email layout at the step level is provided as shown in the following image.+A default email layout at the step level is provided, as shown in the following image.
  
-{{:bw:eeimage5.png?384x305}}+{{ :bw2:bizweavererrorh5.png |}}
  
   * Select the error handling options as desired according to the description included at the workflow level.   * Select the error handling options as desired according to the description included at the workflow level.
Line 56: Line 56:
       * Separate multiple recipients with a semi-colon (user1@twbs.com**;**user2@twbs.com).       * Separate multiple recipients with a semi-colon (user1@twbs.com**;**user2@twbs.com).
   * Define the email Content.   * Define the email Content.
-    * A default email layout at the workflow level is provided as shown in the image above. A default email layout at the workflow level is provided as shown in the image above. It should be adequate for most installations.+    * A default email layout at the workflow level is provided, as shown in the image above. A default email layout at the workflow level is provided, as shown in the image above. It should be adequate for most installations.
       * Items in < … > are selected from the “Add Tags” drop-down list. This allows you to create your own message layout if you prefer.       * Items in < … > are selected from the “Add Tags” drop-down list. This allows you to create your own message layout if you prefer.
  
Line 67: Line 67:
 ^**EEH**^**EN**^**Action**                                                                                                              ^ ^**EEH**^**EN**^**Action**                                                                                                              ^
 |N      |N     |Workflow terminates at this step. No notification is sent, although it may be sent based on the workflow level settings.| |N      |N     |Workflow terminates at this step. No notification is sent, although it may be sent based on the workflow level settings.|
-|Y      |N     |Workflow continues to next step. No notification is sent.                                                               | +|Y      |N     |Workflow continues to the next step. No notification is sent.                                                               | 
-|Y      |Y     |Workflow continues to next step. Notification email is sent.                                                            |+|Y      |Y     |Workflow continues to the next step. A notification email is sent.                                                            |
 |       |      |                                                                                                                        | |       |      |                                                                                                                        |
  
Line 126: Line 126:
 ====== Error Handling & Decisions ====== ====== Error Handling & Decisions ======
  
-The information from error handling can also be used in Decisions. The two key values are for “Step Status.” The values are True (no error) and False (error encountered). The only thing to remember is to define the values as Boolean rather than Alphanumeric in the decision expression.+The information from error handling can also be used in Decisions. The two fundamental values are for “Step Status.” The values are True (no error) and False (error encountered). The only thing to remember is to define the values as Boolean rather than Alphanumeric in the decision expression.
  
-{{:bw:eeimage6.png?576x89}}+{{ :bw2:bizweavererrorh6.png |}}
  
-It might also be possible to use the contents of the Step Message, however it would likely need to pass through a VBScript step to parse out a specific value before the decision.+It might also be possible to use the Step Message contents; however, it would likely need to pass through a VBScript step to parse out a specific value before the decision.
  
bw2/error_handling.1612562175.txt.gz · Last modified: 2021/02/05 16:56 by akoehler

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial 4.0 International
CC Attribution-Noncommercial 4.0 International Valid HTML5 Valid CSS Driven by DokuWiki