You are here: Reference > Rule types > When Condition rules > When Condition form - Completing the Parameters tab

When Condition form
Completing the Parameters tab

  1. About 
  2. New 
  3. Conditions 
  4. Advanced 
  5. Parameters 
  6. Pages & Classes 
  1. History 
  2. More... 

Complete this optional tab if you want to refer to parameters (using the syntax param.name) as inputs on the Advanced tab. If used as a source of values, the parameter values must be set (for example, using a data transform) before the when condition runs.

Field

Description

Parameters  
Name

Enter a name of your choice for a parameter. A parameter name must be a valid Java identifier. See How to enter a Java identifier.

Note: Do not use a name that starts with pz or any of the reserved names. If this activity is to be referenced in a flow, the name cannot match any of the system-supplied parameters.

Description

Enter a text description of this parameter, for information only. This description appears when a developer completes parameter values.

Data Type

Parameters have a type similar to Single Value properties. Choose the type of data that is expected as the value for the parameter:

String A Java String value
Boolean A Boolean value
Integer An integer value
Double A double value, may use exponential notation
Page Name A page structure mentioned in the Pages & Classes tab
Java Object An arbitrary Java object
DateTime A value matching the format of a PRPC DateTime property value
Date A value consistent with a PRPC Date property value
Time of Day A value consistent with a PRPC TimeofDay property value
Decimal A decimal value including a decimal point
True or False Synonym for Boolean

If the type is Page Name, include the parameter name and page class on the Pages & Classes tab.

When entering parameters to call an activity, the values for the Boolean and True or False parameters are the same as for properties of that type:

  • The preferred values are the text constants "true" and "false".
  • The following values are equivalent to "true":
    • A non-zero numeric value (integer or double)
    • The text constants "on", "yes", and "t"
    • Any value starting with a "y"
  • Any other value corresponds to "false".

About When Condition rules