Radio Buttons control Properties — General tab

Field

Description

Select a property, the value of which will be set by the radio button selected at run time.

You can configure a list of options for the radio buttons in the List Source area, as well as select the caption and value for the radio button options. Radio button 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 into the cell from the list of properties visible in the Application Explorer. 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 the 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.

Select Use property default to use the label RadioButtons.

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.

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.

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.

• 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 Other Condition 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.

Specify a condition for disabling the text input:

• Never – Never disabled
• Always – Always disabled
• Condition (expression) – The text input is disabled under the specified condition. In the field that is displayed, select a condition or click the Gear icon to open the Condition Builder. You can define a simple expression based on the comparison of a pair of constants, properties, or both, combined by Boolean operators, such as .Color="Red". You can combine the expression with a when condition rule or another expression by using the && and || operators.
• Condition (when) – The text input is disabled under the specified condition. In the field that is displayed, select a when rule. Click the Open icon to create a when condition or review an existing when condition.

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.

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.
• Report definition— specify the class in the Applies To field and then select the Report Definition.

When a radio button control is bound to a data page or report definition that accepts parameters and the parameter value uses a property reference, the radio button group automatically refreshes with new items whenever the property value changes. You can use this functionality to set up cascading radio button lists, or any combination of controls — no additional configuration is required.

Displays when the List Source Type is a Clipboard page.

Required. Press the down arrow to select the clipboard page that you want to use as the source of the radio button values. Identify the page on the Pages & Classes tab. See How to complete a Pages & Classes tab.

Displays when the List Source Type is Clipboard page.

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

Displays when the List Source Type is Clipboard page.

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

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 radio button 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 radio button list from the data page.

Displays when the List Source Type is a Clipboard page.

Required. Press the down arrow to select the clipboard page that you want to use as the source of the radio button values. Identify the page on the Pages & Classes tab. See How to complete a Pages & Classes tab.

Displays when the List Source Type is a Report definition.

Required. Specify the Applies To class of the 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 radio buttons.

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 radio button list from the report definition.

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

Required. Press the down arrow to select the source of the radio button values.

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 radio button values.

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

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

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.

Optional. If authorized, you can provide a unique Test ID for use in your test suite in order to support better automated testing against any Pega application.

When creating a control that supports Test ID, the Test ID field is initially blank. Use a combination of numbers, letters, and underscores, or click the Generate ID button to create a time stamp as a unique ID. The attribute data-test-id is then generated for the selected element.

When you save an existing section, any supported controls that do not have a Test ID will have one automatically generated. You can override these with a custom ID at a later time.

Once generated, you can view your Test ID in HTML or display it in the Live UI panel.

You also have the option to have all controls that support Test IDs in a ruleset updated in bulk.

A standard, out-of-the-box developer role, PegaRULES:SysAdm4, includes the privilege for Test ID. To disable Test ID for this role, modify the pxTestID privilege.