MIS-AMS SQL ActiveH - Debugging settings

Document data

Document Date:	31 October 2005 - revision 2
Keyfax version :	3.1.0.13 (or greater)
Software required:	SQLactiveH CRM/Repairs 5.3+ / Keyfax 3.1.0.13+
User skill requirements:	NT administration. SQL Server DBA. IIS configuration. NT security policies. MSXML editing.
Author:	Technical Services keyfax@touch-base.com

Debugging.

Error Handling.

The Keyfax ActiveX control contains code to allow the start-up and export XML data and the code process flow (trace) to be written to file on the users PC. This can help in diagnosing problems with the integration.

Enabling Debugging.

Keyfax exchange debugging can be enabled by setting a user registry key as follows:

Enable debug:  Set HKEY_CURRENT_USER\Software\Omfax\Keyfax\Startup\Debug = 2
Disable debug: Set HKEY_CURRENT_USER\Software\Omfax\Keyfax\Startup\Debug = 0

Note: Please ensure that the registry debug setting is disabled when debugging is complete, as it may result in the slower performance of Keyfax.

WARNING: Modifying the Windows registry can cause serious system errors. Before you modify the registry, make sure to back it up and make sure that you understand how to restore the registry if a problem occurs. For information about how to back up, restore, and edit the registry, click the following link to view the article in the Microsoft Knowledge Base:

Description of the Microsoft Windows Registry

Debug Files.

Debug files are created in the user's temporary folder. These files are called startup.xml, export.xml and keyfaxdebug.log. They can be found by entering the following paths on the command line after a Keyfax script has been completed:

• Start-up XML     = %temp%\export.xml
• Export XML       = %temp%\export.xml
• Code flow          = %temp%\keyfaxdebug.log

The XML files will open in the default application for XML files (usually Microsoft Internet Explorer).
The LOG file can be opened in MS Notepad (but .log files may require associating to Notepad first).

• If the MISexchange.xml file is being edited, and errors are present in the commands, the keyfax3.dll may display error warnings. This can assist in tracking down any problems.
• If the problem is within the XML structure, Internet Explorer will help pin-point the problem if it is used to view the MISexchange.xml file.

As the keyfaxdebug.log will always be appended to when it exists, it can become very large after a time, therefore it is recommended that once debugging is complete, the temporary files are deleted.