LinkedIn
Copied!

Table of Contents

Dropdown control Properties — General tab

Click the View properties icon in the layout containing the drop-down control ( pxDropdown ) to display the Properties panel, and then select the General tab to define the source of values in the drop-down list.

Field Description
Property Press the down arrow to select a property, the value of which will be set by the option selected from the drop-down list at run time.

You can configure a list of options for the drop-down control in the List Source area, as well as select the caption and value for the options. Dropdown options can come from the list defined on the property or from a clipboard page, data page, or report definition.

If the set of possible values is provided by a property using the Table Type field , specify a Single Value mode property that has a Table Type other than None.

For Single Value properties in the Applies to class (or higher) of the current rule, you can drag a property name, from the list of properties visible in the Application Explorer, into the layout. If the container that holds this field has a non-blank Using Page value, you can drag a Single Value property from within that embedded page property.

Click the Open icon to review a property (if the reference is to an existing property in the Applies To class of this rule or a parent of that class). If the property is not found, the New dialog box for the property form appears.

You can reference properties on any page identified on the Pages & Classes tab, using the normal notation pagename.propertyname for pages other than the page corresponding to the Applies To class of the rule.

If this field is in a cell of a section that includes parameter declarations on the Parameters tab, you can enter the notation param.NAME here, to use a parameter value for the field, where NAME identifies a string parameter. Make sure that the NAME parameter is declared on the Parameters tab, and that your application provides a non-blank value for the parameter value in all possible situations where the section appears. See Sections Completing the Parameter tab.

Label Select Use property default to use the label Dropdown.

Clear the check box to either type a text string, or select a field value from the SmartPrompt list that contains records with Field Name key part of pyCaption.

Click the Open icon to open a field value or create a one.

Default value

Optional. Enter a constant value for an expression, to be used only when the user form or flow action form appears in read-write mode rather than read-only mode.

Click the Open expression builder icon to start the Expression Builder.

Choose a default value that speeds data entry. When the system renders a harness or section in read-only mode (for example because the read-write mode requires a privilege that the current user does not hold), the default value does not appear, because data entry is not permitted.

Tooltip If you want to display a tooltip when the user hovers the mouse pointer over the drop-down list, type a text string such as Select to open an item, or select a field value from the SmartPrompt list that contains records with Field Name key part of pyActionPrompt.

Click the Open icon to open a field value record or create a new one.

This tooltip applies to the entire drop-down list.

If the List Source Type is Data page, Clipboard page or Report definition, you can also specify a tooltip that displays when the user hovers the mouse pointer over an item within the drop-down list. To do this, specify the Property for tooltip in the List Source area on the General tab.

Visibility Select to determine when the property value is to appear. Always is the default. (If this setting is not applicable, the cell contents are blank.)
  • Choose Always, If Not Blank, or If Not Zero to have the field appear or be hidden based on the property value at the time this area of the user form (section or flow action) is first presented or refreshed. This condition is checked only once.
  • Choose Condition (when) or Condition (expression) to make the visibility depend on a when condition rule or a Java expression.
Do not make an input field invisible if your application expects user input on the field. When a user submits an HTML form, an input field that is not visible is not included in the HTTP details.
Disable
Required Appears only for fields in cells on flow actions and sections. Select to require that when the form appears at runtime in read-write mode, users cannot successfully submit the form if the field is blank.

Selecting Required marks the label for this field with an orange asterisk when the flow action form appears in read-write mode. (The asterisk also appears if the Label control's Value For field is not blank and the Label control's Required box is checked.)

For sections, checking this box enables client-side format validation when this section is part of a harness form that has the Enable Client Side Validation box selected on the HTML tab. At runtime, users who leave this field blank and submit the form are notified immediately that the field is required; the form is not transmitted to the server.

Include placeholder Select to display by default a hint or instructional text that helps users select a correct value.

Either enter a text string, or select a field value from the SmartPrompt list that contains records with Field Name key part of part of pyCaption.

Click the Open icon to open a field value record or create a one.

List Source
Type Select one of the following as the source for the drop-down list:
  • As defined on property
  • Data page — specify the data page in the Data Page field.
  • Clipboard page — specify the clipboard page in the Source field. The clipboard page should be a PageList property. After you select a PageList property more options become available.
  • Report definition — specify the class in the Applies To field and then select the Report Definition.

When the source is a clipboard page, data page, or a report definition, you can categorize items within the drop-down list. When a drop-down list is bound to a data page or report definition that accepts parameters and the parameter value uses a property reference, the drop-down list automatically refreshes with new items whenever the property value changes. No additional configuration is required. This can be used to set up cascading dropdowns or any combination of controls.

Run Data Transform

Displays when the List Source Type is Clipboard page.

Select to run a data transform prior to populating the drop-down list. Press the down arrow in the Data Transform field and select the data transform.

Run Activity

Displays when the List Source Type is Clipboard page.

Select to run an activity prior to populating the drop-down list. Press the down arrow in the Activity field and select the activity that you want to run.

Property or value

Displays when the List Source Type is Clipboard page.

Press the down arrow to select the data page that you want to use as the source of the drop-down list's values.

Property for display text

Displays when the List Source Type is Clipboard page.

Press the down arrow to select the value that you want to display as the label for the radio button values.

If you do not specify a value, the display text defaults to the specified Property for value.

Property for tooltip

Displays when the List Source Type is Clipboard page.

Press the down arrow to select a value that you want to use as the source of the tooltip text. Tooltip text displays when the user hovers the mouse pointer over the radio buttons.

If you do not specify a value, then a tooltip does not appear for the radio buttons.

Data Page

Displays when the List Source Type is a Data page.

Press the down arrow to select the data page that you want to use as the source of the drop-down list's values.

If the data page has parameters, you can pass parameter values to the data page. Press the down arrow in the Value field to specify the value that you want to pass to the data page. Using parameters, you can filter the results that are returned to the drop-down list from the data page. For example, if a data page contains the values of work objects W-001 to W-9999, by passing a parameter value, you can filter the results and populate the drop-down list only with those work objects beginning with W-1.

Clipboard page

Displays when the List Source Type is a Clipboard page.

Required. Press the down arrow to select the page list property that you want to use as the source of the drop-down list's values. Identify the page on the Pages & Classes tab. See Defining the pages and classes of a rule.

Applies To

Displays when the List Source Type is a Report definition.

Required. Specify the Applies To class of the report definition.

Report Definition

Displays when the List Source Type is a Report definition.

Required. Press the down arrow to select the report definition that is the source of values for the drop-down list.

If the report definition has parameters, you can pass parameter values to the report definition. Press the down arrow in the Value field to specify the value that you want to pass to the report definition. Using parameters, you can filter the results that are returned to the drop-down list from the report definition. For example, if a report definition contains the values of work objects W-001 to W-9999, by passing a parameter value, you can filter the results and populate the drop-down list only with those work objects beginning with W-1.

Value property

Displays when the List Source Type is a Data page, Clipboard page or a Report definition.

Required. Press the down arrow to select the select the value that you want to display as text in the drop-down list.

Caption property

Displays when the List Source Type is a Data page, Clipboard page or a Report definition.

Press the down arrow to select the value that you want to display as the label for the drop-down list's values.

If you do not specify a value, the display text defaults to the specified Property for value.

Tooltip property

Displays when the List Source Type is a Data page, Clipboard page or a Report definition.

If you want to display a tooltip when the user hovers the mouse pointer over the item in the drop-down list, press the down arrow to select the source of the tooltip text.

If you do not specify a value, then a tooltip does not appear for the item in the drop-down list.

To specify a tooltip that applies to entire drop-down list, complete the Tooltip field on the Presentation tab.

Group items Displays when the List Source Type is Data page, Clipboard page or Report definition. Select if you want to categorize items within the drop-down list.
Group by

Displays when the List Source Type is Data page, Clipboard page or Report definition and you select the Group items check box.

Press the down arrow to select the property by which you want to categorize items in the drop-down list.

Groups displayed in

Displays when the List Source Type is Data page, Clipboard page or Report definition and you select the Group items check box.

Select the radio button next to how groups will be displayed in the drop-down list — either alphabetically in Ascending order or in Descending order.

Load behavior Specifies when the drop-down list is loaded at runtime. Select one of the following options:
  • At screen load (Default) — loads when the content of the list when the UI renders
  • On user hover — defer loading the content of the list until the user hovers the mouse pointer over the list. You may want to use this option if the drop-down list contains a large number of items and is not a required field.
  • After screen renders — defer loading the content of the list until after all other UI elements are rendered. If the list is large, this option improves the initial rendering time of the UI.
Identifiers
Tour ID Optional: Provide an ID for use in a guided tour. Use a combination of numbers, letters, and underscores. Pega Platform uses the Tour ID when it finds an anchor button during a tour stop anchor point.
Test ID

Optional: If authorized, you can provide a unique Test ID to better support automated testing of your application.

When creating a control that supports you can use a combination of numbers, letters, and underscores, or click the Generate ID button to create a unique ID. The attribute data-test-id is then generated for the selected element.

After the test ID has been generated, you can view your Test ID in HTML or display it in the Enabling run-time branching and editing panel. You also have the option to have all controls that support Test IDs in a ruleset updated in bulk.

The Test ID is available to access groups that include the PegaRULES:TestID privilege. To disable Test ID, remove the PegaRULES:TestID from the access group.

  • Dropdown control

    Use the Dropdown control to display a list of options, from which the user can select a single option. The list of options can be defined in a list bound to a property, or a clipboard page, a data page, or a report definition.

  • Autocomplete Properties Presentation tab

    Click the View properties icon of an autocomplete control to display the properties panel, and then click the Presentation tab to configure the display of the autocomplete control.

  • Creating an action set

    Define an action set to specify what a control does when a user event happens.

  • Control form - Actions tab

    Action sets determine the behavior of a control.

  • Available actions and conditions

    Choose an action from the list, see which options are available for the action and when you can use it. Learn which conditions you can apply.

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.