Debugging EmailPlus

About this task

Follow these steps to enable the EmailPlus debugging functionality:

Procedure

Define a system environment variable called EMP_DEBUGOUT_LEVEL. Set the value of the EMP_DEBUGOUT_LEVEL variable to one of the these values:

Option	Description
1	List all EmailPlus function calls and the parameters passed to the functions
2	List all EmailPlus function calls, the parameters passed to the functions and the return values
3	Full Debugging, which can generate a lot of output

If you are debugging on Linux or UNIX systems, you must set the value of the EMP_DEBUGOUT_FILE variable to the name of a file that Rational® ClearQuest® can write to. Dot not include spaces in the full path of the debug file name. For example, create a file name similar to this line:EMP_DEBUGOUT_FILE=/tmp/EmailPlusDebug.log.

What to do next

To view the debugging output on Microsoft Windows, run the Windows Debugger (dbwin32.exe). The debugging output that is generated by EmailPlus has this prefix:

#EMP_DEBUGOUT# <DATE> : <FUNCTION NAME> : <DEBUG MESSAGE>

For example, when the EMP_DEBUGOUT_LEVEL variable value is 2, the following output might be generated:

3712: #EMP_DEBUGOUT# 2009-10-23 11:45:21 :EMP_isEmailPlusActive: START
3712: #EMP_DEBUGOUT# 2009-10-23 11:45:21 :EMP_CacheConfig: START - Cache EmailPlusConfig
3712: #EMP_DEBUGOUT# 2009-10-23 11:45:21 :EMP_CacheConfig: END
3712: #EMP_DEBUGOUT# 2009-10-23 11:45:21 :EMP_isEmailPlusActive: EMP::ConfigCache::isEmailPlusActive = <YES>
3712: #EMP_DEBUGOUT# 2009-10-23 11:45:21 :EMP_isEmailPlusActive: END  - isEmailPlusActive=<1>

To view the debugging output on Linux or UNIX systems, view the content of the file that you defined in the EMP_DEBUGOUT_FILE variable. When you enable EmailPlus debugging, Rational ClearQuest performance is affected. Enable debugging only when you need to, and then disable it when debugging is completed. You must define or modify the EMP_DEBUGOUT_FILE variable before you start the Rational ClearQuest client. Changes that you make to the EMP_DEBUGOUT_FILE variable while the Rational ClearQuest client is running is not recognized until the Rational ClearQuest client is restarted.