|
Next revision
|
Previous revision
|
bw:error_handling [2019/01/02 11:10]
_deletedUser4_ created |
bw:error_handling [2021/02/05 16:51] (current)
akoehler |
| ====== Introduction ====== | ====== Introduction to Error Handling ====== |
| | <WRAP center round tip 60%> |
| This document describes the configuration and use of error handling tools introduced in version 2.2 of Bizweaver. | Error handling is introduced in version 2.2 of Bizweaver. |
| | </WRAP> |
| ====== Audience ====== | |
| | |
| This document is intended for designers of Bizweaver workflows. It may be appropriate to include end-users when determining who should receive error notifications for specific steps. | |
| | |
| ====== Related Documents ====== | |
| | |
| This document assumes that the reader is familiar with the concepts of Bizweaver workflows. These concepts are outlined in other Bizweaver documents. | |
| | |
| ====== Overview ====== | |
| |
| 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 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. |
| {{:bw:eeimage3.png?384x324}} | {{:bw:eeimage3.png?384x324}} |
| |
| - Select the error handling options as desired according to the description highlighted in <color #fff200>Yellow</color>. | * Leave the "Continue on Error" and "Enable Notifications" checkboxes selected as shown. |
| - The section highlighted <color #22b14c>green</color> is for information only in case you wish to create your own format. | * 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.. |
| - Select the desired SMTP connection from the drop-down list. | * The section highlighted <color #22b14c>green</color> is for information only in case you wish to create your own format. |
| - Enter one or more email addresses for persons to be notified in the event of an error. | * Select the desired SMTP connection from the drop-down list. |
| - At least one recipient is required. | * Enter one or more email addresses for persons to be notified in the event of an error. |
| - Separate multiple recipients with a semi-colon (user1@twbs.com**;**user2@twbs.com). | * **At least one recipient is required**. |
| - Define the email Content. | * Separate multiple recipients with a semi-colon (user1@twbs.com**;**user2@twbs.com). |
| - A default email layout at the workflow level is provided as shown in the image above. It should be adequate for most installations. | * Define the email Content. |
| - Items in < … > are selected from the “Add Tags” drop-down list. This allows you to create your own message layout if you prefer. | * A default email layout at the workflow level is provided as shown in the image above. It should be adequate for most installations. |
| - 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. | * 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. |
| ===== Actions Based on Settings ===== | |
| | |
| The table below shows how the combinations of settings at the workflow level affect processing. | |
| | |
| (EEH = Enable Error Handling, EN = Enable Notification, Y = checked, N = unchecked) | |
| | |
| ^**EEH**^**EN**^**Action** ^ | |
| |N |N |Workflow terminates at the first failed step. No notification is sent. This is the same action as found in Bizweaver prior to v2.2. This also occurs if error handling is not enabled for a workflow.| | |
| |Y |N |Allows processing to continue on error at the step level, but notification is cannot be sent. | | |
| |Y |Y |Allows processing to continue on error at the step level and allows notification to be sent. | | |
| | | | | | |
| |
| ====== Workflow Step Level ====== | ====== Workflow Step Level ====== |
| {{:bw:eeimage5.png?384x305}} | {{:bw:eeimage5.png?384x305}} |
| |
| - 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. |
| - Enter one or more email addresses for persons to be notified in the event of an error. | * Enter one or more email addresses for persons to be notified in the event of an error. |
| - Any recipients entered here are in addition to those defined at the workflow level. | * Any recipients entered here are in addition to those defined at the workflow level. |
| - 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. |
| |
| ===== Actions Based on Settings ===== | ===== Actions Based on Settings ===== |
