Back Forward Understanding page names and reserved pages

Concepts and terms

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:

Valid page names

CLINB 11/26/02 A page name can contain only letters, digits, and the underscore character. Start the page name with a letter. Case is not significant.

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

CautionDon'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*. OLSOK 3/13/06 others

Pages named in your application

Select Pega button> 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:

The prefix Declare_ in a page name by convention indicates a declarative page, one 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. PROJ-359To avoid confusion, 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 objects (or multiple assignments) on the clipboard, you can use other names.

pyCoverPage

By convention in standard flow processing activities, when a single cover work object is opened onto the clipboard, the page is named pyCoverPage.

pyOutput

Created by Process Engine API activities. not pyOutputPage

pyWorkPage

By convention in standard flow processing activities, when a single (non-cover) work object 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. 3/10/06 clinic

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. 3/10/06 clinic

OrgDivision

Contains information from the requestor's organization (Data-Admin-Organization class). This page does not exist for guest (unauthenticated) users. 3/10/06 clinic

OperatorID

Contains information from the requestor's Operator ID (Data-Admin-Operator-ID class). This page does not exist for guest (unauthenticated) users. 3/10/06 clinic

Other

Page Name

Description

pyQueryResultPage

Produced by execution of a list rule (Rule-Obj-List rule type).

Definitions clipboard, declarative page, embedded page, indirect page, Process Engine API, process page, requestor page, thread page
Related topics Data Model class — Clipboard Pages landing page
About Property rules
About the Clipboard tool
Standard rules 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)
UpConcepts