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

Feature compatibility

The table below lists this function's compatibility with various features in Appian.
Feature Compatibility Note
Portals Partially compatible

Can be used with Appian Portals if it is connected using an integration and web API.

Offline Mobile Partially compatible

Can be used with offline mobile if it is loaded at the top of the form.

Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible
Process Reports Incompatible

You cannot use this function to configure a process report.

Process Events Incompatible

You cannot use this function to configure a process event node, such as a start event or timer event.

Open in Github Built: Mon, Dec 05, 2022 (08:15:39 PM)

On This Page

FEEDBACK