Tool Descriptor

Tools are central to an AWM model. Tools are defined by a function package and provide the functionality which can be used in actions of the model. An action always consists of a sequence of tools. Every tool returns a tool execution code. When the tool execution code is higher than the maximum permitted return code specified under Application Options, the action is terminated.

The input and output parameters of a tool have to be modelled. This enables the tools of an action to exchange information. The value of an output parameter of a tool can be used as input value for a subsequent tool in the tool chain of an action.

You can write tools in an atomic and modular way, encapsulating a specified functionality so that a tool can be reused in various action contexts.

AWM provides two features to control the tool execution within an action:

• Statements
  • A statement can define a conditional execution of tools (if/else) or a loop over a tool sequence. The if/else or loop condition is determined by run-time values of properties.
• Parameter override in an Action_Has_Tool or Statement_Has_Tool relationship
  • Enables you to override an input parameter of a tool, for example, with a static value in a certain action context facilitating the reusability of the tool by this means.

By default, the execution of a tool is a black box process. In certain cases a tool might need to affect the AWM resource(s) on which it is applied. For example, a deletion tool that removes the AWM resource from the AWM cash. AWM provides the resource processing concept to support this requirement which would be modeled using the ResourceProcessing attribute of a tool.

The following rules apply for resource processing:

• Resource processing is supported for elements.
• Any new elements added to the Table Results or Application Explorer view by an action are inserted at the bottom of the list, or if the list has been sorted, according to the sorting criteria.
• Inserted elements need not match the filter criteria after they are added to the element list. Refreshing the list shows only elements consistent with the filter criteria.
• Property values returned when updating or inserting an element are assigned to the element except for key properties.
• By default, resource processing applies for the selected resource. UPDATE and DELETE can be applied on any AWM element if its key properties and match name are provided by the operation. Providing the match name is optional, as long as the action is executed on an element of the same type as the target element.
• Resource processing is not executed if the corresponding tool execution returns an error code higher than the maximum permitted return code.

The following resource processing can be modeled for a tool descriptor:

The attributes which are displayed for a tool descriptor in the model editor depend on the tool description in the corresponding function package.

Like all attributes, clicking on an attribute in the Properties view will display a short description at the bottom of the window. Opening the contextual help page with the tool descriptor selected (default key: F1) will display the help page for the tool with additional information.

Attributes that are valid for all tool descriptors are listed in the table below: