Skip to main content
Kofax

Kofax VRS API Logging

3014654

16253

Question / Problem:

How to log the calls made to, and responses received from, the VRS API by such programs as Kofax Express, Kofax Front Office Server (KFS), or Kofax VRS Multicore Processing

Answer / Solution:

Programs that use “VRS Server” technology access the VRS API by making calls to either VRScmd5.dll (all versions) or kfxVRSAPI.dll (introduced in 5.0 Elite). These calls and responses can be logged using the VRSCMD.log file.

To enable VRS API logging for VRS 5.1.1.2 and higher:

  1. Navigate to the ImgCtls\bin folder.
  2. Create a new text file.
  3. Name the new text file: VRSCMD.log.
  4. Grant the necessary user accounts Full Control of the VRSCMD.log file.

The following are the most common locations of the ImgCtls\bin folder:

 

Standalone installation of Kofax VRS on a 64-bit version of Windows:

C:\Program Files (x86)\Kofax\ImgCtls\bin

 

Standalone installation of Kofax VRS on a 32-bit version of Windows:

C:\Program Files\Kofax\ImgCtls\bin

 

Kofax Capture Server:

C:\Program Files (x86)\Kofax\CaptureSS\ServLib\ImgCtls\bin

 

Kofax Capture Workstation:

C:\Program Files (x86)\Kofax\Capture\ImgCtls\bin

To enable VRS API logging for VRS 5.1.1.1 and older:

  1. Navigate to the root of the C: drive.
  2. Create a new text file.
  3. Name the new text file: VRSCMD.log.
  4. Grant the necessary user accounts Full Control of the VRSCMD.log file.

Note: On systems running Windows Vista, 7, 8.x, 10, or Windows Server 2008 R2 or higher, User Account Control (UAC) may block read/write access to files in the root of the C: drive, even though the user account has been granted Full Control. In such cases, it may be necessary to temporarily disable UAC or set it to its lowest level.

To disable VRS API logging:

  1. Navigate to the folder where the VRSCMD.log file is located.
  2. Delete the VRSCMD.log file.

Note: VRS 5.x Elite Multicore Processing uses “VRS Server” technology, so VRS API logging can be used with VCDemo/VRS Test Application and Kofax Capture when Multicore Processing is enabled.

Applies to: 

Product Version
Express 3.2
KFS 4.1
VRS 4.5
  5.1
  5.1.1
  5.1.2

 

  • Was this article helpful?