Back Forward Model form
Completing the Parameters tab
  1. About
  2. New
  3. Definition
  4. Parameters
  5. Pages & Classes
  6. History
  7. More...

Use the Parameters tab to identify any variables used as input parameters to the data transformation actions in the model, or for output results. XXXXXXX Can params be used for results from the model, as well as input to?6.2 PROJ-577

This tab is optional; not every model has parameters. When the model is called, the system places parameter names and values on a nameless, classless page known as the parameter page, and noted by the prefix keyword param. For example, param.depth refers to the depth parameter.

The declared type of a parameter (such as Integer, Double, or DateTime) indicates the format of a value. When evaluating expressions, Process Commander follows the same casting and type conversion operations as for properties.

Parameter names are not properties, and are not defined by a property rule:

XXXXXXXXXXXXXX kowal: Anything special to mention about Out parameters here? A la the activity help does?

Add (Add a row) and complete rows of this array to define parameters for this model. Within the data transformation actions on the Definition tab, 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 the parameter. A parameter name must be a valid Java identifier. See How to enter a Java identifier. BUG-2035

NoteDon't use a name that starts with pz. Don't choose any of the reserved names. Don't choose a name that matches any of the system-supplied parameters. XXXXXXXXXX kowal: Do we need a separate help topic for Reserved Names for the data transformation?
Description

Enter a text description of this parameter, for information only. This text is used for guiding use of the parameter when completing the Definition tab.
Data Type

Choose the type of data that is expected as the value for the parameter: C-1821 MARIK R-17005XXXXXXX kowal: Should all of the types that go on the Activities Param page also appear in this drop-down?

  • String — A Java string value
  • Boolean — A Boolean value
  • Integer — An integer value
  • Page Name — A page structure named on the Pages & Classes tab. If the parameter has Page Name for its Data Type, specify the parameter name and page class on the Pages & Classes tab.

The values for Boolean parameters are the same as Boolean properties:

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

Choose Yes or No to indicate whether this parameter is required to have a non-null value when it is used in the data transformation.

NoteFor a parameter with a Data Type of Boolean, the false value is sometimes correctly indicated by a blank or null value. Don't choose Yes in this field for a Boolean parameter, because a form may return a blank value for "false", which Process Commander may consider a missing property. OLSOK 3/11/05 and 9/15/04

NoteDon't select Required? for an Out parameter (a parameter where In/Out is set to Out).
In/Out

Select In or Out to indicate whether the parameter is used for input to the data transformation or output from the data transformation.

The system does not prevent setting the value of an In parameter. A called model can access and change both In and Out parameters on the parameter page. XXXXXXX kowal Text taken from activity help. Is this statement valid for the new Model?
Prompt Default Value

Optional. You can enter a literal constant value that appears as the default parameter value when the system presents a parameter prompt form to a user upon running this model. XXXXX kowal: Where would this be presented? Besides Run Rule of the model? R-10125 SR-3 B-14862 null value B-20578 not type-validated on Save
Type for SmartPrompt

Optional. For some parameters, you can configure SmartPrompt facilities to list a set of values for the parameter that a person running the data transformation can choose from. XXXXXX kowal: True for the 6.2 data transform model?

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 a configuration that, at runtime, allows a user to enter this parameter using SmartPrompt.
Validate As

Optional. KHATV 6/23/04 Identify a property for further qualifying the 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.

Up About Model rules