Skip to main content
Kofax

KTM Thin Client Advanced Logging

308298

Question / Problem: 

How do I enable advanced logging in Thin Client?

Answer / Solution: 

In order to troubleshoot errors that occur when using the Thin Client modules, you can configure the Thin Client Server to log errors in log files.
Errors from the Thin Client Server can be logged by editing the Web.config file, that is located in the installation directory (By Default it is C:\Program Files (x86)\Kofax\Transformation\ThinClientServer\).

Errors from the custom modules can be logged by editing the KCThinClientModule.exe.config file, that is located in the bin folder of the Kofax Capture installation
location (By Default it is C:\Program Files (x86)\Kofax\CaptureSS\ServLib\Bin\).

Since there can be multiple custom modules running at one time, you will see several log files with dynamically generated names created in your log folder.

Enter How to Enable the Logging (Both Web.Config & KCThinClientModule.exe.config):

  1. Open the desired configuration file and uncomment the following code
    <system.diagnostics>
    <trace autoflush="true">
    <listeners>
    <add name="myListener" traceOutputOptions="DateTime" type="System.Diagnostics.TextWriterTraceListener" initializeData="C:\logs\MyLog.txt">
    <filter type="System.Diagnostics.EventTypeFilter" initializeData="Off"/>
    </add>
    </listeners>
    </trace>
    </system.diagnostics>
  2. Edit the initalizeData=”C:\logs\MyLog.txt” attribute to modify the file system location and name of the log file.
    Note: Only messages generated by the Thin Client Server are added to this file. Each custom module will dynamically generate its own log file based on the date and time the custom module is initialized.
  3. Change the <filter type="System.Diagnostics.EventTypeFilter" initializeData="Off"/> attribute to one of the following options:
    - Error: Outputs Trace.TraceError to the log file.
    - Info: Outputs Trace.TraceError and Trace.TraceInfo to the log file.
    - Warning: Outputs Trace.TraceError, Trace.TraceInfo, and Trace.TraceWarning to the log file.
    - Verbose: Outputs all available debug information to the log file.
  4. Save your changes and restart the IIS Server

Applies to:  

Product Version Category
AXPRO 5.0 Project Builder
AXPRO 5.5 Project Builder
AXPRO 6.0 Project Builder
AXPRO 6.1 Project Builder
AXPRO 6.2 Project Builder
AXPRO 6.3 Project Builder

 

Author:  Justin Tang