Versions Compared

Key

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

...

The Filter Snap filters a document stream based on an a Filter expression. If the filter expression evaluates to true, then the document will be is passed - through. If the filter expression evaluates to false, then the document will be is dropped in the stream. Expressions that do not evaluate to a boolean value will cause the pipeline to fail. Learn more about Expression functions.

...

Info
  • The Router and Filter Snaps are similar, but the Filter Snap handles only handles a single stream. The Router Snap is designed to handle multiple output views.

  • You do not require accounts to use this Snap.

...

The Filter Snap is a Flow - type Snap.

Support for Ultra Pipelines

...

Info

When using the Filter Snap in an ultra Ultra Task pipeline, the pipeline returns an empty response if the Snap filters the incoming document.

...

Field 

Field Type

Description

Label*


Default Value: Filter
Example: Filter

String

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.

Null-safe access


Default Value: Deselected

Checkbox

Select this checkbox to consider the missing data or empty value as null when accessing the source path.

If you deselect this checkbox, the Snap fails and displays error in case there is missing data or empty value when accessing the source path.

Filter Expression*

Default Value: None
Examples:

$first_name = = "Joe"
$people[0].age > 15
$Customers.contains(_customer)

startsWith($description, "Snap") && $quantity < 100 

String/Expression

The Enter the expression to evaluatefilter the documents. If this the expression evaluates to true, then the document will be is passed through. OtherwiseElse, the document will be dropped. is not passed through.
If the expression does not evaluate to a boolean, then the pipeline will failfails.

Snap Execution


Default Value: Validate & Execute
Example: Execute Only

Dropdown list

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

...