Logging error messages

The connector logs an error message whenever it encounters an abnormal condition during processing, regardless of the trace level. When such an error occurs, the connector also prints a textual representation of the failed business object as it was received. It writes the text to the i2 Adapter log file, whose file name corresponds to the connector property LogFileName.

The message contains a detailed description of the condition and the outcome and may also include extra information that may aid in debugging, such as business object dumps or stack traces (for exceptions).

Error types: Error messages are of two types:

Structure of error messages

All the error messages that the connector generates are stored in a message file named i2Adapter.txt. Each error message typically has a message ID, the error message, and an explanation section for a detailed description and tips to rectify the problem.
Message ID


Message


[EXPL]

The message IDs for the i2 connector range from 90000 to 92000, with 90000 to 91000 set aside for polling-related error messages, and 91000 to 92000 set aside for request processing error messages.

Example: The following exemplifies the message structure, where nnnnn represents the message ID.

nnnnn
Not able to get a connection for this instance {1}.
[EXPL]
Please ensure that the instance specified is up.
{1}--Parameter to the error message, in this case the instance id.

Polling-related error messages

The following table describes polling-related error messages. These are logged in the i2 Adapter log file.

Notes:

  1. In some cases, the connector logs a fatal error (log message type of XRD_FATAL) so that e-mail notification can be triggered. For logging this error with the integration broker, you need to set the connector property LogAtInterchangeEnd to true.

  2. E-mail notification will be sent only if the e-mail connector is configured.


Error description Error type Handling by i2 connector
Connection lost while polling Fatal error The connector detects the connection error at the time of a poll call. It logs a fatal error (log message type of XRD_FATAL) and dumps the XML message. Fatal error can trigger e-mail notification. For logging this error with the integration broker, you need to set the connector property LogAtInterchange to true and continue with polling on other operations that might be running on instances that are active.
Not able to register an operation with the CIS Agent Fatal error The connector logs a fatal error (log message type of XRD_FATAL) and dumps the XML message. Fatal error can trigger e-mail notification. For logging this error with the integration broker, you need to set the connector property LogAtInterchange to true.

With subsequent poll calls, the i2 connector tries to re-register the operations that could not be registered with the previous poll call. In case registering all the operations fail, we assume that the CIS agent is down; the connector returns APPRESPONSETIMEOUT, which shuts down the i2 connector.

No metaobjects configured for polling Error The i2 connector always returns a FAIL after logging that the metaobjects are not configured for polling.
Default value for the metadata object attributes not set Error For details on the default value attribute property, see Understanding business objects for the connector. The error "required information for polling was not found for the specified metaobject" is logged and the processing continues for other messages.
Not able to fetch the message from CIS Agent Error/SUCCESS In case the poll call to the i2 application returns a null, or there are no events for the operation, the connector continues to poll for other operations.

In case an exception is caught from any CIS Client API , an error message containing the word ERROR_PROCESSING_EVENT is logged. The connector continues to poll for other operations.

Fail to convert XML message to IBM business object Error The error that the XML message has a syntax error is logged for the message, The XML message gets dumped to the log file, and the processing continues for other messages.
Any error when posting event to the broker Error/Fatal In case of a return code of CONNECTOR_NOT_ACTIVE, the connector logs a fatal error and returns APPRESPONSETIMEOUT which shuts down the connector. The error is logged with the status of ERROR_POSTING_EVENT.

In case of a return code of NO_SUBSCRIPTION_FOUND, the error is logged with the status of UNSUBSCRIBED and polling continues. For a return code of FAIL, the error is logged with the status of ERROR_POSTING_EVENT for the business object, and the polling continues for the other messages.

Event not subscribed to Error The error is logged with the status of UNSUBSCRIBED for the business object, the XML message is dumped to the log file, and the polling continues for the other messages.

Service call request processing error messages

The following table describes service call request processing error messages. These are logged in the i2 Adapter log file.

Error description Error type Handling by i2 connector
Not able to get a connection for the specified port type and instance. Fatal error The connector detects the connection error at the time of a service request processing call. It logs a fatal error with the status of FAIL in the exception and a detailed exception message stating the cause of the exception set on the exception object.
No instanceId found in the metadata object within the incoming business object Error The connector checks for the default value setting for the instanceId attribute of the metaobject within the wrapper business object. If set, the connector tries to connect to this instance and execute the operation. If there is no default value, it logs the error message with the status of FAIL and a detailed exception message stating the cause of the exception set on the exception object.
Not able to convert the incoming child business object attributes to XMl. Error The i2 connector logs the message to the adapter log and sets the status on the exception to FAIL.
Failure executing the operation on the i2 side. Error The i2 connector logs the message from the Resource Exception to the adapter log and sets the status on the exception to FAIL.
Not able to convert the returned CIS Record if the operation was SUCCESSFUL to XML. Error The i2 connector logs the message to the adapter log and sets the status on the exception to FAIL.
Not able to convert the XML message to the business object. Error The i2 connector logs the message to the adapter log and sets the status on the exception to FAIL. It also dumps the XML message to the log file along with the error message.
Execute method returns null output Error/Success In case the operation does not have an output type, the execute method execution is considered a SUCCESS. If an output is expected, the execute method issues an exception which is caught by the connector.

Copyright IBM Corp. 1997, 2003