Collection Filter Steps
- 20 Sep 2024
- 1 Minute to read
- Print
- DarkLight
Collection Filter Steps
- Updated on 20 Sep 2024
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Step Details | |
| Introduced in Version | --- |
| Last Modified in Version | --- |
| Location | Data > List |
The Collection Filter or Rule Collection Filter steps allow users to create custom Rules or Flows to filter a list. The Collection Filter utilizes a Flow with two end stops: Include in Collection and Exclude from Collection. The Rule Collection Filter can return matches, non-matches, or both. The Flow or Rule created by this step to filter the list is stored in the Folder View report by changing the Report view to include hidden items.
Properties
Inputs
| Input name | Description | Data Type |
|---|---|---|
| Expose Flow Data | Passes the Flow Data to the parent Flow | Boolean |
| Type | Specifies the data type which will be used by the step | Any selected Data Type |
| Input Collection | The inputted list for the data type | List of the selected Data Type |
| Edit [FlowName] Button | Opens the Flow or Rule that provides the logic for filtering | Flow or Rule |
| Data to Return *Only for Rule Collection Filter step | Return Matches will return all items that evaluate true. Return Matches and Non-Matches will return all items. Return Non-Matches will return all items that evaluate false. | --- |
Outputs
| Output name | Description | Data Type |
|---|---|---|
| Filtered Array | Outputs the resulting list of the specified datatype | List of [Data Type] |
How to Best Use Collection Filter Steps
The below video has detailed information on how to get the most out of Collection Filter Steps.
Related Information
Example Labs:
Using a Collection Filter Step
Using a Rule Collection Filter Step
Forum Posts:
Flow To Calculate The Earliest Of Multiple Dates
Was this article helpful?
