Entryset Filter
Introduction
The Entryset Filter selects entries in an entryset that meet particular conditions to create a new filtered entryset. It can filter the entries in two primary ways: by their data type or their value. Value conditions depend on the data type of the filtered attributes, but generally, comparisons of greater than, less than, or equality determine whether an entry is included in the resulting filtered entryset. Once an Entryset Filter is configured, the "Condition" input connectors can be used to change how a condition is applied from the Viewer.
Configuring the Entryset Filter
Connect an entryset to the "Set Entryset" input connector in order to enable the configuration of the Entryset Filter. For each condition defined in the Property Panel, select which attribute it filters. Multiple conditions can be configured for a single attribute. The basic filtering works by checking that the content of the attribute can be converted to the specified data type. If the attribute's data type does not match, that entry is removed from the resulting, filtered entryset. Selecting the "Where" check box allows entries to be filtered on more specific criteria than just the data type of an attribute. However, the comparisons for some specific criteria depend on the data type specified for the attribute. For example, the comparison of "January" and "February" depends on whether the values are treated as text or dates.
Property Panel:
- Combine filter conditions using
- Determines whether the final result should be generated by taking the AND or OR of the results of each condition.
- Conditions
- The list of conditions. Add new conditions to the filter by pressing the "Add" button. Remove conditions by selecting them and pressing the "Remove" button.
- Active
- Whether this condition is used to filter entries or not.
Edit Condition
- Filter entries using data in the attribute
- Specifies which attribute the filter conditions are applied to.
- The content of an attribute is
- Specifies which data type an attribute should be treated as. If the value of the attribute is not this data type or cannot be converted to it, the entry is filtered out of the result.
- Where
- Toggles whether a conditional comparison besides data type is used in filtering. Checking this box enables controls to perform more complex comparisons on the value of an attribute.
Input Menu:
Set Entryset
Sets the entryset that is filtered.
Accepted Datatypes:
- Entryset
Triggered Outputs:
- Output Message:
- Get Filtered Entryset
Set Active (Dynamic Menu)
Sets whether or not the filtering condition is active.
Accepted Datatypes:
- True/false
- True applies the condition to the entryset; false does not.
Triggered Outputs:
- Output Message:
- Get Filtered Entryset
Set Attribute Name (Dynamic Menu)
Sets which attribute the condition is applied to.
Accepted Datatypes:
- Text
- Name of an attribute in the entryset
Triggered Outputs:
- Output Message:
- Get Filtered Entryset
Output Menu:
Get Filtered Entryset
Gets an Entryset containing only the Entries from the original entryset that match the filter conditions.
Output Datatype:
- Entryset
- An entryset matching the attribute schema of the original, unfiltered entryset with entries that don't match the conditions filtered out.
Triggered By:
- Input Message:
- Set Entryset
- Action:
- Fire-On-Connect