You are here: Reference > Rule types > Flows > Flow form - Completing the Params tab

Parameters tab on the Flow form
  1. About 
  2. New 
  3. Diagram 
  4. Parameters 
  5. Pages & Classes 
  6. Design 
  1. Process 
  2. Specifications 
  3. Requirements 
  4. Test Cases 
  5. History 

Leave this tab blank unless the Can be added to a work object? box on the Process tab is selected.

This optional array defines the input parameters (if any) used when a user is working with an existing case and starts this flow from that case. In this array, you can also define an HTML form that can present and accept values from a user for these parameters. The prompting and any specified HTML form appear when a user selects this flow from the Add Work sub-menu in the Other Actions menu on the standard Perform harness. The standard Start a New Flow on the Object (StartFlow ) activity checks if each of the flow's required parameters are present, as well as run the flow catching all exceptions.

Caution: Prompts for parameters specified on this tab are not displayed for a user who is creating a new work item. The parameters specified on this tab are most useful in process flows that are started while the user is working with an already created work item.

Within the shape properties panels, you can reference flow parameters using the notation param.MaxLimit. (Within an activity, a reference to param.MaxLimit is a reference to an activity parameter, not a flow parameter.)

Field

Description

Name

ArrayEnter a name of your choice for a parameter. Don't use a name that starts with pz. Don't choose any of the reserved names.

A parameter name must be a valid Java identifier. See How to enter a Java identifier.

Like parameters for activities, you can reference the value of these input parameters within the flow using the param keyword followed by a dot and the parameter name. (For example, param.Lastname)

Description

Optional. Enter a brief text description of this parameter. This text is displayed to the user who starts this flow from a work item.

Data Type

Choose a data type (String, Boolean or Integer) for this parameter.

Required?

Select to require that this parameter have a non-blank value when the flow starts. Leave cleared for Boolean parameters.

SmartPrompt Rule

Optional. Specify a class name here (such as Rule-Obj-FieldValue or Data-Party-Gov) to create a configuration that, at runtime, allows a user to enter this parameter using SmartPrompt. To open the rule form for the specified class (or create a new class), click the Open icon .

For parameters that are displayed as entry fields at runtime, you can make the SmartPrompt feature available when the parameter is displayed to the user running the flow. When the user invokes the SmartPrompt, a list of values displays that the user can choose from. (This is not important if this flow is to be called from another flow with computed parameter values.)

A value listed by SmartPrompt must be a key part to a concrete class with one to three key parts.

Validate Like

Optional. If you specified a value in the SmartPrompt Rule field, specify a property that provides the key part necessary for the SmartPrompt operation.

If you specify Rule-Obj-FieldValue in the SmartPrompt Rule field, specify here the second key part of the field value rules that are displayed at runtime by the SmartPrompt.

If you specify another class in the SmartPrompt Rule field, specify a property that is a key part of the selected class, if the class key contains more than one key part.
Local Action for Parameter Display

 
Local Action

Optional. Specify a flow action to use at runtime to produce a prompt form in which a user can enter values for the flow parameters specified in this tab.
HTML Stream for Parameter Display

 

HTML

Optional. Specify the Stream Name key part of an HTML rule. At runtime, this rule is used to produce a prompt form in which a user can enter values for the flow parameters specified in this tab. The system uses the Applies To key part of this flow as the Applies To key part of the HTML rule. To open the rule form for the specified HTML rule (or create a new one), click the Open icon.

If you leave this blank, the system uses a simple form that lists the parameter descriptions entered on this tab.

Open topic with navigation