Working with Error Pipelines

An error pipeline offers an efficient means to manage errors when executing pipelines. You can configure all the actions to be executed when an error occurs in the error pipeline. It is dynamically called to manage errors across one or more projects and thus can be reused across multiple projects. This approach is one of the best ways to handle errors because it allows seamless integration of numerous pipelines without requiring significant modifications to the error pipeline.

Create an Error Pipeline

Create a pipeline or use an existing one to handle errors. This pipeline should be connected to the main pipeline. An error pipeline must have a single unlinked document input view. The error documents from the main pipeline are sent into this view. Within the error pipeline, you can use various Snaps to handle errors as needed. See Creating a Pipeline for more information.

Error pipeline for ultra pipelines: You can create an error pipeline the same way as you create your regular pipeline. See Creating a Pipeline for more information. However, an error pipeline must have a single unlinked document input view. The error documents from the main pipeline are sent into this view. 

Add an Error Pipeline to a Main Pipeline

  1. Open the main pipeline and click the Edit Pipeline Properties  icon. By default, the dialog opens the Settings tab.

  2. On the Error Pipeline list, select the error pipeline to which you want to route the errors.

  3. Enter the Error Pipeline Parameters (key-value pairs) to evaluate and pass to the error pipeline. 

  4. Click View Error Pipeline to view the linked error pipeline.

  5. Click Save to save the pipeline for reuse. A confirmation prompt appears, informing you that the default error behavior will change.

  6. Click Yes to confirm and No to close the dialog.

You can invoke the error pipeline from any given pipeline from the same dialog (similar to the way that child pipelines are invoked).

If you remove an error pipeline from the main pipeline without replacing it with another one, the main pipeline reverts to the default error behavior.

When viewing a main pipeline with an error pipeline, you can view the errors by looking at the Pipeline Execution Statistics in the Snaps Statistics tab. It displays the number of documents that pass through the output and the number of documents failed with errors.

On the Snap's context menu, click Link Output to Error Pipeline. The Snap displays err in the Snap's connector. Remember to have a single unlinked document input view to allow error documents from the main pipeline to be sent to this view.


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 for customization. 

After you add the Snaps, you can then connect their unlinked output views to the error pipeline by selecting Route to Error Pipeline from the Views tab of Snap settings.

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