Versions Compared

Key

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


Snap type:

Flow


Description:

This Snap filters a document stream based on a expression. If the filter expression evaluates to true, then the document will be passed-through. If the filter expression evaluates to false, then the document will be dropped in the stream. Expressions that do not evaluate to a boolean value will cause the pipeline to fail. 

Expression functions can be found here.

Router vs. Filter

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


Prerequisites:

[None]


Support and limitations:Works in Ultra Task Pipelines.
Account: 

Accounts are not used with this Snap.


Views:


InputThis Snap has exactly one document input view.
OutputThis Snap has exactly one document output view.
Error

This Snap has at most one document error view and produces zero or more documents in the view. 

In Spark mode:

  • the errors will be routed to error view documents if the error policy is defined as CONTINUE;
  • the execution will stop on first error if the error policy is defined as FAIL;
  • the execution will simply ignore the error if the error policy is defined as IGNORE.


    Settings

    Label

    required


    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.

    Filter Expression
    required 


    The expression to evaluate. If this expression evaluates to true, then the document will be passed through. Otherwise, the document will be dropped. If the expression does not evaluate to a boolean, then the pipeline will fail.

    Examples:

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

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


    Default value: [None]

    Multiexcerpt include macro
    nameSnap Execution
    pageAnaplan Read


    Multiexcerpt include macro
    nameSnap_Execution_Introduced
    pageAnaplan Read

    Example


    Excerpt Include
    Flow Snap Pack
    Flow Snap Pack
    nopaneltrue