In this article
You can use this Snap to force a Pipeline to stop with a failed status if it receives more records than the user-defined threshold.
The Exit Snap is a Read-type Snap.
None.
None.
Works in Ultra Task Pipelines.
When an input document is passed to the Exit snap in an Ultra pipeline, the Snap acknowledges the message (removes it from the request queue) and fails the Pipeline (depending on the Threshold limit). |
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps |
---|---|---|---|
Input | Document |
| N/A |
Output | Document |
| N/A |
Error | No error view is defined for this Snap. Nothing is written to the error view in this Snap. The Snap fails the Pipeline if it receives more than the required number of records. |
Field | Field Type | Description | ||
---|---|---|---|---|
Label*
| String | Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline. | ||
Threshold limit*
| Integer/Expression | Specify the maximum number of input records to be received by the Snap.
| ||
Exit error message
| String/Expression | Specify the message to be displayed when the error occurs.
| ||
Snap Execution
| Dropdown list |
In this example, you have a list of documents, and you want to filter the first six input documents based on the number they contain in a specific field. You want all odd numbers routed into one branch, and all the even numbers, into another. To do so, you create a parent and child Pipeline.
You first design the child Pipeline.
$num
field into a branch labeled Even, and all documents containing odd numbers into a branch labeled Odd.Design the parent Pipeline to accept multiple documents and trigger one child Pipeline execution for all the input documents, together.
$num
field contains even numbers. In the four remaining documents, $num
contains odd numbers.