Error Handling
This Page Describes Error Handling in PIT v2.3 and Beyond
As of PIT v2.3, the underlying web service integration layer was changed from the IBM CTC Integration Toolkit product to IBM's Integrated Web Services (IWS) feature, which is native to the IBM i OS. The switch from CTC to IWS results in different error response values as of PIT v2.3 and beyond.
Wrapper Error Response Parameters
Every Portal Toolkit wrapper contains the same final three parameters in its interface:
|
Parameter
|
Direction
|
DataType
|
Length
|
Precision
|
Description
|
|---|---|---|---|---|---|
|
Error Category |
Output |
Decimal |
3 |
0 |
Error Category, if any |
|
Error Code |
Output |
Decimal |
5 |
0 |
Error Code, if any |
|
Error Description |
Output |
Character |
150 varying |
n/a |
Brief description of the error, if any |
The parameters are contained in a copy member named IIPARM01, which can be used with a /COPY directive in the API prototypes.
These parameters will convey any errors that have occurred. A description of these three parameters follows.
Error Category
There are two categories of errors which may occur. A value of zero signifies that no error has occurred. You should check the error category first before checking anything else. If you receive zero in this field, there is no need to check any other error parameters.
|
Category
|
Type
|
Description
|
|---|---|---|
|
0 |
None |
Success |
|
1 |
Failure |
See error code and error description for further details |
Error Code
One of the following error codes may be returned when the "error category" indicates a failure has been encountered:
|
Code
|
Area
|
Description
|
|---|---|---|
|
0 |
Client-side SOAP |
SOAP_VERSION_MISMATCH |
|
1 |
Client-side SOAP |
SOAP_MUST_UNDERSTAND |
|
2 |
Client-side SOAP |
CLIENT_SOAP_MESSAGE_INCOMPLETE |
|
3 |
Client-side SOAP |
CLIENT_SOAP_SOAP_ACTION_EMTPY |
|
4 |
Client-side SOAP |
CLIENT_SOAP_SOAP_CONTENT_ERROR |
|
5 |
Client-side SOAP |
CLIENT_SOAP_NO_SOAP_METHOD |
|
6 |
Client-side SOAP |
CLIENT_SOAP_CONTENT_NOT_SOAP |
|
7 |
Client-side SOAP |
CLIENT_WSDD_SERVICE_NOT_FOUND |
|
8 |
Client-side SOAP |
CLIENT_WSDD_METHOD_NOT_ALLOWED |
|
9 |
Client-side SOAP |
CLIENT_WSDD_PARA_TYPE_MISMATCH |
|
10 |
Client-side SOAP |
CLIENT_ENGINE_CLIENT_HANDLER_FAILED |
|
11 |
Client-side Transport (HTTP) |
CLIENT_TRANSPORT_EXCEPTION |
|
12 |
Client-side Transport (HTTP) |
CLIENT_TRANSPORT_OPEN_CONNECTION_FAILED |
|
13 |
Client-side Transport (HTTP) |
CLIENT_TRANSPORT_TYPE_MISMATCH |
|
14 |
Client-side Transport (HTTP) |
CLIENT_TRANSPORT_HAS_NO_UNSECURE_TRANSPORT_LAYER |
|
15 |
Client-side Transport (HTTP) |
CLIENT_TRANSPORT_HAS_NO_SECURE_TRANSPORT_LAYER |
|
16 |
Client-side Transport (HTTP) |
CLIENT_SSLCHANNEL_RECEPTION_EXCEPTION |
|
17 |
Client-side Transport (HTTP) |
CLIENT_SSLCHANNEL_SENDING_EXCEPTION |
|
18 |
Client-side Transport (HTTP) |
CLIENT_SSLCHANNEL_CHANNEL_INIT_ERROR |
|
19 |
Client-side Transport (HTTP) |
CLIENT_SSLCHANNEL_SOCKET_CREATE_ERROR |
|
20 |
Client-side Transport (HTTP) |
CLIENT_SSLCHANNEL_SOCKET_CONNECT_ERROR |
|
21 |
Client-side Transport (HTTP) |
CLIENT_SSLCHANNEL_INVALID_SOCKET_ERROR |
|
22 |
Client-side Transport (HTTP) |
CLIENT_SSLCHANNEL_CONTEXT_CREATE_ERROR |
|
23 |
Client-side Transport (HTTP) |
CLIENT_SSLCHANNEL_ERROR |
|
24 |
Client-side Transport (HTTP) |
CLIENT_MIME_CONTENT_ID_NOT_UNIQUE |
|
25 |
Server-related |
SERVER_ENGINE_EXCEPTION |
|
26 |
Server-related |
SERVER_ENGINE_COULD_NOT_LOAD_SRV |
|
27 |
Server-related |
SERVER_ENGINE_COULD_NOT_LOAD_HDL |
|
28 |
Server-related |
SERVER_ENGINE_LOADING_TRANSPORT_FAILED |
|
29 |
Server-related |
SERVER_ENGINE_LOADING_PARSER_FAILED |
|
30 |
Server-related |
SERVER_ENGINE_HANDLER_FAILED |
|
31 |
Server-related |
SERVER_ENGINE_WEBSERVICE_FAILED |
|
32 |
Server-related |
SERVER_ENGINE_HANDLER_INIT_FAILED |
|
33 |
Server-related |
SERVER_ENGINE_HANDLER_CREATION_FAILED |
|
34 |
Server-related |
SERVER_ENGINE_LIBRARY_LOADING_FAILED |
|
35 |
Server-related |
SERVER_ENGINE_HANDLER_NOT_LOADED |
|
36 |
Server-related |
SERVER_ENGINE_HANDLER_BEING_USED |
|
37 |
Server-related |
SERVER_ENGINE_GET_HANDLER_FAILED |
|
38 |
Server-related |
SERVER_ENGINE_WRONG_HANDLER_TYPE |
|
39 |
Server-related |
SERVER_CONFIG_EXCEPTION |
|
40 |
Server-related |
SERVER_CONFIG_TRANSPORT_CONF_FAILED |
|
41 |
Server-related |
SERVER_CONFIG_LIBRARY_PATH_EMPTY |
|
42 |
Server-related |
SERVER_WSDD_FILE_NOT_FOUND |
|
43 |
Server-related |
SERVER_WSDD_EXCEPTION |
|
44 |
Server-related |
SERVER_WSDD_NO_HANDLERS_CONFIGURED |
|
45 |
Server-related |
SERVER_SOAP_EXCEPTION |
|
46 |
Server-related |
SERVER_TRANSPORT_EXCEPTION |
|
47 |
Server-related |
SERVER_TRANSPORT_RECEPTION_EXCEPTION |
|
48 |
Server-related |
SERVER_TRANSPORT_SENDING_EXCEPTION |
|
49 |
Server-related |
SERVER_TRANSPORT_PROCESS_EXCEPTION |
|
50 |
Server-related |
SERVER_TRANSPORT_UNKNOWN_HTTP_RESPONSE |
|
51 |
Server-related |
SERVER_TRANSPORT_HTTP_EXCEPTION |
|
52 |
Server-related |
SERVER_TRANSPORT_UNEXPECTED_STRING |
|
53 |
Server-related |
SERVER_TRANSPORT_CHANNEL_INIT_ERROR |
|
54 |
Server-related |
SERVER_TRANSPORT_SOCKET_CREATE_ERROR |
|
55 |
Server-related |
SERVER_TRANSPORT_SOCKET_CONNECT_ERROR |
|
56 |
Server-related |
SERVER_TRANSPORT_INVALID_SOCKET |
|
57 |
Server-related |
SERVER_TRANSPORT_OUTPUT_STREAMING_ERROR |
|
58 |
Server-related |
SERVER_TRANSPORT_INPUT_STREAMING_ERROR |
|
59 |
Server-related |
SERVER_TRANSPORT_TIMEOUT_EXCEPTION |
|
60 |
Server-related |
SERVER_TRANSPORT_TIMEOUT_EXPIRED |
|
61 |
Server-related |
SERVER_TRANSPORT_LOADING_SSLCHANNEL_FAILED |
|
62 |
Server-related |
SERVER_TRANSPORT_LOADING_CHANNEL_FAILED |
|
63 |
Server-related |
SERVER_TRANSPORT_BUFFER_EMPTY |
|
64 |
Server-related |
SERVER_PARSE_BUFFER_EMPTY |
|
65 |
Server-related |
SERVER_PARSE_PARSER_FAILED |
|
66 |
Server-related |
SERVER_PARSE_TRANSPORT_FAILED |
|
67 |
Server-related |
SERVER_TEST_EXCEPTION |
|
68 |
Server-related |
SERVER_UNKNOWN_ERROR |
|
69 |
Server-related |
SERVER_CLIENT_ENGINE_MISMATCH |
|
70 |
Non-SOAP Axis Faults |
AXISC_SERVICE_THROWN_EXCEPTION |
|
71 |
Non-SOAP Axis Faults |
AXISC_UNKNOWN_ELEMENT_EXCEPTION |
|
72 |
Non-SOAP Axis Faults |
AXISC_NODE_VALUE_MISMATCH_EXCEPTION |
|
73 |
Non-SOAP Axis Faults |
AXISC_READ_CONF_EXCEPTION |
|
74 |
Axis Configuration |
CONFIG_DEFAULTS_ALREADY_SET |
|
75 |
Axis Configuration |
SERVER_TRANSPORT_REDIRECT_RECEIVED |
Error Description
When the "error category" indicates a failure condition, this field will contain an error string describing the exception that was encountered. The string value is generated within the underlying IBM IWS (Axis client) layer. Depending on the nature of the error, it may be necessary to enable PIT IFS logging and re-issue the wrapper call. The IFS log file will contain a detailed audit trace of the wrapper's call stack and will also include the raw SOAP XML request and response (if any) generated by the call, as well as any SOAP, HTTP or server errors that might have been encountered.