Skip to main content
Kofax

Scan Agent Service Debug Logging

3028671

Question / Problem: 

How to enable Kofax TotalAgility (KTA) Scan Agent Service Debug logging

Answer / Solution: 

When troubleshooting Scan Agent Service issues, it is often necessary to collect KTA Scan Agent Service debug logs.
 

To enable KTA Scan Agent Service Debug logging:

  1. On the scan station, navigate to the following folder:
    C:\Program Files (x86)\Kofax\TotalAgility\Scan Agent
     
  2. Open Kofax.TotalAgility.ScanAgentService.exe.config in a text editor such as Notepad
     
  3. Locate the system.diagnostics section:
    <configuration>
    ...
      <system.diagnostics>
        <trace autoflush="true" />
        <switches>
          <!-- Set the TraceLevelSwitch to any of the following values:
               Off - None
               Error - Only error messages
               Warning - Warning messages and error message
               Information  - Informational messages, warning messages and error messages.
               Verbose - Verbose messages, informational messages, warining messages and error messages.
               All - All messages.
    
               For more information about tracing options, see: http://msdn.microsoft.com/en-us/library/ms228993(v=vs.100).aspx
          -->
          <add name="TraceLevelSwitch" value="Warning" />
    

     
  4. Set the TraceLevelSwitch value to All:
    <configuration>
    ...
      <system.diagnostics>
        <trace autoflush="true" />
        <switches>
          <!-- Set the TraceLevelSwitch to any of the following values:
               Off - None
               Error - Only error messages
               Warning - Warning messages and error message
               Information  - Informational messages, warning messages and error messages.
               Verbose - Verbose messages, informational messages, warining messages and error messages.
               All - All messages.
    
               For more information about tracing options, see: http://msdn.microsoft.com/en-us/library/ms228993(v=vs.100).aspx
          -->
          <add name="TraceLevelSwitch" value="All" />
    

     
  5. Save the changes to Kofax.TotalAgility.ScanAgentService.exe.config
     
  6. Restart the Kofax TotalAgility Scan Agent Service
     
  7. Scan Agent Service log entries are written to:
    C:\Program Files (x86)\Kofax\TotalAgility\Scan Agent\Kofax.TotalAgility.ScanAgentService.TXT.log

Kofax.TotalAgility.ScanAgentService.TXT.log can grow very large quickly.  Therefore it is not recommended to leave TraceLevelSwitch set to All indefinitely.  Once the issue has been replicated, debug logging should be disabled.


To disable KTA Scan Agent Service Debug logging:

  1. On the scan station, navigate to the following folder:
    C:\Program Files (x86)\Kofax\TotalAgility\Scan Agent
     
  2. Open Kofax.TotalAgility.ScanAgentService.exe.config in a text editor such as Notepad
     
  3. Locate the system.diagnostics section:
    <configuration>
    ...
      <system.diagnostics>
        <trace autoflush="true" />
        <switches>
          <!-- Set the TraceLevelSwitch to any of the following values:
               Off - None
               Error - Only error messages
               Warning - Warning messages and error message
               Information  - Informational messages, warning messages and error messages.
               Verbose - Verbose messages, informational messages, warining messages and error messages.
               All - All messages.
    
               For more information about tracing options, see: http://msdn.microsoft.com/en-us/library/ms228993(v=vs.100).aspx
          -->
          <add name="TraceLevelSwitch" value="All" />
    

     
  4. Set the TraceLevelSwitch value to Warning:
    <configuration>
    ...
      <system.diagnostics>
        <trace autoflush="true" />
        <switches>
          <!-- Set the TraceLevelSwitch to any of the following values:
               Off - None
               Error - Only error messages
               Warning - Warning messages and error message
               Information  - Informational messages, warning messages and error messages.
               Verbose - Verbose messages, informational messages, warining messages and error messages.
               All - All messages.
    
               For more information about tracing options, see: http://msdn.microsoft.com/en-us/library/ms228993(v=vs.100).aspx
          -->
          <add name="TraceLevelSwitch" value="Warning" />
    

     
  5. Save the changes to Kofax.TotalAgility.ScanAgentService.exe.config
     
  6. Restart the Kofax TotalAgility Scan Agent Service

Applies to:  

Product Version
KTA 7.5
  7.6
  7.7
  7.8

 

 

  • Was this article helpful?