web site at www.kofax.com.
Note Kofax Capture 8.0 has not been tested, or certified, with VRS 3.5 or earlier.
Using these versions of VRS with Kofax Capture 8.0 is not supported.
Adrenaline Support
Kofax Capture supports Adrenaline hardware products, including:
• Adrenaline 850 and 1700 image processing accelerators
• Adrenaline 450, 650, and 650i SCSI scanner controllers
Note The use of Adrenaline accelerators is not supported on Windows Server 2003.
In general, Windows Server 2003 does not support scanning with a SCSI card.
Kofax Capture Operating Requirements
Kofax Capture Report Viewer
The system requirements for the Report Viewer module are the same as those for Kofax Capture.
Kofax KF-Series Boards Support Discontinued
Effective with version 5.5, Kofax Capture no longer supports KF-Series boards. These boards are not compatible with the newest drivers shipped with Kofax Capture, so KF-Series boards must be removed from your computer before you install or upgrade to Kofax Capture 8.0. There is no need to uninstall the KF-Series board drivers.
Terminal Servers and Citrix Support
You can operate Kofax Capture via a Terminal Services or Citrix session. Once logged in to the Terminal Services or Citrix session, Kofax Capture operates as if it were installed on your local computer. However, you should be aware of the following station licensing conditions.
Note Citrix supports all Kofax Capture modules except for the Scan module.
Supported Version
Kofax Capture 8.0 has been certified for use with Citrix Presentation Server 4.5, Enterprise Edition.
Running Multiple Modules in a Session
Station licenses apply to the session rather than the computer. This allows you to run multiple licensed applications in one session. Licensed applications that are running within the same session will share this same station license. For example, if you are running Recognition Server, Validation, and Quality Control modules at the same time, on the same computer, and in the same Terminal Services or Citrix session, then only one Kofax Capture concurrent station license is required.
However, licensed applications that are running within different sessions will not share the same station license. For example, if you are running Recognition Server, Validation, and Quality Control modules at the same time, on the same computer, but each is running in a different Terminal Services or Citrix session, then three Kofax Capture station licenses are required.
Running a Mix of Session and Client Based Modules
Kofax Capture applications that run as services are part of the same session as the console. For example, if Recognition Server is running as a service and a user at the console is running the Validation module, then a single Kofax Capture concurrent station license is used. However, if Recognition Server is running as a service and a user connects remotely (via Terminal Services or Citrix) and runs the Validation module, then two Kofax Capture concurrent station licenses are required.
Tracking Terminal Services and Citrix Session Usage Statistics
In order to track individual sessions running on a single station, the station ID for the session includes both the station ID and the session ID. For example:
StationID = ScanStation: Sess 42
Disconnecting and Logging-Out Terminal Services and Citrix Sessions
When a Terminal Services or Citrix session is disconnected, the session state becomes
“Disconnected.” All running applications remain running in an idle state, and any consumed Kofax Capture station licenses remain consumed. When the user logs in again and reconnects, the session becomes active again, and the running applications resume their prior states.
Note If a licensed Kofax Capture module is running within a disconnected session and the administrator forces a logoff of that session, or the application terminates abnormally for any reason, the consumed Kofax Capture station license will be released within the time-out period (20 minutes by default) or after the Kofax Capture licensing service has been manually restarted.
When a Terminal Services or Citrix session is logged-out, the session is closed and any consumed Kofax Capture licenses are released. The session no longer displays in the Management Console.
VMware Support
Kofax Capture 8.0 has been certified for virtual computers hosted by the following VMware products:
• VMware ESX Server 3.0
• VMware Server 1.0
Kofax Capture Operating Requirements
Warning Kofax recommends that you disable hyper-threading on the VMware computer to avoid the possibility of intermittent error messages.
For more information about running the VMware product in a hyper-threaded environment, please check the VMware Support site.
Chapter 3
Planning Your Kofax Capture Installation
Introduction
Planning your installation in advance will ensure that your deployment proceeds efficiently, and your sites are set up according to the needs of your company.
The information in this chapter will help you plan your Kofax Capture installation.
This chapter begins with general installation notes regarding your Kofax Capture environment, and continues with a discussion of some decisions that need to be made before installing and using Kofax Capture.
Setting Up Your Environment
Before installing Kofax Capture, set up your system environment as described in this section.
Privileges and Permissions
At each site, set up the following privileges and permissions:
• The logged in user must have full administrative privileges to the local computer.
• The users who will be installing and/or using the client workstations must have Full Control permissions for the Windows folder on the client
workstation.
• If the Kofax Capture server files are being installed on an NTFS partition, the users who will be installing and/or using the client workstations must have Full Control permissions for the server folder that will contain the server files.
The default name for this folder is CaptureSV.
Folder permissions can be set by right-clicking the folder name from Windows Explorer and selecting Properties | Security tab. Refer to your Windows documentation for additional information.
The folder permissions required to install and run Kofax Capture are summarized in Appendix D on page 213.
Environment Variables
Warning If the TEMP and TMP environment variables are not set up as described below, Kofax Capture will not install or run.
During installation, Kofax Capture needs to access the TEMP and TMP folders on the local drive. The TEMP and TMP folders must be set up as follows:
• The TEMP and TMP environment variables must be defined.
• The paths for the TEMP and TMP environment variables must not exceed 100 characters.
The TEMP and TMP paths can be changed through the Environment Variables display (from the Control Panel, select System | Advanced tab | Environment Variables), and then by editing the TEMP and TMP paths in the User Variables list.
Planning Your Installation
There are various ways that you can configure your Kofax Capture installation. The following information can help you make informed decisions.
Planning decisions that must be made prior to installing Kofax Capture are:
• Installation type
• High availability installations
• File locations
• Running modules as services
• Station and site identification
• Optional upgradefor high performance OCR/ICR engine
• Optional enhanced bar code engine
• Optional VRS station licenses
• Restart login mode
• Installation mode
• Deployment methods
Planning Your Kofax Capture Installation
• Kofax Capture port requirements
Planning decisions that you might want to make before using Kofax Capture are:
• Database configuration
• Security configuration
Decisions Prior to Installing Kofax Capture
This section covers decisions that you need to make before installing Kofax Capture.
Installation Type
You can install Kofax Capture in a standalone or a client/server configuration.
In a client/server configuration, you can also install a Kofax Capture client workstation on the server.
Standalone
In a Standalone configuration, both the client applications and the server components are installed on the same local computer. This is a good choice if you expect to perform all of your scanning and processing, including releasing the data and images, on the same computer at a single location.
Client/Server Without a Workstation Enabled on the Server
In this configuration, only the files required to install or support client workstations are installed on the server. In this case, the server cannot be used as an additional client workstation.
Client/Server With a Workstation Enabled on the Server
This configuration is the same as the above, and also enables the server to run Kofax Capture client applications. For example, you might want to use the server to run a Kofax Capture client application that does not require user input, but that could take advantage of the power of the server computer, such as Recognition Server.
High Availability Installations
Regardless of the installation type, you can elect to take advantage of one or more of Kofax Capture’s High Availability capabilities.
These include support for Web farms (using Microsoft Network Load Balancing), Microsoft Cluster Services, backup license servers, and more. Refer to Chapter 5 –
Installing Kofax Capture Enterprise on page 61 for information about Kofax Capture’s high availability support.
File Locations
You need to determine whether you want to install your server software and server files at the default locations or at custom locations.
Server Software
This includes the Kofax Capture System database (SQL Server 2005 Express Edition), also known as the standard database or batch catalog, and supporting files used by Kofax Capture to manage the batches.
During installation, the server software must be installed on a local, unmapped non-UNC drive. Only components that must run on the server computer are installed to this location.
The default location is: C:\Program Files\Kofax\CaptureSS Server Files
This includes such items as the client workstation setup program, batch classes, and batches.
For these files, you can specify a shared folder on the same computer as the server software (strongly recommended), or a folder on a different computer.
The default location is:
C:\Documents and Settings\All Users\Application Data\Kofax\CaptureSV
Running Modules as Services
You can run the unattended Kofax Capture modules as services. This includes Kofax Capture Import Connector - XML, Recognition Server, Kofax PDF Generator, OCR Full Text, Remote Synchronization Agent (RSA) and/or the Release modules. As services, these unattended modules can be configured to start automatically at system startup, without any user intervention.
However, services do not support mapped network drives. Therefore, for client/
server installations, you must specify a UNC path for your Kofax Capture installation folder.
Refer to the Installing Services appendix in the Kofax Capture Getting Started Guide for more details on setting up unattended modules to run as services.
Planning Your Kofax Capture Installation
Station and Site Identification
You need to determine the names you will use to identify your stations and your sites.
A site can consist of one or more workstations in any of the supported configurations.
Station ID
This assigns an ID to the station, and is used to identify where batches are created or processed. The station ID can be from 1 to 32 characters. It can be any combination of letters and numbers. It may not include the following characters:
The station ID defaults to the computer name. You should choose a name that is meaningful to you. You might consider names that reflect the location or functions of the workstations. For example, the third client workstation being used for scanning at the Irvine facility of a company might be named IrvineScan3.
Site ID
This assigns a numeric value to the site. The site ID can be from 1 to 4 digits. The site ID can range from 1-9999.
Site Name
This assigns a name to the site. The site name can be from 1 to 32 characters. It can be any combination of letters and numbers. The site name defaults to the computer name. You should choose a name that is meaningful to you. It can be any combination of letters and numbers. It may not include the following characters:
- “ $ ` = \ { } ; >
' , . / ~ ! @ # ^ ?
& * ( ) _ + | : < %
- “ $ ` = \ { } ; >
' , . / ~ ! @ # ^ ?
& * ( ) _ + | : < %
Optional Upgrade for High Performance OCR/ICR Engine
You need to determine if you want to upgradeto the “High Performance ICR/OCR”
engine. This engine combines high speed with excellent accuracy, and offers the following components:
• AEG Recognition provides an alternate high performance recognition engine for OCR and ICR processing, and is typically used in conjunction with the voting feature.
• Voting is a recognition method in which two or more recognition engines interpret the same text on a character-by-character basis. The results from each engine are compared, and then a special voting algorithm is used to pick the best results.
The voting feature and AEG Recognition engine can be made available by purchasing an upgrade called “RecoStar Professional.” Once you have purchased this upgrade, you will receive a special hardware key that must be installed on a USB port of the computer running the Recognition Server. Note that the Zone Test functionality in the Administration module can be used to test the advantages of this feature without the hardware key (and without purchasing the upgrade). Contact your Kofax Certified Solution Provider (CSP) for details about the RecoStar Professional upgrade.
Optional Enhanced Bar Code Engine
You need to determine if you want to upgrade to the Enhanced Bar Code Engine. This engine allows:
• Color bar code processing directly from color images
• Color bar code processing at DPIs as low as 100 DPI
• Support for one- and two-dimensional (2-D) bar code types from color, grayscale, or bitonal images
Note that, depending on the setup parameters, Kofax Capture usually performs bar code recognition within the Scan module.
However, in the following cases, it is necessary to defer bar code recognition to the Recognition Server module. If you plan to use the Enhanced Bar Code Engine in these cases, the computer running the Recognition Server module must have the
appropriate license.
• If there are automatic index zones of any kind in the document class, all bar codes, including page level bar codes, will be processed by the Recognition Server module.
Planning Your Kofax Capture Installation
• If there is more than one type of bar code per document class (including all page level or zonal bar codes), all bar codes will be processed by the Recognition Server module.
• If there are any Recognition scripts, all bar codes will be processed by the Recognition Server module.
• If there is more than one form type, all bar codes will be processed by the Recognition Server module.
Table 3-1 shows the licensing requirements for various configurations using the Enhanced Bar Code Engine.
1 Requires an Adrenaline 650i or newer model Adrenaline 850 or 1700 that supports the Enhanced Bar Code Engine. The newer model Adrenaline accelerators are marked “EBC” on the outside of the mounting bracket. Every workstation must have such a card installed to use this feature without implementing one of the other two licensing methods.
2 Requires that an Enhanced Bar Code hardware key be installed on every workstation. If you are using this hardware key, you must shut down all Kofax Capture modules before you attach the Enhanced Bar Code Engine hardware key. Failure to do so will yield unpredictable processing results.
3 Requires that Enhanced Bar Code be added to your Kofax Capture licensing. In a standalone configuration only one Enhanced Bar Code station license is required, but in a client/server
configuration, a license can only be used by one workstation at a time. In a client/server configuration, if a module attempts to use a license while another workstation is using it, the module will either use a Table 3-1. Licensing Requirements for the Enhanced Bar Code Engine
Module Processing Activity Adrenaline
Quality Control Bar code recognition when scanning with
Recognition Server Bar code recognition 3 3
Engine will be left blank. To avoid this condition, we recommend that you purchase multiple Enhanced Bar Code station licenses.
Note that Scan, Quality Control, and Recognition Server use an Enhanced Bar Code station license while a batch invokes the Enhanced Bar Code Engine. In these cases, the license becomes available to other workstations again when the batch closes. However, the Administration module uses an Enhanced Bar Code station license when the Enhanced Bar Code Engine is invoked through a zone test's recognition profile. In this case, the license does not become available to other workstations until the Administration module is closed.
Optional VRS Station Licenses
You need to determine if you want to use VRS.
With VRS, Kofax Capture can repair badly scanned images without the need to physically rescan the documents. In order to take advantage of VRS, you need to obtain one or more VRS station licenses.
Scanner Considerations
The following scanners require that you install Kofax Capture with the /NoVRS option.
• Böwe Bell + Howell Copiscan 8000 VRS Series (8080, 8100, and 8125)
• Fujitsu ScanRight 4097 VRS
• Fujitsu ScanRight 4099D VRS
• Ricoh IS450 VRS
When you plan on using one of these scanners, you must install Kofax Capture after you install other components.
X Recommended installation order 1 VRS for the scanner
2 Adrenaline Image Processing Engine (AIPE) 4.0 (available from the Support pages on the Kofax Web site)
3 Kofax Capture 8.0 using the /NoVRS option X To install Kofax Capture with the /NoVRS option
1 Insert your Kofax Capture 8.0 installation CD 1 into the CD drive.
2 From the Windows taskbar, select Start | Run.
3 In Open, type the path of the Setup.exe file you want to open, or click Browse to locate it.
Planning Your Kofax Capture Installation
4 In the Open box, add the /NoVRS option. For example:
E:\Kofax\Setup.exe /NoVRS
5 Follow the instructions on your screen to install.
Note When installing Kofax Capture on workstations that have older versions of the VRS software installed, you will receive the VRS Detected dialog box, as shown below. When this happens, you can simply dismiss this dialog box by selecting the Continue option and then clicking OK to continue with the installation.
Restart Login Mode
You need to determine how you want to respond to requests for logon information.
At various points in the installation process, the computer will have to restart and you will have to log on. For your convenience, you can choose to have the logon
information automatically reused after each logon.
Installation Mode
You need to determine whether to install Kofax Capture in the interactive mode or the automatic mode.
Interactive Mode
This mode requires you to respond to prompts from the installation, including where to store files. As Kofax Capture is installed, an initialization file is created containing your responses. This file is called ACInsOut.ini. It is located in the TEMP folder. You can then modify and reuse the initialization file for automatic installations. However, it should not be stored as %TEMP%\ACInsOut.ini. You should move or rename the file.
Automatic Mode
This mode does not require you to respond to prompts. The automatic installation can use built-in default values, or values that you provide in an initialization file.
You may want to provide your own initialization file, if you want to centrally control your installations, to ensure consistency, or if you do not have staff on site to respond
You may want to provide your own initialization file, if you want to centrally control your installations, to ensure consistency, or if you do not have staff on site to respond