List View form
Completing the Display Fields tab

Field

Description

Optional. To assign a category to this report, select from the SmartPrompt list.

Choose one of seven standard categories to cause this report to be listed in a corresponding group on the Monitor Activity workspace, (and so available to those 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.

This list shows field value rules with Rule-Obj-ListView as the first key part and pyCategory as the second key part. You can create additional field value rules in your application to define more categories.

Select if the output display of this list view is to appear within the runtime presentation of another rule, such as a section rule or flow action. See:

• Harness, Section, and Flow Action forms — Adding a List View display
• Example: Embedded list view display in a flow action

The Customize View and Customize Criteria capabilities are not available for embedded list views.

Optional. If you selected Embedded List View, enter here a vertical size of the initial display, which corresponds to a <DIV > HTML element. The runtime presentation includes a vertical scroll bar when necessary.

If you selected Embedded List View, select px or % to indicate the units for the Height field.

Field

Description

Optional. Select to indicate that the header area is to be excluded from the scrollable area. When a user scrolls the rows at runtime, the header remains visible and fixed. This field is not visible when you select Hide Column Header.

Optional. Select to allow the user to add or remove columns in the list view display. See Interacting with List view displays.

Optional. Select to suppress column headers in the report display.

Optional. Select to allow the user to filter the data in the list view display. See Interacting with List view displays.

Optional. Select to allow the user to sort the list view display by any column at runtime, by clicking the column header. This field is not visible when you select Hide Column Header.

Field

Description

Identify the properties to appear in the report and the presentation of each.

The order of rows in the Fields array determines the order of columns, left to right, in the resulting HTML table.

As a best practice for good performance, specify only Single Value properties that correspond to exposed columns in a database table here, rather than properties in the Storage Stream (BLOB) column. See Pega Developer Network article PRKB-23116 How to detect and remedy the performance impact of Obj-List methods and list view reports.
If this list view rule presents properties that are not exposed and is to be frequently executed in a production setting, consider exposing all listed properties to improve performance.

Enter a property reference for a single text value, source for the data in a column of an HTML table. In most cases, enter a period and select a property in the class corresponding to the Applies To key part or a superclass of that class.

Enter heading text for this column.

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. To control the display width of this column, enter a number and a measurement here. This becomes the WIDTH=" " value in the final HTML.

Type % as the measurement for percentages of overall table width, or another HTML measurement term such as px for pixels or pt for points. For example, enter 25% for a column that is to be one quarter of the width of the table.

If you leave this field blank or specify widths that cannot be achieved when the table appears at runtime, Internet Explorer determines the resulting display appearance.

Optional. You can identify a CSS style, one present on the style sheet identified on the Format tab, for this column. At runtime, this value becomes the CLASS = "zzz" value in the <TD> element for the cells in this column.

For example, enter tdRightStyle to right-justify a value. See Understanding CSS styles.

Optional. Select an HTML property rule to control the presentation of the field on the list view display. Leave blank to use the HTML property rule associated with the property rule.

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.

Images and links

Two special HTML property rules are useful here:

• Select reporting_image to present a clickable image in the row; reference a binary file rule in the ImageSourceName parameter in the format /dir/name.jpg.
• Select reporting_link to present a clickable link.

A parameter to the reporting_image and reporting_link rules include an activity that executes upon click. Typically, this activity executes an HTML rule, with output displayed in a new window. For an example, see Pega Developer Network article PRKB-25201 How to include an image or link as a report column.

Optional. If this 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.

If checked, the field does not appear in the initial list view display, but is available for users to add or remove at runtime by clicking the Add/remove link in the filter button dialog.