a!sortInfo() Function

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

Syntax

a!sortInfo( field, ascending )

  • 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. For example, recordType!Case.fields.caseName. When sorting data from a data store entity, use the field name in quotations. For example, "department".
  • ascending (Boolean): Determines whether the data sorts in ascending or descending order. Default is false, which means descending.

Returns

SortInfo

Notes

  • Sorting is only supported for complex data types and is not supported for a dictionary array.
  • When sorting on aggregated data, the field parameter can also accept the alias.

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

	[field=name,
	 ascending=true]

See Also

a!pagingInfo(): Use the a!sortInfo() function to create a value for the sort parameter of this function.

SortInfo: This is the data type the a!sortInfo() function returns.

Read-Only Grid: Use the a!sortInfo() function to sort the data for a grid component on an interface.

a!queryRecordtype: Use the a!sortInfo() function to sort the data queried from a record type.

Open in Github Built: Wed, Aug 10, 2022 (11:18:24 PM)

On This Page

FEEDBACK