Atlas —
Standard properties for search results (Code-Pega-List
class)
|
|
At runtime, five methods (Obj-Browse, Obj-Filter, Obj-List,
Obj-List-View, and RDB-List), list view rules, and summary view
rules use a page of the class Code-Pega-List class
as a source of search criteria and to hold output. Typically,
such pages are named Results,
pyQueryResultPage, or pyViewLookupList.
Search results (which support rows of report output) are stored
as pages in the pxResults() property, a Page
List.
Although Code-Pega-List is a concrete class, pages of this class exist only on the clipboard. They are never saved to the PegaRULES database.
This table identifies several properties on such pages, in
alphabetical order ignoring the first two characters of the
name. Properties marked 
with may hold input
parameters for the search; other properties marked with
(
) contain outputs from the search.
Property |
Purpose |
More ... |
| pxBrowseType
|
Set to |
list rule |
| pyCacheFile |
For list view reports that save results as an XML file in the lookup list cache, identifies the file name. |
lookup list |
| pyCondition
|
A
|
|
| pyDetailsAction
|
For list view and summary view rules, identifies the
value of the |
|
| pyDetailsWindow
|
For list view and summary view rules, identifies the name of the window that is to hold the resulting display. |
|
| pxElapsedTime |
Elapsed time in seconds to process the Obj-List operation. |
Obj-List method |
| pyListDef
|
Page property identifies the Rule-Obj-List rule used as parameters to Obj-List method. |
list rule |
| pyListName
|
Second key part of a Rule-Obj-List rule. |
list rule |
| pxMore |
Indicates whether there are more instances not
returned. Values are true or false. |
|
| pyMaxRecords
|
Optional input to limit the number of rows returned. |
|
| pxNextKey |
Indicates the key of the first row (instance) not
returned, if pxMore is true. |
|
| pyObjClass
|
Identifies the class containing the instances that are to be searched. Don't confuse with property pxObjClass, the class of this page, which always has the value Code-Pega-List. |
|
| pyPageSize
|
For list view or summary view rules that support report paging, the maximum number of results to presented on a page. |
|
| pyQueryTimeStamp |
A |
|
| pxResults |
A Page List containing pages with individual search
results. each of the class defined in the
pxObjClass property. (Not used for Obj-List
methods that specify the lightweight results format.)
|
|
| pxResultCount |
Number of rows of data returned by the
search. |
|
| pyReturnLightweight Results
|
|
Obj-List method |
| pxSelectStatement |
For the Obj-List method, the SQL statement sent to the
database before substitution. |
Obj-List method |
| pxSQLStatementPost
|
For the RDB-List method, SQL statements as sent to the
SQL database. Appears only when requested through the
|
RDB-List method |
| pxSQLStatementPre
|
For the RDB-List method, SQL statements before
substitution. Appears only when requested through the
|
RDB-List method |
| pxTimeElapsed |
For the Obj-List method, elapsed seconds taken for the
method. |
Obj-List method |
| pxTotalResultCount |
For the RDB-List method, the total number of results
returned by the query. This is set only if
pyReturnTotalResultCount is true.
(If pyReturnTotalResultCount
is false, then this is zero.) |
RDB-List method |
| pyUseAlternateDb | Set to true if an alternate database, not the primary PegaRULES database, was the source of data for a list view or summary view report. | Data Tables form - Completing the Database tab |
For the Obj-List
method, indicates that the results are in a special
format rather than in pxResults pages.