TIBCO Adapter SDK C++ Reference
MTrace::debug
MTrace
Send a message to the debugRole.
Remarks
This method provides a means for tracing (that is, auditing) significant steps.

A message description is substituted at runtime. For example, if the error message is "DB insert failed for table %1", call debug() like this:

   MString sTableName( "FOOBAR" ); 
   pTrace->debug( "DB insert failed for table %1", 
      NULL, NULL, sTableName ); 

This expands at runtime to "DB insert failed for table FOOBAR" in the actual trace text (in whatever sink it goes to).

Each component should trace to the infoRole the significant steps of a process. Below are examples of significant steps for different components:

•    MB : Transform started, Transform complete
. . . A AEMB-0035 [Transform] Transform started
. . . A AEMB-0036 [Transform] Transform completed
•    IM: job started, job completed, checkpoint executed
. . . A AEIM-0214 [Transform] Job started
. . . A AEIM-0215 [Transform] Job completed
. . . A AEIM-0216 [Transform] Checkpoint <chk1> executed 
•    Adapters : Business Document received
•    Adapters : Business Document sent

Parameters customRole : Send messages to arbitrary roles. message : Message to be sent. pTrackingInfo : If this argument value is NULL, it is ignored. The information contained in the MTrackingInfo instance identified by this argument is traced to the relevant sinks. For further information on message format, see Trace Message Format in TIBCO Adapter SDK Concepts. pData : This argument is ignored. It's reserved for a future implementation. subArgString1 : Substitutes on % values contained in the message description. subArgString2 : Substitutes on % values contained in the message description. subArgString3 : Substitutes on % values contained in the message description. subArgString4 : Substitutes on % values contained in the message description. subArgString5 : Substitutes on % values contained in the message description.

Declaration
virtual void debug(MString const & customRole, MString const & message, MTrackingInfo const * pTrackingInfo, MData const * pData, MString const & subArgString1, MString const & subArgString2, MString const & subArgString3, MString const & subArgString4, MString const & subArgString5);
Links
Copyright (c) 2010 TIBCO Software Inc. All rights reserved.