Skip to main content
Version: 8.1

groupConcat

This function is used by Ignition's Expression language.

Description

Concatenates all of the values in the given column of the given dataset into a string, with each value separated by the string separator. Any null values in the column are ignored.

Syntax (index)

groupConcat(dataset, columnIndex, separator)

  • Parameters

    • DataSet dataset - The starting dataset.

    • Integer columnIndex - The index of the column to concatenate.

    • String separator - What will be used to separate each of the values.

  • Returns

    • String - A string with every value in the specified column of the specified dataset separated by the separator value.

Syntax (name)

groupConcat(dataset, columnName, separator)

  • Parameters

    • DataSet dataset - The starting dataset.

    • String columnname - The name of the column to concatenate.

    • String separator - What will be used to separate each of the values.

  • Returns

    • String - A string with every value in the specified column of the specified dataset separated by the separator value.

Syntax (collection)

New in 8.1.8
The following overload was introduced in 8.1.8.

groupConcat(collection, separator)

  • Parameters

    • Collection collection - The starting list, tuple, or set to use.

    • String separator - What will be used to separate each of the values.

  • Returns

    • String - A string with every value in the specified collection separated by the separator value.

Examples

Suppose you had a table with this dataset in it:

ProductCodeQuantityWeight
BAN_0023803.243
BAN_0101209.928
APL_0001251.287
FWL_2203227.889
Code Snippet
groupConcat({Root Container.Table.data}, 1, " / ")  //would return the string: "380 / 120 / 125 / 322"
Code Snippet
groupConcat({Root Container.Table.data}, "ProductCode", ", ")  //would return the string: "BAN_002, BAN_010, APL_000, FWL_220"