Versions Compared

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 label containing the records that were received by that input view.

Note that this Snap does not complete executing until the execution of all upstream Snaps is done.

Note

Unless the Ignore Empty Streams checkbox empty stream checkbox is selected, the Gate Snap always produces an output document, regardless of how many or if no input documents are received. In some Pipeline designs, this functionality can trigger an error message stating, mapped variables are missing, during validation. This error typically occurs when a downstream Snap expects a field based off an output document from the Gate Snap that is empty.

To prevent the error from occurring, you can limit empty documents produced by the Gate Snap by inserting a Filter Snap after it with the following expression in the Filter Expression
required
field:

!$.isEmpty()

When you run the Pipeline after adding the Filter Snap with this expression, the Pipeline validates and executes successfully, and the error no longer occurs.

...

Parameter NameData TypeDescriptionDefault ValueExample 
LabelStringThe 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.GateEnsure Complete Execution

Snap Execution

String

Specifies the execution type:

  • Validate & Execute: Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.
  • Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.
  • Disabled: Disables the Snap and, by extension, its downstream Snaps.

Validate & ExecuteN/A
Ignore Empty Streamempty streamCheckboxEnables you to indicate whether you want the Snap to ignore empty streams received at the input view during Pipeline execution. If this option is selected, the Snap does not produce any output document; else, the Snap writes an empty array to the output document.Not selectedN/A

Examples

Combining Completed Upstream Execution Output Using the Gate Snap

...