Harness and Section forms Adding a List View display

You can embed a report display (a list view display) within a section, harness, or flow action form using the ListView non-autogenerated control.

You cannot embed two list view displays using data from the same report within a single section.

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 and process rows of the report. For an example, see the PDN article How to embed a list view rule with check box options in a work object form.
3. Test the list view rule.

2. Add the ListView control to the form.

The List View control does not appear in the Advanced control group. Embed the report using the method described here..

1. Select the layout cell in which you want to embed the report.
2. Click () to display the Cell Properties panel.
   
   If the panel is pinned, the wireframe presentation on the rule form changes immediately to reflect your inputs. If the panel is not pinned, click OK to apply your inputs.

3. Complete the Cell Properties panel — Top fields

Complete the following fields.

Field	Description
Property	No property value is computed by this control.
Control	Select ListView. If the destination cell is not empty, the control replaces the current contents of the cell. Click () and complete the Parameters window. Parameter Description Applies To Identify the Applies To key part of the list view rule. Name Enter 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 Optional. 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. Click OK to close the window.
Behavior	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 () 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 ( ) on the Client Event Editor for assistance. For general information on this capability, see Harness and Section forms Help — Client Event Editor. Event support is available for harnesses, sections, and flow actions that have Generate for set to JSP on the HTML tab and that use the SmartFrames layout.

4. Complete the Cell Properties panel — General tab

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

5. Complete the Cell Properties panel — Advanced tab

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

 Notes

The control ListView supports the configuration described here. Do not select ListView in the Control field on the General tab of a Property form.

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

A specific list view display can occur only once in any user 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, and disable auto-generation of HTML code. See listView JavaServer Pages tag.

About Flow Actions

About Harnesses

About Sections

Open topic with navigation