Skip to main content
Kofax

Enable Additional Logging For KTA Web Server

Article # 308103 - Page views: 1305

Question / Problem: 

What are the steps for enabling additional logging for a Kofax TotalAgility (KTA) Web Server?

Answer / Solution: 

The following steps explain how to enable/disable additional logging for KTA.

 

1. Navigate to C:\Program Files\Kofax\TotalAgility\Agility.Server.Web. Substitute the drive letter used for the KTA installation if different from the C: drive.

2. Open the web.config file in a text editor such as Notepad.

3. Navigate to the system.diagnostics section and locate the system.diagnostics element. It will look similar to the following.


        <!--<add name="ThinClientServer" traceOutputOptions="DateTime,ThreadId" type="System.Diagnostics.TextWriterTraceListener" initializeData="c:\ThinClientServerLog.txt">
          <filter type="System.Diagnostics.EventTypeFilter" initializeData="Warning" />
        </add>-->
        <!--to enable TA Logging specify a trace listener with KTALog as name-->
        <!--<add name="KTALog" type="System.Diagnostics.TextWriterTraceListener" initializeData="c:\temp\KTALog.txt">
        </add>-->

 

4. Remove the comment characters "<!—" and "-->" to uncomment the following lines:

        <add name="ThinClientServer" traceOutputOptions="DateTime,ThreadId" type="System.Diagnostics.TextWriterTraceListener" initializeData="c:\ThinClientServerLog.txt">
          <filter type="System.Diagnostics.EventTypeFilter" initializeData="Warning" />
        </add>
        <!--to enable TA Logging specify a trace listener with KTALog as name-->
        <add name="KTALog" type="System.Diagnostics.TextWriterTraceListener" initializeData="c:\temp\KTALog.txt">
        </add>

5. The resulting section should look like the following:


        <add name="ThinClientServer" traceOutputOptions="DateTime,ThreadId" type="System.Diagnostics.TextWriterTraceListener" initializeData="c:\temp\ThinClientServerLog.txt">
          <filter type="System.Diagnostics.EventTypeFilter" initializeData="Warning" />
        </add>
        <!--to enable TA Logging specify a trace listener with KTALog as name-->
        <add name="KTALog" type="System.Diagnostics.TextWriterTraceListener" initializeData="c:\temp\KTALog.txt">
        </add>

 

6. Verify that the folder path for the log location exists. (C:\Temp in this example)

7. Verify that the IIS Application Pool user has Full Control of the log location folder.

8. Save the changes to the web.config file. These changes should take effect immediately without having to restart any services.

9. Replicate the behavior that is to be captured in the logging. The results will be in the log file specified in the path.

10. Reverse the steps above to disable the logging once the necessary logs have been created.

Important!

Do not leave the default .NET Core worker logging running unmonitored as it is only for short term tracing purposes!  The application event log will capture all concerning full-stack errors for troubleshooting, so it is unlikely you will need to enable this Core Worker .NET TraceListener.

 

Applies to:  

Product Version Category
TotalAgility 7.3+ Smart Process Applications

 

Author:  Dan Iler