Previous Topic Next topic Print topic


Relationship: Tool Has Output Parameter

Output parameters of tools are described by the Tool has Output Parameter relationship.

The output parameters of a tool are temporarily saved during the execution of an action, so that subsequent tools can use them as input parameters.

The way in which the output of a tool should be interpreted can be modeled via the type attribute. Depending on the type, a property or a file descriptor must be referenced via the relationship.

Attribute Type Description
TargetIDFile[D] File Descriptor Reference to a file descriptor. This is only important if the type attribute has been set to “File”.
TargetIDParm[D] Property Reference to a property. This is only important if the type attribute has been set to “Element” or “String”.
Label [O] String The display text of the parameter in the Output dialog box.
SeqNo * [U] Integer The position number of the parameter in the Output dialog box (1 = at the very top).
Type Selection Determines how the output parameter should be interpreted.  

Valid values include:

  • String
  • File
  • ToolDefinedResourceOperation
  • MassProcessing

Default value is string.

ToOutputDialog Boolean Indicates whether the parameter should be displayed in the Output dialog box at the end of the action. This only takes place if there is an Output dialog modeled at the end of the tool sequence.
Ui Category String Categorizes the parameter in the Output dialog box. Categorized parameters are enclosed in a labeled frame. Successive parameters with the same categories are enclosed by the same frame in the Output dialog box. See The "UI Category" Attribute for more information.
Previous Topic Next topic Print topic