Using Error Handlers In Workflow Studio

For more information about upgrading your SiteDocs Package, click here!

Occasionally you may come across errors while trying to run a Workflow. This usually happens when a service isn't available, responds with unexpected data, or the input data doesn't check out.

If a module throws an error during a scenario and there's no specific error handling attached to it, a default error handling process kicks in, which means that the Workflow will be stopped and an error email will be sent to all Admins in your Workflow Studio Account.

However, you can customize this default error handling by adding your own error handler route to any  module in your Workflow. Workflow Studio provides 5 different default Directives, and you can pick any of them to include at the end of your error handler routes or choose any other Module Type if you like. 

To add an error handler route to a module, right-click the module and select "Add error handler".

You will see a list of options as well as the apps being used in your Workflow. If the selected Module is the last module in your route, you will be required to choose one of the directives. Otherwise, you can go on to add one or more modules to your route, in which case, the Ignore directive is applied by default to the selected Module and in the event of an error, the subsequent modules on that route are processed.

Error handling Directives

There is a total of five directives that can be grouped into the following 2 categories based on whether a Workflow execution should continue or not:

• The following directives ensure that a scenario execution continues:
  • Resume allows you to specify a substitute output for the module with the error and the scenario execution status is marked as a success.
  • Ignore simply ignores the error and the scenario execution status is marked as a success
  • Break stores the input to the queue of incomplete executions and the scenario execution status is marked as a warning.
    
    
• On the other hand, if a scenario execution should be stopped, one of the following directives need to be used:
  • Rollback stops the scenario execution immediately and marks its status as an error
  • Commit stops the scenario execution immediately and marks its status as a success