a!queryAggregationColumn() Function

Function

a!queryAggregationColumn( field, alias, visible, isGrouping, aggregationFunction, groupingFunction )

Creates an AggregationColumn object for use inside an Aggregation object.

See also: Aggregation, AggregationColumn, Query

Parameters

Keyword Type Description

field

Text

The dot-notation to the field of the data, such as a record type, you want to group together and/or aggregate. The fields cannot be complex or multiple values.

alias

Text

The short name by which the result of the AggregationColumn value can be referenced in other places of the Query value. Values are case-sensitive.

visible

Boolean

Determines whether the grouping or aggregation column should be visible to end users. If false, the data for the column will not be retrieved, but it can be used for sorting. Default value is true.

isGrouping

Boolean

Determines whether the field should be grouped. Default value is false.

aggregationFunction

Text

The function to use when aggregating the field. Valid values include COUNT, SUM, AVG, MIN, and MAX. Requires isGrouping to be false.

groupingFunction

Text

A function that can be applied on the selected field. Valid values are YEAR and MONTH. This parameter can only be used with Date and Date and Time data types. Requires isGrouping to be true.

Returns

AggregationColumn

Open in Github Built: Fri, Sep 17, 2021 (04:05:09 PM)

On This Page

FEEDBACK