Parameter name

Defines the name of the parameter. No blanks allowed.

The parameter name appears in the insert parameter drop-down list during the operation definition.

The following strings are reserved for internal use, and cannot be used as the parameter name. All strings are case insensitive.

• app_name
• string
• object
• procid
• orderid
• runnumber

Label

Defines the text that appears in the Connection Profile or Job Properties.

Field type

Enables you to select one of the following fields:

• Text Box: Enables you to define a small text box.
• Text Area: Enables you to define a larger text area than a text box.

  NOTE: No additional paragraphs are allowed. The text is wrapped.

• Drop-down List: Enables you to select from a drop-down list. Click to add a Display Name and a Value. Add parameters to the Value by clicking . To enable Control-M Schedulers to manually type values instead of selecting from a drop-down list, select the Enable users to manually input values check box.
• Check Box: Enables you to add a check box and to define the value when checked and unchecked. Add parameters by clicking .
• List: (Job Properties only) Enables you to add a list of parameters.
• Label: Enables you to define the text (for view purposes only) in the Connection Profile or Job Properties.
• Text Box with Load Button: (Job Properties only) For more information, see Text Box with load operation parameters.
• Password: (Connection Profile only) Defines a password field. The text does not appear in the Connection Profile or in any log or output.

Description

Enables you to add a description of the parameter.

Default Value

(Text box with load button and Text Area only) Specifies a default value for the parameter.

By default this field is:

Enables you to set the default value for the visibility of a field:

• Visible: The field is visible to users.
• Hidden: The field does not appear in the job properties.
• Read-only: The field is visible to users, but cannot be changed.

Resolved control-m variables on job's rerun

(Text Box and Text Area field types only) Enables you to resolve Control-M variables when the job is rerun. By default, Control-M variables are resolved when the job is first run.

Use as environment variable. Variable name

(Connection Profile only) Enables you to set the parameter by the end user in an environment variable.

NOTE: In the preview pane, an icon is added to show it is an environment or path parameter.

Add to path

(Connection Profile only) Enables you to append the value specified by end user to the PATH environment variable.

NOTE: You can use this for adding a command line program path to the environment path.

Valid Values

Enables you to select valid values from the drop-down list for validation parameters.

Mandatory Field (non empty)

Enables you to select whether the parameter is mandatory.

Excluded chars

Enables you to select whether you want excluded characters when defining the parameter. For example, the parameter cannot contain spaces or colons.

Format

(List only) Enables you to format the real value is used for execution. You can define the value pattern (such as prefix/suffix), or a default value when no value is specified by user for this field.

EXAMPLE: For a Text Box, if the argument is optional, you can specify the argument flag -param in the prefix of the value:

-param {{MY_PARAM}}

Only if MY_PARAM has a value, the "-param" attribute is specified in the command line.