Handling Errors with an Error Pipeline

In this article

When a Snap encounters an error, it writes a document to the error view for further processing. The Snap's error view can then be configured to do one of the three following actions:

  • Ignore errors.
  • Write errors out for further processing by other Snaps in the Pipeline.
  • Fail the Pipeline. 

You can create a Pipeline specifically for handling errors. When a Snap encounters an error, it writes a document to the error view for further processing. Error Pipelines allow you to standardize error handling across all your Pipelines. You can use Pipeline parameters in the Pipeline Properties dialog to specify the error parameter keys and assign them values, then save the Pipeline for reuse. The Error Pipeline can be invoked by any Pipeline from the same dialog (similar to the way that child Pipelines are invoked).

The Error Pipeline runs even if errors are not encountered in the Snaps from the main Pipeline. Snaps that are configured with the other error actions continue to behave as before.

Create an Error Pipeline

An Error Pipeline must have a single unlinked document input view. The error documents from the parent Pipeline are sent into this view. 

Error Pipelines for Ultra Pipelines

When creating an Error Pipeline for an Ultra Pipeline with unlinked views, your Ultra Pipeline must have an unlinked output view and produce output documents that can be used as the response to the original request.

Adding an Error Pipeline to a Parent Pipeline

  1. Open a parent Pipeline and click the Edit Pipeline properties icon. 
  2. Click the Settings tab in the Edit Pipeline dialog. Select an Error Pipeline.

3. Enter the Error Pipeline Parameters to evaluate and pass to the Error Pipeline. 

4. Click Save. A confirmation prompt appears, informing you that default error behavior will change. Click Yes to confirm and No to close the dialog.

If you remove an Error Pipeline from a parent Pipeline without replacing it with another one, the parent Pipeline reverts to the default error behavior. 

To view the Error Pipeline from a Parent Pipeline:

  1. From an open Pipeline in Designer, navigate to the target Pipeline and click to open the Edit Pipeline dialog:

  2. Click View Error Pipeline and the selected Pipeline is displayed.

Verify the Snap Configuration

Verify all the Snaps in the Pipeline are configured. Snaps with a default Error View are automatically updated when you add an Error Pipeline.

  1. Select Edit from the Snap context menu.
  2. Verify that Route to Error Pipeline is selected. 

Snaps are automatically updated when you add an Error Pipeline, but you can still add a custom Error View to a Snap.  

Add Output to an Error Pipeline

If you need to customize an error document before sending it to the Error Pipeline, you can change the Snap to Route Error Data to Error View and then add any Snaps needed to do the customizations. 

After those Snaps have been added, you can then connect their unlinked output views to the Error Pipeline by opening the Snap context menu and selecting Route to Error Pipeline.

When you link a Snap output view to the Pipeline Error View, the Integration Assistant is disabled.

Preview the Errors

Once you have created and saved your pipeline, you can use the Data Preview to display some of the errors that Snaps are passing. Errors are marked by a red icon, as shown in the following image.

To preview the errors:

  1. Click the preview icon in the connector.
  2. Click the View Error tab.


Nested Pipelines are not supported.