a!dataSubset() Function

Function

a!dataSubset( startIndex, batchSize, sort, totalCount, data, identifiers )

Creates a value of type DataSubset for defining the source of expression-backed records and for use with a!pickerFieldCustom, leaving the data as provided. To apply sorting and paging, use todatasubset().

See also: DataSubset

Parameters

Keyword	Type	Description
`startIndex`	Integer	The index of the first item to be returned in the subset.
`batchSize`	Integer	The number of items to be returned in the subset.
`sort`	SortInfo Array	Valid values include `null`, or a `SortInfo` where `<SortInfo>.field` is the name of a field on the input array elements or "dot" notation for a nested field.
`totalCount`	Integer	The number of items in total.
`data`	Any Type Array	The data to be returned in the subset.
`identifiers`	Any Type Array	A parallel list of unique identifiers for each item in the subset.

Returns

DataSubset

Examples

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

	=a!dataSubset(
       startIndex: 1,
       batchSize: 4,
       sort: a!sortInfo(
         field: "name",
         ascending: true()
       ),
       totalCount: 10,
       data: {"a", "b", "c", "d"},
       identifiers: {1, 2, 3, 4}
    )

returns

/returns-datasubset

Feature compatibility

The table below lists this function's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Compatible
Offline Mobile	Compatible
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	Incompatible	Cannot be used to configure a process event node, such as a start event or timer event.

Feedback

Was this page helpful?