Back Forward Harness, Section, and Flow Action forms
Adding a List View display

 About Harness rules

 zzz Show all 

You can embed a report display (a list view display) within a section, harness, or flow action form. When specified on the Selectable tab of the list view rule, users of the work object form can select and process rows of the report.

 zzz 1. Develop and test the list view

Create the list view rule to be presented.

  1. On the Display Fields tab, select the Embedded? check box. The Customize View and Customize Criteria capabilities are not available for embedded list views.
  2. Optional. If the list view display is to appear within a flow action, you can complete the Selectable tab to allow users to select one or more rows at runtime for processing from the display.
  3. Test the list view rule.

 zzz 2. Add the List View control to the form.

Click the down-arrow (Arrow) at the right end of the Advanced control group (Layout group) and select the List View control (Chart). Drag the control. When the pointer changes shape to indicate that you can drop the layout, release the mouse button.

If the destination cell is not empty, the dropped paragraph replaces the current contents of the cell. Click the magnifying glass icon (Magnifying glass) to display the Cell Properties panel.

 zzz 3. Complete the Cell Properties panel — Top fields

Complete the Cell Properties panel that appears.

If the panel is pinned, the wireframe presentation on the rule form changes immediately to reflect of your inputs. If the panel is not pinned, click OK to apply your inputs.

Field

Description
Property

Accept the property name .pyTemplateListView. This property is a placeholder; no property value is computed by this control.
Display As

SmartPromptAccept the default value ListView. Click the magnifying glass icon (Magnifying glass) to enter parameters for this pseudo HTML Property rule:

Parameter Description
Applies To

SmartPromptIdentify the Applies To key part of the list view rule.
Name

SmartPromptEnter the second key part — View Purpose — of the list view rule. The system uses ALL as the final key part.
Header

Select true or false to control whether a header appears above the report contents.
Action

Select:

  • refresh — Execute the list view rule, extracting and formatting data.
  • reuse — bypass report extraction when this same list view rule has run (in this user context with appropriate parameters) recently and the Code-Pega-List page is still present, containing the results.
Max Records

Optional. Enter a positive integer to limit the number of rows presented. At runtime, the system uses the lower of this value and the number in the Maximum Value field (on the Contents tab of the List View form). The system ignores this attribute when the Enable paging? box on the Organize tab is selected.
Remove Pages

Select

  • none — Do not remove pages
  • all — Remove the pages that contain the list view rule and the pages that contain the results. If the user later attempts to sort, the report data is re-extracted.
  • listview — Remove the pages that contain the list view rule.
Report Parameters

ArrayOptional. If the list view requires parameters, such as for selection criteria, complete this name and value array to supply parameter values. Order is not significant.
Client Event

Optional. Leave blank if no dynamic form actions to other parts of the form are to occur based on user updates or values for this field.

To establish a dynamic form action, click the magnifying glass icon (Magnifying glass) to open the Client Event Editor in a new dialog window. Complete the Client Event Editor to select an event (OnBlur, OnChange, or OnClick) and the resulting form action.

Click the help icon ( Help) on the Client Event Editor for assistance. For general information on this capability, see Implementing dynamic form actions and the Client Event Editor.

Event support is available for harness, section, or flow action rules that have Generate for set to JSP on the HTML tab and that use the SmartFrames layout.

 zzz 4. Complete the Cell Properties panel — General tab

The General tab for a ListView control is identical to the General tab for an Input Box control. See Completing the Layout tab — Adding a Input Box — General tab.

 zzz 5. Complete the Cell Properties panel — Advanced tab

The Advanced tab for a ListView control is identical to the Advanced tab for an Input Box control. See Completing the Layout tab — Adding a Input Box — Advanced tab.

 zzz Notes

The HTML Property rule ListView supports the configuration described here. Do not use the select this for the Display Property field on the General tab of a Property form.

You can't use the report paging feature in a list view display within Smart Info pop-up section that has a close box.

A specific list view display can occur only once in any work object form or flow action form.

As an advanced alternative to the approach described here, you can use the listView JSP tag in hand-coded flow action, section, or harness rule, and disable auto-generation of HTML code. See listView JavaServer Pages tag.

zzz About Flow Action rules

zzz About Harness rules

zzz About Section rules