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 operations. Using keywords as a page name
is not recommended:
param,
local,
locate
(unsupported),
primary,
steppage,
mysteppage,
top,
parent, or
current.
Do not use any of the following names or patterns as a page name, where an asterisk
indicates one or more characters:
pxNode,
pxRequestor,
pxThread,
LISTVIEW_*,
locate*prompt*,
$*,
px*,
pz*, or
py*.
Special page name prefixes
You cannot 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 typeLocate. This prefix is unsupported. Locatable pages have been replaced by data pages.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 might appear more than once in a property reference. You keyword is used in Declare Index rules, decision tables, decision trees, and map values. You can also use thePARENTkeyword in the Step page field in activities. You cannot use this keyword in data transforms.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.
| 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 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). |
Previous topic Defining the pages and classes of a rule Next topic Skim to create a higher version