Declare Pages form
Completing the Definition tab

Field

Description

Select Load Only or Read Only.

• Select Load Only if this rule is used only to define the initial contents of a page, which thereafter is accessed normally with changes to its contents. On the clipboard display, this page appears in the User Pages grouping, not the Declared Pages group.
• Select Read Only for a page that is accessed only through accesses to values on the page. The page may be refreshed automatically. On the clipboard display, this page appears in the Declared Pages group.

A Load Only page is created when first accessed by an activity using the Page-New method (or similarly the findPage() or createPage() API calls). Thereafter, it is part of the Thread context and operates like any normal clipboard page created by the requestor. The Declare Page rule simply provides a flexible means to initialize the page.

Select to determine the scope of requestors that can access the declarative pages created by this rule:

• 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. Accesses by separate requestors cause the rule to create distinct pages, which may have different contents.
• Requestor — All Threads for the current requestor.

Load Only pages all have Thread scope.

Select the class of the top level page to be created. Typically, select Code-Pega-List if the page is to store a list of other pages, such as produced by a report or the Obj-List-View method. However, a declare page may be of any class.

• Page — To create a single top-level page of the class identified in the Page Class field.
• List — (Do not use. Reserved .)

Identify the source of data for the page. Select:

• Load Activity — To execute an activity that creates and populates the page.
• Report Definition — To execute a report definition that creates and populates the page.
• Obj Lookup — To fetch a row of data from the PRPC database representing the page-class. The row to be fetched is defined by the page-class-key parameter that is input by the user.
• Connector — To create the page from the responses to a connector rule execution.
• Data Transform — To create the page by running a data transform.

The form changes to reflect your selection.

Optional. Select to Identify the Activity Name key part of an activity that the system uses to create and update (refresh) declarative pages. At runtime, the system uses the value in the Page Class field as the Applies To key part to find the activity with rule resolution.

Select an activity that has LoadDeclarativePage as the Activity Type (on the Security tab). Confirm that this activity adds property values to the page; it is not otherwise unrestricted. See More about Declare Pages rules.

If the Page Scope field is set to Node, the system uses the RuleSet list provided by the access group in the Access Group field with rule resolution to find the activity (not the RuleSet list of the requestor). If the Page Scope field is set to Thread, the system uses the RuleSet list of the requestor to find the activity.

At runtime when searching for this activity, rule resolution excludes checked-out rules in a personal RuleSet. The system selects and executes the current checked-in version.

Optional. Select to identify the key parts of a report definition that the system uses to create and update (refresh) declarative pages, as an alternative to a load activity.

If you select this option, enter Code-Pega-List in the Page Class field.

Optional. This field appears when you select Report Definition as the source. Enter the Applies To key part of a report definition.

This field appears when you select Report Definition as the source. Enter the Report Name key part of a report definition.

If the activity or report definition accepts input parameters, click Params and enter literal constant values or property references as parameter values. To reference a property value, enter the fully qualified reference, starting with a top-level page name. In addition, Include the name and class of clipboard pages you reference here on the Pages & Classes tab of this rule form.

These fields appear when you select Connector as the Data Source. Select the type of connector.

Enter the first key part of the connector, the Applies To class.

Enter the final key part of the connector, such as the Service Name field for SOAP connectors, or the Request Type field for SQL connectors.

Specify a data transform that supplies initial values for properties or parameter values referenced in the connector rule. If you select the List checkbox, reference a data transform rule in the Code-Pega-List class. If your connector rule does not require such initial parameters, create a dummy data transform that makes no changes (for example, sets .pyLabel to .pyLabel).

Optional. Specify a data transform rule to be executed after the connector response is received.

Optional. If the Connector Type is Connect HTTP, Connect REST, Connect SOAP, or Connect dotNet, you can override the End Point URL value in the rule with a value here.

Appears for Connect SQL rules only. Enter the second (middle) key part (Package Name) of the Connect SQL rule.

Appears for Connect SQL rules only. Leave unselected to cause the system to execute the Connect SQL rule with the RDB-Open method, using information in the Open tab of the Connect SQL rule.

Select to cause the system to execute the Connect SQL rule with the RDB-List method, using information in the Browse tab of the Connect SQL rule.

Optional. Appears for Connect SQL rules only when the List checkbox is selected. You may enter a positive integer to limit the number of rows returned from the RDB-List method.

This field appears when you select Data Transform as the Data Source. Select a data transform that is the source of the data for the page.

Click Params to enter parameter values.

Select to load this page asynchronously. Asynchronous declare pages, when included in defer loaded sections, enable non-blocking user interfaces in which users can take action on a work item while other content is still being loaded.

If you selected Load Activity as the Data Source for the ADP, include all pages used by the Load Activity in the Pages & Classes tab of the Declare Page form.

For more information, see PDN How to configure non-blocking UI using Asynchronous Declare Pages (ADP).

Select an access group that provides temporary access to the RuleSets and versions needed to access the load activity, report definition, data transform, or connector. This field appears only when the Page Scope is set to Node.

The requestor that executes uses this access group only during execution of the activity, report definition, data transform or connector. RuleSets made available by this access group may not be available to the requestor at other times.

The load activity, report definition (or other load mechanism) executes the first time any requestor within the scope (Node or Thread) references the page (such as to access the value of a property, or to test whether a property is present).

Optionally, you can define one or two criteria (Refresh if Older Than and Page is Fresh When) that can cause the system to delete the declarative page or pages and rerun the load mechanism, creating the page or pages again with possibly fresher contents.

These two criteria are ignored if the Refresh Once Per Interaction checkbox is checked.

Optional. Enter positive integers in one or more of these fields to define an expiration time interval in days, hours, minutes, and seconds. If not blank, any attempt by a requestor to access the page after a period of no accesses equal to or greater than the timeout causes the system to refresh the page. However, the page is never refreshed more than once per user interaction.

Optional. Identify the When Name key part of a when condition rule to be evaluated when a requestor accesses a page with a Page Scope of Thread.

If the when condition rule evaluates to false, the page contents are refreshed. ( However, the page is never refreshed more than once per user interaction.)

To find this rule at runtime, rule resolution uses the class in the Page Class field as the Applies To class, and the RuleSet list of the requestor. This field appears only when the Page Scope is set to Thread.

For accesses to the declare page from an interactive browser requestor, check to cause rule the system to refresh exactly once per user interaction. This option is available only for rules with Page Scope set to Thread or Requestor. When checked, at runtime the system ignores any values in the Refresh if Older Than and Page is Fresh When fields.

For Thread-scope pages, determine the refresh strategy carefully, especially if your refresh operation is costly in terms of elapsed time or use of system resources. This involves a trade-off of possibly stale data versus additional processing. For example, refreshing upon each interaction may introduce avoidable extra processing if once-per-hour is good enough. But in a high-frequency access situation, refreshing once per minute may be less often (and so less costly) than once per interaction.