Previous Topic Next topic Print topic


Relationship: Tool Has Input Parameter

The Tool has Input Parameter relationship describes exactly one input parameter of a tool. The reference of the relationship is a property whose property value can be passed as parameter to the tool at run time.

The Parameter From attribute determines where the value of the parameters should be obtained from. There are three ways of determining the origin of parameters:

Transfer of Parameters between tools

The Parameter Memory is the temporary storage area for output tool parameters. The values 123, ABC and XYZ are the concrete outputs of the respective tools and are saved as property values. The illustration shows how the property PROP_2 has been referenced for two tools as an output parameter. The second output (XYZ) overwrites the first (ABC).

Attribute Type Description
TargetIDFile[D] File Descriptor Reference to a file descriptor. Only important if the type attribute has been set to File.
TargetIDParm[D] Property Reference to a property. Only important if the type attribute has been set to Mass Processing or String.
DefaultValue [O] String

(multi line)

The standard value of the parameter. This value is only used if no other property value can be found for the referenced property.

Has no meaning for file parameters.

Initializes a field in an Input dialog box.

Label [O] String Label of the parameter in dialog boxes.
Parameterfrom Selection Determines from where the property value of the parameter property should be obtained.

Valid values include:

  • Context (default)
  • Previous_Tool
  • User_Input
SeqNo * [U] Integer Position of the parameter. Depending on the tool type, this can be important for the correct execution of the tool. In dialogs, the sequence numbers are used to position the dialog box fields.
StaticValue [O] String

(multi line)

Sets a fixed value for the parameter. This can only be overwritten via parameter override. See Parameter override for more information.
Type Selection The type of the parameter. A property or a file descriptor must be referenced on the basis of this attribute.  

Valid values include:

  • MassProcessing(+ TargetIDParm)
  • File(+ TargetIDFile)
  • String(+ TargetIDParm)

The default value is String.

UICategory [O] String Categorizes the parameter in dialogs. Categorized parameters are enclosed in a labeled frame. Successive parameters with the same category will be enclosed by the same frame and ordered by sequence number. See The UICategory Attribute for more information.
UITab [O] String Allows the assignment of parameters to tabs. Tabs are individual dialog pages which are activated by clicking the tab label at the top of the dialog. Successive parameters with the same tab are displayed in the same tab page. This works only for Input dialog boxes. See The UI Category Attribute for more information.
UIEditable Boolean Indicates whether the parameter can be edited in input dialog boxes. Fields are never editable in an output dialog box.  

The default value is true.

UIGenericAllowed Boolean Indicates whether wildcard characters are permitted as user input. If false, the Input dialog box cannot be confirmed if wildcard characters are present in the input field. See Application Options for more information.

The default value is false.

UIMandatory       Boolean         Indicates whether the field is mandatory in input dialog boxes. If true, the dialog box cannot be confirmed when the field contains no values.

Mandatory fields are marked with an asterisk *.  

The default value is true.

UIForm [O]   String   Specifies formatting information for the field in Input dialog boxes. Valid values include: BOLD, HIDDEN, RED, GREEN, YELLOW, BLUE, GRAY
UIHelpText [O]   String

(multi line)

Specifies help text for the field in input dialog boxes which is displayed when the question mark button beside the field is clicked or the F1 key is clicked in the field.
UIMultiSelection Boolean Specifies whether multiple items can be selected. For structured file input parameters only. If set to true, a check box table will be created.  

The default value is false.

UIToolTip [O]   String

(multi line)

Specifies a tool tip for the field in input dialog boxes.
Enabled Condition [O] Enabled_Condition Relationship to a parameter enabled condition which allows you to define the conditions which are checked at run time. This condition must be true to display this input parameter in a modeled input dialog. This enabled condition is not relevant for other tools. See Enabled condition for details of how to define an enabled condition.
Previous Topic Next topic Print topic