Batch-level log files

These logs are generated automatically alongside every batch that is processed through Kofax Transformation Modules. The log files are stored in the same location as your image files. For example, C:\ProgramData\Kofax\Capture\Images\0000030D\Log.

These logs contain every event and processing step that occurs in an entire batch. The application log files record information about a single module only, and the steps it takes to process documents. Both logs contain valuable troubleshooting information.

The following modules generate batch log files to record batch-level events.

  • Correction

  • Document Review

  • Validation

  • Verification

The name of a log file includes the name of the module and the batch number.

A shortened module name is included in the batch-level log filename so that you know which log file is for a specific module. The names used are COR for Correction, DR for Document Review, VAL for Validation, or VER for Verification.

The batch-level log filename structure is as follows.

KTM<MODULE>_<BatchID>.txt.

.

If there are several steps of Validation enabled for a project, each step generates its own log file for that batch.

For example, KTMVAL#1_000000364.txt and KTMVAL#2_000000364.txt.

Among other processing events, the batch-level logs files can include the following events.

  • ValidationForm_DocumentLoaded

  • Batch_Open

  • Batch_Close

  • Application_Initialize

  • Application_Deinitialize

These batch-level log files are tab-separated. This means that you can open a log file in a spreadsheet application such as Microsoft Excel. The structure of the tabs is static and cannot be configured or changed. The following information is included in each batch-level log.

  • Time.

    The time and date of processing. Since processing can span across a single day, this date may be different to the date in the log file name.

  • Level.

    The configured level of detail included in the log. Depending on how your log files are configured, this can be any of the following values.

    • Error. Records error events that may allow the application to continue running.

    • Warning. Records potentially harmful situations.

    • Info. Records informational messages that highlight the progress of the application at a detailed level.

    • Debug. Records fine-grained informational events that are used to troubleshoot and debug the application.

  • ProcId.

    The process ID of the application.

  • Memory(KB).

    The amount of memory used by the ProcessId.

  • Message (Class.Method).

    The Message is information about the log entry. If there is an error, it is logged here.

    The Class and Method indicate the origin of a particular log entry.

    All three of these help identify what is causing a problem, and at what point during processing the issue occurs.

The log level matches the value you assigned to the corresponding application log in the Service Configuration Tool. For example, if you configure the Validation application log to record logs with the Warning level, then the batch-level Validation log also records events at the Warning level. Similarly, if you configure the Document Review application log to record logs with the Debug level, then the batch-level Document Review log also records at the Debug level.

For more information about the Service Configuration Tool and its options, see the Help for Server, Knowledge Base Learning Server, and Services.

Important Once a batch is deleted, the log files are deleted along with the batch.