Versions Compared

Old Version 37

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version 38

changes.mady.by.user Kalpana Malladi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this Article

Table of Contents
maxLevel2
absoluteUrltrue

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.

650

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

...

 

Support for Ultra Pipelines

Does not support Ultra Pipelines.

Snap Views

TypeFormatNumber of ViewsExamples of Compatible Upstream and Downstream SnapsDescription
Input Document
  • Min: 1
  • Max: ∞
  • Mapper
  • JSON Parser
  • Join
One or more documents containing records that must be passed on to downstream Snaps for further processing.
OutputDocument
  • Min: 1
  • Max: 1
  • Copy
  • Join
  • Common Words

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:

  • Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.

  • 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

Info

  • Asterisk ( * ): Indicates a mandatory field.

  • Suggestion icon (Image Modified): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon (Image Modified ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ( Image Modified ): Indicates that you can add fields in the field set.

  • Remove icon ( Image Modified): Indicates that you can remove fields from the field set.

  • Upload icon (Image Modified ): Indicates that you can upload files.


Field NameField TypeDescription

Label*


Default Value: Gate
Example: Ensure Complete Execution

StringThe 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.

Ignore Empty Stream


Default Value: Deselected
Example: Ensure Complete Execution

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.

Output Document Content*


Default Value: All input documents
Example: Document count and first document for each input

Dropdown list

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



Snap Execution


Default Value: Validate & Execute
Example: Execute only

Dropdown listSpecifies the execution type

Select one of the following three modes in which the Snap executes:

  • Validate & Execute: Performs limited execution of the Snap

(up to 50 records) during Pipeline validation;

  • , and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during

Pipeline execution

  • pipeline runtime.

  • Execute only: Performs full execution of the Snap during

Pipeline execution; does not execute the Snap during Pipeline validation

  • pipeline execution without generating preview data.

  • Disabled: Disables the Snap and

, by extension, its downstream Snaps

  • all Snaps that are downstream from it.

Examples

Combining Completed Upstream Execution Output Using the Gate Snap

...