Exit

Overview

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.



Important:

Behavior of the Exit Snap in Ultra 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).

Snap views

View Description Examples of upstream and downstream Snaps
Input Accepts document data that flows into the Exit Snap for threshold monitoring and pipeline control.

When the number of input documents exceeds the configured threshold limit, the Snap forces the pipeline to stop with a failed status.

 N/A
Output

The output view passes through input documents that are within the configured threshold limit before the Snap triggers a pipeline failure.

This optional view (Min: 0, Max: 1) allows downstream processing of documents that successfully pass the threshold check.

 N/A
Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when an error occurs.
  • Discard Error Data and Continue Ignores the error, discards that record, and continues with the remaining records.
  • Route Error Data to Error View Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap settings

Legend:
  • Expression icon (): Allows using pipeline parameters to set field values dynamically (if enabled). SnapLogic Expressions are not supported. If disabled, you can provide a static value.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field / Field set Type Description
Label String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: Exit

Example: Exit Transaction
Threshold limit Integer/Expression Required. Specify the maximum number of input records to be received by the Snap.
Warning: This field is expression enabled; however, it cannot take values from the upstream Snaps. The Snap allows only direct values or Pipeline parameters.

Default value: 0

Example: 2483647
Exit error message String/Expression Specify the message to be displayed when the error occurs.
Warning: This field is expression enabled; in case the field is blank, the default value is displayed.

Default value: Exceeded threshold limit
Snap execution Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute: Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Example: Execute only

Default value: Validate & Execute

Example: