Skip to main content
LinkedIn
Copied!

Table of Contents

Control form - Completing the Control tab

Applicable to Theme UI-Kit applications

Pega Platform includes a set of standard auto-generated controls. As a best practice, use these controls to save development time and ensure consistency. By default, this tab is displayed when you open an auto-generated control or open a New rule.

Benefits

Auto-generated controls provide these benefits:

  • Eliminate hand-coding, which simplifies design and maintenance.
  • Let you to customize a control in a section or harness without having to make multiple copies and reconfigurations.
  • Preserve custom settings when you upgrade your system.
  • Eliminate inline JavaScript, which reduces cross-site scripting (XSS) vulnerabilities and improves performance.
  • Ensure browser independence and compatibility.

Customizing a control in a section

Auto-generated controls are optimized for most interfaces. If necessary, edit the settings within the section, flow action, or harness in which you are working.

  1. Open the section or harness that contains the rule.
  2. Select the cell that holds the rule and click the View properties icon to open its Cell Properties window.
  3. In the panel, click the Open icon next to the control name.

    The control Parameters tab opens, which lists the available settings. Note, that you cannot edit the Control Modes or UI Element settings.

  4. Modify the settings and save the section.

    The system generates the XML representing your edits and stores it in the section.

To reuse a modified control, save a copy of this control to your ruleset and change the Stream Name key part. Keep the original Control Modes and UI Element settings. As a best practice, do use an auto-generated rule to build an entirely new control.

When you clear the Auto-Generated? check box on the HTML tab, the Parameters tab appears.

Any customization that you make to the control in the section is maintained even if the control later changes. Parameters that are not customized apply to all of the instances. For example, if the Expand Options setting in the rule is Collapsed With Icon and you customize the control's Parameter dialog setting to Expanded With Icon, updating the rule setting to No Scrollbar does not change the custom parameter. If you had not customized the Expand Options setting, your rule update is reflected in the control's Parameter tab.

If you want to revert to the control's configuration, clear the customized instance and re-add the rule.

For more information, see Supported controls when working offline.

Control tab settings

These settings determine the read-only and edit-mode presentation and behavior of the control.

Field Description
Control Modes Before you begin editing the rule, use the radio buttons to filter the initial array of options and parameters in the form. Select one of the following:
  • Editable/Read-only if you want to configure the associated property for both edit and read-only modes. The options appear in the Basics, Format, Options, and Behaviors areas under Editable and Read-Only column headings. You can configure the following UI Elements:
    • Text input
    • Text area
    • Date time
    • Checkbox
    • Radio buttons
    • Dropdown
    • Autocomplete
    • Rich text editor
    • Address Map
    • Multi-select list
    • Tracking Map
  • Read-Only if you want a control that always appears as non-editable text. The Editable column does not appear.
  • Action to set the UI Element to Button, Image, Link, Attach content, Signature capture, Chart, Menu, Video, or Timeline. Only one column of settings appears, which applies to both editable and read-only control modes as defined in other parameter settings in this form.
The Control Modes setting does not appear in the Parameters dialog when customizing the control in a section.

Basics

Use this section to specify the control or category of property type used with the control.

Field Description
UI Element For Editable/Read Only and Action control modes, select the type of control that appears on the layout. For Read-Only mode, select the type of presentation of the property value. You select filters the Format, Options, and Behaviors settings this tab.
  • Autocomplete – Add an Autocomplete control. Available when Control Mode is set to Editable/Read-Only.
  • Checkbox – Add a Check Box control. Available when Control Mode is set to Editable/Read-Only.
  • Dropdown – Add a Dropdown control. Available when Control Mode is set to Editable/Read-Only.
  • Multi-select list – Add a Multi-Select list. Available when Control Mode is set to Editable/Read-Only.
  • Radio buttons– Add a Radio Button control. Available when Control Mode is set to Editable/Read-Only.
  • Text area – Add a Text area control, which can contain more than one line of text. Spell checking is enabled by default. Available when Control Mode is set to Editable/Read-Only.
  • Text input – Add a Text Input control. Available when Control Mode is set to Editable/Read-Only.
  • Button – Add a button (with a text label) that triggers an action when clicked. Available when Control Mode is set to Action. You can include an image next to the label. You can use the Skin rule to specify and create button styles.
  • Text – Display values of property types that include text, number, boolean, and date/time. Available when Control Mode set to Read-Only.
  • Hidden – Use this element when you want to include a property value that is submitted but is not visible to the user. Available when Control Mode is set to Read-Only.
  • Image – Add an icon that triggers an action when clicked or hovered on. Available when Control Mode is set to Action. You can use standard icons or create custom ones. Available actions are the same as the Button control.
  • LinkAdd a text link that triggers an action when clicked or hovered on. Available when Control Mode is set to Action. You can include an image next to the label. You can use the Skin rule to specify and create link styles. Available actions are the same as the Button control.
  • Date timeAdd a Calendar control. Available when Control Mode is set to Editable/Read-Only.
  • Attach content – Add an Attach Content control. Available actions are the same as the Button control.
  • Rich text editor – Add a Rich Text Editor control. Available when Control Mode is set to Editable/Read-Only.
  • Timeline – Add a Timeline control. Available when Control Mode is set to Action.
  • You cannot edit the UI Element field in the Parameters dialog.
  • The Generated UI element is for future use only.
Value Select a single-value property or text string that contains the value you want to associate with the control. This option does not appear in Action control mode. Select one of the following:
  • Value of associated property – Uses the property or field value entered in the Properties field in the control's Cell Properties panel (located in the section). In edit mode, this setting is the default and cannot be changed.
  • Value of a different property – A Single Value property or field other than the one in the Properties field. 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.
  • Constant – A text string.
    If the Localize? check box is selected on the section's HTML tab, a SmartPrompt appears in the Constant field in the Parameters dialog. Select a field value rule if you plan to localize the text. Enter no more than 64 characters. A field value rule with pyCaption as the second key part and this text as the final key part is needed for each locale.
When a property is computed through a Declare Expression rule, the system presents the value as read only in the control's read-only format.

Options

Use this section to specify parameters for editable and action control modes.

Field Description
Specify Size Available when the UI Element is Text input.
  • Auto – Select if you want the layout to determine the width of the control area. Default.
  • Custom – Select to specify a fixed value in the Width field.
Min/Max Chars Available when the UI Element is Text input or Text area.

Optional. Enter a value that determines the minimum and maximum number of characters that can be entered in the text field or text area. You can designate either value as unlimited by leaving it blank.

Display Character Counter Available when the UI Element is Text area and you specify Max Chars.

Determines whether a count of remaining characters displays at runtime. The counter decrements as the user types. Once the character limit is reached, additional characters are not accepted.

Placeholder Optional. Available when the UI Element is Text input, Text area, Dropdown, Multi-select list, or Date time.

The text disappears when the user enters a value. If no value is entered, the placeholder text reappears when the field loses focus. You can style Placeholder Text in the Skin.

  • Other – Select to display inside the field a hint or instructional text that helps users enter a correct value.
  • Expected Format (Date Picker only) – Select to display the localized DateTime Format value selected in this control.
Specify Width Available when the UI Element is Text area or Rich text editor.
  • Auto – Select if you want the layout to determine the width of the control area. Default.
  • Custom – Select to specify fixed value in the Width field. You can override this setting in the layout.
Width Available when the UI Element is Text area, Text area, Text input, or Dropdown and you select Custom.

Enter a positive integer that is a pixel count, a percentage of the cell area, or a number of columns (Text area only). In the pull-down list to the right of this field, select the unit of measure: px, %columns

Specify Height Available when the UI Element is Text area or Rich text editor.
  • Auto – Select if you want the layout to determine the height of the control area. As a best practice, use this setting.
  • Size to Content – Select if you want the height to expand with the content. This selection also provides collapse options.
  • Custom – Select to specify a fixed height. You can override this setting in the layout.
Height Available when you select Custom in the Specify Height field for Text area or Rich Text Area.

Enter a positive integer that is a pixel count or number of rows. In the pull-down list to the right of this field, select the unit of measure. To ensure uniform text area heights within a layout, do not mix row and pixel settings.

Scrollbar Available when the Text Area Height is Custom.

Select to display a scrollbar to the right of the area if the content exceeds the number of rows or pixels.

Min Height Available when the Text Area Height is Size to Content.

Enter a positive integer that is a pixel count or number of rows. In the pull-down list to the right of this field, select the unit of measure.

Collapsible Available when the Text Area Height is Size to Content.

Select one of the following:

  • No – The text area is presented i at a size determined by the Width and Height settings. The user cannot expand or collapse the text area.
  • Yes, Default Expanded – The text area is initially presented in expanded mode at a size determined by the Width and Height settings. The user clicks the Collapse icon to collapse the text area.
  • Yes, Default Collapsed – The text area is initially presented in display-only mode, with only the Min Height value visible. The user clicks the Expand icon to expand the area.
Date/Time Available when the UI Element is Date time.

Enables date and time selections in the Calendar control. Select one of the following:

  • Auto – Based on the associated property type, the system enables the appropriate date or time selections in the control as follows:
    • DateTime — Enables date and time selections. For example, in Drop-down Lists mode, six lists are displayed — one for each date and time value.
    • Date — Enables date selection only. For example, in Calendar mode, the time selection function does not appear in the pop-up calendar.
    • Time ( TimeOfDay ) — Enables time selection only. For example, in Drop-down Lists mode, three lists are displayed — one for each time value.
  • DateTime – Enables date and time selections.
  • Date – Enables date selections only.
  • Time – Enables time selections only.

As a best practice, use the non-auto options only with DateTime properties or dates stored as valid text strings. Using an option that is unsuitable for the property type may present an incorrect read value at run-time. For example, enabling the Date option for a TimeOfDay property will not display a result.

Display Mode Available when the UI Element is Date time.

Determines the presentation of the control to the user. Select either:

  • Text Input + Calendar – Default. Display a text field that contains a calendar icon. The user can click the icon to select the date and time values in a pop-up calendar. Alternatively, the user can enter a date as a text value by clicking inside the field.
  • Dropdown Lists – Display an array of drop-down lists from which the user selects the day, month, year, hour, minute, and A.M./P.M. Locale settings determine the order of the drop-downs. Use this option if the interface is configured for accessibility.
Allow Text Entry Available when the UI element is Date time and the Display Mode is Text Input + Calendar.

Click Yes (default) to enable the user to enter a text value in the field. Click No to prevent text entry.

Enable Calendar Available when the UI Element is Date time and the Display Mode is Dropdown Lists.

Click Yes to display a calendar icon with the drop-down lists in the field. This enables the user to use the lists or the pop-up calendar to pick dates and times. No is the default.

Number of Years Required. Available when the UI Element is Date time and the Display Mode is Dropdowns.

Enter a numeric value indicating the date range (in years) in the Year drop-down list. The list contains an equal number of years forward and backwards from the current year. If the value is an odd number, the odd date is counted as a future year. For instance, a value of 11 displays a range of 2007 to 2017.

Caption Available when the UI Element is Checkbox.

Enter text describing the purpose of the control. The user can click this text to select or deselect the check box.

Caption Position Available when the UI Element is Checkbox.

Select Left or Right to indicate where you want the caption text to appear in relation to the check box image.

Label Available when the UI Element is Button (optional), or Link.

Enter text or select a property or field value that contains brief text, which appears on the button or as a text link.

Configuring labels

As a best practice, start the text with a verb. Consider the collection of controls that appear at runtime collectively; provide each control with a clear and distinctive label. For example, Cancel order.

To allow users to execute an action using a shortcut key combination, include an ampersand character (&) immediately before a letter in the caption text. At runtime, users can press the ALT key and the letter key together to execute the activity. For example, enter &History as a caption text to allow users to access work item history with ALT + h. At runtime, the label appears with the shortcut key underscored, as in Visual Basic applications.

If you use shortcut keys in your application, be careful to choose distinct letters for each control; for example, you can't have ALT + c as the label for both the Contents button and Close button. (To include an ampersand in a label as text, follow the ampersand by a space character.)

Localization

Use SmartPrompt to select a field value rule if you plan to localize the text. Enter no more than 64 characters. A field value rule with pyButtonLabel as the second key part and this text as the final key part is needed for each locale. When practical, choose a caption already included in a language pack, to simplify later localization. See About the Localization wizard.

Tooltip Optional. Available when Control Modes is Action or Editable/Read-Only (all UI Elements except Date Picker ).

Select a property value or enter a constant that contains a sentence or phrase identifying to users the purpose and function of the control.

As a best practice, start the sentence with verb either in the imperative ("Enter price of item here") or as an infinitive ("To cancel the order, click here").

When UI Element is Icon, the system enters a default value here based upon the value selected in the Icon field.

Localization

Use SmartPrompt to select a field value rule if you plan to localize the text. Enter no more than 64 characters. A field value rule with pyActionPrompt as the second key part and this text as the final key part is needed for each locale. When practical, choose a caption already included in a language pack, to simplify later localization. See About the Localization wizard.

Format Available when the UI Element is Button or Link. Select a pre-defined format ( Standard, Simple, Strong ), which is configured in the Skin rule. The default selection is Standard. Use the Skin rule to modify the settings for these formats.

Alternatively, select Other to reference a custom format created in the Skin rule. A blank field appears when you select this option. Enter the format name.

Privilege Optional. Available when the Control Mode is Action .

Select the Privilege Name key part of a privilege rule that controls the availability of this control at runtime. During rule resolution at runtime, the system uses the Applies To key part of the current rule as the first key part.

If there is a privilege and a when rule (see Disabled field), both rules must evaluate to true for the button to be available to the user.

When Not Met Available when you enter a privilege. Select Hide or Disable (the button) if the user fails the privilege rule.
Image (for Button or Link) Optional. Available when the UI Element is Button or Link.

Insert an icon next to the label by clicking the Show Image Viewer icon . This opens the Image Viewer. Select the binary file you wish to use.

If the button or link Format, for example, Standard, contains an image in the background, then that image overlays the image specified here. Button and link formats are defined in the Skin rule.

Image Position Available when you enter an image in the Image field.

Select Left or Right to indicate where you want the image to appear in relation to the label.

Disabled Optional. Available when the Control Mode is Action.

Select Yes if you want to apply a when condition that tests whether the user can use the control. If selected, the following options appear:

  • Disabled Condition – Select one of the following:
    • The When Name key part of a when condition rule. Click the Open icon to review or create the rule.
    • 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 using the && and || operators.

    As a best practice, use the Condition Builder to edit this field. Click the Open condition builder icon to open the tool.

  • Run On Client – Appears only if the Disabled Condition field contains an expression that can be evaluated on the client. Complex expressions and When rules are not eligible.

    Select to cause evaluation and execution of the condition each time the value of a property stated in the condition changes.

    If unselected, the expression is evaluated and the condition executed when the form is initially presented and whenever the form is refreshed.

Icon Available when UI Element is Image. Select a standard icon from the drop-down list. By default, the Blank icon is selected when pxIcon is entered in the Control field on the Cell Properties dialog.

If you specify a standard pxIcon variation such as pxIconPrint or pxIconReview, the system selects a standard icon for that rule. For example, if the control is pxIconAddItem, the Add Item icon is selected. See Section, and Flow Action forms — Adding an Icon Control for icon descriptions.

To use a custom icon, select Other.

Image (for Icon) Available when you enter Other in the Icon field. Click the Show Image Viewer icon to open the Image Viewer. Select the binary file you wish to use.

As a best practice, use sprites rather than individual images for Icon controls.

Position Available when the file you select in the Image field is defined as a sprite on the Binary File rule form. See Binary File — Completing the Main tab.

The numbers in the drop-down reflect the number of columns in the sprite. Select the number you wish to use for this control's action. The value in the Tooltip field applies to this position.

For information about icon positions, hover the mouse pointer on the help icon next to this field.

Format

Use this area to design the appearance of read-only text or an editable control. Action controls do not use formats.

Field Description
Type Select a format (read-only) used with this property. Your selection filters the format options.
  • None The property is not formatted.
  • Text Unedited text, which may contain spaces, tabs, line break characters, and other control characters.
  • Number Numeric properties on output.
  • Date/Time Renders DateTime and Text property types in date and time format. See Understanding the Date, Time of Day, and DateTime property types.

    Specify the format in the DateTime Format field.

  • Date Renders DateTime and Text property types in date-only format (hours and minutes are not displayed). See Understanding the Date, Time of Day, and DateTime property types.

    Specify the format in the Date Format field.

  • True/False Boolean values.

    Specify the format in the True Label and False Label fields.

Obfuscated Available when Type is Text.

For read-only, select Yes if you want to display to the user the characters as a string of bullets.

For Editable ( Text Input ), select Yes if you want the characters entered by the user to appear as a string of bullets. The input characters are initially added to the clipboard as unencrypted, clear text values. The system computes the hashed value only as the page is committed to the PegaRULES database. Thereafter, the hashed value appears in both the clipboard and the database row.

Decimal Places Available when Type is Number.

A non-negative integer to control the number of digits presented after the decimal place. The default is Auto, which displays a maximum of three decimal places (placeholder zeroes are not added). Select to remove all digits after the decimal point and round to the nearest integer. Select All to include all digits.

Scale Available when Type is Number.

Select a label indicating the scaling you wish to apply to the number. The scales are K for thousands, M for millions, B for billions, and T for trillions. For instance, if you select Thousands, a value of 20,000 appears as "20 K." If Percentage, the value appears as a percentage sign (.8 appears as "80%").

Negative Format Available when the Type is Number.

Select a format (minus sign or parenthesis) for displaying negative numbers.

You can also specify a CSS class if you select one of the Style Ref options. By default, the class name is NegativeNumber.

Symbol Available when Type is Number. When a symbol is specified an additional character(s) is prepended to the value. Currency automatically uses the localized currency symbol, constant uses a string, and reference uses a property value.

Select an option for representing the number as

  • Currency — Formats the number as a currency using the default locale.
  • Constant — A text string or character (for example, "%") ASCII character that you enter.
  • Reference — A property value.
Separators Available when Type is Number.

Select to use a thousands' separator. Depending upon the default locale, a comma or period is used.

Text Alignment Available when Type is Number.

Select left, right, or center alignment.

Auto Prepend / Auto Append Available when Type is Text and the control is not obfuscated.

Select a property or constant that you want to add either before or after the displayed property value. For example, when the user name appears, the system can automatically append the full mail extension to the name or prepend the user's title.

DateTime Format or Date Format Use a custom display by selecting "Custom" from the format drop-down list. Enter the appropriate symbols in the field to the right of the drop-down menu to customize the format. For example, if you enter:

EEE, MMM d, yy h:mm a

it will display as:

Sat, May 1, '99 2:00 PM

Note that symbols are case-sensitive. Common symbols include:

  • y - the year number
  • M - the month in a year (text or number)
  • d - the day number in a month
  • E - the day name in a week
  • Y - the year
  • H - the hour in the day (0-23)
  • h - the hour in AM/PM (1-12)
  • m - the minute number in an hour
  • s - the second number in a minute
  • a - indicates AM or PM

Additionally, the number of symbols used determines the display format (when applicable):

Display type Number of symbols used Output
Text 1-3 Abbreviation (if applicable)
Text 4 or more Full form
Number 1 or more Numbers shorter than the number of symbols used are padded with zeroes when applicable

Years are abbreviated to the last two numbers if fewer than four "y" symbols are used

Text and Number 1-2 Number form
Text and Number 3 or more Text form

Consult the online Java tutorial on SimpleDateFormat for a complete list of custom symbols.

Round second number after Available when DateTime Format is 2 days, 5 hours ago (elapsed time).

Enter a numeric value for the first unit, which determines when the second unit is truncated in the display. When the first unit number reaches or exceeds this value, the second unit does not appear.

For instance, if you set the cutoff value to 5, here is how these dates and times will appear to the user:

1 hour, 45 minutes ago

2 hours, 45 minutes ago

3 hours, 45 minutes ago

4 hours, 45 minutes ago

5 hours

6 hours

etc.

Enter a value of 0 to always display a single unit.

True Label / False Label Available when the Type is True/False.

Enter a text string to label either outcome. Used with a boolean type.

If the Localize? check box is selected on the section's HTML tab, a SmartPromptAppears in the Constant field in the Parameters dialog. Select a field value rule if you plan to localize the text. If this text is to be localized. enter no more than 64 characters. A field value rule with pyCaption as the second key part and this text as the final key part is needed for each locale.

Show validation messages in read-only mode Select this option to display validation errors to users at run time. When enabled for auto-generated controls in read-only mode, if the control's validation fails, the validation message is displayed. This option is available on the Presentation tab under Read-only Format . It is also available in the control ruleform. When enabled on the control ruleform, all controls using that ruleform have the option enabled.

To configure actions on the control, select the Actions tab.

Related Content

Did you find this content helpful?

Have a question? Get answers now.

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

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega Community has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice
Contact us