--- title: "Collection Filter Steps" slug: "rule-collection-filter-step" tags: ["rule", "rule collection filter"] updated: 2025-07-09T15:10:09Z published: 2025-07-09T15:10:09Z canonical: "documentation.decisions.com/rule-collection-filter-step" --- > ## Documentation Index > Fetch the complete documentation index at: https://documentation.decisions.com/llms.txt > Use this file to discover all available pages before exploring further. # Collection Filter Steps | ## 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](https://documentation.decisions.com/v8/docs/showing-hidden-or-deleted-items-in-a-folder). --- ## 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] | #### ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2022-08-19_10h55_41.png) --- ## How to Best Use Collection Filter Steps The below video has detailed information on how to get the most out of Collection Filter Steps. [Embedded content](https://www.youtube.com/embed/DlX45MBA6MY?&wmode=opaque&rel=0) --- Collection Filter step Inputs: | Input name | Description | | --- | --- | | Expose Flow Data | Boolean value. Passes the Flow Data to the parent Flow | | Type | Specifies the data type which will be used by the step | | Input Collection | The inputted list for the data type | | Edit Collection Filter step | Allows the user to edit the inputs for the step | Outputs: | Output name | Description | | --- | --- | | Filtered Array | Outputs the resulting list of the specified datatype | The following example will demonstrate how the Collection Filter step can be used to filter a list of Accounts and output only Accounts whose last name starts with "B". 1. [Create a new Flow](https://documentation.decisions.com/v9/docs/creating-your-first-flow-2) 2. Search for the **Fetch Entities** step and output a list of Accounts. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h35_05.png) 3. Open **Data -> Lists** and find and search for the **Collection Filte****r** step. Add the step to the workspace. 4. Set the **Type** to String and select the list of last names as the **Input Collection**. 5. With the step selected, choose **Edit Flow**.![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h36_52.png) 6. In the toolbox, expand **Data > Texts** and add the **String Starts With** step onto the workspace. Define the step inputs, using Entity in the **Input** field. 7. Connect the outcome paths to the corresponding end step ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h38_57.png) 8. Debug the Flow to view the outputted list. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/image-1649871407226.png) --- ## Rule Collection Filter Inputs: | Input Name | | | --- | --- | | Expose Flow Data | Boolean value. Passes the Flow Data to the parent Flow | | Type | Specifies the input and outputted data type used by the step | | Data to Return | This setting determines what items will be included in the outputted list for the step, either items that evaluate as True (Return Matches), False (Return NonMatches) or outputs both as separate lists (Return Matches and NonMatches). | | Input Collection | The list of the specified datatype | Outputs: | Output name | Description | | --- | --- | | Output | Outputs a filtered list of the specified datatype | The following example will demonstrate how the Rule Collection Filter step can filter a list of food items to only show the ones that contain "Chicken". 1. In a Designer Project, [Create a new Flow](/v9/docs/creating-your-first-flow-2). 2. Click the **Done** path on the **Start** step. Navigate to **All Steps [Catalog] > Data > List** and select the **Add Item to List** step. Click ADD. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h40_50.png) 3. On the **Properties** panel, change the mapping of the **New Item** and **Original List** fields by clicking **Unknown** and selecting **Constant**. In the New Item Field, enter "Chicken Alfredo". In the Original List field, enter "Shrimp Scampi", "Chicken Nuggets", "Beef Stew", and "Lasagna". ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h42_11.png) 4. Click the Done path and navigate to **All Steps [Catalog] > Data > List**. Select the **Rule Collection Filter Step** step and click ADD. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h43_01.png) 5. On the Properties panel, map the **Input Collection** field to **Select From Flow**. Select **New List** and click DONE. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h43_54.png) 6. On the Properties panel, click EDIT RULE.![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h44_10.png) 7. In the Rule Designer, click **Select Data Element**. Select **Entity** and click NEXT.![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h44_53.png)The Entity is a single item from the **Input Collection** established within the Flow. 8. From the Verb window, select **Contains** and click NEXT.![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h45_14.png) 9. In the **value** field, enter "Chicken" and click DONE. Click **Save** and close the Rule Designer.![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h45_40.png) 10. Connect the Done path to the **End** step. Click Save to save changes to the Flow. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h46_08.png) 11. Click **Debug** from the top action bar. 12. Click START DEBUGGING. 13. After the debugger runs, select the Rule Collection Filter step, select **Execution 1**, and click **View Input/Output**. The Output from Rule Collection Filter Step lists the items containing the word Chicken.![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h46_49.png) Related Information Example Labs: [Using a Collection Filter Step](https://documentation.decisions.com/projects/docs/using-a-collection-filter-step) [Using a Rule Collection Filter Step](https://documentation.decisions.com/projects/docs/using-rule-collection-filter-step) Forum Posts: [Flow To Calculate The Earliest Of Multiple Dates](https://community.decisions.com/discussion/29253/flow-to-calculate-the-earliest-of-multiple-dates)