ForEach in Group Step
- 22 Jan 2025
- 1 Minute to read
- Print
- DarkLight
ForEach in Group Step
- Updated on 22 Jan 2025
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
Step Details | |
| Introduced in Version | 3.0.0 |
| Last Modified in Version | 9.7.0 |
| Location | Flow Management > Iteration |
The ForEach in Group step groups a list of objects for a datatype based on a specific field. Any items that have matching values in the field will be grouped together and outputted as a group. The step will iterate through each group before reaching completion.
Properties
Data
| Property | Description | Data Type |
|---|---|---|
| Type | The datatype that will be used by the step. This field will be automatically updated based on the Collection input | --- |
| Get Field to Group By From Input | Enabling this moves the "Field to Group By" property to the Inputs section, allowing for dynamic grouping. | Boolean |
| Field to Group By | Select the data field to group the objects by. | --- |
Inputs
| Property | Description | Data Type |
|---|---|---|
| Field to Group By | The specified field in the datatype to group by. Any values that have a match on this field will | String |
| Collection | The list of objects that will be grouped by the step. | List of Object |
Outputs
| Property | Description | Data Type |
|---|---|---|
| Each Grouping | The outputted lists based on matching values for a field. | --- |
Step Changes
| Description | Version | Release Date | Developer Task |
|---|---|---|---|
| Added "Get Field To Group By From Input" setting. | 9.7 | February 2025 | [DT-021003] |
Was this article helpful?
