Standard properties on the pxRequestor page(Code-Pega-Requestor class) |
Many standard properties in the Code-Pega-Requestor class are typically found on the pxRequestor
page of the clipboard. This is a reserved, system-maintained page; your application can read but not directly set these values ().
This table identifies several of these properties, in alphabetical order ignoring the first two characters of the name.
The Pega 7 Platform automatically maintains certain properties on the pxRequestor
page or on each pxThread
page for a requestor, depending on the value of the Place properties on thread page only check box on the Definition tab of the application rule directly referenced in the requestor's current access group. As a best practice, select the Place properties on thread page only check box to maintain these properties on the pxThread
pages and to allow rapid application switching. Properties marked with the dot () have correct values on the thread pages, not the pxRequestor
page, when the Place properties on thread page only option is selected. These properties appear on both a pxThread
page and the pxRequestor
page, with correct values only on the pxRequestor
page, when the Place properties on thread page only option is not selected. The check box setting does not alter the results of rule execution.
For unauthenticated (guest) requestors, agents, and service requestors that use the APP requestor type, fewer properties are present. When creating and testing service activities, don't depend on the same pxRequestor properties as are visible through BROWSER requestor sessions. For example, the pyHTTPRequestHeaders and pyUserPortals pages are not available.
Property |
Purpose |
More ... |
pxAlertSessionCount | Counts alerts created in this session. | Working with the My Alerts display |
pxAlertSessionReported | Counts alerts viewed in the My Alerts display. | Working with the My Alerts display |
pxApplicationRuleSets | Value List of RuleSets provide by application rule. |
application rule |
pyBaseCurrency | Initially blank. Can be set with the Locale Settings tool. | currency code |
pyCalendar | First key part of this user's calendar data instance, obtained from the Operator ID data instance during log-in, or from the Organization data instance. | calendar |
pxClientConnection | Unique identifier for this requestor, generated when the session starts. | requestor ID |
pxCurrentWorkPool | Current work pool. | Work pool name |
pyDBTraceSettings | Page containing settings for the Database Tracer gadget. | System category — Performance page |
pyDesktopType | Developer or User , from the portal rule |
portal |
pxDevelopRuleSet
pxDevelopVersion |
Local customization RuleSet and version for this user, from the Settings tab of the access group. | |
pxHomeDirectory | Subdirectory on the application server node that contains all the directories for static content. Normally /webwb . |
static content |
pyHTTPRequestHeaders | HTTP request header for most recent request. Available only for BROWSER requestors. | |
pxHTTPServlet | A Java Object property, available only in the context of a custom authentication activity. | |
pyLastSignon | Date and time of previous successful sign-on | |
pyMyRules | Page List property, one page for each favorite (delegated) rule. pyMyRules is not guaranteed to always be on the clipboard. It is generated on the pxRequestor page for a user logged into the Designer Studio when the user clicks the Profile menu in the Designer Studio (Developer portal). |
favorite |
pyRDBSuppressUpdateCounts | Affect the operation of the {MULTISET} keyword in Connect SQL operations. | Connect SQL form — Data Mapping |
pyRDBSingleMultisetResultSet | Affect the operation of the {MULTISET} keyword in Connect SQL operations. | Connect SQL form — Data Mapping |
pyRequestorTimeZone | Set during log-in from the time zone or calendar on the Availability tab of the Operator ID data instance or from the calendar or time zone on the Organization data instance. | |
pxReqRemoteAddr | Internet Protocol address of the client workstation, for browser-based users. (May be missing or inaccurate when proxy servers or other redirectors are in use.) | |
pxReqRemoteHost | Network name of the client workstation, for browser-based users. (May be missing or inaccurate when proxy servers or other redirectors are in use.) | |
pxReqScheme | Identifies a protocol: http , https or blank for non-interactive users. |
requestor scheme |
pxSecuritySnapShot | Page containing security details, including pyUserRuleSets properties. | |
pyStaticServerGIF pyStaticServerJS pyStaticServerCSS |
Allow selected static content to be served from an edge server rather than from the Pega node. | How to capture and deploy static content to an edge server |
pxUseLocale | Current locale for this requestor, established at log-in from Operator ID instance. Can be changed with the Locale Settings tool. | locale |
pxUserIdentifier | Operator ID instance key, for authenticated requestors. Set to system for agent requestors. |
|
pyUserLoginTime | Date and time of this log-in, for authenticated users. | |
pyUserName | User full name, from the Operator ID data instance. | |
pyUserPortals | Value list of portal rules for this requestor, determined from the access group. Meaningful only for BROWSER requestors. | portal rule |
pyUserWorkPools | Work pools available to this user, from the access group. | work pool |
pyUseTimeZone | Can be set with the Set Locale tool. | About the Set Locale tool |
pyWorkbasketFirst | From the Operator ID instance, affects the search algorithm of the GetNextWork facility. | Maximizing user productivity with GetNextWork |