a!sortInfo() Function

Function

a!sortInfo( field, ascending )

Creates a value of type SortInfo for use with grids and record queries.

See also: SortInfo, Read-Only Grid, a!queryRecordtype, a!relatedRecordData(), a!pagingInfo()

Parameters

Keyword Type Description

field

Any Type

The name of the field used to sort by. When sorting record data, use the recordType! domain to reference a record field or related record field. For example, recordType!Case.fields.caseName. When sorting on aggregate data, you must use the alias as the sort field if an alias is defined in the groupings or measures.

ascending

Boolean

Determines what order the data is sorted in. Sorted in ascending order when the value is true and descending order when the value is false. Default: false.

Returns

SortInfo

Usage considerations

Supported data types

  • Sorting is only supported for complex data types and is not supported for a dictionary array.

Sorting on aggregated data

  • If an alias is defined in the grouping or measure, you must provide the alias as the sort field.

  • You can add multiple sort fields on line, bar, and [column] charts that uses a record type as the source. See Configure Charts Using Records for more information.

When applying a sort to the a!relatedRecordData() function, you must reference record fields or related record fields from the related record type specified in the relationship parameter of the function.

See Filtering and sorting the related record set for more information.

Examples

You can copy and paste these examples into the Expression Rule Designer to see how this works.

1
2
3
4

	=a!sortInfo(
	  field: "name",
	  ascending: true()
	)

Returns

1
2

	[field=name,
	 ascending=true]
Open in Github Built: Fri, Jan 21, 2022 (10:26:32 AM)

On This Page

FEEDBACK