Parameter Attribute

The Integrator Parameter object supports the parms attribute and its sub-object attributes as described in the tables below.

Parameter Attribute

Attribute Type Description
parms Array of Arrays The parms attribute contains one or more defined parameters. Each parameter is comprised of the sub-object attributes shown in the Parameter Sub-Object Attributes table below.

Parameter Sub-Object Attributes

Attribute Type Description
name
(required)		 String

Defines the name of the parameter being declared. Parameter names are case-insensitive. However, on UNIX systems, parameters that inherit values from environment variables must match the environment variables in a case-sensitive manner. A parameter can be used by other objects in a script. To do so, include the parameter name in a parameter string in the script.

NOTE: A good practice is that parameter names should be lower case and not contain spaces or any special characters except for underscore.
alias String If present, this attribute defines a new name that is used when the parameter is referred to within the script itself. The parameter name is still used to define parameter values, on the command-line, through the environment, or passed as arguments to Tunnel objects. The alias is used within the script itself, for parameter substitution or dependency expressions.
This feature is useful in Tunnel situations where Dimension names are passed as parameters, but these Dimension names contain special characters like spaces so that the parameter names cannot be used as a dependency. The dimension name can be aliased to a name that meets the rules of a parameter name (alphanumeric, beginning with a letter).
type String Defines the parameter type. Valid values include:
"string" "int" "double" "boolean" "array"
  • If this attribute is not defined, the parameter type is taken from the default attribute (if set). Otherwise, the type defaults to "string".
  • If the type is "string", "int" or "double", parameter strings that contain only this parameter will be viewed as the specified type. Parameter strings that contain multiple parameters will be viewed as an object language string. See Parameter Strings.
  • If the type is "boolean", the parameter can be used to define a dependency.
  • If the type is "array", parameter strings that only contain this parameter will be treated as an array of strings. Parameter strings that include an array parameter along with other characters or parameters will cause an error.
default String, Integer, Double Identifies the default value of the parameter. If a parameter is not defined, either through arguments or an environment variable, this value is used as the parameter value.
If default is not used, the default value is as follows:
  • For a string parameter, it is the empty string.
  • For integer and double parameters, it is 0.
  • For a boolean parameter, it is "false".
  • For an array parameter:
    • The default value can be an array value, in which case it will be used as the value of the parameter if no value is given on the command-line.
    • If the default value of an array parameter is a string value, the value will be used as the filename that contains the array values, not the values themselves.
    • If no default is set for an array parameter, it defaults to the empty string which can cause an error at execution time.
environment Boolean

Defines whether the parameter can inherit its value from an environment variable when no argument is provided. When environment is "true", the parameter value is taken from the environment variable if an environment variable of the same name exists and no parameter value is given.