You are here: Reference > Rule types > Controls > Control form - Completing the Parameters tab

Control form
Completing the Parameters tab
  1. About 
  2. New 
  3. Control 
  4. HTML 
  5. Parameters 
  6. Pages & Classes 
  7. History 
  1. More... 

Optional. Identify parameters for this control. This tab appears only if the rule is non-auto-generated as specified by the Auto-Generated? check box on the HTML tab.

Parameters are supported on controls identified in flow action, section, and harnesses. (Parameters are allowed only for JSP-based rules.)

Benefits

Use of parameterized controls — both standard rules and those you build for your applications — is recommended for flexibility and to reduce the number of distinct controls in your application.

For a partial list of standard rules that accept parameters, see Standard Controls with parameters.

Supplying values for parameters

Completing the tab

This tab is wide. To display more of the content, click the collapse arrow in the portal to temporarily hide the navigation panel. When you finish working with this tab, click the expand arrow to display the navigation panel again.

Field

Description
Name

Choose a name for this parameter, starting with a letter and using only letters and digits. Do not choose a parameter name that starts with the reserved word pega.

Use the following syntax to identify complex parameters:

  • .MyValueList() — for a Value List or Value Group structure
  • .MyPageList().Prop1, MyPageList().Prop2 — for parameters Prop1 and Prop2 on the embedded pages of the Page List structure MyPageList()

As with scalar parameters, these complex parameters are not true properties — no Rule-Obj-Property rule exists for them — but they mimic the structure of the property types. Complex parameter definitions are accepted on this Parameters tab, on the Parameters tab of the Section form.

Use the <pega:param > JSP tag, within the <pega:reference ..> JSP tag, to set values for complex and scalar parameters. Typically, complex parameter values are used within the scope of a <pega:foreach ..> JSP tag.
Description

Optional. Enter descriptive text to document the purpose of each parameter. This description appears when a developer completes parameter values.
Data Type

Select String, Boolean, or Integer as the data type of the parameter.
Required?

Select to indicate that the parameter (of data type String or Integer) must not be blank when this control is referenced in another rule. This restriction is enforced when rules are saved, not at runtime.

Leave cleared for Boolean parameters.
Type for SmartPrompt

Optional. To aid application developers in selecting a value for this parameter, identify a concrete class that has a single key part, such as Data-Admin-Operator-ID. This instructs the system to let developers complete this parameter value through a SmartPrompt selection rather than by typing; it has no runtime effect.

Validate As

Optional. Identify a Single Value property in the Applies To class of this rule (or an ancestor class) that defines, in the General tab, a Local List of values. When the developer enters a parameter value, the system uses the Local List values of the referenced property.
HTML Fragment for Parameter Prompting

Optional. Identify an HTML fragment rule that can prompt developers (when completing the Format form) with descriptive text for each parameter.

About Controls

Open topic with navigation