Kofax Installation Guide

KOFAX
Capture
Installation Guide
10300627-000 Rev A
1994 - 2008 Kofax Image Products, Inc., 16245 Laguna Canyon Road, Irvine, California 92618, U.S.A. All rights reserved. Use is subject to license terms. Third-party software is copyrighted and licensed from Kofax's suppliers. This product includes software developed by the Apache Software Foundation (http://www.apache.org/). This product is protected by U.S. Patent No. 6,370,277. THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF KOFAX IMAGE PRODUCTS, INC. USE, DISCLOSURE OR REPRODUCTION IS PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF KOFAX IMAGE PRODUCTS, INC. Kofax Image Products, Kofax, the Kofax logo, Ascent Capture, the Ascent Capture logo, Ascent, VirtualReScan, the VRS VirtualReScan logo, and VRS are trademarks or registered trademarks of Kofax Image Products, Inc. in the U.S. and other countries. U.S. Government Rights Commercial software. Government users are subject to the Kofax Image Products, Inc. standard license agreement and applicable provisions of the FAR and its supplements. You agree that you do not intend to and will not, directly or indirectly, export or transmit the Software or related documentation and technical data to any country to which such export or transmission is restricted by any applicable U.S. regulation or statute, without the prior written consent, if required, of the Bureau of Export Administration of the U.S. Department of Commerce, or such other governmental entity as may have jurisdiction over such export or transmission. You represent and warrant that you are not located in, under the control of, or a national or resident of any such country. DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.
Contents
How to Use This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv Training . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvi Kofax Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii 1 2 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Kofax Capture Operating Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Server System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Required Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 4 5 6
Client System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Minimum Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Recommended Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Required Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Standalone System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Recommended Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Certified Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Required Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Kofax Capture License Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Network Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Administrative Privileges Required . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Database Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Standard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 11 12 12 14 14 14 15 16 16 16 17
Kofax Capture 8 Installation Guide
iii
Contents
Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 IBM DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Database Validation and Release Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Database Management Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Browser Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Kofax Capture Import Connector - Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Other Installation Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 PDF Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Development Environment Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Scanner Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 VirtualReScan (VRS) Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Adrenaline Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Kofax Capture Report Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Kofax KF-Series Boards Support Discontinued . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Terminal Servers and Citrix Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Supported Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Running Multiple Modules in a Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Running a Mix of Session and Client Based Modules . . . . . . . . . . . . . . . . . . . 22 Tracking Terminal Services and Citrix Session Usage Statistics . . . . . . . . . . . 22 Disconnecting and Logging-Out Terminal Services and Citrix Sessions . . . 22 VMware Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 3 Planning Your Kofax Capture Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25 Setting Up Your Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Privileges and Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Planning Your Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Decisions Prior to Installing Kofax Capture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Installation Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 High Availability Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 File Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Running Modules as Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Station and Site Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Optional Upgrade for High Performance OCR/ICR Engine . . . . . . . . . . . . . 30 Optional Enhanced Bar Code Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Optional VRS Station Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Scanner Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Restart Login Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Installation Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Deployment Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Kofax Capture Port Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
iv
Contents
Decisions Prior to Using Kofax Capture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Database Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Security Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Custom Module and Workflow Agent Support Considerations . . . . . . . . . . . . . 4
34 35 35 35
Installing Kofax Capture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Installing Kofax Capture for the First Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 1: Install Kofax Capture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Kofax Capture With VRS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Client/Server Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Standalone Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 2: Install Adrenaline Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing Adrenaline 850 and 1700 Image Processing Accelerators . . . . . . . Installing Adrenaline 450, 650, and 650i Scanner Controllers . . . . . . . . . . . . Step 3: Install VRS Scanner Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 4: Install the Report Viewer Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing From a Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Upgrading/Updating Kofax Capture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Differences Between Upgrading and Updating . . . . . . . . . . . . . . . . . . . . . . . . . . . Important Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Administrative Privileges Required . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Close All Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Windows Operating System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Batches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Client/Server Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . With SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . With VRS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scanner Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Upgrade/Update Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Converting User Tracking Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Preserving Your Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Recovering After a Failed Upgrade Installation . . . . . . . . . . . . . . . . . . . . . . . . Reinstalling or Repairing VRS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Upgrading Client/Server Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Upgrading to Kofax Capture 8.0 on Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . Upgrading on Client Workstations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Upgrading Standalone Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Updating an Existing Kofax Capture 8.0 Installation . . . . . . . . . . . . . . . . . . . . . . . 37 38 38 38 42 43 44 45 47 47 48 49 49 49 49 49 50 50 50 50 50 51 51 52 53 53 54 54 54 56 57 57
Uninstalling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Contents
Installing Kofax Capture Enterprise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 High Availability Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Multiple Instance Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Terminal Services and Citrix Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 WebSphere Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Backup Licensing Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 High Availability Essentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 What is High Availability? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Kofax Capture and High Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Common Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 What Makes Kofax Capture Resilient? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Microsoft Cluster Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 License Server Failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Automatic Batch Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 KCN Server Web Farm Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Configuring Kofax Capture for High Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Step 1: Install and Configure Kofax Capture in a Microsoft Cluster Server Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Step 2: Set Up One or More Backup License Servers . . . . . . . . . . . . . . . . . . . . . . . . 70 Step 3: Set up your KCN Server Web Farm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Enable the First Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Install Web Server Components on the Web Servers . . . . . . . . . . . . . . . . . . . . 73 Enable Additional Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Configure KCN Server Cache Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Optimize Your Web Farm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 High Availability for Smaller Installations using Microsoft Cluster Server . . . . 74
Disaster Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Interruption of Critical Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Business Continuity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Data Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Site Administrator Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Setting Up for Disaster Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Enterprise Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Shared and Backup Licensing Support for Disaster Recovery . . . . . . . . . . . . 80 Backing Up, Replicating, and Restoring Batches . . . . . . . . . . . . . . . . . . . . . . . 80 Central Site Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
vi
Contents
Alternate Site Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Transferring Custom Module Configuration Data . . . . . . . . . . . . . . . . . . . . . Customizing Workflow Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Switching to a New Primary Central Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting a Central Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting and Importing Administrative Data . . . . . . . . . . . . . . . . . . . . . . . . Backup and Shared License Server Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Backup License Server Support for Disaster Recovery . . . . . . . . . . . . . . . . . . . . . . Shared License Server Support for Disaster Recovery . . . . . . . . . . . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Optional Advanced Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Network Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Backing Up, Replicating, and Restoring Batches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Up Automatic Batch Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling and Configuring Batch Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Multiple Versions of Batch Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Backup Requires Remote Site Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Replication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Restoring Batches Using the KcnsRestoreBatches Command Line Utility . . . . . Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command Line Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Data and Path Substitution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Image Path Substitution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Substitution Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Custom Data Substitution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Data Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Release Script Setup Substitution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Remove and Add Release Script to Apply Edits . . . . . . . . . . . . . . . . . . . . . . .
80 81 81 81 81 81 82 82 82 82 83 84 87 88 88 88 88 90 90 90 90 91 91 92 93 94 94 94 94 95 95 95 96 96 96 97
Transferring Custom Module Configuration Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Switching to a New Primary Central Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Command Line Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
vii
Contents
Deleting a Central Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Command Line Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Exporting and Importing Administrative Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Batch Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Exported and Imported Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 KCNS Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Exported and Imported Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 Transfer Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 User Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Exported and Imported Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Not Exported or Imported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Administrative Data Export and Import Use Case Recommendations . . . . . . . . . . . 107 Exporting Administrative Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 Importing Administrative Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Reinstalling an Alternate Central Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Releasing at Remote Sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 If Release Fails at a Remote Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 7 Setting Up Source Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113 Configuring a Source Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Sharing Scanner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Scanner Profile Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 8 Kofax Capture Network Server Operating Requirements. . . . . . . . . . . . . . . . . . . . .117 KCN Server Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Central Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Remote Sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 Web Server Operating Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 Minimum Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 Recommended Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 KCN Service Operating Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 Remote Site Station Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 Minimum Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
viii
Contents
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 KCN Server License Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 9 Planning Your Kofax Capture Network Server Installation. . . . . . . . . . . . . . . . . . . 123 Setting Up Your Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Privileges and Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UNC Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Proxy Server Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Web Server Port Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Custom Module and Workflow Agent Support Considerations . . . . . . . . . . . . Planning Your Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Decisions Before Installing KCN Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . General Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . KCN Service Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . KCN Service (Log on as) User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . KCN Server Software Component Configurations . . . . . . . . . . . . . . . . . . . . File Cache Folder Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Web Server Software Location and the Web Site . . . . . . . . . . . . . . . . . . . . . . KCN Server Anonymous User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Remote Site Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Web Server Port Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . High Availability Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 123 123 124 124 125 125 126 126 126 127 127 128 128 129 130 131 132
10 Installing Kofax Capture Network Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 KCN Server Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 1: Check Your Environment at the Central Site . . . . . . . . . . . . . . . . . . . . . . . Kofax Capture Check Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . KCN Server Check Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 2: Enable the KCN Service at the Central Site . . . . . . . . . . . . . . . . . . . . . . . . Step 3: To Install the KCN Web Server Components . . . . . . . . . . . . . . . . . . . . . . Installing KCN Web Server Components on IIS . . . . . . . . . . . . . . . . . . . . . . . Step 4: Install KCN Server Remote Sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 5: Convert Kofax Capture Remote Installations to Remote Sites . . . . . . . . Configuration Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Central Site Configuration Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Up Remote Site Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Assigning Remote Site Profiles to Remote Sites . . . . . . . . . . . . . . . . . . . . . . . Sharing Scanner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Additional File Cache Folder Locations . . . . . . . . . . . . . . . . . . Enabling Additional KCN Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 134 134 134 136 138 139 142 142 144 144 145 145 146 146 148
ix
Contents
Disabling the KCN Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Stopping the KCN Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Starting the KCN Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Remote Site Configuration Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Converting a Remote Installation to a Remote Site . . . . . . . . . . . . . . . . . . . . 150 Specifying the Web Server URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Activating the RSA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Configuring Remote Site Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Configuring a Client Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Sharing Scanner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Upgrading/Updating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 Converting Batches From Previous Releases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 Upgrading Your Central Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 Step 1: Stop the Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 Step 2: Upgrade Ascent Capture and Republish Your Batch Classes . . . . . 156 Step 3: Enable the KCN Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 Step 4: Upgrade Ascent Capture Internet Server . . . . . . . . . . . . . . . . . . . . . . 157 Step 5: Restart the Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 Upgrading Your Remote Sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 Step 1: Process All Batches at the Remote Site and Upload Them . . . . . . . . 159 Step 2: Upgrade Your Ascent Capture Software at Your Remote Site . . . . . 159 Deactivating a Remote Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Uninstalling KCN Server Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Uninstalling KCN Server on IIS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Uninstalling KCN Server on WebSphere . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 11 Web Server Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161 IIS Web Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 KCN Server Virtual Directory Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 ACIUpload Virtual Directory Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Adding or Editing File Cache Folder Locations . . . . . . . . . . . . . . . . . . . . . . . 164 Setting Your IIS Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 IIS Authentication Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 Anonymous User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 Basic Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 Integrated Windows Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 IIS and File Cache Permissions Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 Disabling Impersonation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 Configuring File Cache Write Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 NTFS Security Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 KCN Server Installation Folder Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Contents
Logs Folder Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 ACIUpload Folder Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 WebSphere . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Install KCN Server Components on WebSphere . . . . . . . . . . . . . . . . . . . . . . . . . . Step 1: Create a Cache Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 2: Edit ACConfig.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 3: Install KCN Server Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 4: Edit KCN Server Deployment Descriptor . . . . . . . . . . . . . . . . . . . . . . Step 5: Configure Web Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 6. Configure Basic Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Uninstalling KCN Server Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 171 171 171 172 173 174 174 175
12 Installing and Configuring Kofax Capture Import Connector - Email . . . . . . . . . . 177 Installing Kofax Capture Import Connector - Email - Service . . . . . . . . . . . . . . . . . . 178 Installing the Kofax Capture Import Connector - Email - Administration Plug-In . 180 Upgrading From Earlier Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 Configuring Kofax Capture Import Connector - Email . . . . . . . . . . . . . . . . . . . . . . . . Step 1: Configure Kofax Capture Batch Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 2: Verify Batch Class Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 3: Configure User Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 4: Specify a User Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 5: Set Up Email Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 6: Set Up the Outgoing Mail Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 7: Specify Number of Emails in Each Batch . . . . . . . . . . . . . . . . . . . . . . . . . . Step 8: Customize Email Notification Templates . . . . . . . . . . . . . . . . . . . . . . . . . Step 9: Add One or More Mailboxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A 182 182 184 184 184 185 185 186 187 187
Automatic Installations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Automatic Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Types of Automatic Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Initiating Automatic Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Automatic Installation Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deploying Automatic Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using Initialization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Assigning Values in the Initialization File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Initialization File Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The [Main] Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The [SystemFiles] Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The [Path] Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 189 190 190 190 191 191 192 193 194 194
xi
Contents
The [Identification] Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 The [Hardware Information] Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 The [ACIS] Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197 The [SecurityBoost] Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 The [Database] Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 B Setting Up Distributed Server Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .201 Server System Requirements for Server Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Minimum Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 System Requirements for Server Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Recommended Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Novell NetWare Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Distributed Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Upgrading or Updating Distributed Configurations . . . . . . . . . . . . . . . . . . . . . . 204 Upgrading Ascent Capture 6.x or 7.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204 Updating an Existing Distributed Server Configuration . . . . . . . . . . . . . . . . 205 C Backing Up and Restoring Your Standard Database . . . . . . . . . . . . . . . . . . . . . . . .207 Standalone Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 Backing Up the Ascent Capture (version 6.x or 7.x) MSDE Database . . . . . . . . . 208 Restoring the Ascent Capture (version 6.x or 7.x) MSDE Database . . . . . . . . . . 208 Backing Up the Kofax Capture 8.0 Microsoft SQL Server 2005 Express Edition Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 Restoring the Kofax Capture 8.0 Microsoft SQL Server 2005 Express Edition Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 Client/Server Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 Backing Up the Ascent Capture (version 6.x or 7.x) MSDE Database . . . . . . . . . 210 Restoring the Ascent Capture (version 6.x or 7.x) MSDE Database . . . . . . . . . . 210 Backing Up the Kofax Capture 8.0 Microsoft SQL Server 2005 Express Edition Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 Restoring the Kofax Capture 8.0 Microsoft SQL Server 2005 Express Edition Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 D Required Folder Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .213 Client/Server Required Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 Standalone Required Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 Registry Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 KCN Server Required Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 SecurityBoost Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 Minimum Permissions for the Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
xii
Contents
Minimum Permissions for the SecurityBoost User . . . . . . . . . . . . . . . . . . . . 217 Permissions When Using the Scan and Release Modules . . . . . . . . . . . . . . . 217 SecurityBoost and Windows 2000 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 E Kofax Capture Deployment Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 Kofax Capture Deployment Utility Process Overview . . . . . . . . . . . . . . . . . . . . . 219 Command Line Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . No Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Usage [/?] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Default [/default] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ServerPath [/ServerPath:{server path}] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SiteName [/SiteName:{site name}] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SiteID [/SiteID:{site ID}] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . StationID [/StationID:{station ID}] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Proper Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Unsupported Installation Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F 220 220 220 220 221 221 221 221 221 221 222
Kofax Capture Database Management Requirements. . . . . . . . . . . . . . . . . . . . . . . 223 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 Supported Database Management Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 Configuration Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . License Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Database Client Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Database Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Microsoft .NET 2.0 Framework Requirement . . . . . . . . . . . . . . . . . . . . . . . . . Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IBM DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 224 225 225 225 225 225 226
Database Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 G Monitoring Kofax Capture Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 Kofax Capture Monitoring Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 Network Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 Licensing Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 Installed Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230 Installing the Monitoring Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230 Verification of Installed Components and License . . . . . . . . . . . . . . . . . . . . 231
xiii
Contents
Site Monitor Service Credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 Configuring the SNMP Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 Separate Site Monitor Service Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 Site Monitor Service Credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 License Verification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 Sample Monitoring Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 Starting the Sample Monitoring Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 Specifying the Default List of Hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 Specifying a List of Hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .235
xiv
How to Use This Guide
Introduction
This guide contains essential information about installing Kofax Capture and Kofax Capture Network Server (KCN Server). This guide assumes that you have a thorough understanding of Windows standards, applications, and interfaces. It also assumes that, if you are installing KCN Server, you have a thorough understanding of the Internet, Web servers and your Web server software, your network configuration, and Kofax Capture. This guide is for system administrators and developers who are installing Kofax Capture or KCN Server, or who need a description of the installation procedures and requirements.
Related Documentation
In addition to this Kofax Capture Installation Guide, Kofax Capture 8.0 includes the following documentation. Kofax Capture Getting Started Guide This guide introduces the various modules and utilities provided with Kofax Capture, describes basic concepts about document/data capture and Kofax Capture processing, and introduces the components and major features of KCN Server. Kofax Capture Developers Guide The Kofax Capture Developers Guide provides guidance information regarding why you would want to customize Kofax Capture and instructions to do so. Several examples and code segments are provided to demonstrate how to create custom panels, menus, workflow agents, modules, and scripts to enhance Kofax Capture processing.
xv
Kofax Capture Online Help Kofax Capture online Help provides online assistance for system administrators and operators alike. You can access online Help as follows: From the Windows taskbar: Select Start | Programs | Kofax Capture | Kofax Capture Help to display the main Help topic for the Help system. From any modules toolbar or menu bar: Click the Help button from the toolbar, or select Help | Kofax Capture Help Topics from the menu bar to display the main Help topic for the module. From any dialog box: Click the Help button or press F1 to display context sensitive information for the dialog box. Kofax Capture API Reference Guide The Kofax Capture API Reference Guide is an online reference that provides the details of each API library needed to customize Kofax Capture. The API Reference Guide is designed to be used with the Kofax Capture Developers Guide as a primary resource for customizing Kofax Capture. To access the API Reference Guide, select Start | Programs | Kofax Capture 8.0 | API Reference Guide from the taskbar. Quick Reference Cards The set of quick reference cards provides abbreviated steps for performing common tasks for several Kofax Capture modules. Release Notes Late-breaking product information is available from release notes. You should read the release notes carefully, as they contain information that may not be included in other Kofax Capture documentation.
Training
Kofax offers both classroom and computer-based training that will help you make the most of your Kofax Capture solution. Visit the Kofax Web site at www.kofax.com for complete details about the available training options and schedules.
xvi
Kofax Technical Support

For additional technical information about Kofax products, visit the Kofax Web site at www.kofax.com and select an appropriate option from the Support menu. The Kofax Support pages provide product-specific information, such as current revision levels, the latest drivers and software patches, online documentation and user manuals, updates to product release notes (if any), technical tips, and an extensive searchable knowledgebase. The Kofax Web site also contains information that describes support options for Kofax products. Please review the site for details about the available support options. If you need to contact Kofax Technical Support, please have the following information available: Kofax Capture software version KCN Server software version Operating system and service pack version Network and client configuration Copies of your error log files Scanner make and model Scanner engine (board) type Special/custom configuration or integration information
xvii
xviii
Chapter 1
Overview
Introduction
Kofax Capture is designed to support both document capture and data capture in a single application. Both structured and non-structured documents can be scanned in a single batch. The system will automatically recognize each document in the batch and process it based on characteristics that you have predefined. The definition process is simple, quick, and provides an extraordinary amount of control over how your documents are processed. Kofax Capture Network Server (KCN Server) extends the capabilities of Kofax Capture by allowing inexpensive Kofax Capture remote workstations to assist in the capture and processing of documents and data. With Internet (or intranet) capabilities, Kofax Capture workstations can be connected to a central site to assist in the document and data capture process. This guide provides important information about installing and upgrading to Kofax Capture and KCN Server, including: Operating requirements that must be met to successfully install Kofax Capture and KCN Server Preparations, decisions, precautions, settings, and helpful hints that will help you successfully and efficiently install Kofax Capture and KCN Server Instructions for installing Kofax Capture in interactive mode or in automatic mode in a client/server or standalone configuration Instructions for installing KCN Server and creating remote sites Information about installing other Kofax products used with Kofax Capture Information on performing automatic installations
Chapter 1
Chapter 2
Kofax Capture Operating Requirements
Introduction
This chapter provides information about Kofax Capture operating requirements, including hardware and system requirements, and recommendations for installing and using Kofax Capture.
Server System Requirements

This section lists the requirements for installing Kofax Capture on a server station. Note We recommend that you use a dedicated server for Kofax Capture. In particular, we strongly suggest that you do not use your server computer for scanning or importing documents.
Chapter 2
Minimum Hardware Requirements

The following lists the minimum hardware requirements for the Kofax Capture server:
Processor: System memory: Disk space: Pentium 4 processor, or equivalent 1 Gbyte or more 1.3 Gbytes on any local drive, plus 300 Mbytes available on your local C: drive or wherever your operating system is installed, for installation files, temporary files, and working space during processing You may need even more disk space, if you have many image files or a large database. Display: USB port: NIC: 1024 x 768 with 16 bit color, small fonts; 24 bit color is recommended for the best viewing of online Help Kofax Capture hardware key (not required if installing with the software-based licensing option) 100 Mbps
Note Recommended requirements for a Kofax Capture server system are purposely not given as each implementation varies in capacity, load and processing. Testing your Kofax Capture processing workload in a test environment is highly recommended.
Supported Operating Systems

The list below shows the operating systems supported for use with Kofax Capture server files and software. This list represents the minimum requirement for each operating system family and edition. This list does not specify each version and service pack available, only the minimum requirement. Although not explicitly tested, Kofax offers technical support for all supported operating systems. Operating systems marked as certified represent those which have been explicitly tested against Kofax Capture functionality.
Operating System Windows 2000 Server with Service Pack 4 Windows Server 2003 Standard Edition with Service Pack 1 Windows Server 2003 Standard x64 Edition (64-Bit) with Service Pack 1 Windows Server 2003 Enterprise Edition with Service Pack 1 Windows Server 2003 Enterprise Edition with Service Pack 2 Windows Server 2003 Enterprise Edition R2 with Service Pack 2 Windows Server 2003 Enterprise x64 Edition (64-Bit) with Service Pack 1 Windows Server 2003 Enterprise x64 Edition (64-Bit) R2 with Service Pack 2 Windows Server 2003 Datacenter Edition with Service Pack 1 Windows Server 2003 Datacenter x64 Edition (64-Bit) with Service Pack 1 Windows Small Business Server 2003 Standard Edition with Service Pack 1 Windows Small Business Server 2003 Premium Edition with Service Pack 1 Certified
Note Visit the Kofax Web site support page at www.kofax.com for updates to the supported operating systems for Kofax Capture 8.0.
Chapter 2
Note Windows Server 2003 does not support scanning with a SCSI card. Kofax strongly suggests that you do not use your server computer for scanning or importing documents. In general, the Kofax Capture server files and software should be installed on the same computer. However, some existing sites may have legacy issues that require server files to be kept on a computer that is not running any of the Kofax Capture certified operating systems listed above. Refer to File Locations on page 28 for more information about Kofax Capture server files and server software. Refer to Appendix B Setting Up Distributed Server Configurations on page 201 for information about installing Kofax Capture server files on a computer that is not running an operating system certified for use with Kofax Capture.
Required Windows Service

The Server service must be running before installing Kofax Capture on a server workstation.
Client System Requirements

This section lists the requirements for installing Kofax Capture on a client workstation.

The following lists the minimum hardware requirements for the Kofax Capture client systems:
Processor: System memory: Disk space: Pentium 4 processor, or equivalent 512 Mbytes or more 680 Mbytes on any local drive, plus 300 Mbytes available on your local C: drive or wherever your operating system is installed, for installation files, temporary files, and working space during processing 1024 x 768 with 16 bit color, small fonts Enhanced Bar Code Engine hardware key (optional) RecoStar Professional hardware key (optional) 600 DPI to support the Separator Sheet Utility (optional) 100 Mbps
Display: Parallel port: USB port: Printer: NIC:
Chapter 2
Recommended Hardware Requirements

The following lists the recommended hardware requirements for the Kofax Capture client systems:
Processor: System memory: Disk space: Pentium 4 processor, or equivalent 1 Gbyte or more 680 Mbytes or more on any local drive, plus 300 Mbytes or more available on your local C: drive or wherever your operating system is installed, for installation files, temporary files, and working space during processing 1024 x 768 with 24 bit color, small fonts; 24 bit color is recommended for the best viewing of online Help Enhanced Bar Code Engine hardware key (optional) RecoStar Professional hardware key (optional) 600 DPI to support the Separator Sheet Utility (optional) 100 Mbps or higher
Display: Parallel port: USB port: Printer: NIC:

The list below shows the operating systems supported for use with Kofax Capture client workstations. This list represents the minimum requirement for each operating system family and edition. This list does not specify each version and service pack available, only the minimum requirement. Although not explicitly tested, Kofax offers technical support for all supported operating systems. Operating systems marked as certified represent those which have been explicitly tested against Kofax Capture functionality.
Operating System Windows 2000 Professional with Service Pack 4 Windows 2000 Server with Service Pack 4 Windows XP Professional with Service Pack 2 Windows XP Professional x64 with Service Pack 2 Windows Server 2003 Standard Edition with Service Pack 1 Windows Server 2003 Standard x64 Edition (64-Bit) with Service Pack 1 Windows Server 2003 Enterprise Edition with Service Pack 1 Windows Server 2003 Enterprise Edition with Service Pack 2 Windows Server 2003 Enterprise Edition R2 with Service Pack 2 Windows Server 2003 Enterprise x64 Edition (64-Bit) with Service Pack 1 Windows Server 2003 Enterprise x64 Edition (64-Bit) R2 with Service Pack 2 Windows Server 2003 Datacenter Edition with Service Pack 1 Windows Server 2003 Datacenter x64 Edition (64-Bit) with Service Pack 1 Windows Small Business Server 2003 Standard Edition with Service Pack 1 Windows Small Business Server 2003 Premium Edition with Service Pack 1 Windows Vista Business Edition Windows Vista Business x64 (64-Bit) Edition Certified
Chapter 2
Operating System Windows Vista Enterprise Edition Windows Visita Enterprise x64 (64-Bit) Edition
Certified
Note Visit the Kofax Web site support page at www.kofax.com for updates to the supported operating systems for Kofax Capture 8.0. 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. Note The use of scanners is not supported with 64-bit systems.

The Workstation service must be running before installing Kofax Capture on a client workstation.
10
Standalone System Requirements

This section lists the requirements for installing Kofax Capture on a standalone workstation.

The following lists the minimum hardware requirements for the Kofax Capture standalone systems:
Processor: System memory: Disk space: Pentium 4 processor, or equivalent 512 Mbytes or more 760 Mbytes on any local drive, plus 300 Mbytes available on your local C: drive or wherever your operating system is installed, for installation files, temporary files, and working space during processing 1024 x 768 with 16 bit color, small fonts; 24 bit color is recommended for the best viewing of online Help Enhanced Bar Code Engine hardware key (optional) Kofax Capture hardware key (not required if installing the softwarebased licensing option) RecoStar Professional hardware key (optional) 600 DPI to support the Separator Sheet Utility (optional)
Display: Parallel port: USB port:
Printer:
11
Chapter 2

The following lists the recommended hardware requirements for the Kofax Capture standalone systems:
Processor: System memory: Disk space: Pentium 4 processor, or equivalent 1 Gbyte or more 760 Mbytes or more on any local drive, plus 300 Mbytes or more available on your local C: drive or wherever your operating system is installed, for installation files, temporary files, and working space during processing 1024 x 768 with 24 bit color, small fonts; 24 bit color is recommended for the best viewing of online Help Enhanced Bar Code Engine hardware key (optional) Kofax Capture hardware key (not required if installing the softwarebased licensing option) RecoStar Professional hardware key (optional) 600 DPI to support the Separator Sheet Utility (optional)
Display: Parallel port: USB port:
Printer:
Certified Operating Systems

The list below shows the operating systems supported for use with Kofax Capture standalone workstations. This list represents the minimum requirement for each operating system family and edition. This list does not specify each version and service pack available, only the minimum requirement. Although not explicitly tested, Kofax offers technical support for all supported operating systems. Operating systems marked as certified represent those which have been explicitly tested against Kofax Capture functionality.
Operating System Windows 2000 Professional with Service Pack 4 Windows 2000 Server with Service Pack 4 Windows XP Professional with Service Pack 2 Certified
12
Operating System Windows XP Professional x64 with Service Pack 2 Windows Server 2003 Standard Edition with Service Pack 1 Windows Server 2003 Standard x64 Edition (64-Bit) with Service Pack 1 Windows Server 2003 Enterprise Edition with Service Pack 1 Windows Server 2003 Enterprise Edition with Service Pack 2 Windows Server 2003 Enterprise Edition R2 with Service Pack 2 Windows Server 2003 Enterprise x64 Edition (64-Bit) with Service Pack 1 Windows Server 2003 Enterprise x64 Edition (64-Bit) R2 with Service Pack 2 Windows Server 2003 Datacenter Edition with Service Pack 1 Windows Server 2003 Datacenter x64 Edition (64-Bit) with Service Pack 1 Windows Small Business Server 2003 Standard Edition with Service Pack 1 Windows Small Business Server 2003 Premium Edition with Service Pack 1 Windows Vista Business Edition Windows Vista Business x64 (64-Bit) Edition Windows Vista Enterprise Edition Windows Visita Enterprise x64 (64-Bit) Edition
Certified
Note Kofax Capture 8.0 has not been tested on, or certified for, Windows XP Home. Although Kofax is unaware of any specific limitations on using Windows XP Home with Kofax Capture 8.0, the use of Windows XP Home with Kofax Capture is not supported. 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.
13
Chapter 2
Warning When installing Kofax Capture on Windows Server 2003, you may be confronted with a series of warning messages informing you that some files can harm your computer. These messages appear because Windows Server 2003 uses stricter security defaults than earlier versions of Windows. Since this warning will occur repeatedly during the installation process, and may cause automatic/silent installations to fail, you can temporarily relax the security settings. After installation, you may restore the original settings. For more information on this, and for instructions on changing these settings, find article number 182569 in the Microsoft Knowledge Base, and refer to the 1806 Launching applications and unsafe files DWORD setting. Do not attempt to edit the registry unless you have the necessary knowledge and experience. Damaging the registry may make your system inoperative.

The Server service must be running before installing Kofax Capture on a standalone workstation.
Configuration Requirements
This section contains information on a number of Kofax Capture configuration requirements. These are the required system configuration settings for Kofax Capture.
Kofax Capture License Management

Kofax Capture supports a centralized license management scheme that requires a hardware key on the Kofax Capture server at the central site, and on standalone installations. Client workstations do not require hardware keys to run Kofax Capture. Note With the software-based licensing option, the hardware key is not required. Instead, activation occurs with your Kofax serial number and product code. The rest of the installation and activation process remains the same as licensing with a hardware key. The key features of the license management scheme are: Licenses can be delivered and upgraded through the Internet.
14
Licenses must be activated before you can use Kofax Capture permanently. Activation typically occurs during installation of a Kofax Capture server or standalone station, but can also occur after installation. During installation: After the Kofax Capture server or standalone files are installed, the installation may prompt you to attach a hardware key to the server or standalone station. Near the end of the installation process, the installation will contact the Kofax license server to activate the licenses for the options you purchased. Refer to the Kofax Capture online Help for details about activating licenses. Note During Kofax Capture installation on a server or standalone station, you need to have Internet access if you want to automatically activate your license at that time. If the station does not have Internet access, you will be able to install Kofax Capture, but will need to use the Kofax Capture License Utility to activate your licenses after installation. After Installation: If activation during installation fails, you will be able to use your purchased Kofax Capture options for a period of three days. To use the purchased options on a permanent basis, you must use the Kofax Capture License Utility installed with Kofax Capture to activate your licenses after installation. After activation, the Kofax Capture License Utility allows you to view the status of activated licenses, as well as activate new or additional licenses for your system. Refer to the Kofax Capture online Help for details about using the License Utility. Note For more information about the options purchased for your company, contact your system administrator or Kofax Certified Solution Provider.
Network Components
Kofax Capture requires that the TCP/IP protocol be installed and running in your Windows network configuration settings. Prior to installing Kofax Capture, ensure that the following are installed and functioning properly: Client for Microsoft Networks and File and Printer Sharing for Microsoft Networks TCP/IP protocol A NIC (not required for standalone installations)
15
Chapter 2
Contact your network administrator or refer to your Microsoft documentation for more information about these components. Note Not having the TCP/IP protocol may be a problem in standalone installations that have never been connected to the Internet, or a network, or where the TCP/IP protocol has been removed or disabled. If you attempt to install a standalone version of Kofax Capture on a computer without TCP/IP, the installation may fail with an Unable to Initialize Batch Catalog error message. The batch catalog is the Kofax Capture database.
Administrative Privileges Required

To install Kofax Capture, the logged-in user must have administrative privileges to the local computer.
Database Support
For new Kofax Capture installations, you can select the desired database configuration (as listed in this section) at the start of the install process. You can also switch database configurations at any time after installation. For upgrades from Ascent Capture 6.x or 7.x, the existing database configuration will be maintained. No option to switch databases is provided during an upgrade, however you can switch at any time after the upgrade. If your current installation is using the Standard (MSDE) database configuration, SQL Server Express Edition will be automatically installed. Standard Kofax Capture uses the Microsoft SQL Server 2005 Express Edition database. This standard database ships with Kofax Capture, and requires no additional software or configuration. Note All references to Microsoft SQL Server 2005 Express Edition in this guide assume Microsoft SQL Server 2005 Express Edition Service Pack 2 unless otherwise noted.
16
SQL Server You can use SQL Server 2000 with Service Pack 4, SQL Server 2005, or SQL Server 2005 64-bit if you want to actively administer the database, or for scalability and availability. Kofax Capture does not ship with or install SQL Server. See the Kofax Capture Getting Started Guide for more information on switching database configurations. Note All references to SQL Server in this guide assume SQL Server 2000 with Service Pack 4 or SQL Server 2005 unless otherwise noted.
Oracle You can use Oracle Database if you want to actively administer the database, or for scalability and availability. To use Oracle Database, create an empty schema where you want to store Kofax Capture information. The user name provided when you installed Kofax Capture must have this schema set as the default schema for that user. The user must also have user rights to create objects in that schema. Refer to Appendix F Kofax Capture Database Management Requirements on page 223 for information about Oracle requirements. Kofax Capture does not ship with or install Oracle. IBM DB2 You can use IBM DB2 if you want to actively administer the database, or for scalability and availability. To use IBM DB2, create an empty schema where you want to store Kofax Capture information. The user name provided when you installed Kofax Capture must have this schema set as the default schema for that user. The user must also have user rights to create objects in that schema. Note For IBM DB2 installations running on Windows, the database must be configured as a Unicode database prior to installing Kofax Capture.
17
Chapter 2
Refer to Appendix F Kofax Capture Database Management Requirements on page 223 for information about IBM DB2 requirements. Kofax Capture does not ship with or install IBM DB2.
Database Validation and Release Support

Kofax Capture supports Microsoft Access 2000, and 2002, or any ODBC-compliant database for the Database Validation feature and for releasing index data to a database. Kofax Capture does not provide ODBC drivers for target databases.
Database Management Components

For managing batches during processing, Kofax Capture uses SQL Server 2005 Express Edition, which is a version of SQL Server. When installing the Kofax Capture server software or a Kofax Capture standalone installation, the required database management components are also installed. Note You must use the versions of the Microsoft Data Access Components (MDAC) that shipped and installed with Kofax Capture. Kofax Capture will install correctly and can coexist with existing installations of SQL Server or MSDE or SQL Server 2005 Express Edition, provided Kofax Capture is installed in a folder under the same parent directory as these products, usually C:\Program Files. For example, if SQL Server is installed in C:\Program Files\MSSQL, then the Kofax Capture server software should be installed in a folder such as C:\Program Files\<Kofax Capture installation folder>. Warning Do not install Kofax Capture in the same directory as SQL Server (all editions) or on a computer with earlier versions of these applications. If you do, the results will be unpredictable and you may render your SQL Server software inoperable.
Browser Support
The online Help for Kofax Capture requires Internet Explorer 6 (or higher) be set as your default browser. Although no known incompatibilities exist with previous
18
versions of Internet Explorer, the online Help for Kofax Capture has been certified only with Internet Explorer 6. If the browser that you are currently using is a version earlier than Internet Explorer 6, the installation will stop and display a warning message indicating that Internet Explorer 6 is not installed. After you acknowledge the warning, the installation will resume. Before using the online Help, install or upgrade your browser to Internet Explorer 6 and set it as the default browser for your system.
Kofax Capture Import Connector - Email

The Kofax Capture Import Connector - Email feature has the same operating requirements as Kofax Capture itself. Refer to Chapter 12 Installing and Configuring Kofax Capture Import Connector - Email on page 177 for information about installing this feature.
Other Installation Options

This section contains information on a number of Kofax Capture installation options. While potentially useful, these are not required.
PDF Generation
The Kofax Capture PDF Generator module is included with Kofax Capture. This module allows you to create PDF files from within Kofax Capture. However, you may continue to use Adobe Acrobat Capture Cluster Server or Personal Edition version 3.04 with all Kofax developed release scripts to create PDF files. If you choose to use Adobe Acrobat Capture Personal Edition, be sure to attach the hardware key provided with your Adobe Acrobat Capture software.
Development Environment Support

Kofax Capture supports the following development languages: For release and import scripts, custom modules, and OCX panels: Visual Basic 6.0 with Service Pack 6 Visual C++ 6.0 with Service Pack 6 Visual Basic .NET version 2005
19
Chapter 2
Visual C# .NET version 2005 For validation and recognition scripts: Softbridge Basic Language (SBL) 5.3 provided with Kofax Capture Visual Basic .NET 2005
Scanner Support
Kofax Capture supports a wide range of desktop and production-level scanners, including: High-end SCSI and video models supported by Kofax Adrenaline hardware products Low-end Group 1, 2, and 3 SCSI models using ISIS drivers VirtualReScan (VRS) ready scanners For a current list of supported scanners, visit the Kofax Web site at www.kofax.com. Select the Scanner Configurator and follow the instructions presented to you.
VirtualReScan (VRS) Support

Kofax Capture 8.0 includes, and automatically installs, VRS. However, additional licensing is required to activate VRS for use with Kofax Capture. Refer to the Kofax Capture Help system for information about licensing VRS. See the section Step 3: Install VRS Scanner Drivers on page 47 for more information about installing VRS drivers. For a complete description of VRS, refer to the Kofax 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.
20
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.
21
Chapter 2
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
22
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.
23
Chapter 2
24
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.
25
Chapter 3
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 upgrade for high performance OCR/ICR engine Optional enhanced bar code engine Optional VRS station licenses Restart login mode Installation mode Deployment methods
26
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 Captures 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
27
Chapter 3
Installing Kofax Capture Enterprise on page 61 for information about Kofax Captures 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 nonUNC 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.
28
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:
' & , * $ . ( ` / ) = ~ _ \ ! + { @ | } # : ; ^ < > ? %
29
Chapter 3
Optional Upgrade for High Performance OCR/ICR Engine You need to determine if you want to upgrade to 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.
30
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.
Table 3-1. Licensing Requirements for the Enhanced Bar Code Engine Module Processing Activity Adrenaline Hardware1 Enhanced Bar Enhanced Bar Code Hardware Code Software Key Licensing2 Licensing3
Administration
Testing zone-level or page-level bar code recognition with QuickZones Bar code recognition when scanning with a scanner Bar code recognition when importing documents
Scan and Quality Control
Recognition Server Bar code recognition
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. 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. 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 second license or, if a second license is unavailable, the values that require the Enhanced Bar Code
31
Chapter 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. Bwe 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. Recommended installation order 1 2 3 VRS for the scanner Adrenaline Image Processing Engine (AIPE) 4.0 (available from the Support pages on the Kofax Web site) Kofax Capture 8.0 using the /NoVRS option
To install Kofax Capture with the /NoVRS option 1 2 3 Insert your Kofax Capture 8.0 installation CD 1 into the CD drive. From the Windows taskbar, select Start | Run. In Open, type the path of the Setup.exe file you want to open, or click Browse to locate it.
32
4 5
In the Open box, add the /NoVRS option. For example:

E:\Kofax\Setup.exe /NoVRS
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 to installation prompts. Automatic installations are described in more detail in Appendix A on page 189.
33
Chapter 3
Deployment Methods You need to determine how you want to deploy Kofax Capture. There are a number of ways that you can deploy Kofax Capture. CD Network (for client/server installations) Kofax Capture Deployment Utility (see Appendix E) Through Network Management software available from a third-party supplier
Kofax Capture Port Requirements Kofax Capture requires that the following ports be open. These requirements may affect your firewall or other security settings. Kofax Capture uses port 2424 for managing licenses and volume usage. Port 2424 must be open between the client and server. Note If you are using Kofax Capture Network Server (KCN Server), port 2424 must also be open between the KCN Service(s) and the KCN Web Server. The Kofax Capture server utilizes TCP ports for communication between clients and the server. The Standard database configuration (SQL Server 2005 Express Edition) also requires a specific UDP port for name resolution of Named Instances. These ports are: UDP port 1434 TCP ports 1433, 1434, and a dynamically assigned port. The dynamically assigned port can be found in the System Registry at:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft SQL Server\AscentCapture\MSSQLServer\SuperSocketNetLib\ Tcp\TcpPort
Note If your database configuration is SQL Server, Oracle, or IBM DB2, consult your database or network administrator for port requirements.
Decisions Prior to Using Kofax Capture

In planning your Kofax Capture installation, there are certain decisions that you might want to make before using Kofax Capture to process batches. These decisions generally do not have to be made before installing.
34
Database Configuration Kofax Capture is installed with SQL Server 2005 Express Edition database components. You can, however, use SQL Server, Oracle Database, or IBM DB2 if you want to actively administrate the database, or for scalability and availability. Note Kofax Capture does not ship with or install a full featured version of SQL Server, Oracle Database, or IBM DB2 (as noted above, SQL Server 2005 Express Edition is installed). Note When user tracking is enabled, Kofax Capture may require large amounts of memory to query or update the database. We recommend that Kofax Capture be the only application installed on the Kofax Capture server computer. Furthermore, if you plan to enable user tracking, it is also recommended that SQL Server, Oracle Database or IBM DB2 be used as the database for Kofax Capture. To use one of the aforementioned databases to help improve performance, you can select these options in the Database Utility.
Security Configuration You can use SecurityBoost to protect critical Kofax Capture files. To use SecurityBoost, you must set minimum system permissions for your operators so that they cannot access critical Kofax Capture files and folders. You must also create a special SecurityBoost user with permissions that allow access to these files and folders. See the section SecurityBoost Permissions on page 215 for more information. You can also find information about SecurityBoost in the online Help.
Custom Module and Workflow Agent Support Considerations

Kofax Capture supports custom modules and workflow agents. A workflow agent is a custom program that allows custom routing of batches in Kofax Capture. If you plan to use custom modules and workflow agents, install the custom modules and workflow agents after installing Kofax Capture. If you do not install them and you try to use them, an error message will display.
35
Chapter 3
Warning Ensure that workflow agents do not display a user interface while batches are being processed through any unattended modules. If the workflow agent attempts to invoke a user interface in certain modules (such as the Recognition Server module, when it is running as a service), that module will hang. See the Kofax Capture online Help for more information on custom modules and workflow agents.
36
Chapter 4
Installing Kofax Capture
Introduction
This chapter provides step-by-step instructions for installing Kofax Capture. The instructions do not describe every installation screen you may see, nor do they cover every decision you may be asked to make. Instead, the focus is on major milestones, key decisions, and possible areas of confusion. Note Depending on your equipment and options, it may take approximately 30 minutes to install Kofax Capture. Before you install Kofax Capture 8.0: Refer to Chapter 2 Kofax Capture Operating Requirements on page 3 for information about requirements and recommendations for installation. Refer to Chapter 3 Planning Your Kofax Capture Installation on page 25 for information about ensuring the installation is smooth and accurate.
Installing Kofax Capture for the First Time

The following is an overview of the major steps for installing Kofax Capture. Depending on the products you have, it may not be necessary to perform all of these steps. Each of the major steps is detailed after the overview. Note The steps must be followed in the order shown, but not all steps will need to be performed. Step 1 Step 2 Install Kofax Capture. Start here to install Kofax Capture. Install Adrenaline Hardware. Perform this step only if you want to install an Adrenaline image processing accelerator or Adrenaline scanner controller for use with Kofax Capture and either a nonHardware VRS scanner or no scanner.
37
Chapter 4
Step 3 Step 4
Install Scanner Drivers. Perform this step only if you want to install scanner drivers on your workstation. Install Kofax Capture Network Server. Perform this step only if you want to install Kofax Capture Network Server (KCN Server) to upload batches from remote sites using the Internet or intranet. To install KCN Server, see Chapters 5, 6, and 7 for more information.
Step 1: Install Kofax Capture

This section covers the steps for installing Kofax Capture. You can also install Kofax Capture in automatic mode. See Appendix A Automatic Installations for more information. Note You must have at least 300 Mbytes of free space available on your local C drive, or wherever your operating system is installed, during the installation process, regardless of which drive you choose for the installation. See Chapter 2 - Kofax Capture Operating Requirements on page 3 for more information.
Kofax Capture With VRS If you have VRS version 3.5 or later installed, it will be overwritten by a newer version of VRS. You will still be able to use VRS after the installation, but you will not be able to use the VRS QC Later feature unless you obtain the necessary license. If you have a version of VRS earlier than 3.5, you must remove or upgrade VRS before installing Kofax Capture. Client/Server Installation Before you install Kofax Capture on any client workstations, you must install Kofax Capture on a server. To install Kofax Capture server 1 2 At the server, shut down any applications (including the Control Panel, virus detection software, and toolbars) that might be running. Insert Kofax Capture installation CD 1 into the CD drive. The CD supports AutoPlay, so the installation will automatically begin. (If it doesnt start, run Autoplay.exe from the CD.)
38
From the main installation menu shown in Figure 4-1, select Install Kofax Capture for the First Time.
Figure 4-1. Kofax Capture Main Installation Menu
Follow the instructions on your screen to install the software. The installation instructions contain additional information that will guide you through the installation process. Be sure to read them carefully before proceeding with each step. As you proceed through the instructions, note the following: When prompted for the type of installation, select Server. When prompted for the destination folder for the server software, choose a path on a local, unmapped, non-UNC drive. The default location is C:\Program Files\Kofax\CaptureSS. When prompted for the destination folder for the server files, choose an installation path that is accessible to all of your client workstations as a permanently mapped, shared drive, or a UNC path. The method (UNC or mapped drive) that you use here will dictate how your client workstations will be installed. The default location is C:\Documents and Settings\All
39
Chapter 4
Users\Application Data\Kofax\CaptureSV. See Chapter 3 Planning Your Installation for more information on default installation locations. Note Do not install the server software and the server files to the same folder. Ensure that the destination path lengths for both the server software and server files do not exceed 100 characters. When prompted for the database configuration, you can select which database configuration to use with Kofax Capture. Standard is the default selection, in which case the Standard database, SQL Server 2005 Express Edition, will be installed. The other options are SQL Server, Oracle, and IBM DB2. If you select an option other than Standard, SQL Server 2005 Express Edition will not be installed. Refer to Database Installation on page 226 for more information. Ensure that the server files are accessible to all Kofax Capture client workstations, either through a UNC path (recommended) or a mapped drive. The path specified from each workstation must be the same and must be in the same format (UNC path or a mapped drive). Note At various points in the installation process, you will have to restart your system and log on. You can choose to log on after each restart or have the installation log on for you after each restart. If you manually log on after each restart, be sure to use the same user account when logging back on. To have the installation log on for you, select Automatically Reboot and log in. The installation will automatically resume once your workstation has been restarted. After the software is installed, you will be prompted to reboot your computer. After your computer reboots, you will be prompted to attach the appropriate hardware key. If you are installing with the softwarebased licensing option, do not install a hardware key. Instead, follow the on-screen instructions to complete activation with your Kofax serial number and product code. If the New Hardware Key Detected message displays, dismiss it. After detecting the hardware key, the installation will activate the license. If activation is successful, Kofax Capture is fully installed.
40
Note If the license cannot be activated during installation, you will be able to use Kofax Capture for a limited period of time. See the Kofax Capture online Help for more information on licensing. Warning After installing Kofax Capture, do not change the name of your computer. Changing the name may cause your installation to become unstable. The server is now installed. Next, you can install Kofax Capture on your client workstations. To install Kofax Capture on a client workstation 1 At the client workstation, shut down any applications (including the Control Panel, virus detection software, and toolbars) that might be running. Note You must initiate the client workstation installation from the client workstation. 2 3 4 If necessary, map a drive to the Kofax Capture server files. Select Start | Run from the Windows task bar and browse to the shared folder where you installed the Kofax Capture server files. Then, run setup.exe from the WrkInst subfolder. Note If you use a UNC path or a mapped drive to access the setup.exe file, the path must be exactly the same on each workstation, and must match the method (UNC or mapped drive) and path used to install the Kofax Capture server files folder. 5 Follow the instructions on your screen to install the software. The installation instructions contain additional information that will guide you through the installation process. Be sure to read them carefully before proceeding with each step. As you proceed through the instructions, when prompted for the destination folder, choose an installation path on a local, unmapped, non-UNC drive.
41
Chapter 4
Note At various points in the installation process, you will have to restart your system and log on. At the first restart, you can choose to log on after each restart or have the installation log on for you after each restart. If you manually log on after each restart, be sure to use the same user account when logging back on. To have the installation log on for you, select Automatically Reboot and log in. The installation will automatically resume once your workstation has been restarted.
Standalone Installation Follow these steps to install Kofax Capture on a standalone workstation. To install Kofax Capture on a standalone workstation 1 2 At the standalone workstation, shut down any applications (including the Control Panel, virus detection software, and toolbars) that might be running. Insert the Kofax Capture installation CD 1 into your CD drive. The CD supports AutoPlay, so the installation will automatically begin. (If it doesnt start, run Autoplay.exe from the CD.) From the main installation screen, select Install Kofax Capture for the First Time. (Refer to Figure 4-1 on page 39.) Follow the instructions on your screen to install the software. The installation instructions contain additional information that will guide you through the installation process. Be sure to read them carefully before proceeding with each step.
3 4
As you proceed through the instructions, note the following: When prompted for the type of installation, select Standalone. When prompted for the destination folder for the software, choose a path on a local, unmapped, non-UNC drive. The default location is C:\Program Files\Kofax\Capture. When prompted for the database configuration, you can select which database configuration to use with Kofax Capture. Standard is the default selection, in which case the Standard database, SQL Server 2005 Express Edition, will be installed. The other options are SQL Server, Oracle, and IBM DB2. If you select an option other than Standard, SQL Server 2005 Express Edition will not be installed. Refer to Database Installation on page 226 for more information.
42
Note At various points in the installation process, you will have to restart your system and log on. At the first restart, you can choose to log on after each restart or have the installation log on for you after each restart. If you manually log on after each restart, be sure to use the same user account when logging back on. To have the installation log on for you, select Automatically Reboot and log in. The installation will automatically resume once your workstation has been restarted. After the software is installed, you will be prompted to reboot your computer. After your computer reboots, you will be prompted to attach the appropriate hardware key. If you are installing with the software-based licensing option, do not install a hardware key. Instead, follow the on-screen instructions to complete activation with your Kofax serial number and product code. If the New Hardware Key Detected message displays, dismiss it. After detecting the hardware key, the installation will activate the license. If activation is successful, Kofax Capture is fully installed. Note If the license cannot be activated during installation, you will be able to use Kofax Capture for a limited period of time. See the online Help for more information on licensing. Warning After installing Kofax Capture, do not change the name of your computer. Changing the computer name may cause your installation to become unstable.
Step 2: Install Adrenaline Hardware

This section describes the installation of Adrenaline image processing accelerators and Adrenaline scanner controllers for use with Kofax Capture. These instructions may differ from those shipped with your Adrenaline hardware. If you are upgrading from an earlier version, you do not need to reinstall your Adrenaline image processing accelerator, or reinstall your drivers. Note Follow these instructions to install Adrenaline image processing accelerators or Adrenaline scanner controllers, if you are using a non-VRS scanner or no scanner.
43
Chapter 4
Installing Adrenaline 850 and 1700 Image Processing Accelerators Warning When installing Adrenaline hardware for use with Kofax Capture, do not install the drivers from the Adrenaline installation CD. Note Adrenaline 850 and 1700 image processing accelerators do not support Windows Server 2003. Follow these instructions to install an Adrenaline 850 or 1700 image processing accelerator. To install an Adrenaline 850 or 1700 image processing accelerator 1 Download and install the most recent AHRT (Adrenaline Hardware Runtime) drivers for your Adrenaline product from the Kofax Web site (www.kofax.com). Make sure your workstation is powered off and unplugged. Wait ten seconds, and then remove its shell (chassis cover). Insert the Adrenaline image processing accelerator in an available PCI slot. You can use any PCI slot for an Adrenaline 850 image processing accelerator. You must use a full-length PCI slot for an Adrenaline 1700 image processing accelerator. Refer to the documentation that came with your Adrenaline image processing accelerator for more information about inserting the accelerator into your workstation. Once the image processing accelerator is inserted, secure the workstations shell into place and plug in the workstation. Restart the workstation. Windows will automatically detect your new Adrenaline image processing accelerator. Follow any instructions on your screen to finish. Configure your scanner using the Scanner Configuration Utility. Refer to Chapter 7 Setting Up Source Devices on page 113 for information about using the Scanner Configuration Utility.
2 3
4 5
44
Installing Adrenaline 450, 650, and 650i Scanner Controllers Warning When installing Adrenaline hardware for use with Kofax Capture, do not install the drivers from the Adrenaline installation CD. The Adrenaline drivers required by Kofax Capture are included on the Kofax Capture installation CD 1, and are installed as part of the Kofax Capture installation process. Note These controllers do not support Windows Server 2003. Windows 2000 Follow these instructions to install an Adrenaline 450, 650, or 650i scanner controller on a Windows 2000 workstation. To install an Adrenaline 450, 650, or 650i scanner controller 1 2 Make sure your workstation is powered off and unplugged. Wait ten seconds, and then remove its shell (chassis cover). Insert the scanner controller in an available PCI slot. Refer to the documentation that came with your Adrenaline scanner controller for more information about inserting the scanner controller into your workstation. Once the scanner controller is inserted, secure the workstations shell into place and plug in the workstation. Restart the workstation. Windows will automatically detect your scanner controller.
3 4
Windows XP Follow these instructions to install an Adrenaline 450, 650, or 650i scanner controller on Windows XP. To install an Adrenaline 450, 650, or 650i scanner controller 1 2 Make sure your workstation is powered off and unplugged. Wait ten seconds, and then, remove its shell (chassis cover). Insert the scanner controller in an available PCI slot. Refer to the documentation that came with your Adrenaline scanner controller for more information about inserting the scanner controller into your workstation. Once the scanner controller is inserted, secure the workstations shell into place and plug in the workstation.
45
Chapter 4
4 5
Restart the workstation. Windows will automatically detect your scanner controller. From the Windows Desktop, right-click My Computer and select Manage. Then, click Device Manager.
Figure 4-2. Device Manager
Expand SCSI and RAID controllers, right-click Advansys 3550 Ultra Wide SCSI Host Adapter, and select Update Driver. This will launch the Hardware Update wizard. Select Install from a list or specific location (Advanced) and click Next. Select Dont search. I will choose the driver to install and click Next. From the list of Models, select the Kofax Adrenaline model and click Next. You may get a message informing you that the adapter driver has not passed Windows Logo Testing. If you do, click Continue Anyway and follow the instructions on your screen. Note Kofax has tested this driver with Windows XP and verified its compatibility independently of the Windows Logo testing program. There are no known problems.
7 8 9
10 When the completion screen appears, click Finish. 11 Your Adrenaline scanner controller will appear in the Device Manager list for SCSI and RAID controllers as shown below.
46
Figure 4-3. Adrenaline Scanner Controller
Step 3: Install VRS Scanner Drivers

Perform this step only if you want to install VRS scanner drivers. To install your VRS scanner driver from installation CD 2 1 2 3 4 Insert the installation CD 2 into your CD drive. Open Windows Explorer and navigate to the Scanner Drivers folder on the CD. Locate the Subfolder for your scanner. Within that subfolder run the installation or setup program to install the driver components for your scanner.
Note If your scanner is not on Kofax Capture installation CD 2, use the Scanner Configuration Utility to configure your scanner source. Refer to Chapter 7 Setting Up Source Devices on page 113 for information about using the Scanner Configuration Utility.
Step 4: Install the Report Viewer Module

Perform this step if you wish to use the Report Viewer to generate, view, print, and export reports based on the user tracking data collected by Kofax Capture.
47
Chapter 4
To install the Report Viewer module 1 2 Shut down any applications (including the Control Panel, virus detection software, and toolbars) that might be running. Insert the Kofax Capture installation CD 1 into the CD drive. The CD supports AutoPlay, so the installation will automatically begin. (If it doesnt start, run Autoplay.exe from the CD.) From the main installation menu shown in Figure 4-1, select Install Kofax Capture Report Viewer Components. When prompted, insert installation CD 2 into the CD drive. Follow the instructions on your screen to install the software. The installation instructions contain additional information that will guide you through the installation process. Be sure to read them carefully before proceeding with each step. Note The Report Viewer components are installed and uninstalled separately from Kofax Capture. Kofax Capture will not be affected if you uninstall the Report Viewer components. Also, the Report Viewer components do not need to be uninstalled before uninstalling Kofax Capture.
3 4 5
Installing From a Network

Kofax Capture and its components can be installed from a network, rather than from the installation CDs. This option makes it easier to complete installations on multiple computers that have access to a single network folder. To install Kofax Capture and components from a network 1 2 Copy the contents of both Kofax Capture installation CDs into a single folder on your network. From any computer attached to your network, browse to the folder where you copied the contents of the installation CDs and double-click the AutoRun.exe file. Complete the installation, as described earlier in this chapter.
As a separate option, you can also install individual Kofax Capture components (such as KCN Server or the Report Viewer) by copying the contents of installation CD Disk 2 to a network folder, then browsing to the Setup.exe file for each component.
48
Upgrading/Updating Kofax Capture

The Kofax Capture installation supports upgrading and updating.
Differences Between Upgrading and Updating

The differences between upgrading and updating are summarized below: Upgrading to Kofax Capture 8.0: Updates all files to the latest version of those files Preserves your current batch classes, profiles, and other settings during the upgrade Preserves your site and station IDs Preserves active batches Updating Kofax Capture 8.0: Updates the non-data files with the same version of those files. This will replace corrupted or missing files. Preserves your current batch classes, profiles, and other settings Preserves your site and station IDs Preserves active batches
Important Notes
Please read the following before you upgrade to or update your Kofax Capture installation. Administrative Privileges Required The logged in user must have administrative privileges to the local computer. Close All Applications Before upgrading the Server or standalone workstation to Kofax Capture 8.0, you must close all applications. This means that all of the modules on every workstation must be closed, including Services, and any third party applications. The MSDE service (MSSQL$AscentCapture) must continue running for the installation to complete successfully.
49
Chapter 4
When upgrading to Kofax Capture 8.0, note the following: You must disable the ACI service. To disable the ACI service run the following from the command line: <Ascent Capture installation folder>\Bin\aciscfg.exe/d You must stop all modules running as services. The services must remain stopped until the upgrade is complete. We recommend that you set the startup type selection to Manual, that way the services will not automatically start when you are prompted to reboot during the upgrade process. Windows Operating System If your previous version was installed on a Windows operating system that does not comply with the operating requirements for this version of Kofax Capture 8.0, you must first upgrade your Windows operating system. Refer to Chapter 2 Kofax Capture Operating Requirements on page 3 for information about the operating requirements. Batches You can perform an upgrade while there are still batches being processed in the system. Client/Server Configurations When upgrading in a client/server configuration, you must upgrade the server software and files from the installation CD. Then, you can upgrade the client workstations. For a server installation, the upgrade or update must be performed on the computer where the server software is installed. Client workstation and standalone installations must be upgraded on the computers where the current installation exists. You cannot upgrade an Ascent Capture server from a client workstation. With SQL Server If you are upgrading from Ascent Capture 6.x or 7.0, and if you moved the Batch Catalog database to SQL Server, you do not need to convert back to MSDE when upgrading to Kofax Capture 8.0. With VRS If you are upgrading an installation that also has VRS version 3.5 or later, your current version of VRS will be overwritten by a newer version. You will still be able to use
50
VRS after the upgrade, but you will not be able to use the VRS QC Later feature unless you obtain the necessary license. If you have a version of VRS earlier than 3.5, you must remove or upgrade VRS before upgrading. Scanner Considerations The following scanners require that you upgrade Ascent Capture with the /NoVRS option. Bwe Bell + Howell Copiscan 8000 VRS Series (8080, 8100, and 8125) Fujitsu ScanRight 4097 VRS Fujitsu ScanRight 4099D VRS Ricoh IS450 VRS
To install Kofax Capture with the /NoVRS option 1 2 3 4 5 Insert your Kofax Capture installation CD 1 into the CD drive. From the Windows taskbar, select Start | Run. In Open, type the path of the Setup.exe file you want to open, or click Browse to locate it. In the Open box, add the /NoVRS option. For example:
E:\Kofax\Setup.exe /NoVRS
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 Kofax Capture 8.0 - VRS Detected dialog box, as shown below. When this happens, you can simply dismiss this dialog box by selecting the Continue option and then click OK to continue with the installation.
Upgrade/Update Methods The installation supports upgrading from Ascent Capture version 6.x or higher. If you have an earlier version of Ascent Capture, you must first upgrade to an intermediate version. Then, you may be able to upgrade to Kofax Capture 8.0. See the table below to determine whether you can upgrade directly.
51
Chapter 4
Note Upgrading to another language is not supported (for example, Ascent Capture 7.0 German to Kofax Capture 8.0 English). If the installation detects that Kofax Capture 8.0 is already installed, it will prompt you to confirm updating the program files.
Table 4-1. Upgrade Methods Existing Version Ascent Capture 4.x or 5.x standalone or Server installation Upgrade Methods You cannot upgrade directly to Kofax Capture 8.0 If upgrading from Ascent Capture 4.x, ensure that all batches have been released. If upgrading from Ascent Capture 5.x, you must be using (at least temporarily) the MSDE database before upgrading to 6.1. Then, upgrade the Operating System to an OS supported by Kofax Capture 8.0. Finally, upgrade Ascent Capture to 6.1 and then to Kofax Capture 8.0. Ascent Capture 4.x and 5.x Server with a workstation installed on the same computer You cannot upgrade directly to Kofax Capture 8.0. If upgrading from Ascent Capture 4.x, ensure that all batches have been released. If upgrading from Ascent Capture 5.x, there is no need to ensure that all batches have been released. Uninstall the workstation on the Server. Then, upgrade the Operating System to an OS supported by Kofax Capture 8.0. Upgrade Ascent Capture to version 6.1 and then to Kofax Capture 8.0 Ascent Capture 6.x, or 7.x to Kofax Capture 8.0 If upgrading from Ascent Capture 6.x or 7.x, upgrade directly to Kofax Capture 8.0. There is no need to ensure that all batches have been released.
Converting User Tracking Statistics Depending on your current database selection, the user tracking statistics are stored in the standard database or in your SQL Server database. When upgrading to Kofax Capture 8.0, user tracking statistics data can be converted from the previous installation's database to the new installations database. Depending on the amount of
52
user tracking statistics in your system, this process may take several hours or more to complete. During an upgrade, user tracking statistics, administrative data, and batches are converted to the new installation's database. You have the option to skip the conversion of user tracking statistics when upgrading to Kofax Capture 8.0. The administration data and batches will still be converted. As you proceed through the installation, the Kofax Capture Conversion message box will display. Select the Skip user tracking statistics data (the administrative data and batches will still be converted) option. If you choose to skip the conversion of user tracking statistics, they will not be converted or available to the new installations database. Preserving Your Settings If you are upgrading an existing installation of Ascent Capture, it is strongly suggested that you back up your server folders and the database containing your batch classes and scripts. See Backing Up and Restoring Your Standard Database on page 207 for more information. Recovering After a Failed Upgrade Installation If you experience a failed installation during an upgrade, use the procedure below to ensure the conversion of existing data. Before you proceed through the installation after a failed upgrade, note the following: This procedure applies to Server and Standalone installations. A previous version of Ascent Capture will not be detected, and the installation will proceed like a clean install. Use the previous file path as the target folder. Data from the previous version will be converted to the new version at the end of the installation. To recover after a failed Kofax Capture install 1 2 Insert the Kofax Capture 8.0 installation CD 1 into the CD drive. Select Start | Run from the Windows task bar and browse to the Setup.exe file on the installation CD.
53
Chapter 4
At the command prompt, add the /Recover option and click OK. For example:
E:\Kofax\Setup.exe /Recover
Follow the instructions on your screen to install. These installation instructions contain additional information that will guide you through the process. Be sure to read them carefully before proceeding with each step.
Reinstalling or Repairing VRS If you need to reinstall or repair VRS within an existing Kofax Capture installation, use the procedure below. Before you proceed, note the following: A reboot is required if you reinstall VRS. This procedure only applies to updating an existing Kofax Capture installation. It has no effect on Kofax Capture upgrades or new installations. This procedure cannot be used with the auto or silent switch. To reinstall or repair VRS 1 2 3 Insert the Kofax Capture 8.0 installation CD 1 into the CD drive. Select Start | Run from the Windows task bar and browse to the Setup.exe file on the installation CD. At the command prompt, add the /VRSReinstall option and click OK. For example:
E:\Kofax\Setup.exe /VRSReinstall
Follow the instructions on your screen to install. These installation instructions contain additional information that will guide you through the process. Be sure to read them carefully before proceeding with each step.
Upgrading Client/Server Installations

The procedures in this section describe upgrading Ascent Capture client/server installations. You must upgrade your server first, and then you can upgrade your client workstations. Upgrading to Kofax Capture 8.0 on Servers Follow this upgrade procedure if your existing Ascent Capture server version is 6.x or 7.x.
54
To upgrade Ascent Capture 6.x, or 7.x server 1 2 Read Important Notes on page 49 before you upgrade. Shut down any applications (including the Control Panel, virus detection software, and toolbars) that might be running (see Close All Applications on page 49). Note If you moved the Batch Catalog (database) to SQL Server in Ascent Capture 6.x or 7.x, you do not need to change back to MSDE for the upgrade. 3 Insert your Kofax Capture 8.0 installation CD 1 into the CD drive of the server where your server files are installed. The CD supports AutoPlay, so the installation will automatically begin. (If it doesnt start, run Autoplay.exe from the CD.) From the main installation menu, select the Upgrade option. Follow the instructions on your screen to upgrade the software. The installation instructions contain additional information that will guide you through the process. Be sure to read them carefully before proceeding with each step.
4 5
As you proceed through the installation, note the following: The installation will search for the currently installed version to determine which method to use to upgrade. If a previous version is detected, an upgrade will be performed. See With VRS on page 50 for additional information. If a previous version is not detected, the Installation Not Found dialog box will display. If this occurs, browse to the folder where the existing server files were installed, and click Next. The Server Installation Detected dialog box will display, if a previous version is found. If a previous version is still not detected, verify that you browsed to the correct location. If the earlier version cannot be found, install Kofax Capture by following the instructions in Step 1: Install Kofax Capture on page 38. Warning Completely reinstalling Kofax Capture will cause loss of your batch classes.
55
Chapter 4
Warning You might need to browse to the folder containing the existing server files before proceeding with the installation. If you do not browse to the appropriate folder, the installation program will attempt to install the server files to C:\Documents and Settings\All Users\Application Data\Kofax\CaptureSV. Do not install the server software to the same folder as the server files. If you moved the Batch Catalog (database) temporarily to MSDE format before the upgrade, you can move it to SQL Server, Oracle, or IBM DB2 through the Database Utility (provided with Kofax Capture 8.0) after the upgrade completes. If you want to switch the Batch Catalog (database) to a different database, you can do so through the Database Utility after the upgrade completes. Warning After upgrading, do not change the name of your computer. Changing the name may cause your installation to become unstable.
Upgrading on Client Workstations Once the server has been upgraded, you can upgrade your client workstations. Note Depending on your current configuration, you may not be able to upgrade directly to Kofax Capture 8.0. Refer to Table 4-1 on page 52. To upgrade a client workstation 1 2 3 Read Important Notes on page 49 before you upgrade or update your installation. At the client workstation, shut down any applications (including the Control Panel, virus detection software, and toolbars) that might be running. Select Start | Run from the Windows task bar and browse to the shared folder where you installed the server files. Then, run Setup.exe from the WrkInst subfolder on the server. Follow the instructions on your screen to upgrade. The installation instructions contain additional information that will guide you through the installation process. Be sure to read them carefully before proceeding with each step.
56
Upgrading Standalone Installations

This procedure describes upgrading a standalone installation to Kofax Capture 8.0. Depending on your current configuration, you may not be able to upgrade directly to Kofax Capture 8.0. Refer to Table 4-1 on page 52. To upgrade a standalone installation 1 2 Read Important Notes on page 49 before you upgrade. Shut down any applications (including the Control Panel, virus detection software, and toolbars) that might be running. Note If you moved the Batch Catalog (database) to your SQL Server in Ascent Capture 6.x, you do not need to change back to MSDE for the upgrade. 3 Insert your Kofax Capture 8.0 installation CD 1 into the CD drive. The CD supports AutoPlay, so the installation will automatically begin. (If it doesnt start, run Autoplay.exe from the CD.) From the main installation menu, select the Upgrade option. Follow the instructions on your screen to upgrade. The installation instructions contain additional information that will guide you through the installation process. Be sure to read them carefully before proceeding with each step.
4 5
If you moved the Batch Catalog (database) to MSDE before the upgrade, you can move it to SQL Server, Oracle, or IBM DB2 through the Database Utility when the upgrade completes. If you want to switch the Batch Catalog (database) to a different database, you can do so through the Database Utility after the upgrade completes. Note After upgrading, do not change the name of your computer. Changing the name may cause your installation to become unstable.
Updating an Existing Kofax Capture 8.0 Installation

Follow these instructions if you need to update the current installation of Kofax Capture. For example, you may need to do this if some files have become corrupted or were inadvertently deleted.
57
Chapter 4
To update a server or standalone configuration 1 2 Shut down any applications (including the Control Panel, virus detection software, and toolbars) that might be running. Insert your Kofax Capture 8.0 installation CD 1 into the CD drive of the station that requires updating. The CD supports AutoPlay, so the installation will automatically begin. (If it doesnt start, run Autoplay.exe from the CD.) From the main installation menu, select the Upgrade option. The existing installation will be detected and an update assumed. Follow the instructions on your screen to update. The installation instructions contain additional information that will guide you through the update process. Be sure to read them carefully before proceeding with each step. Warning After updating, do not change the name of your computer. Changing the name may cause your installation to become unstable. To update a client workstation 1 2 At the client workstation, shut down any applications (including the Control Panel, virus detection software, and toolbars) that might be running. Select Start | Run from the Windows task bar and browse to the shared folder where you installed the server files. Then, run Setup.exe from the WrkInst subfolder. The current installation will be detected and an update assumed. Follow the instructions on your screen to update. The installation instructions contain additional information that will guide you through the update process. Be sure to read them carefully before proceeding with each step.
3 4
Uninstalling
Use the following procedure to uninstall Kofax Capture 8.0. Warning You must uninstall all plug-ins before you uninstall Kofax Capture. To uninstall plug-ins 1 2 From the Control Panel, select Add or Remove Programs. Select a plug-in, and follow the on-screen instructions. Repeat this step with each installed plug-in.
58
To uninstall Kofax Capture 1 2 3 If you are running a module as a service, uninstall the service before uninstalling Kofax Capture. From the Control Panel, select Add or Remove Programs. Select Kofax Capture 8.0, and follow the on-screen instructions. Note You might be prompted to reboot to delete locked files. Choose to reboot.
59
Chapter 4
60
Chapter 5
Installing Kofax Capture Enterprise
Introduction
Kofax Capture Enterprise is identical to Kofax Capture, with the addition of several features that are specifically designed for enterprise-level installations. The installation procedure is the same for Kofax Capture (refer to Chapter 4 for details). In addition to the standard installation, further configuration may be necessary for the various features that are available with Kofax Capture Enterprise.
High Availability Support

Kofax Capture Enterprises High Availability Support feature is covered in detail later in this chapter. Refer to High Availability Essentials on page 62 for more information about this feature.
Multiple Instance Support

The Multiple Instance Support feature allows you to install multiple versions of any Kofax Capture service. This improves the capabilities of multi CPU computers, so they can take full advantage of their potential processing throughput. Refer to the Installing Services appendix of the Kofax Capture Getting Started Guide for more information about this feature.
Terminal Services and Citrix Support

Terminal Services and Citrix server technology can be used to run instances of Kofax Capture modules remotely. Refer to Terminal Servers and Citrix Support on page 21 for more information about configuring this feature.
61
Chapter 5
WebSphere Support
Kofax Capture Enterprise users have the option of installing and deploying Kofax Capture Network Server (KCN Server) components on IBM WebSphere version 6.0. WebSphere can be implemented either on Solaris or Windows operating systems. Refer to WebSphere on page 161 for more information about installing and configuring WebSphere for use with KCN Server.
Backup Licensing Option

Backup license keys (used with High Availability Support) are available by contractual agreement. Contact your sales representative or your Certified Solution Provider for more information about this alternate licensing option.
High Availability Essentials

Kofax Capture Enterprises High Availability Support feature consists of a number of independent components that, when deployed in a highly available computer system, result in robust, fault-tolerant operation. Although fault-tolerant systems are primarily intended for very large enterprise scale organizations, even the smallest company may benefit from some of these components. Note Many high availability features apply to both Kofax Capture Enterprise and Kofax Capture Network Server. For convenience, in this chapter only, the term Kofax Capture will be used to include both Kofax Capture Enterprise and KCN Server, unless otherwise noted. This chapter includes basic information about fault-tolerant systems in general, specific information about Kofax Captures support for high availability, and specific installation guidelines. Tip Configuring and optimizing a fault-tolerant system can be a complex, timeconsuming and expensive task. This chapter includes only information related to Kofax Capture, and it is not intended to be a complete analysis or guide to creating such systems. Depending on the size and complexity of your installation, as well as the skills and experience of your staff, it may be best to retain a consultant who specializes in high availability systems.
62
What is High Availability?

A high availability (resilient) system, at the most fundamental level, is capable of performing its tasks with virtually no downtime. Any complex system has many components, any of which can fail or degrade at any moment. A highly available system will continue to function even if one or more of its components fail. The key idea behind high availability is that a system is only as good as its weakest component (also known as a fault domain). A system is made more resilient by providing redundancy for those fault domains most likely to fail, starting with the weakest and moving up. Kofax Capture and High Availability Kofax Capture is only one link in the chain of high availability. It has features that are intended to work within, and take advantage of, a high availability computer system. Some of these features, even if used in a normal environment, will nonetheless improve the performance and reliability of Kofax Capture. Common Terms You may find it helpful to familiarize yourself with the following terms, which are used throughout this chapter. Failover In case of a problem, failover is the act of automatically switching to redundant or standby equipment upon the failure or abnormal termination of the currently active equipment. Failover happens without human intervention. Scalability Scalability is the ability to respond to increased demand by adding additional equipment, processes, or other capabilities. Recover (a batch) In case of a problem with a batch, recovery is the process of restoring the state of the batch to whatever it was prior to the batch being opened, and recovering all changes made to the batch that would otherwise have been lost due to the problem. After recovery, the batch becomes available to Kofax Capture applications running on any station, including the crashed station. In many cases, recovery happens invisibly to the user (refer to Automatic Batch Recovery on page 67 for details).
63
Chapter 5
Rollback (a batch) In case of a problem with a batch, rollback involves only restoring the state of the batch to whatever it was prior to the batch being opened. Changes made to the batch may be rolled back to what the data was prior to the batch being opened. After rollback, the batch becomes available to Kofax Capture applications running on any station, including the crashed station. In many cases, rollback happens invisibly to the user (refer to Automatic Batch Recovery on page 67 for details).
What Makes Kofax Capture Resilient?

Kofax Capture incorporates a number of individual components that allow you to select a degree of fault-tolerance that is suitable for your business. Because Kofax Captures degree of resilience can be readily scaled, organizations of any size or complexity can find a level of high availability that matches their needs and budget. To ensure that a Kofax Capture installation meets the criteria for high availability it should: Use Microsoft Cluster Services. Run multiple license servers at the central site, providing automatic failover. Use Web farms for installations with KCN Server (based on Microsoft Network Load Balancing). Built-in automatic batch recovery of in-progress batches if a workstation or application fails. Run multiple instances of all the Kofax Capture modules. If one instance fails the other instances can continue working. Also known as scalability. Combined, these steps allow Kofax Capture to continue processing batches even if specific points in the system fail. Figure 5-1 shows an example of a high availability configuration, including KCN Server remote sites.
64
Figure 5-1. Kofax Capture High Availability Configuration Example
65
Chapter 5
Microsoft Cluster Services Microsoft Cluster Services (MCS) provides the ability for a group of independent servers to be managed as a single system for higher availability and greater scalability. A minimum configuration would consist of two servers connected by a network, a mechanism for sharing their disk data, and cluster software (in this case MCS). This software provides failure detection and recovery, as well as the ability to manage the servers as a single system. MCS also provides software routing of incoming network requests to a shared IP address. With Kofax Capture, performance and throughput do not scale as more nodes are added to the cluster, since each cluster resource can be active on only one node at a time. Note MCS does not protect a system from application failures on a particular computer (where the application crashes, but the computer continues to run). However, SQL Server Enterprise is cluster aware and automatically forces a failover if one of the SQL Server applications fails (even if the computer continues running). Although Microsoft Cluster Services and SQL Server Enterprise provide automatic failover, client applications may receive errors during the time needed to complete the failover process. While Kofax Capture hides most errors, some may be exposed to the user. Note Kofax Capture supports MCS only on Microsoft Advanced Server 2000 or Microsoft Windows Server 2003 Enterprise Edition.
License Server Failover Kofax Capture uses a license server to manage all licensing requests. The license server uses a hardware key to lock the activation code to a particular serial number. Note If you are using the software-based licensing option instead of a hardware key, your Kofax serial number and product code are locked to the computer. Kofax Capture supports multiple license serversa primary and one or more backups. When multiple license servers are available, each license server needs its own hardware key, activation code, and license configuration.
66
Note that volume usage in the backup license servers can be very low (there only needs to be enough volume to last until the primary license server is restored). If the primary license server fails, the system automatically switches to another license server. The system can use this backup license server until it runs out of volume. When the primary system is restored, Kofax Capture automatically resumes using it. There are no performance gains from installing multiple backup license servers, so there is no performance-based reason to have more than one backup license server. To the contrary, the introduction of multiple backup license servers requires proportionally more work by the system administrator. If you plan to have more than one backup license server, you might want to weigh any perceived benefits against this additional overhead. Automatic Batch Recovery Kofax Capture can automatically recover a batch if a failure occurs while the batch is being processed. The Automatic Batch Recovery feature is built-in and does not require any special installation or configuration. In order for Kofax Capture to detect a failure and recover batches, some other Kofax Capture application must be running. The other Kofax Capture application will eventually detect the failure and initiate the batch recovery process. This discovery and subsequent recovery will usually take no longer than 15 minutes, and in many cases significantly less time (a matter of seconds). The delay depends on the exact timing and sequence of events. If a Kofax Capture application detects a failure on another station and restores a batch to its last known good state, changes made to the batch after it was opened on the crashed station may be lost if you do not have your batches in SQL Server, Oracle, or IBM DB2. The ability of Kofax Capture to completely rollback or recover a batch without data loss depends, in part, on the batch database option you have selected. SQL Server option: If the Store batches in SQL Server option is enabled, a failed batch is set (rolled back) to its last good state, and then becomes available to Kofax Capture applications. In the vast majority of cases, no data is lost. If the Store batches in SQL Server option is not enabled, no data will be lost if the batch is opened on the same workstation where the problem occurred.
67
Chapter 5
If the Store batches in SQL Server option is not enabled, data will be lost if the batch is opened on some workstation other than the one where the problem occurred. Oracle or IBM DB2 options: If your batches are stored in Oracle or IBM DB2, a failed batch is set (rolled back) to its last good state. The batch then becomes available to Kofax Capture applications. In the vast majority of cases, no data is lost. Batch recovery and rollback events are logged to the error log (Err_YYMM.txt). Note If you discover a problem before a batch is automatically recovered, you may decide to attempt to initiate recovery of the batch by manually restarting the application. If at all possible, you should restart that application on the same station. This maximizes chances for a full recovery of the batch.
KCN Server Web Farm Support KCN Server supports the Microsoft NLB (Network Load Balancing) Web farm technology with multiple nodes (servers). Network load balancing allows a Web server-based application to distribute its workload across multiple Web servers. This not only improves performance, but also provides failover support because if one Web server fails, other Web servers in the network will take over. Such configurations are known as Web farms.
Configuring Kofax Capture for High Availability

This section includes instructions for configuring Kofax Capture for high availability. You can skip those steps that do not apply to your installation. Note that the Automatic Batch Recovery feature is an integral part of Kofax Capture, so there are no specific steps required to implement or configure it. Step 1 Install and configure Kofax Capture. We recommend that you initiate the installation of Kofax Capture Server from one of your cluster nodes. Set up one or more backup license servers. Perform this step only if you intend to install one or more backup license servers. In general, there is no advantage to having more than one backup server.
Step 2
68
Step 3
Set up your Web farm for use with KCN Server. Perform this step only if you want to use Microsoft NLB to set up a Web farm for use with KCN Server.
Step 1: Install and Configure Kofax Capture in a Microsoft Cluster Server Environment
Before you install Kofax Capture in a high availability environment, you must satisfy the following prerequisites: Configure Microsoft Cluster Services. For specific installation details, refer to your Microsoft documentation. Note The computers hosting the Kofax Capture server files, as well as their network connections, must be as optimized as possible. For high availability installations using Microsoft Cluster Server with a redundant drive file system, certain drive configurations may slow down performance while increasing resilience. Install SQL Server on the cluster. For specific installation details, refer to your Microsoft documentation. Create the Kofax Capture shared folder from within the Cluster Administrator. This folder will be used for the Server Files and so it requires Full Control permissions. Refer to Server Files on page 28 for more information about the shared folder. Do not share the folder in Windows Explorer as you normally would for a file share. Note High availability goals may conflict with the desire for optimal performance. For example, RAID drives often provide greater availability, but perform more slowly than standard drives. Additionally, you may prefer to install multiple applications on your KCN Service computers to reduce cost. You need to weigh all of these issues when configuring or optimizing your system. The following steps provide a recommended installation procedure for Kofax Capture that will take full advantage of a high availability environment. 1 2 Install Kofax Capture as you normally would. When asked to specify a server files folder to store data files, be sure to use the file share you created as one of the prerequisites above.
69
Chapter 5
When the install is complete, run DBUtil.exe and change the database configuration so that it uses the SQL Server instance installed on the cluster. Then, if desired, enable the Store batches in SQL Server option. All external, shared files must be placed in the cluster file share folder. These files include: Image Files The folder holding image files is configured with the Image folder setting from the General tab of the Batch Class Properties dialog box in the Kofax Capture Administration module. OCR Full Text Dictionary This dictionary is configured with the Dictionary setting on the OCR tab of the Document Class Properties dialog box. PDF Dictionary This dictionary is configured with the Dictionary setting on the PDF tab of the Document Class Properties dialog box. Field Type Dictionary This dictionary is configured with the Dictionary setting on the Field Type Properties dialog box.
By default, when file operations fail, they are retried every 0.5 seconds for a total retry time of 2 minutes. You can configure these parameters by updating the ACConfig.xml file in the Kofax Capture Server files folder, Config subfolder. The ReliableFileSystem element must be added as a direct child of the ACConfig element.
<ACConfig> <ReliableFileSystem> <Retry MaxRetrySeconds=120 MilliSecondsBetweenTries=500/> </ReliableFileSystem> </ACConfig>
Step 2: Set Up One or More Backup License Servers

Kofax Capture includes a single license server, which is automatically installed. To make the system more resilient, you can start multiple license servers on additional client workstations, provided you have obtained the required licensing. You may optionally run other server-based applications (such as the OCR Full Text or Release modules, but not the Scan or Validation modules) on the same computer as the license server. However, overall system performance may be reduced. This is because the license server requires frequent network transmissions, low to medium CPU usage, and occasional disk access. It is usually easier to configure a successful system by keeping the license servers on dedicated computers. However, running server applications together with the license server can be accomplished through careful configuration.
70
Note If you install your license server on one of the cluster node computers, it is strongly suggested that you have a backup license server. Otherwise, you will lose your failover capability if that node fails. To configure a backup license server 1 2 Install a Kofax Capture Workstation on a second (or additional) computer. Install the backup license servers hardware key. If you are installing with the software-based licensing option, do not install a hardware key. Instead, follow the on-screen instructions to complete activation with your backup Kofax serial number and product code. Run ACLicSrvCfg.exe from <Kofax Capture installation folder>\Bin\ ACLicSrvCfg.exe. Leave the default user set to Local System and click OK. Note If you are also using KCN Server on this computer, a different user is necessary. This user must have access to the folder specified for the licensing service, as well as to the needed KCN Service resources. 5 6 7 The utility starts the service, and then checks to see if the service is running properly. Ensure that the license on the primary server has already been activated (this should have happened when you installed Kofax Capture). To activate the backup server, invoke the license utility with appropriate command-line parameters that cause it to connect to the backup license server:
<Kofax Capture installation folder>\Bin\AcLicUtl.exe /S <ServerName>.
3 4
For example, to run the License Utility against the license server named LicBackup you might use this command prompt:
c:\program files\Kofax\Capture\Bin\ACLicUtl.exe /S LicBackup.
Finally, use the License Utility to activate your backup license server.
Step 3: Set up your KCN Server Web Farm

If you want to use a KCN Server central site with a Web farm, use the following procedure. Following the procedure, each step is explained in more detail.
71
Chapter 5
The Kofax Capture system must include at least two Kofax Capture workstations that host KCN Services. The system must also include at least two KCN File Cache folders on any two computers. Before you install your KCN Server Web farm, you must satisfy the following prerequisites: You must have two or more computers without Kofax Capture installed on them. These will function as the Web farm. You must install at least two Web servers on at least two of these computers. You also need to install IIS. Refer to your IIS documentation for details. Note WebSphere is not supported for use with Kofax Capture in a Web farm. You must configure these Web servers as part of a Web farm using Microsoft Network Load Balancing (NLB). The specific Web farm technology used by KCN Server is Microsoft NLB. Refer to your Microsoft documentation for details. When setting up the NLB port, the port range must include the port for which the Web server is configured. By default, the KCN Web Server listens on port 80. Note Only IIS and KCN Web Server components are allowed on the Web farm nodes. You cannot install any Kofax Capture workstation components, KCN Server file caches, or KCN Services on them. To set up an KCN Server Web farm 1 2 3 4 5 Enable the first Service. Configure the Web servers as part of a Web farm. Install the Web Server components on the Web servers. Enable additional Services. Configure KCN Server Cache Folders. Note The Kofax Capture server, the KCN Server cache folder(s), and all Web servers in the configuration must belong to the same domain.
72
Enable the First Service Next, you must enable the first Service at the central site. Refer to Chapter 10 Installing Kofax Capture Network Server on page 133 for information about installing KCN Server (and enabling the Service). Note In subsequent steps, you will change the default KCN Server file cache folder and create new ones on each KCN Service computer. If installing KCN Server for the first time, you can skip the parts about configuring the cache folder. Refer to Chapter 10 Installing KCN Web Server Components on IIS on page 139 for information about the cache folder.
Install Web Server Components on the Web Servers You need to install the Web Server components on each and every Web server in the Web farm. Note The same Kofax Capture Server and the same cache folder location(s) must be used for all Web servers. Refer to Chapter 10 Installing KCN Web Server Components on IIS on page 139 for information about installing these components.
Enable Additional Services You need to enable at least one additional Service on an Kofax Capture client workstation. You can also add more Services. This not only provides greater reliability, but may also improve performance. Refer to Chapter 10 Step 2: Enable the KCN Service at the Central Site on page 136 for information about installing Services. Note You cannot install KCN Services on the Web servers.
Configure KCN Server Cache Folders By default, all Kofax Capture Network Services use a KCN Server cache folder located within the Kofax Capture Server files folder. Assuming that you have implemented Microsoft Cluster Services as described in this chapter, this folder will be highly available.
73
Chapter 5
However, because there are additional KCN Services deployed on workstations, then the default KCN Server File cache folder should be disabled and a local cache folder added on each client workstation running a KCN Service. Each local cache folder must be accessible by all KCN Services. This will reduce network overhead and may improve performance. Refer to Chapter 10 Configuring Additional File Cache Folder Locations on page 146 for information about adding multiple cache folders. Remember that it is necessary to run the KCN Server Wizard on all the Web servers after making the changes. Note If desired, you can disable the original cache folder. To do so, edit the ACConfig.xml file by replacing the path to the original cache folder with the path to one of the added cache folders.
Optimize Your Web Farm With NLB, client requests are load-balanced among the different Web servers. Adding additional Web servers theoretically improves performance, if the current Web server is the bottleneck. In order to obtain these performance benefits, all the components involved with KCN Server batch upload and insertion must be optimized. In addition, you should ensure that all points in your network have sufficient bandwidth to handle your projected loads.
High Availability for Smaller Installations using Microsoft Cluster Server

Kofax has certified the following for Kofax Capture high availability cluster configurations: Microsoft Windows 2000 Advanced Server Microsoft Windows 2003 Enterprise Edition MS SQL Server 2000 Enterprise with SP4 MS SQL Server 2005 Enterprise
Kofax supports the following for Kofax Capture high availability cluster configurations: Microsoft Windows 2003 Enterprise x64 Edition (64-Bit) MS SQL Server 2005 Enterprise x64 Edition (64-Bit)
74
If you are able or willing to accept a somewhat diminished level of high availability and performance, you can use some of the following configuration variations to reduce the number of computers you need. These variations represent a trade-off between high availability, performance, and hardware costs. You can install Kofax Capture on one of the cluster computers. If you decide to do this, you should use the node that has the least load. Install the Kofax Capture workstation on the remaining cluster computer using the workstation installation program (setup.exe in the WrkInst folder). Note During the installation, be sure that the other cluster computer is powered on. This is required to ensure that the shared disk resource is available during the installation. Keeping in mind that this will have a negative impact on performance, you may choose to run any of the following Kofax Capture server applications on the cluster computers. KCN Service Custom modules with no user interaction (such as Xtrata) License server OCR Full Text module PDF Generator module Recognition module Release module Remote Synchronization Agent XML Import Connector
75
Chapter 5
76
Chapter 6
Disaster Recovery
This chapter provides information about configuring and using the Kofax Capture Disaster Recovery feature. It is intended to be used by system administrators who manage the disaster recovery features of a Kofax Capture Enterprise installation.
Introduction
Disaster recovery is the process of regaining access to the data, hardware and software necessary to resume critical business operations after a natural or humaninduced disaster. In a large Kofax enterprise installation, which includes multiple sites, servers, and personnel centers in various geographical locations, there is a strong need for a thorough business recovery plan. A business recovery plan is a start-to-finish solutions approach to disaster recovery for your site. The Kofax Capture Disaster Recovery feature provides a partial solution, but cannot fill the void for hardware and software configurations that are unique to your site, nor can it provide specific training for your personnel. Your business recovery plan should include a training section for your personnel so they know what to do in various situations. For example, if a central site becomes inoperable, there will be a large number of people whose normal duties will cease, but who could, perhaps, be deployed to start working on solutions.
Interruption of Critical Functions

The Kofax Capture Disaster Recovery feature addresses the infrastructure needed to prepare for business continuity and data recovery. Business Continuity Business Continuity refers to the recovery and restoration of interrupted critical functions. For a Kofax Capture enterprise site, this requires a backup central site. When a disaster strikes, causing the primary site to go down, remote sites are
77
Chapter 6
automatically routed to the alternate central site, personnel perform appropriate tasks per their training, and batches continue to be seamlessly uploaded. This case requires no special action - it is transparent. Data Recovery Data Recovery implies that data is safely backed up and can be restored. For a Kofax Capture enterprise site, this requires that the batch backup feature has been enabled, batches and batch classes are replicated to another secure location, and that administrative data is exported on a regular basis. When a site goes down, it can easily be restored to the last backup point. Note The Disaster Recovery feature ensures recovery of batches that were created at remote sites, but provides no recovery solution for batches created at a central site.
Features
The Kofax Capture Disaster Recovery feature allows you to: Back up, replicate, and restore batches and batch classes Specify batch upload behavior for optimal use of multiple central sites Manage the availability of central sites with easy-to-use utilities Share licensing across a Kofax Capture Enterprise installation Customize how administrative data is copied to alternate central sites Easily send custom module configuration data to an entire installation Customize load balancing among central sites using workflow agents Export and import adminstrative data
Site Administrator Activity

As a site administrator, you are responsible for the following areas: initial setup, routine maintenance, and manual intervention in the case of a down system. For the initial setup, a site administrator must configure shared and backup licenses, set up a backup location for batches and batch classes, configure a replication scheme, create a list of central sites, and specify upload behavior. The administrator can also optionally export administrative data, transfer custom module configuration data, and create custom workflow agents.
78
Disaster Recovery
Routine maintenance might include exporting administrative data at regular intervals, monitoring batch upload activity and balancing, and monitoring batch replication activity. Manual intervention might include adding a central site, switching remote sites to another central site, restoring batches and batch classes to a restored site, importing administrative data to a restored site, and possibly deleting a central site. For business continuity, the system automatically switches batch uploads to alternate central sites depending on defined upload behavior.
Figure 6-1. Business Continuity
Setting Up for Disaster Recovery

You can make configuration settings that affect several areas: the entire enterprise, central sites, alternate central sites, and customization. The following sections explain each configuration.
Enterprise Setup
Disaster Recovery setup at the enterprise level includes the following:
79
Chapter 6
Shared and Backup Licensing Support for Disaster Recovery Because a Disaster Recovery configuration has at least two central sites, it employs a shared license scheme that requires minor configuration adjustments. For more information about activating and configuring licensing for a Kofax Capture Disaster Recovery configuration, see Backup and Shared License Server Support on page 82. Backing Up, Replicating, and Restoring Batches The Disaster Recovery configuration provides several features that allow you to secure your batches and batch classes in the event of a central site failure. First, it provides a mechanism that allows you to automatically back up batches and their associated batch classes to a user-specified location. Once automatic batch backup has been configured, you can schedule third party replication software to transparently copy batch information to a secure location. In the case of a disaster, your critical business data is now securely backed up. Once the down central site is active again, you can execute an easy-to-use command line utility to restore any batches that may have been lost. For more information, see Backing Up, Replicating, and Restoring Batches on page 88.
Central Site Setup

Setting up your central sites for a Kofax Capture Disaster Recovery configuration includes the following: Creating a list of all the central sites and their URLs that are part of your Kofax Capture Disaster Recovery configuration. For more information, see Creating a List of Central Sites and KCN Server Central Site Manager Dialog Box in the Kofax Capture Help system. Specifying batch upload behavior. You can configure a primary site so that remote sites automatically select a central site for load balancing or they upload batches using a priority list of central sites. To specify batch upload behavior and to optionally create a priority list of central sites, see the KCN Server Remote Site Profiles Dialog Box - Business Continuity Tab in the Kofax Capture Help System. You can also specify batch upload behavior using a workflow agent.
Alternate Site Setup

The Kofax Capture Disaster Recovery configuration provides several optional methods that allow you to modify the way batches are processed. For example, when you export administrative data from one system and import it to another, you can substitute new values for the configuration settings. You might use this feature to
80
Disaster Recovery
develop and test using one path for images, and then move to a production configuration using another path for images. You could also use this method to specify a new path for images in a disaster recovery scenario. There are comparable substitution mechanisms provided for image files, custom data, and release script setup data. For more information, see Data and Path Substitution on page 94.
Customization
The Kofax Capture Disaster Recovery configuration also provides several customization options, outlined below. Transferring Custom Module Configuration Data You can place custom module configuration data in a designated folder at the central site. As a result, a KCN Server will automatically send the configuration data to remote sites when they synchronize and to alternate central sites when a batch of another central site is uploaded. This allows administrators to easily send custom module configuration data to the entire installation. For more information, see Transferring Custom Module Configuration Data on page 97. Customizing Workflow Agents You can create a workflow agent using the Kofax Capture Optimized Custom Module API to customize the current load balancing or priority scheme. For example, based on a set of business rules, you might want to override the current priority list and route batches to a different central site from what is currently specified. For more information, see the Kofax Capture 8 Developers Guide.
Operations
After enabling and configuring your Kofax Capture Disaster Recovery configuration, you can manage the use and availability of each central site as explained below. Switching to a New Primary Central Site You can switch any remote site to a new primary central site by running an easy-touse command line utility. You might want to temporarily switch remote sites to another primary central site to perform routine maintenance at a particular central site. In another case, a central site might be down, and to preserve business continuity, you can switch all remote sites to use another central site as a primary. For more information about this utility, see Switching to a New Primary Central Site on page 98.
81
Chapter 6
Deleting a Central Site After switching any remote sites that are using a particular central site, you might want to delete that central site from the KCN Server central site list. You might perform this operation when you want to remove a particular central site for an undetermined period of time. For more information about this utility, see Deleting a Central Site on page 101. Exporting and Importing Administrative Data You can export and import administrative data such as batch classes, KCNS profiles, and user profiles. This allows you to save periodic snapshots of administrative data. You can use administrative data export and import in to duplicate administrative settings when restoring or switching primary sites or to transfer administrative settings from a development site to a production site. For more information, see Exporting and Importing Administrative Data on page 102 and Administrative Data Export and Import Use Case Recommendations on page 107.
Backup and Shared License Server Support

This section explains how licensing is activated and configured in a Kofax Capture Disaster Recovery configuration.
Backup License Server Support for Disaster Recovery

To manage all licensing requests, Kofax Capture supports multiple license servers - a primary and one or more backups. When multiple license servers are available, each license server requires its own hardware key, activation code, and license configuration. In any configuration, if the primary license server fails, the system automatically switches to the backup license server. The system can use this backup license server until it runs out of volume. When the primary system is restored, Kofax Capture automatically resumes using it for licensing. A backup license is included with Kofax Capture Enterprise. With a disaster recovery configuration, you can activate the backup license server at an alternate site. That way, in a disaster situation or during routine maintenance, if the system at the central site that is providing primary licensing becomes unreachable, a system at an alternate central site with backup licensing can continue the licensing function, allowing uninterrupted workflow.
82
Disaster Recovery
For example, your business might require a system that includes two central sites that processes 2M pages a year and has 20 remote sites (with one station license at each site). Regardless of how the site is configured for batch uploading, all remote sites would initially obtain licensing from the primary licensing server at a central site. If, for some reason, the primary licensing server becomes unavailable, licensing would automatically switch to the backup licensing server at an alternate central site. Note The backup license server cannot be used in production because it does not contain a full compliment of page volume and is not intended for normal production. Therefore, the backup license server must be configured to be used only in case the license server fails.
Shared License Server Support for Disaster Recovery

In a Disaster Recovery system configuration, licensing must be shared among all central sites. For example, suppose your system configuration contains two central sites. Set up your configuration using the following general steps: Step 1 Step 2 Install both central sites and attach hardware keys. Activate your licenses. The activation process establishes licensing information for the central sites as well as all remote sites (based on assigned remote site profiles).
a Activate the primary license wherever you plan to run the primary license server. b Activate a backup license at the alternate central site. The backup server can also be activated on the server or any workstation at the site. Step 3 When activation is complete, set up shared licensing by configuring all central sites to use the primary license server. For detailed instructions about configuring central sites to use the primary license server, see Configuration on page 84. Finally, install the remote sites. Remote sites will receive their licensing based on the rules you have established in the KCN Server Remote Site Profiles dialog box.
Step 4
Note The license server on a standalone installation cannot be shared.
83
Chapter 6
Configuration You can configure a shared license by updating the ACConfig.xml file. For a client/ server installation, this file is located in the <ServerFiles>\Config folder. Check with your administrator for the exact location of this file.
Figure 6-2. Licensing for a Disaster Recovery Configuration
The following shows a typical section of the licensing portion of the ACConfig.xml file.
<Licensing> <Service Key=Licensing\Licensing Service Host=System_on_CS_1/> <Service Key=Licensing\Licensing Service Host=System_on_CS_2/> </Licensing>
The terms System_on_CS_1 and System_on_CS_2 reflect the fact that a license server may be activated on any workstation or server at the central site. The following examples show how to configure a shared license. It explains how to edit the ACConfig.xml file and where to place the hardware keys.
84
Disaster Recovery
Two Central Site Configuration The following illustrates a sample two central site configuration.
Table 6-1. Before Editing ACConfig.xml Central Site 1 (Primary) ACConfig.xml File <Licensing> <Service Key=Licensing\Licensing Service Host=System_on_CS_1/> </Licensing> <Licensing> <Service Key=Licensing\Licensing Service Host=System_on_CS_2/> </Licensing> Hardware Key Primary
2 (Alternate)
Backup
Note the changes in the following table.

Table 6-2. After Editing ACConfig.xml Central Site 1 (Primary) ACConfig.xml File <Licensing> <Service Key=Licensing\Licensing Service Host=System_on_CS_1/> <Service Key=Licensing\Licensing Service Host=System_on_CS_2/> </Licensing> <Licensing> <Service Key=Licensing\Licensing Service Host=System_on_CS_1/> <Service Key=Licensing\Licensing Service Host=System_on_CS_2/> </Licensing> Hardware Key Primary
2 (Alternate)
Backup
Note The text that has changed in each ACConfig.xml file is bold.
85
Chapter 6
Four Central Site Configuration In a four central site configuration, a license server is required on only two of the four central sites. The following illustrates a sample configuration.
Table 6-3. Before Editing ACConfig.xml Central Site 1 (Primary) ACConfig.xml File <Licensing> <Service Key=Licensing\Licensing Service Host=System_on_CS_1/> </Licensing> <Licensing> <Service Key=Licensing\Licensing Service Host=System_on_CS_2/> </Licensing> <Licensing> <Service Key=Licensing\Licensing Service Host=Central_Site_3/> </Licensing> <Licensing> <Service Key=Licensing\Licensing Service Host=Central_Site_4/> </Licensing> Hardware Key Primary
2 (Alternate)
Backup
3 (Alternate)
None
4 (Alternate)
None
Note the changes in the following table.

Table 6-4. After Editing ACConfig.xml Central Site 1 (Primary) ACConfig.xml File <Licensing> <Service Key=Licensing\Licensing Service Host=System_on_CS_1/> <Service Key=Licensing\Licensing Service Host=System_on_CS_2/> </Licensing> Hardware Key Primary
86
Disaster Recovery
Table 6-4. After Editing ACConfig.xml (continued) Central Site 2 (Alternate) ACConfig.xml File <Licensing> <Service Key=Licensing\Licensing Service Host=System_on_CS_1/> <Service Key=Licensing\Licensing Service Host=System_on_CS_2/> </Licensing> <Licensing> <Service Key=Licensing\Licensing Service Host=System_on_CS_1/> <Service Key=Licensing\Licensing Service Host=System_on_CS_2/> </Licensing> <Licensing> <Service Key=Licensing\Licensing Service Host=System_on_CS_1/> <Service Key=Licensing\Licensing Service Host=System_on_CS_2/> </Licensing> Hardware Key Backup
3 (Alternate)
None
4 (Alternate)
None
Note The text that has changed in each ACConfig.xml file is bold. Note In addition to editing the ACConfig.xml file, we recommend that you disable the license servers on central sites 3 and 4.
Optional Advanced Settings The following shows a section of the licensing portion of the ACConfig.xml file that uses several advanced features.
<Licensing ServerTimeout=30> <Service Key=Licensing\Licensing Service Host=System_on_CS_1 Protocol=http /> </Licensing>
The ServerTimeout parameter specifies the number of seconds that a site tries to connect to a license server to obtain licensing before it times out. In this case, the site would try for 30 seconds before it times out. The licenses are listed in priority order. If
87
Chapter 6
a site cannot connect to a license server within the server timeout period, it tries the next one on the list. After trying the last server on the list, it begins again at the first server in the list. Network Considerations License sharing occurs among all client stations directly attached to the central site and specified license servers. In order to communicate, the license server requires TCP port 2424. You must allow this port at all central sites. Note Remote sites require only HTTP or HTTPS to communicate with central sites. You do not need to open TCP port 2424 to enable communications and license sharing among remote sites and central sites (only among the central sites themselves).
Backing Up, Replicating, and Restoring Batches

The Disaster Recovery configuration provides several features that allow you to secure your batches in the event of a central site failure. First, it provides a mechanism that allows you to automatically back up batches and their associated batch classes to a user-specified location. Once automatic batch backup has been configured, you can schedule replication software to transparently move batch files to a secure location. In the case of a disaster, your critical business data is now securely backed up. You can restore any batches that may have been lost to an alternate central site or to the down central site when it is active again. The following sections describe how to implement each part of this process.
Setting Up Automatic Batch Backup

This section explains how to set up a Disaster Recovery configuration for automatic batch backup. Once this is set up, you can replicate the backed up files and, in the event of a disaster, restore any lost batches or batch classes. Enabling and Configuring Batch Backup To enable and configure automatic batch backup, add the following element to the ACConfig.XML file:
88
Disaster Recovery
<Replication Path="Backup Path" DelayTimeInMinutes="Delay Time"> <ExcludedBatchClass>Excluded Batch Class</ExcludedBatchClass> </Replication>
Example
<Replication Path="\\MyComputer\Backup\" DelayTimeInMinutes="720"> <ExcludedBatchClass>Order Form</ExcludedBatchClass> <ExcludedBatchClass>Invoices</ExcludedBatchClass> </Replication>
Use the following parameters to configure automatic batch backup. Replication Path The Replication Path specifies a backup location. When you enable the automatic batch backup feature, the system creates a copy of each batch in the specified folder. This makes it ready for replication by a third party software package. If the published batch class used by a batch has not already been replicated, a copy of the batch class is also copied to the specified backup location. Note Deleting batch classes in the backup location is not recommended because you might inadvertently delete a batch class that is needed by a backed up batch. When batches and batch classes are placed in the specified backup location, they are separated into a batch folder and a batch class folder:
<Specified backup location>\Batches\ <Specified backup location>\BatchClasses\
Access to these folders must be granted to the user that is running KCN Service. Failure to grant this permission will prevent batches from being backed up and possibly delay overall batch insertion time. DelayTimeInMinutes The DelayTimeInMinutes parameter defines the time between when a batch is successfully inserted (and backed up) and when the remote site receives notification that the batch can safely be deleted. This delay gives your third-party replication software time to replicate batches before they are automatically deleted from the remote site. During this time, the status of batches at remote sites is In Progress (Replicating - <CentralSiteName>). When setting the delay time, leave a reasonable margin. For example, a time that is too short, such as one hour (60), may not leave enough time to safely replicate batches. On the other hand, a time that is too long, such as 24 hours (1440) might overload the disk with batches waiting for replication. It may also cause a large percentage of
89
Chapter 6
duplicate batches in a disaster recovery situation if remote sites re-send batches that were already restored. A delay time of 12 hours (720) might be a good starting point and then adjust it up or down based on the actual replication time. Batches remain at the remote site until the first time the remote site synchronizes with the central site after the delay time has expired, or the batch is released or deleted at the central site. A batch is only backed up the first time it is uploaded to the central site; it is not backed up again on subsequent uploads. Backed up batches in the specified backup location are deleted only when a batch is released or deleted from the central site. Batch classes are never deleted from the specified backup location. ExcludedBatchClass By default, all batch classes are backed up to the specified backup location. You can exclude any batch class from the backup and replication process using the ExcludedBatchClass parameter. Batch classes in this list and the batches that use them are not placed in the specified backup location. Multiple Versions of Batch Classes The batch backup feature backs up all versions of published batch classes that are uploaded from remote sites. Errors If an error occurs during the backup process, the batch is not deleted from the remote site and an entry is logged to the error file. In this case, the batch is sent back to the remote site and must be uploaded again once the error has been corrected. Backup Requires Remote Site Upgrade The batch backup feature requires that remote sites be upgraded to Kofax Capture 8.0.
Replication
Once you have configured automatic batch backup as outlined in the previous section, you are ready to transfer data to an off-site location on a scheduled basis. This requires that you purchase and configure a third-party replication application of your choice.
90
Disaster Recovery
The replication software that you purchase should be a Windows server, file-based, file replication software application that replicates files over a WAN. Use the instructions that came with your third-party software to install and configure your software on a remote server. When you configure your third-party replication software, specify the replication path. The replication path is the local folder where Kofax Capture makes copies of batches and published batch classes. This is the path that you specified in the ACConfig.XML file in the section titled Setting Up Automatic Batch Backup on page 88.
Figure 6-3. Backup and Replication
Restoring Batches Using the KcnsRestoreBatches Command Line Utility

The KCN Server Restore Batches command utility, KcnsRestoreBatches.exe, is a stand-alone command line utility that restores batches from a specified location. You can find this utility in the Kofax Capture bin folder. Notes All error messages are written to the error log. If the utility encounters a batch that has already been restored, it is skipped.
91
Chapter 6
You can restore batches to Kofax Capture without KCNS installed and enabled. If you restore a batch to a central site that is not connected to the remote site that the batch requires for routing, the central site still routes the batch with the assumption that the required remote site will eventually connect. Only one instance of the utility may be run at a time. The utility cannot be run on a remote site. If the batch routing rules in a batch require routing to a remote site, there must be an installed and enabled KCN service at the site where the batch is restored. Without a KCN service, this type of batch would not be Ready to download. Note that a batch cannot be recalled unless it is ready to download. Command Line Parameters You can specify the path where batches have been backed up and login credentials when required. You can also remove backed up batches that have been successfully inserted. Parameters can be specified with a forward slash (/) or a hyphen (-). /path [path] This parameter is required to specify the location from which you want to restore batches. Follow the /path parameter with a valid path, as in the following example:
KcnsRestoreBatches /path \\mysystem\batchbackup
/u [username] If you run the utility at a site where User Profiles is enabled, an administrator login is required. Use the /u parameter along with the /p parameter to specify a user name and password. See the example for the /p parameter. /p [password] If you run the utility on a central site where User Profiles is enabled, an administrator login is required. Use the /p parameter along with the /u parameter to specify a user name and password. The following example specifies a valid user, steven, and his password, Vq4Rc8t2x.
KcnsRestoreBatches /path \\mysystem\batchbackup /u steven /p Vq4Rc8t2x
/d By default, the utility moves restored batches that have been successfully inserted into a subfolder so it will not attempt to restore them again. If you would rather delete the backed up batches, include the /d parameter.
92
Disaster Recovery
? The ? parameter displays the correct usage of the KcnsRestoreBatches utility to the console. It defines each of the supported command line parameters and provides an example for formatting the command line. For example, you can use the following to display information about correct usage:
KcnsRestoreBatches /?
Error Codes The KCN Server Restore Batches command utility returns the following codes:
Table 6-5. Error Codes Value 0 1 2 3 4 5 Name Normal BadUsage LoginRequired LoginFailed UnknownError IsRemoteSite Description The utility ran successfully and without exception. The path parameter was supplied without an actual path. User Profiles is enabled, but a login was not provided. Credentials were supplied but could not be validated. An unhandled exception was encountered. Please check the error log. The utility was run on a remote site. Therefore, no batches were restored. To successfully restore batches, run the utility on a station other than a remote site. The utility expected the following subfolder in the path specification: <Path>\Batches. If this folder is not specified, an invalid directory message is logged and this error code is returned. Errors occurred during the batch restoration process. Please check the error log for details. The utility was not able to ascertain whether user profile information was needed.
InvalidDirectoryStructure
7 8
NormalExitWithErrors CannotValidateUser
93
Chapter 6
Data and Path Substitution

When you export administrative data from one system and import it to another, you can substitute new values for the configuration settings. Substitution is possible in the following areas: Image Path Substitution Custom Data Substitution Release Script Setup Substitution
Image Path Substitution

Image path substitution allows you to: develop and test using one path for images, and then move to a production configuration using another path for images. specify a new path for images in a disaster recovery scenario. To substitute image path information, modify the ACConfig.xml file. Syntax The path substitution format in ACConfig.xml is:
<ACConfig> <AdminDataSubstitution> <Replace Old="<old path>" New="<new path>" /> </AdminDataSubstitution> </ACConfig>
Example The following sample entry in the ACConfig.xml file specifies substitution paths for images:
<ACConfig> <AdminDataSubstitution> <Replace Old="C:\Capture\Images" New="\\AC\Alternate_B\Images" /> <Replace Old="C:\Working" New="\\AC\Alternate_B\Images" /> <Replace Old="\\Tmp" New="\\AC\Alternate_B\Images" />
94
Disaster Recovery
</AdminDataSubstitution> </ACConfig>
Substitution Locations The system substitutes every entry in the ACConfig.xml file for each of the following locations.
Table 6-6. Text Release Script Substitution Locations Purpose Image folder for a batch class ODBC source for Database Release Script Image folder for Release Script Full text OCR folder for Release Script PDF folder for Release Script Database Table BatchDef ReleaseSetup ReleaseSetup ReleaseSetup ReleaseSetup Database Column ImageDir ConnectString ReleaseDir TextFileDir KofaxPDFDir
Custom Data Substitution

You can also substitute certain custom data using the AscRelSC.inf file. This includes any data in the CustomProperty table. To substitute custom data, modify the ACConfig.xml file and the AscRelSC.inf file. AscRelSC.inf is the setup file used for Kofax Capture Release Scripts. Syntax ACConfig.xml The data substitution format in ACConfig.xml is:
<ACConfig> <AdminDataSubstitution> <Replace Old="<Old Value>" New="<New Value>" />
95
Chapter 6
</AdminDataSubstitution> </ACConfig>
AscRelSC.inf
[Ascent Capture Text] DataSubstitution="<custom property>" PathSubstitution="<custom property>"
Example The following example substitutes a value of False for a value of True found in the EnableKofaxPDFExport property. ACConfig.xml
<ACConfig> <AdminDataSubstitution> <Replace Old="True" New="False" /> </AdminDataSubstitution> </ACConfig>
AscRelSC.inf
[Ascent Capture Text] DataSubstitution="EnableKofaxPDFExport"
Note The search and replace is blind. When you configure for a True/False substitution, make sure that you do not unintentionally globally change the wrong settings.
Data Validation For CAB insert, the system performs no data validation. For KCNS batch insertion, the system first checks to see if the substitution path exists. If it does not, the insertion will fail.
Release Script Setup Substitution

For text and database release scripts, you can substitute path and certain custom data. Note If you have modified your release scripts source code that affects this substitution scheme, you may not get the intended results.
96
Disaster Recovery
Remove and Add Release Script to Apply Edits Whenever you substitute custom data using the AscRelSC.inf file, in order for the changes to take place, you must remove and add the release script using the Release Script Manager.
Transferring Custom Module Configuration Data

You can place custom module configuration data in a designated folder at the central site and the KCN Server automatically sends the configuration data to remote sites when they synchronize and to alternate central sites when a batch of another central site is uploaded. This allows administrators to easily send custom module configuration data to the entire installation. This feature is for large binary data files, such as images. To obtain the name of the designated folder that is used for this data, invoke the CustomDataFolder method. For example, you might want to run a custom module on several remote sites that all require the same sample image. In this case, an admin plug-in would pass the custom module name to the CustomDataFolder method and it would return a data storage path. After copying the sample image to the designated folder on the central site, the next time published batch class information is transferred to other sites, the sample image and any other data in the designated custom module folder would also be transferred. Consequently, a custom module at any remote site can access the image from the corresponding folder location at its remote site. The values that each method returns are read-only and are determined automatically based on the batch class name and the custom modules ID. You can also create subfolders within the designated folder location and all data included in the subfolders are transferred. Each object library (Kofax Capture AdminMod and Kofax Capture Document Access) contains two methods that return a custom module folder name. You can use the methods during setup and during runtime. One method returns a global custom data folder location based on the provided module ID. The other method returns a custom data folder name based on the published batch class and the provided module ID.
97
Chapter 6
The following tables show each method per object library and the folder name string that it returns.
Table 6-7. Kofax Capture AdminMod (ACAdMod.dll) Method AdminApplication.CustomDataF older ( strModuleID as string ) BatchClass.CustomDataFolder (strModuleID as String) Returns folder name string "<CaptureSV>\PubTypes\Custom\<strModuleID>" "<CaptureSV>\PubTypes\Custom\<Batch Class Name>\<strModuleID>"
Table 6-8. Kofax Capture Document Access (DBLite.dll) Method RuntimeSession.CustomDataFold er (strModuleID as String) Batch.CustomPublishedDataFold er (strModuleID as String) Returns folder name string "<CaptureSV>\PubTypes\Custom\<strModuleID>" "<CaptureSV>\PubTypes\Custom\<Batch Class Name>\<strModuleID>"
Note To ensure that your custom module data folder is unique, it is recommended that the value you pass to strModuleID be the custom module ModuleID (<company>.<application>.<module>) you use when you register the custom module.
Switching to a New Primary Central Site

The KCN Server Site Switch command utility, KcnsSiteSwitch.exe, is a stand-alone command line utility that specifies a new primary central site in a Kofax Capture Disaster Recovery configuration. By specifying a URL, you are broadcasting to any remote site that currently uses that central site as a primary to no longer use it and use the site from which you are running the KcnsSiteSwitch utility as its new primary central site.
98
Disaster Recovery
The central site switch takes place automatically once a remote site synchronizes. If the remote sites existing primary central site URL matches a URL in the site switch list, it makes the switch to the new primary central site. You can find this utility in the Kofax Capture bin folder.
Command Line Parameters

The utility supports several command line parameters. You can specify the URL of the old primary central site, and, when required, a user name and password. You can also remove a URL from the site switch list, view all currently specified central site URLs in the site switch list, and display the correct usage. If you specify an invalid or incomplete parameter, the utility defaults to the behavior of the View (v) parameter. You can specify only one command line parameter at a time and parameters can be specified with a forward slash (/) or a hyphen (-). /url [URL] When you want to specify a primary central site to switch from, you must specify its URL. The url parameter is followed by a valid URL, as in the following example:
KcnsSiteSwitch /url http://mywebserver/kcn
Note For WebSphere, the specified URL must be an exact match of the primary central sites web server URL because it is case-sensitive. This restriction does not apply to IIS. /url [URL] [user] [password] If you run the utility on a central site where User Profiles is enabled, an administrator login is required. The following example specifies a valid user, robert, and his password, MyC8q29x.
KcnsSiteSwitch /url http://mywebserver/kcn robert MyC8q29x
/v The View (v) parameter displays all entries in the site switch list, which is a list of URLs that have been specified at the central site where the utility is run. /r [URL] The Remove (r) parameter removes a specified URL from the site switch list. Once all affected remote sites have completed switching primary central sites, you may want
99
Chapter 6
to remove any URL entries that are no longer relevant by removing them from the list. The following example removes http://phoenix/kcn from the site switch list:
KcnsSiteSwitch /r http://phoenix/kcn
/r [URL] [user] [password] This parameter removes a specified URL from the site switch list when an administrator login is required. For more information, see the /r parameter. The following example removes http://phoenix/kcn from the site switch list using a valid user, john_baker, and his password, Z73Nt2x:
KcnsSiteSwitch /r http://phoenix/kcn john_baker Z73Nt2x
/? The ? parameter displays the correct usage of the KcnsSiteSwitch utility to the console. The following command displays information about correct usage:
KcnsSiteSwitch /?
Error Codes
The KCN Server Site Switch command utility returns the following codes:
Table 6-9. Error Codes Value 0 1 2 3 4 5 6 Name Normal BadUsage LoginRequired LoginFailed SiteNotFound LicenseError UnknownError Description The utility ran successfully and without exception. Invalid parameters were entered. User Profiles is enabled, but a login was not provided. Credentials were supplied but could not be validated. A site targeted for removal was not on the site list. An enterprise license is required but not found. An unhandled exception was encountered. Please check the error log.
100
Disaster Recovery
Deleting a Central Site

The KCN Remove Central Site command utility, KcnsRemoveCentralSite.exe, is a stand-alone command line utility that deletes a central site (URL) from the KCN Server central site list. Once deleted, the central site will no longer be available to remote sites. The utility duplicates the functionality of deleting a central site from the KCN Server Central Site Manager in the Kofax Capture Administration module. KCN Remove Central Site is controlled completely via command line parameters. You can specify parameters with a forward slash (/) or a hyphen (-). You can find this utility in the Kofax Capture bin folder.

The utility supports several command line parameters. You can specify the URL of the central site to be deleted, and, when required, a user name and password. If you specify any invalid or incomplete parameters, you will be prompted with the correct usage. You can specify only one command line parameter at a time. /r [URL] When you want to delete a central site, you must specify its URL. The r parameter is followed by a valid URL, as in the following example:
KcnsRemoveCentralSite /r http://mywebserver/kcns
Note For WebSphere, the specified URL must be an exact match of the central sites web server URL because it is case-sensitive. This restriction does not apply to IIS. /r [URL] [user] [password] An administrator login is required if the utility is run on a central site where User Profiles is enabled. If the current user is already logged in as an administrator their credentials will be used automatically. Otherwise a User Profiles username and password must be supplied. The following example switches one primary central site to another using a valid user, robert_s, and his password, MyC8q29x.
KcnsRemoveCentralSite /url http://mywebserver/kcns robert_s MyC8q29x
/v The v parameter allows you to view the <URL> for each of the central sites that are currently available. Central sites that are shown here can be deleted.
101
Chapter 6
/? The ? parameter displays the correct usage of the KcnsRemoveCentralSite utility to the console. The following command displays information about correct usage:
KcnsRemoveCentralSite /?
The correct usage also displays when you enter any invalid parameter.
Error Codes
The KCN Remove Central Site command utility returns the following codes:
Table 6-10. Error Codes Value 0 1 2 3 4 5 Name Normal BadUsage LoginRequired LoginFailed SiteNotFound UnknownError Description The utility ran successfully and without exception. Invalid parameters were entered. User Profiles is enabled, but a login was not provided. Credentials were supplied but could not be validated. An alternate site targeted for removal was not on the site list. An unhandled exception was encountered. Please check the error log.
Exporting and Importing Administrative Data

You can export and import administrative data such as batch classes, KCNS profiles, and user profiles. This allows you to save periodic snapshots of administrative data. You can use administrative data export and import in the following cases: To duplicate administrative settings when restoring or switching primary sites To transfer administrative settings from a development site to a production site Administrative data includes: Batch Classes KCNS Profiles (includes the Central Site List, Central Site Profile, Remote Site List, and Remote Site Profiles)
102
Disaster Recovery
User Profiles The following sections describe the specific administrative data that is exported and imported.
Batch Classes
This feature allows you to export and import batch class assignments and override settings for user profiles and KCNS profiles (central and remote). When you export a batch class, it also exports which user profiles and KCNS profiles it is assigned to as well as the class-specific overridden batch routing settings for KCNS profiles. Exported and Imported Data The following data is exported and imported with batch classes:
Table 6-11. Exported and Imported Data Option Export Import Description All batch class assignments and override settings with the associated batch class are exported. Optionally imports all batch class assignments and override settings for batch classes that are selected for import. The import process matches batch class assignments and override settings to profiles by name. If a profile is not found, the settings for that profile are not imported.
Transfer Mode Select one of the following options to specify how duplicate batch classes are handled if the import process encounters a duplicate batch class name:
Table 6-12. Transfer Mode Options Option Do not import duplicates Description Does not import the duplicate batch class and its associated assignments and override settings.
103
Chapter 6
Table 6-12. Transfer Mode Options (continued) Option Save duplicates to a new name Description Renames the imported duplicate batch class by appending an integer to the name. This is the default. Batch class assignments and overrides apply to the renamed batch class. For example, if both central sites A and B contain a user profile named John, and the Order Forms batch class is exported from A and imported to B, the renamed batch class becomes OrderForms1 and is assigned to the user John. Replaces the existing duplicate batch class. The batch class assignments and override settings are updated in the profiles for the batch class.
Replace duplicates with items imported
Importing Batch Class Assignments and Override Settings To import batch class assignments and override settings for the selected batch classes, select the Import batch class assignments and override settings check box on the Batch Classes tab. Importing is Additive Only When importing batch class assignments, they are only added to the existing assignments. Under no circumstances are assignments ever removed. More Information For more information, see the Importing and Exporting Batch Classes - An Overview topic in the Help.
KCNS Profiles
This feature allows you to export and import KCNS profiles.
104
Disaster Recovery
Exported and Imported Data The following table lists the data that can be both exported and then imported.
Table 6-13. Exported and Imported Data Option KCNS Central Site List KCNS Central Site Profiles Description Exported and imported data includes the list of central sites. For more information, see the KCN Server Central Site Manager Dialog Box topic in the Help. Exported and imported data includes the data in the Batch Routing tab in the KCN Server Central Site Profile dialog box. Note that the information in the Batch Class Override tab is not imported. To import this data, use the Import batch class assignments and override settings for the selected batch classes option on the Batch Classes tab on the Import dialog box. For more information about KCNS Central Site Profiles, see the KCN Server Central Site Profile Dialog Box topic in the Help. Exported and imported data includes the list of remote sites. For more information, see the KCN Server Remote Site Manager Dialog Box topic in the Help. Exported and imported data includes most of the information contained in the KCN Server Remote Site Profile dialog box, which includes the following tabs: Batch Routing. Assigned Batch Classes (exported and imported data includes only the All batch classes and Selected batch classes settings. It does not include the list of assigned batches classes and routing settings. Station Licensing. Volume Licensing. Polling. Business Continuity. For more information, see the KCN Server Remote Site Profile Dialog Box topic in the Help.
KCNS Remote Site List KCNS Remote Site Profiles
105
Chapter 6
Transfer Mode Select one of the following options to specify how duplicate KCNS profiles are handled if one is encountered by the import process:
Table 6-14. Transfer Mode Options Option Skip duplicate KCNS profiles Description If the import process encounters a duplicate KCNS profile on the target system, it does not import the KCNS profile. The existing profile is updated with the settings of the imported profile with the exception of data items described in the Exported and Imported Data table above.
Replace existing KCNS profiles
Batches Routed to a Remote Site Are Not Ready to Download Without a KCN Service If the batch routing rules in a batch require routing to a remote site, there must be an installed and enabled KCN service at the site where the batch is imported. Without a KCN service, this type of batch would not be Ready to download. Note that a batch cannot be recalled unless it is ready to download.
User Profiles
This feature allows you to export and import Kofax Capture user profiles. Exported and Imported Data The following data is exported and imported in user profiles:
Table 6-15. Exported and Imported Data in User Profiles Option Export Description All users and groups, including linked, are exported.
106
Disaster Recovery
Table 6-15. Exported and Imported Data in User Profiles (continued) Option Import Description Only new users and new groups, including linked, are imported. Existing users and groups are never updated. The following information is imported for new users and groups: Users: General tab, Assigned Modules tab, and Group Members tab Group: General tab, Assigned Modules tab, and Members tab
Not Exported or Imported The following data is not exported or imported with User Profiles: Enable User Profiles check box. This data was excluded so as not to interrupt the current processes of existing users. Default user group for new batch classes setting. Assigned batch classes. To import this data, use the Import batch class assignments and override settings for the selected batch classes option on the Batch Classes tab on the Import dialog box. All existing users and groups are not imported. For more information, see the User Profiles Dialog Box topic in the Help.
Administrative Data Export and Import Use Case Recommendations

This section provides recommendations and procedures for the following use cases: Disaster Recovery Development to Production Site Data Transfer Disaster Recovery In the case of a disaster, if you have made recent backups of all administrative data, you can easily import all batch classes, KCNS profiles and user profiles to the restored system. Development to Production Site Data Transfer In the case of a development, test, and production system, you can develop batch classes, KCNS profiles, and user profiles on a development system and then
107
Chapter 6
incrementally transfer those settings to the production system. If you choose, you can import only the modifications from the last update. Note To successfully export and import administrative data from a development site to a production site, the two sites should contain the same site configuration and site names. Also, before importing data, first synchronize all remote sites with the central site.
Exporting Administrative Data

Use the following recommendations to export administrative data to prepare for a disaster recovery scenario or to transfer administrative data from a development system to a production system. To export administrative data to prepare for disaster recovery In the Export dialog box: On the Batch Classes tab, add all batch classes to Selected Batch Classes for export. On the KCNS Profiles tab, select the Export KCNS profiles check box to export all KCNS profiles. On the User Profiles tab, select the Export user profiles check box to export user profiles (All users and groups, including linked, are exported). To export administrative data from a development system Depending upon your goals, you may want to export certain types of administrative data, as explained below. To export specific batch classes that have been updated for production, in the Export dialog box, on the Batch Classes tab, add selected batch classes to Selected Batch Classes for export. To export KCNS profiles that have been updated for production, in the Export dialog box, on the KCNS Profiles tab, choose whether to select or clear the Export KCNS profiles check box. (Selecting this option always exports all KCNS profiles). To import only the permissions when you import updated batch classes, in the Export dialog box, on the User Profiles tab, add selected batch classes to Selected Batch Classes for export.
108
Disaster Recovery
Importing Administrative Data

Recommendations Importing all data at the same time is recommended because it automatically imports data in the correct order. If you import batch classes, KCNS profiles, and user profiles separately, be sure to import batch classes last. This ensures that batch class assignments are available for the already imported KCNS profiles and user profiles. If you already imported administrative data in an order other than the recommended order, you can still add batch class rights and assignments. For more information, see Assigning Batch Classes to Users in the Getting Started Guide. To make an exact copy of administrative data from another site, before importing, be sure to delete user profiles on the production (target) system with identical names as user profiles on the development (source) system. When you export administrative data from one system and import it to another, you can substitute new values for the configuration settings. For more information, see Data and Path Substitution in this chapter. To configure any settings that are not imported (user profile checkbox and default group), see Enabling the User Profiles Feature in the Getting Started Guide. To import batch classes 1 2 3 4 5 6 Export batch classes using the recommendations in Exporting Administrative Data on page 108. Open the Administration module. Select File | Import. Select the file that contains the exported batch classes obtained in Step 1 and click Open. When the unpacking process completes, click OK. In the Import dialog box, on the Batch Classes tab: a Add all batch classes to Selected Batch Classes for import. b Select the Replace duplicates with items imported option. c Select the Import batch class assignments and override settings for the selected batch classes check box. 7 Click Import.
109
Chapter 6
To import KCNS profiles 1 2 3 4 5 6 Export KCNS profiles using the recommendations in Exporting Administrative Data on page 108. Open the Administration module. Select File | Import. Select the file that contains the exported KCNS profiles obtained in Step 1 and click Open. When the unpacking process completes, click OK. In the Import dialog box, on the KCNS Profiles tab: a Select the Export KCNS profiles check box to import all KCNS profiles. b Select the Replace existing KCNS profiles option. 7 Click Import.
To import an exact replica of the exported user profiles 1 2 3 4 5 6 7 Export user profiles using the recommendations in Exporting Administrative Data on page 108. Delete all user profiles on the target system. Open the Administration module. Select File | Import. Select the file that contains the exported user profiles obtained in Step 1 and click Open. When the unpacking process completes, click OK. In the Import dialog box, on the User Profiles tab, select the Import user profiles check box to import user profiles (All users and groups, including linked, are imported). Note If you do not manually delete all user profiles and import new ones from the source system, you can manually update them on the target system. However, if you later import batch classes, they may get assigned to users you did not intend to modify. To import only exported user profiles 1 Export user profiles using the recommendations in Exporting Administrative Data on page 108.
110
Disaster Recovery
Delete only the user profiles on the target system that have identical names as user profiles on the source system. (If you do not delete them, the import process automatically skips them.) Follow steps 3 through 7 in the previous procedure.
Reinstalling an Alternate Central Site

If you reinstall an alternate central site (using the same name but with a new GUID), in order to make it operational with the current profile settings on the primary central site you can perform the following steps: 1 2 3 4 Export the current KCNS profiles from the primary central site. Remove the previous alternate central site from the KCNS Server Central Site Manager. Add the reinstalled alternate central site to the KCNS Server Central Site Manager. Import the exported KCNS profiles to the alternate central site with the Replace existing KCNS profiles option selected.
Releasing at Remote Sites

You can release batches at remote sites. Release script installation and registration for non-Kofax scripts must be performed at the central and remote sites using the release script registration utility. However, release script setup must be performed at the central site. Note that if a release script has not been registered and the remote site has been designated for remote release, an error is not returned at the remote site during batch class synchronization.
If Release Fails at a Remote Site

If release fails at a remote site, you have several options: Check to see that the release paths exist on the remote site (you set these at a central site and they should be the same at the remote site) and database connections are correct (depending on the script this may mean that the remote site must reside on the same domain as the central site). If these issues caused the release to fail, once fixed, you can re-release the batch. Use a workflow agent to route the batch to another remote site.
111
Chapter 6
Recall the batch and release it at the central site.
Notes
Document IDs are unique per site, so if multiple sites (primary central, alternate central, or remote) release to the same database or merge their data, there may be colliding document IDs. When releasing to a common back end document management system, use Document GUIDs when possible. When a remote site releases a batch, if the central site recalls the batch before the remote site synchronizes, then the central site can also release the batch. If both sites release to the same back end document management system or merge data, there may be duplicate batches.
112
Chapter 7
Setting Up Source Devices
Introduction
The Scanner Configuration Utility is a tool used to configure your source devices. When you install Kofax Capture, several scan sources are already available for use. If the appropriate scanning drivers you want to use are installed, there is no further source device configuration necessary. However, you may need to use the Scanner Configuration Utility to create an additional scan source if one of the following situations is applicable to your installation: You want to use an import source not provided with Kofax Capture. You are using Kofax Capture with a compatible scanner, which is a scanner that has not gone through the VRS certification process. You are using a Kofax Adrenaline SCSI scanner controller (without VRS) with a compatible scanner, and you want to create a source other than the default source. You can also use the Scanner Configuration Utility to set your default scanner, restore scanner default settings, and more. For detailed information about all the Scanner Configuration Utility options and features, refer to the online Help by clicking Help or pressing F1 from within the utility interface.
113
Chapter 7
Configuring a Source Device

To configure a source device 1 2 Open the Scanner Configuration Utility by selecting Start | Programs | Kofax Capture 8.0 | Scanner Configuration Utility. In the Scanner Configuration Utility dialog box (Figure 7-1), select your source device from the list of available image devices. Scanners will appear on the list if they are VRS certified scanners, or if their drivers are installed on the computer.
Figure 7-1. Scanner Configuration Utility
Click Configure Sources. The Configure Sources dialog box will display.
114
Setting Up Source Devices
Figure 7-2. Configure Sources Dialog Box
4 5
If there are no configured sources for this device, click Create Standard Sources. To set the default source for your device, select the appropriate configured source from the list and click Set Device Default Source. A check mark appears next to the default source. Click Close to close the Configure Sources dialog box. To set a configured scanner as the default, select it from the available image device list and click Set as Default. In the Scanner Configuration Utility dialog box, your current default scanner and source are listed at the bottom of the window. Click Close to close the utility.
6 7 8
115
Chapter 7
Sharing Scanner Profiles

You can save profiles to a shared location on the network and make them available to other users. To share scanner profiles, select Scan | Scanner Profiles | Save Profiles as Shared. Note If User Profiles is enabled, make sure that you have selected the Allow admin utility usage setting. Only users with rights to access Administrative Utilities can save local profiles as shared or revert to shared profiles.
Scanner Profile Locations

The profile storage location is a hierarchical set of folders organized by scan source. Scanner profiles, including VRS profiles, are stored in a folder specific to the scan source and can either be local or shared. Local profiles are stored in the ScannerProfiles folder beneath the Kofax Capture <LocalPath> folder. Shared profiles are stored in the SharedScannerProfiles folder beneath the Kofax Capture <ServerPath> folder. Note On a standalone installation, shared profiles are not enabled and the shared profiles folder does not exist.
116
Chapter 8
Kofax Capture Network Server Operating Requirements
Introduction
Kofax Capture Network Server (KCN Server) is installed in a distributed way, meaning the software is usually installed in more than one place. The central site portion of it is installed on a supported Web server at your central site. At your remote locations, you must also install Kofax Capture and convert those installations to remote sites. There are specific operating requirements and preparations that you should consider when planning your KCN Server installation. This chapter includes the following: Components that must be installed or enabled on the central site, and those that must be installed or running at the remote locations Operating requirements, including the supported hardware and system software, and configurations
KCN Server Components

This section contains information about the various KCN Server components at the central and remote sites.
Central Site
The following components must be available at the central site. Windows 2000 Operating System with Service Pack 4 or Windows Server 2003, must be installed on both the Web server and the Kofax Capture server. Kofax Capture, must be installed in either a client/server configuration or a standalone configuration. See Chapters 2-4 for more information on operating requirements, planning decisions, and installation steps.
117
Chapter 8
File cache folder locations must be available to the Web Server and the KCN Service. See File Cache Folder Locations on page 128 for additional information. KCN Server software, must be installed on a supported Web Server at your central site. The Web Server's Anonymous User account must have access to the KCN Server file cache folder locations and the anonymous user account. Licenses for using KCN Server, must be enabled. See KCN Server License Requirements on page 121 for more information on required licenses for KCN Server. See the online Help for more information on licensing. Web site, must be available for routing requests and data between the KCN Server remote sites and the central site. The Web site must already exist when you begin installing the KCN Server components. KCN Service, must be enabled, and must have network access to the file cache folder locations, and must be on a computer running Kofax Capture.
Remote Sites
The following components must be available at remote sites. Kofax Capture, must be installed or upgraded to the current version at your remote sites. You do not have to upgrade all remote sites at the same time. See Installing Kofax Capture on page 37 for the installation steps. Remote Synchronization Agent (RSA), must be running. In each remote client/server configuration, the RSA must be running on at least one workstation to upload batches automatically. The RSA can also be installed as a service (refer to the Kofax Capture Getting Started Guide for more information).
Web Server Operating Requirements

The following lists the Web server hardware and system operating requirements needed to use KCN Server.
118

The following lists the minimum Web server hardware requirements:
Processor: System memory: Disk space: Display: NIC: Pentium 4 processor, or equivalent 1 Gbyte of memory 200 Mbytes of available disk space for the file cache folder location 1024 x 768 display with 16-bit color 100 Mbps

The following lists the recommended Web server hardware requirements:
Processor: System memory: Disk space: Pentium 4 processor, or equivalent 512 Mbytes of memory or more Depending on your processing volume, allocate as much disk space as possible. You should allocate enough disk space to hold the maximum number of batches that might be uploaded at the same time. 1024 x 768 display with 24-bit color 100 Mbps or higher
Display: NIC:
System Requirements
The following lists the system requirements for installing and using the Web server: Windows 2000 Server with Service Pack 4 or Windows Server 2003 with Service Pack 1 Microsoft Internet Information Services (IIS) or WebSphere 6.0 TCP/IP protocol (defaults to port 80, but is user configurable) SSL is optional (defaults to port 443, but is user configurable) Network access to the file cache folder locations from the Web server (During installation) Network access to the Kofax Capture server files folder
119
Chapter 8
KCN Service Operating Requirements

The following lists the KCN Service operating requirements.
System Requirements
Kofax Capture 8.0 client workstation or standalone TCP/IP Protocol through port 2424 (KCN Service to Web Server) Network access to the file cache folder locations
Remote Site Station Requirements

This section contains information about remote site station hardware and software requirements.

The remote components of KCN Server are installed when Kofax Capture is installed on a remote client or standalone workstation.
Processor: System memory: Disk space: Pentium 4 processor, or equivalent 256 Mbytes or more 760 Mbytes or more for installation and working space during processing, with approximately 150 Mbytes of this on the local hard drive. You may need even more disk space if you have many image files or a large database (on a standalone workstation). 1024 x 768 with 24 bit color, small fonts 100 Mbps
Display: NIC:
System Requirements
The following are the system requirements for installing KCN Server. One of the following operating systems: Windows 2000 Server with Service Pack 4 Windows Server 2003 with Service Pack 1 TCP/IP protocol Internet or intranet access to your Web server
120
KCN Server License Requirements

The KCN Server remote site workstations do not require hardware keys. However, KCN Server requires the appropriate licenses. See the online Help for more information on licensing.
121
Chapter 8
122
Chapter 9
Planning Your Kofax Capture Network Server Installation
Introduction
There are various ways that you can configure your Kofax Capture Network Server (KCN Server) installation. The following information can help you make informed decisions that will ensure that your installation is set up to meet the needs of your company. This chapter begins with general installation notes regarding your KCN Server environment, and continues with a discussion of some decisions that need to be made before proceeding with the installation.
Setting Up Your Environment

For Kofax Capture and KCN Server to be successfully installed, the installation environment needs to be set up correctly. Carefully review the following information.
Privileges and Permissions

Before the actual installation is performed, ensure that the logged in user has full administrative privileges. 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.
UNC Support
At your central site, if you install Kofax Capture and your Web server software on different computers, you must specify the path to the Kofax Capture server files and
123
Chapter 9
the path to the file cache folder locations in UNC format. For example: \\ServerName\Capture Share If you install Kofax Capture and your Web server software on the same computer, the KCN Server setup application will determine the path automatically.
Proxy Server Support

KCN Server can run in a proxy server environment. KCN Server remote sites can communicate with the Internet through a proxy server. The KCN Web Server can communicate with the Internet through a proxy server. To use a proxy server with KCN Server remote sites, you must enable and configure the proxy server address and port number in the browser for every computer that uses a proxy server. To configure your proxy server settings in Microsoft Internet Explorer, open Internet Explorer, and then select Tools | Internet Options | Connections | LAN Settings. Note KCN Server has been tested, and is certified to work with, Microsofts ISA Server 2000. Other proxy servers may work, but have not been tested or certified by Kofax.
Web Server Port Numbers

KCN Server 8.0 allows remote sites to communicate with the Web server on ports other than port 80 for HTTP and 443 for SSL. Although you can specify any port number from 0 to 65535, you should keep in mind possible conflicts with other processes that may be using communications ports. If you want to use alternate ports, be sure to first consult with your administrator. In general, these port numbers are divided into three ranges: Well Known Ports ranging from 0 through 1023 Registered Ports ranging from 1024 through 49151 Dynamic and/or Private Ports ranging from 49152 through 65535 For the most part, ports in the first two ranges are used, either by convention or registration, for specific purposes. The dynamic and private ports are open for general use. When selecting an alternate port, your primary concerns should be ensuring that the port is free, and that your firewall (if any) will allow its use.
124
Custom Module and Workflow Agent Support Considerations

KCN Server supports Kofax Capture custom modules and workflow agents. A workflow agent is a custom program that allows custom routing of batches. If you plan to use a custom module or workflow agent at your remote sites, you must register the custom module or workflow agent at your central site and at each remote site (that requires it), after you install KCN Server. Note Activating KCN Server on a remote site will disable the Kofax Capture Administration module on that site. Therefore, to register custom modules or workflow agents at remote sites, you must use the command line method. For instructions on registering custom modules or workflow agents for KCN Server remote sites, see the Kofax Capture Getting Started Guide. For more information on workflow agents and custom modules, see the online Help. Warning Ensure that workflow agents do not display a user interface while batches are being processed through any unattended modules and the KCN Service. Displays from a workflow agent will stop the KCN Service from inserting batches into the Kofax Capture workflow. In that case, you will have to manually restart the KCN Service.
Planning Your Installation

There are various ways that you can configure your installation. The following information can help you make informed decisions. Before installing KCN Server, ensure that you have a working knowledge of: Your network configuration Kofax Capture The Internet Your Web server software
Before installing KCN Server, ensure that you have first read Planning Your Kofax Capture Installation on page 25. Then, plan your installation in light of the decisions you made for Kofax Capture, and the decisions you make in the following sections. Planning decisions that should be made prior to installing KCN Server are: KCN Service locations KCN Service (Log on as) user account
125
Chapter 9
KCN Server Software Component Configurations File cache folder locations Web server software location and the Web site KCN Server Anonymous User Account Remote site name Alternate Web server port number, if necessary High Availability requirements (if any)
Note The Deployment Utility may not be used to deploy KCN Server installations.
Decisions Before Installing KCN Server

There are certain decisions that you need to make before installing KCN Server. General Considerations The following elements should be considered as a means of getting the best performance from your KCN Server installation. For each Web server at the central site, there should be at least one KCN Service (on a client workstation, not the Web server). Overall, there should be at least one KCN Service per 50 remote sites. There should be one KCN Server file cache on each computer hosting a KCN Service. KCN Service computers should not have any other software (Kofax Capture modules or other) running on them. Even multiprocessor computers may not be satisfactory to run the KCN Service along with other software. The KCN Service can be very I/O intensive. However, if the other applications are CPU intensive instead of I/O intensive, this may be acceptable. KCN Service Locations The KCN Service is responsible for responding to requests from the remote sites. Specifically, the KCN Service performs the following operations: Inserting batches into Kofax Capture on the Kofax Capture server asynchronously one batch at a time Extracting batch class and other remote site profile information Verifying licenses
126
The KCN Service must reside at the Kofax Capture central site on a standalone installation, a server with a client workstation installed, or a separate client workstation. Note We recommend that you run one KCN Service for every 50 remote sites. You can run only one KCN Service per central site workstation. Therefore, if you anticipate having more than 50 remote sites uploading batches, you should install Kofax Capture and enable the KCN Service on more than one workstation at your central site. Note To verify that the KCN Service is running, from the Control Panel select Administrative Tools | Services. The Service will display in the Name column. In the Description column next to Service, KCN Service will display.
KCN Service (Log on as) User Account Select a user account that has access permissions on the Kofax Capture server and at the file cache folder locations. You can select the local system account or specify another user account. You must have Full Control permissions to the Kofax Capture and KCN Server file cache folder locations. KCN Server Software Component Configurations The KCN Server software components can be configured to reside on one or more computers. The following are examples of minimal, recommended, and highly scalable configurations. The configuration that you use will depend on various factors, such as your available hardware and your security policy. Minimal configuration, consisting of one computer for Kofax Capture, the KCN Server file cache folder location, the Kofax Capture license server, the KCN Service, and the KCN Web server components. Recommended configuration, consisting of: One computer for Kofax Capture, the KCN Server file cache folder location, and the Kofax Capture license server One Kofax Capture workstation for the KCN Service One computer for the single instance of the KCN Web server components Highly scalable configuration, consisting of: One computer for Kofax Capture and the Kofax Capture license server
127
Chapter 9
One computer for the KCN Web server components At least two Kofax Capture workstations for the KCN Services At least two computers for the KCN Server file cache folder locations KCN Server remote sites can run in an environment consisting of client/server installations, standalone installations, or a mix of both installations. File Cache Folder Locations The file cache folder locations, which are accessed by both the KCN Service and the Web server, are used to hold batches uploaded from remote sites until the data can be inserted into Kofax Capture at the central site. The file cache folder resides, by default, on the Kofax Capture server. The folders can be deployed anywhere on your network as long as there is network access (using UNC paths) between the following: Web server and the file cache folder locations KCN Service and the file cache folder locations Multiple file cache folders can be created on one or more computers. You might want to create multiple file cache folders so that if one file cache folder location fails, the remote sites can continue to synchronize using the remaining file cache folder locations. If you have cache folders in multiple locations, a KCN Service will prefer to use its local cache directory (if there is one) rather than the other caches, provided other factors (such as batch priority) are equal. This cache affinity reduces network overhead and may increase performance. See Configuring Additional File Cache Folder Locations on page 146 for additional information on multiple cache locations. Note The cache folders must be accessible to the Web Server's Anonymous User account, but you may wish to limit or prohibit direct access by users through the NTFS security settings.
Web Server Software Location and the Web Site The Web site is used to route requests and data between the KCN Server remote sites and the central site. The Web site must be accessible to the remote site. The Web server requires network access to the file cache folder locations.
128
Note If you want to use a Web site that does not currently exist on your KCN Web Server, create the Web site before starting the installation of KCN Server. If you are using IIS, it creates a default Web site, which you can use for your KCN Server installation. Note During installation of KCN Web Server components on a domain controller that is also running the IIS Web Server, an error is logged to the event log when the aspnet_wp.exe attempts to run. This is a known Microsoft issue. For more information on how to resolve this issue, point your browser to the support section of www.kofax.com and search the knowledge base for QAID (KB Article ID) number 587.
KCN Server Anonymous User Account The KCN Server anonymous user account is used by KCN Server remote sites through the KCN Web Server to automatically upload batches and statistics and download batch classes from the Kofax Capture central site without requiring a logon. The KCN Server anonymous user account must have the permissions listed in the to do list. If the permissions are not set correctly, you will not be able to upload batches. The to do list can be found at: <KCN Server installation folder>\Logs\ACICfgWzToDo.log after the installation completes. The permissions include: Full Control permission to the file cache folder location (including share permissions, if applicable) Read and Execute permission to the KCN Server installation folders Full Control permission to the log file path folders The selected account must also have Log on locally rights to the Web server.
129
Chapter 9
In addition to the above rights, the permissions listed in the following table apply to the KCN Server anonymous user account:
Table 9-1. Anonymous User Account Requirements Location of Web Server Software Anonymous User Account Permissions and Access Required On a domain controller (not recommended because of Microsoft issues) On a member server (rather than on a domain controller) Not installed within a domain The account must be a domain account in this domain.
Account must be a domain-wide account. Account must exist on both the Web server and the server where the file cache folder locations reside at the central site. The account must have the same password on both servers.
Note If you plan to use SSL, and require a secure channel to the Web site for KCN Server, you must set up the secure communications before installing the KCN Web Server components (see the Microsoft online Help for help with setting up secure communications). If you require a secure channel after installing the KCN Web Server components, you may be presented with a prompt to set a new password on the KCN Server virtual directories. Do not set a new password. If you do, your remote sites will be unable to synchronize with the central site. If you do accidentally set a new password, rerun the configuration wizard to reconfigure the anonymous user account. Your remote sites will be able to synchronize with the central site.
Remote Site Name The remote site name defaults to the computer name. Since the remote site name is used to identify the remote site in the central site Administration module, you should choose a name that is meaningful to you. With KCN Server, you can create remote site profiles to assign to the remote sites. The profiles specify settings, such as which modules and batch classes will be accessible to a remote site. If you create the profiles before creating the sites, be sure to name the sites the same as their profiles. This will facilitate automatic assignment of the profiles
130
to the sites, depending on whether the following rule was specified for the new remote site behavior: Assign to site profile matching site name if it exists, otherwise assign (Default) The new remote site behavior is specified in the Remote Site Manager dialog box available from the Administration module The site name can be from 1 to 32 characters, and may not include the following characters:
' & , * $ . ( ` / ) = ~ _ \ ! + { @ | } # : ; ^ < > ? %
If you change the site name, the change will not be reflected in the Remote Synchronization Agent (RSA) Status display until the RSA is stopped and restarted at the remote site. Web Server Port Number By default, all HTTP communications use port 80, and all SSL communications use port 443. If you do not want to use the default KCN Web Server ports, you can assign alternate ports either before or after installation. See the section Setting Your IIS Port Configuration on page 165 for more information. You can change the port number at any time, however if possible you should make this decision prior to installation of your remote sites. This will allow you to set the new port number in the initialization file for use during a Kofax Capture automatic installation. Note When selecting alternate ports, you must ensure that the ports you assign are not being used by other applications or services. If there are port conflicts, you may experience intermittent and unpredictable problems. Furthermore, if you later change the port number, you will loose contact with all remote sites and they will all have to update the Web Server URL before they can upload.
131
Chapter 9
High Availability Installations You can elect to take advantage of one or more of Kofax Captures 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 Captures high availability support in conjunction with KCN Server.
132
Chapter 10
Installing Kofax Capture Network Server
Introduction
This chapter provides step-by-step instructions for installing Kofax Capture Network Server (KCN Server). The instructions do not describe every installation screen you may see, nor do they cover every decision you may be asked to make. Instead, the focus is on major milestones, key decisions, and possible areas of confusion. It is important that you follow the installation steps exactly in the order given. If you are upgrading KCN Server, see Upgrading/Updating on page 154.
KCN Server Installation Steps

The following is an overview of the major steps for installing KCN Server. All of the steps must be performed in the order listed. Each of the major steps is detailed after the overview. Step 1 Step 2 Step 3 Step 4 Step 5 Check your environment at the central site. Enable the Kofax Capture Network Service (KCN Service) at the central site. Install the KCN Web server components at the central site. Install Kofax Capture at the remote sites. Convert Kofax Capture remote installations to remote sites.
133
Chapter 10
Step 1: Check Your Environment at the Central Site

Check the following to ensure that they have been configured correctly before proceeding with your KCN Server installation. Kofax Capture Check Points Check the following: Ensure that the central site meets the operating and license requirements for Kofax Capture. Refer to Chapter 2 Kofax Capture Operating Requirements on page 3 for information about operating requirements and licensing requirements. Refer to Chapter 3 Planning Your Kofax Capture Installation on page 25 for information about ensuring the installation is smooth and accurate. Refer to Chapter 4 Installing Kofax Capture on page 37 for information about installation instructions if Kofax Capture is not already installed at your central site. There are no special requirements for installing Kofax Capture when it will be operating with KCN Server. KCN Server Check Points Check the following: Ensure that the central site meets the operating and license requirements for KCN Server. Refer to Chapter 8 Kofax Capture Network Server Operating Requirements on page 117 for information about the KCN Server operating and licensing requirements. If your Web server software is not already installed at your central site, follow the manufacturers instructions that came with your Web server software. Note Internet Information Services (IIS) is installed on a Windows 2000 Server by default. However, with Windows Server 2003, you must explicitly install IIS; it is not installed by default. If you are upgrading to Windows 2000 Server or Windows Server 2003, and plan to use IIS as your Web server, be sure that IIS is installed after the upgrade. If you have not already done so, create or use an existing Web site. Verify that you can contact the Web site by typing in the address area of your browser: http://computername. For example: http://MySite. By default, all HTTP communications use port 80, and all SSL communications use port 443.
134
WebDAV is not required for file insertion to the KCN file cache. By default, WebDAV is disabled in IIS. If WebDAV is enabled, you can optionally disable it by running the IIS Lockdown Tool. Ascent Capture 6.x and Ascent Capture 7.x remote sites that connect to an 8.0 KCN Server will be unable to upload files to a central site if WebDAV has been disabled. Therefore, be sure to upgrade all remote sites to Kofax Capture 8.0 before removing WebDAV from the central site server. When selecting alternate ports, you must ensure that the ports you assign are not being used by other applications or services. If there are port conflicts, you may experience intermittent and unpredictable problems. Note If you are not using IIS as your Web server, refer to the manufacturers instructions for operational details. The following example is specific to IIS. To select an alternate port in IIS 1 2 3 Run the Internet Information Services administrative tool. Select the Web Site where KCN Web Server Components are installed. Right-click and select properties. The Default Web Site Properties dialog box displays.
Figure 10-1. Web Site Properties Dialog Box
135
Chapter 10
Change the TCP Port setting to the desired number, for example 8080. Note Changing the port configuration will also require changing the port specification at your remote sites. See Setting Your IIS Port Configuration on page 165 for more information.
Step 2: Enable the KCN Service at the Central Site

To enable the KCN Service at the central site, the logged in user must have administration rights. To enable the KCN Service 1 At the command line at the central site, enter: <Kofax Capture installation folder>\Bin\aciscfg.exe. The Enable Kofax Capture Network Service dialog box will display.
Figure 10-2. Enabling KCN Service Sample Initial Display
136
The notes in the Enable Kofax Capture Network Service dialog box specify that the KCN Server must have read/write permissions to the specified folder. If those permissions have not already been set up, you must configure the folder permissions before continuing with the installation. 2 In the Log on as area, do one of the following: Select Local System account, and then click OK. The local system account will be used. Only select this option, if both the Kofax Capture folder and the file cache folder locations are on the local computer. Select the User name option. Then, enter the user name, password and domain, and click OK. The user must have the specified permissions to both the Kofax Capture folder and the file cache folder locations. Note On a standalone computer or the Kofax Capture Server computer, the specified user must have access to all KCN Server resources and all resources required by the licensing service. Select the User name option. Then, browse to select the user name and click OK. The user name and domain boxes will automatically be populated after you make your selection. The user must have the specified permissions to both the Kofax Capture folder and the file cache folder locations. The KCN Service will be added to the Kofax Capture Service description as an enabled service. To verify that the service was added, from the Control Panel select Administrative Tools | Services. Then, view the Description column for Kofax Capture Service. If any problems were found while enabling the KCN Service, a dialog box will display listing errors or warnings. In the case of errors, click OK, correct the errors, and enable the KCN Service again. In the case of warnings, the KCN Service will successfully enable. Note We recommend that the KCN Service be installed on any workstation other than the Kofax Capture Server.
137
Chapter 10
Some examples of more common errors are listed in the following table.
Table 10-1. Sources of Errors or Warnings when Enabling the KCN Service Error/Warning Message KCN Service not found Possible Cause Possible Resolution
Logon user name, password, Retype logon user name, or domain was incorrectly password, and domain. entered
KCN Service(s) cannot Incorrect permissions for the Modify the permissions to be (Full connect to cache folder(s) folders, or the Control) for the file cache folders, folders do not exist or select a different user. File cache folder path was longer than 138 characters Evaluation or temporary license about to expire Evaluation or temporary license expired Licensing has expired No Kofax Capture Network Server Remote Site Station License Path to file cache folders contains too many characters Licensing issues may have the following possible sources: One or more licenses were not installed One or more licenses expired Modify the length to 138 characters or less. Licensing issues may have the following possible resolutions: Run the License Utility and verify you have sufficient licenses. Obtain the necessary KCN Server licenses. If this is an initial installation, ensure you have obtained an activation code and have activated the licenses using the code within three days of receiving your software. Verify that there is enough disk space, and free some disk space, if necessary.
Insufficient quantity of remaining disk space
Not enough disk space remains on the device
Step 3: To Install the KCN Web Server Components

The following instructions are for IIS only. If you are using WebSphere, see WebSphere on page 170, then continue with Step 4: Install KCN Server Remote Sites on page 142.
138
Installing KCN Web Server Components on IIS The KCN Web server components are installed to your Web server from the Install/ Upgrade KCN Web Server Components option on the Kofax Capture installation menu. Selecting the option initiates the KCN Web Server installation. This will configure typical Web server settings for KCN Server. For example, you will need to specify the anonymous user account and the locations for the KCN Server components. The installation configures anonymous access for each of the KCN Server virtual directories. Refer to KCN Server Anonymous User Account on page 129 for more information about anonymous user accounts. If necessary, the installation will also display a to do list of tasks that must be completed before you run KCN Server for the first time. For example, you must ensure that the anonymous user account has read/write permissions for certain folders. If the permissions are not set correctly, you will not be able to upload batches. The to do list can be found at: <KCN Server installation folder>\Logs\ACICfgWzToDo.log after the installation completes. Follow the installation procedure exactly, and read all instructions carefully. The procedure includes many important notes about settings you must change if your computer varies from the typical configuration. To install KCN Web server components on IIS 1 Insert the Kofax Capture installation CD 1 into the CD drive on your Web server. The CD supports AutoPlay, so the installation will automatically begin. (If it doesnt start, run Autoplay.exe from the CD.) From the main installation menu shown in Figure 10-3, select Install/ Upgrade KCN Web Server Components. Note This menu item is for use with IIS only. Do not select it if you are using another Web server application.
139
Chapter 10
Figure 10-3. KCN Server Main Installation Menu
Follow the instructions from the installation. When prompted, reboot your Web server. Then, the installation will continue. It will assist you in setting up the following: KCN Server Web site File cache folder location Note If you have planned to use more than one file cache folder location, you only specify one at this point. The instructions for adding more file cache folders are provided later in this chapter. Anonymous user account
140
Note The user name specified for the anonymous user account must have Log on locally permission for the Web server, or must be a member of a group that has this permission. This is a Microsoft security requirement for anonymous or basic authentication. To determine whether the anonymous user account has Log on locally permission, see Anonymous User Account on page 166. See also KCN Server Anonymous User Account on page 129 for more information on the Anonymous User Account. Note If you installed KCN Server and/or Kofax Capture on NTFS partitions, see NTFS Security Settings in Appendix B for additional information. 4 If generated, the to do list will display. Complete all the items in the to do list. An example of a to do list is provided below. The contents of the list will vary depending on your equipment and settings.
======= Kofax Capture Network Server Configuration Wizard: Tuesday, January 15, 2008 3:32:17 PM You may ignore entries referencing local FAT or FAT32 path statements. These are provided for your information only. For user: 'DJVM2K3\sqaadmin' do the following: Grant 'Read and Execute' permission to the KCN Server install folder: C:\Program Files\KCN Server\Bin\Web (NTFS) Grant 'Full Control' permission to the following file cache folder location (including share permissions, if applicable): \\DJVM2K3\ACIUpload (NTFS) Grant 'Full Control' permission to the log file path folder: C:\Documents and Settings\All Users\Application Data\Kofax\KCN Server\Logs (NTFS) Verifying that Kofax Capture Network Server can create files in its file cache folders. Current user account: DJVM2K3\sqaadmin Write test successful for all file caches.Proceed to Step 4: Install KCN Server Remote Sites.
141
Chapter 10
Step 4: Install KCN Server Remote Sites

To install KCN Server remote sites 1 2 At the remote workstation, shut down any applications (including the Control Panel, virus detection software, and toolbars) that might be running. Insert the Kofax Capture installation CD 1 into your CD drive. The CD supports AutoPlay, so the installation will automatically begin. (If it doesnt start, run Autoplay.exe from the CD.) From the main installation screen, select Install/Upgrade KCN Server Remote Site. The installation will start. Kofax Capture will be installed or upgraded on the remote site. Follow the instructions on your screen to install the software. The installation screens contain additional information that will guide you through the installation process. Be sure to read them carefully before proceeding with each step. See Chapter 4 Installing Kofax Capture for more information.
Step 5: Convert Kofax Capture Remote Installations to Remote Sites

Next, you need to convert the Kofax Capture installation to a remote site. To convert remote installations to remote sites 1 2 At the remote installation, open Batch Manager. From the menu bar, select Options | KCN Server | Convert to Remote Site. A message will display warning you that the Administration module will be disabled, and all batch classes created at the remote site will be deleted if you continue converting the installation. Select Yes to acknowledge the warning. The Web Server URL dialog box will display. Specify the Web server URL (for example, http://<Web server>), and click Next. The KCN Server remote site will validate the specified URL by attempting to contact the Web site. It will append the KCN Server folder name (for example, http://<Web server>/acis). If you are not using the default port number, specify the Web Server URL and the new port number using the following syntax: <http protocol>://<Web server>[:port]/acis. For example, if the alternate TCP port number is 8080, the URL would be similar to: http://www.Mysite.com:8080/acis.
3 4
142
See Setting Your IIS Port Configuration on page 165 for more information. Note If the Web site requires SSL, you must specify the URL with https, instead of http (for example, https://<Web server>). 5 If the Web server URL validation is successful, you are prompted to activate the RSA. The RSA allows you to upload batches and download batch classes without maintaining an ongoing connection to the Kofax Capture server. When you are prompted to confirm the activation, select either Yes to confirm the activation, or select No to defer activation. Selecting Yes causes a shortcut to the RSA to be installed as an icon in the Windows system tray. You must activate the RSA on at least one station at each remote site. If you select No, see Activating the RSA on page 152, when you are ready to activate the RSA. The remote station initiates polling through the RSA, so polling will not occur until the RSA is activated.
Figure 10-4. Remote Synchronization Agent (RSA) Icon
Warning Converting a Kofax Capture installation to a remote site will cause the latest versions of batch classes to be downloaded from the central site to the remote site. Any existing batch classes at the remote installation will be lost. If you want to keep these batch classes, export them to .cab files first. You can then send the .cab files to your central site, where they can be imported. The RSA can optionally be installed as a service, which allows it to upload batches and synchronize with the central site without having any user logged on. See the Installing Services appendix of the Kofax Capture Getting Started Guide for more information. 6 If desired, from the central site you can assign remote site profiles to the remote sites at this point. Remote site profiles allow you to easily assign various attributes to your remote sites. See Setting Up Remote Site Profiles on page 145 for more information.
143
Chapter 10
All remote sites are initially assigned a default remote site profile, depending on the central site settings. You can assign a different profile to a remote site at any time. See Assigning Remote Site Profiles to Remote Sites on page 145, and the Kofax Capture Getting Started Guide for more information. All remote sites are initially assigned a default remote site profile, depending on the central site settings. You can assign a different profile to a remote site at any time. See Assigning Remote Site Profiles to Remote Sites on page 145, and the Kofax Capture Getting Started Guide for more information.
Configuration Tasks
There are various configuration tasks that are performed at the central site, and other configuration tasks that are performed at the remote site. Some configuration tasks can be performed at any time. Other configuration tasks can be performed only after certain installation steps have been performed. Examples of central site configuration tasks are: Setting up your remote site profiles Converting user profiles into remote site profiles Assigning remote site profiles to remote sites Sharing scanner profiles Configuring additional file cache folder locations Enabling KCN Services Disabling KCN Services Stopping KCN Services Starting KCN Services
Examples of remote site configuration tasks are: Converting a remote installation to a remote site Specifying the Web server URL Activating the RSA Set polling intervals
Central Site Configuration Tasks

This section contains information about items you may want to configure at the central site.
144
Setting Up Remote Site Profiles You can perform this step at any time after enabling the KCN Service. You may want to set up remote site profiles to assign to remote sites. Remote site profiles allow you to specify: Which Kofax Capture modules can be run at the sites sharing the profile Which batch classes will be shared with the sites assigned the profile Which site (central or remote) is controlling the polling settings Polling settings, if centralized polling has been selected
To set up a remote site profile 1 From the Administration module at the central site, select Edit | Profiles | KCN Server Remote Site Profiles. The KCN Server Remote Site Profiles dialog box will display. Select an existing remote site profile. Select or type information on the tabs on the KCN Server Remote Site Profiles dialog box. See the Kofax Capture Getting Started Guide for a description of the KCN Server Remote Site Profiles dialog box. Select either Save to save the changes to the selected profile, or Save As to save the changes to a new profile. If you choose Save As, provide a name for the new profile that matches your expected remote site names. Note If you edit a profile that is assigned to several sites, all sites sharing the same profile will be affected by the changes.
2 3
Assigning Remote Site Profiles to Remote Sites You can perform this step at any time after installing KCN Server, and as often as necessary. By default, new remote sites are assigned either the profile that matches the site name or the remote site profile named (Default). You can assign a different remote site profile to each remote site. The same profile can be assigned to two or more remote sites. To assign profiles to remote sites 1 Open the Administration module at the central site.
145
Chapter 10
2 3 4
Select Tools | KCN Server | Remote Site Manager. The KCN Server Remote Site Manager dialog box will display. From the list of remote sites, select the remote site. From the list of remote site profiles, select the remote site profile that you want to assign to the selected remote site.
Sharing Scanner Profiles You can save profiles to a shared location on the network and make them available to other users. To share scanner profiles, select Scan | Scanner Profiles | Save Profiles as Shared. Note If User Profiles is enabled, make sure that you have selected the Allow admin utility usage setting. Only users with rights to access Administrative Utilities can save local profiles as shared or revert to shared profiles. Scanner Profile Locations The profile storage location is a hierarchical set of folders organized by scan source. Scanner profiles, including VRS profiles, are stored in a folder specific to the scan source and can either be local or shared. Local profiles are stored in the ScannerProfiles folder beneath the Kofax Capture <LocalPath> folder. Shared profiles are stored in the SharedScannerProfiles folder beneath the Kofax Capture <ServerPath> folder. Note On a standalone installation, shared profiles are not enabled and the shared profiles folder does not exist.
Configuring Additional File Cache Folder Locations You can perform this step at any time after installing KCN Server. For more information on why you might want to use more than one file cache folder location, see File Cache Folder Locations on page 128. If you have cache folders in multiple locations, a KCN Service will prefer to use its local cache directory. This cache affinity reduces network overhead and may increase performance.
146
However, there are a number of other settings that can override the KCN Services natural affinity for its local cache. The rules by which the KCN Service processes work queued at the central site are (in order): All caches are processed; however local caches are processed before remote caches. Interactive requests are processed first. That is, if you specifically upload a particular batch from Batch Manager, it will be processed before work that was uploaded through the RSA. Batches are processed in order of priority. Batches of a particular priority are processed from the local cache first and then from remote caches. Batches are processed on a first in, first out basis. Batches are processed in order of creation from the local cache first and then from remote caches. Batches are processed before statistics data. Statistics data are only inserted after all batches have been inserted. If you decide to use more than one file cache folder location, you will have to do the following: To create multiple cache folders 1 Create the shared file cache folder locations on the computers that will contain the file cache folders. Ensure that the folder locations are accessible to both the anonymous user account on the Web server and the Log on as user running your KCN Service. Shut down all Kofax Capture applications and services. Then, modify the KCN Server section in the <Kofax Capture installation folder>\Config\ACConfig.xml file to add a line containing the unique number that you are assigning to the new file cache folder location and the path to the folder location. An example of how to specify the file cache folder number and location is:
<Cache Number=1 Path=\\Mfg1\acis\/>
2 3
The first file cache folder is assigned the cache number 0 by default when you install KCN Server. Use a consecutive number starting with 1 when you specify the cache number. You cannot have two or more file cache folder locations having the same cache number. The path must not exceed 138 characters. 4 5 Restart the services that you shut down. Run the KCN Server configuration wizard from the KCN Server installation folder \Bin folder. The wizard is named AciCfgWz.exe. You do not need to
147
Chapter 10
make any changes on the displays while the configuration wizard is running. You should see the additional file cache folder locations listed. Enabling Additional KCN Services You can perform this operation at any time. To enable the KCN Service at the central site, the logged in user must have administration rights. If you have more than 50 remote sites connected to a single central site, you may need to enable additional KCN Services to have better performance. To enable additional KCN Services 1 At the command line, enter: <Kofax Capture installation folder>\Bin\aciscfg.exe. The Enable KCN Service dialog box will display.
Figure 10-5. Enabling KCN Service Sample Initial Display
148
The notes in the dialog box shown above also specify that you must have Full Control permissions to the specified server files and KCN Server file cache folder locations. 2 In the Log on as area, do one of the following: Select Local System account, and then click OK. The local system account will be used. Only select this option, if both the Kofax Capture server files folder and the file cache folder locations are on the local computer. Select the User name option. Then, enter the password and domain, and click OK. The user specified must have Full Control permissions to both the Kofax Capture server files folder and the file cache folder locations. Select the User name option. Then, browse to select the user name and click OK. The user name and domain boxes will automatically be populated after you make your selection. The user specified must have Full Control permissions to both the Kofax Capture server files folder and the file cache folder locations. If any problems were found while enabling the KCN Service, a dialog box will display listing errors or warnings. In the case of errors, click OK, correct the errors, and enable the KCN Service again. In the case of warnings, the KCN Service will successfully enable. Note We recommend that the KCN Service be installed on any workstation other than the Kofax Capture Server.
Disabling the KCN Service You can perform this operation after KCN Server has been installed. If you want to remove the KCN Service from a computer, you need to disable it. After disabling the KCN Service, to be able to use the service you must re-enable it. To disable the KCN Service, run the following from the command line: <Kofax Capture installation folder>\Bin\aciscfg.exe /d. Note If you attempt to uninstall Kofax Capture and a KCN Service is running, the uninstall program will automatically disable the KCN Service.
Stopping the KCN Service You can perform this operation after KCN Service has been enabled.
149
Chapter 10
Stopping the KCN Service causes the service to be made temporarily unavailable. It does not remove the service. To resume using the KCN Service, you must restart it or reboot. To stop the KCN Service, from the Control Panel, select Administrative Tools | Services | Kofax Capture Service | Action | Stop. Starting the KCN Service If you stopped the KCN Service, you need to start it to use KCN Server. To start the KCN Service, from the Control Panel, select Administrative Tools | Services | Kofax Capture Service | Action | Start.
Remote Site Configuration Tasks

This section contains a number of tasks you may need to perform when configuring your remote sites. Converting a Remote Installation to a Remote Site You can perform this step after the KCN Server is installed. Warning Converting a Kofax Capture installation to a remote site will cause the latest versions of batch classes to be downloaded from the central site to the remote site. Any existing batch classes at the remote installation will be lost. If you want to keep these batch classes, export them to .cab files first. You can then send the .cab files to your central site, where they can be imported. Note After conversion, the Administration module will be disabled at the remote site. To convert a remote installation to a remote site 1 2 Open the Batch Manager module at the remote site. From the menu bar, select Options | KCN Server | Convert to Remote Site. A message will display warning you that the Administration module will be disabled and all batch classes will be deleted if you continue converting the installation. Select Yes to acknowledge the warning. The Web Server URL dialog box will display.
150
Specify the Web server URL (for example, http://Web server) If you are not using the default port number, specify the Web Server URL and the new port number using the following syntax: <http protocol>://<Web server>[:port]/acis. For example, if the alternate TCP port number is 8080, the URL would be similar to: http://www.Mysite.com:8080/acis. See Setting Your IIS Port Configuration on page 165 for more information. Click OK. The KCN Server will validate the specified URL by attempting contact the Web site. Note If the Web site requires SSL, you must specify the URL with https, instead of http. For example, <http >://<Web server>[:port]/acis. Http protocol includes both http and https.
If authentication was enabled and credentials were not already supplied during installation, the Connect to Central Site dialog box displays, prompting you for valid credentials. Enter a valid user name and password and click OK. If desired, select Yes to confirm that you want to activate the RSA at the remote site. A shortcut to the RSA will be installed as an icon in the Windows system tray.
Specifying the Web Server URL You can perform this operation after converting an installation to a remote site if the URL has changed. You can also use this to switch central sites. Ensure that you have no batches in process, if you switch central sites. You will lose the batch classes and licensing from the old central site. Batch classes and licensing from the new central site will be downloaded to the remote site based on the remote site profile assigned to this remote site. To specify the Web server URL 1 2 3 Open the Batch Manager module. Select Options | KCN Server | Web Server URL. The Web server URL dialog box will display. Specify the Web server URL (for example, http://Web server) If you are not using the default port number, specify the Web Server URL and the new port number using the following syntax: <http protocol>://<Web
151
Chapter 10
server>[:port]/acis. Http protocol includes both http and https. For example, if the alternate TCP port number is 8080, the URL would be similar to: http:// www.Mysite.com:8080/acis. See Setting Your IIS Port Configuration on page 165 for more information. 4 Click OK. The URL will be validated. Note If the Web site requires SSL, you must specify the URL with https, instead of http. For example, <http >://<Web server>[:port]/acis.
Activating the RSA You can perform this operation after converting an installation to a remote site. Use the following steps to activate the RSA. To activate the RSA 1 2 Start Batch Manager. Select Options | KCN Server | Activate RSA on This Station. The RSA allows you to upload batches and download batch classes without maintaining an ongoing connection to the Kofax Capture server. When you are prompted to confirm the activation, select either Yes to confirm the activation, or select No to defer activation. Selecting Yes adds the RSA to the Windows system tray (see Figure 10-4 on page 143). You must activate the RSA on at least one station at each remote site. Once you have activated the RSA, you can also choose to install it as a service. Refer to the Installing Services appendix of the Kofax Capture Getting Started Guide for more information. Configuring Remote Site Authentication When you convert a Kofax Capture installation to a remote site, it must establish a connection with the central site web server. If an authentication scheme has been enabled, the RSA Authentication Settings dialog displays, prompting you for a user name and password. Once proper credentials are provided, they are saved to the database and conversion continues. If proper credentials are not provided, nothing is saved and the remote site conversion process does not continue.
152
Configuring a Client Certificate If the KCN Web Server is configured to require client certificates, in order to connect, remote sites must also be configured with a valid client certificate. You configure the client certificate by adding an entry to the remote sites registry. During operation, if a valid client certificate is found in the registry, the RSA automatically uses the client certificate when connecting to the KCN Web Server. Note Kofax Capture 8.0 supports the use of client certificates for authentication only where the KCN Web Server is running IIS. Currently, there is no support for the use of client certificates for authentication on WebSphere. To configure a client certificate 1 Import the client certificate to the remote site computer in one of the two following ways: In Internet Explorer, select Tools | Internet Options | Content | Certificates | Import. In the Microsoft Management Console, select File | Add/Remove Snap-in | Add | Certificates | Add. 2 3 4 5 6 7 Copy the Thumbprint entry for the client certificate. This is typically represented as a hexidecimal string. Start the Windows Registry Editor (Start | Run | Open | regedit). Navigate to the following registry key: HKLM\SOFTWARE\Kofax Image Products\Kofax Capture\3.0 Create a new binary registry entry named Thumbprint and set the value to the previously copied Thumbprint value in Step 2. Close the Windows Registry Editor. Stop the RSA and then restart it.
The RSA automatically reads and uses the client certificate when connecting to the KCN Web Server. Sharing Scanner Profiles You can save scanner profiles to a shared location on the network and make them available to other users. To share scanner profiles, Select Scan | Scanner Profiles | Save Profiles as Shared.
153
Chapter 10
Note If User Profiles is enabled, make sure that you have selected the Allow admin utility usage setting. Only users with rights to access Administrative Utilities can save local profiles as shared or revert to shared profiles. Scanner Profile Locations The profile storage location is a hierarchical set of folders organized by scan source. Scanner profiles, including VRS profiles, are stored in a folder specific to the scan source and can either be local or shared. Local profiles are stored in the ScannerProfiles folder beneath the Kofax Capture <LocalPath> folder. Shared profiles are stored in the SharedScannerProfiles folder beneath the Kofax Capture <ServerPath> folder. Note On a standalone installation, shared profiles are not enabled and the shared profiles folder does not exist.
Upgrading/Updating
The steps for upgrading or updating are the same as installing it for the first time. However, note the following: Upgrade Ascent Capture and ACI Server at the central site first, and then upgrade ACI Server remote sites. You cannot upgrade directly from Ascent Capture 4.x or 5.x to Kofax Capture 8.0. When upgrading Ascent Capture and ACI Server 6.x or 7.x to Kofax Capture 8.0 at the central site, first upgrade Ascent Capture and then upgrade ACI Server. Note Until both Kofax Capture 8.0 and KCN Server 8.0 have been installed at the central site, remote sites cannot synchronize. You must stop the Web site before upgrading. The Web site must remain stopped until KCN Server 8.0 is installed. When upgrading Ascent Capture and ACI Server 6.x or 7.x to 8.0, it is not necessary to complete processing batches at the central site prior to upgrading. However, batches in progress are not allowed at remote sites. You do not need to change or adjust your scanner, source devices, or accelerator settings.
154
Converting Batches From Previous Releases

After the central site has been upgraded, remote sites can continue to create and process version 6.x and 7.x batches to send to the central site. When these batches are uploaded to the central site, the batches are converted to 8.0 batches. Depending on the size and number of batches that require conversion, you may experience significant KCN Server overhead during the conversion process. You might want to enable the KCN Service on more computers for better performance and while remote sites running older versions still exist.
Upgrading Your Central Site

Upgrading your central site involves the following basic steps, which must be done in the order listed. Step 1 Step 2 Step 3 Step 4 Step 5 Stop the Web site. Upgrade Ascent Capture and republish your batch classes. Enable the ACI Service. Upgrade ACI Server. Restart the Web site.
Note You must upgrade Ascent Capture and ACI Server at your central site before you upgrade your remote sites. In addition, you must prohibit remote sites from synchronizing with your central site during the entire central site upgrade process.
Step 1: Stop the Web Site You must stop your Web site on your Web server before you upgrade Ascent Capture at your central site. Stopping the Web site will prohibit remote sites from attempting to synchronize during the central site upgrade process. Warning You must stop the Web site for the duration of the entire central site upgrade process. If you do not, and a remote site attempts to synchronize with your central site before both Ascent Capture and Ascent Capture Internet Server are upgraded, the remote site will lose all published batch classes and will not be able to function. If this occurs, you must complete the upgrade at the central site. Then, you must upgrade the remote site to restore its functionality.
155
Chapter 10
To stop the IIS Web site 1 Do one of the following: a On your Windows 2000 Server IIS Web server, select Start | Programs | Administrative Tools | Internet Services Manager. b On your Windows Server 2003 IIS Web server, select Start | Programs | Administrative Tools | Internet Information Services (IIS) Manager. 2 3 Expand the Internet Information Services tree to display the Web site. Right-click the Web site folder, and select Stop.
To stop the WebSphere Web site 1 2 In your Windows Services manager locate IBM WebSphereAdminServer 5.1. Stop the service.
Note Do not stop the Web site while remote sites are uploading batches. This may cause batches to become unusable or lost. One way to check the upload activity is to use the Windows Performance monitor. Under Active Service Pages, view the Requests Executing statistic. For more information on performance monitoring, see your Microsoft documentation.
Step 2: Upgrade Ascent Capture and Republish Your Batch Classes Upgrade your Ascent Capture software at your central site. In addition, make sure the necessary hardware key is attached to your Ascent Capture server at your central site, and that you have sufficient licenses. See the Kofax Capture online Help for more information on licensing. For standalone installations, upgrade your standalone Ascent Capture station. For client/server installations, first upgrade the Ascent Capture server. After upgrading the central site, republish your batch classes. Step 3: Enable the KCN Service You must enable the KCN Service at the central site. To enable KCN Services at the central site, the logged in user must have administration rights.
156
To enable the KCN Service 1 At the command line, enter: <Kofax Capture installation folder>\Bin\aciscfg.exe. The Enable KCN Service dialog box will display. The notes in the dialog box also specify that you must have read/write permissions to both the Kofax Capture folders and the file cache folder locations. 2 In the Log on as area, do one of the following: Select Local System account, and then click OK. The local system account will be used. Only select this option, if both the Kofax Capture folder and the file cache folder locations are on the local computer. Select the User name option. Then, enter the password and domain, and click OK. The user specified must have read/write permissions to both the server files folder and the file cache folder locations. Note On a standalone computer or the Server computer, the specified user must have access to all KCN Service resources and all resources required by the licensing service. Select the User name option. Then, browse to select the user name and click OK. The user name and domain boxes will automatically be populated after you make your selection. The user specified must have read/write permissions to both the Kofax Capture server files folder and the file cache folder locations. If any problems were found while enabling the KCN Service, a dialog box will display listing errors or warnings. In the case of errors, click OK, correct the errors, and enable the KCN Service again. In the case of warnings, the KCN Service will successfully enable. Note We recommend that the KCN Service be installed on any workstation other than the Kofax Capture Server.
Step 4: Upgrade Ascent Capture Internet Server Upgrade the Ascent Capture Internet Server software at your central site. Any previously defined Ascent Capture Internet Server configuration settings will be preserved during the upgrade process.
157
Chapter 10
To upgrade Ascent Capture Internet Server 1 2 Make certain that your Web site on your Web server is stopped. To do so, refer to Step 1: Stop the Web Site on page 155. Insert the Kofax Capture installation CD 1 into the CD drive on your Web server. The CD supports AutoPlay, so the installation will automatically begin. (If it doesnt start, run AutoPlay.exe from the CD.) Select Install/Upgrade Web Server Components for IIS. Follow the instructions on your screen to upgrade the software. When prompted to do so, reboot your Web server computer.
3 4 5
Step 5: Restart the Web Site After upgrading to Kofax Capture and KCN Server at your central site, you must restart the Web site. To restart the Web site on an IIS Web server 1 2 3 On your Web server, select Start | Programs | Administrative Tools | Internet Services Manager. Expand the Internet Information Services tree to display the Web site. Right-click the Web site folder, and select Start, if it is not already started.
To restart the Web site on a WebSphere server 1 2 3 In your Windows Services manager locate IBM WebSphereAdminServer 5.1. Restart the service. Start WebSphere Application Server, typically from the program group or a shortcut.
Upgrading Your Remote Sites

Follow these steps for each remote site Step 1 Step 2 Process all batches at the remote site and upload them. Upgrade your Kofax Capture software at your remote site.
Note The central site must be upgraded before the remote installations are upgraded.
158
Step 1: Process All Batches at the Remote Site and Upload Them Finish processing any Ascent Capture batches at the remote installation before you upgrade Ascent Capture at a remote installation. All completed batches must be uploaded to the central site. Step 2: Upgrade Your Ascent Capture Software at Your Remote Site Upgrade the Ascent Capture software on your remote installation. To do so, use the Install/Upgrade Remote Site from the Autorun menu. If you are upgrading a client/ server installation, see Upgrading Client/Server Installations on page 54.
Deactivating a Remote Site

There is no way to explicitly uninstall or deactivate a KCN Server remote site. If you have a remote site that you want to convert to an Kofax Capture-only installation, use the following procedure. Note Deactivating or uninstalling a remote site will permanently remove all batches at the remote site. Be sure to complete all batches and upload them to your central site before you execute the following procedure. To convert a remote site to a Kofax Capture installation 1 2 3 4 If the RSA is open, close it. To do so, right-click the RSA system tray icon and select Close. Open the Add or Remove Programs utility available from the Windows Control Panel. Select Kofax Capture 8.0 and click Change/Remove. Kofax Capture will be uninstalled. Reinstall Kofax Capture.
Uninstalling KCN Server Software

Please note that uninstalling the KCN Server will not: Remove or change the Web server settings previously configured for KCN Server. For example, it will not remove your KCN Server virtual directory or change its properties. Affect KCN Server remote site profile settings. Remote sites will retain their profile settings that were already downloaded. If you subsequently reinstall
159
Chapter 10
the KCN Server software at the central site, the remote sites and central site may no longer have the same settings. A remote site will download new settings the next time it synchronizes. Note The remote sites will automatically receive the new settings from the central site the next time the remote sites synchronize provided you have reinstalled the KCN Server.
Uninstalling KCN Server on IIS

If you want to uninstall the KCN Server software at your central site, use the following procedure. To uninstall the central site KCN Server software 1 2 From the Windows Control Panel, select Add or Remove Programs. Select Kofax Capture Network Server 8.0 and click Change/Remove.
Uninstalling KCN Server on WebSphere

Refer to Uninstalling KCN Server Components on page 175 for more information about uninstalling KCN Server components on WebSphere.
160
Chapter 11
Web Server Settings
Introduction
This chapter contains important information on configuring your Web server to work with Kofax Capture Network Server (KCN Server). The following Web servers are supported: IIS Web Server WebSphere
IIS Web Server

KCN Server requires certain IIS Web server property settings for your ACIS and ACIUpload0 virtual directories. IIS settings are set by the KCN Server installation. The installation also generates a to do list. Be sure to complete all the items on the list before using KCN Server. For a sample to do list, see Step 3: To Install the KCN Web Server Components on page 138. If desired, you can enable additional settings. This section identifies the minimum IIS and NTFS security settings required by KCN Server. Refer to your Microsoft documentation for details on additional settings. To display the KCN Server Web site properties 1 Run the Internet Information Services application from your IIS Web server station. To do so, select Start | Programs | Administrative Tools | Internet Services Manager. Expand the Internet Information Services tree to display your KCN Server virtual directories. Right-click the applicable directory (ACIS or the ACIUpload0 directory) and select Properties.
2 3
161
Chapter 11
KCN Server Virtual Directory Properties

The KCN Server virtual directory stores the KCN Server Web pages and associated program files. The KCN Server installation program (configuration wizard) sets the KCN Server virtual directory properties for you. If you need to set the properties yourself, follow the instructions below. For brevity, only Windows 2000 Server dialog boxes are shown. Dialog boxes for other Windows versions are not shown. To set the KCN Server virtual directory properties 1 On the KCN Server Properties dialog box, make sure the following settings are selected: For permissions, choose Read For Application name, enter KCN Server For Execute Permissions, choose Scripts and Executables The KCN Server Properties dialog box will look similar to the following:
Figure 11-1. KCN Server Virtual Directory Required Properties
162
Web Server Settings
Note The default value for Application Protection is High (Isolated). This value is recommended, but not required. 2 Configure the .acis application extension. The aspnet_isapi.dll file should be mapped to the .acis application extension, and the HTTP verbs that should be passed to the application should be limited to GET and POST. This creates a mapping between the file name extension (.acis) and the program or interpreter that processes those files (the dll file). a From the KCN Server Properties page, click Configuration | Add. b For the Executable, enter: C:\WinNT\Microsoft.NET\Framework\v1.0.3705\aspnet_isapi.dll. c For the Extension, enter .acis. d For the Verbs, select Limit to, and then enter the HTTP verbs GET and POST (GET, POST). e Ensure that the Script option is selected. This option will allow the executable to run.
ACIUpload Virtual Directory Properties

The ACIUpload virtual directory temporarily stores batches as they are uploaded to the central site. The ACIUpload virtual directories point to the actual locations of the file cache folders. Generally, you will have only one virtual directory where batches will be temporarily stored. That virtual directory will be named ACIUpload0. The KCN Server installation program (configuration wizard) sets the KCN Server virtual directory properties for you. Note If you need to set the properties yourself, follow the instructions on page 162. However, we strongly recommend you let the configuration wizard perform this task for you. If you add ACIUpload virtual directories, you need to number them consecutively (ACIUpload0..ACIUploadn). You must ensure that the properties are correct for each ACIUpload folder. For brevity, only Windows 2000 Server dialog boxes are shown. Dialog boxes for other Windows versions are not shown.
163
Chapter 11
The ACIUpload0 Properties dialog box will look similar to the following:
Figure 11-2. ACIUpload Virtual Directory Required Properties
On each ACIUpload Properties dialog box, make sure the following settings are selected: For permissions, choose Write For Execute Permissions, choose None Note The KCN Server installation enables anonymous access with write permission for the ACIUpload0 virtual directory defined during installation. This allows completed batches to be uploaded to the central site without remote users having to log on to the IIS Web server. Anonymous access is required.
Adding or Editing File Cache Folder Locations To change the location or number of file cache folders, run the KCN Server configuration wizard (see page 138 for more information). If you choose to configure the KCN Web server components without using the configuration wizard, you will need to modify the Web.config file after configuring the ACIUpload folder(s). The additional ACIUpload folders are configured as virtual directories through the
164
Web Server Settings
Microsoft Management Console. The additional virtual directories must be numbered sequentially when created (ACIUpload1..ACIUploadn). The contents of the file that you might need to change are listed below. Note Most of the settings in this file should not be changed, except as described below.
<appSettings>  <add key=forwardertimeout value=180/> <add key=errorlogpath value=/>  <add key=filecachefolder value=1/>  <add key=webconfigversion value=1/>  <add key=tidstatusretry value=90/> </appSettings>
The only values you should change are as follows. Change the value assigned to the filecachefolder key to set the value to the number of file cache folders you have. This is typically 1. Also, change the value assigned to the webconfigversion key to increment by 1 any time you change the filecachefolder value. For more information on why you might want to use more than one file cache folder location, see File Cache Folder Locations on page 128.
Setting Your IIS Port Configuration

You can change your IIS port configurations at any time either before or after installation. By default, all HTTP communications use port 80, and all SSL communications use port 443. If you change the port configuration in IIS prior to installing KCN Server, you must specify the proper URL at the remote site after installation. If you change your port number after installation, you must change the port number at both the central and remote sites before processing batches can resume. At the central site run the Internet Information Services administration tool. Refer to your Microsoft documentation for details.
165
Chapter 11
At the remote site, from Batch Manager select Options | KCN Server | Web Server URL. Specify the Web Server URL and the new port number using the following syntax: <http protocol>://<Web server>[:port]/acis. For example, if the alternate TCP port number is 8080, the URL would be similar to: http://www.Mysite.com:8080/acis. Note When selecting alternate ports, you must ensure that the ports you assign are not being used by other applications or services. If there are port conflicts, you may experience intermittent and unpredictable problems.
IIS Authentication Configuration

The following section contains important information on configuring authentication for your Web server. The following authentication schemes are supported: Anonymous User Account Basic Authentication Integrated Windows Authentication Anonymous User Account The anonymous user account is used as the logon account for remote users. You may use any anonymous user account if desired, but be sure to consider the following when doing so: If IIS is installed on a domain controller, ensure the anonymous user account has permissions on the stations where the file cache folders are located. This is not recommended. If IIS is installed on a member server (rather than a domain controller), ensure the anonymous user account is a domain-wide account that has permissions on the IIS Web server and the stations where the file cache folders are located. If IIS is not installed within a domain, ensure the anonymous user account exists on both the IIS Web server and the stations where the file cache folders are located, and has the same password. Note The user name specified for the anonymous user account must have Log on locally permission for the IIS Web server or be a member of a group that has this permission.
166
Web Server Settings
Note You can install multiple file cache folders, each on a separate station. If you install multiple file cache folders, ensure that the anonymous user account has the appropriate permissions described above for each station on which a KCN Server file cache folder is installed. To display users with Log on locally rights 1 Select Start | Programs | Administrative Tools | Local Security Policy. Note If your computer is a domain controller, select Domain Controller Security Policy rather than the Local Security Policy. 2 3 4 Expand the tree to display Security Settings\Local Policies\User Rights Assignment. Right-click the Log on locally right and select Security. The users with Log on locally rights are specified in the Assigned To list.
Allow IIS to Control Password Settings The KCN Server Configuration Wizard disables the Allow IIS to control password setting for all KCN Server virtual directories (ACIS and ACIUpload0). This setting should always remain disabled. If you change the password for your anonymous user account, you must also change the password in IIS to match. See your Microsoft IIS documentation for more information on changing passwords. Basic Authentication To configure KCN Server for basic authentication on IIS 1 2 3 4 5 6 On your web server, select Start | Programs | Administrative Tools | Internet Information Services. Expand the Internet Information Services tree to display the Web site. Right-click the Web site folder and select Properties. The Web Site Properties dialog box will display. Select the Directory Security tab and click Edit. The Authentication Methods dialog box will display. Clear the Anonymous access check box. Select the Basic authentication check box.
167
Chapter 11
7 8 9
When the Internet Service Manager message box displays, click Yes. Enter a domain name in the Default domain field. Click OK on the Authentication Methods dialog box.
10 Click OK on the Web Site Properties dialog box. Note This configuration is not recommended unless it is in conjunction with SSL.
Integrated Windows Authentication To configure KCN Server for Integrated Windows authentication on IIS 1 2 3 4 5 6 7 8 On your web server, select Start | Programs | Administrative Tools | Internet Information Services. Expand the Internet Information Services tree to display the Web site. Right-click the Web site folder and select Properties. The Web Site Properties dialog box will display. Select the Directory Security tab and click Edit. The Authentication Methods dialog box will display. Clear the Anonymous access check box. Select the Integrated Windows authentication check box. Click OK on the Authentication Methods dialog box. Click OK on the Web Site Properties dialog box.
IIS and File Cache Permissions Configuration

The following sections provide important information for configuring file cache permissions for IIS. Disabling Impersonation When using Basic or Windows Integrated authentication, for file cache accessibility, we recommend that you disable impersonation. This provides the advantage of not having to configure file access permissions for every authenticated user.
168
Web Server Settings
To disable impersonation 1 Modify the web.config file in the <KCN Server>\Bin\Web folder. For example:
<system.web> <identity impersonate="false"/> ... </system.web>
Restart IIS.
Configuring File Cache Write Permissions Disabling impersonation causes IIS to use the account specified by the .NET framework when it accesses the file cache. By default, the web servers worker thread operates under the <Local Machine>\ASPNET user account. Therefore, you must determine the name of this account and give it write access to the KCN Server file caches. To configure file cache write permissions 1 Determine the account used by the web server using one of the two methods below: Open the machine.config file in the <Windows>\Microsoft.NET\Framework\<.NET Version>\Config folder and view the <processModel> element. Use the config.acis?config=user KCN Server configuration parameter. This parameter outputs data similar to the following: Current Windows identity: TJAMES-WKS-XP\ASPNET Note The the config.acis?config=user KCN Server configuration parameter is an existing KCN Server parameter on IIS. The ASPNET account is created during the .NET framework installation and is an account local to the web server. 2 Give the account determined in Step 1 write access to the KCN Server file caches.
NTFS Security Settings

If KCN Server and the file cache folder locations are installed on NTFS partitions, ensure that the folders (not virtual directories) have the minimum required permissions documented in this section. Note that these folders may be located on separate computers.
169
Chapter 11
Note A reboot is only required for NTFS security setting changes, if the changes did not take effect. To display folder permissions 1 2 3 Run Windows Explorer. To do so, select Start | Programs | Accessories | Windows Explorer. Right-click the applicable folder and choose Properties. Select the Security tab to display folder permissions.
KCN Server Installation Folder Permissions

Default location: C:\Program Files\Kofax\CaptureSS on the computer where KCN Server is installed
The KCN Server\Bin\Web folder, if located on an NTFS partition, must have Read and Execute permissions for the anonymous user account used for the KCN Server virtual directory. Logs Folder Permissions
Default location: C:\Program Files\KCN Server\Logs on the computer where KCN Server is installed
The Logs folder, if located on an NTFS partition, must have Full Control permissions for the anonymous user account used for the ACIS virtual directory. ACIUpload Folder Permissions
Default location: C:\Documents and Settings\All Users\Application Data\Kofax\CaptureSV\ACIS\Upload on the computer where Kofax Capture is installed
The ACIUpload folder, if located on an NTFS partition, must have full control permissions for the anonymous user account used for the ACIS and the ACIUpload virtual directories, and for the KCN Service user account.
WebSphere
KCN Server currently supports version 6.0 of IBM WebSphere. The following sections provide important information for configuring this product for use with KCN Server. Warning WebSphere installation should be performed by the Kofax Professional Services department, or a specialist with equivalent knowledge and experience. This document does not provide information on installing WebSphere.
170
Web Server Settings
WebSphere 6.0 for KCN Server is supported on the Windows 2000/2003 Server/ Advanced Server platforms, as well as Solaris 9 and 10.
Install KCN Server Components on WebSphere

After WebSphere 6.0 has been installed and is running correctly, your Web server administrator can install the KCN Server components to WebSphere. Note This procedure should be performed only by your Web server administrator. Although a- Kofax Capture installation is required at the central site, Kofax Capture is not required on the Web server. Step 1: Create a Cache Folder Create file cache folders that are accessible from the WebSphere Application Server and Kofax Capture. Since KCN Web Server Components reside on the application server, it must have write access to the file cache. File cache folders do not need to be accessible from the HTTP web server. For Solaris, the storage folder must be located on a Solaris server. The path to the cache folder cannot exceed 138 characters. Once the storage folder is created, you must create the following subfolders: services and Upload (these names are case-sensitive). Step 2: Edit ACConfig.xml Specify the file cache folder location (138 characters or less) by modifying ACConfig.xml (usually in the Kofax Capture installation folder) as follows. For Windows:
<KCNServer> <Cache Number=<Cache folder #> Path=<unc path for cache folder>/> </KCNServer>
For example (note that the first cache folder is 0, and subsequent cache folders must be numbered sequentially):
<KCNServer> <Cache Number=0 Path=\\Eng1\acis\/> </KCNServer>
171
Chapter 11
For Solaris:
<KCNServer> <Cache Number=<Cache folder #> Path=<path for cache folder>/> </KCNServer>
For example (note that the first cache folder is 0, and subsequent cache folders must be numbered sequentially):
<KCNServer> <Cache Number=0 Path=sharename/> </KCNServer>
Note You can create multiple cache folders. Refer to Configuring Additional File Cache Folder Locations on page 146 for more information about how to do this.
Step 3: Install KCN Server Components Use the following procedure to install the KCN Server components to WebSphere. Note that entries are case-sensitive. To install the KCN Server components 1 From the IBM WebSphere group menu, start the IBM Application Server, then the WebSphere Administrative Console. Log into the application with the same user ID used when the IBM Application Server was first installed. From the WebSphere Administration Console welcome page, expand the Applications node on the left side of the screen, and click the Install New Application option. In the Preparing for the application installation panel on the right, browse for the file acis.war on the Kofax Capture CD 2 (ACIS\WebSphere). Enter /acis for Context Root then click the Next button. On the Generate Default Bindings and Mappings page, select the following options: Generate Default Bindings: on Override: Do not override existing bindings Virtual Host: Use default virtual host name for Web modules 6 7 Click Next to continue. Skip the security warning page by clicking Continue. In the Step 1 page, enter KCN Server for Application Name. Click the Next button to go to the next page.
3 4 5
172
Web Server Settings
In the Step 2 page, select the check box next to Kofax Capture Request Forwarder. In the Clusters and Servers area, select a Web server and an application server, then click Apply. Click Next to continue. In the Step 3 page, click Next to continue.
10 In the Step 4 page, click Finish. 11 After the KCN Server components are installed, select the Save to Master Configuration link, then click Save. 12 Expand the Environment node on the left side of the screen, and select the Update Web Server Plugin option. 13 In the Update web server plugin configuration panel on the right, click OK. 14 Expand the Applications node on the left side of the screen, and select the Enterprise Applications option. 15 In the Enterprise Applications panel on the right, select KCN Server and click Start. 16 Logout of the WebSphere Administrative Console. 17 Restart the IBM Application Server. 18 ACIServer.ear is now installed as a subfolder under the WebSphere InstalledApps folder. Step 4: Edit KCN Server Deployment Descriptor Next, update the Web application deployment descriptor (Web.xml) to be sure the aciupload0 parameter value specifies the correct location for the file cache folder you created in Step 2 above. Also, confirm that the com.kofax.acis.ErrorLogPath parameter specifies a suitable location for the error log file. If you dont specify a location, WebSphere will store the error log in its default location. For Windows, Web.xml is located at: <IBM WebSphere>\AppServer\profiles\default\ config\cells\<machine name, node cell>\applications\ACI Server.ear\deployments\ACI Server\acis.war\WEBINF\Web.xml For Solaris, Web.xml is located at: <IBM WebSphere>/AppServer/config/cells/DefaultNode/applications/ACI Server.ear/deployments/ACI Server/acis.war/WEB-INF/Web.xml
173
Chapter 11
Edit the bold italic values as shown in the example below:

<web-app> <display-name>Ascent Capture Request Forwarder</display-name> <context-param> <param-name>com.kofax.acis.ErrorLogPath</param-name> <param-value> <your log path> </param-value> </context-param> <servlet> <servlet-name>ForwardServlet</servlet-name> <display-name>ForwardServlet</display-name> <description>Forwards the request to the KCN Service.</description> <servlet-class>ForwardServlet</servlet-class> </servlet> <servlet> <servlet-name>ServiceConfigServlet</servlet-name> <display-name>ServiceConfigServlet</display-name> <description>Return the HTTP body as a string containing the URL of the KCN Service to use (http://serviceserver:port).</description> <servlet-class>ServiceConfigServlet</servlet-class> init-param> <param-name>aciupload0</param-name> <param-value> <your cache folder path> </param-value> </init-param> </servlet> <servlet-mapping> <servlet-name>ForwardServlet</servlet-name> <url-pattern>/service.acis</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>ServiceConfigServlet</servlet-name> <url-pattern>/config.acis</url-pattern> </servlet-mapping> </web-app>
Step 5: Configure Web Server To allow the KCN Server component to function properly in WebSphere, the following line must be added to the <IBM HTTP Server>\conf\httpd.conf configuration file:
BrowserMatch .NET CLR downgrade-1.0 force-response-1.0
Step 6. Configure Basic Authentication Enabling Basic Authentication on the HTTP web server involves creating a password file and optionally creating a group.
174
Web Server Settings
To create a password file 1 2 3 Open a command prompt. Navigate to the <IBM HTTP Server Bin> folder. Run the following command:
htpasswd c b <password file location> <user name> <user password>
Note When adding users to the password file, omit the -c option. This is the same command for both Windows and Solaris versions of WebSphere. To create a group file 1 2 Create a group file with the following format: Add the following lines to the httpd.conf file:
<group name>: <user1> <user2> <userN>
<Location /acis> AuthType Basic AuthName "<Domain name hint to display>" AuthUserFile "<location of password file>" AuthGroupFile "<location of group name file>" Require [entity type] [entity value] </Location>
Basic Authentication is not recommended unless it is in conjunction with SSL. Note Integrated Windows Authentication is not supported by the IBM HTTP Server.
Uninstalling KCN Server Components

Use the following procedure to uninstall the KCN Server components from WebSphere 6.0. To uninstall the KCN Server components 1 From the WebSphere Administration Console welcome page, expand the Applications node on the left side of the screen, and select the Enterprise Applications option. Select the check box next to KCN Server and click Stop. Click the Uninstall button. When the next screen appears, click OK.
2 3
175
Chapter 11
4 5
Click the Save link at the top of the page to save the configuration changes to the Master Configuration. If any files were manually edited during the installation process, they may need to be manually edited to complete the uninstallation process.
176
Chapter 12
Installing and Configuring Kofax Capture Import Connector - Email
Introduction
The Kofax Capture Import Connector - Email (Email Import Connector) feature allows you to import email from one or more designated mailboxes directly into the Kofax Capture workflow. Email Import Connector consists of the following two components: Kofax Capture Import Connector - Email - Service (Service): The Service can be installed on any Kofax Capture workstation or standalone system. This component (which has no user interface) reads emails from mailboxes, imports them into Kofax Capture, and generates batches. You can start or stop this service just like any other service running on Microsoft Windows. You can have only one Kofax Capture Import Connector - Email - Service running per Kofax Capture installation. Note Do not install and use this service at a remote site. Kofax Capture Import Connector - Email - Administration Plug-In (Administration Plug-In): The Administration Plug-In can be installed on any Kofax Capture workstation. It is accessed from a menu item added to the Administration module. There can be any number of Administration Plug-Ins in a Kofax Capture client/server installation, but only one per computer. It is suggested you install the Administration Plug-In where you most frequently use the Administration module. This chapter provides installation and configuration information for these two components.
177
Chapter 12
Installing Kofax Capture Import Connector - Email - Service

Installing the Service is straightforward. To install the Service 1 2 Shut down any applications (including the Control Panel, virus detection software, and toolbars) that might be running. Insert your Kofax Capture installation CD 1 into the CD drive. The CD supports AutoPlay, so the installation will automatically begin. (If it doesnt start, run Autoplay.exe from the CD.) From the main installation menu, shown in Figure 12-1, select Install Email Import Connector.
178
After a few moments, you will see the following menu:
Figure 12-2. Kofax Capture Import Connector - Email Installation Menu
5 6
Select Install Service. Follow the instructions on your screen to install the software. The installation instructions contain additional information that will guide you through the installation process. Be sure to read them carefully before proceeding with each step. When prompted for the logon account, be sure that the account you specify has the rights described in the dialog box. When installation is complete, if desired, you can check your Windows services to confirm that the service is running.
179
Chapter 12
Installing the Kofax Capture Import Connector - Email Administration Plug-In

Installing the Administration Plug-In is also straightforward. To install the Administration Plug-In 1 2 Shut down any applications (including the Control Panel, virus detection software, and toolbars) that might be running. Insert your Kofax Capture installation CD 1 into the CD drive. The CD supports AutoPlay, so the installation will automatically begin. (If it doesnt start, run Autoplay.exe from the CD.) From the main installation menu shown in Figure 12-3, select Install Email Import Connector.
180
After a few moments, you will see the following menu:
Figure 12-4. Kofax Capture Import Connector - Email Installation Menu
5 6 7
Select Install Administration Plug-In. Follow the instructions on your screen to install the software. When installation is complete, if desired, you can run the Administration module and check for the new Email Import Connector item in the menu bar.
Note If you want to uninstall the Administration Plug-In, you must do so while Kofax Capture is still installed. If you uninstall Kofax Capture first, the plug-in will not uninstall.
181
Chapter 12
Upgrading From Earlier Versions

If you have a version of the Service and the Administration Plug-In installed that is earlier than Kofax Capture 8.0, you can upgrade the feature by uninstalling the old version of the Service, then reinstalling version 8.0 of both the Service and the Administration Plug-In. To upgrade to the Kofax Capture Import Connector - Email feature from an earlier version 1 2 3 From the Control Panel, select Add or Remove Programs. Select Ascent Capture Email Import Service, then click Remove. Follow the on-screen instructions to uninstall. Install version 8.0 of the Service and the Administration Plug-In, following the instructions given on pages 178 and 180.
Configuring Kofax Capture Import Connector - Email

If you are setting up Email Import Connector for the first time, follow these steps. Each step is detailed after this overview. Step 1 Step 2 Step 3 Step 4 Step 5 Step 6 Step 7 Step 8 Step 9 In Kofax Capture, configure your batch classes. Verify the compatibility of your batch classes. In Kofax Capture, configure user profiles, if desired. Specify a user profile, if necessary. Set up administrator and sender email notifications. Select or set up your outgoing mail server. Specify the maximum number of emails to allow in each batch. If desired, customize the email notification templates. Add one or more mailboxes.
Step 1: Configure Kofax Capture Batch Classes

Use the following procedure to configure a batch class for use with Email Import Connector. This procedure assumes that the batch class has already been created.
182
To configure a batch class for Email Import Connector 1 2 3 From the Administration module, in the Definitions panel, select the batch class you want to configure. Right-click and select Properties. The Batch Class Properties dialog box displays. In the General tab, examine the batch fields area. If there are any batch fields where the Required property is set to true, change it to false (or do not use this batch class with Email Import Connector). In the Advanced tab, ensure that Allow import of eDocument files is selected. Note Treat non-TIFF images as eDocument files may be optionally selected or left blank. 5 6 7 8 9 In the Separation and Form Identification tab, make sure that Kofax fixed pages is not selected. Click OK to close the dialog box and save your settings. In the Definitions panel, select the form type you want to use with Email Import Connector. Right-click and select Properties. The Form Type Properties dialog box displays. Ensure that Fixed number of pages is not selected (or do not use this form type with Email Import Connector).
10 Publish the batch class. Your batch class is now ready for use by Email Import Connector. 11 If desired, validate your batch class using the Email Import Connector Compatibility dialog box. Note If the User Profiles feature is enabled, you cannot select a batch class in Email Import Connector unless the specified user profile allows access to that batch class. Although the above procedure covers the necessary settings, this list of batch class options that cannot be used with Email Import Connector may serve as a handy reference: In the Batch Class Properties dialog box, you cannot have any batch fields where the Required property is set to true.
183
Chapter 12
In the Advanced tab, Allow import of eDocument files must be selected. In the Separation and Form Identification tab, Kofax fixed pages must not be selected. In the Form Type Properties dialog box, Fixed number of pages must not be selected.
Step 2: Verify Batch Class Compatibility

After you have configured a batch class in Kofax Capture, you can confirm that it is ready for use by Email Import Connector. To validate a batch class 1 2 3 4 From the Email Import Connector menu, select Compatibility. The Compatibility dialog box displays. In the Batch Class list, select one or more batch classes. Only published batch classes allowed by the currently specified user profile are displayed. Click Validate to check the selected batch classes for compatibility. Check the Results area for any problems, and fix as necessary.
Step 3: Configure User Profiles

If desired, you can use the User Profiles Properties dialog box to define a user profile. Refer to the online Help and the Kofax Capture Getting Started Guide for information about user profiles.
Step 4: Specify a User Profile

If you elect to specify user profiles, Email Import Connector will only allow you to use those batch classes permitted by the user profile, so you must complete this procedure before you can specify or validate a batch class. Note User profiles must also be enabled within Kofax Capture. To specify a user profile 1 From the Email Import Connector menu, select Configuration. The Configuration dialog box - User Profile tab displays.
184
In the User Name area, select the user profile you want to use. This is a required field. Your choice may affect the batch classes listed in the Mailbox dialog box - Import Options tab or the Compatibility dialog box. In the Password area, specify the password for the selected user profile. Click OK to close the dialog box and save your settings.
3 4
Step 5: Set Up Email Notifications

Before using Email Import Connector, you must provide an email address for the administrator. This address will be used as the destination for a variety of customizable email notifications. To set up Administrator email notifications 1 2 3 4 5 From the Email Import Connector menu, select Configuration. The Configuration dialog box - User Profile tab displays. Select the Advanced tab. In the Administrator Email area, specify an email account in the name@domain format. Account names are limited to 256 characters or less. Select the Notify administrator in case of error option. Click OK to close the dialog box and save your settings.
Email Import Connector can automatically send a customizable email notification to the sender if desired. To set up sender email notifications 1 2 3 4 From the Email Import Connector menu, select Configuration. The Configuration dialog box - User Profile tab displays. Select the Advanced tab. Select the Notify sender in case of import error option. Click OK to close the dialog box and save your settings.
Step 6: Set Up the Outgoing Mail Server

Next, you should setup the outgoing mail server.
185
Chapter 12
To set up the outgoing mail server 1 2 3 From the Email Import Connector menu, select Configuration. The Configuration dialog box - User Profile tab displays. Select the Advanced tab. Specify an Outgoing mail server. Use the DNS name or IP address of the mail server you want to use for outgoing email. Addresses are limited to 256 characters or less. Specify the port number used to connect to the mail server. Port numbers are limited to 8 characters or less. If the outgoing mail server requires authentication, select Server requires authentication. Specify an existing account name that can be used with the outgoing mail server. Account names are limited to 256 characters or less. Specify the password for the account. Passwords are limited to 256 characters or less. If SSL should be used, select Use Secure Connection (SSL). Click OK to close the dialog box and save your settings.
4 5 6 7 8 9
Step 7: Specify Number of Emails in Each Batch

You can specify the maximum number of emails that can be imported into a batch. If the number of waiting emails exceeds the limit, the remainder will be imported into the next batch. To specify the number of emails in a batch 1 2 3 4 From the Email Import Connector menu, select Configuration. The Configuration dialog box - User Profile tab displays. Select the Advanced tab. In Maximum number of emails per batch, specify a value from 1 to 1000 emails. The default is 100 emails. Click OK to close the dialog box and save your settings.
186
Step 8: Customize Email Notification Templates

If desired, you can customize the contents of the Email Import Connector notification email to suit your needs. As a reference, the default contents for the various email templates are provided in the online Help. To customize an email template 1 2 3 Open your preferred text editor (for example, Notepad). Navigate to C:\Documents and Settings\All Users\Application Data\Kofax\Capture\ACEI. Depending on the template you want to edit, open one of the following: email_error.txt mailbox_error.txt system_error.txt Make changes as necessary. Warning Do not alter the conditional content (the items between angle brackets, such as <From address of the original message>). 4 Save the text file.
Step 9: Add One or More Mailboxes

You can add one or more new mailboxes to the list of mailboxes that Email Import Connector will monitor, or you can edit an existing mailbox. To add or edit a mailbox 1 2 From the Email Import Connector menu, select Mailbox List. The Mailbox List dialog box displays. Do one of the following: Click Add to add a new mailbox to the list. Select an existing mailbox, then click Edit to change its settings. The Mailbox dialog box - Mailbox tab displays. 3 4 Specify or edit the name of the mailbox. Mailbox names are limited to 256 characters or less. Select the type of incoming mail server. You can choose either POP3 Server or IMAP4 Server.
187
Chapter 12
5 6 7 8 9
Specify the DSN name or IP address of the mail server. DSN names and IP addresses are limited to 256 characters or less. Specify the port. For new mailboxes, the default port is 110. The port number is limited to 8 numeric characters or less. Specify the name of the email account, up to 256 characters. Enter the account name using the name@domain format. Specify the password associated with the account. Passwords are limited to 256 characters or less. If necessary, select Use Secure Connection (SSL).
10 Specify how often the mailbox should be checked for email. For new mailboxes, the default interval is 10 minutes. 11 Associate this mailbox with a batch class. 12 Click OK to close the dialog box and save your settings.
188
Appendix A
Automatic Installations
Introduction
This section describes automatic installations and initialization files.
There may be occasions when you do not want to perform an interactive installation of Kofax Capture. In those cases, you can use an automatic installation. Automatic installations allow you to complete your installations with minimal involvement from operators. You might want to use an automatic installation if you have many sites to install with similar configurations or at specific times. You might also want to use an automatic installation to avoid the inconvenience of having administrators respond to prompts on every computer.
Types of Automatic Installations

You can perform either of the following types of automatic installations: Silent. This type of automatic installation does not display configuration, progress, feature information, or warning dialog boxes. Error messages will still display. Non-interactive. This type of automatic installation displays configuration, progress, feature information, warning dialog boxes, and error messages. Automatic installations look for an initialization file from which they obtain the values that define the installation environment. If you want to use the default values, you do not need to provide an initialization file.
189
Appendix A
Initiating Automatic Installations

To perform an automatic installation of Kofax Capture line, navigate to the \Bin folder and enter setup <options> on the command line. Automatic Installation Options The following table lists the options that can be used when initiating an automatic installation. The options are not case-sensitive.
Table A-1. Automatic Installation Options Option /s or /silent Description Initiates a silent automatic installation. This type of installation suppresses progress and feature information, and warning messages. Error messages are still displayed. You do not, however, need to respond to prompts, except, optionally, when logging in after restarts. Initiates a non-interactive automatic installation. This type of installation displays progress and feature information, warning messages, and error messages. You do not, however, need to respond to prompts, except, optionally, when logging in after restarts. Specifies the path and name of the initialization file, if you will not be using the default initialization values, file name, or file location. If the path to the initialization file contains spaces, the path must be enclosed with double quotes. For example, C:\Initialization Files\Scan3RP.ini. The contents of initialization files are described starting on page 191.
/a or /auto
/i:<initialization file path>
Below is an example of initiating an automatic installation with an initialization file: Setup.exe /s /i:C:\Initialization Files\Scan3RP.ini initiates a silent installation using the specified initialization file.
Deploying Automatic Installations

There are a number of ways that you can deploy automatic installations: By providing an optional initialization file on a CD along with the installation CD.
190
By providing an optional initialization file in an email message to be used with the installation CD. By creating a batch file that starts the installation from the installation CD, and stores the optional initialization files in the appropriate locations for use by the installation . By installing both the Kofax Capture software and optional initialization files through Network Management software available from a third-party supplier.
Using Initialization Files

Note You do not need an initialization file if you will only use the default installation values. As you respond to prompts during interactive installations, Kofax Capture records your choices as attribute values in an initialization file. The resulting initialization file is named ACInsOut.ini and is saved in your TEMP folder. Each time you reinstall on the same computer, that file is overwritten. To retain the attribute values from any installation, you must move the initialization file to another folder before the next installation on the same computer so the file is not overwritten. The initialization file can be modified, if desired, and reused to install Kofax Capture on other workstations. However, it should not be stored as %TEMP%\ACInsOut.ini. You should move or rename that file. Refer to Chapter 3 Planning Your Kofax Capture Installation on page 25 for information about customizing an initialization file.
Assigning Values in the Initialization File

The initialization file is divided into sections. Each section contains attributes for which you can provide values. The values are not case-sensitive. If you do not provide a value, and a default value exists, it will be used. If the attribute is not applicable to the type of installation, any value you assign to that attribute will be ignored. For example, the attribute WorkstationOnServer will be ignored for client installations. You can assign values to the attributes any time before you initiate the installation.
191
Appendix A
Note If you assign values to the workstation attributes in the initialization file before installing Kofax Capture on the server, create the Wrkcnfg folder under the Kofax Capture directory, and then insert the initialization file in the Wrkcnfg folder. When you deploy Kofax Capture, ensure that the initialization file is in the Wrkcnfg folder. See Planning Your Kofax Capture Installation on page 25 for possible deployment methods.
Initialization File Elements

The initialization file elements, attributes, and default values are described below. In the initialization file, you specify a value for an attribute by entering the attribute followed by an equal (=) sign, followed by the value. For example: InstallType=server. The following shows the general structure of the initialization file.
Element [Main] Description of Elements These attributes specify the installation type, program folder name, any switches that are needed for the executable, and other related attributes. These attributes specify whether only system files will be installed, and other related attributes. These attributes specify the various paths required by the installation. These attributes specify the station ID, site ID, site name, the user ID, and other related attributes. These attributes specify information about the type of scanner adapter you are using. These attributes specify information used with KCN Server. These attributes specify the name, password, and other attributes related to SecurityBoost. These attributes specify information related to SQL Server, Oracle, or IBM DB2 databases.
[SystemFiles] [Path] [Identification] [Hardware Information] [ACIS] [SecurityBoost] [Database]
192
The [Main] Element The [Main] element is required, and supports the following attributes.
Table A-2. [Main] Attributes Attribute Name InstallType Values Server, workstation, or standalone Name for your program group Default Server Description Type of installation. This is ignored if you run the setup from the Wrkinst folder to install a client. Name of your Kofax Capture program group. The entry cannot contain any of the following invalid characters: /:\*?<> | . Specify Yes, if you want to use your server as a workstation, or No, if this is to be a server only Specify Yes, if you want to skip the final reboot, and reboot later. Create and execute a script to reboot the computer to complete the Kofax Capture installation. Name of a custom program or script to be launched at the end of the installation. The relative or absolute path to the program must be included, if the path is different from that of the setup executable. Names of the switches used by the custom program or script that you want launched at the end of the installation. If you need to pass a quoted string, the string must be enclosed in a second pair of quotes and a space. For example: C:\Test\Test.doc .
ProgramFolder
Kofax Capture 8.0 No
WorkstationOnServer
Yes or No
SuppressFinalReboot
Yes or No
No
LaunchExe
Executable name
none
LaunchExeArguments Names of switches
none
193
Appendix A
The [SystemFiles] Element The [SystemFiles] element is required, and supports the following attributes.
Table A-3. [SystemFiles] Attributes Attribute Name SystemFilesOnly Values Yes or No Default No Description Upgrades system files only. This option can be used when you are using a custom installation script to manually control when a reboot will occur. You should use this option with the SuppressSystemFilesReboot option. SkipSystemFilesUpdate Yes or No No Skips system files update, if system files are already current. Only use it after updating the system files. Skips reboot after system files have been installed. You will still have to reboot to continue the installation at a later time.
SuppressSystemFilesReboot
Yes or No
No
The [Path] Element The [Path] element is required, and supports the following attributes.
Table A-4. [Path] Attributes Attribute Name ServerSoftwarePath Values Path information Default Description
Program Files\ Path to the server software. Kofax\Capture SS For server installations only.
194
Table A-4. [Path] Attributes (continued) Attribute Name ServerFilesPath Values Path information Default Documents and Settings\ All Users\ Application Data\Kofax\ CaptureSV Description Path to the server files. For server installations only. If you include the location of a previous version of Ascent Capture for this option, and you run the setup file with the /u option, an upgrade will be performed. Path to the program files. For Standalone installations only. Path to the workstation files. For client workstation installations only.
StandalonePath
Path information
Program Files\ Kofax\Capture Program Files\ Kofax\Capture
WorkstationPath
Path information
The [Identification] Element The [Identification] element is required, and supports the following attributes.
Table A-5. [Identification] Attributes Attribute Name StationID Values Alphanumeric from 1-32 characters; cannot include the following characters: - $ ` = \ { } ;' , . / ~!@#^&*()_+ : <> ? % SiteID From 1-4 digits; from 1-9999 1 ID of the site, for server installations. Default Description
computer name Name of the station. Computer names longer than 32 characters will be truncated to 32 characters.
195
Appendix A
Table A-5. [Identification] Attributes (continued) Attribute Name SiteName Values Alphanumeric from 1-32 characters; cannot include the following characters: - $ ` = \ { } ;' , . / ~!@#^&*()_+ : <> ? % RebootUserID RebootUserPassword user ID password none none ID of the user that will be used during the installation. Password associated with the ID provided for the RebootUserID. Domain associated with the ID provided for the RebootUserID. Default Description
computer name Name of the site. Computer names longer than 32 characters will be truncated to 32 characters.
RebootUserDomain
domain
none
The [Hardware Information] Element The [Hardware Information] element is optional if you are not using an Adrenaline scanner adapter. The element supports the following attribute.
Table A-6. [Hardware Information] Attribute Attribute Name ScannerAdapter Values Adrenaline or Other Default Other Description Type of scanner adapter you have. For automatic installations, the Are you using Hardware VRS? dialog box takes the default of No. You must have already installed Hardware VRS, if you intend to use it with Kofax Capture.
196
The [ACIS] Element The [ACIS] element is optional, and supports the following attribute.
Table A-7. [ACIS] Attribute Attribute Name RSAURL Values Full KCN Server URL path Web server port number Default none none Description Turns a particular client workstation into a KCN Server remote site, and enables the KCN Server RSA utility, and automatically activates the RSA. You must provide the URL for the Web server that is running KCN Server. Optionally allows you to specify the Web server port number. If you specify a port, use the following syntax:
<http protocol>://<Web server>[:port]/acis

Note that http and https are the only supported protocols. If the port is not specified, the default ports are assumed: port 80 is used for http and port 443 is used for https. If you do not use the ACIS attribute, you can manually convert a site to a remote site through the Batch Manager module. WebServerUserName User name none A user name that has the ability to log on to the central site web server. Use to specify authentication information when the remote site conversion step takes place. The password associated with the WebServerUserName parameter.
WebServerPassword
Password
none
197
Appendix A
The [SecurityBoost] Element The [SecurityBoost] element is optional, and supports the following attributes. See the Kofax Capture Getting Started Guide or online Help for more information on SecurityBoost.
Table A-8. [SecurityBoost] Attributes Attribute Name SecurityBoostUserName Values User name Default none Description Enables the SecurityBoost option, and specifies the SecurityBoost user name that will be used for the SecurityBoost user. You must provide the SecurityBoost user name, password, and domain. The SecurityBoost parameters are only used for server or standalone installations. SecurityBoostPassword Password none Password of the SecurityBoost user. This is ignored if the SecurityBoostUserName is empty. Domain of the SecurityBoost user. This is ignored if the SecurityBoostUserName is empty.
SecurityBoostDomain
Domain name
local
The [Database] Element The [Database] element is required if you want to configure a SQL Server, Oracle, or IBM DB2 database during a silent installation. The element supports the following attributes.
Table A-9. [Database] Attributes Attribute Name Configuration Values Standard, SQL Server, Oracle, or IBM DB2 Default Standard Description Database configuration.
198
Table A-9. [Database] Attributes (continued) Attribute Name ServerName Values The SQL Server or IBM DB2 server name Default none Description Name of the SQL Server or IBM DB2 database server. This attribute is required if the Configuration value is SQL Server or IBM DB2. This is ignored is the ServerName is empty. Name of the Oracle service. This is required if the Configuration value is Oracle. Name of the SQL Server or IBM DB2 database. This is required if the Configuration value is SQL Server or IBM DB2. This is ignored if the Configuration value is Standard or Oracle. Specify Yes if you want to create a new database using the database name, or No, if the database name refers to an existing database. This is required if the Configuraiton value is SQL Server and ignored if the Configuration value is not SQL Server. Specifies the authentication method for SQL Server. If the value is SQL Server, a value for LoginID is required. This is ignored if the Configuration value is not SQL Server. Login ID used to connect to the database. This is required if the Configuration value is Oracle or IBM DB2, or if the Configuration value is SQL Server and the Authentication value is SQL Server. This is ignored if the LoginID is empty.
ServiceName
The Oracle service name The database name
none
DatabaseName
none
CreateNewDatabase
Yes or No
Yes
Authentication
SQL Server or Windows
SQL Server
LoginID
The database login ID
none
199
Appendix A
Table A-9. [Database] Attributes (continued) Attribute Name Password Values The database login password Default empty Description Password for the database login ID. Use this option if the Configuration value is Oracle or DB2, or if the Configuration value is SQL Server and the Authentication value is SQL Server. This is ignored if the Configuration value is Standard or if it is SQL Server and the Authentication value is Windows. BatchesInSqlServer Yes or No No Specify Yes if you want batches stored in SQL Server, or No, if batches are stored in Access. This is ignored if the Configuration value is not SQL Server.
200
Appendix B
Setting Up Distributed Server Configurations
Introduction
In general, the server components (server files and server software) should be installed on the same computer. However, some existing sites may have legacy issues that require server files be kept on a computer that is not running any of the Kofax Capture certified operating systems listed in Supported Operating Systems on page 5. If you have such a requirement, you can use separate computers for the server software and the server files. This chapter provides information about installing the server software and server files on separate computers. Refer to Client/Server Installation on page 38 for more information about the server components.
201
Appendix B
Server System Requirements for Server Software

The following are the minimum requirements for the server software.

Processor: System memory: Disk space: Pentium 4 processor, or equivalent 1Gbyte or more 500 Mbytes available on your local C: drive, or wherever your operating system is installed, for installation files, temporary files, and working space during processing. You may need even more if you have many batches in progress. 1024 x 768 with 16 bit color, small fonts; 24 bit color is recommended for the best viewing of online Help Kofax Capture hardware key 100 Mbps
Display: USB port: NIC:

Refer to Supported Operating Systems on page 5 for more information about the supported operating systems.
202
System Requirements for Server Files

The following requirements are for the server files.
Recommended Hardware
Processor: Disk space: Long file names: NIC: Network access: Pentium 4 processor, or equivalent 650 Mbytes or more for working space during processing. You may need more if you have many image files or a large database. Normally, server files are installed on a file system that supports long file names, and their default paths make use of long names. 100 Mbps Server files must be accessible to all Kofax Capture client workstations using any operating system that allows access to shared folders across the network using either a UNC path or mapped drive.
Novell NetWare Limitations

Kofax Capture must be installed on a drive that supports long file names, and the default paths for Kofax Capture make use of long names.
Distributed Installation
To install server software and server files on separate computers 1 2 3 At the server software computer, shut down any applications (including the Control Panel, virus detection software, and toolbars) that might be running. Create or select a folder that will be shared during installation of Kofax Capture. Insert your Kofax Capture installation CD 1 into the CD drive. The CD supports AutoPlay, so the installation will automatically begin. (If it doesnt start, run AutoPlay.exe from the CD.) From the main installation menu, select one of the installation options. (Refer to Figure 4-1 on page 39.) Follow the instructions on your screen to install the software. The installation instructions contain additional information that will guide you through the
4 5
203
Appendix B
update process. Be sure to read them carefully before proceeding with each step. As you proceed through the instructions, note the following: Note In most cases, system files may need to be updated and you may be prompted to restart the workstation. If this occurs, choose to restart the workstation and be sure to use the same user account when logging back on. The installation process will automatically resume once your workstation has been restarted. When prompted for the installation type, select Server. When prompted for a destination for the server software, specify a local folder on your server software computer. Make sure you choose an installation path on a local, unmapped, non-UNC drive. When you are prompted for a destination for the server files, select a location for them. Since this will be on a different computer from the server software, make absolutely certain that you choose an installation destination path that is accessible to the server software computer and all client workstations. Use either a UNC path (recommended) or a permanently mapped drive. The method (UNC or mapped drive) that you use here will dictate how your client workstations will be installed. 6 After the server installation is complete, you can install your client workstations.
Upgrading or Updating Distributed Configurations

For a description of the differences between upgrading and updating an Kofax Capture installation, see Upgrading/Updating Kofax Capture on page 49. Upgrading Ascent Capture 6.x or 7.x Follow these instructions if you are upgrading an existing Ascent Capture distributed configuration. Kofax Capture 8.0 also supports Windows Server 2003. If you want to upgrade from Windows 2000 to Windows Server 2003, you should do so prior to upgrading Ascent Capture 6.x or 7.x to Kofax Capture 8.0. Note Read Important Notes on page 49 before you upgrade your Ascent Capture 6.x or 7.x installation.
204
To upgrade an existing distributed configuration 1 Shut down any applications (including the Control Panel, virus detection software, and toolbars) that might be running. Note If you moved the Ascent Capture Batch Catalog (database) to your SQL Server in Ascent Capture 6.x or 7.x, you do not need to change back to MSDE. 2 Insert your Kofax Capture installation CD 1 into the CD drive of the station where the server software is installed. The CD supports AutoPlay, so the installation will automatically begin. (If it doesnt start, run Autoplay.exe from the CD.) From the main installation menu, select the Upgrade option. (Refer to Figure 4-1 on page 39.) The upgrade process will detect the previous version of your server software. Follow the instructions on your screen to upgrade the software. The installation instructions contain additional information that will guide you through the process. Be sure to read them carefully before proceeding with each step. After the server installation is upgraded, you can upgrade your client workstations.
Updating an Existing Distributed Server Configuration Follow these instructions if you are updating an existing Kofax Capture 8.0 distributed server configuration. To update an existing distributed server configuration To update your distributed server, see To update a server or standalone configuration on page 58. To update your client workstations, see To update a client workstation on page 58.
205
Appendix B
206
Appendix C
Backing Up and Restoring Your Standard Database
Introduction
When you upgrade to the latest version of Kofax Capture, you might want to back up your Standard database. For SQL Server database, Oracle database, or IBM DB2 database, follow the instructions that come with your software to back up and restore the database. For MSDE or Microsoft SQL Server 2005 Express Edition database, follow the instructions in this appendix, depending on the version and type of installation (client/server or standalone) you have. These instructions are specifically written for backing up MSDE or Microsoft SQL Server 2005 Express Edition. The MSDE or Microsoft SQL Server 2005 Express Edition database contains information about User Tracking and current batches that are in the system waiting to be processed. Note This is not a complete back up of Ascent Capture (versions earlier than 7.x) or Kofax Capture 8.0. You would need to do this in conjunction with backing up the server files folder and the designated image folders in order to have a complete backup. The Server Files folder is selected during installation and is normally (versions earlier than 7.x) <Ascent Capture installation folder>\Program Files\AscentSV or (Kofax Capture 8.0) C:\Documents and Settings\All Users\Application Data\Kofax\CaptureSV. In addition, the temporary image directories defined in the batch classes would need to be backed up to preserve the images associated with batches in progress. Please follow the steps below to properly back up and restore your Standard database. Please note that your folder paths may be different depending on the type of installation you have (standalone or client/server).
207
Appendix C
Standalone Installations
The following are the procedures for backing up and restoring the Ascent Capture MSDE and Kofax Capture Microsoft SQL Server 2005 Express Edition database on standalone installations.
Backing Up the Ascent Capture (version 6.x or 7.x) MSDE Database

Use the following instructions to back up the MSDE database. To back up the Ascent Capture (version 6.x or 7.x) MSDE database 1 2 3 4 Stop the MSSQL$AscentCapture service. Copy ACSystem.mdf located in \Ascent\Server\DB\MSSQL$AscentCapture\Data\ Copy ACSystem_log.ldf located in \Ascent\Server\DB\MSSQL$AscentCapture\Data\ Start the MSSQL$AscentCapture service.
Restoring the Ascent Capture (version 6.x or 7.x) MSDE Database

Use the following instructions to restore the MSDE database. To restore the Ascent Capture (version 6.x or 7.x) MSDE database 1 2 3 4 5 Stop the MSSQL$AscentCapture service. Browse to \Ascent\Server\DB\MSSQL$AscentCapture\Data\ Rename the original ACSystem.mdf and ACSystem_log.ldf to ACSystem_Orig.mdf and ACSystem_log_Orig.ldf, respectively. Copy your backed up ACSystem.mdf and ACSystem_log.ldf into the folder. Start the MSSQL$AscentCapture service.
Warning This restore needs to be done in conjunction with a restore of the rest of the Ascent Capture file structure, or the restored installation may not be complete.
208
Backing Up the Kofax Capture 8.0 Microsoft SQL Server 2005 Express Edition Database
Use the following instructions to back up the Microsoft SQL Server 2005 Express Edition database. To back up the Kofax Capture Microsoft SQL Server 2005 Express Edition database 1 2 Stop the SQL Server (ASCENTCAPTURE) service. Copy ACSystem.mdf located in \Documents and Settings\All Users\Application Data\Kofax\Capture\Server\DB\MSSQL.1\MSSQL\Data Copy ACSystem_log.ldf located in \Documents and Settings\All Users\Application Data\Kofax\Capture\Server\DB\MSSQL.1\MSSQL\Data Start the SQL Server (ASCENTCAPTURE) service.
Restoring the Kofax Capture 8.0 Microsoft SQL Server 2005 Express Edition Database
Use the following instructions to restore the Microsoft SQL Server 2005 Express Edition database. To restore the Kofax Capture Microsoft SQL Server 2005 Express Edition database 1 2 3 4 5 Stop the SQL Server (ASCENTCAPTURE) service. Browse to \Documents and Settings\All Users\Application Data\Kofax\Capture\Server\DB\MSSQL.1\MSSQL\Data Rename the original ACSystem.mdf and ACSystem_log.ldf to ACSystem_Orig.mdf and ACSystem_log_Orig.ldf, respectively. Copy your backed up ACSystem.mdf and ACSystem_log.ldf into the folder. Start the SQL Server (ASCENTCAPTURE) service.
Warning This restore needs to be done in conjunction with a restore of the rest of the Kofax Capture file structure, or the restored installation may not be complete.
209
Appendix C
Client/Server Installations
The following are the procedures for backing up and restoring the Ascent Capture (version 6.x or 7.x) MSDE database or Kofax Capture 8.0 SQL Server 2005 Express Edition database on client/server installations.
Backing Up the Ascent Capture (version 6.x or 7.x) MSDE Database

Use the following instructions to back up the MSDE database. To back up the Ascent Capture (version 6.x or 7.x) MSDE database 1 2 3 4 Stop the MSSQL$AscentCapture service. Copy ACSystem.mdf located in \AscentSS\Server\DB\MSSQL$AscentCapture\Data\ Copy ACSystem_log.ldf located in \AscentSS\Server\DB\MSSQL$AscentCapture\Data\ Start the MSSQL$AscentCapture service.
Restoring the Ascent Capture (version 6.x or 7.x) MSDE Database

Use the following instructions to restore the MSDE database. To restore the Ascent Capture (version 6.x or 7.x) MSDE database 1 2 3 4 5 Stop the MSSQL$AscentCapture service. Browse to \AscentSS\Server\DB\MSSQL$AscentCapture\Data\ Rename the original ACSystem.mdf and ACSystem_log.ldf to ACSystem_Orig.mdf and ACSystem_log_Orig.ldf, respectively. Copy your backed up ACSystem.mdf and ACSystem_log.ldf into the folder. Start the MSSQL$AscentCapture service.
Warning This restore needs to be done in conjunction with a restore of the rest of the Ascent Capture file structure, or the restored installation may not be complete.
210
Backing Up the Kofax Capture 8.0 Microsoft SQL Server 2005 Express Edition Database
Use the following instructions to back up the Microsoft SQL Server 2005 Express Edition database. To back up the Kofax Capture 8.0 Microsoft SQL Server 2005 Express Edition database 1 2 Stop the SQL Server (ASCENTCAPTURE) service. Copy ACSystem.mdf located in Documents and Settings\All Users\Application Data\Kofax\Capture\Server\DB\MSSQL.1\MSSQL\Data Copy ACSystem_log.ldf located in Documents and Settings\All Users\Application Data\Kofax\Capture\Server\DB\MSSQL.1\MSSQL\Data Start the SQL Server (ASCENTCAPTURE) service.
3 4
Restoring the Kofax Capture 8.0 Microsoft SQL Server 2005 Express Edition Database
Use the following instructions to restore the Microsoft SQL Server 2005 Express Edition database. To restore the Kofax Capture 8.0 Microsoft SQL Server 2005 Express Edition database 1 2 3 4 5 Stop the SQL Server (ASCENTCAPTURE) service. Browse to Documents and Settings\All Users\Application Data\Kofax\Capture\Server\DB\MSSQL.1\MSSQL\Data Rename the original ACSystem.mdf and ACSystem_log.ldf to ACSystem_Orig.mdf and ACSystem_log_Orig.ldf, respectively. Copy your backed up ACSystem.mdf and ACSystem_log.ldf into the folder. Start the SQL Server (ASCENTCAPTURE) service.
Warning This restore needs to be done in conjunction with a restore of the rest of the Kofax Capture file structure, or the restored installation may not be complete.
211
Appendix C
212
Appendix D
Required Folder Permissions
Introduction
To run Kofax Capture, interactive clients require certain permissions.
Client/Server Required Permissions

The table below lists the permissions required to run Kofax Capture in client/server installation.
Table D-1. Client/Server Required Permissions Client/Server Requirements TEMP Folder Installation Folder Server Software Folder Permissions Full Control Read/Execute Read/Write permission for the License Server and SQL Server 2005 Express Edition (if applicable). This is not used by server utilities or a workstation installation on a server. See note below for details. The SQL Server (ASCENT CAPTURE) service must be run as a user that has Read/Write permission to the folder. The Kofax Capture Service must be run as a user that has Read/Write permission to the folder. Both of these services run as Local System by default. If you enable the KCN Service on the same computer, then the KCN Service must also have Read/Write permission to the folder. Server Files Folder <AppData>\Kofax Batch Class Image Folder Full Control Full Control Full Control
213
Appendix D
Standalone Required Permissions

The table below lists the permissions required to run Kofax Capture in standalone installation.
Table D-2. Standalone Required Permissions Standalone Requirements TEMP Folder Installation Folder <AppData>\Kofax Batch Class Image Folder Permissions Full Control Read/Execute Full Control Full Control
Registry Permissions
The table below lists the registry permissions required to run Kofax Capture.
Table D-3. Registry Permissions Registry Key HKEY_CURRENT_USER\SOFTWARE HKEY_LOCAL MACHINE\Software\Kofax Image Products HKEY_LOCAL_MACHINE\Software Kofax Minimum Permissions Full Control Read Read
KCN Server Required Permissions

The tables below list the permissions required to run Kofax Capture Network Server.
Table D-4. KCN Server Required Permissions for IIS Requirements Program Files\KCN Server\Bin\Web <App Data>\Kofax\CaptureSV Permissions IIS user: Read & Execute IIS user: Read & Execute KCN Service user account: Full Control
214
Table D-4. KCN Server Required Permissions for IIS (continued) Requirements File Cache Folders Permissions IIS user: Full Control KCN Service user account: Full Control
Table D-5. KCN Server Required Permissions for WebSphere Requirements Error Log Path (if not default) File Cache Folder Permissions WAS user account: Full Control WAS user account: Full Control KCN Service user account: Full Control <App Date>\Kofax\CaptureSV KCN Service user account: Full Control
SecurityBoost Permissions
If desired, you can use SecurityBoost to protect critical Kofax Capture files. You must first set minimum system permissions for your operators so that they cannot access critical Kofax Capture files and folders. You also create a special SecurityBoost user with permissions that allow access to these files and folders. This section provides information on the minimum folder and file permissions required for the operators and SecurityBoost user. It also has important additional information about permissions when using the Scan or Release modules. Note The permissions shown in Table D-1 and Table D-2 also apply to the SecurityBoost user. See the appropriate table for the system you are using.
Minimum Permissions for the Operator This section describes the minimum permissions for operators. Notice that these are considerably more restrictive than the permissions for the SecurityBoost user.
215
Appendix D
Note If you are not planning to use SecurityBoost, then your operators require the same minimum permissions as those listed in Table D-1 and Table D-2. The following list shows the minimum permissions for client/server installations.
Table D-6. Permissions for Client/Server Installations Location Server Server Item TEMP folder Config subfolder Permission Full Control Read-only Example Path specified in environment variables C:\Documents and Settings\ All Users\Application Data\Kofax\CaptureSV\Config C:\Documents and Settings\ All Users\Application Data\Kofax\CaptureSV\Logs C:\Program Files\Kofax\Capture
Server
Logs subfolder
Read/Write
Client
Installation folder
Read & Execute
The following list shows the minimum workstation permissions for standalone installations.
Table D-7. Permissions for Standalone Systems Item TEMP folder Installation folder Config subfolder Permission Full Control Read & Execute Read-only Example Path specified in environment variables C:\Program Files\Kofax\Capture C:\Documents and Settings\ All Users\Application Data\Kofax\Capture\Config C:\Documents and Settings\ All Users\Application Data\Kofax\Capture\Logs
Logs subfolder
Read/Write
216
Minimum Permissions for the SecurityBoost User To run Kofax Capture with SecurityBoost, the SecurityBoost user must have the following minimum permissions. Furthermore, in a client/server installation, the SecurityBoost user must be a domain user. Note The SecurityBoost user must have access to all operator TEMP files. The permissions in Table D-1 and Table D-2 also apply to the SecurityBoost user. See the appropriate table for the system you are using. The SecurityBoost user must also have Full control permissions of the HKEY_CURRENT_USER registry hive for all interactive users. Note The SecurityBoost user is shared for the entire installation. SecurityBoost users must be either local (for standalone systems) or part of a Windows domain (for client/ server or standalone installations).
Permissions When Using the Scan and Release Modules In certain cases, it may be advisable to avoid using SecurityBoost with the Scan module or the Release module, particularly if you can run these on an otherwise secure workstation. If you need to run these applications with SecurityBoost enabled, you may need to take extra precautions when setting up the permissions for your operators and SecurityBoost user. Scan Module When using the Scan module to import image files, both the SecurityBoost user and the operator need Read permission to the folder or folders that contain those files. Note This concern does not apply if you are using the Scan module to scan paper documents. Do not enable SecurityBoost when using mapped drives. Mapped drives cannot be used for temporary image paths for a batch class. An error occurs after clicking Scan in the Scan module
217
Appendix D
Release Scripts When releasing with the standard text and database release scripts that ship with Kofax Capture, the SecurityBoost user needs Read and Write permissions for all the following folders: Your text file index storage location folders Your release image files folders Your OCR full text folders Your Kofax PDF folders
For other release scripts, refer to the documentation for those scripts for information regarding SecurityBoost compatibility. SecurityBoost and Windows 2000 Windows 2000 does not allow implementing the mechanisms needed by SecurityBoost without setting a special operating system permission for the operator beyond those required the other operating systems. For information on setting this permission, refer to the online Help. This special permission is called Act as part of the operating system, and it must be set for all operators running Windows 2000 that need to use SecurityBoost. This special permission must also be set for the Kofax Capture administrator enabling SecurityBoost on a Windows 2000 system. It is not necessary to set this permission for the SecurityBoost user. After examining the implications of these additional requirements for Windows 2000, you need to assess how they fit within the overall security strategy for you company. It may be that these permissions are not in alignment with your security requirements. Refer to your Windows 2000 documentation for more information about this permission.
218
Appendix E
Kofax Capture Deployment Utility
Introduction
Many companies use disk imaging software to quickly install and configure multiple computers. This software makes an exact copy of a hard drive that can then be restored on a second computer; effectively duplicating the entire computer with its installed software. When Kofax Capture is duplicated in this way, it often runs into configuration issues. The Kofax Capture Deployment Utility, ACDeployUtil.exe, is a standalone console application that reconfigures the Kofax Capture installation, and allows it to function normally on a duplicated computer. ACDeployUtil.exe resides in the Kofax Capture Bin folder (<Kofax Capture installation folder>\Bin). This utility has no graphical user interface, and is controlled completely via command line parameters. This utility can be used with Kofax Capture servers, workstations, and standalone installations. Warning Kofax Capture Deployment Utility must be used on clean installs only.
Kofax Capture Deployment Utility Process Overview

1 2 3 4 5 6 7 Install Kofax Capture on the source computer. Create a disk image of the source computer using a third party product. Restore the disk image to a second computer. Change the second computer's network Computer Name. Stop all Kofax Capture components, if any are running. Start ACDeployUtil.exe and make the necessary changes to the system. Activate Kofax Capture through ACLicUtil.
219
Appendix E

This utility supports several command line parameters to reconfigure the new installation of Kofax Capture.
No Parameters
Displays the current configuration values.
ACDeployUtil
Usage [/?]
The "/?" parameter displays the proper usage of ACDeployUtil, including all of the command line parameters.
ACDeployUtil /?
Default [/default]
Automatically detects the current configuration and updates it with the default settings.
ACDeployUtil /default
Table E-1 lists the default settings depending on the detected Kofax Capture configuration.
Table E-1. Default Ascent Deployment Settings Detected Available Input Default Values Configuration Arguments Server ServerPath SiteName SiteID StationID ServerPath StationID SiteName SiteID StationID \\{Computer Name}\CaptureSV {Computer Name} 1 {Computer Name} Unchanged {Computer Name} {Computer Name} 1 {Computer Name} Example Values \Network\CaptureSV Computer2 1 Computer2 Computer2 Computer2 1 Computer2
Workstation Standalone
220
Kofax Capture Deployment Utility
ServerPath [/ServerPath:{server path}]

Specifies the location of the server files. This variable does not apply to standalone configurations.
ACDeployUtil /ServerPath:\\Network\AscentData
SiteName [/SiteName:{site name}]

Specifies the SiteName for the new computer. This variable does not apply to workstation configurations.
ACDeployUtil /SiteName:ThisComputer
SiteID [/SiteID:{site ID}]

Specifies the SiteID for the new computer. This variable does not apply to workstation configurations.
ACDeployUtil /SiteID:12
StationID [/StationID:{station ID}]

Specifies the StationID for the new computer. This variable applies to all workstation configurations.
ACDeployUtil /StationID:JohnSmith
Proper Usage
If you call the Kofax Capture Deployment Utility with the "/?" parameter, the valid parameters will display. If you call it without any parameters, the current configuration settings will display. Use both of these to properly reconfigure the Kofax Capture installation on the new computer.
Error Messages
If the utility fails to reconfigure the Kofax Capture installation, an error message is displayed explaining the problem.
221
Appendix E
Unsupported Installation Configurations

The Kofax Capture Deployment Utility cannot reconfigure the following installation configurations. High Availability Kofax Capture Network Server (KCN Server) Xtrata Kofax Capture Import Connector - Email
222
Appendix F
Kofax Capture Database Management Requirements
Introduction
This chapter provides information about Kofax Capture database management requirements, including supported database management systems, operating systems, and settings.
Supported Database Management Systems

The list below shows the database management systems certified for use with Kofax Capture server files and software. Microsoft SQL Server 2000 (Version 8), 2005, and 2005 64-bit Oracle Database 10g Release 2 IBM DB2 Version 9.1.2
223
Appendix F
Configuration Requirements
This section contains information on a number of Kofax Capture database management system configuration requirements.

The list below shows the supported operating systems for database management systems used with Kofax Capture. This list represents the minimum requirement for each operating system family and edition. This list does not specify each version and service pack available, only the minimum requirement. Operating systems marked as certified represent those which have been explicitly tested against Kofax Capture functionality.
Operating System SQL Server Windows 2000 Server Windows Server 2003 R2 Windows Server 2003 64-bit Oracle Sun Solaris 10 on Sparc Server Red Hat Enterprise Linux 4 AS Windows Server 2003 R2 IBM DB2 IBM AIX 5L Version 5.3 on IBM System p Windows Server 2003 R2 Red Hat Enterprise Linux 4 AS Certified
224
Note Visit the Kofax Web site support page at www.kofax.com to check for any updates to the supported operating systems for database management systems used with Kofax Capture 8.0.
License Requirements
SQL Server Enterprise Edition, Oracle, and IBM DB2 require a Kofax Capture Enterprise License or Evaluation License.
Database Client Software

Kofax Capture requires the use of Microsoft .NET data providers for Oracle and IBM DB2 database management systems. The Microsoft .NET data providers for Oracle and IBM DB2 are installed by the client software on each workstation. Following are the versions of the client software that are supported: Oracle ODAC 10.2.0.2.21 IBM DB2 Client V9.1 Fix Pack 2 or higher
Database Settings
This section contains required configuration settings for Oracle and IBM DB2 databases. Microsoft .NET 2.0 Framework Requirement Both Oracle and IBM DB2 database configurations require the Microsoft .NET 2.0 framework. Kofax Capture automatically installs the .NET 2.0 framework. If you plan to install the Oracle or DB2 data provider after installing Kofax Capture, you can just install either data provider. If you plan to install the Oracle or DB2 data provider before installing Kofax Capture, and the system does not already have .NET 2.0 framework installed, you must first install the .NET 2.0 framework. You can then install Kofax Capture at any time thereafter. Oracle You must create an empty database schema in Oracle where the Kofax Capture information will be stored. The user name provided at installation must have this
225
Appendix F
database schema set as the default schema for the user. The user must also have rights to create objects in that schema. IBM DB2 The user name provided at installation must have a default database schema that is empty. The user must also have rights to create objects in that schema. For IBM DB2 installations running on Windows, the database must be set up as a Unicode database prior to installing Kofax Capture. The IBM DB2 database must be configured prior to installing Kofax Capture. The following list specifies these configuration settings. Unicode database Application control heap size must be at least 768 pages At least one buffer pool with a page size of at least 8K At least one regular table space with a page size of at least 8K At least one system temporary table space with a page size of at least 8K
Database Installation
As you proceed through the Kofax Capture server, standalone, or KCNS remote site installation, the Database Configuration dialog box will display. This dialog box will not display during an upgrade. Note If you are performing an upgrade and want to change your Kofax Capture database configuration, use the Database Utility application (DBUtil.exe) after the upgrade is complete. See the online Help for more information about the Database Utility application. From the Database Configuration dialog box, you can select which database configuration to use with Kofax Capture. Standard is the default selection, in which case the Standard database, SQL Server 2005 Express Edition will be installed. The other options are SQL Server, Oracle, and IBM DB2. Note Oracle and IBM DB2 are enabled for selection only if the respective data provider is installed and a Kofax Capture Enterprise license is activated. If you select an option other than Standard, SQL Server 2005 Express Edition will not be installed. As you continue through the installation, your Kofax Capture license
226
will be activated and the Database Utility will display. You can then configure the database option that you selected at the start of the installation. If the database is not successfully configured, you will be unable to use Kofax Capture. If you want to use the Standard database even though you selected another option during the initial installation, you must manually install SQL Server 2005 Express Edition as follows. To install SQL Server 2005 Express Edition 1 2 3 4 5 Insert your Kofax Capture 8.0 installation CD 1 into the CD drive. From the Windows taskbar, select Start | Run. In Open, type the path of the Setup.exe file you want to open, or click Browse to locate it. In the Open box, add the /InstallDB option. For example:
E:\Kofax Capture\Setup.exe /InstallDB
Follow the instructions on your screen to install. When the installation is completed, the instance name will be server\ascentcapture, where server is the name of the computer where Kofax Capture is installed.
Note SQL Server 2005 Express Edition always installs as a named instance.
227
Appendix F
228
Appendix G
Monitoring Kofax Capture Services
Kofax Capture provides a solution for remote, real-time monitoring of an installation. This chapter describes how to install, enable, and configure the Kofax Capture monitoring solution which uses Simple Network Management Protocol (SNMP). It also describes how to start and use the provided sample monitoring application.
Kofax Capture Monitoring Requirements

The following lists the network and licensing requirements for installing and using the monitoring feature.
Network Requirements
The Kofax Capture monitoring feature uses SNMP as the underlying communication protocol. SNMP uses 161/udp and 162/udp.
Licensing Requirements
The Kofax Capture monitoring feature requires one of the following licenses: Enterprise Evaluation Temporary
229
Appendix G
Installed Components
The typical Kofax Capture installation process installs the following monitoring related files to the executable directory.
Table G-1. Installed Monitoring Components Filename SnmpExtensionAgent.dll Description The extension agent provides the interface and a database for the information that is used to monitor network devices and processes that are using SNMP. It collects and returns information as requested by a management system. At SNMP service startup time, the SNMP service (Snmp.dll) invokes the appropriate extension-agent DLL, which in turn implements the appropriate MIB (Management Information Base). WMI schema This is a Windows service that exposes Capture site information to SNMP. This includes information about the configured queues, the site ID, site name, and site GUID. The provided sample monitoring application.
WmiProvider.dll, WmiProviderCOM.dll SiteMonitorService.exe
Monitor.exe
Installing the Monitoring Feature

An administrator must initially execute a command script to install the key monitoring components. To install the monitoring feature, run the following command script from the Capture executable directory: Install_Monitoring.cmd Note This step is required to install the monitoring feature, but is not required for the normal operation of Kofax Capture.
230
The Install_Monitoring command script performs the following: Attempts to programmatically install the Windows SNMP service. This process may prompt you for a Windows CD to complete the installation. See Configuring the SNMP Service on page n for more information. Installs the extension agent (SnmpExtensionAgent.dll). Installs the WMI schema (WmiProvider.dll and WmiProviderCOM.dll). Updates the ACConfig.xml configuration file. Optionally installs the site monitor service (SiteMonitorService.dll). You will be prompted to install this service. If you decline, you can install it later using InstallUtil.exe. Verification of Installed Components and License The install process checks to see if the Windows SNMP service is installed and Capture is configured with an Enterprise, Temporary, or Evaluation license. If the service is not installed or the appropriate license is not found, an error dialog box displays. You can suppress error dialog boxes using the /unattended switch with InstallUtil.exe. Site Monitor Service Credentials If you choose to install the site monitor service (SiteMonitorService.exe) during the initial Monitoring feature installation (Install_Monitor.cmd script), it prompts you to enter credentials to use the service. To continue, enter a valid user name and password.
Configuring the SNMP Service

After installing the monitoring feature, you must configure the SNMP service. 1 Display the property dialog for the SNMP service (Start | Programs | Administrative Tools | Component Services | Right-click SNMP service | Properties). Select the Security tab. The SNMP Service Properties dialog box will look similar to the following:
231
Appendix G
Figure G-1. SNMP Service Properties Dialog Box
3 4 5 6
On the Security tab, select the Send authentication trap check box. On the Security tab, select the Accept SNMP packets from any host option. Click OK. Restart the SNMP service
For more information about configuring the SNMP service, see the Microsoft documentation.
Separate Site Monitor Service Installation

If you chose not to install the site monitor service (SiteMonitorService.exe) during the initial Monitoring feature installation (Install_Monitor.cmd script), you can install it later using the InstallUtil.exe utility. Site Monitor Service Credentials When this service is installed, it prompts you to enter credentials to use the service. You can enter a valid user name and password.
232
You can also supply valid credentials using the /username and /password switches to InstallUtil.exe. When calling InstallUtil.exe, the credentials parameters must be specified before the assembly name. For example:
InstallUtil.exe /username=Jsmith /password=Q8642Z SiteMonitorService.exe
License Verification The site monitor service installation also checks to see if Kofax Capture is configured with an Enterprise, Temporary, or Evaluation license. If the appropriate license is not found, an error dialog box displays. You can suppress any dialog boxes using the /unattended switch with InstallUtil.exe.
Sample Monitoring Application

Kofax Capture includes a sample monitoring application that monitors Kofax Capture services and displays their status. You can use the application as is or as a springboard for your custom monitoring application. The sample application is written in Visual Basic .NET. The provided VB.NET project contains all of the source and components necessary to build the application and is located in the following folder.
Kofax\Capture\Source\VB.Net Samples\Monitor
Note For a client/server installation, this folder is located in the CaptureSV folder. The SNMP MIB is located in the same folder as the sample application. Note The sample application is not 508 compliant.
Starting the Sample Monitoring Application

You can start the sample monitoring application from the command line and specify which hosts you want to poll. Specifying the Default List of Hosts To poll the default list of Kofax Capture hosts in the ACConfig.xml file, run the application with no arguments:
233
Appendix G
C:\> MONITOR.EXE
If Kofax Capture is not installed, the application runs however the host list and activity list will be empty. Specifying a List of Hosts You can also specify the hosts that you want the sample monitoring application to poll by listing them in an XML configuration file and specifying it as a command line argument. The syntax is:
C:\> MONITOR.EXE [<host configuration file>]
The host configuration file is an XML file that specifies a list of host servers. This is required if running the sample application on a machine where Kofax Capture is not present. The XML file should contain Workstation elements with Host attributes for each station that you want to monitor, as shown below.
<Workstations> <Workstation Host=SystemName"/> </Workstations>
234
Index
A
ACConfig.xml, 70, 74, 171 ACLicSrvCfg.exe, 71 Administrative data, 102 Adrenaline hardware installation, 43 support, 20 Anonymous access, 139, 164, 166 user account, 139, 140, 166 Automatic batch recovery, 67 Automatic password synchronization, 167 specify during installation, 140 UNC support, 124 user account access, 127 Cache folder access, 118 Capture virtual directory automatic password synchronization, 167 IIS password control, 167 Central site deleting, 101 switching, 98 Citrix, 21 Cluster file share folder, 70 Configurator scanner, 20 Configuring backup license server, 71 NTFS security settings, 169 Websphere, 170 Converting batches, 155 Custom modules, 125 configuration data, 97 considerations, 35
B
Backing up Microsoft SQL Server 2005 Express Edition, 207 Batch class import and export, 103 Batches, converting, 155 Browser support, 19 Business continuity, 77
C
Cab files, 143, 150 Cache folder, 73 adding locations, 146 affinity, 128, 146 and Local System account, 137 anonymous account access, 129 configuration options, 127 disk space required, 119 for WebSphere, 171 in multiple locations, 128 network access, 119
D
Data recovery, 78 substitution, 94 Database management components, 18 license requirements, 225 requirements, 223 settings, 225 supported database systems, 223 supported operating systems, 224 Database support, 18 DBUtil.exe, 70
235
Index
Deployment descriptor, 173 Deployment modes, 34 Development environment support, 19 Disabling impersonation, 168 Disaster recovery backup and restore, 88 business continuity, 77 data and path substitution, 94 features, 78 overview, 77 replication, 88, 90 restoring batches, 91 setup, 79 shared license, 82 Distributed server, 201 Domain controller, 166
for NTFS, 170 Upload, 170
G
Group file, 175
H
Hardware accelerators and controllers, 20 Hardware keys, 14, 156 at remote sites, 121 High (Isolated) application protection, 163 High availability, 62
I
IBM DB2 .NET 2.0 framework, 225 automatic batch recovery, 68 options, 17 settings, 226 ICR engine, 30 IIS anonymous account, 166 ASP pages, 162 automatic password synchronization, 167 basic authentication, 167 client certificates, 153 configuring, 161 file cache configuration, 168 for NTFS, 169 integrated windows authentication, 168 password control, 167 Upload virtual directory, 163 Importing batch classes, 103 KCNS profiles, 104 user profiles, 106 Installation modes, 33 types, 27
E
Email Import Connector Administration Plug-In, 180 batch class compatibility, 184 batch class configuration, 182 components, 177 configuring, 182 emails per batch, 186 mailboxes, 187 notification templates, 187 outgoing mail server, 186 Service, 178 user profiles, 184 Email notification templates, 187 Enhanced bar code engine, 30 Enterprise installation, 61 Environment variables, 25 Exporting batch classes, 103, 143, 150 KCNS profiles, 104 user profiles, 106
F
File cache impersonation, 168 write permissions, 169 File locations, 28 Folder permissions
K
KCN Server folder permissions, 170 Properties dialog box, 162
236
Index
KCN Server Web site installation, 140 NTFS security settings, 169 KCN Service operating requirements, 120 KCN Web Server client certificates, 153 KCNS profiles import and export, 104 Kofax technical support, xvii training, xvi Web site, xvii Kofax Capture Enterprise, 61
N
Network components, 15 installing from, 48 load balancing, 68, 72 NLB. See network load balancing Novell, 203 NTFS partitions, 25 security settings, 169
O
OCR engine, 30 Operating requirements browser, 19 client operating system, 9 database management components, 18 development environment, 19 distributed server configurations, 201 environment variables, 25 folder access on NTFS, 25 KCN Server, 117 KCN Service, 120 network components, 15 Novell, 203 NTFS security settings, 169 remote sites, 120 server operating system, 5 standalone operating system, 12 Oracle Database .NET 2.0 framework, 225 automatic batch recovery, 68 options, 17 settings, 225
L
License backup, 62 management, 14 server, 70 server failover, 66 Utility, 14, 71 Log on locally permission, 166 Long file names, 203
M
Member server, 166 Microsoft .NET 2.0 framework IBM DB2, 225 Oracle, 225 Microsoft Cluster Services, 66, 69 Modes of deployment, 34 Modes of installation automatic, 33 interactive, 33 Modules running as services, 28 Monitoring installation, 230 installed components, 230 Kofax Capture services, 229 license requirements, 229 sample application, 233 SNMP, 229 suppress dialog boxes, 231 Multiple license servers, 66
P
Password file, 175 Permissions folders, 213 SecurityBoost, 215 SecurityBoost user, 217 upload folder, 170 Port number setting, 142, 151, 165
237
Index
Proxy servers, 124
R
RAID drive, 69 RecoStar Professional upgrade, 30 Related documentation, xv Remote site authentication, 152 converting a site to a, 143, 150 deactivating, 159 release, 111 Resilient system, 64 Restart login mode, 33 Restoring batches, 91 Restoring Microsoft SQL Server 2005 Express Edition, 207 Running modules as services, 28
Software-based licensing configure backup license server, 71 install Kofax Capture server, 40 install standalone workstation, 43 license management, 14 license server failover, 66 Solaris, 171 Source devices, 113 SQL Server, 18, 69, 70 automatic batch recovery, 67 storing batches, 67 SQL Server 2005 Express Edition, 18 Station ID, 29 Substitution custom data, 95 image path, 94 release script setup, 96
S
Sample monitoring application, 233 Saving batch classes, 143, 150 Scanner adapter, 32 configurator, 20 support, 20 Scanner Configuration Utility, 113 Scanner profiles locations, 116, 146 sharing, 116, 146 Security settings anonymous access, 139 central site, 166 write permission, 164 SecurityBoost and Windows 2000, 218 permissions, 215 Server files, 28 software, 28 Shared license, 82 Sharing scanner profiles, 116, 146 Site ID, 29 Site name, 29 SNMP, 229 Softbridge Basic Language, 20
T
Technical support, xvii Templates for email notification, 187 Terminal servers, 21 Training, xvi Types of installations, 27
U
UNC paths, 28 Uninstalling Kofax Capture, 59 Upgrading Ascent Capture at remote site, 159 central site, 155 Upload Properties dialog box, 163 Upload virtual directory required properties, 163 User profiles import and export, 106
V
Virtual directories KCN Server, 167 Upload, 163, 167 VirtualReScan scanner support, 20
238
Index
Visual Basic, 19 Visual Basic .NET, 20 Visual C++, 19 VRS driver installation, 47 reinstall, 54 repair, 54
W
Web farm, 68, 71 optimizing, 74 support, 68 WebSphere not supported, 72 Web Server hardware requirements, 119 system requirements, 119 web.xml, 173 WebSphere basic authentication, 174 configuring, 170 file cache, 171 installing server components, 172 Workflow agent considerations, 35
239
Index
240

Kofax Installation Guide

Hochgeladen von

Dokumentinformationen

Originalbeschreibung:

Originaltitel

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

Kofax Installation Guide

Hochgeladen von

Copyright:

Verfügbare Formate

KOFAX

Kofax Capture 8 Installation Guide

Kofax Capture 8 Installation Guide

Kofax Capture 8 Installation Guide

Kofax Capture 8 Installation Guide

Kofax Capture 8 Installation Guide

Kofax Capture 8 Installation Guide

Kofax Capture 8 Installation Guide

Kofax Capture 8 Installation Guide

Kofax Capture 8 Installation Guide

Kofax Capture 8 Installation Guide

Kofax Capture 8 Installation Guide

Kofax Capture 8 Installation Guide

How to Use This Guide

Kofax Capture 8 Installation Guide

How to Use This Guide

Kofax Capture 8 Installation Guide

How to Use This Guide

Kofax Technical Support

Kofax Capture 8 Installation Guide

How to Use This Guide

Kofax Capture 8 Installation Guide

Kofax Capture 8 Installation Guide

Kofax Capture 8 Installation Guide

Kofax Capture Operating Requirements

Server System Requirements

Kofax Capture 8 Installation Guide

Minimum Hardware Requirements

Kofax Capture 8 Installation Guide

Kofax Capture Operating Requirements

Supported Operating Systems

Kofax Capture 8 Installation Guide

Required Windows Service

Kofax Capture 8 Installation Guide

Kofax Capture Operating Requirements

Client System Requirements

Minimum Hardware Requirements

Display: Parallel port: USB port: Printer: NIC:

Kofax Capture 8 Installation Guide

Recommended Hardware Requirements

Display: Parallel port: USB port: Printer: NIC:

Kofax Capture 8 Installation Guide

Kofax Capture Operating Requirements

Supported Operating Systems

Kofax Capture 8 Installation Guide

Required Windows Service

Kofax Capture 8 Installation Guide

Kofax Capture Operating Requirements

Standalone System Requirements

Minimum Hardware Requirements

Display: Parallel port: USB port:

Kofax Capture 8 Installation Guide

Recommended Hardware Requirements

Display: Parallel port: USB port:

Certified Operating Systems

Kofax Capture 8 Installation Guide

Kofax Capture Operating Requirements

Kofax Capture 8 Installation Guide

Required Windows Service

Kofax Capture License Management

Kofax Capture 8 Installation Guide

Kofax Capture Operating Requirements