You are here: Reference > Standard rules > Property rules > Property rules for the Code-Pega-List class

Standard properties for search results (Code-Pega-List class)

At run time, four methods (Obj-Browse, Obj-Filter, Obj-List-View, and RDB-List), report definitions, 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 a yellow diamonddotcan hold input parameters for the search. Other properties marked with a read-only icon Read-only contain outputs from the search.

Property

Purpose

More ...
pyCacheFile

For list view reports that save results as an XML file in the lookup list cache, identifies the file name.

 lookup list
pyCondition dot

A Page List. Identifies the parameters that define search comparisons, for the Obj-List method:

  • pyConditionFieldName — A property reference resulting in a single text value
  • pyConditionOperation — A comparison operator, such as "<"
  • pyConditionValue1 — An expression for the comparison value
  
pyDetailsAction dot

For list view and summary view rules, identifies the value of the pyAction parameter to the ShowView activity, such as PREPARE or SHOW.

  
pyDetailsWindowdot

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 RDB-List operation. Read-only

  
pxMore

Indicates whether there are more instances not returned. Values are true or false. Read-only

  
pyMaxRecords dot

Optional input to limit the number of rows returned.

  
pxNextKey

Indicates the key of the first row (instance) not returned, if pxMore is true. Read-only

  
pyObjClassdot

Identifies the class containing the instances that are to be searched. This property is different from pxObjClass, the class of this page, which always has the value Code-Pega-List.

  
pyPageSizedot

For list view or summary view rules that support report paging, the maximum number of results to presented on a page.

  
pyQueryTimeStamp

A DateTime value recording the start of the operation.Read-only

  
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.) Read-only

  
pxResultCount

Number of rows of data returned by the search.Read-only

  
pyReturnLightweight
Resultsdot

For the Obj-List method, indicates that the results are in a special format rather than in pxResults pages. Read-only

  
pxSelectStatement

For the Obj-List method, the SQL statement sent to the database before substitution. Read-only

  
pxSQLStatementPost
dot

For the RDB-List method, SQL statements as sent to the SQL database. Appears only when requested through the {SQLPage} syntax.Read-only

 RDB-List method
pxSQLStatementPre
dot

For the RDB-List method, SQL statements before substitution. Appears only when requested through the {SQLPage} syntax.Read-only

 RDB-List method
pxTimeElapsed

For the Obj-List method, elapsed seconds taken for the method. Read-only

  
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.)Read-only

 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

About Property rules
Standard rules index

Open topic with navigation