...
...
...
...
On this page
| Table of Contents | ||||
|---|---|---|---|---|
|
What is an Error Pipeline?
A Pipeline that you can create specifically for handling errors—it processes error documents produced by other Pipelines in your environment. The Error Pipeline runs even if errors are not encountered in the Snaps from the main Pipeline.
Benefits of an Error Pipeline
- Allows you to write the errors of all your Pipelines (in production) to a single document for ease in resolving those errors.
- Allows you to standardize error handling across your Pipelines.
...
Error View
You can configure the error view in your Snaps to handle errors
...
by selecting an option from the When errors occur in the Views tab of the Snap settings.
Stop Pipeline Execution: This option stops the current pipeline execution when an error arises. When the pipeline fails, a window appears that shows the execution statistics for the pipeline. The Mapper Snap is configured with the wrong settings in the following example. This generates an error when we execute the pipeline.
Discard Error Data and Continue:
...
This option discards the record with errors, if any, and continues with the Snap execution. You might encounter partial or no data processing if you select this option.
Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.
...
Creating an Error Pipeline
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.
| Note | ||
|---|---|---|
| ||
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
- Open the main Pipeline and click the Edit Pipeline Properties
icon. By default, the dialog opens the Settings tab. - On the Error Pipeline list, select the Error Pipeline to which you want to route the errors.
- Enter the Error Pipeline Parameters (key-value pairs) to evaluate and pass to the Error Pipeline.
- Click Save to save the Pipeline for reuse. A confirmation prompt appears, informing you that default error behavior will change. 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).
| Note |
|---|
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. |
Viewing the Error Pipeline from a Main Pipeline
...
Linking Output to Error Pipeline
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.
Verifying 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, but you can still add a custom Error View to a Snap.
- Select Edit from the Snap context menu.
- 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.
Adding 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 you add the Snaps, you can then connect their unlinked output views to the Error Pipeline by selecting Route to Error Pipeline from the Snap's context menu.
| Note |
|---|
When you link a Snap output view to the Pipeline Error View, the Integration Assistant is disabled. |
Example
Triggering an Error Pipeline From the Main Pipeline
Having Error Pipelines is an efficient way to handle error data of your Pipelines, which enables you to read the errors in a single log and take further action.
This is typically a two step process:
Creating and configuring the main Pipeline.
Creating and configuring the Error Pipeline.
Creating the Main Pipeline
...
Create a simple Pipeline containing the JSON Generator and Mapper Snaps.
...
Creating and configuring Error Pipeline
...
Create a Pipeline containing the Mapper, JSON Formatter, and File Writer Snaps.
...
Run the Main Pipeline to route the error data the Error Pipeline.
After you run, you will see the following error in the preview of the Pipeline Execution Statistics.
You can navigate to the SnapLogic Dashboard to view the Pipeline details.
Related Links
...
If you manage errors in this manner within the pipeline, the overall status of the pipeline will still show as completed. In the following example, you can see the data is directed to an error view of the Mapper Snap. You can route errors to the error view and decide how to manage them in the pipeline: store them in a file, log them, or take specific actions based on the type of error.
However, it’s not the recommended practice for handling errors across the entire project. As pipelines evolve over time, growing in size, the number of Snaps, and complexity, this method becomes challenging to maintain. It's best to consider alternative strategies for managing errors on a broader scale.
Error Pipeline
An error pipeline is a pipeline that you can create specifically for handling errors—it processes error documents produced by other pipelines in your environment. When an error is encountered during pipeline execution, the error handling mechanism routes the errored documents to an error pipeline, which is a separate pipeline dedicated to handling errors. The main pipeline continues processing valid documents without being interrupted by errors. The error pipeline runs even if errors are not encountered in the Snaps from the main pipeline. After the error pipeline is configured, the options in the Views tab change as follows:
Select the Route to Error Pipeline option to route the errors to an error pipeline. For more information on using error pipelines, see Working with Error Pipelines.
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.