Logging

UNICOM Intelligence Interviewer provides a standard method of logging that is used by all programs and components. The log files are very useful for debugging; your dialing provider should log information that might be helpful in understanding what is happening on the system. Log files that are used by UNICOM Intelligence Interviewer are described in Log files.

The skeleton provides example logging to the IVW logs. It is suggested that all dialing providers use similar methods for logging to the IVW log file but that each dialing provider should use a unique component identifier. The LoggingIDs.h file lists the logging identifiers that are already in use. Select a unique logging identifier and use that in your log messages. The skeleton code is at:

[INSTALL_FOLDER]\IBM\SPSS\DataCollection\<version>\DDL\\ThirdPartyDialer\Skeleton

Your dialing provider should be careful to log enough at the informational level to see what is happening but not so much that the log files grow too quickly. Errors should always be logged at error level. Trace level is not stored by default but can be turned on when necessary, allowing you to use trace logging for information that might be helpful when debugging.

As an example, UNICOM Intelligence Dialer logs the outcome of each dial, hang ups, and errors. Here are some example log entries. As you can see it is useful to provide as much specific information as possible in the log entry.

Connected '1112223333' on dialer 'Dialer1', group 'Cars:1' to extension 'E275'
Dialed '1112223333' on dialer 'Dialer1', group Cars:1'. Call outcome 1 (BadNumber)
Returning the sample record retrieved for the interviewer as it was not immediately required by group dialing
Manual-dialed '1112223333' on dialer 'Dialer1', extension 'E492'
Hang-up on dialer 'Dialer1', extension 'E495'
Manual hang-up on dialer 'Dialer1', extension 'E590'
Error hanging up on dialer 'Dialer1', extension 'E250': Timeout occurred while waiting for a response from 'Dialer1'

The dialing provider should also set the Project and RespondentId parameters when these are known as these are also logged and can provide useful information.

To enable or disable trace logging for your dialer, use these HKEY_LOCAL_MACHINE\SOFTWARE\SPSS\mrInterview\3\Log\ registry values:

Create this DWORD Value if it does not already exist. This value controls when trace logging is enabled or disabled. Providing a value of 1 enables trace logging; providing a value of 0 disables trace logging.

The trace log file name is determined by the type of dialer that is employed. For example, the trace log is named QSampTrace.txt when the is used and ProTSTrace.txt when a Pro TS dialer is used.