Relationship: Action Has Tool

The relationships of an action descriptor to a tool descriptor specifies an executable function under an action.

If a tool returns a return code higher than the permitted return code or when the user cancels an input dialog, the whole action is terminated.

See Application Options for more information on how to specify the maximum permitted return code.

Attribute Type Description
TargetID * ToolDescriptor The tool descriptor that should be referenced by this relationship.
Context Name String The name of an execution context previously created using Tool has Named Context. The tool is executed with the referenced context.

By default, all tools are executed with the main context of the action.

Parameter_Override [O] Parameter_Override Relationship to an input parameter of the referenced tool descriptor. This makes adaptations to the input parameters possible for one action, so that the re-usability of tool descriptors is increased. See Parameter Override for more information.
Named Context Named_Context Relationship to an execution context to be created from the tool output which can be used in subsequent tools of this action.

Examples

For example, the following displays several "Action Has Tool" relationships with enabled conditions:


SCLM Build

The enabled conditions are all dependent on the property SCLM_PROP_DIA_RunInBatch which is set as user input by the first tool of the action. Depending on the value of the SCLM_PROP_DIA_RunInBatch property, different tools of the action are executed.

For example, the following displays the use of the Parameter_Override relationship in an "Action Has Tool" relationship:


Endevor Browse

For example, the Endevor model contains a general tool which retrieves the information for several browse actions. One parameter of the tool is the function code which specifies which information should be retrieved. This parameter is overwritten by the appropriate static value in each "Action Has Tool" relationship referencing the NDV_TOOL_ISPF_REX_RetrieveElementInfos2Browse tool making use of a "Parameter Override" relationship. In this example, the input parameter NDV_PROP_ElementVVLL is removed from the parameters being passed to the tool as it is not relevant to an element browse action. It is only relevant for an element version browse action:


Endevor Browse Tool