Show all
Basics
Standard HTML Property rules described in the table below
accept input parameters.
As a best practice when
feasible, use these parameter-based HTML Property rules to
present properties in the fields of section rules, flow
actions, and harness rules rather than HTML Property rules 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 also Standard
HTML property rules without parameters.
Use the Rules by Type Explorer to see a complete list of the
standard and custom HTML Property rules available to you.
Entering parameter values
Process Commander offers three places you can specify
values for these parameters:
- When completing the Fields panel (when
updating a harness, section, or flow action rule), enter
the HTML Property rule name in the Format
field and click the magnifying glass icon (
) to enter parameter
values that apply to that field. Values you enter here
override values specified by another method.
- On the General tab of
the Property form (for
Single Value
properties). Click the magnifying glass icon () to the right of the HTML Property field to enter parameter
values for all presentations of the property.
- Through the parameter page of an activity and
hand-coded Java, for example:
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 work object form and is:
- The target of a Declare Expression rule
- Presented in read-only mode
- Recomputed interactively based on the Enable
Expression Calculation field on the HTML tab of the Harness form or Flow Action
form.
SmartInfo parameters
Several of the standard rules listed in the
following table accept three optional parameters named
ReadOnlySmartInfo, ReadWriteSmartInfo and
SmartInfoHeader:
- To allow users to access a pop-up Smart Info display
from the field when the field is presented in read-only
mode, select a section for the
ReadOnlySmartInfo parameter value.
- To allow users to access a pop-up Smart Info display
from the field when the field is presented in read-write
mode, select a section for the
ReadWriteSmartInfo parameter value.
- Identify the text of the SmartInfo header in the
SmartInfoHeader parameter.
You can leave either or both parameter blank, or identify
the same section rule for both cases.
HTML Property rules - 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
Harness, Section, and Flow Action rules — Adding
an Autocomplete control.
|
| CurrencyAmount
|
Formats a number as currency using the default
locale. Complete two parameters plus the
CalculatedValue parameter:
NegativeNumberFormat —
Red or ParenthesisSize — A positive integer to
control the display width of the text box
See Concepts
— Internationalization.
|
| DataGrid
|
Implements a flexible, powerful control to review or edit Page List or Value List properties. See Harness, Section, and Flow Action forms — Adding a DataGrid control.
|
| 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.
|
|
| 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.
|
|
| 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 separatorPrecision — A non-negative
integer to control the number of digits presented
after the decimal placeNegativeNumberFormat— To
Red or ParenthesisSize — Positive integer to
control the display width of the text box for both
input and outputCalculatedValue — As described
above
|
| DynamicSelect
|
Supports the Dynamic Select control.
See
Harness, Section, and Flow Action form — Adding a
Dynamic Select Control. |
HTML Property Rules - E to R
Purpose
|
Description
|
| Integer
|
Formats a numeric value on output with a thousands
separator and specified precision and locale, for
example 1,234.567. Enter values for up to four
parameters:
ThousandsSeparator — Include a
thousands separatorNegativeNumberFormat— To
Red or ParenthesisSize — Positive integer to
control the display width of the text box for both
input and outputCalculatedValue — As described
above
|
| MenuBar
|
Supports dynamic menus within composite portals. See Harness rules — Adding a dynamic meny control. |
| MultiSelectList
|
Allows a user to select one or more items from a short list. For an example, see the standard section rule 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
presentationSize — Positive integer to
control the display width of the text box for both
input and outputCalculatedValue — As described
above
|
| 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
values determined by the Table
Edits tab of the Property form) as a group of
radio buttons. The Table
Edits tab can specify a Local List,
Field Values, Prompt List, or
Class Key Value.
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, if the Table
Edit tab provides 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 work
object 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 can be localized at runtime.
|
| reporting_image
|
Allows a clickable image to appear in 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 activityTarget — Name of the window,
for example "_blank"Height — Optional. Height of
the window in pixelsWidth — Optional. Width of the
window in pixelsShowScrollbar — BooleanShowToolbar — BooleanResizable — 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 activityTarget — Name of the window,
for example "_blank"Height — Optional. Height of
the window in pixelsWidth — Optional. Width of the
window in pixelsShowScrollbar — BooleanShowToolbar — BooleanResizable — Boolean.
|
HTML Property rules — 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:
SectionName — The
Stream Name — the second key part
— of the section rule to appear in the
SmartInfo pop-up window. The system determines the
Applies To key part of the section
rule 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 rule. 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 HTML Property 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, Section, and Flow Action forms —
Adding a SmartLabel control.
|
| SplitButton
|
Presents a button but allows access to a drop-down list of alternativees. See Split button.
|
| 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.
|
| 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 Harness, Section, and Flow Action rules — Adding a TextArea.
|
| 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.
|
| TreeGrid
|
Supports an interactive tree structure display. For an example, review the standard section rule Code-Pega-List.OrgChart. |
| WorkArea
|
Supports display of work object forms in a composite portal. See Harness and Section rules — Adding a Work Area control.
|
| |
|
Notes
Standard HTML Property rules 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 HTML Property rules
Atlas home
Atlas —
Standard HTML Property rules accepting parameters