Understanding page names and reserved pages

A page is a data structure that holds name-value pairs. Most pages are named; the names of pages may arise from any of four sources:

• Literal values entered into a rule such as a parameter to the Page-New method.
• System-created pages with reserved names and purposes, such as the requestor page.
• Names used by convention in a collection of rules designed to operate together
• Property names (for embedded pages)

Valid page names

A page name can contain only letters, digits, and the underscore character. Start the page name with a letter.

Several keywords identify elements in specific PRPC operations. Using keywords as a page name is not recommended: param, local, locate, primary, steppage, mysteppage, top, parent, or current.

Don't use any of the following names or patterns as a page name, where asterisk indicates one or more characters: pxNode, pxRequestor, pxThread, LISTVIEW_*, locate* prompt*, $*, px*, pz*, or py*.

Pages named in your application

Select > Data Model > Clipboard Pages > Named Pages to access the Named Pages gadget, which can summarize the named pages used in the current application.

Special page name prefixes

You can't use certain prefixes and keywords as page names, as they have a special meaning:

• local — Not a page, a keyword indicating that the name that follows the word "local" and the period is a local variable, not a property.
• locate — A prefix to a page name (in lowercase), indicates that this page is retrieved or located at runtime through an activity of type Locate.
• mode — Identifies an indirect page reference.
• param — Identifies the parameter page for an activity. This page structure is not part of the clipboard.
• parent — In the context of an embedded page, identifies the immediately containing page to which the embedded page belongs. This keyword may appear more than once in a property reference. This keyword is used in Declare Index rules, decision tables, decision trees, and map values.
• prompt — As a prefix portion of a page name, not a keyword, identifies an indirect page reference in a Call or Branch.
• primary — In the context of an activity, refers to the primary page of that activity.
• top — In the context of an embedded page, identifies the top-level page to which the current embedded page belongs.

The prefix Declare_ in a page name indicates a declarative page, a page that is created and updated only by Declare Pages rules (Rule-Declare-Pages rule type). The properties on this page are "read-only" to normal requestor processing. To avoid confusion with such pages , don't create pages named Declare_zzzzz in other processing.

Except as noted, case is not significant in keywords: Param.Country, PARAM.Country and param.Country all reference the same value.

Page names used by convention

Many standard activities and other standard rules use these page names by convention. To utilize these standard rules, follow these naming conventions in the rules you create.

Page Name	Description
NewAssignPage	When a single assignment object is open on the clipboard, the page is named NewAssignPage. If your application involves multiple work items (or multiple assignments) on the clipboard, you can use other names.
pyCoverPage	By convention in standard flow processing activities, when a single cover work item is opened onto the clipboard, the page is named pyCoverPage.
pyOutput	Created by Process Engine API activities.
pyWorkPage	By convention in standard flow processing activities, when a single (non-cover) work item is opened onto the clipboard, the page is named pyWorkPage.
RuleToRun	Created during unit testing of a rule with the Run toolbar button. The class of this page matches the rule type. See Unit testing a rule with the Run toolbar button.

System-created pages

These top-level pages are present in the clipboard of every authenticated requestor:

Page Name	Description
Process page pxProcess	A named page of class Code-Pega-Process containing system-wide information, such as information from the Data-Admin-System instance.
Requestor page pxRequestor	A named page of class Code-Pega-Requestor. Created at log in and contains information about your access roles, RuleSet list, and TCP and HTTP protocol parameters.
thread page pxThread	A named page of class Code-Pega-Thread, identifies a named context of clipboard pages. The first Thread for a requestor is named STANDARD.
AccessGroup	Contains information from the requestor's current access group (Data-Admin-Operator-AccessGroup class). This page does not exist for guest (unauthenticated) users.
Org	Contains information from the requestor's organization (Data-Admin-Organization class). This page does not exist for guest (unauthenticated) users. This page does not exist for guest (unauthenticated) users.
OrgDivision	Contains information from the requestor's organization (Data-Admin-Organization class). This page does not exist for guest (unauthenticated) users.
OperatorID	Contains information from the requestor's Operator ID (Data-Admin-Operator-ID class). This page does not exist for guest (unauthenticated) users.

Other

Page Name	Description
pyQueryResultPage	Produced by execution of a list rule (Rule-Obj-List rule type).

	clipboard, declarative page, embedded page, indirect page, Process Engine API, process page, requestor page, thread page
	Data Model class — Clipboard Pages landing page About Property rules About the Clipboard tool
	Atlas — Standard properties on the pxProcess page (Code-Pega-Process class) Atlas — Standard properties on the pxRequestor page (Code-Pega-Requestor class) Atlas — Standard properties on the pxThread page (Code-Pega-Thread class)

Concepts