View this page in the latest version of Appian. a!pagingInfo() Function Share Share via LinkedIn Reddit Email Copy Link Print On This Page Function a!pagingInfo( startIndex, batchSize, sort ) Creates a value of type PagingInfo for use with grids, queries, and todatasubset(). See also: PagingInfo, Read-Only Grid, a!sortInfo(), a!queryRecordType() Parameters Keyword Type Description startIndex Integer Index of the array in which to start returning values for the subset. Valid values include those greater than zero. batchSize Integer The number of items to return. When used with records, valid values are 0 to 5,000. When used with an entity, valid values include those greater than or equal to -1. See Using the batchSize parameter for more information about the allowed values. sort SortInfo Array Valid values include null, an empty array of SortInfo, or an array of SortInfo where <SortInfo>.field is the name of a field on the input array elements or "dot" notation for a nested field. Returns PagingInfo Usage considerations Using the startIndex parameter If the startIndex value is greater than the total number of items in the list the PagingInfo value is applied to, a null array is returned as the data. Using the batchSize parameter The batchSize parameter determines the number of items to return. Depending on the data you are querying, the valid values for a batchSize may vary. batchSize value Returns -1 All items are returned. This value is only supported in a!queryEntity(). 0 or null Only the totalCount and startIndex of the array are returned (no data). This value is only supported in a!queryEntity() and a!queryRecordType where the source is a database or Salesforce. >1 Returns the specified number of results, starting at the startIndex. If the batchSize is 0, the total count of records will be returned, but no data. If the batchSize value is -1, all items are returned. When People Functions contain PagingInfo, the batchSize parameter must be greater than or equal to zero; -1 is not a valid option. A batch size of 0 cannot be used for the following record types: Service-backed record types that have data sync disabled Process-backed record types Legacy record types Using the sort parameter If the sort value is not null or empty, the function your PagingInfo is applied to returns a subset of the input sorted by the field value of the SortInfo. If the value is null or empty, it returns an unsorted subset of the input. Examples You can copy and paste these examples into the Expression Rule Designer to see how this works. 1 2 3 4 5 6 7 8 a!pagingInfo( startIndex: 1, batchSize: 4, sort: a!sortInfo( field: "name", ascending: true() ) ) returns [startIndex=1, batchSize=4, sort=[field=name, ascending=true]] 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? SHARE FEEDBACK Loading...