Skip to main content
Kofax

TotalAgility Reporting Logging

3024376

There are three kinds of logging related to KTA reporting: logging from the reporting service, logging from the ETL process, and client-side logging.

ETL Process Logging

The ETL process  (Kofax.CEBPM.Reporting.AzureETL.exe) is started by the service to do the actual work of processing reporting data.  Thus the ETL log is the place to look for most problems with reporting.

In default logging configuration, this is found in the following location, where {tenant name} is the name of the tenant in a multitenant installation, or the phrase “Non-multitenant environment” in a single tenant installation.  By default the file also rolls over into up to 10 numbered files:

C:\ProgramData\Kofax\TotalAgility\Reporting\Log\ETLApp_{tenant name}.log

In a default installation, the configuration for this log file is in this location:

C:\Program Files\Kofax\TotalAgility\Reporting\Kofax.CEBPM.Reporting.AzureETL.exe.config

Changing the ETL Process logging level

  • Open C:\Program Files\Kofax\TotalAgility\Reporting\Kofax.CEBPM.Reporting.AzureETL.exe.config
  • Find the following line:
    • <add name="TraceLevelSwitch" value="Warning"/>
  • Change the value to the desired logging level, for example to “Information”:
    • <add name="TraceLevelSwitch" value="Information"/>
  • Available levels are Off, Error, Warning, Information, Verbose, All
  • Takes effect after service restart

Note on ETL process logging levels

Logging is set to Warning by default, but most troubleshooting requires more context, so it is recommended to increase this to Information.

Verbose/All is not recommended for general troubleshooting, because the volume of logging is so high that the whole set of logs may roll over after a few minutes.  This usually means that by the time logs are collected, errors and relevant information is already gone.  In the rare situation where verbose logs may actually be relevant, increase the maxFileSizeKB and/or the maxFilesAmount settings. 

For example, increase the maxFilesAmount to 100, but ensure that the drive with the logs has enough space (maxFileSizeKB x maxFilesAmount).

As shown below, maxFileSizeKB defaults to 5120, and maxFilesAmount defaults to 10:

<sharedListeners>
  <!--Using customized Listener which can generate log file name based on tenant name (if used {0} placeholder in the name). 
  By default, logs folder is C:\ProgramData\Kofax\TotalAgility\Reporting\Log-->
  <add name="TextDiagnostics" type="Kofax.Reporting.Common.Logging.TenantBasedTraceListener, Kofax.Reporting.Common"
   initializeData="C:\ProgramData\Kofax\TotalAgility\Reporting\Log\ETLApp_{0}.log" 
   maxFileSizeKB="5120" maxFilesAmount="10">
  </add>
</sharedListeners>

Reporting Service Logging

The “Kofax TotalAgility Reporting Server” service (Kofax.CEBPM.Reporting.TAService.exe) is responsible for taking the reporting system task from the TotalAgility database and starting the child process (Kofax.CEBPM.Reporting.AzureETL.exe) which will do the work of processing the reporting data.  Thus this log can be examined to see if there are database errors, problems taking the system task, or problems starting the child process.

In default logging configuration, this is found in the following location, also rolling over into up to 10 numbered files:

C:\ProgramData\Kofax\TotalAgility\Reporting\Log\WorkerRole.log

In a default installation, the configuration for this log file is in this location:

C:\Program Files\Kofax\TotalAgility\Reporting\Kofax.CEBPM.Reporting.TAService.exe.config

Changing the Reporting Service logging level

  • Open C:\Program Files\Kofax\TotalAgility\Reporting\Kofax.CEBPM.Reporting.TAService.exe.config
  • Find the following line:
    • <add name="TraceLevelSwitch" value="Warning"/>
  • Change the value to the desired logging level, for example to “All”:
    • <add name="TraceLevelSwitch" value="All"/>
  • Available levels are Off, Error, Warning, Information, Verbose, All
  • Takes effect after service restart

Note on service logging levels

Logging is set to Warning by default, but during troubleshooting it is helpful to increase the logging level.

A substantially lower volume is logged to the Service logs compared to the ETL process logs, so there is no obstacle to increasing logging all the way to Verbose/All.  This can be helpful because Verbose logging will show when the reporting task is available and taken, as well as showing the reporting settings configured in the Designer.

Reporting Client Logging

In this context “reporting client” means the component that other parts of KTA use to send raw data to reporting.  This type of logging is not configured by default and is not needed frequently.  It may be used if there is a question about components are sending incorrect data to reporting.

To enable the Reporting client-side logging, you must extend the existing System.Diagnostics section of the specific component (Web.config, Agility.Server.Core.WorkerService.exe.config or Kofax.CEBPM.CPUServer.ServiceHost.exe.config) with the following switches, sources and shared listeners. 

<system.diagnostics>
    <trace autoflush="true"/>
    <switches>
        <add name="TraceLevelSwitch" value="Verbose"/>
    </switches>
    <sources>
        <source name="Reporting" switchName="TraceLevelSwitch">
            <listeners>
                <clear/>
                <add name="ReportingLogTxt"/>
            </listeners>
        </source>
    </sources>
    <sharedListeners>
        <add name="ReportingLogTxt" type="System.Diagnostics.TextWriterTraceListener,
         system, version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" 
         initializeData="C:\ProgramData\Kofax\TotalAgility\Reporting\Log\Kofax.Reporting.Integration.LogType.log"/>
    </sharedListeners>
</system.diagnostics>

Where "LogType" in the "initializeData" attribute is set to Web, CoreWorker, or Transformation (suggested naming for Web.config, Agility.Server.Core.WorkerService.exe.config or Kofax.CEBPM.CPUServer.ServiceHost.exe.config respectively) so they are logged to separate files and it is clear which is which.

Providing Logs

Always provide the whole set of logs together.  So zip up and provide the contents of this folder:

C:\ProgramData\Kofax\TotalAgility\Reporting\Log\

Applies to:  

Product Version
KTA ALL

 

 

  • Was this article helpful?