Gate

Overview

Use this Snap to consolidate multiple input streams into a single output document, where each input stream is displayed as a a label containing the records that were received by that input view.

It is also important to note that this Snap does not complete executing until the execution of all upstream Snaps is done.



Prerequisites

This Snap collects multiple input documents into a single output document; hence there are system memory limitations, and it should not be used for massive data propagation. If large amounts of data are required, offload your data before Snap execution. You can also write your data to a file or database; then, after Snap execution completes, you can use a Reader Snap ( File Reader , S3 File Reader , and so on) to read from the offloaded data source.

Limitations

This Snap does not have error views. If the Snap fails during validation or execution, documents are not passed through, and you receive an error message.

Snap views

View Description Examples of upstream and downstream Snaps
Input One or more documents containing records that must be passed on to downstream Snaps for further processing.
Output A single document that contains all the records received from the various upstream Snaps.
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: Gate

Example: Ensure Complete Execution
Ignore Empty Stream Checkbox

Select this checkbox if you do not want this Snap to produce any output document.

When you deselect this checkbox, the Snap writes an empty document to the output view.

Default status: Deselected
Output Document Content Dropdown list Required. Choose one of the following options to determine the content of the output document:
  • All inputs documents
  • Document count and first document for each input
  • Document count and final document for each input

Default value: All input documents

Example: Document count and first document for each input
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.

Default value: Validate and Execute

Example: Execute only

Example:

Combining Completed Upstream Execution Output Using the Gate Snap