You are here: Reference > Rule types > Batch Processes > Batch Process form - Completing the Parameters tab

  Batch Process rules
Completing the Parameters tab
  1. About 
  2. New 
  3. General 
  4. Parameters 
  5. Pages & Classes 
  6. History 

This rule form is reserved for future use.

Use the Parameters tab to identify any variables used as input parameters to, or results from, the batch process.

Complete a row of this array for each parameter required for this batch process. Within the activity the batch process calls, you can reference parameters with the keyword param followed by a period and the parameter name.

Field

Description
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.

The following restrictions apply:

  • Do not use a name that starts with pz..
  • Do not use any of the reserved names.
  • If this activity is to be referenced in a flow, do not use a name that matches 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.
Required? Choose Yes or No to indicate whether this parameter is required to have a non-null value when this batch process starts.
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 activity can choose from. (This is not important if this activity is to be called from another activity with computed parameter values.)

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 Like

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 at runtime 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.

About Batch Process rules

Open topic with navigation