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*.

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 prefixes D_ and Declare_ in a page name indicates a data page, a page that is created and updated only by Data Page rules. 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 or D_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.

System-created pages

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

Other

	clipboard, data 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

Open topic with navigation