Collection Sort Step

Updated on 11 Oct 2024
1 Minute to read

Print
Share
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Step Details
Introduced in Version	---
Last Modified in Version	7.12.0
Location	Data > List

The Collection Sort or Rule Collection Sort steps allow users to create custom Rules or Flows to sort a list. The Collection Sort utilizes a Flow with three end steps: Entity First Sorts First, Entity Second Sort Second, and Entity First and Second Sorted the Same. 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

Property	Description	Data Type
Expose Flow Data	Makes the Flow Data within the Parent Flow available within the Sub-Flow that the sort logic is built in.	Boolean
Type	The desired data type that the step will evaluate.	---
Edit [Flow Name]_Collection Sort Step	Flow to build the logic to sort the list of items.	Flow
Input Collection	A list of items to pass into the Flow where the sort logic is built.	List of ---

Outputs

Property	Description	Data Type
SortedArray	List of Items that were sorted according to the logic within the Flow.	List of ---

How it Functions

The Collection Sort step creates an imbedded Subflow that creates the custom Rules and Flows within the main Flow. The Subflow is created by selecting the Edit [Flow Name]_Collection Sort Step button in the Inputs section within the Properties panel for the step. The below example shows what the Subflow would look like. The Subflow is implementing rules regarding the alphabetical placement of text within a list. The End steps are where the filtered results are routed, and then can be outputted to the main Flow for whatever purpose the user needs.