Kofax VRS
Installation Guide
Version: 5.2.0
Date: 2020-09-02
© 2001–2020 Kofax. All rights reserved.
Kofax is a trademark of Kofax, Inc., registered in the U.S. and/or other countries. All other trademarks
are the property of their respective owners. No part of this publication may be reproduced, stored, or
transmitted in any form without the prior written permission of Kofax.
Table of Contents
Preface...........................................................................................................................................................4
Product files location.......................................................................................................................... 4
Related documentation.......................................................................................................................4
Technical assistance for your Kofax product..................................................................................... 4
Chapter 1: Overview................................................................................................................................... 5
System Requirements........................................................................................................................ 5
Microsoft Visual C++ Redistributables.................................................................................... 5
.NET Framework 4.7 Requirement..........................................................................................6
Chapter 2: Installation................................................................................................................................ 7
Upgrades.............................................................................................................................................7
Installation with Kofax Capture.......................................................................................................... 7
Install Kofax VRS............................................................................................................................... 7
Perform a silent installation..................................................................................................... 9
Register Kofax VRS........................................................................................................................... 9
Upgrade to Kofax VRS Elite............................................................................................................ 10
Remove Kofax VRS......................................................................................................................... 11
Chapter 3: Administrator access.............................................................................................................12
3
Preface
This guide includes the information you need to install Kofax VRS and register the product. After
completing the Kofax VRS installation, you can get detailed information about the product features and
user interface from the Kofax VRS help.
Product files location
If you download Kofax VRS from the Kofax Fulfillment site, refer to instructions on the site to extract the
product files from the ISO file to a local drive. If you receive Kofax VRS as a package that includes the
product files on removable electronic media, use the media to perform the installation. In this guide, the
term "product files" applies to either the extracted files or the electronic media.
Related documentation
In addition to this guide, the Kofax VRS documentation set includes the following:
• Help for Kofax VRS: Online product assistance for the Kofax VRS Administration Console and the
Kofax VRS Interactive Viewer.
• Help for Kofax VRS Test Console: Online product assistance for the Kofax VRS Test Console, a sample
scan application included in your Kofax VRS installation.
• Kofax VRS Release Notes: Late-breaking information that is not available in your other Kofax VRS
documentation. To view the release notes, go to the Kofax Support pages.
Technical assistance for your Kofax product
For more information about your product, visit the Kofax Support pages for:
• Product information and release news
• Access to the Kofax Knowledge Base
• Access to the online Case Management System (for eligible customers)
• Downloadable product documentation
Before contacting your technical support provider, please gather the following information, as applicable:
• Product name, version, and serial number
• Log files
• Product license
• Exact error messages
• Reproduction scenario
4
Chapter 1
Overview
Kofax VRS is an image enhancement tool intended to provide the best possible image quality across the
widest range of document types. Kofax VRS works alongside your scan application to ensure that every
scanned image meets your quality standards. Through instant detection of poor image quality, Kofax VRS
performs automatic image enhancements. Kofax VRS provides a set of interactive adjustment controls to
eliminate guesswork with easy, real-time image correction.
This guide includes important information to help you install Kofax VRS and register the product.
All Kofax VRS installations include the Kofax VRS Test Console and the Kofax VRS Test Application (or
VCDemo). Use either of these sample scan applications to test or demonstrate the benefits of Kofax VRS.
System Requirements
In addition to the hardware requirements listed here, information about supported operating systems
and other Kofax VRS system requirements is available in the Kofax VRS 5.2.0 Technical Specifications
document from the Kofax Knowledge Base. The Technical Specification document is updated regularly,
and we recommend that you review it carefully before installing your product.
Hardware Requirements:
• Minimum 1 GHz or faster: 32-bit (x86) or 64-bit (x64) AMD / Intel processor
• Minimum 2 GB RAM or more
• 20 GB of available disk space
Microsoft Visual C++ Redistributables
During the product installation, the Kofax VRS installer checks to determine if Microsoft Visual C++
2013 Redistributable (x86) - 12.0.30501 and Microsoft Visual C++ 2015-2019 Redistributable (x86) -
14.22.27821 are already installed. If not, the Visual C++ Redistributables are installed automatically for
you.
The required files are also provided with your Kofax VRS product files:
Media\ISSetupPrerequisites\{09F56021-05C8-46A2-BCD8-
DBF87ED5C928}\vcredist_x86.exe
Media\ISSetupPrerequisites\{5bfc1380-
fd35-4b85-9715-7351535d077e}\vc_redist.x86.exez
5
Kofax VRS Installation Guide
.NET Framework 4.7 Requirement
Kofax VRS 5.2.0 requires Microsoft .NET Framework 4.7 or later.
During a Kofax VRS installation, the installer checks to determine if .NET Framework 4.7 or later is
already installed. If not, .NET Framework 4.7 is installed automatically for you.
.NET Framework 4.7 is also available with your Kofax VRS product files:
Media\ISSetupPrerequisites\{C1015097-96FE-4C5E-BD95-37910B3B16FF}\NDP47-
KB3186497-x86-x64-AllOS-ENU.exe
Additional prerequisite
If you are currently running Windows 7, Windows Server 2008 R2 or Windows Server 2012, a Windows
hotfix must be installed before you can proceed with the .NET Framework 4.7 installation.
During a Kofax VRS installation, the installer checks to determine if the hotfix is already installed. If not,
the hotfix is installed automatically for you.
The hotfix is also available with your product files, as listed in the table.
Operating system Kofax VRS product files - hotfix location
Windows 7 x86 Media\ISSetupPrerequisites\{E03F1F8E-5020-49D4-BB38-
Windows Server 2008 R2 D7E4C6FDF860}
x86
Windows 7 x64 Media\ISSetupPrerequisites\{E03F1F8E-5020-49D4-BB38-
Windows Server 2008 R2 D7E4C6FDF861}
x64
Windows 2012 Media\ISSetupPrerequisites\{E03F1F8E-5020-49D4-BB38-
D7E4C6FDF862}
6
Chapter 2
Installation
To perform a new installation, download Kofax VRS 5.2.0 from the Kofax Fulfillment site to a local drive, or
use the removable installation media issued at the time of purchase (see Product files location).
Note Kofax VRS is designed to install successfully while User Account Control (UAC) is enabled and set
to the Medium level (default) or lower. If the installation does not succeed with UAC enabled, you can
turn off UAC, restart the computer, and then retry the Kofax VRS installation. After installing Kofax VRS
successfully, you can turn on UAC again.
Upgrades
To perform an in-place Kofax VRS upgrade, follow the installation procedures in this guide. When you
start the installation, the existing instance of Kofax VRS is detected and noted on the first installer screen:
"The InstallShield Wizard will upgrade Kofax VRS on your computer." From that point forward, the installer
guides you through the upgrade process.
You can upgrade to Kofax VRS 5.2.0 without removing an existing 5.x or 4.x version beforehand.
However, if Kofax VRS 4.x is currently installed on an operating system earlier than Windows 7, an
inplace upgrade is not supported.
Installation with Kofax Capture
If you have a Kofax Capture installation in place, it includes an earlier version of Kofax VRS. The VRS
component is updated if you install VRS 5.2.0 on the computer where Kofax Capture already exists. After
the update, a separate entry for VRS appears on the "Currently installed programs" list in the Programs
and Features utility.
Install Kofax VRS
Before proceeding with the installation, be sure that you have reviewed the System Requirements section.
1. Confirm that your scanner is installed and connected to the computer according to the
manufacturer’s instructions.
7
Kofax VRS Installation Guide
2. Close all applications on the computer and make sure that you are logged in as a user with
Administrator rights.
Some Domain Administrator accounts prevent you from accessing certain folders and/or registry
entries on the local computer. Make sure that your Administrator account gives you the same level of
folder and registry access as a Local Administrator account.
3. Turn off User Account Control (UAC) until the installation is complete.
4. Start the installer by running setup.exe from one of the following:
• Folder containing the Kofax VRS product files
• Removable electronic media
5. On the first Kofax VRS - InstallShield Wizard pre-installation screen, click Install to begin installing
the required by Kofax VRS items on your computer.
When the items are installed, the Welcome screen appears.
6. On the Welcome screen, click Next to proceed with setup.
7. On the License Agreement screen, carefully review the terms of the End User License
Agreement:
• Use the scroll bar to bring other sections of the license agreement into the viewing area.
• Use the Print button to print a copy of the full license agreement.
8. Do one of the following:
• Select I accept the terms in the license agreement, and click Next to proceed with the
installation.
• Select I do not accept the terms in the license agreement, and click Next to exit the
installation.
9. On the Destination Folder screen, do one of the following to select the location for installing Kofax
VRS.
• Click Next to use the default installation folder listed on the screen.
• Click Change to specify another installation path, and then click Next.
10. On the Ready to Install the Program screen, do one of the following:
• Click Install to start the installation.
• Click Back to review or update settings before starting the installation.
After you start the installation, status messages appear while the process is underway, and you may
be prompted to restart your computer after the installation is finished.
11. When the Kofax VRS Administration Console screen appears, select the name of your scanner
and click Next.
Note Ensure that you install the appropriate driver before using the scanner.
12. When you are notified that the installation is complete, click Finish to exit the installer.
After the installer is closed, Kofax VRS configuration is automatically started and a progress indicator
appears on the screen.
13. When the Kofax VRS Setup success message appears, click OK to exit.
14. Restart UAC.
8
Kofax VRS Installation Guide
Perform a silent installation
As an alternative to the standard Kofax VRS installation process, you can achieve the same results by
performing a silent installation from an elevated Command Prompt that has administrator privileges.
During a silent installation, no manual entries are required.
1. Copy setup.exe to your standalone computer.
• For an existing instance of Kofax VRS, copy the file to your installation folder, which typically uses
the default path:
64-bit: C:\Program Files (x86)\Kofax\ImgCtls
32-bit: C:\Program Files\Kofax\ImgCtls
• For a new Kofax VRS installation, copy the file to any folder on your computer. The default path
will be created automatically during the installation process.
2. Turn off User Account Control (UAC) until the installation is complete.
3. To install Kofax VRS using the default path, run the following command from an elevated Command
Prompt that has administrator privileges:
Setup.exe /s /v" /qn"
4. To set the default scanner, run the following command from an elevated Command Prompt that has
administrator privileges:
Setup.exe /s /v" SCANNERNAME=\"SCANNER NAME HERE\" /qn"
5. To install Kofax VRS using a custom path, run one of the following commands from an elevated
Command Prompt that has administrator privileges, as applicable:
• Standalone 64-bit:
Setup.exe /s /v" INSTALLDIR=\"C:\Program Files (x86)\<PATH>\ImgCtls\" /
qn"
• Standalone 32-bit:
Setup.exe /s /v" INSTALLDIR=\"C:\Program Files\<PATH>\ImgCtls\" /qn"
Uninstall VRS silently
Use this procedure to uninstall VRS silently on a standalone computer.
1. Turn off User Account Control (UAC) until you finish uninstalling VRS.
2. Open an elevated Command Prompt that has administrator privileges, and navigate to the VRS
installation folder.
3. Run the following command:
Msiexec.exe /x{8C3B9971-87E9-4D91-AF83-54F518590387} /qn
Register Kofax VRS
If you are working with a Kofax VRS Basic or Professional license, you are prompted to enter contact
information to complete the product registration when you start Kofax VRS the first time. Follow the
instructions on the screen to register your product online or over the phone.
9
Kofax VRS Installation Guide
As a registered user, you are informed about new products, supported scanners, and any updates to
Kofax VRS.
Upgrade to Kofax VRS Elite
The Kofax VRS Basic and Professional licenses support specific feature sets. An extended set of features
is available if you upgrade to a Kofax VRS Elite license (see the Kofax VRS Feature Sets by License
table).
Kofax VRS Basic and Professional licenses give you the ability to preview Kofax VRS Elite features before
making the decision to upgrade your license. To preview the features, select Kofax VRS Elite Demo from
the Kofax VRS program folder or from the Administration Console. While previewing Kofax VRS Elite
features, any images that you scan are digitally stamped. The stamping is discontinued if you upgrade to
Kofax VRS Elite, or turn off the demo. If you turn off the demo, the Kofax VRS Elite features are no longer
available. After obtaining a Kofax VRS Elite license, use the License panel on the Administration Console
to activate the features permanently. For instructions, see the online help.
Kofax VRS Feature Sets by License
Features Kofax VRS Elite Kofax VRS Kofax VRS Basic
Professional
Crop X X X
Deskew X X X
Edge Cleanup X X X
Auto Brightness X X X
Gamma Correction X X X
Line Filter X X X
Speckle Removal X X X
Fluent User Interface X X X
AIPE License X X X
1
Standard Bar Codes X X X
Simplified Installer X X X
Desktop Productivity X X X
Digital Annotation X X X
Auto Orientation X X
Auto Contrast / Intelligent Cleanup X X
Hole Fill X X
Automatic Color Detection X X
Color Suppression X X
Color Smoothing X X
10
Kofax VRS Installation Guide
Features Kofax VRS Elite Kofax VRS Kofax VRS Basic
Professional
Blank Page Detection X X
Enhanced Bar Code Scanning X X
Multicore Image Processing X X
Edge Fill X
Merge Sides X
Intelligent Halftone X
Auto Profile X
Multicore - Production Scanners X
Device Health - Local X
2
Device Health - SNMP Support X
Add-on Features
Shared profiles VRS License Server required
Shared licensing VRS License Server required
MSI package VRS License Server required
Kofax Monitor VRS License Server required
1
Refers to the standard 1D bar codes (Code 39, Code 128, Code 93, EAN, Postnet, Interleaved 2 of 5,
Linear 2 of 5, UPC-A, and UPC-E)
2
Not available with the Kofax VRS Elite Demo
Remove Kofax VRS
This section explains how to remove Kofax VRS from your computer. If you performed a silent VRS
installation, see Uninstall VRS silently for instructions.
1. Turn off User Account Control (UAC) until you finish uninstalling VRS.
2. Start Control Panel and double-click Programs and Features.
3. Select Kofax VRS on the list of currently installed programs.
4. Click Uninstall.
5. When prompted to confirm removal, click Yes.
6. When prompted to retain custom scan profiles or Auto Profile training data, click Yes to keep them
for use with a future VRS installation. Otherwise, they are removed.
7. When you are notified that the process is complete, click Finish.
11
Chapter 3
Administrator access
By default, Kofax VRS users have full access to every feature in the product. If you prefer to grant
full access only to Kofax VRS administrators, use an XML file to manage access based on user-
specific permissions. The file for this purpose is VRSAccess.xml, which is available in the <Common
Application Data> folder:
ProgramData\Kofax\Vrs
Here is an excerpt from VRSAccess.xml:
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<VRSAccess>
<DisablePublish>0<DisablePublish>
<DisableAllAdmin>0</DisableAllAdmin>
</VRSAccess>
By default, VRSAccess.xml elements are set to zero (0), granting full access to Kofax VRS features.
The table describes how to update the elements for VRSAccess.xml in <Common Application Data>
to restrict access to Kofax VRS administrator features.
VRSAccess.xml Elements
If element is set to: Logged-in user can access all Kofax VRS features
except:
DisableAllAdmin = 1 Preferences, Profile, Auto Profile, and License panels on
DisablePublish value is ignored the Kofax VRS Administration Console.
Profile toolbar controls on the Kofax VRS Interactive
Viewer.
DisablePublish = 1 Publish feature on the Profiles panel on the Kofax VRS
DisableAllAdmin value is ignored Administration Console.
To set more than one level of access to Kofax VRS on the same computer, create an override version of
VRSAccess.xml with alternate settings, and place it in the <User Application Data> folder located
here:
Users\<Current User>\AppData\Roaming
When a Kofax VRS user logs in to the computer, <User Application Data> is always checked first
for the override file. If the file exists, it is used even if it is empty (in which case it has the same effect as
the default VRSAccess.xml file with values set to zero). Otherwise, the VRSAccess.xml file in <Common
Application Data> is used.
12
Kofax VRS Installation Guide
The override file is useful if you are a Kofax VRS administrator, because you can log in to any Kofax VRS
workstation with unrestricted access and manage settings related to scan profiles, Auto Profile training
data, or the product license.
Use VRSAccess.xml to assign different levels of access to Kofax VRS users on the same computer or
multiple computers. For example, you might restrict a scan operator from administrator features while
assigning the scan operator’s supervisor access to all administrator features except Publish. You could
assign full access to any user who is responsible for managing a Kofax VRS installation. The level of
access is based on each user’s Windows login.
As another option, you can use management software such as SCCM or SMS to distribute
VRSAccess.xml files to Kofax VRS client workstations.
Note Apply read-only permission to VRSAccess.xml to prevent unauthorized users from altering the file.
13
