You are here: Reference > Standard rules > Control rules (parameters)

Standard controls accepting parameters

Basics

Your system contains hundreds of standard controls (formerly HTML Property rules). Use the Records Explorer to see a complete list of the standard and custom controls available to you. Standard controls described in the table below accept input parameters.

Use these parameter-based or auto-generated controls to present properties in the fields of sections, flow actions, and harnesses rather than controls that do not accept parameters. Your application uses fewer distinct rules and operates more efficiently. In hand-edited HTML code, use the <pega:param > option of the <pega:reference > JSP tag to supply parameter values. See Standard controls without parameters and Standard auto-generated controls.

Entering parameter values

The Pega Platform offers three places you can specify values for these parameters:

tools.putParamValue("DateFormat","2");
tools.getParameterPage().remove("DateFormat).

The Calculated Value parameter

Several of the standard rules listed in the following table accept a Boolean parameter named CalculatedValue. Set the CalculatedValue parameter to true when the property appears in a user form and is:

SmartInfo parameters

Several of the standard rules listed in the following table accept three optional parameters named ReadOnlySmartInfo, ReadWriteSmartInfo and SmartInfoHeader:

You can leave either or both parameter blank, or identify the same section for both cases.

Controls — A to D

Purpose

Description

Autocomplete

Presents a dynamically assembled list of text-matched candidates, constructed by an activity or from an existing clipboard page. For details and parameters, see Harnesses, Sections, and Flow Actions — Adding an Autocomplete control.

CurrencyAmount

Formats a number as currency using the default locale. Complete two parameters plus the CalculatedValue parameter:

  • NegativeNumberFormatRed or Parenthesis
  • Size — A positive integer to control the display width of the text box

See Concepts — Internationalization.

For new development, use the auto-generated control pxCurrency.

Date

Presents a localizable date in one of several formats depending on parameters. Accepts six input parameters:

Parameter

Values

DateFormat

Select a style from the drop-down list.

  • 1 — Java Date-Default value, four-digit year format 12/31/2007
  • 2 — Java Date-Short value, two digit year format 12/31/07
  • 3 — Java Date-Medium value, Jan 1, 2007
CalendarIcon

Set to true to allow users to select a date with the Calendar control icon.

Size

Set to a positive integer to control the display width of the text box for both input and output.

CalculatedValue

Set this Boolean parameter as described above.

TextFieldDisable

Set the Boolean parameter to true to force users to use the calendar icon; they can't type directly into the text field.

DisplayMode

Set to window, pop-up or embedded to control the presentation when the user clicks the calendar control icon.

For new development use pxDateTime.

DateTime

Presents a localizable DateTime value in one of five formats depending on parameters. Accepts seven input parameters, all optional.

Parameter

Values

DateTimeFormat

Enter a digit 1 to 5:

  • 1 — Jan 24, 2007 4:15:23 P.M.
  • 2 — Wednesday, January 24, 2007 4:08:15 P.M. EST
  • 3 — January 24, 2007 4:08:15 P.M. EST
  • 4 — 1/24/07 4:08 P.M.
  • 5 — 1/24/2007 4:08 P.M.
CalendarIcon

Set to true to allow users to select a date with the Calendar control icon.

Size

Set to a positive integer to control the display width of the text box for both input and output.

CalculatedValue

Set this Boolean parameter as described above.

withTime

Set to true to allow the input of a time value and the display of a time value. (The property value is always a full DateTime value, regardless of this parameter setting.)

TextFieldDisable

Set the Boolean parameter to true to force users to use the calendar icon; they can't type directly into the text field.

DisplayMode

Set to window, pop-up or embedded to control the presentation when the user clicks the calendar control icon.

For new development use pxDateTime.

Decimal

Formats a numeric value on output with a thousands separator and specified precision locale, for example 1,234.567. Enter up to five parameters:

  • ThousandsSeparator — Include a thousands separator
  • Precision — A non-negative integer to control the number of digits presented after the decimal place
  • NegativeNumberFormat — To Red or Parenthesis
  • Size — Positive integer to control the display width of the text box for both input and output
  • CalculatedValue — As described above
For new development use pxNumber.
DynamicSelect Supports the Dynamic Select control. See Harness, Section, and Flow Action form — Adding a Dynamic Select Control.

Controls — E to R

Purpose

Description

Integer

Formats a numeric value on output with a thousands separator and specified precision and locale. Enter values for up to four parameters:

  • ThousandsSeparator — Include a thousands separator
  • NegativeNumberFormat — To Red or Parenthesis
  • Size — Positive integer to control the display width of the text box for both input and output
  • CalculatedValue — As described above
For new development use pxInteger.
MenuBar Supports menus within composite portals. See Harnesses — Adding a menu bar control.
MultiSelectList

Allows a user to select one or more items from a short list. For an example, see the standard section PegaAccel-Task-CircumstanceSearch. FindByCircumstance_Circumstances.

Percentage

Formats a numeric value on output as a percentage value, for example the value 0.043 can be presented as 4.31 %. Set three parameters:

  • Precision — Zero or positive integer, number or decimal places.
  • Convert decimal to percent — If true, input value is to be divided by 100.0 before presentation
  • Size — Positive integer to control the display width of the text box for both input and output
  • CalculatedValue — As described above
For new development, use the auto-generated control rule pxPercentage.
PickState

Presents a list of two-character state codes for the states of the United States. Set the Width parameter to a positive integer to control the width of the field. .

PromptSelect

On input, presents a drop-down selection list of values determined by the Table Type area of the General tab of a property rule. The Table Type field can specify a Local List, Field Values, Prompt List, or Class Key Value.

This allows users to select from a familiar or easy-to-understand list of values, while a hidden value corresponding to a user selection becomes the property value.

If the Class Key Value is specified, set the DisplayProperty parameter to the name of a property (with no leading period) that is to be the source of user-visible values.

Set the Width parameter to a positive integer to control the width of the field.

Entries on the list can be localized at runtime through field value rules.

RadioButtons

Similar to PromptSelect, but presents the values as a group of radio buttons determined by one of the following:

  • The Table Type area of the General tab of a property rule. The choices for Table Type are Local List, Field Values, Prompt List, and Class Key Value.
  • A report definition
  • A clipboard page

Complete two parameter values to control the appearance of the radio buttons:

  • Direction — Select Horizontal or Vertical to control the layout of radio buttons in sequence in the group.
  • NumItemsBeforeWrap — Enter a small positive integer to limit the number of buttons in a row (if you selected the Horizontal direction) or the number of buttons in a column (if you selected the Vertical direction).

For example, given a property with the Table Type field specified as the 24 text values Alpha, Beta, Gamma through Omega, and you select Horizontal as the Direction value and 3 as the wrap interval, the resulting user form presents eight rows of three buttons each, with Alpha, Beta, and Gamma in the top row.

Using field value rules, your application can localize button labels at runtime.

RichTextEditor

For a text value, allows the user to enter HTML markup such as <b> and <i>, and JSP tags. For example, the email text in the Body field of the standard flow action Work-.SendEmailCorr allows users to include such markup in outgoing emails.

As a best practice for security reasons, use the standard edit input rule pyFilterRichText to process user input into such fields. See Property form — Completing the Advanced tab.

reporting_image

Allows a clickable image to appear in a list view report cell. Create and reference in parameters an activity that executes upon click. Parameters are:

  • ImageSourceName — reference a binary file rule as a SRC= value for example /desktopimages/back.png.
  • ActivityName — Second key part of an activity that executes upon clicking the image. Typically, this activity uses the Show-HTML method to present an HMTL rule display in a new window.
  • ActivityClassName — Applies To key part of the activity
  • Target — Name of the window, for example "_blank"
  • Height — Optional. Height of the window in pixels
  • Width — Optional. Width of the window in pixels
  • ShowScrollbar — Boolean
  • ShowToolbar — Boolean
  • Resizable — Boolean.
reporting_link

Allows a clickable link to appear in a report cell. Create and reference in parameters an activity that executes upon click. Parameters are:

  • ActivityName — Second key part of an activity that executes upon clicking the link. Typically, this activity uses the Show-HTML method to present an HMTL rule display in a new window.
  • ActivityClassName — Applies To key part of the activity
  • Target — Name of the window, for example "_blank"
  • Height — Optional. Height of the window in pixels
  • Width — Optional. Width of the window in pixels
  • ShowScrollbar — Boolean
  • ShowToolbar — Boolean
  • Resizable — Boolean.

Controls — S to Z

Purpose

Description

SearchPanel

Supports multi-criteria search.

SmartInfo

Used with read-only property values. Presents a pop-up window displaying a read-only section when the user hovers the mouse pointer over the field value. The user can click the window or press any key to close the window.

The window contents can explain the significance of the selected value or provide other guidance. For example, if the read-only value is a state code such as CA for California, text in the pop-up window can explain how California regulations affect what the user can enter in other fields.

Complete three parameters:

  • SectionNameThe Stream Name — the second key part — of the section to appear in the SmartInfo pop-up window. The system determines the Applies To key part of the section from the primary page, or from the UsingPage parameter.
  • UsingPage — Optional. Name of the clipboard page that is the source of values for any JSP tags in the section. If omitted, the primary page is used by default. Include the name and class of this page in the Pages & Classes tab of the harness, section, flow action, or other stream rule that references this control rule.
  • HeaderText — A phrase that appears as the window title.

By design, the pop-up window does not appear when the mouse pointer hovers over a blank value.

The pop-up is for display, not user input. Don't identify a section that contains input (read-write) fields.

SmartLabel

Allows you to present a pop-up window when a user clicks on a specially styled label, normally presented in red font. Parameters for the SmartLabel rule are the same as for the SmartInfo rule. See Harness and Section forms   — Adding a SmartLabel control.

SplitButton

Presents a button but allows access to a drop-down list of alternatives.

Text

Presents an HTML text box with a specified display size and a maximum input length, both in characters. Set values for three parameters:

  • Size — A positive integer to control the width of the text box.
  • MaxLength parameter to a positive that limits user input.
  • CalculatedValue — As described above.

Processing other than input processing is unaffected by the MaxLength parameter, and may set a longer value to the property.

Spell checking is enabled by default.

For new development, use the auto-generated control rule pxTextInput.

TextArea

Presents an HTML <INPUT TYPE="textarea" ...> with specified size and expansion. Set the Rows parameter to a positive integer to control the number of lines initially displayed. See Harnesses, Sections, and Flow Actions — Adding a TextArea.

For new development, use the auto-generated control rule pxTextArea.

Time

Present a TimeofDay property in one of two formats. Set the TimeFormat parameter to one of these values:

  • 1 to include minutes but not seconds, such as 3:15 P.M.
  • 2 to include seconds, such as 12:22:53 A.M.
For new development, use the auto-generated control rule pxDateTime.
TreeGrid Supports an interactive tree structure display. For an example, review the standard section Code-Pega-List.OrgChart.
WorkArea

Supports display of user forms in a composite portal. See Harnesses and Sections — About the Work Area control.

For new development, use a dynamic container. See Harness and Section forms — Adding a dynamic container.

Notes

Standard controls with names ending in i18n (such as Date-Long-i18n) accept a parameter for the locale. For these rules, you can't supply parameters through the Formats form or the Parameters tab. You can set a parameter value with the PublicAPI call:

tools.putParamValue(...)

About Controls
Standard rules index