---

Purpose

Groups a List.In Legacy Mode, if a table of values is provided, e.g. A^B^2021-03-12;A^B^2021-03-11;A^B^2021-03-09;A^C^2021-03-12;A^C^2021-03-11, then specify the columns you wish to group by with groupByColumnIndices, zero-indexed and the output columns you want with outputColumns. In Normal Mode, you must provide a JArray (in 'values' and the properties you want to group by.

---

Macro Compatibility

---

Parameter	Type	Deprecation Message	Preferred Parameter	Presence	Purpose	Options	Default
values	List<Object>			Mandatory	The list of input values. In Legacy Mode, they should be split by the delimiter character.	N/A	N/A
aggregations Normal mode	List<String>			Optional	In Normal Mode only, the aggregations in the form: Property1^Aggregation;Property2^Aggregation;... OR Property1^Aggregation^OutputName;Property2^Aggregation^OutputName;... For more information about using aggregations, see: using aggregations in the help.	All Count First Last Max Mean Min Sum	N/A
calculate	String			Optional	Post processing formula. Use {value} for the macro output, e.g. {value}/1024.	N/A	N/A
colorTableCell	Boolean			Optional	Whether to color table cells if thresholds are breached, rather than color the text.	true false	true
comment	String			Optional	Add a comment to make your document template more readable. The comment is discarded in the output document.	N/A	N/A
comparison	List<String>	Deprecated	comparisons		In 'normal' mode only, the comparisons that are jsonPaths. For multiple items, separate by a semi-colon e.g. property1;property2;...	N/A	N/A
comparisons	List<String>	Use instead of: comparison		Optional	In 'normal' mode only, the comparisons that are jsonPaths. For multiple items, separate by a semi-colon e.g. property1;property2;...	N/A	N/A
condition	String			Optional	The condition that must be true, using 'value'.	N/A	N/A
criticalAfter	DateTimeOffset			Optional	The macro is considered 'critical' if the output is after this DateTime UTC.	N/A	N/A
criticalBefore	DateTimeOffset			Optional	The macro is considered 'critical' if the output is before this DateTime UTC.	N/A	N/A
criticalEq	String			Optional	The macro is considered 'critical' if the output is equal to this value.	N/A	N/A
criticalFontBackgroundColor	Color			Optional	The critical font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
criticalFontBold	Boolean			Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
criticalFontColor	Color			Optional	The critical font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
criticalFontSize	Double			Optional	Change the critical font size in points. If omitted, no change is made.	From 2 to 200	N/A
criticalGe	String			Optional	The macro is considered 'critical' if the output is greater than or equal to this value.	N/A	N/A
criticalGt	String			Optional	The macro is considered 'critical' if the output is greater than this value.	N/A	N/A
criticalIf	String			Optional	The macro is considered 'critical' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
criticalLe	String			Optional	The macro is considered 'critical' if the output is less than or equal to this value.	N/A	N/A
criticalLt	String			Optional	The macro is considered 'critical' if the output is less than this value.	N/A	N/A
criticalNe	String			Optional	The macro is considered 'critical' if the output is not equal to this value.	N/A	N/A
criticalTableCellBackgroundColor	Color			Optional	The critical table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
delimiter	Char			Optional	The delimiter character to delimit text-based input lists (e.g. 1;2;3;4). When this parameter is set and 'listDelimiter' is NOT set, this acts as both the input and output list delimiter.	N/A	;
errorAfter	DateTimeOffset			Optional	The macro is considered 'error' if the output is after this DateTime UTC.	N/A	N/A
errorBefore	DateTimeOffset			Optional	The macro is considered 'error' if the output is before this DateTime UTC.	N/A	N/A
errorEq	String			Optional	The macro is considered 'error' if the output is equal to this value.	N/A	N/A
errorFontBackgroundColor	Color			Optional	The error font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
errorFontBold	Boolean			Optional	Change the error font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
errorFontColor	Color			Optional	The error font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
errorFontSize	Double			Optional	Change the error font size in points. If omitted, no change is made.	From 2 to 200	N/A
errorGe	String			Optional	The macro is considered 'error' if the output is greater than or equal to this value.	N/A	N/A
errorGt	String			Optional	The macro is considered 'error' if the output is greater than this value.	N/A	N/A
errorIf	String			Optional	The macro is considered 'error' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
errorLe	String			Optional	The macro is considered 'error' if the output is less than or equal to this value.	N/A	N/A
errorLt	String			Optional	The macro is considered 'error' if the output is less than this value.	N/A	N/A
errorNe	String			Optional	The macro is considered 'error' if the output is not equal to this value.	N/A	N/A
errorOnOverflow	Boolean			Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
errorTableCellBackgroundColor	Color			Optional	The error table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
failureText	String			Optional	The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message.	N/A	N/A
fatalAfter	DateTimeOffset			Optional	The macro is considered 'fatal' if the output is after this DateTime UTC.	N/A	N/A
fatalBefore	DateTimeOffset			Optional	The macro is considered 'fatal' if the output is before this DateTime UTC.	N/A	N/A
fatalEq	String			Optional	The macro is considered 'fatal' if the output is equal to this value.	N/A	N/A
fatalFontBackgroundColor	Color			Optional	The fatal font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fatalFontBold	Boolean			Optional	Change the fatal font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fatalFontColor	Color			Optional	The fatal font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fatalFontSize	Double			Optional	Change the fatal font size in points. If omitted, no change is made.	From 2 to 200	N/A
fatalGe	String			Optional	The macro is considered 'fatal' if the output is greater than or equal to this value.	N/A	N/A
fatalGt	String			Optional	The macro is considered 'fatal' if the output is greater than this value.	N/A	N/A
fatalIf	String			Optional	The macro is considered 'fatal' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
fatalLe	String			Optional	The macro is considered 'fatal' if the output is less than or equal to this value.	N/A	N/A
fatalLt	String			Optional	The macro is considered 'fatal' if the output is less than this value.	N/A	N/A
fatalNe	String			Optional	The macro is considered 'fatal' if the output is not equal to this value.	N/A	N/A
fatalTableCellBackgroundColor	Color			Optional	The fatal table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontBackgroundColor	Color			Optional	The font background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontBold	Boolean			Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fontColor	Color			Optional	The font color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontSize	Double			Optional	Change the font size in points. If omitted, no change is made.	From 2 to 200	N/A
format	String			Optional	The formatting to use for numbers. You can also specify 'format=string' to force numbers to be treated as strings.	N/A	N/A
groupByColumnIndices Legacy mode	List<String>			Optional	In Legacy mode only, the zero-indexed columns to group by. e.g. '0;3;1'.	N/A	N/A
groupByObjectProperties Normal mode	List<String>			Optional	In Normal Mode only, the properties to group by, e.g. 'Property1;Property2;...'. When you use this parameter, do not use the 'groupByColumnIndices' or 'outputColumnSpecs' parameters. The macro will fail if you do not set this parameter in Normal mode.	N/A	N/A
hidden	Boolean			Optional	Whether to hide the macro output.	true false	false
if	String			Optional	The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z').	N/A	true
includeWhitespaceItems	Boolean			Optional	Whether to include whitespace items.	true false	true
indexDelimiter	Char			Optional	The index delimiter.	N/A	^
infoAfter	DateTimeOffset			Optional	The macro is considered 'info' if the output is after this DateTime UTC.	N/A	N/A
infoBefore	DateTimeOffset			Optional	The macro is considered 'info' if the output is before this DateTime UTC.	N/A	N/A
infoEq	String			Optional	The macro is considered 'info' if the output is equal to this value.	N/A	N/A
infoFontBackgroundColor	Color			Optional	The info font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
infoFontBold	Boolean			Optional	Change the info font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
infoFontColor	Color			Optional	The info font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
infoFontSize	Double			Optional	Change the info font size in points. If omitted, no change is made.	From 2 to 200	N/A
infoGe	String			Optional	The macro is considered 'info' if the output is greater than or equal to this value.	N/A	N/A
infoGt	String			Optional	The macro is considered 'info' if the output is greater than this value.	N/A	N/A
infoIf	String			Optional	The macro is considered 'info' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
infoLe	String			Optional	The macro is considered 'info' if the output is less than or equal to this value.	N/A	N/A
infoLt	String			Optional	The macro is considered 'info' if the output is less than this value.	N/A	N/A
infoNe	String			Optional	The macro is considered 'info' if the output is not equal to this value.	N/A	N/A
infoTableCellBackgroundColor	Color			Optional	The info table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
listDelimiter	Char			Optional	In Legacy Mode only, the delimiter character to delimit the output list, UNLESS only 'delimiter' is set, in which case 'delimiter' acts as both the input and output list delimiter.	N/A	;
mode	MacroMode			Optional	The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
normalFontBackgroundColor	Color			Optional	The normal font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
normalFontBold	Boolean			Optional	Change the normal font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
normalFontColor	Color			Optional	The normal font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
normalFontSize	Double			Optional	Change the normal font size in points. If omitted, no change is made.	From 2 to 200	N/A
normalTableCellBackgroundColor	Color			Optional	The normal table cell background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
obfuscation	ObfuscationType			Optional	Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen.	None UkTown DeviceName Company IpAddress PrivateIpAddress	None
order	List<String>	Deprecated	orderDirection		The semicolon-separated order directions. Each must be one of: Ascending, Asc, Descending or Desc.	N/A	None
orderByIndex	List<Int32>	Deprecated	orderByIndices		The semicolon-separated ordered list of columns to order by. The first is 0. e.g. 0;2;1	N/A	N/A
orderByIndices	List<Int32>	Use instead of: orderByIndex		Optional	The semicolon-separated ordered list of columns to order by. The first is 0. e.g. 0;2;1	N/A	N/A
orderDirection	List<String>	Use instead of: order		Optional	The semicolon-separated order directions. Each must be one of: Ascending, Asc, Descending or Desc.	N/A	None
outputColumnSpecs Legacy mode	List<String>			Optional	In Legacy mode only, the output column specifications in the form: columnIndex^orderType^orderDirection e.g. '0^alphanumeric^asc;1^numeric^desc.	N/A	N/A
outputListsAsJarray Normal mode	Boolean			Optional	Any macros that output lists can optionally (in Normal mode) output a jArray instead.	true false	true
redact	Boolean			Optional	Whether substituted variables are hidden from macro results (and the word 'REDACTED' will appear in progress screens and elsewhere in the web UI).	true false	false
selectDistinct	Boolean			Optional	Whether to exclude duplicates.	true false	false
singleValueList Normal mode	Boolean			Optional	In Normal Mode and for macros that output JArrays only, whether to convert a JArray of single-property jObjects into a flat JArray of values.	true false	false
skip	Int32			Optional	The number of items AFTER the sort to skip.	N/A	0
sortType	List<String>	Deprecated	sortTypes		The semicolon-separated sort types. Each must be one of Alphanumeric, Numeric or Auto. The default (Auto) will attempt a numeric sort if all the values are numeric, otherwise falls back to alphanumeric.	N/A	Auto
sortTypes	List<String>	Use instead of: sortType		Optional	The semicolon-separated sort types. Each must be one of Alphanumeric, Numeric or Auto. The default (Auto) will attempt a numeric sort if all the values are numeric, otherwise falls back to alphanumeric.	N/A	Auto
storeAs	String			Optional	The variable to store the result as.	N/A	N/A
storeAsHidden	String			Optional	The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'.	N/A	N/A
storeAsVariableDelimiter	Char			Optional	The delimiter used by storeAs to split the input (Legacy mode only), when there are multiple stored variables. For example, in this macro, we indicate that the value to be stored should be split by the asterisk when being stored: [String:value=a*b*c*d, storeAs=var1;var2;var3;var4, storeAsVariableDelimiter=*]	N/A	;
storeFormattedValueAs	String			Optional	The name of the STRING variable to store the result as and output (both will use the same format) into the report. Note that if you also use 'storeAsHidden' in the same macro, you should not expect the output to be hidden, as this parameter overrides that.	N/A	N/A
stringListSortType	StringListSortType			Optional	The sort method to use. This can be used to adjust the sort order used by the system.	OrdinalIgnoreCase Ordinal InvariantCulture InvariantCultureIgnoreCase	OrdinalIgnoreCase
take	Int32			Optional	The number of items AFTER the sort to take.	N/A	2147483647
trimWhitespace	Boolean			Optional	Whether to trim leading and trailing whitespace on input items. The trim operation is done BEFORE other operators such as selecting distinct items or sorting.	true false	false
warning	String			Optional	If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression.	N/A	N/A
warningAfter	DateTimeOffset			Optional	The macro is considered 'warning' if the output is after this DateTime UTC.	N/A	N/A
warningBefore	DateTimeOffset			Optional	The macro is considered 'warning' if the output is before this DateTime UTC.	N/A	N/A
warningEq	String			Optional	The macro is considered 'warning' if the output is equal to this value.	N/A	N/A
warningFontBackgroundColor	Color			Optional	The warning font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
warningFontBold	Boolean			Optional	Change the warning font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
warningFontColor	Color			Optional	The warning font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
warningFontSize	Double			Optional	Change the warning font size in points. If omitted, no change is made.	From 2 to 200	N/A
warningGe	String			Optional	The macro is considered 'warning' if the output is greater than or equal to this value.	N/A	N/A
warningGt	String			Optional	The macro is considered 'warning' if the output is greater than this value.	N/A	N/A
warningIf	String			Optional	The macro is considered 'warning' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
warningLe	String			Optional	The macro is considered 'warning' if the output is less than or equal to this value.	N/A	N/A
warningLt	String			Optional	The macro is considered 'warning' if the output is less than this value.	N/A	N/A
warningNe	String			Optional	The macro is considered 'warning' if the output is not equal to this value.	N/A	N/A
warningTableCellBackgroundColor	Color			Optional	The warning table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A

---

Examples (7)

Example 1: Normal mode

This example uses the [Calculate:] macro to construct the initial JArray.

// Firstly, create a JArray:
[Calculate:
	value=`list(
		jObject('Name', 'Y', 'Location', 'Yloc', 'Count', 2),
		jObject('Name', 'X', 'Location', 'Xloc1', 'Count', 1),
		jObject('Name', 'X', 'Location', 'Xloc2', 'Count', 2),
		jObject('Name', 'OMIT', 'Location', 'Nowhere', 'Count', 10)
	)`,
	mode=normal,
	outputListsAsJarray=true,
	=>TheList
]

// Now group by Name and store as a variable called Output7. Aggregating on the first Location and the Sum of the Count
[List.GroupBy:
	values=`{=TheList}`,
	groupByObjectProperties=Name,
	aggregations=Location^First^Location;Count^Sum^TotalCount,
	condition=`jPath(value, 'Name') != 'OMIT'`,
	mode=normal,
	=>Output7
]

---

Example 2: Legacy mode

This Legacy mode example provides input data in standard tabular format, then groups by the first two columns. The output columns are: i) the first value of the first column (this column is used in the group-by, so will be the same as the last, min or max, within the group) ii) the first value of the next column (this column is also used in the group-by, so see above) iii) the count of items in the group (Note: the first column is used. If a count of non-nulls is required, count a nullable column) iv) the first value of the last column, within the group. The result is ordered by: the second column (column 1) descending, then the third column (column 2) descending and finally the first column (column 0) ascending.Only the first 3 resultant values are used, due to the 'take' parameter.

[String: value=`A^B^2021-03-12;A^B^2021-03-11;A^B^2021-03-09;A^B^2021-03-10;A^B^2021-03-08;A^B^2021-03-07;A^C^2021-03-12;A^C^2021-03-11;B^Z^2021-03-12;C^Z^2021-03-12;D^Z^2021-03-12;E^Z^2021-03-12`, =>Input]
[List.GroupBy: values=`{Input}`, groupByColumnIndices=0;1, mode=Legacy, outputColumnSpecs=0^first;1^first;0^count;2^first, orderByIndices=1;2;0, sortTypes=numeric;alphanumeric;alphanumeric;alphanumeric, orderDirection=Desc;Desc;Asc;Asc, take=3, storeAs=Output1]

Outputs:

A^B^6^2021-03-12;A^C^2^2021-03-12;B^Z^1^2021-03-12

---

Example 3: Legacy mode

This Legacy mode example demonstrates the min, max, first, last, sum and count aggregations for numeric values. Note that items with a missing value in the fifth row, third column (column 2) do NOT contribute to the count or the sum and the macro does not error on missing numeric values.

[String: value=`A^B^2;A^B^3;A^B^1;A^C^1;A^C^;A^C^3`, =>Input]
[List.GroupBy: values=`{Input}`, groupByColumnIndices=0;1, mode=Legacy, outputColumnSpecs=0^first;1^first;2^min;2^max;2^first;2^last;2^sum;2^count, orderByIndices=0;1;2,sortTypes=auto;numeric;numeric, orderDirection=Asc;Desc;Desc, storeAs=Output2]

Outputs:

A^B^1^3^2^1^6^3;A^C^1^3^1^3^4^2

---

Example 4: Legacy mode

This Legacy mode example demonstrates the min, max, first, last, sum and count aggregations for alphanumeric values. Note that items with a missing value in the fifth row, third column (column 2) do NOT contribute to the count and the macro does not error on missing numeric values. Note also that the sum of a mixture of alphanumeric and numeric values only uses the numeric values.

[String: value=`A^B^Y;A^B^Z;A^B^X;A^C^1;A^C^;A^C^Z`, =>Input]
[List.GroupBy: values=`{Input}`, groupByColumnIndices=0;1, mode=Legacy, outputColumnSpecs=0^first;1^first;2^min;2^max;2^first;2^last;2^sum;2^count, orderByIndices=0;1;2,sortTypes=auto;numeric;numeric, orderDirection=Asc;Desc;Desc, storeAs=Output3]

Outputs:

A^B^X^Z^Y^X^^3;A^C^1^Z^1^Z^1^2

---

Example 5: Legacy mode

In this Legacy mode example, order by the second column, but treat the number as a string only by using 'format=string', i.e. this means the macro does not strip any leading zeros

[List.GroupBy: values=`ABC^01154756^DEF`, format=string, groupByColumnIndices=1, mode=Legacy, outputColumnSpecs=1^first, orderByIndices=0, orderDirection=Asc, sortType=Alphanumeric, storeAs=Output4]

Outputs:

01154756

---

Example 6: Legacy mode

Legacy mode example:

[List.GroupBy: values=`Device1^1^1^5;Device1^7^5^6;Device2^1^1^1;Device2^2^2^3^;Device3^5^8^12`, mode=Legacy, groupByColumnIndices=0, outputColumnSpecs=0^first;1^first;2^sum;3^last, orderByIndices=0, storeAs=Output5]

Outputs:

Device1^1^6^6;Device2^1^3^3;Device3^5^8^12

---

Example 7: Legacy mode

This Legacy mode example demonstrates the use of the 'condition' parameter:

[List.GroupBy: values=`Device1^1^1^5;Device1^7^5^6;Device2^1^1^1;Device2^2^2^3^;Device3^5^8^12`, mode=Legacy, groupByColumnIndices=0, outputColumnSpecs=0^first;1^first;2^sum;3^last, orderByIndices=0, condition="!contains(value, 'Device1^')", storeAs=Output6]

Outputs:

Device2^1^3^3;Device3^5^8^12