Rule-Declare-Pages (Data Page)

A data page (formerly "declare pages") rule defines the contents of a clipboard page.

Data Pages are instances of the Rule-Declare-Pages class. They are part of the Technical category.

Data pages load synchronously by default. To have them load asynchronously, so users can take action on a work item while other content is still being loaded, do one of the following:

• Check the Defer load checkbox on a Section whose source is a data page.

• Use the Load-DataPage step method in an activity. Wait for the data page to load by using the step method Connect-Wait (In between these two steps you can include steps to do other processing that does not depend on the data page being loaded.)

Click  > Data Model > Clipboard Pages > Data Pages to list data pages used by the current application.

Data Page Definition

Provide the required information in the fields in this section:

Field	Description
Structure	Select: Page — To create a data page containing a single object of the type specified below. List -- To create a list-type data page containing multiple objects of the type specified below.
Object Type	Select the data object type (class) of the data page to be created. The object type does not have to be the same as the object type of the data source(s) for the data page.
Edit Mode	Select Read Only or Editable
Scope	Select an option to set who can access the pages loaded by this data page record: Node — Any requestor executing on the current node can access the pages. Thread — The page is created in a single requestor Thread, and can be accessed as often as needed by processing in that Thread. Later accesses on another threadcause the data page to load a distinct page which may have different contents, even if it is by the same requestor. Requestor — The requestor can access the page(s) loaded across all threads. Accesses by separate requestors create distinct pages which may have different contents. Read / Write pages all have Thread or Requestior scope.

Data Sources

For each data source, Select:

Field

Description

Source

Required. Select a source. The list of options varies according to whether you set the page structure to Page or List. Report Definition — Use the results of a report definition as the data source. This can only be used as a data source for list-structure data pages. Lookup — Use an instance of the specified object type as the data source. This can only be used as a data source for page-structure data pages. Connector — Use the response of a connector as the data source. Data Transform — Specify a data transform to use to populate the data page. You can also select Load Activity — To execute an activity that creates and populates the page. However, Pega no longer recommends using this option.

Data pages are read-only

Except to the load activity, data pages are read-only. Any attempt to modify a data page (with Property-Set, Page-Copy, Page-Clear, or other processing) produces a ReadOnlyException exception.

When pages are removed

The system removes a data page (with a scope of Node) only when the system is shut down for that node (or when the rule is deleted).

The system removes a data page for a Thread when the requestor of that Thread logs out.

The system removes any data pages with a specific name when you save a Data Page rule form that has a key (Page Name field) that matches that name.

You can't use the Page-Remove method or the Clipboard tool to delete the page.