Error situations in an attached tool
If one of the pre-configured Application Workflow Manager models (PDS Explorer, SCLM Application, or ChangeMan Application) or custom application models based on the REXX tool adapter TAUTOSAM are used, the attached tools will report error situations in a defined way.
See Workflow Manager Modeling Guide for more information on methods and techniques for tool attachment.
Application Workflow Manager displays an error message when the return code of the attached tool is higher than the value specified by the Application Workflow Manager model administrator under the property Max RC of Application Options in the Application Workflow Manager model. The recommended value for Max RC is 4. Then the following error message is displayed:
Within the message, the return code and message returned by the attached tool are displayed.
The following table shows special return codes typically used in preconfigured Application Workflow Manager models, specifically in models based on the REXX tool adapter TAUTOSAM.
| Return code | Meaning |
|---|---|
| 0 | Attached tool successfully executed; no message window is displayed. |
| 11 | The return code of the facility called (such as TSO or ISPF) is higher than the maximum return code specified in the facility call. The message contains the command called and the return code produced by the facility. Look up the meaning of the return code in the corresponding IBM book under the command reported by the message. |
| 99 | Undefined variable referenced or syntax error in the attached tool. |
In addition to these special return codes, attached tools can return custom created return codes and messages. If the REXX TAUTOSAM is used as a template for custom tool adapters, these custom messages are reported with the same formatting.
The following examples shows the error messages displayed when certain error situations occur within an attached tool:
- Undefined variable used in the attached tool:
- Syntax error in the attached tool:
- Call to ISPF command VGET returns a return code higher than the maximum return code allowed ( 4):
Looking in REXX TAUPDGJK, the error was produced by a call to ISPF command VGET:
Call ISPF '0 VGET (ZUSERA) SHARED'
See IBM ISPF Services Guide for more information on the VGET command, shown in the following under return code 8:
Variable not found. If the SYMDEF parameter was specified: system symbol not found.
- Custom return code:
The custom tool TOOL_Getdatasets returned with a return code of 12, which is higher than Max RC of 4 specified under Application Options in the Application Workflow Manager model. The message returned by the tool is This is a customer specific error situation….