Free cookie consent management tool by TermsFeed

a!queryColumn() Function

On This Page

Function

a!queryColumn( field, alias, visible )

Creates a Column object for use inside a Selection object.

See also: Column, Selection, Query

Parameters

Keyword Type Description

field

Text

The field of the data type you want to retrieve. The fields available depend on the source of the data and the data type of that source.

alias

Text

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

visible

Boolean

Determines whether the 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.

Returns

Column

Usage considerations

Using the fields parameter

  • The field parameter is required.
  • Fields that are children of a multiple cannot be selected.

Using the alias parameter

  • If no alias is given, the alias for the column will be inferred as the field value.
  • If the alias is not provided and the field name collides with another existing alias, the field name will be suffixed with an incremented digit appended to the end when returned in the result.

Examples

In this example, we create three Column object. The first retrieves the firstName field. The second retrieves the lastName field and makes it accessible with the alias familyName in query results. The third column for employeeId is hidden from end users, but it can still be used for sorting.

1
2
3
4
5
6
7
8
9
10
11
12
13
a!queryEntity(
  entity: cons!MY_DATA_STORE_ENTITY,
  query: a!query(
    selection: a!querySelection(
      columns: {
        a!queryColumn(field: "firstName"),
        a!queryColumn(field: "lastName", alias: "familyName"),
        a!queryColumn(field: "employeeId", visible: false)
      }
    ),
    pagingInfo: a!pagingInfo(startIndex: 1, batchSize: 10)
  )
)

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 Interfaces Partially compatible

Can be used with offline interfaces if loaded at the top of the interface.

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

Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.

Process Reports Incompatible

Cannot be used to configure a process report.

Process Events Partially compatible

If autoscale is enabled, can be used to configure a supported process event node (such as a start event or timer event).

Process Autoscaling Compatible

Can be used in autoscaled processes.

Event Consumer Filter Conditions Incompatible

Cannot be used in filter conditions.

Event Consumer Event Handlers Incompatible

Cannot be used in event handler expressions.

Feedback