Allow API query for data pages
Improve performance for data pages that are used as the source of a table by designating the data page as queryable. The data page then loads only the necessary rows from the table. When you configure a queryable data page, you can filter columns, sort, and group data in a more performant way.
For example, you view a table of 10,000 customers who live in California. You filter the Location column to show only those customers who live in Sacramento, which displays 20 results on your screen. If you configured your data page to accept API queries, the data page only loads the 20 results that you see. The data page does not load all 10,000 results.
To specify a queryable data page, select the Allow API query check box on the Load Management tab of the data page rule form. For more information, see Defining data page access.
The Allow API query check box appears when you set the following parameters on the Definition tab of the data page rule form:
- Structure – Set to List
- Mode – Set to Read-only
- Scope – Set to Thread or Requestor
- Data source – Set to Report definitionThe Report definition must be in the same class as the data page. You can add multiple Report definition sources.
You can define multiple sources in the data page, but at least one source must be a Report definition. However, run-time behavior might be inconsistent because you might not know which source the system will run.
If you configured a response data transform or post-load activity to change the values returned by the Report definition, the grid might not display the values as expected.
For more information, see Creating a data page.