Back Forward List View form
Completing the Selectable tab

About List View rules

AdvancedComplete this optional tab to enable users at runtime to select one or more rows of an embedded list view display and operate on the selected row or rows. This capability requires that the list view display be embedded in a section.

For example, this facility can support list view displays embedded within flow action forms. A flow action form can present a list of forty optional contract terms and conditions that can apply to a corporate loan, each with a check box. The user can select which of them are to apply to the loan application being processed.

For other examples, see How to present a list view display within a section.

If you choose Page List or Page for the Copy to field, complete a row on the Pages & Classes tab to identify the class of the destination page or pages.

Field

Description

Enable selection of rows

Select to cause the runtime display of a check box or radio button for each row. If not selected, other fields on this tab are ignored. Checking this option causes the Embedded option (on the Display Fields tab) to be selected.

When selected, you can identify a callback function (on the Format tab) to access the rows that the user selected.

Options

Mode

SmartPromptChoose:

  • Single Select — The user can select only one row of the report at runtime, by clicking to select one radio button. This mode is not supported if the Enable Paging box on the Organize tab is selected.
  • Multiple Select — A check box appears at the left of each report row. The user can select none, one, or more than one row of the report at runtime. A check box also appears in the header row; checking this box selects the check box on every row. This mode is available whether or not the Enable Paging box is selected.
Copy To

Indicate which clipboard page is to hold the properties recording user selections. Choose:

  • Content Page — User inputs are recorded in the pyRowSelected property on the Code-Pega-List pages created by the GetContent activity. (This choice is not available if the Enable Paging box on the Organize tab is selected.)
  • PageList — This choice appears when you choose Multiple Select for the Mode field. User's choices of none, one, or multiple rows are recorded on pages of an embedded property of mode Page List, identified in the Name field. The system creates one page for each selected row.
  • Page — This choice appears when you choose Single Select for the Mode field. Properties from a row selected (by clicking a radio button) can be copied into an embedded page or top-level page identified in the Name field.

CautionIf you choose Content Page, ensure that your application copies, saves, or acts on user selections quickly, because other processing may remove that page or overwrite that page with the results of a later list view execution.

Name

SmartPrompt This field appears only when you choose PageList or Page for the Copy To field.

Enter a reference to a property of the indicated mode to contain details of user choices. To indicate that the property is directly on the step page of the calling activity, start the property reference with a period.

The reference can be the keyword primary followed by a period to refer to the primary page of the stream that includes the list view at runtime, followed by a property name. In this case, enter primary on the Pages & Classes tab. For other cases, enter a fully qualified property reference, and identify the page containing the property on the Pages & Classes tab.

 

Add rowThis array appears only when you choose PageList or Page for the Copy To field. Identify the properties to be copied from the Get Content page to the property identified on the Name field.

At runtime, the .pyRowSelected Boolean property records user decisions. Any rows where this property has a true value are copied.

The .pxInsHandle property for a selected row is always copied; you do not need to list it in the array.

Source Property

SmartPrompt Select a property as a source; this property is from the pxResults(n) pages created by the GetContent activity.

Target Property

SmartPrompt Select a target property to hold the copied value of the source property.

Complete the Pages & Classes tab of this form to enable SmartPrompt is for this field.

zzz About List View rules