Tracing messages

Tracing is an optional debugging feature you can turn on to closely follow the connector or Event Listener's behavior. Tracing messages are configurable and can be changed dynamically. You set various levels depending on the desired detail. The following sections describe tracing for each component of the Exchange adapter.

Recommendation: Tracing should be turned off on a production system or set to the lowest possible level to improve performance and decrease file size.

Using tracing with the connector

Trace messages, by default, are written to STDOUT (screen). You can also configure tracing to write to a file.

Table 15 describes the types of tracing messages that the connector outputs at each trace level. All the trace messages appear in the file specified by the connector property TraceFileName. These messages are in addition to any tracing messages output by the IBM WebSphere Business Integration Adapter architecture.

Table 15. Tracing messages for the connector

Tracing level Tracing messages
Level 0 Message that identifies the connector version. No other tracing is done at this level. This is the default tracing level.
Level 1 Tracing messages include:
  • Status messages
  • Messages that provide identifying (key) information for each business object processed
Level 2 Business object handler messages that contain information about the arrays and child business objects the connector encounters or retrieves while processing a business object.
Level 3 Messages that provide information about business object processing. For example, these types of messages are delivered when the connector finds a match between business objects, or finds a specific business object in an array of business objects.
Level 4 Tracing messages include:
  • Application-specific text messages (for example, messages showing the values returned by the functions that parse the business object's application-specific text fields)
  • Messages that identify when the connector enters or exits a function, which can help trace the connector's process flow
Level 5 Tracing messages include:
  • Messages that indicate connector initialization (for example, messages that show the value of each configuration property retrieved)
  • Messages that comprise a representation of a business object before the connector processes it (in other words, displaying the state of the business object as the connector receives it from the collaboration) and after the connector completes its processing (in other words, displaying the state of the business object as the connector returns it to the collaboration)
  • Messages that comprise a business object dump during processing

Using tracing with the Event Listener

Trace messages, by default, are written to the Windows Event Log as Information events. Table 16 describes the types of tracing messages that the Event Listener outputs at each trace level.

Table 16. Tracing messages for Event Listener

Tracing level Tracing messages
Level 0 The Event Listener identification message (for example, 2002/07/10 15:01:46.812: This is version 1.0 of the Exchange adapter). This message is always displayed the first time the event sink fires.
Level 1 Tracing messages include
  • Status messages
  • Messages that provide identifying (key) information for each processed event
  • Messages for each execution of the onSave(), onDelete(), onSyncSave(), onSyncDelete(), onTimer(), onMDBStartUp(), and onMDBShutDown() methods
Level 2 Messages that indicate each time an email message is sent to the CwEvent user.
Level 3 Messages that display event-specific flags (for example, EVT_NEW_ITEM, EVT_COPY, or EVT_MOVE).
Level 4 Messages that display the Event Store field values. Fields include EventID, Event type, FolderID, MessageID, and Priority.
Level 5 Tracing messages include:
  • Initialization messages (for example, messages that show the value of each configuration property that is retrieved)
  • Messages that trace individual method entry and exit points

Copyright IBM Corp. 1997, 2003