Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Configuring keyed access in a data page

Updated on April 6, 2022

To provide instant access to a particular page in a list-structure data page, enable keyed access. For example, you can easily access a list of products with an embedded page that holds information about a particular product.

By using keyed data pages, you avoid maintaining two separate data pages: one page to return a list of items and a second page to return information about a single item in the list.

You can enable keyed access for read-only data pages with a thread or requestor scope.

  1. In the navigation pane of Dev Studio, click Records.
  2. Expand the Data Model category, and then click Data Page.
  3. Click a data page to open it.
  4. On the Definition tab, in the Keyed page access section, click Access pages with user defined keys.
  5. In the Page list keys section, click Add key to define one or more keys for the data page. Press the Down arrow key to select from the properties in the class of the data page, or click Open to create a new one.
    For example: .SupplierID or .Industry
    You must pass either all or no keys to the data page at run-time to allow one data page to serve a dual purpose:
    • It can display all the items it contains (no keys passed).
    • It can return only items that match the keys.
  6. To enable the data page to return multiple embedded pages from a single instance to an auto-populated page list property, click Allow multiple pages per key.
    For example: You might use this option when preparing to display a list of all the products offered by a particular provider.
    Note: You can use this option only with an auto-populated page list property. If the option is not selected, you can populate a page property.
  7. Open the property, and in the Data access section, reference the keyed data page in the page property by using the selected keys. For more information, see Configuring page, page group, and page list properties.
    Note: You can use both parameters and keys in the property.
    • The parameters determine the instance of a data page that is loaded and selected.
    • The keys determine which embedded page within a given instance to return.
    Result: To retrieve the data, the property that requires the data references the data page and sends a property reference or a literal value to populate the data page key. When the property is referenced, the system automatically loads the data page using the value that the property sends as the key.
  • Previous topic More about data page rules
  • Next topic Creating a data object and connecting it to a system of record using REST

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us