Wiki

Scale Your Enterprise

User Tools

Site Tools

mbstring extension must be loaded in order to run mPDF

bw:error_handling

This is an old revision of the document!


Introduction

Error handling is introduced in version 2.2 of Bizweaver.

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.

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.

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.

Enabling Error Handling

Error handling is enabled for a workflow by selecting the “Error Handling and Notifications” checkbox as shown here.

Step level error handling cannot be used unless this option is selected.

Workflow Level

  • 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 be available at the lower levels.
    • The section highlighted green is for information only in case you wish to create your own format.
  • Select the desired SMTP connection from the drop-down list.
  • Enter one or more email addresses for persons to be notified in the event of an error.
    • At least one recipient is required.
    • Separate multiple recipients with a semi-colon (user1@twbs.com;user2@twbs.com).
  • 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.
    • 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)

Workflow Step Level

To access step level error handling options, click the » link in the upper right corner of the step page.

A default email layout at the step level is provided as shown in the following image.

  • 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.
    • 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).
  • 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.
      • 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

The table below shows how the combinations of settings at the step level affect processing. Remember that these options are also based on the settings at the workflow level.

(EEH = Enable Error Handling, EN = Enable Notification, Y = checked, N = unchecked)

EEHENAction
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 Y Workflow continues to next step. Notification email is sent.

Sample Output

Here are sample emails using the standard formats provided

Workflow Level Message

Error found in Bizweaver workflow (ID 103)
Date: 10/1/2018 at 2:55 PM
Workflow has terminated

Details
-----------
Step Name:
Step Type:
Step Status: False
Step Message: An invalid character was found in the mail header: '@'.
Exception Message: An invalid character was found in the mail header: '@'.
Detailed Error Information
System.FormatException: An invalid character was found in the mail header: '@'.
at System.Net.Mail.DotAtomReader.ReadReverse(String data, Int32 index)
at System.Net.Mail.MailAddressParser.ParseLocalPart(String data, Int32& index, Boolean expectAngleBracket, Boolean expectMultipleAddresses)
at System.Net.Mail.MailAddressParser.ParseAddress(String data, Boolean expectMultipleAddresses, Int32& index)
at System.Net.Mail.MailAddressParser.ParseAddress(String data)
at System.Net.Mail.MailAddress..ctor(String address, String displayName, Encoding displayNameEncoding)
at SMTPMail.SendSMTPMail()
at ThirdWaveAssembly.Start(Object[] args)

Step Level Message

Error found in Bizweaver workflow Error Handling Test - Email (ID 103)

Date: 10/1/2018 at 2:56 PM
Details
-----------
Step Name: Email1
Step Type: Email
Step Status: False
Step Message: An invalid character was found in the mail header: '@'.
Exception Message: An invalid character was found in the mail header: '@'.
Detailed Error Information
System.FormatException: An invalid character was found in the mail header: '@'.
at System.Net.Mail.DotAtomReader.ReadReverse(String data, Int32 index)
at System.Net.Mail.MailAddressParser.ParseLocalPart(String data, Int32& index, Boolean expectAngleBracket, Boolean expectMultipleAddresses)
at System.Net.Mail.MailAddressParser.ParseAddress(String data, Boolean expectMultipleAddresses, Int32& index)
at System.Net.Mail.MailAddressParser.ParseAddress(String data)
at System.Net.Mail.MailAddress..ctor(String address, String displayName, Encoding displayNameEncoding)
at SMTPMail.SendSMTPMail()
at ThirdWaveAssembly.Start(Object[] args)

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.

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.

bw/error_handling.1568051812.txt.gz · Last modified: 2019/09/09 13:56 by runger