Summary View form
Completing the Content tab

Field

Description

Optional. To assign a category to this report, select from the SmartPrompt list. This list shows field value rules with Rule-Obj-SummaryView as the first key part and pyCategory as the second key part. You can create field value rules in your application to define additional categories.

Select one of seven standard categories to cause this report to be listed in a corresponding group on the Monitor Activity workspace, (and so visible and available to all users who can access this workspace). For example, choose WorkAnalysis to list this report in the Analyze Quality area. See A developer's view of the Monitor Activity workspace.

Field

Description

Each row of this array identifies a selection criterion. The order of rows in this array is not significant. Process Commander converts information in this array to an SQL WHERE clause.

You can specify only Single Value properties in the Field field. Each property you identify for selection criteria must be exposed as a column in the database table.

Optional. Enter a letter or letters that uniquely identifies this row, to reference this row in the Logic field.

For example, enter A for the first row, B for the second row, and so on. The Logic value must mention each label.

Enter a property reference for a comparison. For exposed properties defined in the class identified by the Applies To key part of this summary view rule, start the property reference with a period. You can also identify fully qualified values on other clipboard pages that are always present on the clipboard, such as the requestor page or process page.

If the Type of this property is TextEncrypted, special instructions apply to the Condition, Value, and Edit Input fields. See Property rules — Implementing and using the TextEncrypted Type.

If you enter .pxObjClass here and the Applies To key part of this list view rule is a framework class, at runtime the report execution can use the corresponding implementation class, not the framework class, for comparisons and report content. This feature eliminates the need to copy each framework class-based list view report into the implementation class. To enable this capability, select the Report on Descendant Class Instances check box on this tab.

Optional. Enter text to name this row of the array. If you do not specify a caption, the Field name will be used.

Select a comparison condition, such as Is Equal or Starts With.

Enter one of the following options as a comparison value:

• A literal constant, formatted in accordance with the property type. See Constants in expressions. To compare the Field value with multiple literal constants, surround each with double quote characters and separate each with a comma. Place a backslash character / before any double quote character that appears within the constant. As described below, you can click the magnifying glass icon () in some situations to review current clipboard values for the property identified in the Field field.
• A fully qualified property reference to a Single Value property that is present on the clipboard at runtime. The Type of this property must match the Type of the property in the Field field.
• A fully qualified property reference to a Value List or Value Group property present on the clipboard at runtime. The Type of this property must match the Type of the property in the Field field. To compare the Field value with multiple Value List or Value Group properties, separate each property name with a comma.
• The keyword param followed by a period, followed by a parameter that is defined on the parameter page of the calling activity.
• A period followed by the name of a Single Value property that is exposed as a column. This allows comparison of the values of two properties in the same instance (database row), if the types are identical or comparable.
• A symbolic date, for a Date or DateTime value. When the list value rule executes, this symbolic reference is converted to an actual date or date range based on the time zone of the user and the Condition value. For example, if the user selects Last Year and the Condition value is IS EQUAL TO, the result is a date range between January 1 and December 31 inclusive, of the previous calendar year.

If the Condition field is set to IS NULL or IS NOT NULL, leave this field blank.

Commas correspond to an OR test: if the Value field contains two or more entries separated by commas, the comparison is true at runtime if the value of the Field field equals (or is greater than, or is contained in, and so on) any one of the entries.

Similarly, when the Value field contains a Value List or Value Group property reference, the comparison is true at runtime if the value of the Field field is true for any element in the list or group.

When evaluating either of the two Condition values Greater or Greater or Equal at runtime, the result is the same as applying the test to the largest value in a list or group. Similarly, when evaluating the Condition values Less or Less or Equal at runtime, the result is the same as applying the test to the smallest value in the group or list. The Value List and Value Group options are most useful for other condition values, such as Contains or Starts with.

Using the Pick Values pop-up window

For guided assistance in completing this field, click the magnifying glass icon (). A pop-up window appears with one or more of these tabs:

• Available Values — The system searches the column in the database corresponding to the property in the Field field to collect and display up to 1,000 values for the Field property in a new window. To add literal values to the Value field, check one or more boxes and click  Apply  . (You can also type literal constants directly, whether or not they appear on this list.) This tab appears at runtime only to users who hold the standard privilege @baseclass.ShowStoredValues. For such users, it is visible at runtime when the Display Available Values? box in the Prompt Settings area is selected.
• Valid Values — The system presents values from the Table Edit tab of the property rule referenced in the Field field. To add literal values to the Value field, check one or more boxes and click  Apply  . This tab appears at runtime when the Display Valid Values? box in the Prompt Settings area is selected.
• Compatible Columns — The system lists exposed properties with the same Type as the property in the Field field, as candidates for this field. This tab appears at runtime when the Display Compatible Columns? box in the Prompt Settings area is selected.
• Time Periods — For a property of type Date or DateTime, allows the selection of a symbolic date such as Yesterday or Current Year.

Enter a comparison value to be used when you do not specify a value in the Value field.

Optional. Identify an edit input rule to convert the value from the format supplied by the expression in the Value field to another format.

Select to cause runtime tests or comparisons of the Field value and the Value value to occur after the system converts both to uppercase. In this situation, "a" matches "A" and is less than "B".

Clear to cause tests of the Field value and the Value value to occur without case conversion. In this case, "a" is greater than "A" and also greater than "B"

In most cases, leave this box cleared. Select this box only when required to obtain the rows of the report. For example:

• If your PegaRULES database is hosted by Microsoft SQL Server, comparisons are always in uppercase, so selecting this box does not affect the report contents.
• If your PegaRULES database is hosted by Oracle, IBM UDB or most other database vendor products, selecting this box can affect which rows appear in the report, when values occur in mixed case. However, conversion to uppercase can significantly slow database processing.
• Case conversion is meaningful only for properties of type Text, Identifier or Password. Regardless of database software, case conversion is not needed when you know the values are numeric, dates, or hold text in only uppercase or only lowercase.

This box is meaningful only when the value in the Value field is not a constant. By default, if the value in the Value field is null at runtime, the criterion defined by this row is ignored; processing is the same as if this row is not present.

For example, assume the criteria in a row is:

If this summary view rule executes at a time when Param.Letter has the value "C", this criterion limits the report to contain only instances in which the Lastname property value starts with the letter C. However, if the same summary view rule executes again when the Param.Letter parameter has no value, this criterion is dropped, so instances with any Lastname value (or none) are selected.

In situations where this default behavior is not desirable, select the Use Null* box to force the Condition value to become Is Null when the Value value is blank at runtime. In the above example, the criterion is transformed to "Lastname is null" — quite different from having no restriction on Lastname.

Optional. Using the labels entered in the Criteria array, enter a logical expression that defines how the system combines the criteria into an overall Boolean value at runtime. The expression can include parentheses and the operators AND and OR.

For example, if the table contains four rows labeled A, B, C, and D, you can enter:

(A OR B OR C) AND D

in this field. This notation is the same as for the logic statement in when condition rules.

If you leave the Logic field blank, the system selects only instances for which all criteria rows are true.

Select to cause the system to convert of certain input values for parameters from a locale-specific format to the internal representation. When selected, the system attempts to convert literal values or parameter value for numbers (Integer, Double, or Decimal), DateTime, and Date, specified in the Criteria section or trend section from a locale-specific format.

If not selected, enter parameter values and literal values for DateTime parameters in the form MM/DD/YY HH:MM AAA.

When selected, conversion from the locale-specific format occurs before the activity specified in the Activity Name field runs. The system applies any edit input rules specified in the Criteria array after the conversion but before the activity runs.

For example, if the user's locale is FR (France), an input of 3,142 for a Decimal criterion corresponds to the input 3.142 from a user with a United States locale. Similarly, a user in France may input of 4/7/6 for July 4, 2006. A United States user enters this date as 7/4/6. The French-locale user can enter 1.000.000 for an Integer value of one million.

Select whether to use the default prompt settings or define custom settings.

When you select Custom, the form changes. Identify on the Pages & Classes tab the class and page name of a page that can hold prompt values. Create and reference a section rule in that class to collect each prompt value. Use the standard HTML property rule Reporting_SymbolicDates if you want to allow the user to select a symbolic date for a Date or DateTime property. You can also identify a section to hold report output and criteria values.

This label corresponds to the label defined in the criteria row.

This field is corresponds to the field specified in the criteria row.

Select a value to determine how a user of this report can modify the criterion in this row, when either prompted before report execution or through use of the Customize Summary Criteria link:

• No Access — No part of this row is visible in either prompting or the Customize Summary Criteria display.
• Read Only — The criterion row is visible but users cannot alter the criteria.
• All Access — The criterion appears. Users can change the Field, Condition, and Value fields.
• Value Only — The criterion appears. Users can change the Value field.

Select to cause the criteria to appear before the summary view report executes to users who request this report.

When selected, at least one Criteria row must allow user input; the Prompt Mode for at least one row must not be No Access or Read Only.

Select to cause the criteria (both prompts and values) to appear at runtime as part of the report output.

As a best practice to avoid confusion or error, select this option if the report user is allowed to change report selection criteria. If not selected, the output for a single report may vary from user to user for no easily detected reason — because the users have different saved criteria.

Select to display at runtime a list of up to 1,000 values for a property referenced in the Field field. The system searches saved instances of the class until it finds 1,000 distinct values.

User selections are recorded in the Value field for the current execution of the report. This check box is meaningful only when you selected Prompt user? and one or more rows of the criteria allow users to enter values.

Select to display at runtime a list of values based on the Table Edit area of the General tab of the property referenced in the Field field.

User selections are recorded in the Value field for the current execution of the report. This check box is meaningful only when Prompt user? is selected and one or more rows of the criteria allow users to enter values.

Select to display at runtime a list of properties eligible for comparison. These are properties in the Applies To class (or an ancestor class) that are exposed as columns and match the Type of the property referenced in the Field field.

User selections are recorded in the Value field for the current execution of the report. This check box is meaningful only when Prompt user? is selected and one or more rows of the criteria allow users to enter property names.

Enter a text string to display on the search button.

Field

Description

Identify the properties to correspond to summary levels, with the major summary level in the first row.

Optional. Enter text to appear above the list display for this property. If you leave this blank, the text (empty) appears as the caption.

If your application is to support users in multiple locales, choose a noun or noun phrase for the caption of 64 characters or less and select the Localize? check box on the HTML tab. When practical, choose a caption already included in a language pack, to simplify localization. Click the pencil icon to review or create the field value rule supporting localization. The pencil icon appears only after you select the Localize? check box on the HTML tab. See About the Localization wizard and Rules Inspector tool — Localizing forms and reports with the Field Value Inspector.

Optional. When the property in the Field field has a type of Text or DateTime, you can use a function to transform the property value, to alter the grouping level or sort sequence.

For example, if a property of type Text has hundreds of possible values from AAAAAA to ZZZZZ, you can truncate the value to the first character, to create a report with at most 26 top-level groups. Similarly, values of a DateTime property are precise to the millisecond, but you can group rows by day or month.

For the Text type, click the Details button () to specify a string function that the system applies to the field before grouping. You can select a function that converts the field value to uppercase or lowercase, select a substring, or concatenate the value with another Text property value or with a literal constant.

For DateTime type, click the Details button to specify a portion of the date to be used in grouping. For example, you can specify the year only (in the format YYYY), a two-digit month code (as YYYY-MM or only MM), or the day (as DD or YYYY-MM-DD).

The Details button changes to after you select a function.

Optional. Select an HTML Property rule to format the label for grouping. Many HTML Property rules accept parameters. Click the magnifying glass icon () to the right of the HTML Property value to enter parameters for the HTML property rule.

Click the pencil button () to open the HTML property rule.

Optional. If this drill-down display can be exported to Excel, select an HTML Property rule to use for the export. Ordinarily, select one of the following, as appropriate to the type of the value:

These HTML Property rules accept parameters. Click the magnifying glass icon () to the right of the Export HTML Property value to enter parameters for the HTML property rule.

Click the pencil button () to open the HTML property rule.

Field

Description

Select a function such as Count or Average from the selection list.:

• Count — Counts the number of rows for which this field is not blank.
• Count Distinct — Counts the number of distinct values of this field.
• Sum — Adds all instances of this field. Can only be used with Integer, Decimal, and Double property types.
• Average — Displays the average of this field. Can only be used with Integer, Decimal, and Double property types.
• Min — Displays the minimum of this field. Can only be used with Integer, Decimal, and Double property types.
• Max — Displays the maximum of this field. Can only be used with Integer, Decimal, and Double property types.

Optional. Enter a property in the class corresponding to the Applies To key part of this rule. If the function selected is Average or Sum, identify a property of type Number or Integer.

Leave blank to use a DateTime property with trend reporting.

Optional. The system can count instances based on the value of a DateTime property. To define trend fields, leave the Field field blank. Click the details button () and complete the Trend Definition form. See Summary View form — Entering trend details.

Provide a display caption for that property.

If your application is to support users in multiple locales, choose a noun or noun phrase for the caption of 64 characters or less and select the Localize? check box on the HTML tab. When practical, choose a caption already included in a language pack, to simplify localization. Click the pencil icon to review or create the field value rule supporting localization. The pencil icon appears only after you select the Localize? check box on the HTML tab. See About the Localization wizard and Rules Inspector tool — Localizing forms and reports with the Field Value Inspector.

Select No Sorting, Ascending, or Descending to control the sort order for this field.

Sorting follows the order of rows within this array. If this field is set to Ascending in the first row and also in the second row, values corresponding to the first row form the major sort and values corresponding to the second row form a minor sort.

Optional. To override the presentation of this property defined on the Property form, identify here an HTML Property rule to use when presenting this property.

Many HTML Property rules accept parameters. Click the magnifying glass icon () to the right of the HTML Property value to enter parameters for the HTML property rule.

Click the pencil button () to open the HTML property rule.

Optional. If this drill-down display can be exported to Excel, select an HTML Property rule to use for the export. Ordinarily, select one of the following, as appropriate to the type of the value:

• Export_Integer
• Export_Decimal
• Export_DateTime
• Export_Time
• Export_Date

These HTML Property rules accept parameters. Click the magnifying glass icon () to the right of the Export HTML Property value to enter parameters for the HTML property rule.

Click the pencil button () to open the HTML property rule.

Field

Description

Field

Description

Field

Description

Enter a clipboard page name to contain the report contents.

Optional. Identify an activity that applies to the Embed-SummaryParams class to support summary calculations. In most cases, accept the default activity named getContent.

If you implement a custom activity for unusual reporting needs, choose a name other than getContent and reference it in this field. The custom activity can derive report contents from various means and sources, such access to external databases through connector rules, calculations, and so on, but must place the results on the page named above and enforce the Maximum Value record count limit. A few summary view capabilities are disabled when an activity with a different name is used here.

See the section Customizing getContent Activities in the Pega Developer Network article PRKB-14593 How to get started on V4.1 reporting for more information on custom activities for this field.

Optional. Enter a maximum number of instances to retrieve for the report contents in each drill-down and at the summary level. As a best practice during testing, enter 500. If you leave this blank or enter a value above 9,999, the system enforces a limit of 9,999.

Select to include a message at the top of the output display if not all rows that meet the selection criteria are included in the report output. The message is:

Found more than the maximum number of records (nnn)

where nnn is the Maximum Value limit. If all records are displayed, a record count appears.

Displaying nnnn records

Clear to disable this message. This option is enabled by default for new reports you create and disabled for reports created in versions prior to V5.5.

Select in most cases to mark the Code-Pega-List page returned by this summary view at runtime as "read-only", meaning that later processing cannot alter the values of properties on the embedded pages. This has multiple benefits: .

• The report display always matches data exactly as retrieved from the database; it cannot be altered through post-processing.
• Internal processing reuses certain clipboard pages, reducing database access and improving performance.

If this summary view uses the facilities of the Join tab, this box must be checked.

When the results page is marked as read-only, later processing can delete embedded pages (for example, with the Page-Remove or Obj-Filter method) but cannot alter the contents of the embedded pages. Any attempt to alter the embedded pages produces an exception, such as:

SQLError - There was a problem getting a list — Illegal 0 length operation

Cannot update — page is read-only

Select to indicate that summary view processing is to use the database identified in the Reports Database field of the Data-Admin-DB-Table instance that supports the Applies To class of this summary view. See How to use a reports database.

Chose this option only if the Reports Database field is not blank and identifies a database table that is replicated from the production PegaRULES database. If the report uses JOIN operations that draw from multiple database tables, all tables must be in the same reports database.

When this option is selected, at runtime the report uses data from the alternate database. It sets property pyUseAlternateDb to true on the top-level output Code-Pega-List page.

Select to cause this report, at runtime, to use an implementation class derived from the current rule's Applies To class as the source of report contents.

Select this to allow one summary view rule, saved in a framework class, to execute against the work objects in an implementation class. This capability reduces the number of rules needed when building an implementation of a framework.

This check box is effective only if the Applies To class of this summary view rule is derived from the Work- base class.

To determine the Work- class actually used in report execution, use the Tracer tool, or, from the list view display, right-click and select View Source from the browser menu; search for ViewClass.

Field

Description

Optional. Identify a work type within the class group. The summary view output may include properties from this class (work type) when they exist. For example, if the class group has three work types, you can report on properties defined in the first type even though these properties do not exist for the other two types.
If this work type is derived from Work-, choose carefully whether you want to join to an implementation class , or in a framework class. At runtime, summary view rules with a framework class in this field automatically report on work objects in the associated implementation class, if the Report on Descendant Class Instance option is selected.

Field

Description

Optional. Select the Privilege Name key part of a privilege rule.

The system uses the Class and Privilege values with class inheritance to look for the privilege rule.

Optional. Select to allow this summary view rule to be executed on a web node, as part of a Pega composite application. If selected, users of a Pega composite application can display this report, if the normal access roles, RuleSet list, and privileges requirements are met.

If not checked and a user at a web node attempts to execute this summary view rule, the rule does not run and a security exception is added to the Alert log.