Logging and Exception Handling
Overview
The following sections describe Adapter for Siebel message logging, exception handling, and error codes (including cause and response information).
Adapter Logging Levels
The Adapter for Siebel uses the Integration Server logging mechanism to log messages. You can configure and view the Integration Server logs to monitor and troubleshoot the Adapter for Siebel. For detailed information about logging into Integration Server, including instructions for configuring and viewing the different kinds of logs supported by the server, see the IBM webMethods Integration Server Administrator’s Guide for your release.
Configuring Adapter Logging Levels
Beginning with Integration Server 7.1, you can configure different logging levels for the Adapter for Siebel.
Accessing the Adapters Logging Information
About this task
To access the adapter's logging information
Procedure
Changing Logging Settings
About this task
To change logging settings for the adapter
Procedure
What to do next
Adapter for Siebel Message Logging
Integration Server maintains several types of logs. However, the Adapter for Siebel logs messages only to the audit, error, and server logs. Because the Adapter for Siebel works in conjunction with the WmART package, the adapter's messages and exceptions typically appear within log messages for the WmART package.
The logging levels are different depending on which version of Integration Server you are running the adapter on, as shown in the following table.
| Integration Server | Log | Description |
|---|---|---|
| Integration Server 6.5 | Audit Log | You can monitor individual adapter services using the audit log as you would audit any service in Integration Server. The audit properties for an adapter service are available in each Adapter for Siebel service template on the Audit tab. |
| Error Log | The Adapter for Siebel automatically posts critical-level and error-level log messages to Integration Server's Error log. These log messages will appear as Adapter Runtime messages. | |
| Server Log | The Adapter for Siebel posts messages to the Integration Server log, depending on how the server log is configured. Critical-level through debug-level log messages appear as Adapter Runtime log messages. V1-Verbose1 or V4-Verbose4 log messages appear as Adapter for Siebel log messages. | |
| Integration Server 7.1 or higher | Audit Log | You can monitor individual adapter services using the audit log as you would audit any service in Integration Server. The audit properties for an adapter service are available in the Adapter for Siebel service template on the Audit tab. |
| Error Log | The Adapter for Siebel automatically posts fatal-level and error-level log messages to the error log. These log messages will appear as Adapter Run-time messages. | |
| Server Log | Adapter for Siebel posts messages to the server log, depending on how the server log is configured. Fatal-level through debug-level log messages appear as Adapter Run-time log messages. Trace-level log messages appear as Adapter for Siebel log messages. |
Adapter for Siebel log messages appear in the following format: ADA.0700.nnnnc, where:
- ADA is the facility code that indicates that the message is from an adapter.
- 0700 is the Adapter for Siebel major code, which indicates that the error is generated by the Adapter for Siebel.
- nnnn represents the error's minor code. For detailed descriptions of the Adapter for Siebel's minor codes, see Adapter for Siebel Error Codes.
- c represents the message's severity level (optional).
To monitor Adapter for Siebel log messages in the Server log, ensure that your server log's logging settings are configured to monitor the following facilities:
- 0113 Adapter Runtime (Managed Object)
- 0114 Adapter Runtime
- 0117 Adapter Runtime (Adapter Service)
- 0118 Adapter Runtime (Connection)
- 0126 Adapter Runtime (System Contract Component [SCC] Connection Manager)
Adapter for Siebel Exception Handling
If a Adapter for Siebel object (for example, a connection or service) encounters an error with the Siebel system, it will throw an adapter error coupled with the Siebel error, exactly as it was thrown by Siebel. The Siebel errors will be in an IData format.
For example, if a Query service fails on the Siebel system at run time because its search expression contains invalid values, you will receive an adapter error that indicates that the Query service failed, and the adapter error will contain the specific error generated on the Siebel system indicating why the service failed. In this case, you would receive a Siebel error specifying that the search expression values are invalid.
When creating a flow or Java service that incorporates an adapter service, you might want to build logic into the wrapping service to catch and handle these types of exceptions.
Adapter for Siebel Error Codes
The following table lists Adapter for Siebel error codes, and provides information about the cause and suggested response for each error.
| Error Code | Description |
|---|---|
| 1000 | variable text threw a SiebelException:
code(ErrorCode), msg(Message).
ErrorCode is the Siebel exception code and Message is the exception message returned by Siebel. |
| Explanation: A SiebelException occurred. | |
| Action: Varies according to cause. | |
| 1001 |
variable text threw:
type(ExceptionType),
msg(Message).
ExceptionType is the type of exception and Message is the exception message returned by the Siebel Adapter. |
| Explanation: An AdapterException has occurred. This error code is reserved for all exceptions that do not have a specific exception message listed below. | |
| Action: Varies according to cause. | |
| 1002 | Invalid method inputs. |
| Explanation: Invalid inputs to the method. | |
| Action: Retry the operation with valid inputs. | |
| 1003 | An MVL field must be specified at each level in order to support the next query level. |
| Explanation: An internal error occurred with an adapter service that uses a multi-valued link (MVL) business component. | |
| Action: Ensure that the adapter service configuration includes an MVL business component in the Navigation Path tab. | |
| 1004 | Unable to {variable text} fields. |
| Explanation: An exception was thrown when the adapter could not deactivate business component fields before executing a Query on the business component. | |
| Action: Check the business component definition to ensure that the specified fields are included in the business component, and that there are no restrictions on the fields that may prevent the adapter from deactivating the field. | |
| 1005 | Unable to extract fields from the business component after a Query operation. |
| Explanation: The operation failed, throwing a SiebelException: code(ErrorCode), msg(Message). Indicates a failure in retrieving business component fields after executing a Query. | |
| Action: Ensure that the specified fields are included in the business component definition, and that there are no restrictions on the fields that may prevent the adapter from reading the field values. | |
| 1006 | Cannot set Query on the business component when performing an Insert operation. |
| Explanation: Missing search expressions for the selected multi-value link and additional business components. | |
| Action: Using the Search tab, define search expressions for the selected multi-valued link and additional business components. | |
| 1007 | Select {variable text} on the Navigation Path tab before you specify search criteria for it. |
| Explanation: You did not select {variable text} on the Navigation Path tab. | |
| Action: Select {variable text} on the Navigation Path tab before you specify search criteria for it on the Search tab. | |
| 1008 | Threw a non-fatal exception: type(ErrorType), msg(Message).
ErrorType is the type of exception and Message is the exception message returned by the Siebel Adapter. |
| Explanation: A non-fatal AdapterException has occurred. | |
| Action: No response is necessary. For example, setRepositoryContext() throws an exception since it cannot be called on certain business components. This exception is logged, and does not require any user action. | |
| 1009 | The placeholder {variable text} does not correspond to a field in the input |
| Explanation: The name of an input variable does not match the placeholder in the query specification. | |
| Action: Save the change you made to the input variable name. | |
| 1010 | No records were returned as a result of the Query; unable to perform {variable text}. |
| Explanation: Query failed to return one or more records when performing one of the following operations: Delete, Update, or Associate. | |
| Action: Check the adapter service input and the search criteria specified in the Search tab. | |
| 1011 |
Note: Message 1011 is intentionally omitted.
|
| 1012 | Must select two business components for an Associate operation. |
| Explanation: You failed to select two business components. | |
| Action: Select two business components in the Navigation Path tab, and specify a search expression for each one in the Search tab. | |
| 1013 | Business service operation input, {variable text}, is a required value. |
| Explanation: The names of a Business Service and a Business Service method are required parameters when executing the BusinessServiceOperation adapter service template. | |
| Action: Specify the names of a Business Service and a Business Service method in the Business Service Inputs field on the Siebel Business Service Inputs/Outputs tab. | |
| 1014 | The number of input keys and values must match. |
| Explanation: The arrays of Siebel property set keys and Siebel property set values that you selected contain a different number of keys and values. | |
| Action: In the Business Service Inputs field on the Siebel Business Service Inputs/Outputs tab, ensure that the array of Siebel property set keys and the array of Siebel property set values contain the same number of keys and values. | |
| 1015 | There was no response from the Siebel Server. |
| Explanation: An existing adapter connection
object could not communicate with the Siebel Server, perhaps due to loss of network connectivity or
Siebel Server shutdown. The adapter will attempt to clean up the Adapter for Siebel connection pool and re-connect to the Siebel Server. |
|
| Action: If the problem persists, restart the Adapter for Siebel. | |
| 1016 | Invalid connection; please retry operation. |
| Explanation: The adapter received a null connection object. | |
| Action: Retry the operation. If the problem persists, restart your adapter connection using Integration Server Administrator. | |
| 1017 | Threw a SiebelException: code ({ErrorCode}), msg ({Message}). The connection pool will now be recycled. Please retry your operation. |
| Explanation: An existing adapter connection object could not communicate with the Siebel Server, perhaps due to loss of network connectivity or Siebel Server shutdown. The BOI API returns an error code and error message indicating this fact. | |
| Action: Retry the operation. If the problem persists, restart the Adapter for Siebel. | |
| 1018 | Unable to get {variable text}. Not connected to Siebel Server; please check your network connection and make sure the Siebel Server is running. |
| Explanation: Occurs when a stale connection is
retrieved from the connection pool. A connection becomes stale when the adapter loses a physical connection to the Siebel Server, but the adapter considers the connection to be active. This can occur when the network connection has gone down or the Siebel Server shuts down unexpectedly. |
|
| Action: The adapter removes the stale connection and recycles that connection's pool. That is, it shuts down the connection pool and re-starts it. If this problem persists, please reset your Siebel Server connections. | |
| 1019 | One or more inputs are missing, Please check your inputs and retry the operation. |
| Explanation: Improper inputs were passed to the AttachmentOperation or the InvokeBusinessComponent adapter service template. | |
| Action: For an Attachment adapter service, check the values on the Attachment Operation Inputs tab. For an Invoke Business Component adapter service, check the values on the Invoke Business Component Method - Inputs tab. | |
| 1020 | Siebel Attachment operation returned: {variable text}. |
| Explanation: Indicates whether the Attachment operation succeeded. | |
| Action: None required. |