Filter Tool
The Filter tool queries records by using an expression and splits data into two outputs: True, where the data meets the specified criteria, and False, where the data does not meet the specified criteria.
Use this tool to identify records in your data that meet a specified criteria. You may choose to handle records that come from the True output differently than the False output by connecting additional tools to the workflow on either side.
Configure the tool
Known limitation: large number handling
Numbers with more than 15 digits need to be treated as strings, or they lose their precision. Set the field type to a string using the Select Tool.
Select the type of filter to use.
- Basic filter: Use the basic filter to quickly build a simple query on a single column of data.
- Click Select column to select the data to filter on.
- In the next drop down, select the operator to use depending on the data type of the selected column.
- Complete the expression by typing a value or selecting the available date values.
- Select a dynamic option to automatically update the workflow to that relative date every time the workflow is run, or select a Fixed date.
- When creating an expression based on a date and related periods, select the Period type and the Number of periods to set the date range.
= | Value matches input |
!= | Value does not match input |
> | Value is greater than input |
>= | Value is greater than or equal to input |
< | Value is less than input |
<= | Value is less than or equal to input |
Is null | Value is a missing or unknown value |
Is not null | Value is not a missing or unknown value |
Equals | Value matches input |
Does not equal | Value does not match input |
Comes before (<) | Value sorts to come before input |
Comes after (>) | Value sorts to come after input |
Contains | Value is found in any part of the string |
Does not contain | Value is not found in any part of the string (case sensitive) |
Is null | Value is a missing or unknown value |
Is not null | Value is not a missing or unknown value |
Is empty | Value is Null or "" |
Is not empty | Value is not Null or "" |
= | Value matches input |
!= | Value does not match input |
> | Value is greater than input |
>= | Value is greater than or equal to input |
< | Value is less than input |
<= | Value is less than or equal to input |
Is empty | Value is Null or "" |
Is not empty | Value is not Null or "" |
Date range | Value is a selected start and end date |
Start date and periods after | Value is the selected first date and a set number of periods that follow |
End date and periods before | Value is the select last date and a set number of periods that precede |
= | Value matches input |
!= | Value does not match input |
> | Value is greater than input |
>= | Value is greater than or equal to input |
< | Value is less than input |
<= | Value is less than or equal to input |
Is empty | Value is Null or "" |
Is not empty | Value is not Null or "" |
Date range | Value is a selected start and end date |
Start date and periods after | Value is the selected first date and a set number of periods that follow |
End date and periods before | Value is the select last date and a set number of periods that precede |
Select Filter only Date data to truncate the Time data and filter using only the Date data.
Is null | Value is a missing or unknown value |
Is not null | Value is not a missing or unknown value |
Is null | Value is a missing or unknown value |
Is not null | Value is not a missing or unknown value |
Is true | Value is true |
Is false | Value is not true |
Is null | Value is a missing or unknown value |
Is not null | Value is not a missing or unknown value |
-
Custom filter: Use the custom filter to build a more complex expression or to query from multiple fields in the data stream.
Build an expressionUse any of these methods to build an expression:
- Type directly in the expression editor.
- Press Ctrl + Space to view a list of all functions.
- Type a word or phrase to view a matching list of functions.
- Type a [ (left bracket) to view a list of variables that can be used in the expression.
- Columns: Data from an incoming connection, or from a column created in a previous expression.
- Connections from Questions: Values from an Interface tool connected to the Question anchor of a tool with an expression editor, when the tool is used in an app or macro. Use the Question anchor when you want question values to be used as variables in the expression. See Interface Tools.
- Constants: Global variables for a workflow that make it possible to change a value in a single location and have that change apply to the rest of the workflow. See Constants.
- Click Functions to search and browse through categories of functions. See Functions.
- Click Columns and Constants to search and browse through incoming or newly created columns and constants.
- Click Recent and Saved Expressions to search and browse through recent and saved expressions.
VariablesSave an expressionOnce an expression has been built, it can be saved for use at a later time.
With an expression in the expression editor, click Save Expression, type a name, and click Save.
Because this tool includes an expression editor, an additional input anchor displays when the tool is used in an app or macro workflow. Use the Interface tools to connect to a Question anchor. See Interface Tools.