Skip to main content
Kofax

KTA Log Agent app to conveniently control logging in various services and gather logs

Article # 3036524 - Page views: 168

BETA VERSION

Issue

The KTA Log Agent app was created by Technical Support to allow system administrators to conveniently control log levels who may lack product knowledge of the different trace sources and listeners which are supported.  The app also allows the administrators to remotely control logging and download logs from a folder.

Logging information is important for troubleshooting issues and analyzing performance, when KTA customers do not have logging turned on, the ability to assist them becomes limited, to the point that performing analysis may be impossible. Also, in some cases, customers may not have the technical expertise needed to set up logging properly for the various KTA services.

The KTA Log Agent app is designed to ease the customer burden of learning how to turn on logs in the middle of a support case. It performs the work of creating a custom log folder, backing up the existing config file and restarting the services to apply the logging configuration. This can be performed remotely without logging into each machine via RDP.

Solution

Prerequisites
  • All supported versions of Windows (server and client).
  • Requires .NET Framework Version 4.7.1
  • This desktop app supports remote execution with Administrator permissions (using WMI).
  • Supports KTA  deployment types OP, OPMT and RTTS.
User Guide
  1. Download the KTA Log Agent app deskop app from here
  2. Run with Administrator permissions - Right click and select Run the Admin when launching this app.
  3. Enter Kofax install folder location - by default C:\Program Files\Kofax
    1. If the machine has non default folder names, update the KTAlogAgentApp.exe.config appsettings folder keys accordingly.
  4. Enter Transformation Designer (TD) install folder location - by default C:\Program Files (x86)\Kofax\TotalAgility\Transformation Designer
  5. Enter Kofax Import Connector (KIC)/Message Connector(MC) install folder - by default C:\Program Files (x86)\Kofax\KIC-ED\MC
  6. Enter the hostname of a KTA machine - Note: If it is unable to connect to a host, you may be able to run this desktop app locally on the machine. 
  7. Enter the custom log folder location or leave blank to use the default (service folder location).
  8. The temp folder is readonly used internally for this app to store its own log file and temp download location.
  9. Select which logging you want to enable and check the restart services to apply the changes now.
  10. Press Run (This will backup the existing configs (adds {configname)_BACKUP_{date}_{time}.bak) and update the configs as per the options)
  11. Replicate the issue/behaviour. 
  12. If you used a custom log folder, you can run the download button to gather the logs for you from the host and attach the zip to your Kofax Support case. 

    Important - please be careful increasing log levels as it will consume extra resources. If you enable too many low level debug logging for the various services,  it could generate a lot of log messages quickly and could fill the disk. Please revert the log levels to default once the relevant logs are acquired. 

      clipboard_e8118af620ae731317a4068bc11082c88.png

An in-depth look at the logging levels this app enables

Log service Logging description Level information Default configs locations Default log locations
Reporting Server

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. 

Information level - This will increase log level for debugging.

Warning level (Default) - Default.

Both Warning and Information levels will have the same log file size management settings of  maxFileSizeKB="5120" and maxFilesAmount="10"

 

 

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

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

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

The CPU Server (CPUS) (Kofax.CEBPM.CPUServer.ServiceHost.exe.config) is the brain of the Transformation Server.  It fetches the capture tasks either from the database or WCF calls from other services.  Its main proposes are Task Dispatcher, Activity Processing Logic, Transformation Process Pool, Image Processing Process Pool, Document Conversion Process Pool. It calls the data layer and document services APIs. This app can enable low level tracing for the above components.

The Image Processing (eVRS) (Kofax.CEBPM.ProcessingService.Host) performs image enhancements.  Includes processes that handle image processing tasks which use eVRS, AtalaSoft, and other libraries to perform image conversion, image processing, scaling, bar code detection and separation, patch sheet detection and separation, and others. 

The Document Conversion (Kofax.CEBPM.DocumentConversionService.Host) is used for Document conversion activity to apply all the document conversion / normalization parameters configured in the document conversion profile.  A Document conversion profile contains conversion settings for converting the incoming documents. For example, supports converting images (PNG, JPEG, TIFF and others) to TIFF or converting documents (docx, excel, txt and others) to PDF.

The Data Layer (DL) and Document Service (DS) uses the standard .NET logging. The Data Layer (DL) is the API's which interact with the Documents database.  The Document Service (DS) is the API's with the capture document service used by the Capture Clients and KTA SDK's.

All (CPUS/DL/DS/Performance) - This will  increase CPU server logging to debug level along with Data Layer (DL) and Document Service (DS) component logging. It also enables Performance logging which creates a log with timing of all tasks.

The DL/DS logs will use the VB .NET trace listener which has the following log file size management: logFileCreationSchedule="Daily" with MaxFileSize="524288000"

All (CPUS/Performance) - This will increase CPU server logging to low level. Performance logging creates a log with timings of all tasks.

Note: This does not have any log file size management apart from service restarts which generate a new log file. 

Warning - (Default) (Logs only Warning and Error messages).

Note: This does not have any log file size management apart from service restarts will generate a new log file. 

 


C:\Program Files\Kofax\TotalAgility\Transformation Server\Kofax.CEBPM.CPUServer.ServiceHost.exe.config


C:\Program Files\Kofax\TotalAgility\Transformation Server\Kofax.CEBPM.DocumentConversionService.Host.exe.config


C:\Program Files\Kofax\TotalAgility\Transformation Server\Kofax.CEBPM.ProcessingService.Host.exe.config

C:\Program Files\Kofax\TotalAgility\Transformation Server

CoreWorker

The Core Worker uses the Unity logging framework which enables enhanced logging, through various configuration settings.

 

The Data Layer (DL) and Document Service (DS) uses the standard .NET logging. The Data Layer (DL) is the API's which interact with the Documents database.  The Document Service (DS) is the API's with the capture document service used by the Capture Clients and KTA SDK's.

Enable (CW/DL/DS) - This will enable core worker unity logging with LogMethodWithIORegistration along with Data Layer (DL) and Document Service (DS).

Note: the CWLog does not have any log file size management while the  DL/DS logs will use the VB .NET trace listener which has the following log file size management: logFileCreationSchedule="Daily" with MaxFileSize="524288000" 

Off (Default) - This will disable all log messages.

 

 

C:\Program Files\Kofax\TotalAgility\CoreWorkerService\Agility.Server.Core.WorkerService.exe.config
 

 

C:\Program Files\Kofax\TotalAgility
\CoreWorkerService
Web

The KTA Web logging also uses the Unity logging framework which enables enhanced logging, through various configuration settings.

Capture Thin Client logging will log data from capture forms (Scan, document review, Validation, Verification).

The Data Layer (DL) and Document Service (DS) uses the standard .NET logging. The Data Layer (DL) is the API's which interact with the Documents database.  The Document Service (DS) is the API's with the capture document service used by the Capture Clients and KTA SDK's.

Enable (Web/DL/DS) - This will enable KTA web server unity logging along with Data Layer (DL) and Document Service (DS).

Note: the KTAWebLog does not have any log file size management while the  DL/DS logs will use the VB .NET trace listener which has the following log file size management: logFileCreationSchedule="Daily" with MaxFileSize="524288000" 

Enable (Web) - This will enable KTA web server unity logging along with Capture Thin Client logging.

Note: This does not have any log file size management.

Off (Default) - This will disable all log messages.

C:\Program Files\Kofax\TotalAgility\Agility.Server.Web\web.config C:\Program Files\Kofax\TotalAgility\Agility.Server.Web
Export

The Export service uses the Unity logging framework which enables enhanced logging, through various configuration settings.

This also enables logging using the following sources to capture common calls to the database: Kofax.CEBPM.Server.Repository.Connector Kofax.CEBPM.Server.Repository.SqlCommon

 

Enable - This will enable Export service unity logging along with SqlCommon. It will generate a Export_tracing_output.svclog. (WCF Service Trace Viewer Log) This can be opened in any machine with Visual Studio/SvcTraceViewer.

Off (Default) - This will disable all log messages.

C:\Program Files\Kofax\TotalAgility\CoreWorkerService\Agility.Server.Core.ExportWorker.Host.exe.config

C:\Program Files\Kofax\TotalAgility\CoreWorkerService\Agility.Server.Core.ExportService.exe.config

C:\Program Files\Kofax\TotalAgility\CoreWorkerService
Steaming

The Streaming service uses Unity logging framework which enables enhanced logging, through various configuration settings.

This also enables logging using the following sources to capture common calls to the database: Kofax.CEBPM.Server.Repository.Connector Kofax.CEBPM.Server.Repository.SqlCommon

Enable - This will enable Export service unity logging along with SqlCommon. It will generate a Export_tracing_output.svclog. (WCF Service Trace Viewer Log) This can be opened in any machine with Visual Studio/SvcTraceViewer.

Off (Default) - This will disable all log messages.

C:\Program Files\Kofax\TotalAgility\CoreWorkerService\Agility.Server.StreamingService.exe.config C:\Program Files\Kofax\TotalAgility\CoreWorkerService
KIC/MC

This increases Kofax Import Connector (KIC)/ Message Connector (MC) log levels for debugging.

KIC/MC is a Windows service responsible for importing messages and files in many electronic formats. It retrieves documents from various sources and saves them in its internal storage making them available for retrieval through a web service interface. KTA connects to the KIC/MC web service interface and retrieves the documents for import.

The default level is 10 which is typically not useful for debug purposes.

 

 

 

80 - this sets the trace level to "80" for advanced debug purposes. As the trace level is increased, more data is logged and therefore it is important to increase trace message size to "10000", file size to "30" mb and amount of files to 30. 

60 - this sets the trace level to "60" for debug purposes. As the trace level is increased, more data is logged and therefore it is important to increase trace message size to "10000", file size to "20" mb and amount of files to 25. 

10 (default) - this sets the trace level back to default. The trace message size to "1", file size to "2" mb and amount of files to 10. 

C:\Program Files (x86)\Kofax\KIC-ED\MC\config\SolutionConfig.xml C:\Program Files (x86)\Kofax\KIC-ED\MC
Transformation Designer

This enables Transformation Designer (TD) logging using the following sources to capture common calls to the database: Kofax.CEBPM.Server.Repository.Connector Kofax.CEBPM.Server.Repository.SqlCommon

Enable - This will TD to generate a TD_tracing_output.svclog. (WCF Service Trace Viewer Log) This can be opened in any machine with Visual Studio/SvcTraceViewer.

Off (Default) - This will disable all log messages.

C:\Program Files (x86)\Kofax\TotalAgility\Transformation Designer\Kofax.ProjectBuilder.exe.config C:\Program Files (x86)\Kofax\TotalAgility\Transformation Designer

 

LogLevel Enum
 
All 1

Logs that are used for interactive investigation during development. These logs should primarily contain information useful for debugging and have no long-term value.

Information 2

Logs that track the general flow of the application.

Warning 3

Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the application execution to stop.

None 6

Not used for writing log messages. Specifies that a logging should not write any messages.

Level of Complexity 

Easy

 

Applies to  

Product Version Build Environment Hardware
KTA 7.x      

 

  • Was this article helpful?