List View form
Completing the Format tab

Field

Description

Identify a cascading style sheet (CSS) file that is contained in a text file rule. Enter the File Type key part, a slash character, and the File Name key part, for example css/ourreportstyles.

In most situations, leave this field blank, using it only for unusual reports. As a best practice, define report styles for an entire application using a skin rule that is developed and maintained exclusively through the Application Skin wizard. This approach assures uniform presentation of list view output.

If you leave this blank, default styles apply, but vary depending on the Type field of the user's portal rule and any skin rule that the portal rule references. For additional information on styles, see:

• Understanding CSS styles.
• About the Style Viewer tool
• More about Skin rules
• More about List View rules

Styles referenced here affect only the presentation of this individual list view report. You can override the styles for all list view and summary view reports at the portal level, through a skins rule that references report styles you have defined in your application. See About Skin rules.

Field

Description

You can use this optional array to define styles applied to specific rows of this display.

For each row, the system evaluates all the conditions (in the order you enter them) and applies the style in the first row that evaluates to true. If none is true, no style is applied.

Optional. Enter the name of a when condition rule or a boolean Java expression.

The when condition rule can evaluate property values in the row. For example, you can apply a special style to those rows of a list view report that contain your own Operator ID in a certain column.

Optional. Identify a style for a table row if the expression is true. This becomes the value of the CLASS=" " attribute for the <TR> table row element. Choose a style defined in the style sheet identified in the Style Name field.

Field

Description

Optional. Identify the name of a style for the first, third, and other odd-numbered rows of the output.

Optional. Identify the name of a style for the second, fourth, and other even-numbered rows of the output.

Field

Description

Optional. Identify an activity to run upon single click after a row is selected.

Optional. Identify a script function to run upon single click after a row is selected.

Optional. Identify an activity to run upon double-click after a row is selected. This capability is not available when the Embedded option (on the Display Fields tab) is selected.

Optional. Identify a script to run upon double-click after a row is selected.

Optional. This field appears only when the Enable Selection of Rows option is selected on the Selectable tab. Identify a callback JavaScript function with the signature:

(nRow, strClass, strInsName, strInsKey, strCategoryProp, strCategoryValue, lvRowItem, options)

where:

• nRow — index of the row, starting 1. If the Select All open is selected then this is set to -1.
  
• strClass — pxObjClass value of the record.
  
• strInsName — value of pxInsName
  
• strInsKey — value of pzInsKey
  
• strCategoryProp — category property (if categorization is enabled)
  
• strCategoryValue — category value (if categorization is enabled)
  
• lvRowItem — structure describing a single row, with these fields:
          getRowIndex
          getPageIndex
          getPageCount
          getKey
  
• Options.selected is true or false.

Your application can call the pega.ui.LVUtils.getSelectedRows() PublicAPI function to return an array of list view rows that the user selected.

Optional. Enter Tooltip text to appear for a row.

Used in IWM only. If selected, at runtime when the call script function executes, Process Commander creates an arraylist of all the fields in the selected row and then builds a AJAX JSON object, sent to the browser.

Optional. Identify the HTML frame in the display for the output of the event. The default frame is DETAILS.

Optional. Identify a script to run when this view is first displayed. This capability is not available when the Embedded option (on the Display Fields tab) is selected.

Optional. Identify an HTML Fragment rule that contains the functions identified above, or that references a static file containing the script functions.

The standard HTML fragment rule ListViewSelectorScript contains JavaScript functions that you can use here. To review documentation on these functions, select Help > APIs > Desktop. Then click the List View Script link in the Packages area.

Field

Description

Select to cause the list view display to include a rectangular area containing additional details for that row below each row. If selected the system finds and executes an HTML rule identified in the next field and presents the results below each row.

Clear this box to eliminate preview area beneath each displayed row.

This capability is not available when the Embedded option (on the Display Fields tab) is selected.

Optional. This field appears only when the Show row preview? box is selected.

Enter the second key part of an HTML rule that is to appear at runtime when users open the optional expanded area. The system uses a concrete class identified at runtime as the Applies To key part of the HTML rule; this class can be the same as or a subclass of the Applies To key part of this list view rule.

Design the HTML rule to display additional details about the row, or other information that is meaningful to users in context.

If you leave this field blank but the Show row preview? box is selected, the system at runtime looks for an HTML rule named Preview by default. (Define at least one HTML rule in an appropriate Applies To class, since the standard placeholder rule @baseclass.Preview contains no fields.)

(In releases before Version 4.2SP6, the HTML rule was restricted to have the name Preview.)

Select if you want to allow the user to access (by single-clicking a row) a set of additional fields to appear inside a frameset border below the rows.

If selected, at runtime a single click executes the activity in the Single click event - call Activity field, and presents the results in the frameset.

This capability is not available when the Embedded option (on the Display Fields tab) is selected.

Optional. If you selected Display data in a FrameSet, specify here what percent of the height of the workspace is to hold rows of the report. For example, enter 80 to leave 20 percent of the height for the FrameSet information.

If you leave this blank, the default value is 70.

This field appears only when you select the Display data in a FrameSet check box.

Field

Description

Enter text to appear in the header of the pop-up window. Alternatively, if this list view report is to be localized, identify a field value rule to contain the header text.

Identify the name of an activity that computes the HTML text to be rendered. This activity must meet the following conditions:

• The Applies To key part of the activity matches the Applies To key part of the list view rule, or is a parent class of this list rule.
• On the Security tab, the May Start? check box is selected.
• The activity accepts a parameter named keyHandle.
• The activity assembles and returns text or an HTML stream that meets certain restrictions listed here.

For an example, review the standard activity Assign-.getWorkItemSmartInfo, which can be used to supplement worklist displays. It assembles an HTML stream by evaluating a section named Work-.WorkItemSmartInfo. (Although the standard activity is a Final rule, you can copy and override the section rule, to include fields in your application as appropriate, or copy the standard activity with a new name.

The activity can return HTML code that is a partial document that contains:

• No <HTML> or </HTML> elements
• No input fields
• No <TEXTAREA > elements
• No JavaScript code or calls

Additionally, when rendered by Internet Explorer as a pop-up, the window must be modest in size.

To aid users, include in the Description field a notification that this capability is available. For example:

Hold mouse pointer over any row to see details...

This facility uses AJAX to communicate user requests to the Process Commander server.

For an example activity that meets these criteria, see Pega Developer Network article PRKB-24125 How to enable a SmartInfo details display on report rows.

Select to have the Smart Info content embedded in the report to display when you click the expand arrow at the beginning of the row.

When selected, at runtime a Row Expand Arrow () changes to a Row Collapse Arrow (), the workstation sends a request to the server to run the Content activity specified in the previous field, and the resulting HTML output appears below the current line.

Optional. Select one field — from those appearing in the Display fields tab — to activate the Smart Info display — to cause the Smart Info display to appear only when the mouse pointer is held over a value in that field.

If blank, the Smart Info display is activated when the mouse pointer is held over any field in the row and does not move for at least 700 milliseconds. The workstation sends a request to the server to run the Content activity specified in the previous field, and the resulting HTML output appears in a pop-up window.

This field appears only when the Embedded? option is not selected.

Field

Description

Optional. Enter text to appear in the header of the pop-up window. Alternatively, if this list view report is to be localized, identify a field value rule to contain the header text.

Optional. Identify the name of an activity that computes the HTML text to be rendered. This field functions similarly to the Content field in Smart Info Settings.

Optional. Select one field — from those appearing in the Display fields tab — to activate the Smart Info display — to cause the Smart Info display to appear only from a right-click operation over a value in that field. If blank, the Smart Info display is activated from a right-click on any field in the row.

The workstation sends a request to the server to run the Content activity specified in the previous field, and the resulting HTML output appears in a pop-up window.

Field

Description

Optional. Select a section that specifies the content of the report display header.

Optional. Select a section that specifies the content of the report display footer.