Back Forward Collection form
Completing the Parameters tab

  1. About 
  2. New 
  3. Basic/Advanced 
  4. Preamble and Stop 
  5. Parameters 
  6. Pages & Classes 
  1. History 
  2. More... 

Complete this optional tab to identify names and types of input parameters expected by the rules listed in this collection rule. At runtime, values of these parameters are available to activities, other collection rules, list view rules, and property references on this form.

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

Name

ArrayOptional. Enter a parameter name. As with parameters to activities, you can reference the value of these input parameters in other fields using the param keyword followed by a dot and the parameter name.

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

Description

Optional. Enter a brief text description of this parameter.

Data Type

SmartPromptChoose String, Boolean, or Integer as a data type for this parameter.

Required?

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

SmartPrompt Rule

Optional. For some parameters, you can configure SmartPrompt facilities to list a set of values for the parameter that a person running the collection can choose from.

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

To enable SmartPrompt operation, enter a class name here (such as Rule-Obj-FieldValue or Data-Party-Gov) to create configuration that, at runtime, allows a user to enter this parameter using SmartPrompt.

Validate as

Optional. Identify a property for SmartPrompt operation.

If you selected Rule-Obj-FieldValue in the SmartPrompt Rule field, enter here the second key part of the field value rules to appear in SmartPrompt lists.

If you selected another class in the SmartPrompt Rule field, identify a property that is a key part of the indicated class, if the class key contains more than one key part.

Up About Collection rules