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

Collection form
Completing the Parameters tab
  1. About 
  2. New 
  3. Rules 
  4. Pre / Post Actions 
  5. Parameters 
  6. Pages & Classes 
  1. Specifications 
  2. History 

Complete the fields on this tab to define a list of named data types that can be passed to the collection. At run time, the values of these parameters are referenced by the fields on the Rules tab and Pre/Post Actions tab of the form.

The fields on this form are optional. Not every collection has parameters.

Working with the parameter grid

The following fields appear as columns in a grid. Each row represents a distinct parameter. Empty rows are not evaluated. You can add a row to define a new parameter or delete an existing row.

 

Field

Description
Name

Enter a unique Java identifier that does not use reserved names.

The name you provide appears in prompts used by the Collect instruction and Parameters section when the collection is called.
Description

Enter text that briefly describes the purpose of the parameter.

The description you provide appears as a tool tip used by the Collect instruction and Parameters section when the collection is called.
Data Type

Select a data type to store the parameter value. Options include: String, Boolean, and Integer.
Required?

Select an option to indicate whether the parameter requires a non-null value:

  • Yes — The parameter cannot be null when the collection is called. Any user that calls the collection sees an error message and is blocked from saving until a value is specified.
  • No — The parameter can have a null value when the collection is called.

As a best practice, select No for Boolean data type parameters because some rules can interpret "false" as a null or blank value.

Type for SmartPrompt

Enter the name of a concrete class.

When this field is populated, a SmartPrompt is used by the Collect instruction and Parameters section to prompt you for a parameter value. Each item in the list represents a rule with pxObjClass set to the specified class name.

Each concrete class has one or more key parts. When a class has an applies to key part, the SmartPrompt automatically limits the results to instances with the same applies to class as the calling collection or activity.
Validate as

Enter text to refine the results displayed in the SmartPrompt.

Only use this field when the class name in the Type for SmartPrompt field has two or more key parts that do not represent an applies to class.

You can enter Rule-Obj-FieldValue in the Type for SmartPrompt field that has three key parts. Enter "pyCaption" in the Validate as field to prompt you with a list of field values with a field name key part containing the string "pyCaption".

Understanding the param keyword

When a collection is called, the system places parameter names and values on a nameless, classless page known as the parameter page. You can access values on the parameter page by typing the keyword param in a field, followed by a period and the name of a parameter.

For example, param.depth refers to the depth parameter on the parameter page.

The following fields on the Collection form support the param keyword:

Tab name

Fields
Rules

  • Any input field to a function that supports a string, boolean, or integer value. Functions are referenced by the Condition, Context, and Response actions sections.

    You can use functions to help you evaluate the additional parameters that are available to response actions.

  • Any input field to a supported rule type. Input fields are displayed in the Parameters section of the form and the Task Update modal.

  • Property Name and Property Value fields. These fields appear when you select the Set Property option as an action type for a collection step or task in a response action.

  • The Copy return value to field. This option is available in the Action section when you select a rule type that supports return values.
Pre/Post Actions

  • Any input field to a function that supports a string, boolean, or integer value. Functions are referenced by the Before This Collection and After This Collection sections, in addition to the Task Update modal.

  • Any input field to a supported rule type. Input fields are displayed in the Parameters  section of the Task Update modal.

  • Property Name and Property Value fields. These fields appear when you select the Set Property option as an action type for a task in a response action.

Use caution when entering the param keyword in the Property Name field. Any change you make to the parameter page is made visible to the calling activity when the collection ends and the Pass current parameter page option is selected.

 

Related topics

About Collections

Collect instruction

Completing the Rules tab of the Collection form

Completing the Pre/Post Actions tab of the Collection form

Rules and methods supported by a collection

Open topic with navigation