Collection Filter Steps
  • 25 Apr 2022
  • 2 Minutes to read
  • Dark
    Light

Collection Filter Steps

  • Dark
    Light

Overview

The Collection Filter or Rule Collection Filter steps allow a user to create custom Rules or Flows to filter a list. The Collection Filter utilizes a Flow with two endsteps: Include in Collection and Exclude from Collection. The Rule Collection Filter can return matches, non matches or both. The steps can be found under the Data > Lists category.


Collection Filter step

Inputs:

Input nameDescription
Expose Flow DataBoolean value. Passes the Flow Data to the parent Flow
TypeSpecifies the data type which will be used by the step
Input CollectionThe inputted list for the data type
Edit Collection Filter stepAllows the user to edit the inputs for the step

Outputs:

Output nameDescription
Filtered ArrayOutputs 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
  2. Search for the Fetch Entities step and output a list of Accounts.

  3. Open Data -> Lists and find and search for the Collection Filtestep. 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.  
  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

  8. Debug the Flow to view the outputted list. 

Rule Collection Filter

Inputs:

Input Name
Expose Flow DataBoolean value. Passes the Flow Data to the parent Flow
TypeSpecifies 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 CollectionThe list of the specified datatype

Outputs:

Output nameDescription
OutputOutputs 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.
  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.


  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".


  4. Click the Done path and navigate to All Steps [Catalog] > Data > List. Select the Rule Collection Filter Step step and click ADD.


  5. On the Properties panel, map the Input Collection field to Select From Flow. Select New List and click DONE.


  6. On the Properties panel, click EDIT RULE.
  7. In the Rule Designer, click Select Data Element. Select Entity and click NEXT.
    The Entity is a single item from the Input Collection established within the Flow.
  8. From the Verb window, select Contains and click NEXT.
  9. In the value field, enter "Chicken" and click DONE. Click Save and close the Rule Designer.
  10. Connect the Done path to the End step. Click Save to save changes to the Flow.


  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.



    For further information on Flows, visit the Decisions Forum.

Was this article helpful?