General Parameters
The following table describes the General parameters when adding a parameter for an execute action.
Parameter |
Description |
---|---|
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.
|
Label |
Defines the text that appears in the Connection Profile or Job Properties. |
Field Type |
Enables you to select one of the following fields:
|
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:
|
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. 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 the user to the PATH environment variable. 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 that 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. For a Text Box, if the argument is optional, you can specify the argument flag -param in the prefix of the value:
|