Skip to main content
Kofax

Where can be the logs found for KTM Thin Client Validation when attempting to troubleshoot Thin Client Validation issues

Article # 3035752 - Page views: 170

Issue

Where can logging be found for KTM Thin Client Validation when attempting to troubleshoot issues?

How do I enable advanced logging in KTM Thin Client?

Solution

In order to troubleshoot errors that occur when using the Thin Client modules (Validation, Verification, Correction), 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 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):

  • Open the desired configuration file
<!-- KTM 6.4 -->
<system.diagnostics>
  <trace autoflush="true">
    <listeners>
       <add name="delimitedListener" type="System.Diagnostics.DelimitedListTraceListener" delimiter="," initializeData="C:\Log_Thin\ThinClientServer.csv" traceOutputOptions="ProcessId, DateTime">
          <filter type="System.Diagnostics.EventTypeFilter" initializeData="Error" />
        </add>
        <!-- options: Error, Warning, Information, All -->
    </listeners>
  </trace>
</system.diagnostics>

<!-- KTM 6.3 -->
<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>
  • 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.

Change the <filter type="System.Diagnostics.EventTypeFilter" initializeData="Off"/> attribute to one of the following options:

  • Error: Outputs Trace.TraceError to the log file.
  • Information (KTM 6.3: Info): Outputs Trace.TraceError and Trace.TraceInfo to the log file.
  • Warning: Outputs Trace.TraceError, Trace.TraceInfo, and Trace.TraceWarning to the log file.
  • All (KTM 6.3: Verbose): Outputs all available debug information to the log file.

Save your changes and restart the IIS Server

 

For issues that could be related to Kofax Capture/KTM Thin Client Modules, some error messages are logged to the general Kofax Capture error log.
This can typically be found in the following location: \\<ServerShare>\CaptureSV\logs\err_YYMM.txt

<ServerShare> is the share location for all Kofax Capture configuration information.

 

Log files IIS Server

For issues related to IIS Server, the log can be examined to see if there are permission or other configuration issues related to IIS.
The log files are typically found in the following location if IIS logging is enabled: C:\Windows\system32\logfiles\W3SVC1\

To enable IIS logging, please see the following Microsoft article: How to configure Web site logging....

Level of Complexity 

Easy

 

Applies to  

Product Version Build Environment Hardware
Kofax Transformation Modules All      

 

 

Article # 3035752