KofaxInstallationGuide

KOFAXCapture Installation Guide 8 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 Kofax Capture 8 Installation Guide 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 Kofax Capture 8 Installation Guide v . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Automatic Batch Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 License Server Failover . . . . . . . . . . . . . . . . . 62 High Availability Essentials . . . . . 73 Configure KCN Server Cache Folders . . . . . . . . . . . . . . . . . 80 Central Site Setup . . . . . . . . . . . . . . . . . . 79 Enterprise Setup . . . . . . . . . . . . . . . . . . . . 77 Data Recovery . . . . . . . . . . . . . . . . . . . 63 Common Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 What is High Availability? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Business Continuity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 High Availability Support . . . . . . . . . . . . . . . . . .77 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Step 1: Install and Configure Kofax Capture in a Microsoft Cluster Server Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . and Restoring Batches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Step 2: Set Up One or More Backup License Servers . . . . . . . . . . . . 68 Configuring Kofax Capture for High Availability . . . . . . . . . . . . . . . . . . . . 64 Microsoft Cluster Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Step 3: Set up your KCN Server Web Farm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Site Administrator Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Setting Up for Disaster Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Enable Additional Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Install Web Server Components on the Web Servers . . . . . . . . . . . . . . . . . . . . . . . 80 Backing Up. . . . . . . 63 What Makes Kofax Capture Resilient? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 vi Kofax Capture 8 Installation Guide . . . . . . . . . . 67 KCN Server Web Farm Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Features . . . . . . . . . . . . 79 Shared and Backup Licensing Support for Disaster Recovery . . . . . . . . . . . . . . . . . . . . . . . . . 77 Interruption of Critical Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Terminal Services and Citrix Support . . . . . . . . . .61 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Kofax Capture and High Availability . . . 74 6 Disaster Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 High Availability for Smaller Installations using Microsoft Cluster Server . . . . . . . . . . . . . . . . . . . . . . 71 Enable the First Service . . . . . . . . . . . . . . Replicating. . . . . . . . . . . . . . . . . . . . . . . . . .Contents 5 Installing Kofax Capture Enterprise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Backup Licensing Option . . 61 WebSphere Support . . . . . . . . . . . . . . 61 Multiple Instance Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Optimize Your Web Farm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Restoring Batches Using the KcnsRestoreBatches Command Line Utility . . . . . . . . . . . Data and Path Substitution . . . . . . . . . . . . . Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Replicating. . . . . . . . . . . . . . . . 98 Command Line Parameters . . . . . . . Backup Requires Remote Site Upgrade . . . . Customization . Operations . . . . . Backup License Server Support for Disaster Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . Backing Up. . . . . . . . . . . . . . . . . Deleting a Central Site . . . . . . . . . . . . . . .Contents Alternate Site Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Switching to a New Primary Central Site . . . . 97 Switching to a New Primary Central Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Network Considerations . . . . . . . . . . . . . . . . . . . . Remove and Add Release Script to Apply Edits . . . . . . . . . . . . . Custom Data Substitution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . and Restoring Batches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Data Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Up Automatic Batch Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Shared License Server Support for Disaster Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Error Codes . . . . . . . . . . . . . . . . . . Command Line Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Backup and Shared License Server Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration . . . Substitution Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Kofax Capture 8 Installation Guide vii . . . . . . . Transferring Custom Module Configuration Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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 . . . . Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Multiple Versions of Batch Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting and Importing Administrative Data . . . . . . . . . . . . . . . . . . . . . . Replication . . . . . . . . . . . . . . . . . . . . . . Image Path Substitution . . . . . . . . . . . . . . . . . Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Release Script Setup Substitution . . . . . . . Optional Advanced Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling and Configuring Batch Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Customizing Workflow Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Administrative Data Export and Import Use Case Recommendations . . . . . . . .117 KCN Server Components . . 120 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Exported and Imported Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 If Release Fails at a Remote Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Remote Sites . . . . . . . . . . . . . . . . . . . 118 Web Server Operating Requirements . . . . . . . . . . . . . . . . 108 Importing Administrative Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 User Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Exporting Administrative Data . . . . . 109 Recommendations . . . . 101 Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Scanner Profile Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Command Line Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 Transfer Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Central Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Sharing Scanner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 KCN Service Operating Requirements . . 118 Minimum Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . 106 Not Exported or Imported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Releasing at Remote Sites . . . . . . . . . . . . .Contents Deleting a Central Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Exported and Imported Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 8 Kofax Capture Network Server Operating Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 Minimum Hardware Requirements . . . . . . . . . . . . . . . . . . . . . 119 Recommended Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 KCNS Profiles . 120 Remote Site Station Requirements . . . . . . 112 7 Setting Up Source Devices . . . . . . . . . . . 109 Reinstalling an Alternate Central Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113 Configuring a Source Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 viii Kofax Capture 8 Installation Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Batch Classes . . . . . . . . . . . . . . . . . 102 Exporting and Importing Administrative Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Exported and Imported Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Contents System Requirements . . . . . . Decisions Before Installing KCN Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Proxy Server Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing KCN Web Server Components on IIS . . . . . . . . Step 5: Convert Kofax Capture Remote Installations to Remote Sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 Setting Up Your Environment . . . . . . . . . . . . . . . . . KCN Server Anonymous User Account . . . . . . . . Privileges and Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 9 Planning Your Kofax Capture Network Server Installation. . . . . . . . . . . . . . . . . . . . General Considerations . . . . . . . . . . . . . KCN Server Check Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . KCN Server Software Component Configurations . . . . . . . . . Enabling Additional KCN Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UNC Support . . . . . . . . . . . . . . . . . 133 KCN Server Installation Steps . . . . . . . . . . . . . . . . . . Planning Your Installation . . . . . . . . . . Web Server Port Numbers . . . . . . . High Availability Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . KCN Service (“Log on as”) User Account . . . . . . . . . . . . . Step 2: Enable the KCN Service at the Central Site . . . . . . . Web Server Software Location and the Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Web Server Port Number . Step 1: Check Your Environment at the Central Site . . . . . . . . . . . File Cache Folder Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Kofax Capture Check Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Remote Site Name . . . . . . . Setting Up Remote Site Profiles . . . . . . . . . Central Site Configuration Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 4: Install KCN Server Remote Sites . . . . . . . . . . . . . . . . . . . . . . . . . 133 134 134 134 136 138 139 142 142 144 144 145 145 146 146 148 Kofax Capture 8 Installation Guide ix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Additional File Cache Folder Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 3: To Install the KCN Web Server Components . . . . . . . . . . . . . . . . . . Sharing Scanner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Custom Module and Workflow Agent Support Considerations . . . . . . . KCN Service Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Assigning Remote Site Profiles to Remote Sites . 123 123 123 124 124 125 125 126 126 126 127 127 128 128 129 130 131 132 10 Installing Kofax Capture Network Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 KCN Server License Requirements . . . . . . . . . . . . . . . . . . . . . 161 KCN Server Virtual Directory Properties . . . . . . . . . 160 11 Web Server Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Sharing Scanner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Upgrading/Updating . . . . . . . . . 169 NTFS Security Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 KCN Server Installation Folder Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 Setting Your IIS Port Configuration . 163 Adding or Editing File Cache Folder Locations . 166 Anonymous User Account . . . . . . . . . . . . . . . 158 Upgrading Your Remote Sites . . . . . . . . . . . . . . . . . 168 Configuring File Cache Write Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Configuring a Client Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 IIS Authentication Configuration . 159 Uninstalling KCN Server on IIS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 Disabling Impersonation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Deactivating a Remote Site . . . . . 149 Stopping the KCN Service . . . . . . . . . . . . 154 Converting Batches From Previous Releases . . . . . . 156 Step 4: Upgrade Ascent Capture Internet Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 Integrated Windows Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Configuring Remote Site Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Remote Site Configuration Tasks . . . . . . . . . 159 Step 2: Upgrade Your Ascent Capture Software at Your Remote Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161 IIS Web Server . . . . . . . . . . . . . . . 159 Uninstalling KCN Server Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 x Kofax Capture 8 Installation Guide . . . . . . . . . . . . . . . . . . . 150 Converting a Remote Installation to a Remote Site . . . . . . . . . . . . . 166 Basic Authentication . . . . . . . . 157 Step 5: Restart the Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 Upgrading Your Central Site . . . . . . . . 160 Uninstalling KCN Server on WebSphere . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Starting the KCN Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Specifying the Web Server URL .Contents Disabling the KCN Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Activating the RSA . . . . . . . . . . . . . . . . . . 162 ACIUpload Virtual Directory Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 Step 1: Process All Batches at the Remote Site and Upload Them . . . . 155 Step 2: Upgrade Ascent Capture and Republish Your Batch Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 IIS and File Cache Permissions Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 Step 3: Enable the KCN Service . . . . . . . . . 155 Step 1: Stop the Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 3: Configure User Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 WebSphere . . . . . . . . . . . . . Initiating Automatic Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Uninstalling KCN Server Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure Basic Authentication . . . . . . .Email . . . . . . . . . . . . . . . . . . 189 Automatic Installations . . . . . . . . . . . . . . . . . . . . . 178 Installing the Kofax Capture Import Connector . . . . . . . . . . . . . . . . . . . . . . . . . 170 ACIUpload Folder Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Types of Automatic Installations . . . . . . . . . . . . . . . . . . . . . . . . . 180 Upgrading From Earlier Versions . . . . . . . . . . . . . . Step 6: Set Up the Outgoing Mail Server . . . . . . . . . . . . . . . . Step 9: Add One or More Mailboxes . . . . . . . . . . . . . . . . . . . . . . . . Initialization File Elements . . . . . . . . . . . . . . . . . . . . 189 189 190 190 190 191 191 192 193 194 194 Kofax Capture 8 Installation Guide xi . . . . . . . . . . . A 182 182 184 184 184 185 185 186 187 187 Automatic Installations. . . . . . . . . . . . . . . . . . . . . . . . . . 182 Configuring Kofax Capture Import Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 4: Specify a User Profile . . . . . .Email . . . . . . . . . Step 1: Create a Cache Folder . . . . . . . . . . . . .Contents Logs Folder Permissions . . . . . . . . . . . . . . . . . . . . . . . Step 1: Configure Kofax Capture Batch Classes . . . . . . . . . . . . . . . Using Initialization Files . . . . . . Step 5: Configure Web Server . . . . . . . . . . .Administration Plug-In . . . . . . . . . . Step 2: Edit ACConfig. . . . . . . . . . . . . . . Install KCN Server Components on WebSphere . . . . . . . . . . . . . . . Step 6. . . . . The [Main] Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Automatic Installation Options . . . . . . . . . . . . . . . . . Step 5: Set Up Email Notifications . Step 4: Edit KCN Server Deployment Descriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 7: Specify Number of Emails in Each Batch .Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 Installing Kofax Capture Import Connector . . . . . . . . . . . . . . . . . . 170 171 171 171 172 173 174 174 175 12 Installing and Configuring Kofax Capture Import Connector . . . . . . . . . . . . . . . . .Email . . . . . . . . . . . . . . . Step 8: Customize Email Notification Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The [Path] Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 3: Install KCN Server Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Email . . . . . . . . . . . . . . . . . . . . . Assigning Values in the Initialization File . . . . . . . . . . . . . . . . . . . . Deploying Automatic Installations . . The [SystemFiles] Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step 2: Verify Batch Class Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204 Upgrading Ascent Capture 6. . . . .x . . . . . . .0 Microsoft SQL Server 2005 Express Edition Database . . . . . . . . . . . . . . . . . . . .x or 7. . . . . . . . . . . . . 208 Backing Up the Ascent Capture (version 6. . . . . . . . . . . . . . . . . . . . 204 Updating an Existing Distributed Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 B Setting Up Distributed Server Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Recommended Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .207 Standalone Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Upgrading or Updating Distributed Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 Registry Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 Client/Server Installations . . . .0 Microsoft SQL Server 2005 Express Edition Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 Standalone Required Permissions . . . . . . . . . . . . . . . . 202 System Requirements for Server Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .x) MSDE Database . . . . . . . . . . . . . . . . . . .x or 7. . . . . . . . . . . . . . . .0 Microsoft SQL Server 2005 Express Edition Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 The [ACIS] Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .x) MSDE Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .0 Microsoft SQL Server 2005 Express Edition Database . . . . . . . . . . 208 Restoring the Ascent Capture (version 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .201 Server System Requirements for Server Software . . . . . . . . . . . . . . .x or 7. . . 211 D Required Folder Permissions . . . .x or 7. . . . . . . . . 210 Restoring the Ascent Capture (version 6. . . . . . . . . . . 210 Backing Up the Kofax Capture 8. . . . . . . . . 211 Restoring the Kofax Capture 8. . . . . . . 215 Minimum Permissions for the Operator . . . . . . 210 Backing Up the Ascent Capture (version 6. . . . . . . . . 195 The [Hardware Information] Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 KCN Server Required Permissions . . . 203 Novell NetWare Limitations . . . . . . . . . . .x) MSDE Database . . . . . . . . . . . . . . . . . . . . . . . . . .Contents The [Identification] Element . 202 Minimum Hardware Requirements . . . . . . . . . . . . . 214 SecurityBoost Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 Backing Up the Kofax Capture 8. . . . . . . . .x or 7. . . . . . . . . . . . . . . . . . . . . . . . . .213 Client/Server Required Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .x) MSDE Database . . . 197 The [SecurityBoost] Element . . . . . . . . . . . . . . . . . . . . . . . 209 Restoring the Kofax Capture 8. . . . . . . . . . . . 205 C Backing Up and Restoring Your Standard Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Distributed Installation . . . . . . . . . . . . . . . . 215 xii Kofax Capture 8 Installation Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 The [Database] Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Database Client Software . . . . . . . . Microsoft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Proper Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 G Monitoring Kofax Capture Services . . . . . . . . . . . . . . . . . . . . . . . 229 Installed Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230 Verification of Installed Components and License . 223 Supported Database Management Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 Kofax Capture 8 Installation Guide xiii . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Usage [/?] . . . . . . . . . . . . . . 219 Kofax Capture Deployment Utility Process Overview . . . . . . . . . . . . . . . . . . . . . . . . 230 Installing the Monitoring Feature . . . . . . . . . . . 224 224 225 225 225 225 225 226 Database Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Unsupported Installation Configurations . . . . . 217 SecurityBoost and Windows 2000 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F 220 220 220 220 221 221 221 221 221 221 222 Kofax Capture Database Management Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SiteName [/SiteName:{site name}] . . . . . . . . 223 Configuration Requirements . . . . . . . . . . . . . . . . . . . . . . Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . License Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 Licensing Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Contents Minimum Permissions for the SecurityBoost User . . . . . . . 229 Kofax Capture Monitoring Requirements . . . . .0 Framework Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IBM DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . StationID [/StationID:{station ID}] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 E Kofax Capture Deployment Utility . . . . Database Settings . . . . . . . . . . . . . . . . . . . 219 Command Line Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SiteID [/SiteID:{site ID}] . . . . . . . . . . . . . . . . . . . . . . . . . .NET 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supported Operating Systems . . . . . . . . . . . . . . . . . Default [/default] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 Introduction . . . . . . . . . . . . . . . . . . . . . . . . ServerPath [/ServerPath:{server path}] . . . . . 217 Permissions When Using the Scan and Release Modules . . . . . . . . . . . . . . . . . . . . . . . . . Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 Network Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . No Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 Specifying the Default List of Hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 Specifying a List of Hosts . . . . . . . . . . . . . . . . . . 233 Sample Monitoring Application . . 233 Starting the Sample Monitoring Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .235 xiv Kofax Capture 8 Installation Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 Site Monitor Service Credentials . . . . . . . . . . . . . . . . . . . 231 Configuring the SNMP Service . 231 Separate Site Monitor Service Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Contents Site Monitor Service Credentials . . . . . . . . . . . . . . . . . . . . . 234 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 License Verification . . . . . . . applications. Kofax Capture Developer’s Guide The Kofax Capture Developer’s Guide provides guidance information regarding why you would want to customize Kofax Capture and instructions to do so. It also assumes that.0 includes the following documentation.How to Use This Guide Introduction This guide contains essential information about installing Kofax Capture and Kofax Capture Network Server (KCN Server). Several examples and code segments are provided to demonstrate how to create custom panels. modules. menus. Web servers and your Web server software. Related Documentation In addition to this Kofax Capture Installation Guide. describes basic concepts about document/data capture and Kofax Capture processing. and scripts to enhance Kofax Capture processing. your network configuration. Kofax Capture Getting Started Guide This guide introduces the various modules and utilities provided with Kofax Capture. Kofax Capture 8. or who need a description of the installation procedures and requirements. you have a thorough understanding of the Internet. This guide assumes that you have a thorough understanding of Windows standards. workflow agents. and Kofax Capture. This guide is for system administrators and developers who are installing Kofax Capture or KCN Server. and interfaces. if you are installing KCN Server. Kofax Capture 8 Installation Guide xv . and introduces the components and major features of KCN Server. or select Help | Kofax Capture Help Topics from the menu bar to display the main Help topic for the module. Quick Reference Cards The set of quick reference cards provides abbreviated steps for performing common tasks for several Kofax Capture modules.How to Use This Guide Kofax Capture Online Help Kofax Capture online Help provides online assistance for system administrators and operators alike. You should read the release notes carefully. The API Reference Guide is designed to be used with the Kofax Capture Developer’s Guide as a primary resource for customizing Kofax Capture. select Start | Programs | Kofax Capture 8. as they contain information that may not be included in other Kofax Capture documentation.com for complete details about the available training options and schedules. 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 dialog box: Click the Help button or press F1 to display context sensitive information for the dialog box.0 | API Reference Guide from the taskbar. Training Kofax offers both classroom and computer-based training that will help you make the most of your Kofax Capture solution. 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.kofax. Visit the Kofax Web site at www. To access the API Reference Guide. • From any module’s toolbar or menu bar: Click the Help button from the toolbar. Release Notes Late-breaking product information is available from release notes. xvi Kofax Capture 8 Installation Guide . and an extensive searchable knowledgebase. 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 Kofax Capture 8 Installation Guide xvii . The Kofax Support pages provide product-specific information. the latest drivers and software patches. Please review the site for details about the available support options. online documentation and user manuals. updates to product release notes (if any). If you need to contact Kofax Technical Support. technical tips. The Kofax Web site also contains information that describes support options for Kofax products.How to Use This Guide Kofax Technical Support For additional technical information about Kofax products. such as current revision levels. visit the Kofax Web site at www.kofax.com and select an appropriate option from the Support menu. How to Use This Guide xviii Kofax Capture 8 Installation Guide . The system will automatically recognize each document in the batch and process it based on characteristics that you have predefined.Chapter 1 Overview Introduction Kofax Capture is designed to support both document capture and data capture in a single application. 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. and provides an extraordinary amount of control over how your documents are processed. quick. With Internet (or intranet) capabilities. decisions. including: • Operating requirements that must be met to successfully install Kofax Capture and KCN Server • Preparations. settings. This guide provides important information about installing and upgrading to Kofax Capture and KCN Server. 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 Kofax Capture 8 Installation Guide 1 . precautions. Both structured and non-structured documents can be scanned in a single batch. The definition process is simple. Kofax Capture workstations can be connected to a central site to assist in the document and data capture process. Chapter 1 2 Kofax Capture 8 Installation Guide . including hardware and system requirements.Chapter 2 Kofax Capture Operating Requirements Introduction This chapter provides information about Kofax Capture operating requirements. Kofax Capture 8 Installation Guide 3 . we strongly suggest that you do not use your server computer for scanning or importing documents. In particular. and recommendations for installing and using Kofax Capture. Note We recommend that you use a dedicated server for Kofax Capture. Server System Requirements This section lists the requirements for installing Kofax Capture on a server station. or equivalent 1 Gbyte or more 1. if you have many image files or a large database. plus 300 Mbytes available on your local C: drive or wherever your operating system is installed. Display: USB port: NIC: 1024 x 768 with 16 bit color. Testing your Kofax Capture processing workload in a test environment is highly recommended. and working space during processing You may need even more disk space. small fonts.3 Gbytes on any local drive. for installation files.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. 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. temporary files. 4 Kofax Capture 8 Installation Guide . only the minimum requirement.kofax.com for updates to the supported operating systems for Kofax Capture 8. This list represents the minimum requirement for each operating system family and edition.Kofax Capture Operating Requirements Supported Operating Systems The list below shows the operating systems supported for use with Kofax Capture server files and software. Although not explicitly tested. Operating systems marked as certified represent those which have been explicitly tested against Kofax Capture functionality. Kofax offers technical support for all supported operating systems. This list does not specify each version and service pack available. 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 Capture 8 Installation Guide 5 .0. 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. the Kofax Capture server files and software should be installed on the same computer. Refer to File Locations on page 28 for more information about Kofax Capture server files and server software. In general. Required Windows Service The Server service must be running before installing Kofax Capture on a server workstation. However. Kofax strongly suggests that you do not use your server computer for scanning or importing documents.Chapter 2 Note Windows Server 2003 does not support scanning with a SCSI card. 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. 6 Kofax Capture 8 Installation Guide . or equivalent 512 Mbytes or more 680 Mbytes on any local drive. 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: Kofax Capture 8 Installation Guide 7 .Kofax Capture Operating Requirements Client System Requirements This section lists the requirements for installing Kofax Capture on a client workstation. plus 300 Mbytes available on your local C: drive or wherever your operating system is installed. for installation files. Minimum Hardware Requirements The following lists the minimum hardware requirements for the Kofax Capture client systems: Processor: System memory: Disk space: Pentium 4 processor. and working space during processing 1024 x 768 with 24 bit color. 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: 8 Kofax Capture 8 Installation Guide . for installation files. small fonts.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. temporary files. plus 300 Mbytes or more available on your local C: drive or wherever your operating system is installed. Kofax Capture Operating Requirements Supported Operating Systems The list below shows the operating systems supported for use with Kofax Capture client workstations. This list does not specify each version and service pack available. Kofax offers technical support for all supported operating systems. This list represents the minimum requirement for each operating system family and edition. only the minimum requirement. 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 Kofax Capture 8 Installation Guide 9 . Operating systems marked as certified represent those which have been explicitly tested against Kofax Capture functionality. Although not explicitly tested. 10 Kofax Capture 8 Installation Guide . Note The use of scanners is not supported with 64-bit systems.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. Windows Server 2003 does not support scanning with a SCSI card.0.com for updates to the supported operating systems for Kofax Capture 8.kofax. In general. Note The use of Adrenaline accelerators is not supported on Windows Server 2003. Required Windows Service The Workstation service must be running before installing Kofax Capture on a client workstation. and working space during processing 1024 x 768 with 16 bit color. temporary files. plus 300 Mbytes available on your local C: drive or wherever your operating system is installed.Kofax Capture Operating Requirements Standalone System Requirements This section lists the requirements for installing Kofax Capture on a standalone workstation. or equivalent 512 Mbytes or more 760 Mbytes on any local drive. for installation files. 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: Kofax Capture 8 Installation Guide 11 . Minimum Hardware Requirements The following lists the minimum hardware requirements for the Kofax Capture standalone systems: Processor: System memory: Disk space: Pentium 4 processor. small fonts. small fonts. or equivalent 1 Gbyte or more 760 Mbytes or more on any local drive. temporary files. 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 Kofax Capture 8 Installation Guide .Chapter 2 Recommended Hardware Requirements The following lists the recommended hardware requirements for the Kofax Capture standalone systems: Processor: System memory: Disk space: Pentium 4 processor. 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. Kofax offers technical support for all supported operating systems. Although not explicitly tested. Operating systems marked as certified represent those which have been explicitly tested against Kofax Capture functionality. for installation files. and working space during processing 1024 x 768 with 24 bit color. plus 300 Mbytes or more available on your local C: drive or wherever your operating system is installed. This list does not specify each version and service pack available. only the minimum requirement. This list represents the minimum requirement for each operating system family and edition. or certified for. Windows Server 2003 does not support scanning with a SCSI card.0. Although Kofax is unaware of any specific limitations on using Windows XP Home with Kofax Capture 8. Kofax Capture 8 Installation Guide 13 . 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. Windows XP Home.0 has not been tested on. In general.Kofax Capture Operating Requirements 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. find article number 182569 in the Microsoft Knowledge Base. and on standalone installations. Since this warning will occur repeatedly during the installation process.Chapter 2 Warning When installing Kofax Capture on Windows Server 2003. activation occurs with your Kofax serial number and product code. Note With the software-based licensing option. After installation. and may cause automatic/silent installations to fail. Do not attempt to edit the registry unless you have the necessary knowledge and experience. Client workstations do not require hardware keys to run Kofax Capture. Configuration Requirements This section contains information on a number of Kofax Capture configuration requirements. For more information on this. you may restore the original settings. These messages appear because Windows Server 2003 uses stricter security defaults than earlier versions of Windows. The key features of the license management scheme are: • Licenses can be delivered and upgraded through the Internet. you may be confronted with a series of warning messages informing you that some files can harm your computer. the hardware key is not required. 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. 14 Kofax Capture 8 Installation Guide . and refer to the “1806 Launching applications and unsafe files” DWORD setting. and for instructions on changing these settings. The rest of the installation and activation process remains the same as licensing with a hardware key. These are the required system configuration settings for Kofax Capture. Required Windows Service The Server service must be running before installing Kofax Capture on a standalone workstation. Damaging the registry may make your system inoperative. Instead. you can temporarily relax the security settings. Activation typically occurs during installation of a Kofax Capture server or standalone station. To use the purchased options on a permanent basis. contact your system administrator or Kofax Certified Solution Provider. but can also occur after installation. the installation may prompt you to attach a hardware key to the server or standalone station. you need to have Internet access if you want to automatically activate your license at that time. but will need to use the Kofax Capture License Utility to activate your licenses after installation. as well as activate new or additional licenses for your system. Prior to installing Kofax Capture. you must use the Kofax Capture License Utility installed with Kofax Capture to activate your licenses after installation. After activation. Refer to the Kofax Capture online Help for details about activating licenses. the installation will contact the Kofax license server to activate the licenses for the options you purchased. Note During Kofax Capture installation on a server or standalone station. the Kofax Capture License Utility allows you to view the status of activated licenses. you will be able to install Kofax Capture. • After Installation: If activation during installation fails. Near the end of the installation process. 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. • During installation: After the Kofax Capture server or standalone files are installed. 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) Kofax Capture 8 Installation Guide 15 . If the station does not have Internet access. you will be able to use your purchased Kofax Capture options for a period of three days. Network Components Kofax Capture requires that the TCP/IP protocol be installed and running in your Windows network configuration settings.Kofax Capture Operating Requirements • Licenses must be activated before you can use Kofax Capture permanently. This standard database ships with Kofax Capture. however you can switch at any time after the upgrade. For upgrades from Ascent Capture 6. The batch catalog is the Kofax Capture database. the logged-in user must have administrative privileges to the local computer. Administrative Privileges Required To install Kofax Capture.Chapter 2 Contact your network administrator or refer to your Microsoft documentation for more information about these components. or where the TCP/IP protocol has been removed or disabled. No option to switch databases is provided during an upgrade. and requires no additional software or configuration. If you attempt to install a standalone version of Kofax Capture on a computer without TCP/IP. you can select the desired database configuration (as listed in this section) at the start of the install process. SQL Server Express Edition will be automatically installed. 16 Kofax Capture 8 Installation Guide . Database Support For new Kofax Capture installations. the installation may fail with an “Unable to Initialize Batch Catalog” error message. Standard Kofax Capture uses the Microsoft SQL Server 2005 Express Edition database.x or 7. Note Not having the TCP/IP protocol may be a problem in standalone installations that have never been connected to the Internet.x. the existing database configuration will be maintained. or a network. You can also switch database configurations at any time after installation. 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. If your current installation is using the Standard (MSDE) database configuration. Note All references to SQL Server in this guide assume SQL Server 2000 with Service Pack 4 or SQL Server 2005 unless otherwise noted. 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. or SQL Server 2005 64-bit if you want to actively administer the database. the database must be configured as a Unicode database prior to installing Kofax Capture.Kofax Capture Operating Requirements SQL Server You can use SQL Server 2000 with Service Pack 4. 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 SQL Server. Oracle You can use Oracle Database if you want to actively administer the database. The user must also have user rights to create objects in that schema. or for scalability and availability. To use IBM DB2. create an empty schema where you want to store Kofax Capture information. or for scalability and availability. or for scalability and availability. Kofax Capture 8 Installation Guide 17 . The user must also have user rights to create objects in that schema. IBM DB2 You can use IBM DB2 if you want to actively administer the database. The user name provided when you installed Kofax Capture must have this schema set as the default schema for that user. Note For IBM DB2 installations running on Windows. To use Oracle Database. SQL Server 2005. See the Kofax Capture Getting Started Guide for more information on switching database configurations. Kofax Capture does not ship with or install Oracle. which is a version of SQL Server. When installing the Kofax Capture server software or a Kofax Capture standalone installation. Note You must use the versions of the Microsoft Data Access Components (MDAC) that shipped and installed with Kofax Capture. Kofax Capture uses SQL Server 2005 Express Edition. or any ODBC-compliant database for the Database Validation feature and for releasing index data to a database. 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 SQL Server is installed in C:\Program Files\MSSQL. Database Validation and Release Support Kofax Capture supports Microsoft Access 2000. Although no known incompatibilities exist with previous 18 Kofax Capture 8 Installation Guide . the required database management components are also installed. Database Management Components For managing batches during processing. Kofax Capture does not ship with or install IBM DB2. usually C:\Program Files. and 2002. If you do. the results will be unpredictable and you may render your SQL Server software inoperable. Kofax Capture does not provide ODBC drivers for target databases. provided Kofax Capture is installed in a folder under the same parent directory as these products. For example.Chapter 2 Refer to Appendix F – Kofax Capture Database Management Requirements on page 223 for information about IBM DB2 requirements. Kofax Capture will install correctly and can coexist with existing installations of SQL Server or MSDE or SQL Server 2005 Express Edition. then the Kofax Capture server software should be installed in a folder such as C:\Program Files\<Kofax Capture installation folder>. Browser Support The online Help for Kofax Capture requires Internet Explorer 6 (or higher) be set as your default browser. 0 with Service Pack 6 Visual Basic .Email on page 177 for information about installing this feature. Refer to Chapter 12 – Installing and Configuring Kofax Capture Import Connector . Development Environment Support Kofax Capture supports the following development languages: • For release and import scripts.0 with Service Pack 6 Visual C++ 6. the installation will resume. the installation will stop and display a warning message indicating that Internet Explorer 6 is not installed. custom modules.Email The Kofax Capture Import Connector . If the browser that you are currently using is a version earlier than Internet Explorer 6. these are not required. While potentially useful.Kofax Capture Operating Requirements versions of Internet Explorer. However. If you choose to use Adobe Acrobat Capture Personal Edition. Kofax Capture Import Connector . be sure to attach the hardware key provided with your Adobe Acrobat Capture software. Other Installation Options This section contains information on a number of Kofax Capture installation options. you may continue to use Adobe Acrobat Capture Cluster Server or Personal Edition version 3. This module allows you to create PDF files from within Kofax Capture. the online Help for Kofax Capture has been certified only with Internet Explorer 6. install or upgrade your browser to Internet Explorer 6 and set it as the default browser for your system. Before using the online Help. After you acknowledge the warning. PDF Generation The Kofax Capture PDF Generator module is included with Kofax Capture.NET version 2005 Kofax Capture 8 Installation Guide 19 . and OCX panels: Visual Basic 6.04 with all Kofax developed release scripts to create PDF files.Email feature has the same operating requirements as Kofax Capture itself. 2. 20 Kofax Capture 8 Installation Guide . VRS. refer to the Kofax web site at www. For a complete description of VRS. VirtualReScan (VRS) Support Kofax Capture 8. and 650i SCSI scanner controllers Note The use of Adrenaline accelerators is not supported on Windows Server 2003. with VRS 3. Note Kofax Capture 8. 650. Using these versions of VRS with Kofax Capture 8. In general. visit the Kofax Web site at www. additional licensing is required to activate VRS for use with Kofax Capture.NET version 2005 • For validation and recognition scripts: Softbridge Basic Language (SBL) 5.0 has not been tested. Refer to the Kofax Capture Help system for information about licensing VRS.com.3 provided with Kofax Capture Visual Basic . and automatically installs. Windows Server 2003 does not support scanning with a SCSI card.kofax.5 or earlier. Adrenaline Support Kofax Capture supports Adrenaline hardware products.com.kofax.0 is not supported.Chapter 2 Visual C# . including: • Adrenaline 850 and 1700 image processing accelerators • Adrenaline 450. Select the Scanner Configurator and follow the instructions presented to you.NET 2005 Scanner Support Kofax Capture supports a wide range of desktop and production-level scanners. or certified. and 3 SCSI models using ISIS drivers • VirtualReScan (VRS) ready scanners For a current list of supported scanners. See the section Step 3: Install VRS Scanner Drivers on page 47 for more information about installing VRS drivers. However.0 includes. including: • High-end SCSI and video models supported by Kofax Adrenaline hardware products • Low-end Group 1. Kofax Capture Operating Requirements Kofax Capture Report Viewer The system requirements for the Report Viewer module are the same as those for Kofax Capture. Kofax KF-Series Boards Support Discontinued Effective with version 5.5, Kofax Capture no longer supports KF-Series boards. These boards are not compatible with the newest drivers shipped with Kofax Capture, so KF-Series boards must be removed from your computer before you install or upgrade to Kofax Capture 8.0. There is no need to uninstall the KF-Series board drivers. Terminal Servers and Citrix Support You can operate Kofax Capture via a Terminal Services or Citrix session. Once logged in to the Terminal Services or Citrix session, Kofax Capture operates as if it were installed on your local computer. However, you should be aware of the following station licensing conditions. Note Citrix supports all Kofax Capture modules except for the Scan module. Supported Version Kofax Capture 8.0 has been certified for use with Citrix Presentation Server 4.5, Enterprise Edition. Running Multiple Modules in a Session Station licenses apply to the session rather than the computer. This allows you to run multiple licensed applications in one session. Licensed applications that are running within the same session will share this same station license. For example, if you are running Recognition Server, Validation, and Quality Control modules at the same time, on the same computer, and in the same Terminal Services or Citrix session, then only one Kofax Capture concurrent station license is required. However, licensed applications that are running within different sessions will not share the same station license. For example, if you are running Recognition Server, Validation, and Quality Control modules at the same time, on the same computer, but each is running in a different Terminal Services or Citrix session, then three Kofax Capture station licenses are required. Kofax Capture 8 Installation Guide 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 Kofax Capture 8 Installation Guide Kofax Capture Operating Requirements Warning Kofax recommends that you disable hyper-threading on the VMware computer to avoid the possibility of intermittent error messages. For more information about running the VMware product in a hyper-threaded environment, please check the VMware Support site. Kofax Capture 8 Installation Guide 23 Chapter 2 24 Kofax Capture 8 Installation Guide 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. Kofax Capture 8 Installation Guide 25 Planning Your Installation There are various ways that you can configure your Kofax Capture installation. Refer to your Windows documentation for additional information. Kofax Capture needs to access the TEMP and TMP folders on the local drive. During installation. 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 8 Installation Guide .Chapter 3 Folder permissions can be set by right-clicking the folder name from Windows Explorer and selecting Properties | Security tab. and then by editing the TEMP and TMP paths in the User Variables list. select System | Advanced tab | Environment Variables). Environment Variables Warning If the TEMP and TMP environment variables are not set up as described below. • The paths for the TEMP and TMP environment variables must not exceed 100 characters. The TEMP and TMP folders must be set up as follows: • The TEMP and TMP environment variables must be defined. The following information can help you make informed decisions. The folder permissions required to install and run Kofax Capture are summarized in Appendix D on page 213. The TEMP and TMP paths can be changed through the Environment Variables display (from the Control Panel. Kofax Capture will not install or run. This is a good choice if you expect to perform all of your scanning and processing. and more. and also enables the server to run Kofax Capture client applications. These include support for Web farms (using Microsoft Network Load Balancing). backup license servers. both the client applications and the server components are installed on the same local computer. including releasing the data and images. 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. In this case. on the same computer at a single location. Refer to Chapter 5 – Kofax Capture 8 Installation Guide 27 . Client/Server Without a Workstation Enabled on the Server In this configuration. Microsoft Cluster Services. For example. only the files required to install or support client workstations are installed on the server. High Availability Installations Regardless of the installation type. but that could take advantage of the power of the server computer. you can elect to take advantage of one or more of Kofax Capture’s High Availability capabilities. such as Recognition Server. you can also install a Kofax Capture client workstation on the server. Standalone In a Standalone configuration. Installation Type You can install Kofax Capture in a standalone or a client/server configuration. you might want to use the server to run a Kofax Capture client application that does not require user input.Planning Your Kofax Capture Installation • Kofax Capture port requirements Planning decisions that you might want to make before using Kofax Capture are: • Database configuration • Security configuration Decisions Prior to Installing Kofax Capture This section covers decisions that you need to make before installing Kofax Capture. In a client/server configuration. However. for client/ server installations. 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. The default location is: C:\Program Files\Kofax\CaptureSS Server Files This includes such items as the client workstation setup program. you can specify a shared folder on the same computer as the server software (strongly recommended). Only components that must run on the server computer are installed to this location. Server Software This includes the Kofax Capture System database (SQL Server 2005 Express Edition). 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. these unattended modules can be configured to start automatically at system startup. 28 Kofax Capture 8 Installation Guide . Kofax PDF Generator.XML. Therefore. unmapped nonUNC drive. For these files. batch classes. without any user intervention. As services.Chapter 3 Installing Kofax Capture Enterprise on page 61 for information about Kofax Capture’s high availability support. Recognition Server. During installation. Remote Synchronization Agent (RSA) and/or the Release modules. the server software must be installed on a local. or a folder on a different computer. This includes Kofax Capture Import Connector . OCR Full Text. 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. and batches. you must specify a UNC path for your Kofax Capture installation folder. also known as the standard database or batch catalog. services do not support mapped network drives. and supporting files used by Kofax Capture to manage the batches. You should choose a name that is meaningful to you. A site can consist of one or more workstations in any of the supported configurations. The station ID can be from 1 to 32 characters. The site name defaults to the computer name.Planning Your Kofax Capture Installation Station and Site Identification You need to determine the names you will use to identify your stations and your sites. The site ID can be from 1 to 4 digits. Site ID This assigns a numeric value to the site. ^ < > ? % Kofax Capture 8 Installation Guide 29 . It can be any combination of letters and numbers. It can be any combination of letters and numbers. It may not include the following characters: ' & “ . You might consider names that reflect the location or functions of the workstations. ( ` / ) = ~ _ \ ! + { @ | } # : . * $ . ( ` / ) = ~ _ \ ! + { @ | } # : . 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. ^ < > ? % The station ID defaults to the computer name. It can be any combination of letters and numbers. For example. * $ . Station ID This assigns an ID to the station. and is used to identify where batches are created or processed. the third client workstation being used for scanning at the Irvine facility of a company might be named IrvineScan3. You should choose a name that is meaningful to you. It may not include the following characters: ' & “ . • If there are automatic index zones of any kind in the document class. 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. The voting feature and AEG Recognition engine can be made available by purchasing an upgrade called “RecoStar Professional. and then a special voting algorithm is used to pick the best results. or bitonal images Note that. you will receive a special hardware key that must be installed on a USB port of the computer running the Recognition Server. it is necessary to defer bar code recognition to the Recognition Server module. Contact your Kofax Certified Solution Provider (CSP) for details about the RecoStar Professional upgrade.and two-dimensional (2-D) bar code types from color. Kofax Capture usually performs bar code recognition within the Scan module. The results from each engine are compared. will be processed by the Recognition Server module. grayscale. • Voting is a recognition method in which two or more recognition engines interpret the same text on a character-by-character basis.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. in the following cases. and offers the following components: • AEG Recognition provides an alternate high performance recognition engine for OCR and ICR processing. the computer running the Recognition Server module must have the appropriate license. 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). all bar codes. and is typically used in conjunction with the voting feature. Optional Enhanced Bar Code Engine You need to determine if you want to upgrade to the Enhanced Bar Code Engine. including page level bar codes. However. depending on the setup parameters.” Once you have purchased this upgrade. If you plan to use the Enhanced Bar Code Engine in these cases. 30 Kofax Capture 8 Installation Guide . if a second license is unavailable. all bar codes will be processed by the Recognition Server module. If you are using this hardware key. 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 1 Requires an Adrenaline 650i or newer model Adrenaline 850 or 1700 that supports the Enhanced Bar Code Engine. Failure to do so will yield unpredictable processing results. but in a client/server configuration. you must shut down all Kofax Capture modules before you attach the Enhanced Bar Code Engine hardware key. Every workstation must have such a card installed to use this feature without implementing one of the other two licensing methods. the values that require the Enhanced Bar Code 2 3 Kofax Capture 8 Installation Guide 31 . In a standalone configuration only one Enhanced Bar Code station license is required. Table 3-1 shows the licensing requirements for various configurations using the Enhanced Bar Code Engine. all bar codes will be processed by the Recognition Server module. a license can only be used by one workstation at a time. Table 3-1. Requires that Enhanced Bar Code be added to your Kofax Capture licensing. In a client/server configuration. The newer model Adrenaline accelerators are marked “EBC” on the outside of the mounting bracket. • If there are any Recognition scripts. Requires that an Enhanced Bar Code hardware key be installed on every workstation. the module will either use a second license or.Planning Your Kofax Capture Installation • If there is more than one type of bar code per document class (including all page level or zonal bar codes). all bar codes will be processed by the Recognition Server module. if a module attempts to use a license while another workstation is using it. • If there is more than one form type. exe file you want to open. type the path of the Setup. From the Windows taskbar. and 8125) Fujitsu ScanRight 4097 VRS Fujitsu ScanRight 4099D VRS Ricoh IS450 VRS When you plan on using one of these scanners. Recommended installation order 1 2 3 VRS for the scanner Adrenaline Image Processing Engine (AIPE) 4. Quality Control.0 (available from the Support pages on the Kofax Web site) Kofax Capture 8. 32 Kofax Capture 8 Installation Guide . you must install Kofax Capture after you install other components. we recommend that you purchase multiple Enhanced Bar Code station licenses. 8100.0 installation CD 1 into the CD drive. you need to obtain one or more VRS station licenses. In Open. Note that Scan. In these cases. and Recognition Server use an Enhanced Bar Code station license while a batch invokes the Enhanced Bar Code Engine. Scanner Considerations The following scanners require that you install Kofax Capture with the /NoVRS option. With VRS. • • • • Böwe Bell + Howell Copiscan 8000 VRS Series (8080. Kofax Capture can repair badly scanned images without the need to physically rescan the documents. the license becomes available to other workstations again when the batch closes. In order to take advantage of VRS. 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. To avoid this condition. select Start | Run. or click Browse to locate it.Chapter 3 Engine will be left blank. 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.0 using the /NoVRS option To install Kofax Capture with the /NoVRS option 1 2 3 Insert your Kofax Capture 8. In this case. However. ini. or values that you provide in an initialization file. Installation Mode You need to determine whether to install Kofax Capture in the interactive mode or the automatic mode. add the /NoVRS option. For your convenience. Automatic installations are described in more detail in Appendix A on page 189.Planning Your Kofax Capture Installation 4 5 In the Open box. It is located in the TEMP folder. to ensure consistency. you will receive the VRS Detected dialog box.exe /NoVRS Follow the instructions on your screen to install. At various points in the installation process. You can then modify and reuse the initialization file for automatic installations. if you want to centrally control your installations. including where to store files. you can choose to have the logon information automatically reused after each logon.ini. This file is called ACInsOut. or if you do not have staff on site to respond to installation prompts. You may want to provide your own initialization file. For example: E:\Kofax\Setup. The automatic installation can use built-in default values. an initialization file is created containing your responses. You should move or rename the file. When this happens. Automatic Mode This mode does not require you to respond to prompts. the computer will have to restart and you will have to log on. it should not be stored as %TEMP%\ACInsOut. Interactive Mode This mode requires you to respond to prompts from the installation. However. As Kofax Capture is installed. Kofax Capture 8 Installation Guide 33 . you can simply dismiss this dialog box by selecting the Continue option and then clicking OK to continue with the installation. as shown below. Note When installing Kofax Capture on workstations that have older versions of the VRS software installed. Restart Login Mode You need to determine how you want to respond to requests for logon information. These ports are: UDP port 1434 TCP ports 1433. These decisions generally do not have to be made before installing. 1434. • Kofax Capture uses port 2424 for managing licenses and volume usage. consult your database or network administrator for port requirements. port 2424 must also be open between the KCN Service(s) and the KCN Web Server. and a dynamically assigned port. These requirements may affect your firewall or other security settings. There are a number of ways that you can deploy Kofax Capture. Oracle. The Standard database configuration (SQL Server 2005 Express Edition) also requires a specific UDP port for name resolution of Named Instances. there are certain decisions that you might want to make before using Kofax Capture to process batches. • • • • 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. Decisions Prior to Using Kofax Capture In planning your Kofax Capture installation. 34 Kofax Capture 8 Installation Guide .Chapter 3 Deployment Methods You need to determine how you want to deploy Kofax Capture. Note If you are using Kofax Capture Network Server (KCN Server). or IBM DB2. 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. Port 2424 must be open between the client and server. • The Kofax Capture server utilizes TCP ports for communication between clients and the server. you can select these options in the Database Utility. You can also find information about SecurityBoost in the online Help. however. Note When user tracking is enabled. To use one of the aforementioned databases to help improve performance. Security Configuration You can use SecurityBoost to protect critical Kofax Capture files. if you plan to enable user tracking. To use SecurityBoost. Oracle Database. or for scalability and availability. you must set minimum system permissions for your operators so that they cannot access critical Kofax Capture files and folders. If you do not install them and you try to use them. Furthermore. You can. use SQL Server. A workflow agent is a custom program that allows custom routing of batches in Kofax Capture. or IBM DB2 if you want to actively administrate the database. install the custom modules and workflow agents after installing Kofax Capture. We recommend that Kofax Capture be the only application installed on the Kofax Capture server computer. Custom Module and Workflow Agent Support Considerations Kofax Capture supports custom modules and workflow agents. Oracle Database. an error message will display. Note Kofax Capture does not ship with or install a full featured version of SQL Server. Oracle Database or IBM DB2 be used as the database for Kofax Capture. You must also create a special SecurityBoost user with permissions that allow access to these files and folders. If you plan to use custom modules and workflow agents. See the section SecurityBoost Permissions on page 215 for more information. it is also recommended that SQL Server. or IBM DB2 (as noted above. Kofax Capture may require large amounts of memory to query or update the database. SQL Server 2005 Express Edition is installed). Kofax Capture 8 Installation Guide 35 .Planning Your Kofax Capture Installation Database Configuration Kofax Capture is installed with SQL Server 2005 Express Edition database components. See the Kofax Capture online Help for more information on custom modules and workflow agents. that module will hang. If the workflow agent attempts to invoke a user interface in certain modules (such as the Recognition Server module. 36 Kofax Capture 8 Installation Guide . when it is running as a service).Chapter 3 Warning Ensure that workflow agents do not display a user interface while batches are being processed through any unattended modules. Depending on the products you have. Note Depending on your equipment and options.Chapter 4 Installing Kofax Capture Introduction This chapter provides step-by-step instructions for installing Kofax Capture.0: • Refer to Chapter 2 – Kofax Capture Operating Requirements on page 3 for information about requirements and recommendations for installation. it may not be necessary to perform all of these steps. 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. nor do they cover every decision you may be asked to make. Start here to install Kofax Capture. Install Adrenaline Hardware. and possible areas of confusion. Instead. the focus is on major milestones. • Refer to Chapter 3 – Planning Your Kofax Capture Installation on page 25 for information about ensuring the installation is smooth and accurate. Note The steps must be followed in the order shown. The instructions do not describe every installation screen you may see. Before you install Kofax Capture 8. it may take approximately 30 minutes to install Kofax Capture. Installing Kofax Capture for the First Time The following is an overview of the major steps for installing Kofax Capture. but not all steps will need to be performed. key decisions. Step 1 Step 2 Install Kofax Capture. Kofax Capture 8 Installation Guide 37 . Each of the major steps is detailed after the overview. so the installation will automatically begin. Insert Kofax Capture installation CD 1 into the CD drive. regardless of which drive you choose for the installation. or wherever your operating system is installed. See Chapter 2 .exe from the CD. you must install Kofax Capture on a server. and 7 for more information.Chapter 4 Step 3 Step 4 Install Scanner Drivers. Perform this step only if you want to install scanner drivers on your workstation. If you have a version of VRS earlier than 3. 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. Note You must have at least 300 Mbytes of free space available on your local C drive. See Appendix A – Automatic Installations for more information. virus detection software.Kofax Capture Operating Requirements on page 3 for more information. and toolbars) that might be running. it will be overwritten by a newer version of VRS. but you will not be able to use the VRS QC Later feature unless you obtain the necessary license. 6. run Autoplay. You can also install Kofax Capture in automatic mode. Install Kofax Capture Network Server. To install Kofax Capture server 1 2 At the server.5 or later installed. Client/Server Installation Before you install Kofax Capture on any client workstations.5. Kofax Capture With VRS If you have VRS version 3. To install KCN Server. The CD supports AutoPlay. you must remove or upgrade VRS before installing Kofax Capture. shut down any applications (including the Control Panel.) 38 Kofax Capture 8 Installation Guide . during the installation process. (If it doesn’t start. see Chapters 5. Step 1: Install Kofax Capture This section covers the steps for installing Kofax Capture. You will still be able to use VRS after the installation. Be sure to read them carefully before proceeding with each step. The default location is C:\Documents and Settings\All Kofax Capture 8 Installation Guide 39 . The default location is C:\Program Files\Kofax\CaptureSS. or a UNC path. As you proceed through the instructions. Figure 4-1. Kofax Capture Main Installation Menu 4 Follow the instructions on your screen to install the software. note the following: • When prompted for the type of installation. non-UNC drive. The method (UNC or mapped drive) that you use here will dictate how your client workstations will be installed. unmapped. choose an installation path that is accessible to all of your client workstations as a permanently mapped. • When prompted for the destination folder for the server files. select Install Kofax Capture for the First Time.Installing Kofax Capture 3 From the main installation menu shown in Figure 4-1. • When prompted for the destination folder for the server software. shared drive. choose a path on a local. select Server. The installation instructions contain additional information that will guide you through the installation process. If activation is successful. you can select which database configuration to use with Kofax Capture. Note At various points in the installation process. follow the on-screen instructions to complete activation with your Kofax serial number and product code. Kofax Capture is fully installed. you will be prompted to attach the appropriate hardware key.Chapter 4 Users\Application Data\Kofax\CaptureSV. • Ensure that the destination path lengths for both the server software and server files do not exceed 100 characters. Oracle. • When prompted for the database configuration. If you are installing with the softwarebased licensing option. SQL Server 2005 Express Edition will not be installed. Instead. SQL Server 2005 Express Edition. • After the software is installed. will be installed. “Standard” is the default selection. the installation will activate the license. do not install a hardware key. in which case the Standard database. dismiss it. • If the New Hardware Key Detected message displays. If you select an option other than “Standard”. The path specified from each workstation must be the same and must be in the same format (UNC path or a mapped drive). you will be prompted to reboot your computer. Note Do not install the server software and the server files to the same folder. The other options are SQL Server. 40 Kofax Capture 8 Installation Guide . After detecting the hardware key. select Automatically Reboot and log in. See Chapter 3 – Planning Your Installation for more information on default installation locations. To have the installation log on for you. and IBM DB2. be sure to use the same user account when logging back on. you will have to restart your system and log on. If you manually log on after each restart. either through a UNC path (recommended) or a mapped drive. Refer to Database Installation on page 226 for more information. • Ensure that the server files are accessible to all Kofax Capture client workstations. You can choose to log on after each restart or have the installation log on for you after each restart. After your computer reboots. The installation will automatically resume once your workstation has been restarted. Then. Select Start | Run from the Windows task bar and browse to the shared folder where you installed the Kofax Capture server files. Warning After installing Kofax Capture. choose an installation path on a local. See the Kofax Capture online Help for more information on licensing. 5 Follow the instructions on your screen to install the software. Note If you use a UNC path or a mapped drive to access the setup. shut down any applications (including the Control Panel. you will be able to use Kofax Capture for a limited period of time. unmapped. when prompted for the destination folder. run setup. Next. map a drive to the Kofax Capture server files. Be sure to read them carefully before proceeding with each step. The installation instructions contain additional information that will guide you through the installation process. and must match the method (UNC or mapped drive) and path used to install the Kofax Capture server files folder. the path must be exactly the same on each workstation. Note You must initiate the client workstation installation from the client workstation. non-UNC drive. virus detection software. The server is now installed. Changing the name may cause your installation to become unstable.exe from the WrkInst subfolder. To install Kofax Capture on a client workstation 1 At the client workstation.Installing Kofax Capture Note If the license cannot be activated during installation. As you proceed through the instructions.exe file. Kofax Capture 8 Installation Guide 41 . 2 3 4 If necessary. you can install Kofax Capture on your client workstations. do not change the name of your computer. and toolbars) that might be running. Chapter 4 Note At various points in the installation process. be sure to use the same user account when logging back on. 3 4 As you proceed through the instructions. select Standalone. • When prompted for the database configuration. The other options are SQL Server. you can select which database configuration to use with Kofax Capture. note the following: • When prompted for the type of installation. SQL Server 2005 Express Edition. Insert the Kofax Capture installation CD 1 into your CD drive. select Automatically Reboot and log in. Standalone Installation Follow these steps to install Kofax Capture on a standalone workstation. Be sure to read them carefully before proceeding with each step. To have the installation log on for you. run Autoplay. “Standard” is the default selection. choose a path on a local. 42 Kofax Capture 8 Installation Guide . and IBM DB2. you can choose to log on after each restart or have the installation log on for you after each restart. you will have to restart your system and log on. will be installed. Refer to Database Installation on page 226 for more information. and toolbars) that might be running. so the installation will automatically begin. SQL Server 2005 Express Edition will not be installed. If you select an option other than “Standard”. select Install Kofax Capture for the First Time.) From the main installation screen. shut down any applications (including the Control Panel. (Refer to Figure 4-1 on page 39.exe from the CD. Oracle. in which case the Standard database. non-UNC drive. At the first restart. The CD supports AutoPlay. virus detection software. To install Kofax Capture on a standalone workstation 1 2 At the standalone workstation.) Follow the instructions on your screen to install the software. The installation instructions contain additional information that will guide you through the installation process. (If it doesn’t start. The installation will automatically resume once your workstation has been restarted. The default location is C:\Program Files\Kofax\Capture. If you manually log on after each restart. unmapped. • When prompted for the destination folder for the software. Changing the computer name may cause your installation to become unstable. if you are using a non-VRS scanner or no scanner. If you are upgrading from an earlier version. be sure to use the same user account when logging back on. To have the installation log on for you. If you are installing with the software-based licensing option. Note Follow these instructions to install Adrenaline image processing accelerators or Adrenaline scanner controllers. After detecting the hardware key. Kofax Capture 8 Installation Guide 43 . Warning After installing Kofax Capture. select Automatically Reboot and log in. The installation will automatically resume once your workstation has been restarted. you will be able to use Kofax Capture for a limited period of time. you can choose to log on after each restart or have the installation log on for you after each restart. Note If the license cannot be activated during installation. do not install a hardware key. or reinstall your drivers. If activation is successful. See the online Help for more information on licensing. These instructions may differ from those shipped with your Adrenaline hardware. • If the New Hardware Key Detected message displays. dismiss it. you do not need to reinstall your Adrenaline image processing accelerator. do not change the name of your computer. • After the software is installed. the installation will activate the license. follow the on-screen instructions to complete activation with your Kofax serial number and product code.Installing Kofax Capture Note At various points in the installation process. Step 2: Install Adrenaline Hardware This section describes the installation of Adrenaline image processing accelerators and Adrenaline scanner controllers for use with Kofax Capture. At the first restart. you will have to restart your system and log on. After your computer reboots. Kofax Capture is fully installed. Instead. If you manually log on after each restart. you will be prompted to attach the appropriate hardware key. you will be prompted to reboot your computer. 2 3 4 5 6 44 Kofax Capture 8 Installation Guide . Once the image processing accelerator is inserted. Follow these instructions to install an Adrenaline 850 or 1700 image processing accelerator. Note Adrenaline 850 and 1700 image processing accelerators do not support Windows Server 2003. Restart the workstation. You must use a full-length PCI slot for an Adrenaline 1700 image processing accelerator. Follow any instructions on your screen to finish. Configure your scanner using the Scanner Configuration Utility. Make sure your workstation is powered off and unplugged. and then remove its shell (chassis cover).Chapter 4 Installing Adrenaline 850 and 1700 Image Processing Accelerators Warning When installing Adrenaline hardware for use with Kofax Capture. 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. You can use any PCI slot for an Adrenaline 850 image processing accelerator. secure the workstation’s shell into place and plug in the workstation.com). Refer to Chapter 7 – Setting Up Source Devices on page 113 for information about using the Scanner Configuration Utility. do not install the drivers from the Adrenaline installation CD. Windows will automatically detect your new Adrenaline 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. Wait ten seconds. Insert the Adrenaline image processing accelerator in an available PCI slot. Once the scanner controller is inserted. 650. To install an Adrenaline 450. and are installed as part of the Kofax Capture installation process. Once the scanner controller is inserted. Restart the workstation. 3 4 Windows XP Follow these instructions to install an Adrenaline 450. Windows will automatically detect your scanner controller. 650. Refer to the documentation that came with your Adrenaline scanner controller for more information about inserting the scanner controller into your workstation. Note These controllers do not support Windows Server 2003. do not install the drivers from the Adrenaline installation CD. and then. 3 Kofax Capture 8 Installation Guide 45 . 650. 650. To install an Adrenaline 450. or 650i scanner controller on a Windows 2000 workstation. and 650i Scanner Controllers Warning When installing Adrenaline hardware for use with Kofax Capture. secure the workstation’s shell into place and plug in the workstation. remove its shell (chassis cover). or 650i scanner controller on Windows XP. Refer to the documentation that came with your Adrenaline scanner controller for more information about inserting the scanner controller into your workstation. Wait ten seconds. 650. secure the workstation’s shell into place and plug in the workstation. or 650i scanner controller 1 2 Make sure your workstation is powered off and unplugged. The Adrenaline drivers required by Kofax Capture are included on the Kofax Capture installation CD 1. and then remove its shell (chassis cover). Wait ten seconds. Insert the scanner controller in an available PCI slot. Insert the scanner controller in an available PCI slot. Windows 2000 Follow these instructions to install an Adrenaline 450. or 650i scanner controller 1 2 Make sure your workstation is powered off and unplugged.Installing Kofax Capture Installing Adrenaline 450. Select “Install from a list or specific location (Advanced)” and click Next. right-click My Computer and select Manage. Then.Chapter 4 4 5 Restart the workstation. Note Kofax has tested this driver with Windows XP and verified its compatibility independently of the Windows Logo testing program. If you do. From the list of Models. click Finish. 46 Kofax Capture 8 Installation Guide . Device Manager 6 Expand SCSI and RAID controllers. This will launch the Hardware Update wizard. Windows will automatically detect your scanner controller. I will choose the driver to install” and click Next. Select “Don’t search. right-click “Advansys 3550 Ultra Wide SCSI Host Adapter. Figure 4-2. From the Windows Desktop. You may get a message informing you that the adapter driver has not passed Windows Logo Testing. click Device Manager. select the Kofax Adrenaline model and click Next. There are no known problems. click “Continue Anyway” and follow the instructions on your screen. 11 Your Adrenaline scanner controller will appear in the Device Manager list for SCSI and RAID controllers as shown below. 7 8 9 10 When the completion screen appears.” and select Update Driver. Within that subfolder run the installation or setup program to install the driver components for your scanner. Kofax Capture 8 Installation Guide 47 . Locate the Subfolder for your scanner. Open Windows Explorer and navigate to the Scanner Drivers folder on the CD. Step 4: Install the Report Viewer Module Perform this step if you wish to use the Report Viewer to generate. Refer to Chapter 7 – Setting Up Source Devices on page 113 for information about using the Scanner Configuration Utility. Adrenaline Scanner Controller Step 3: Install VRS Scanner Drivers Perform this step only if you want to install VRS scanner drivers. view. To install your VRS scanner driver from installation CD 2 1 2 3 4 Insert the installation CD 2 into your CD drive.Installing Kofax Capture Figure 4-3. and export reports based on the user tracking data collected by Kofax Capture. Note If your scanner is not on Kofax Capture installation CD 2. print. use the Scanner Configuration Utility to configure your scanner source. 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. When prompted.) From the main installation menu shown in Figure 4-1.Chapter 4 To install the Report Viewer module 1 2 Shut down any applications (including the Control Panel. virus detection software. so the installation will automatically begin.exe from the CD. then browsing to the Setup. 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. insert installation CD 2 into the CD drive. 3 As a separate option. Be sure to read them carefully before proceeding with each step. browse to the folder where you copied the contents of the installation CDs and double-click the AutoRun. 48 Kofax Capture 8 Installation Guide . Complete the installation. Also.exe file for each component.exe file. rather than from the installation CDs. The CD supports AutoPlay. as described earlier in this chapter. The installation instructions contain additional information that will guide you through the installation process. run Autoplay. and toolbars) that might be running. 3 4 5 Installing From a Network Kofax Capture and its components can be installed from a network. Follow the instructions on your screen to install the software. the Report Viewer components do not need to be uninstalled before uninstalling Kofax Capture. Insert the Kofax Capture installation CD 1 into the CD drive. This option makes it easier to complete installations on multiple computers that have access to a single network folder. Kofax Capture will not be affected if you uninstall the Report Viewer components. From any computer attached to your network. select Install Kofax Capture Report Viewer Components. (If it doesn’t start. Note The Report Viewer components are installed and uninstalled separately from Kofax Capture. you must close all applications. including Services. This will replace corrupted or missing files. Close All Applications Before upgrading the Server or standalone workstation to Kofax Capture 8.0: Updates all files to the latest version of those files Preserves your current batch classes. The MSDE service (MSSQL$AscentCapture) must continue running for the installation to complete successfully.Installing Kofax Capture Upgrading/Updating Kofax Capture The Kofax Capture installation supports upgrading and updating. Preserves your current batch classes.0. profiles. and other settings during the upgrade Preserves your site and station IDs Preserves active batches • Updating Kofax Capture 8. 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. Kofax Capture 8 Installation Guide 49 . Administrative Privileges Required The logged in user must have administrative privileges to the local computer. This means that all of the modules on every workstation must be closed.0: Updates the non-data files with the same version of those files. and any third party applications. profiles. Differences Between Upgrading and Updating The differences between upgrading and updating are summarized below: • Upgrading to Kofax Capture 8. Then.x or 7. 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.5 or later. With VRS If you are upgrading an installation that also has VRS version 3. you do not need to convert back to MSDE when upgrading to Kofax Capture 8. With SQL Server If you are upgrading from Ascent Capture 6. Client/Server Configurations When upgrading in a client/server configuration.0. Batches You can perform an upgrade while there are still batches being processed in the system. For a server installation.0. the upgrade or update must be performed on the computer where the server software is installed. note the following: • You must disable the ACI service.exe/d • You must stop all modules running as services. You cannot upgrade an Ascent Capture server from a client workstation. You will still be able to use 50 Kofax Capture 8 Installation Guide . Refer to Chapter 2 – Kofax Capture Operating Requirements on page 3 for information about the operating requirements. The services must remain stopped until the upgrade is complete. your current version of VRS will be overwritten by a newer version. To disable the ACI service run the following from the command line: <Ascent Capture installation folder>\Bin\aciscfg.0.Chapter 4 When upgrading to Kofax Capture 8. you must first upgrade your Windows operating system. 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. and if you moved the Batch Catalog database to SQL Server. Client workstation and standalone installations must be upgraded on the computers where the current installation exists. you must upgrade the server software and files from the installation CD. you can upgrade the client workstations.0. 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. Note When installing Kofax Capture on workstations that have older versions of the VRS software installed.5. For example: E:\Kofax\Setup.x or higher. or click Browse to locate it. select Start | Run. In Open. In the Open box. you can simply dismiss this dialog box by selecting the Continue option and then click OK to continue with the installation. If you have a version of VRS earlier than 3. 8100.0 . add the /NoVRS option. you may be able to upgrade to Kofax Capture 8.exe file you want to open.0.VRS Detected dialog box. you must remove or upgrade VRS before upgrading. you must first upgrade to an intermediate version. Upgrade/Update Methods The installation supports upgrading from Ascent Capture version 6.exe /NoVRS Follow the instructions on your screen to install. When this happens. Then. If you have an earlier version of Ascent Capture. See the table below to determine whether you can upgrade directly. • • • • Böwe Bell + Howell Copiscan 8000 VRS Series (8080. as shown below. but you will not be able to use the VRS QC Later feature unless you obtain the necessary license. you will receive the Kofax Capture 8. type the path of the Setup. Kofax Capture 8 Installation Guide 51 .Installing Kofax Capture VRS after the upgrade. From the Windows taskbar. Scanner Considerations The following scanners require that you upgrade Ascent Capture with the /NoVRS option. 0 German to Kofax Capture 8. If upgrading from Ascent Capture 5. Upgrade Ascent Capture to version 6.0 is already installed.0.x. When upgrading to Kofax Capture 8. Then. If the installation detects that Kofax Capture 8. upgrade Ascent Capture to 6. ensure that all batches have been released.x to Kofax Capture 8.0 Ascent Capture 6. There is no need to ensure that all batches have been released.x. the user tracking statistics are stored in the standard database or in your SQL Server database.0 If upgrading from Ascent Capture 6. you must be using (at least temporarily) the MSDE database before upgrading to 6. Table 4-1.0.x. Ascent Capture 7.x.x.x Server with a workstation installed on the same computer You cannot upgrade directly to Kofax Capture 8. upgrade the Operating System to an OS supported by Kofax Capture 8.0. ensure that all batches have been released.x and 5. If upgrading from Ascent Capture 5. Ascent Capture 4. there is no need to ensure that all batches have been released. user tracking statistics data can be converted from the previous installation's database to the new installation’s database.1 and then to Kofax Capture 8. Converting User Tracking Statistics Depending on your current database selection.0 English).x or 5.x standalone or Server installation Upgrade Methods You cannot upgrade directly to Kofax Capture 8. Then. If upgrading from Ascent Capture 4.1 and then to Kofax Capture 8.1. upgrade directly to Kofax Capture 8. Uninstall the workstation on the Server. it will prompt you to confirm updating the program files.0. upgrade the Operating System to an OS supported by Kofax Capture 8. Depending on the amount of 52 Kofax Capture 8 Installation Guide .0.0 If upgrading from Ascent Capture 4. Finally. Upgrade Methods Existing Version Ascent Capture 4.0.Chapter 4 Note Upgrading to another language is not supported (for example.x or 7. or 7.x. the Kofax Capture Conversion message box will display. Preserving Your Settings If you are upgrading an existing installation of Ascent Capture. • A previous version of Ascent Capture will not be detected.0. they will not be converted or available to the new installation’s database. Kofax Capture 8 Installation Guide 53 . As you proceed through the installation. Select Start | Run from the Windows task bar and browse to the Setup. • Data from the previous version will be converted to the new version at the end of the installation. • Use the previous file path as the target folder. administrative data. this process may take several hours or more to complete. The administration data and batches will still be converted. See Backing Up and Restoring Your Standard Database on page 207 for more information. and the installation will proceed like a clean install.Installing Kofax Capture user tracking statistics in your system. user tracking statistics. During an upgrade. Select the “Skip user tracking statistics data (the administrative data and batches will still be converted)” option. Recovering After a Failed Upgrade Installation If you experience a failed installation during an upgrade.0 installation CD 1 into the CD drive. To recover after a failed Kofax Capture install 1 2 Insert the Kofax Capture 8. If you choose to skip the conversion of user tracking statistics.exe file on the installation CD. and batches are converted to the new installation's database. 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. You have the option to skip the conversion of user tracking statistics when upgrading to Kofax Capture 8. it is strongly suggested that you back up your server folders and the database containing your batch classes and scripts. Chapter 4 3 At the command prompt. For example: E:\Kofax\Setup. Upgrading Client/Server Installations The procedures in this section describe upgrading Ascent Capture client/server installations. For example: E:\Kofax\Setup. • This procedure only applies to updating an existing Kofax Capture installation. You must upgrade your server first.x.0 installation CD 1 into the CD drive.exe /VRSReinstall 4 Follow the instructions on your screen to install. add the /Recover option and click OK. note the following: • A reboot is required if you reinstall VRS. Be sure to read them carefully before proceeding with each step. To reinstall or repair VRS 1 2 3 Insert the Kofax Capture 8. These installation instructions contain additional information that will guide you through the process.exe file on the installation CD. Upgrading to Kofax Capture 8. and then you can upgrade your client workstations. Be sure to read them carefully before proceeding with each step.x or 7. At the command prompt. • This procedure cannot be used with the auto or silent switch.exe /Recover 4 Follow the instructions on your screen to install.0 on Servers Follow this upgrade procedure if your existing Ascent Capture server version is 6. use the procedure below. Reinstalling or Repairing VRS If you need to reinstall or repair VRS within an existing Kofax Capture installation. These installation instructions contain additional information that will guide you through the process. 54 Kofax Capture 8 Installation Guide . Select Start | Run from the Windows task bar and browse to the Setup. It has no effect on Kofax Capture upgrades or new installations. add the /VRSReinstall option and click OK. Before you proceed. 4 5 As you proceed through the installation. Be sure to read them carefully before proceeding with each step. install Kofax Capture by following the instructions in Step 1: Install Kofax Capture on page 38. browse to the folder where the existing server files were installed.x server 1 2 Read Important Notes on page 49 before you upgrade. and toolbars) that might be running (see Close All Applications on page 49). or 7. run Autoplay. Shut down any applications (including the Control Panel. See With VRS on page 50 for additional information. select the Upgrade option.x or 7. Kofax Capture 8 Installation Guide 55 . if a previous version is found. verify that you browsed to the correct location. virus detection software.x. Warning Completely reinstalling Kofax Capture will cause loss of your batch classes. note the following: • The installation will search for the currently installed version to determine which method to use to upgrade.0 installation CD 1 into the CD drive of the server where your server files are installed. If the earlier version cannot be found. • If a previous version is detected.) From the main installation menu. If this occurs. If a previous version is still not detected. the Installation Not Found dialog box will display. you do not need to change back to MSDE for the upgrade. Follow the instructions on your screen to upgrade the software. The Server Installation Detected dialog box will display. The installation instructions contain additional information that will guide you through the process. • If a previous version is not detected. (If it doesn’t start.exe from the CD. Note If you moved the Batch Catalog (database) to SQL Server in Ascent Capture 6. and click Next. an upgrade will be performed. The CD supports AutoPlay.Installing Kofax Capture To upgrade Ascent Capture 6. 3 Insert your Kofax Capture 8. so the installation will automatically begin.x. you can upgrade your client workstations. Select Start | Run from the Windows task bar and browse to the shared folder where you installed the server files. To upgrade a client workstation 1 2 3 Read Important Notes on page 49 before you upgrade or update your installation. run Setup. The installation instructions contain additional information that will guide you through the installation process. Upgrading on Client Workstations Once the server has been upgraded. 4 56 Kofax Capture 8 Installation Guide . Then. you may not be able to upgrade directly to Kofax Capture 8. do not change the name of your computer. If you want to switch the Batch Catalog (database) to a different database. and toolbars) that might be running. the installation program will attempt to install the server files to C:\Documents and Settings\All Users\Application Data\Kofax\CaptureSV. Follow the instructions on your screen to upgrade.Chapter 4 Warning You might need to browse to the folder containing the existing server files before proceeding with the installation.0. Warning After upgrading. Changing the name may cause your installation to become unstable. At the client workstation. Oracle. Be sure to read them carefully before proceeding with each step. 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.exe from the WrkInst subfolder on the server. Refer to Table 4-1 on page 52. you can do so through the Database Utility after the upgrade completes. Note Depending on your current configuration. virus detection software. shut down any applications (including the Control Panel.0) after the upgrade completes. or IBM DB2 through the Database Utility (provided with Kofax Capture 8. If you do not browse to the appropriate folder. Depending on your current configuration.exe from the CD.Installing Kofax Capture Upgrading Standalone Installations This procedure describes upgrading a standalone installation to Kofax Capture 8. you can do so through the Database Utility after the upgrade completes. Updating an Existing Kofax Capture 8. so the installation will automatically begin. Refer to Table 4-1 on page 52.0 Installation Follow these instructions if you need to update the current installation of Kofax Capture. Note If you moved the Batch Catalog (database) to your SQL Server in Ascent Capture 6.x. 3 Insert your Kofax Capture 8. 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. or IBM DB2 through the Database Utility when the upgrade completes. Oracle. Changing the name may cause your installation to become unstable. Note After upgrading. (If it doesn’t start. virus detection software.0. select the Upgrade option. you may not be able to upgrade directly to Kofax Capture 8.0 installation CD 1 into the CD drive. For example.0. Kofax Capture 8 Installation Guide 57 . run Autoplay. To upgrade a standalone installation 1 2 Read Important Notes on page 49 before you upgrade. you do not need to change back to MSDE for the upgrade.) From the main installation menu. If you want to switch the Batch Catalog (database) to a different database. The CD supports AutoPlay. you can move it to SQL Server. Follow the instructions on your screen to upgrade. 4 5 If you moved the Batch Catalog (database) to MSDE before the upgrade. you may need to do this if some files have become corrupted or were inadvertently deleted. Shut down any applications (including the Control Panel. do not change the name of your computer. and toolbars) that might be running. select the Upgrade option. run Setup.0 installation CD 1 into the CD drive of the station that requires updating.) From the main installation menu. Follow the instructions on your screen to update. To uninstall plug-ins 1 2 From the Control Panel.0. Repeat this step with each installed plug-in. virus detection software. and toolbars) that might be running. 58 Kofax Capture 8 Installation Guide . Warning You must uninstall all plug-ins before you uninstall Kofax Capture. 3 4 3 Uninstalling Use the following procedure to uninstall Kofax Capture 8. The installation instructions contain additional information that will guide you through the update process. run Autoplay. The CD supports AutoPlay. Select Start | Run from the Windows task bar and browse to the shared folder where you installed the server files.Chapter 4 To update a server or standalone configuration 1 2 Shut down any applications (including the Control Panel. do not change the name of your computer. Follow the instructions on your screen to update.exe from the WrkInst subfolder. Select a plug-in. Changing the name may cause your installation to become unstable. and follow the on-screen instructions. Insert your Kofax Capture 8. and toolbars) that might be running. To update a client workstation 1 2 At the client workstation. Warning After updating. Be sure to read them carefully before proceeding with each step. shut down any applications (including the Control Panel. virus detection software. Be sure to read them carefully before proceeding with each step. Then.exe from the CD. The current installation will be detected and an update assumed. select Add or Remove Programs. The existing installation will be detected and an update assumed. (If it doesn’t start. so the installation will automatically begin. The installation instructions contain additional information that will guide you through the update process. select Add or Remove Programs. Choose to reboot. uninstall the service before uninstalling Kofax Capture. Kofax Capture 8 Installation Guide 59 .0. and follow the on-screen instructions. Select Kofax Capture 8. From the Control Panel.Installing Kofax Capture To uninstall Kofax Capture 1 2 3 If you are running a module as a service. Note You might be prompted to reboot to delete locked files. Chapter 4 60 Kofax Capture 8 Installation Guide . Refer to the Installing Services appendix of the Kofax Capture Getting Started Guide for more information about this feature. High Availability Support Kofax Capture Enterprise’s High Availability Support feature is covered in detail later in this chapter. further configuration may be necessary for the various features that are available with Kofax Capture Enterprise. Terminal Services and Citrix Support Terminal Services and Citrix server technology can be used to run instances of Kofax Capture modules remotely. so they can take full advantage of their potential processing throughput. In addition to the standard installation. 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). Refer to Terminal Servers and Citrix Support on page 21 for more information about configuring this feature. Multiple Instance Support The Multiple Instance Support feature allows you to install multiple versions of any Kofax Capture service. Refer to High Availability Essentials on page 62 for more information about this feature. This improves the capabilities of multi CPU computers. Kofax Capture 8 Installation Guide 61 .Chapter 5 Installing Kofax Capture Enterprise Introduction Kofax Capture Enterprise is identical to Kofax Capture. 0. unless otherwise noted. specific information about Kofax Capture’s support for high availability.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. fault-tolerant operation. when deployed in a highly available computer system. timeconsuming and expensive task. in this chapter only. Depending on the size and complexity of your installation. High Availability Essentials Kofax Capture Enterprise’s High Availability Support feature consists of a number of independent components that. Refer to WebSphere on page 161 for more information about installing and configuring WebSphere for use with KCN Server. For convenience. and specific installation guidelines. Contact your sales representative or your Certified Solution Provider for more information about this alternate licensing option. and it is not intended to be a complete analysis or guide to creating such systems. This chapter includes only information related to Kofax Capture. as well as the skills and experience of your staff. even the smallest company may benefit from some of these components. it may be best to retain a consultant who specializes in high availability systems. This chapter includes basic information about fault-tolerant systems in general. 62 Kofax Capture 8 Installation Guide . the term “Kofax Capture” will be used to include both Kofax Capture Enterprise and KCN Server. Note Many high availability features apply to both Kofax Capture Enterprise and Kofax Capture Network Server. Although fault-tolerant systems are primarily intended for very large “enterprise scale” organizations. Backup Licensing Option Backup license keys (used with High Availability Support) are available by contractual agreement. Tip Configuring and optimizing a fault-tolerant system can be a complex. WebSphere can be implemented either on Solaris or Windows operating systems. result in robust. will nonetheless improve the performance and reliability of Kofax Capture. processes. A highly available system will continue to function even if one or more of its components fail. Kofax Capture and High Availability Kofax Capture is only one link in the chain of high availability. Failover happens without human intervention. In many cases. and take advantage of. starting with the weakest and moving up. is capable of performing its tasks with virtually no downtime. After recovery. Recover (a batch) In case of a problem with a batch.Installing Kofax Capture Enterprise What is High Availability? A high availability (resilient) system. the batch becomes available to Kofax Capture applications running on any station. 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. Any complex system has many components. recovery is the process of restoring the state of the batch to whatever it was prior to the batch being opened. The key idea behind high availability is that a system is only as good as its weakest component (also known as a fault domain). at the most fundamental level. It has features that are intended to work within. A system is made more resilient by providing redundancy for those fault domains most likely to fail. including the crashed station. Some of these features. a high availability computer system. any of which can fail or degrade at any moment. even if used in a normal environment. Scalability Scalability is the ability to respond to increased demand by adding additional equipment. recovery happens invisibly to the user (refer to Automatic Batch Recovery on page 67 for details). and recovering all changes made to the batch that would otherwise have been lost due to the problem. which are used throughout this chapter. Kofax Capture 8 Installation Guide 63 . or other capabilities. Common Terms You may find it helpful to familiarize yourself with the following terms. including KCN Server remote sites. 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. In many cases. providing automatic failover. the batch becomes available to Kofax Capture applications running on any station. including the crashed station. rollback involves only restoring the state of the batch to whatever it was prior to the batch being opened. rollback happens invisibly to the user (refer to Automatic Batch Recovery on page 67 for details). Also known as scalability. Changes made to the batch may be rolled back to what the data was prior to the batch being opened. • Run multiple instances of all the Kofax Capture modules.Chapter 5 Rollback (a batch) In case of a problem with a batch. To ensure that a Kofax Capture installation meets the criteria for high availability it should: • Use Microsoft Cluster Services. After rollback. these steps allow Kofax Capture to continue processing batches even if specific points in the system fail. • Run multiple license servers at the central site. • Use Web farms for installations with KCN Server (based on Microsoft Network Load Balancing). If one instance fails the other instances can continue working. Combined. Figure 5-1 shows an example of a high availability configuration. organizations of any size or complexity can find a level of high availability that matches their needs and budget. • Built-in automatic batch recovery of in-progress batches if a workstation or application fails. Because Kofax Capture’s degree of resilience can be readily scaled. 64 Kofax Capture 8 Installation Guide . Kofax Capture High Availability Configuration Example Kofax Capture 8 Installation Guide 65 .Installing Kofax Capture Enterprise Figure 5-1. A minimum configuration would consist of two servers connected by a network. The license server uses a hardware key to lock the activation code to a particular serial number. Kofax Capture supports multiple license servers—a primary and one or more backups. since each cluster resource can be active on only one node at a time. but the computer continues to run). 66 Kofax Capture 8 Installation Guide . Although Microsoft Cluster Services and SQL Server Enterprise provide automatic failover. This software provides failure detection and recovery. 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. Note Kofax Capture supports MCS only on Microsoft Advanced Server 2000 or Microsoft Windows Server 2003 Enterprise Edition. Note If you are using the software-based licensing option instead of a hardware key. and license configuration.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. your Kofax serial number and product code are locked to the computer. and cluster software (in this case MCS). as well as the ability to manage the servers as a single system. activation code. While Kofax Capture hides most errors. License Server Failover Kofax Capture uses a license server to manage all licensing requests. Note MCS does not protect a system from application failures on a particular computer (where the application crashes. each license server needs its own hardware key. some may be exposed to the user. 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). When multiple license servers are available. However. a mechanism for sharing their disk data. client applications may receive errors during the time needed to complete the failover process. a failed batch is set (rolled back) to its last good state. some other Kofax Capture application must be running. Oracle. This discovery and subsequent recovery will usually take no longer than 15 minutes. so there is no performance-based reason to have more than one backup license server. The other Kofax Capture application will eventually detect the failure and initiate the batch recovery process. and in many cases significantly less time (a matter of seconds). • SQL Server option: If the “Store batches in SQL Server” option is enabled. you might want to weigh any perceived benefits against this additional overhead. in part. the system automatically switches to another license server. The delay depends on the exact timing and sequence of events. If you plan to have more than one backup license server. no data is lost. 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. In the vast majority of cases. If a Kofax Capture application detects a failure on another station and restores a batch to its last known good state. on the batch database option you have selected. and then becomes available to Kofax Capture applications. Automatic Batch Recovery Kofax Capture can automatically recover a batch if a failure occurs while the batch is being processed. Kofax Capture automatically resumes using it. When the primary system is restored. no data will be lost if the batch is opened on the same workstation where the problem occurred. To the contrary. If the “Store batches in SQL Server” option is not enabled. In order for Kofax Capture to detect a failure and recover batches. Kofax Capture 8 Installation Guide 67 . There are no performance gains from installing multiple backup license servers.Installing Kofax Capture Enterprise 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). the introduction of multiple backup license servers requires proportionally more work by the system administrator. The system can use this backup license server until it runs out of volume. If the primary license server fails. The Automatic Batch Recovery feature is built-in and does not require any special installation or configuration. The ability of Kofax Capture to completely rollback or recover a batch without data loss depends. or IBM DB2. • Oracle or IBM DB2 options: If your batches are stored in Oracle or IBM DB2.txt). The batch then becomes available to Kofax Capture applications. you should restart that application on the same station. Step 1 Install and configure Kofax Capture. If at all possible. Batch recovery and rollback events are logged to the error log (Err_YYMM. This not only improves performance. Step 2 68 Kofax Capture 8 Installation Guide . This maximizes chances for a full recovery of the batch. In the vast majority of cases. We recommend that you initiate the installation of Kofax Capture Server from one of your cluster nodes. but also provides failover support because if one Web server fails. no data is lost. data will be lost if the batch is opened on some workstation other than the one where the problem occurred. KCN Server Web Farm Support KCN Server supports the Microsoft NLB (Network Load Balancing) Web farm technology with multiple nodes (servers). Note If you discover a problem before a batch is automatically recovered.Chapter 5 If the “Store batches in SQL Server” option is not enabled. Such configurations are known as “Web farms. there is no advantage to having more than one backup server. Note that the Automatic Batch Recovery feature is an integral part of Kofax Capture. You can skip those steps that do not apply to your installation. Perform this step only if you intend to install one or more backup license servers. Set up one or more backup license servers. other Web servers in the network will take over. you may decide to attempt to initiate recovery of the batch by manually restarting the application. In general.” Configuring Kofax Capture for High Availability This section includes instructions for configuring Kofax Capture for high availability. Network load balancing allows a Web server-based application to distribute its workload across multiple Web servers. so there are no specific steps required to implement or configure it. a failed batch is set (rolled back) to its last good state. Installing Kofax Capture Enterprise Step 3 Set up your Web farm for use with KCN Server. For specific installation details. For example. you may prefer to install multiple applications on your KCN Service computers to reduce cost. Do not share the folder in Windows Explorer as you normally would for a file share. as well as their network connections. You need to weigh all of these issues when configuring or optimizing your system. but perform more slowly than standard drives. Refer to Server Files on page 28 for more information about the shared folder. must be as optimized as possible. you must satisfy the following prerequisites: • Configure Microsoft Cluster Services. For specific installation details. 1 2 Install Kofax Capture as you normally would. • Install SQL Server on the cluster. The following steps provide a recommended installation procedure for Kofax Capture that will take full advantage of a high availability environment. Step 1: Install and Configure Kofax Capture in a Microsoft Cluster Server Environment Before you install Kofax Capture in a high availability environment. Note The computers hosting the Kofax Capture server files. be sure to use the file share you created as one of the prerequisites above. Note High availability goals may conflict with the desire for optimal performance. certain drive configurations may slow down performance while increasing resilience. Perform this step only if you want to use Microsoft NLB to set up a Web farm for use with KCN Server. Kofax Capture 8 Installation Guide 69 . For high availability installations using Microsoft Cluster Server with a redundant drive file system. refer to your Microsoft documentation. This folder will be used for the Server Files and so it requires “Full Control” permissions. Additionally. • Create the Kofax Capture shared folder from within the Cluster Administrator. RAID drives often provide greater availability. When asked to specify a server files folder to store data files. refer to your Microsoft documentation. when file operations fail. they are retried every 0. This is because the license server requires frequent network transmissions. if desired. Then. 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. • Field Type Dictionary This dictionary is configured with the “Dictionary” setting on the Field Type Properties dialog box. which is automatically installed. All external. • OCR Full Text Dictionary This dictionary is configured with the “Dictionary” setting on the OCR tab of the Document Class Properties dialog box.5 seconds for a total retry time of 2 minutes. running server applications together with the license server can be accomplished through careful configuration. overall system performance may be reduced. and occasional disk access. 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. <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. To make the system more resilient. run DBUtil. you can start multiple license servers on additional client workstations. You can configure these parameters by updating the ACConfig. However. However. enable the “Store batches in SQL Server” option. • PDF Dictionary This dictionary is configured with the “Dictionary” setting on the PDF tab of the Document Class Properties dialog box. provided you have obtained the required licensing.xml file in the Kofax Capture Server files folder. Config subfolder. low to medium CPU usage.exe and change the database configuration so that it uses the SQL Server instance installed on the cluster. 4 5 By default. 70 Kofax Capture 8 Installation Guide . The ReliableFileSystem element must be added as a direct child of the ACConfig element. shared files must be placed in the cluster file share folder. It is usually easier to configure a successful system by keeping the license servers on dedicated computers.Chapter 5 3 When the install is complete. Run ACLicSrvCfg. Following the procedure. a different user is necessary. Step 3: Set up your KCN Server Web Farm If you want to use a KCN Server central site with a Web farm.exe from <Kofax Capture installation folder>\Bin\ ACLicSrvCfg.exe /S <ServerName>. you will lose your failover capability if that node fails. If you are installing with the software-based licensing option. follow the on-screen instructions to complete activation with your backup Kofax serial number and product code. Otherwise. 5 6 7 The utility starts the service. 8 Finally.exe. To activate the backup server. and then checks to see if the service is running properly. do not install a hardware key. use the following procedure. This user must have access to the folder specified for the licensing service. to run the License Utility against the license server named “LicBackup” you might use this command prompt: c:\program files\Kofax\Capture\Bin\ACLicUtl. Kofax Capture 8 Installation Guide 71 .Installing Kofax Capture Enterprise Note If you install your license server on one of the cluster node computers. Install the backup license server’s hardware key. Ensure that the license on the primary server has already been activated (this should have happened when you installed Kofax Capture). To configure a backup license server 1 2 Install a Kofax Capture Workstation on a second (or additional) computer. it is strongly suggested that you have a backup license server. Leave the default user set to “Local System” and click OK. Note If you are also using KCN Server on this computer. use the License Utility to activate your backup license server. Instead. 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. 3 4 For example.exe /S LicBackup. as well as to the needed KCN Service resources. each step is explained in more detail. When setting up the NLB port. and all Web servers in the configuration must belong to the same domain. You cannot install any Kofax Capture workstation components. Note Only IIS and KCN Web Server components are allowed on the Web farm nodes. Before you install your KCN Server Web farm. These will function as the Web farm. • You must configure these Web servers as part of a Web farm using Microsoft Network Load Balancing (NLB). You also need to install IIS. Note The Kofax Capture server. the KCN Web Server listens on port 80. you must satisfy the following prerequisites: • You must have two or more computers without Kofax Capture installed on them. the KCN Server cache folder(s). Configure the Web servers as part of a Web farm. The system must also include at least two KCN File Cache folders on any two computers. The specific Web farm technology used by KCN Server is Microsoft NLB.Chapter 5 The Kofax Capture system must include at least two Kofax Capture workstations that host KCN Services. or KCN Services on them. Refer to your Microsoft documentation for details. the port range must include the port for which the Web server is configured. • You must install at least two Web servers on at least two of these computers. Enable additional Services. By default. Install the Web Server components on the Web servers. Note WebSphere is not supported for use with Kofax Capture in a Web farm. Refer to your IIS documentation for details. 72 Kofax Capture 8 Installation Guide . To set up an KCN Server Web farm 1 2 3 4 5 Enable the first Service. Configure KCN Server Cache Folders. KCN Server file caches. Note The same Kofax Capture Server and the same cache folder location(s) must be used for all Web servers. Kofax Capture 8 Installation Guide 73 . you can skip the parts about configuring the cache folder. If installing KCN Server for the first time. Refer to Chapter 10 – Installing Kofax Capture Network Server on page 133 for information about installing KCN Server (and enabling the Service). Refer to Chapter 10 – Installing KCN Web Server Components on IIS on page 139 for information about installing these components. You can also add more Services.Installing Kofax Capture Enterprise Enable the First Service Next. this folder will be highly available. This not only provides greater reliability. all Kofax Capture Network Services use a KCN Server cache folder located within the Kofax Capture Server files folder. Note You cannot install KCN Services on the Web servers. Assuming that you have implemented Microsoft Cluster Services as described in this chapter. 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. Refer to Chapter 10 – Step 2: Enable the KCN Service at the Central Site on page 136 for information about installing Services. Configure KCN Server Cache Folders By default. but may also improve performance. Enable Additional Services You need to enable at least one additional Service on an Kofax Capture client workstation. you will change the default KCN Server file cache folder and create new ones on each KCN Service computer. Note In subsequent steps. you must enable the first Service at the central site. if the current Web server is the bottleneck.Chapter 5 However. Remember that it is necessary to run the KCN Server Wizard on all the Web servers after making the changes. Refer to Chapter 10 – Configuring Additional File Cache Folder Locations on page 146 for information about adding multiple cache folders. you should ensure that all points in your network have sufficient bandwidth to handle your projected loads. you can disable the original cache folder. Each local cache folder must be accessible by all KCN Services. Note If desired. To do so. Optimize Your Web Farm With NLB. In addition. Adding additional Web servers theoretically improves performance. 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 Kofax Capture 8 Installation Guide . all the components involved with KCN Server batch upload and insertion must be optimized. edit the ACConfig. because there are additional KCN Services deployed on workstations.xml file by replacing the path to the original cache folder with the path to one of the added cache folders. In order to obtain these performance benefits. This will reduce network overhead and may improve performance. 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. client requests are load-balanced among the different Web servers. 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. performance.exe in the WrkInst folder). • Keeping in mind that this will have a negative impact on performance. If you decide to do this.Installing Kofax Capture Enterprise If you are able or willing to accept a somewhat diminished level of high availability and performance. 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. • You can install Kofax Capture on one of the cluster computers. Note During the installation. 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 Kofax Capture 8 Installation Guide 75 . you can use some of the following configuration variations to reduce the number of computers you need. you may choose to run any of the following Kofax Capture server applications on the cluster computers. and hardware costs. These variations represent a trade-off between high availability. Chapter 5 76 Kofax Capture 8 Installation Guide . this requires a backup central site. For example.Chapter 6 Disaster Recovery This chapter provides information about configuring and using the Kofax Capture Disaster Recovery feature. In a large Kofax enterprise installation. It is intended to be used by system administrators who manage the disaster recovery features of a Kofax Capture Enterprise installation. if a central site becomes inoperable. Interruption of Critical Functions The Kofax Capture Disaster Recovery feature addresses the infrastructure needed to prepare for business continuity and data recovery. which includes multiple sites. remote sites are Kofax Capture 8 Installation Guide 77 . but who could. but cannot fill the void for hardware and software configurations that are unique to your site. Your business recovery plan should include a training section for your personnel so they know what to do in various situations. there is a strong need for a thorough business recovery plan. hardware and software necessary to resume critical business operations after a natural or humaninduced disaster. For a Kofax Capture enterprise site. and personnel centers in various geographical locations. Introduction Disaster recovery is the process of regaining access to the data. A business recovery plan is a start-to-finish solutions approach to disaster recovery for your site. nor can it provide specific training for your personnel. The Kofax Capture Disaster Recovery feature provides a partial solution. be deployed to start working on solutions. Business Continuity Business Continuity refers to the recovery and restoration of interrupted critical functions. perhaps. When a disaster strikes. servers. there will be a large number of people whose normal duties will cease. causing the primary site to go down. Features The Kofax Capture Disaster Recovery feature allows you to: • • • • • • • • Back up. but provides no recovery solution for batches created at a central site. set up a backup location for batches and batch classes. configure a replication scheme. and create custom workflow agents. it can easily be restored to the last backup point. The administrator can also optionally export administrative data. and batches continue to be seamlessly uploaded. and manual intervention in the case of a down system. 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. This case requires no special action . this requires that the batch backup feature has been enabled. personnel perform appropriate tasks per their training. For a Kofax Capture enterprise site. you are responsible for the following areas: initial setup. When a site goes down. Note The Disaster Recovery feature ensures recovery of batches that were created at remote sites.it is transparent. transfer custom module configuration data.Chapter 6 automatically routed to the alternate central site. and that administrative data is exported on a regular basis. batches and batch classes are replicated to another secure location. create a list of central sites. replicate. and specify upload behavior. For the initial setup. routine maintenance. a site administrator must configure shared and backup licenses. Data Recovery Data Recovery implies that data is safely backed up and can be restored. 78 Kofax Capture 8 Installation Guide . and monitoring batch replication activity. and customization. Figure 6-1. Manual intervention might include adding a central site. restoring batches and batch classes to a restored site. switching remote sites to another central site. importing administrative data to a restored site. For business continuity. the system automatically switches batch uploads to alternate central sites depending on defined upload behavior. Enterprise Setup Disaster Recovery setup at the enterprise level includes the following: Kofax Capture 8 Installation Guide 79 . and possibly deleting a central site. Business Continuity Setting Up for Disaster Recovery You can make configuration settings that affect several areas: the entire enterprise. monitoring batch upload activity and balancing. central sites. The following sections explain each configuration. alternate central sites.Disaster Recovery Routine maintenance might include exporting administrative data at regular intervals. For more information. you can schedule third party replication software to transparently copy batch information to a secure location.Chapter 6 Shared and Backup Licensing Support for Disaster Recovery Because a Disaster Recovery configuration has at least two central sites. 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. it employs a shared license scheme that requires minor configuration adjustments.Business Continuity Tab” in the Kofax Capture Help System. For more information about activating and configuring licensing for a Kofax Capture Disaster Recovery configuration. see the “KCN Server Remote Site Profiles Dialog Box . Once automatic batch backup has been configured. your critical business data is now securely backed up. you can execute an easy-to-use command line utility to restore any batches that may have been lost. For more information. In the case of a disaster. • Specifying batch upload behavior. To specify batch upload behavior and to optionally create a priority list of central sites. You can also specify batch upload behavior using a workflow agent. You might use this feature to 80 Kofax Capture 8 Installation Guide . when you export administrative data from one system and import it to another. Once the down central site is active again. see Backup and Shared License Server Support on page 82. and Restoring Batches on page 88. you can substitute new values for the configuration settings. 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. it provides a mechanism that allows you to automatically back up batches and their associated batch classes to a user-specified location. 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. see “Creating a List of Central Sites” and “KCN Server Central Site Manager Dialog Box” in the Kofax Capture Help system. Backing Up. Alternate Site Setup The Kofax Capture Disaster Recovery configuration provides several optional methods that allow you to modify the way batches are processed. Replicating. For example. First. see Backing Up. For more information. see Data and Path Substitution on page 94. you might want to override the current priority list and route batches to a different central site from what is currently specified. This allows administrators to easily send custom module configuration data to the entire installation. In another case. and release script setup data. custom data. 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. a central site might be down. and then move to a production configuration using another path for images. based on a set of business rules.” Operations After enabling and configuring your Kofax Capture Disaster Recovery configuration.Disaster Recovery develop and test using one path for images. For example. Customization The Kofax Capture Disaster Recovery configuration also provides several customization options. you can manage the use and availability of each central site as explained below. see Transferring Custom Module Configuration Data on page 97. For more information about this utility. Transferring Custom Module Configuration Data You can place custom module configuration data in a designated folder at the central site. Kofax Capture 8 Installation Guide 81 . outlined below. You might want to temporarily switch remote sites to another primary central site to perform routine maintenance at a particular central site. For more information. For more information. 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. see the “Kofax Capture 8 Developer’s Guide. There are comparable substitution mechanisms provided for image files. you can switch all remote sites to use another central site as a primary. see Switching to a New Primary Central Site on page 98. You could also use this method to specify a new path for images in a disaster recovery scenario. and to preserve business continuity. 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. As a result. and license configuration. 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. activation code. This allows you to save periodic snapshots of administrative data. With a disaster recovery configuration. A backup license is included with Kofax Capture Enterprise. a system at an alternate central site with backup licensing can continue the licensing function.a primary and one or more backups. and user profiles. Kofax Capture supports multiple license servers . When multiple license servers are available. see Deleting a Central Site on page 101. see Exporting and Importing Administrative Data on page 102 and Administrative Data Export and Import Use Case Recommendations on page 107. the system automatically switches to the backup license server. in a disaster situation or during routine maintenance. 82 Kofax Capture 8 Installation Guide .Chapter 6 Deleting a Central Site After switching any remote sites that are using a particular central site. allowing uninterrupted workflow. Backup and Shared License Server Support This section explains how licensing is activated and configured in a Kofax Capture Disaster Recovery configuration. For more information about this utility. In any configuration. For more information. you can activate the backup license server at an alternate site. That way. KCNS profiles. you might want to delete that central site from the KCN Server central site list. Exporting and Importing Administrative Data You can export and import administrative data such as batch classes. if the primary license server fails. When the primary system is restored. Backup License Server Support for Disaster Recovery To manage all licensing requests. if the system at the central site that is providing primary licensing becomes unreachable. Kofax Capture automatically resumes using it for licensing. each license server requires its own hardware key. You might perform this operation when you want to remove a particular central site for an undetermined period of time. The system can use this backup license server until it runs out of volume. Kofax Capture 8 Installation Guide 83 . the primary licensing server becomes unavailable. Remote sites will receive their licensing based on the rules you have established in the KCN Server Remote Site Profiles dialog box. Activate your licenses. licensing must be shared among all central sites. Regardless of how the site is configured for batch uploading. Step 4 Note The license server on a standalone installation cannot be shared. For detailed instructions about configuring central sites to use the primary license server. Finally. If. see Configuration on page 84. licensing would automatically switch to the backup licensing server at an alternate central site. The backup server can also be activated on the server or any workstation at the site. For example. Shared License Server Support for Disaster Recovery In a Disaster Recovery system configuration. 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). Step 3 When activation is complete. the backup license server must be configured to be used only in case the license server fails. all remote sites would initially obtain licensing from the primary licensing server at a 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. suppose your system configuration contains two central sites.Disaster Recovery For example. a Activate the primary license wherever you plan to run the primary license server. for some reason. install the remote sites. b Activate a backup license at the alternate central site. Set up your configuration using the following general steps: Step 1 Step 2 Install both central sites and attach hardware keys. set up shared licensing by configuring all central sites to use the primary license server. Therefore. The activation process establishes licensing information for the central sites as well as all remote sites (based on assigned remote site profiles). this file is located in the <ServerFiles>\Config folder. Check with your administrator for the exact location of this file. The following examples show how to configure a shared license.Chapter 6 Configuration You can configure a shared license by updating the ACConfig. Figure 6-2. 84 Kofax Capture 8 Installation Guide .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.xml file and where to place the hardware keys. For a client/ server installation. It explains how to edit the ACConfig.xml file. Licensing for a Disaster Recovery Configuration The following shows a typical section of the licensing portion of the ACConfig. Table 6-1. After Editing 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 Central Site 1 (Primary) ACConfig. Table 6-2. Before Editing ACConfig.Disaster Recovery Two Central Site Configuration The following illustrates a sample two central site configuration.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.xml Central Site 1 (Primary) ACConfig. Kofax Capture 8 Installation Guide 85 .xml file is bold. xml Central Site 1 (Primary) ACConfig. The following illustrates a sample configuration.xml Central Site 1 (Primary) ACConfig.Chapter 6 Four Central Site Configuration In a four central site configuration.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. a license server is required on only two of the four central sites. Before Editing ACConfig. Table 6-3. Table 6-4. After Editing 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 Kofax Capture 8 Installation Guide . xml file that uses several advanced features.Disaster Recovery Table 6-4. we recommend that you disable the license servers on central sites 3 and 4. The licenses are listed in priority order. Note In addition to editing the ACConfig. If Kofax Capture 8 Installation Guide 87 . <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.xml (continued) Central Site 2 (Alternate) ACConfig. the site would try for 30 seconds before it times out. Optional Advanced Settings The following shows a section of the licensing portion of the ACConfig.xml file. After Editing 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. Once this is set up. In order to communicate. 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). Note Remote sites require only HTTP or HTTPS to communicate with central sites. add the following element to the ACConfig. you can replicate the backed up files and. Enabling and Configuring Batch Backup To enable and configure automatic batch backup. it provides a mechanism that allows you to automatically back up batches and their associated batch classes to a user-specified location. your critical business data is now securely backed up. After trying the last server on the list. it tries the next one on the list. In the case of a disaster. First. Once automatic batch backup has been configured. it begins again at the first server in the list.XML file: 88 Kofax Capture 8 Installation Guide . Replicating. in the event of a disaster. 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. 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.Chapter 6 a site cannot connect to a license server within the server timeout period. The following sections describe how to implement each part of this process. you can schedule replication software to transparently move batch files to a secure location. Network Considerations License sharing occurs among all client stations directly attached to the central site and specified license servers. Backing Up. restore any lost batches or batch classes. You must allow this port at all central sites. the license server requires TCP port 2424. Setting Up Automatic Batch Backup This section explains how to set up a Disaster Recovery configuration for automatic batch backup. a time that is too long. may not leave enough time to safely replicate batches. the system creates a copy of each batch in the specified folder. the status of batches at remote sites is “In Progress (Replicating .” When setting the delay time. When batches and batch classes are placed in the specified backup location. If the published batch class used by a batch has not already been replicated. On the other hand. a time that is too short. 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. 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. This delay gives your third-party replication software time to replicate batches before they are automatically deleted from the remote site. This makes it ready for replication by a third party software package. such as one hour (60). Replication Path The Replication Path specifies a backup location. During this time. leave a reasonable margin. such as 24 hours (1440) might overload the disk with batches waiting for replication. 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.<CentralSiteName>). It may also cause a large percentage of Kofax Capture 8 Installation Guide 89 . When you enable the automatic batch backup feature. Failure to grant this permission will prevent batches from being backed up and possibly delay overall batch insertion time. a copy of the batch class is also copied to the specified backup location.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. For example. In this case. 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. you are ready to transfer data to an off-site location on a scheduled basis. Batch classes are never deleted from the specified backup location. the batch is sent back to the remote site and must be uploaded again once the error has been corrected. it is not backed up again on subsequent uploads. Multiple Versions of Batch Classes The batch backup feature backs up all versions of published batch classes that are uploaded from remote sites. You can exclude any batch class from the backup and replication process using the ExcludedBatchClass parameter. This requires that you purchase and configure a third-party replication application of your choice. Backup Requires Remote Site Upgrade The batch backup feature requires that remote sites be upgraded to Kofax Capture 8. or the batch is released or deleted at the central site. 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.Chapter 6 duplicate batches in a disaster recovery situation if remote sites re-send batches that were already restored. all batch classes are backed up to the specified backup location. Backed up batches in the specified backup location are deleted only when a batch is released or deleted from the central site. Batch classes in this list and the batches that use them are not placed in the specified backup location. ExcludedBatchClass By default.0. Replication Once you have configured automatic batch backup as outlined in the previous section. 90 Kofax Capture 8 Installation Guide . A batch is only backed up the first time it is uploaded to the central site. Batches remain at the remote site until the first time the remote site synchronizes with the central site after the delay time has expired. You can find this utility in the Kofax Capture bin folder. When you configure your third-party replication software. Use the instructions that came with your third-party software to install and configure your software on a remote server.XML file in the section titled Setting Up Automatic Batch Backup on page 88. is a stand-alone command line utility that restores batches from a specified location. specify the replication path.exe. file replication software application that replicates files over a WAN. it is skipped. • If the utility encounters a batch that has already been restored. Notes • All error messages are written to the error log. Kofax Capture 8 Installation Guide 91 . Backup and Replication Restoring Batches Using the KcnsRestoreBatches Command Line Utility The KCN Server Restore Batches command utility. file-based. KcnsRestoreBatches. The replication path is the local folder where Kofax Capture makes copies of batches and published batch classes.Disaster Recovery The replication software that you purchase should be a Windows server. This is the path that you specified in the ACConfig. Figure 6-3. an administrator login is required. the utility moves restored batches that have been successfully inserted into a subfolder so it will not attempt to restore them again. Vq4Rc8t2x. Use the /p parameter along with the /u parameter to specify a user name and password. Command Line Parameters You can specify the path where batches have been backed up and login credentials when required. Note that a batch cannot be recalled unless it is ready to download. an administrator login is required. as in the following example: KcnsRestoreBatches /path “\\mysystem\batchbackup” /u [username] If you run the utility at a site where User Profiles is enabled. You can also remove backed up batches that have been successfully inserted. • If you restore a batch to a central site that is not connected to the remote site that the batch requires for routing. there must be an installed and enabled KCN service at the site where the batch is restored. KcnsRestoreBatches /path “\\mysystem\batchbackup” /u steven /p Vq4Rc8t2x /d By default. The following example specifies a valid user. and his password. steven. • Only one instance of the utility may be run at a time. 92 Kofax Capture 8 Installation Guide . Without a KCN service.Chapter 6 • You can restore batches to Kofax Capture without KCNS installed and enabled. the central site still routes the batch with the assumption that the required remote site will eventually connect. this type of batch would not be “Ready to download”. Use the /u parameter along with the /p parameter to specify a user name and password. /path [path] This parameter is required to specify the location from which you want to restore batches. /p [password] If you run the utility on a central site where User Profiles is enabled. If you would rather delete the backed up batches. • If the batch routing rules in a batch require routing to a remote site. • The utility cannot be run on a remote site. Parameters can be specified with a forward slash (/) or a hyphen (-). See the example for the /p parameter. Follow the /path parameter with a valid path. include the /d parameter. an invalid directory message is logged and this error code is returned. The utility was run on a remote site. no batches were restored. For example. The path parameter was supplied without an actual path. but a login was not provided. Errors occurred during the batch restoration process. The utility was not able to ascertain whether user profile information was needed. Error Codes Value 0 1 2 3 4 5 Name Normal BadUsage LoginRequired LoginFailed UnknownError IsRemoteSite Description The utility ran successfully and without exception. An unhandled exception was encountered. User Profiles is enabled. It defines each of the supported command line parameters and provides an example for formatting the command line. Please check the error log for details. Please check the error log. Credentials were supplied but could not be validated. To successfully restore batches. Therefore. run the utility on a station other than a remote site. The utility expected the following subfolder in the path specification: “<Path>\Batches”. 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. If this folder is not specified.Disaster Recovery ? The “?” parameter displays the correct usage of the KcnsRestoreBatches utility to the console. 6 InvalidDirectoryStructure 7 8 NormalExitWithErrors CannotValidateUser Kofax Capture 8 Installation Guide 93 . you can substitute new values for the configuration settings.Chapter 6 Data and Path Substitution When you export administrative data from one system and import it to another. Syntax The path substitution format in 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 Kofax Capture 8 Installation Guide .xml is: <ACConfig> <AdminDataSubstitution> <Replace Old="<old path>" New="<new path>" /> </AdminDataSubstitution> </ACConfig> Example The following sample entry in the ACConfig. To substitute image path information. and then move to a production configuration using another path for images. 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.xml file. modify the ACConfig. • specify a new path for images in a disaster recovery scenario. Table 6-6.Disaster Recovery </AdminDataSubstitution> </ACConfig> Substitution Locations The system substitutes every entry in the ACConfig.inf is the setup file used for Kofax Capture Release Scripts.xml is: <ACConfig> <AdminDataSubstitution> <Replace Old="<Old Value>" New="<New Value>" /> Kofax Capture 8 Installation Guide 95 .xml The data substitution format in ACConfig. To substitute custom data. modify the ACConfig. Syntax ACConfig.inf file. This includes any data in the CustomProperty table. AscRelSC. 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.xml file and the AscRelSC.xml file for each of the following locations.inf file. the system performs no data validation. the insertion will fail. Release Script Setup Substitution For text and database release scripts. you may not get the intended results. Note If you have modified your release script’s source code that affects this substitution scheme. Data Validation For CAB insert. make sure that you do not unintentionally globally change the wrong settings. ACConfig. If it does not.inf [Ascent Capture Text] DataSubstitution="EnableKofaxPDFExport" Note The search and replace is blind.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. For KCNS batch insertion. the system first checks to see if the substitution path exists. When you configure for a True/False substitution. you can substitute path and certain custom data.xml <ACConfig> <AdminDataSubstitution> <Replace Old="True" New="False" /> </AdminDataSubstitution> </ACConfig> AscRelSC. 96 Kofax Capture 8 Installation Guide .Chapter 6 </AdminDataSubstitution> </ACConfig> AscRelSC. Disaster Recovery Remove and Add Release Script to Apply Edits Whenever you substitute custom data using the AscRelSC. invoke the CustomDataFolder method. For example. To obtain the name of the designated folder that is used for this data. an admin plug-in would pass the custom module name to the CustomDataFolder method and it would return a data storage path.inf file. Each object library (Kofax Capture AdminMod and Kofax Capture Document Access) contains two methods that return a custom module folder name. In this case. 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. in order for the changes to take place. After copying the sample image to the designated folder on the central site. you must remove and add the release script using the Release Script Manager. One method returns a global custom data folder location based on the provided module ID. Consequently. a custom module at any remote site can access the image from the corresponding folder location at its remote site. the next time published batch class information is transferred to other sites. You can also create subfolders within the designated folder location and all data included in the subfolders are transferred. such as images. The other method returns a custom data folder name based on the published batch class and the provided module ID. The values that each method returns are read-only and are determined automatically based on the batch class name and the custom module’s ID. you might want to run a custom module on several remote sites that all require the same sample image. the sample image and any other data in the designated custom module folder would also be transferred. Kofax Capture 8 Installation Guide 97 . You can use the methods during setup and during runtime. This allows administrators to easily send custom module configuration data to the entire installation. This feature is for large binary data files. it is recommended that the value you pass to strModuleID be the custom module ModuleID (<company>. KcnsSiteSwitch.dll) Method RuntimeSession. 98 Kofax Capture 8 Installation Guide .CustomDataFolder (strModuleID as String) Returns folder name string "<CaptureSV>\PubTypes\Custom\<strModuleID>" "<CaptureSV>\PubTypes\Custom\<Batch Class Name>\<strModuleID>" Table 6-8. is a stand-alone command line utility that specifies a new primary central site in a Kofax Capture Disaster Recovery configuration. Kofax Capture Document Access (DBLite. Table 6-7.CustomDataFold er (strModuleID as String) Batch. Switching to a New Primary Central Site The KCN Server Site Switch command utility.Chapter 6 The following tables show each method per object library and the folder name string that it returns. By specifying a URL.<module>) you use when you register the custom module.dll) Method AdminApplication.CustomDataF older ( strModuleID as string ) BatchClass. 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.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.<application>.exe. Kofax Capture AdminMod (ACAdMod. it makes the switch to the new primary central site. /url [URL] When you want to specify a primary central site to switch from. and. You can find this utility in the Kofax Capture bin folder. The url parameter is followed by a valid URL. which is a list of URL’s that have been specified at the central site where the utility is run. You can specify only one command line parameter at a time and parameters can be specified with a forward slash (/) or a hyphen (-). The following example specifies a valid user. when required. /url [URL] [user] [password] If you run the utility on a central site where User Profiles is enabled. MyC8q29x. and display the correct usage.Disaster Recovery The central site switch takes place automatically once a remote site synchronizes. /r [URL] The Remove (r) parameter removes a specified URL from the site switch list. and his password. This restriction does not apply to IIS. If the remote site’s existing primary central site URL matches a URL in the site switch list. an administrator login is required. robert. a user name and password. you must specify its URL. You can also remove a URL from the site switch list. view all currently specified central site URLs in the site switch list. as in the following example: KcnsSiteSwitch /url http://mywebserver/kcn Note For WebSphere. Once all affected remote sites have completed switching primary central sites. You can specify the URL of the old primary central site. If you specify an invalid or incomplete parameter. you may want Kofax Capture 8 Installation Guide 99 . KcnsSiteSwitch /url http://mywebserver/kcn robert MyC8q29x /v The View (v) parameter displays all entries in the site switch list. the specified URL must be an exact match of the primary central site’s web server URL because it is case-sensitive. Command Line Parameters The utility supports several command line parameters. the utility defaults to the behavior of the View (v) parameter. and his password. User Profiles is enabled. see the “/r” parameter. An enterprise license is required but not found. john_baker. but a login was not provided. 100 Kofax Capture 8 Installation Guide . For more information. An unhandled exception was encountered. 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. Z73Nt2x: KcnsSiteSwitch /r http://phoenix/kcn john_baker Z73Nt2x /? The “?” parameter displays the correct usage of the KcnsSiteSwitch utility to the console. Invalid parameters were entered. Credentials were supplied but could not be validated. Please check the error log. 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. The following example removes http://phoenix/kcn from the site switch list using a valid user.Chapter 6 to remove any URL entries that are no longer relevant by removing them from the list. A site targeted for removal was not on the site list. MyC8q29x. robert_s. the specified URL must be an exact match of the central site’s web server URL because it is case-sensitive. when required. KCN Remove Central Site is controlled completely via command line parameters. You can specify parameters with a forward slash (/) or a hyphen (-). Kofax Capture 8 Installation Guide 101 . If you specify any invalid or incomplete parameters. and his password. the central site will no longer be available to remote sites. Once deleted. You can specify the URL of the central site to be deleted. /r [URL] [user] [password] An administrator login is required if the utility is run on a central site where User Profiles is enabled. The following example switches one primary central site to another using a valid user. 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. If the current user is already logged in as an administrator their credentials will be used automatically.exe. /r [URL] When you want to delete a central site. Otherwise a User Profiles username and password must be supplied. This restriction does not apply to IIS. You can find this utility in the Kofax Capture bin folder. The utility duplicates the functionality of deleting a central site from the KCN Server Central Site Manager in the Kofax Capture Administration module. you must specify its URL. Command Line Parameters The utility supports several command line parameters. you will be prompted with the correct usage.Disaster Recovery Deleting a Central Site The KCN Remove Central Site command utility. and. is a stand-alone command line utility that deletes a central site (URL) from the KCN Server central site list. KcnsRemoveCentralSite. Central sites that are shown here can be deleted. as in the following example: KcnsRemoveCentralSite /r http://mywebserver/kcns Note For WebSphere. a user name and password. You can specify only one command line parameter at a time. The “r” parameter is followed by a valid URL. but a login was not provided. and Remote Site Profiles) 102 Kofax Capture 8 Installation Guide . Invalid parameters were entered. Error Codes The KCN Remove Central Site command utility returns the following codes: Table 6-10. 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. User Profiles is enabled. An alternate site targeted for removal was not on the site list. Remote Site List. Credentials were supplied but could not be validated. This allows you to save periodic snapshots of administrative data. Central Site Profile.Chapter 6 /? The “?” parameter displays the correct usage of the KcnsRemoveCentralSite utility to the console. An unhandled exception was encountered. The following command displays information about correct usage: KcnsRemoveCentralSite /? The correct usage also displays when you enter any invalid parameter. Error Codes Value 0 1 2 3 4 5 Name Normal BadUsage LoginRequired LoginFailed SiteNotFound UnknownError Description The utility ran successfully and without exception. KCNS profiles. Please check the error log. and user profiles. Exporting and Importing Administrative Data You can export and import administrative data such as batch classes. the settings for that profile are not imported. Transfer Mode Options Option Do not import duplicates Description Does not import the duplicate batch class and its associated assignments and override settings. Kofax Capture 8 Installation Guide 103 . 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.Disaster Recovery • User Profiles The following sections describe the specific administrative data that is exported and imported. If a profile is not found. When you export a batch class. 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. 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). The import process matches batch class assignments and override settings to profiles by name. 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. Batch class assignments and overrides apply to the renamed batch class. KCNS Profiles This feature allows you to export and import KCNS profiles. see the “Importing and Exporting Batch Classes . they are only added to the existing assignments. For example. 104 Kofax Capture 8 Installation Guide . This is the default. if both central sites A and B contain a user profile named “John”. Importing is Additive Only When importing batch class assignments. 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. More Information For more information. The batch class assignments and override settings are updated in the profiles for the batch class. the renamed batch class becomes “OrderForms1” and is assigned to the user “John”. 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. and the “Order Forms” batch class is exported from A and imported to B. Under no circumstances are assignments ever removed.Chapter 6 Table 6-12. Replaces the existing duplicate batch class.An Overview” topic in the Help. select the “Import batch class assignments and override settings” check box on the Batch Classes tab. Volume Licensing. For more information. Exported and Imported Data Option KCNS Central Site List KCNS Central Site Profiles Description Exported and imported data includes the list of central sites. KCNS Remote Site List KCNS Remote Site Profiles Kofax Capture 8 Installation Guide 105 . see the “KCN Server Remote Site Profile Dialog Box” topic in the Help. Assigned Batch Classes (exported and imported data includes only the “All batch classes” and “Selected batch classes” settings. which includes the following tabs: Batch Routing. Exported and imported data includes the list of remote sites. For more information. It does not include the list of assigned batches classes and routing settings. Table 6-13. Note that the information in the Batch Class Override tab is not imported. see the “KCN Server Remote Site Manager Dialog Box” topic in the Help. 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.Disaster Recovery Exported and Imported Data The following table lists the data that can be both exported and then imported. Business Continuity. Exported and imported data includes most of the information contained in the KCN Server Remote Site Profile dialog box. To import this data. For more information. Polling. Exported and imported data includes the data in the Batch Routing tab in the KCN Server Central Site Profile dialog box. Station Licensing. For more information about KCNS Central Site Profiles. see the “KCN Server Central Site Manager Dialog Box” topic in the Help. see the “KCN Server Central Site Profile Dialog Box” topic in the Help. this type of batch would not be “Ready to download. it does not import the KCNS profile. including linked. 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.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.” Note that a batch cannot be recalled unless it is ready to download. Without a KCN service. Exported and Imported Data in User Profiles Option Export Description All users and groups. User Profiles This feature allows you to export and import Kofax Capture user profiles. 106 Kofax Capture 8 Installation Guide . Transfer Mode Options Option Skip duplicate KCNS profiles Description If the import process encounters a duplicate KCNS profile on the target system. 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. Exported and Imported Data The following data is exported and imported in user profiles: Table 6-15. there must be an installed and enabled KCN service at the site where the batch is imported. are exported. you can easily import all batch classes. • “Default user group for new batch classes” setting. are imported. • All existing users and groups are not imported. you can develop batch classes. Assigned Modules tab. test. Development to Production Site Data Transfer In the case of a development. and user profiles on a development system and then Kofax Capture 8 Installation Guide 107 . and Group Members tab Group: General tab. and Members tab Not Exported or Imported The following data is not exported or imported with User Profiles: • “Enable User Profiles” check box. including linked. KCNS profiles and user profiles to the restored system. For more information. if you have made recent backups of all administrative data. Exported and Imported Data in User Profiles (continued) Option Import Description Only new users and new groups. KCNS profiles. This data was excluded so as not to interrupt the current processes of existing users. • Assigned batch classes.Disaster Recovery Table 6-15. To import this data. Assigned Modules tab. see the “User Profiles Dialog Box” topic in the Help. The following information is imported for new users and groups: Users: General tab. 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. 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. and production system. Existing users and groups are never updated. the two sites should contain the same site configuration and site names. add selected batch classes to “Selected Batch Classes” for export. on the User Profiles tab. in the Export dialog box. • To import only the permissions when you import updated batch classes. • On the User Profiles tab. select the “Export KCNS profiles” check box to export all KCNS profiles. Note To successfully export and import administrative data from a development site to a production site. • To export specific batch classes that have been updated for production. first synchronize all remote sites with the central site. choose whether to select or clear the “Export KCNS profiles” check box. add selected batch classes to “Selected Batch Classes” for export. on the KCNS Profiles tab. on the Batch Classes tab. are exported). before importing data. 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. you may want to export certain types of administrative data. • To export KCNS profiles that have been updated for production. If you choose. in the Export dialog box. Also. 108 Kofax Capture 8 Installation Guide . you can import only the modifications from the last update. To export administrative data to prepare for disaster recovery In the Export dialog box: • On the Batch Classes tab. To export administrative data from a development system Depending upon your goals. (Selecting this option always exports all KCNS profiles).Chapter 6 incrementally transfer those settings to the production system. as explained below. in the Export dialog box. • On the KCNS Profiles tab. including linked. select the “Export user profiles” check box to export user profiles (All users and groups. add all batch classes to “Selected Batch Classes” for export. • To configure any settings that are not imported (user profile checkbox and default group). Select the file that contains the exported batch classes obtained in Step 1 and click Open. • If you import batch classes. you can substitute new values for the configuration settings. before importing. For more information. • To make an exact copy of administrative data from another site. on the Batch Classes tab: a Add all batch classes to “Selected Batch Classes” for import. see “Data and Path Substitution” in this chapter. • If you already imported administrative data in an order other than the recommended order. For more information. KCNS profiles. 7 Click Import. This ensures that batch class assignments are available for the already imported KCNS profiles and user profiles. Kofax Capture 8 Installation Guide 109 .Disaster Recovery Importing Administrative Data Recommendations • Importing all data at the same time is recommended because it automatically imports data in the correct order. and user profiles separately. To import batch classes 1 2 3 4 5 6 Export batch classes using the recommendations in Exporting Administrative Data on page 108. be sure to delete user profiles on the production (target) system with identical names as user profiles on the development (source) system. see “Enabling the User Profiles Feature” in the Getting Started Guide. When the unpacking process completes. you can still add batch class rights and assignments. Select File | 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. • When you export administrative data from one system and import it to another. see “Assigning Batch Classes to Users” in the Getting Started Guide. be sure to import batch classes last. In the Import dialog box. Open the Administration module. click OK. When the unpacking process completes. click OK. if you later import batch classes. b Select the “Replace existing KCNS profiles” option. 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. Select the file that contains the exported KCNS profiles obtained in Step 1 and click Open.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. you can manually update them on the target system. 110 Kofax Capture 8 Installation Guide . Note If you do not manually delete all user profiles and import new ones from the source system. click OK. Open the Administration module. In the Import dialog box. on the KCNS Profiles tab: a Select the “Export KCNS profiles” check box to import all KCNS profiles. In the Import dialog box. Delete all user profiles on the target system. Open the Administration module. However. including linked. When the unpacking process completes. 7 Click Import. select the “Import user profiles” check box to import user profiles (All users and groups. Select File | Import. are imported). To import only exported user profiles 1 Export user profiles using the recommendations in Exporting Administrative Data on page 108. Select the file that contains the exported user profiles obtained in Step 1 and click Open. they may get assigned to users you did not intend to modify. on the User Profiles tab. Select File | Import. Note that if a release script has not been registered and the remote site has been designated for remote release. 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. once fixed. Kofax Capture 8 Installation Guide 111 . 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).) Follow steps 3 through 7 in the previous procedure. However. Add the reinstalled alternate central site to the KCNS Server Central Site Manager. Release script installation and registration for non-Kofax scripts must be performed at the central and remote sites using the release script registration utility. 3 Reinstalling an Alternate Central Site If you reinstall an alternate central site (using the same name but with a new GUID). (If you do not delete them. release script setup must be performed at the central site. Releasing at Remote Sites You can release batches at remote sites. the import process automatically skips them.Disaster Recovery 2 Delete only the user profiles on the target system that have identical names as user profiles on the source system. an error is not returned at the remote site during batch class synchronization. you can re-release the batch. • Use a workflow agent to route the batch to another remote site. If these issues caused the release to fail. Import the exported KCNS profiles to the alternate central site with the “Replace existing KCNS profiles” option selected. If Release Fails at a Remote Site If release fails at a remote site. there may be colliding document IDs. When releasing to a common back end document management system.Chapter 6 • Recall the batch and release it at the central site. alternate central. If both sites release to the same back end document management system or merge data. • When a remote site releases a batch. there may be duplicate batches. use Document GUIDs when possible. 112 Kofax Capture 8 Installation Guide . so if multiple sites (primary central. or remote) release to the same database or merge their data. Notes • Document IDs are unique per site. if the central site recalls the batch before the remote site synchronizes. then the central site can also release the batch. refer to the online Help by clicking Help or pressing F1 from within the utility interface. • You are using a Kofax Adrenaline SCSI scanner controller (without VRS) with a “compatible” scanner. and more. • You are using Kofax Capture with a “compatible” scanner. 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. For detailed information about all the Scanner Configuration Utility options and features. Kofax Capture 8 Installation Guide 113 .Chapter 7 Setting Up Source Devices Introduction The Scanner Configuration Utility is a tool used to configure your source devices. restore scanner default settings. there is no further source device configuration necessary. However. which is a scanner that has not gone through the VRS certification process. If the appropriate scanning drivers you want to use are installed. When you install Kofax Capture. You can also use the Scanner Configuration Utility to set your default scanner. and you want to create a source other than the default source. several scan sources are already available for use. select your source device from the list of available image devices. Figure 7-1. or if their drivers are installed on the computer. 114 Kofax Capture 8 Installation Guide . Scanner Configuration Utility 3 Click Configure Sources. Scanners will appear on the list if they are VRS certified scanners. In the Scanner Configuration Utility dialog box (Figure 7-1). The Configure Sources dialog box will display.0 | Scanner Configuration Utility.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. 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 Kofax Capture 8 Installation Guide 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 Kofax Capture 8 Installation Guide 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. Kofax Capture 8 Installation Guide 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 Kofax Capture 8 Installation Guide Kofax Capture Network Server Operating Requirements Minimum Hardware Requirements 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 Recommended Hardware Requirements 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 Kofax Capture 8 Installation Guide 119 or equivalent 256 Mbytes or more 760 Mbytes or more for installation and working space during processing. 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. small fonts 100 Mbps Display: NIC: System Requirements The following are the system requirements for installing KCN Server. with approximately 150 Mbytes of this on the local hard drive.Chapter 8 KCN Service Operating Requirements The following lists the KCN Service operating requirements. You may need even more disk space if you have many image files or a large database (on a standalone workstation). Minimum Hardware Requirements The remote components of KCN Server are installed when Kofax Capture is installed on a remote client or standalone workstation. • 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 Kofax Capture 8 Installation Guide . 1024 x 768 with 24 bit color. Processor: System memory: Disk space: Pentium 4 processor. Kofax Capture 8 Installation Guide 121 .Kofax Capture Network Server Operating Requirements KCN Server License Requirements The KCN Server remote site workstations do not require hardware keys. KCN Server requires the appropriate licenses. See the online Help for more information on licensing. However. Chapter 8 122 Kofax Capture 8 Installation Guide . Folder permissions can be set by right-clicking the folder name from Windows Explorer and selecting Properties | Security tab. if you install Kofax Capture and your Web server software on different computers. ensure that the logged in user has full administrative privileges. the installation environment needs to be set up correctly.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. Setting Up Your Environment For Kofax Capture and KCN Server to be successfully installed. Privileges and Permissions Before the actual installation is performed. This chapter begins with general installation notes regarding your KCN Server environment. 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. Refer to your Windows documentation for additional information. Carefully review the following information. UNC Support At your central site. you must specify the path to the Kofax Capture server files and Kofax Capture 8 Installation Guide 123 . and continues with a discussion of some decisions that need to be made before proceeding with the installation. KCN Server remote sites can communicate with the Internet through a proxy server. To use a proxy server with KCN Server remote sites. open Internet Explorer. If you want to use alternate ports. for specific purposes.0 allows remote sites to communicate with the Web server on ports other than port 80 for HTTP and 443 for SSL. Proxy Server Support KCN Server can run in a proxy server environment. The KCN Web Server can communicate with the Internet through a proxy server.Chapter 9 the path to the file cache folder locations in UNC format. and that your firewall (if any) will allow its use. be sure to first consult with your administrator. Microsoft’s ISA Server 2000. The dynamic and private ports are open for general use. but have not been tested or certified by Kofax. Although you can specify any port number from 0 to 65535. ports in the first two ranges are used. your primary concerns should be ensuring that the port is free. 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. To configure your proxy server settings in Microsoft Internet Explorer. and then select Tools | Internet Options | Connections | LAN Settings. you should keep in mind possible conflicts with other processes that may be using communications ports. the KCN Server setup application will determine the path automatically. For example: \\ServerName\Capture Share If you install Kofax Capture and your Web server software on the same computer. you must enable and configure the proxy server address and port number in the browser for every computer that uses a proxy server. 124 Kofax Capture 8 Installation Guide . either by convention or registration. Web Server Port Numbers KCN Server 8. When selecting an alternate port. and is certified to work with. In general. Other proxy servers may work. Note KCN Server has been tested. Planning Your Kofax Capture Network Server Installation Custom Module and Workflow Agent Support Considerations KCN Server supports Kofax Capture custom modules and workflow agents. you must use the command line method. you must register the custom module or workflow agent at your central site and at each remote site (that requires it). and the decisions you make in the following sections. Planning Your Installation There are various ways that you can configure your installation. ensure that you have first read Planning Your Kofax Capture Installation on page 25. ensure that you have a working knowledge of: • • • • Your network configuration Kofax Capture The Internet Your Web server software Before installing KCN Server. Displays from a workflow agent will stop the KCN Service from inserting batches into the Kofax Capture workflow. A workflow agent is a custom program that allows custom routing of batches. plan your installation in light of the decisions you made for Kofax Capture. For instructions on registering custom modules or workflow agents for KCN Server remote sites. after you install KCN Server. If you plan to use a custom module or workflow agent at your remote sites. Before installing KCN Server. 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. Then. In that case. see the Kofax Capture Getting Started Guide. For more information on workflow agents and custom modules. Note Activating KCN Server on a remote site will disable the Kofax Capture Administration module on that site. The following information can help you make informed decisions. Therefore. you will have to manually restart the KCN Service. Planning decisions that should be made prior to installing KCN Server are: • KCN Service locations • KCN Service (“Log on as”) user account Kofax Capture 8 Installation Guide 125 . to register custom modules or workflow agents at remote sites. if necessary High Availability requirements (if any) Note The Deployment Utility may not be used to deploy KCN Server installations. General Considerations The following elements should be considered as a means of getting the best performance from your KCN Server installation.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. The KCN Service can be very I/O intensive. Even multiprocessor computers may not be satisfactory to run the KCN Service along with other software. there should be at least one KCN Service per 50 remote sites. Decisions Before Installing KCN Server There are certain decisions that you need to make before installing KCN Server. if the other applications are CPU intensive instead of I/O intensive. • Overall. However. not the Web server). this may be acceptable. 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 Kofax Capture 8 Installation Guide . • KCN Service computers should not have any other software (Kofax Capture modules or other) running on them. Specifically. KCN Service Locations The KCN Service is responsible for responding to requests from the remote sites. there should be at least one KCN Service (on a client workstation. • There should be one KCN Server file cache on each computer hosting a KCN Service. • For each Web server at the central site. Note To verify that the KCN Service is running. recommended. In the Description column next to Service.Planning Your Kofax Capture Network Server Installation The KCN Service must reside at the Kofax Capture central site on a standalone installation. consisting of: One computer for Kofax Capture. the KCN Server file cache folder location. • Recommended configuration. You can select the local system account or specify another user account. the Kofax Capture license server. consisting of: One computer for Kofax Capture and the Kofax Capture license server Kofax Capture 8 Installation Guide 127 . you should install Kofax Capture and enable the KCN Service on more than one workstation at your central site. the KCN Server file cache folder location. from the Control Panel select Administrative Tools | Services. KCN Service will display. The following are examples of minimal. such as your available hardware and your security policy. or a separate client workstation. 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. and highly scalable configurations. the KCN Service. Note We recommend that you run one KCN Service for every 50 remote sites. The configuration that you use will depend on various factors. The Service will display in the Name column. You must have Full Control permissions to the Kofax Capture and KCN Server file cache folder locations. • Minimal configuration. consisting of one computer for Kofax Capture. and the KCN Web server components. 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. a server with a client workstation installed. KCN Server Software Component Configurations The KCN Server software components can be configured to reside on one or more computers. Therefore. if you anticipate having more than 50 remote sites uploading batches. You can run only one KCN Service per central site workstation. which are accessed by both the KCN Service and the Web server. standalone installations. by default. but you may wish to limit or prohibit direct access by users through the NTFS security settings. the remote sites can continue to synchronize using the remaining file cache folder locations. The Web site must be accessible to the remote site. Note The cache folders must be accessible to the Web Server's Anonymous User account. File Cache Folder Locations The file cache folder locations. on the Kofax Capture server. are used to hold batches uploaded from remote sites until the data can be inserted into Kofax Capture at the central site. The Web server requires network access to the file cache folder locations. You might want to create multiple file cache folders so that if one file cache folder location fails. See Configuring Additional File Cache Folder Locations on page 146 for additional information on multiple cache locations. 128 Kofax Capture 8 Installation Guide . This “cache affinity” reduces network overhead and may increase performance.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. or a mix of both installations. a KCN Service will “prefer” to use its local cache directory (if there is one) rather than the other caches. The file cache folder resides. 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. If you have cache folders in multiple locations. 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. provided other factors (such as batch priority) are equal. If the permissions are not set correctly. 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. Note During installation of KCN Web Server components on a domain controller that is also running the IIS Web Server.exe attempts to run.kofax. which you can use for your KCN Server installation. point your browser to the support section of www. If you are using IIS. you will not be able to upload batches. it creates a default Web site.com and search the knowledge base for QAID (KB Article ID) number 587.Planning Your Kofax Capture Network Server Installation Note If you want to use a Web site that does not currently exist on your KCN Web Server. Kofax Capture 8 Installation Guide 129 . create the Web site before starting the installation of KCN Server. For more information on how to resolve this issue. The “to do” list can be found at: <KCN Server installation folder>\Logs\ACICfgWzToDo. The KCN Server anonymous user account must have the permissions listed in the “to do” list. This is a known Microsoft issue. 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.log after the installation completes. an error is logged to the event log when the aspnet_wp. The permissions include: • “Full Control” permission to the file cache folder location (including share permissions. 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. your remote sites will be unable to synchronize with the central site. Account must exist on both the Web server and the server where the file cache folder locations reside at the central site. and require a secure channel to the Web site for KCN Server. Note If you plan to use SSL. rerun the configuration wizard to reconfigure the anonymous user account. Your remote sites will be able to synchronize with the central site. With KCN Server. such as which modules and batch classes will be accessible to a remote site. If you do accidentally set a new password.Chapter 9 In addition to the above rights. If you create the profiles before creating the sites. be sure to name the sites the same as their profiles. you can create remote site profiles to assign to the remote sites. If you do. Remote Site Name The remote site name defaults to the computer name. Account must be a domain-wide account. 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). The profiles specify settings. you should choose a name that is meaningful to you. If you require a secure channel after installing the KCN Web Server components. Do not set a new password. This will facilitate automatic assignment of the profiles 130 Kofax Capture 8 Installation Guide . The account must have the same password on both servers. Since the remote site name is used to identify the remote site in the central site Administration module. the permissions listed in the following table apply to the KCN Server anonymous user account: Table 9-1. you may be presented with a prompt to set a new password on the KCN Server virtual directories. This will allow you to set the new port number in the initialization file for use during a Kofax Capture automatic installation. Kofax Capture 8 Installation Guide 131 . See the section Setting Your IIS Port Configuration on page 165 for more information. ^ < > ? % If you change the site name. you may experience intermittent and unpredictable problems. 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. * $ . you will loose contact with all remote sites and they will all have to update the Web Server URL before they can upload. Furthermore. you must ensure that the ports you assign are not being used by other applications or services. however if possible you should make this decision prior to installation of your remote sites. and may not include the following characters: ' & “ . Note When selecting alternate ports. If there are port conflicts. and all SSL communications use port 443. if you later change the port number.Planning Your Kofax Capture Network Server Installation to the sites. If you do not want to use the default KCN Web Server ports. you can assign alternate ports either before or after installation. all HTTP communications use port 80. 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. depending on whether the following rule was specified for the new remote site behavior: “Assign to site profile matching site name if it exists. ( ` / ) = ~ _ \ ! + { @ | } # : . You can change the port number at any time. Chapter 9 High Availability Installations You can elect to take advantage of one or more of Kofax Capture’s High Availability capabilities. Microsoft Cluster Services. and more. These include support for Web farms (using Microsoft Network Load Balancing). backup license servers. 132 Kofax Capture 8 Installation Guide . Refer to Chapter 5 – Installing Kofax Capture Enterprise on page 61 for information about Kofax Capture’s high availability support in conjunction with KCN Server. nor do they cover every decision you may be asked to make. All of the steps must be performed in the order listed. KCN Server Installation Steps The following is an overview of the major steps for installing KCN Server. Step 1 Step 2 Step 3 Step 4 Step 5 Check your environment at the central site. Install the KCN Web server components at the central site. Convert Kofax Capture remote installations to remote sites. It is important that you follow the installation steps exactly in the order given. Each of the major steps is detailed after the overview. key decisions.Chapter 10 Installing Kofax Capture Network Server Introduction This chapter provides step-by-step instructions for installing Kofax Capture Network Server (KCN Server). Install Kofax Capture at the remote sites. Instead. If you are upgrading KCN Server. the focus is on major milestones. Kofax Capture 8 Installation Guide 133 . and possible areas of confusion. see Upgrading/Updating on page 154. Enable the Kofax Capture Network Service (KCN Service) at the central site. The instructions do not describe every installation screen you may see. it is not installed by default. and all SSL communications use port 443. • Refer to Chapter 3 – Planning Your Kofax Capture Installation on page 25 for information about ensuring the installation is smooth and accurate. 134 Kofax Capture 8 Installation Guide . create or use an existing Web site. For example: http://MySite. • If your Web server software is not already installed at your central site. and plan to use IIS as your Web server. all HTTP communications use port 80. There are no special requirements for installing Kofax Capture when it will be operating with KCN Server. Verify that you can contact the Web site by typing in the address area of your browser: http://computername. If you are upgrading to Windows 2000 Server or Windows Server 2003. with Windows Server 2003.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. • If you have not already done so. KCN Server Check Points Check the following: • Ensure that the central site meets the operating and license requirements for KCN Server. follow the manufacturer’s instructions that came with your Web server software. Refer to Chapter 8 – Kofax Capture Network Server Operating Requirements on page 117 for information about the KCN Server operating and licensing requirements. • By default. However. you must explicitly install IIS. • 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. Refer to Chapter 2 – Kofax Capture Operating Requirements on page 3 for information about operating requirements and licensing requirements. be sure that IIS is installed after the upgrade. Kofax Capture Check Points Check the following: • Ensure that the central site meets the operating and license requirements for Kofax Capture. Note Internet Information Services (IIS) is installed on a Windows 2000 Server by default. Installing Kofax Capture Network Server • WebDAV is not required for file insertion to the KCN file cache. Right-click and select properties.0 KCN Server will be unable to upload files to a central site if WebDAV has been disabled.0 before removing WebDAV from the central site server. By default. • Ascent Capture 6. be sure to upgrade all remote sites to Kofax Capture 8. Figure 10-1. Therefore. When selecting alternate ports.x remote sites that connect to an 8. you may experience intermittent and unpredictable problems. Web Site Properties Dialog Box Kofax Capture 8 Installation Guide 135 .x and Ascent Capture 7. WebDAV is disabled in IIS. If there are port conflicts. refer to the manufacturer’s instructions for operational details. To select an alternate port in IIS 1 2 3 Run the Internet Information Services administrative tool. you must ensure that the ports you assign are not being used by other applications or services. you can optionally disable it by running the IIS Lockdown Tool. If WebDAV is enabled. Select the Web Site where KCN Web Server Components are installed. The following example is specific to IIS. Note If you are not using IIS as your Web server. The Default Web Site Properties dialog box displays. To enable the KCN Service 1 At the command line at the central site.Chapter 10 4 Change the TCP Port setting to the desired number. enter: <Kofax Capture installation folder>\Bin\aciscfg. See Setting Your IIS Port Configuration on page 165 for more information. the logged in user must have administration rights. Enabling KCN Service – Sample Initial Display 136 Kofax Capture 8 Installation Guide . The Enable Kofax Capture Network Service dialog box will display. for example 8080. Figure 10-2.exe. Step 2: Enable the KCN Service at the Central Site To enable the KCN Service at the central site. Note Changing the port configuration will also require changing the port specification at your remote sites. view the Description column for Kofax Capture Service. you must configure the folder permissions before continuing with the installation. do one of the following: • Select Local System account. click OK. To verify that the service was added. The user must have the specified permissions to both the Kofax Capture folder and the file cache folder locations. Only select this option. If any problems were found while enabling the KCN Service. the specified user must have access to all KCN Server resources and all resources required by the licensing service. In the case of warnings. • Select the User name option. correct the errors. The user name and domain boxes will automatically be populated after you make your selection. Then. In the case of errors. Note We recommend that the KCN Service be installed on any workstation other than the Kofax Capture Server. a dialog box will display listing errors or warnings. Then. the KCN Service will successfully enable. The user must have the specified permissions to both the Kofax Capture folder and the file cache folder locations. • Select the User name option. Note On a standalone computer or the Kofax Capture Server computer. The local system account will be used. enter the user name. password and domain.Installing Kofax Capture Network Server 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. 2 In the Log on as area. and enable the KCN Service again. and then click OK. and click OK. browse to select the user name and click OK. Then. The KCN Service will be added to the Kofax Capture Service description as an enabled service. if both the Kofax Capture folder and the file cache folder locations are on the local computer. from the Control Panel select Administrative Tools | Services. Kofax Capture 8 Installation Guide 137 . If those permissions have not already been set up. Sources of Errors or Warnings when Enabling the KCN Service Error/Warning Message KCN Service not found Possible Cause Possible Resolution Logon user name. If this is an initial installation. Retype logon user name. and domain. ensure you have obtained an activation code and have activated the licenses using the code within three days of receiving your software. entered KCN Service(s) cannot Incorrect permissions for the Modify the permissions to be (Full connect to cache folder(s) folders. and free some disk space. then continue with Step 4: Install KCN Server Remote Sites on page 142. folders do not exist or select a different user. 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. see WebSphere on page 170. or the Control) for the file cache folders. or domain was incorrectly password. 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. password. 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 necessary. Table 10-1. Verify that there is enough disk space.Chapter 10 Some examples of more common errors are listed in the following table. If you are using WebSphere. 138 Kofax Capture 8 Installation Guide . Follow the installation procedure exactly. For example. you must ensure that the anonymous user account has read/write permissions for certain folders. If the permissions are not set correctly. The installation configures anonymous access for each of the KCN Server virtual directories. 2 Kofax Capture 8 Installation Guide 139 .exe from the CD. select Install/ Upgrade KCN Web Server Components. run Autoplay. If necessary. The “to do” list can be found at: <KCN Server installation folder>\Logs\ACICfgWzToDo. the installation will also display a “to do” list of tasks that must be completed before you run KCN Server for the first time.Installing Kofax Capture Network Server 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. Do not select it if you are using another Web server application. so the installation will automatically begin. you will not be able to upload batches. To install KCN Web server components on IIS 1 Insert the Kofax Capture installation CD 1 into the CD drive on your Web server. Note This menu item is for use with IIS only. Refer to KCN Server Anonymous User Account on page 129 for more information about anonymous user accounts. The procedure includes many important notes about settings you must change if your computer varies from the typical configuration. The CD supports AutoPlay. Selecting the option initiates the KCN Web Server installation.) From the main installation menu shown in Figure 10-3. you will need to specify the anonymous user account and the locations for the KCN Server components.log after the installation completes. and read all instructions carefully. This will configure typical Web server settings for KCN Server. For example. (If it doesn’t start. 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. The instructions for adding more file cache folders are provided later in this chapter. KCN Server Main Installation Menu 3 Follow the instructions from the installation.Chapter 10 Figure 10-3. you only specify one at this point. • Anonymous user account 140 Kofax Capture 8 Installation Guide . When prompted. Then. reboot your Web server. the installation will continue. 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. Current user account: DJVM2K3\sqaadmin Write test successful for all file caches. These are provided for your information only. or must be a member of a group that has this permission. The contents of the list will vary depending on your equipment and settings. Complete all the items in the “to do” list. Kofax Capture 8 Installation Guide 141 . January 15. ======= Kofax Capture Network Server Configuration Wizard: Tuesday. see NTFS Security Settings in Appendix B for additional information. 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. An example of a “to do” list is provided below. This is a Microsoft security requirement for anonymous or basic authentication. see Anonymous User Account on page 166. 2008 3:32:17 PM You may ignore entries referencing local FAT or FAT32 path statements. To determine whether the anonymous user account has “Log on locally” permission.Installing Kofax Capture Network Server Note The user name specified for the anonymous user account must have “Log on locally” permission for the Web server. See also KCN Server Anonymous User Account on page 129 for more information on the Anonymous User Account.Proceed to Step 4: Install KCN Server Remote Sites. the “to do” list will display. Note If you installed KCN Server and/or Kofax Capture on NTFS partitions. 4 If generated. Kofax Capture will be installed or upgraded on the remote site. Insert the Kofax Capture installation CD 1 into your CD drive. if the alternate TCP port number is 8080. (If it doesn’t start. The installation screens contain additional information that will guide you through the installation process. run Autoplay. From the menu bar. and toolbars) that might be running. For example. Follow the instructions on your screen to install the software. The CD supports AutoPlay. The KCN Server remote site will validate the specified URL by attempting to contact the Web site. so the installation will automatically begin. If you are not using the default port number. 3 4 142 Kofax Capture 8 Installation Guide . The installation will start. To convert remote installations to remote sites 1 2 At the remote installation. open Batch Manager.com:8080/acis. virus detection software. shut down any applications (including the Control Panel. Specify the Web server URL (for example.Chapter 10 Step 4: Install KCN Server Remote Sites To install KCN Server remote sites 1 2 At the remote workstation. http://<Web server>). specify the Web Server URL and the new port number using the following syntax: <http protocol>://<Web server>[:port]/acis. 3 4 Step 5: Convert Kofax Capture Remote Installations to Remote Sites Next. and all batch classes created at the remote site will be deleted if you continue converting the installation. Be sure to read them carefully before proceeding with each step. select Install/Upgrade KCN Server Remote Site. and click Next.) From the main installation screen. See Chapter 4 – Installing Kofax Capture for more information. select Options | KCN Server | Convert to Remote Site. The Web Server URL dialog box will display. the URL would be similar to: http://www. A message will display warning you that the Administration module will be disabled. http://<Web server>/acis). It will append the KCN Server folder name (for example.Mysite. Select Yes to acknowledge the warning. you need to convert the Kofax Capture installation to a remote site.exe from the CD. Selecting Yes causes a shortcut to the RSA to be installed as an icon in the Windows system tray. 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. so polling will not occur until the RSA is activated. export them to . 5 If the Web server URL validation is successful. or select No to defer activation. You must activate the RSA on at least one station at each remote site. you must specify the URL with “https”. Remote site profiles allow you to easily assign various attributes to your remote sites. instead of “http” (for example. which allows it to upload batches and synchronize with the central site without having any user logged on. select either Yes to confirm the activation. The RSA allows you to upload batches and download batch classes without maintaining an ongoing connection to the Kofax Capture server. See Setting Up Remote Site Profiles on page 145 for more information. The remote station initiates polling through the RSA. where they can be imported. See the Installing Services appendix of the Kofax Capture Getting Started Guide for more information. Kofax Capture 8 Installation Guide 143 . If you want to keep these batch classes. Any existing batch classes at the remote installation will be lost. you are prompted to activate the RSA. from the central site you can assign remote site profiles to the remote sites at this point. You can then send the .Installing Kofax Capture Network Server See Setting Your IIS Port Configuration on page 165 for more information. when you are ready to activate the RSA. 6 If desired.cab files to your central site. see Activating the RSA on page 152. The RSA can optionally be installed as a service.cab files first. If you select No. https://<Web server>). Note If the Web site requires SSL. Figure 10-4. When you are prompted to confirm the activation. Chapter 10 All remote sites are initially assigned a default remote site profile. All remote sites are initially assigned a default remote site profile. and other configuration tasks that are performed at the remote site. You can assign a different profile to a remote site at any time. depending on the central site settings. depending on the central site settings. and the Kofax Capture Getting Started Guide for more information. See Assigning Remote Site Profiles to Remote Sites on page 145. See Assigning Remote Site Profiles to Remote Sites on page 145. 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. Configuration Tasks There are various configuration tasks that are performed at the central site. 144 Kofax Capture 8 Installation Guide . and the Kofax Capture Getting Started Guide for more information. Other configuration tasks can be performed only after certain installation steps have been performed. Some configuration tasks can be performed at any time. You can assign a different profile to a remote site at any time. new remote sites are assigned either the profile that matches the site name or the remote site profile named “(Default)”. or Save As to save the changes to a new profile. To assign profiles to remote sites 1 Open the Administration module at the central site. select Edit | Profiles | KCN Server Remote Site Profiles. Select either Save to save the changes to the selected profile. You can assign a different remote site profile to each remote site. By default. 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. provide a name for the new profile that matches your expected remote site names. See the Kofax Capture Getting Started Guide for a description of the KCN Server Remote Site Profiles dialog box. if centralized polling has been selected To set up a remote site profile 1 From the Administration module at the central site. Kofax Capture 8 Installation Guide 145 . 2 3 4 Assigning Remote Site Profiles to Remote Sites You can perform this step at any time after installing KCN Server.Installing Kofax Capture Network Server Setting Up Remote Site Profiles You can perform this step at any time after enabling the KCN Service. The KCN Server Remote Site Profiles dialog box will display. all sites sharing the same profile will be affected by the changes. If you choose Save As. Note If you edit a profile that is assigned to several sites. Select or type information on the tabs on the KCN Server Remote Site Profiles dialog box. Select an existing remote site profile. You may want to set up remote site profiles to assign to remote sites. and as often as necessary. The same profile can be assigned to two or more remote sites. Shared profiles are stored in the “SharedScannerProfiles” folder beneath the Kofax Capture <ServerPath> folder. a KCN Service will “prefer” to use its local cache directory. Local profiles are stored in the “ScannerProfiles” folder beneath the Kofax Capture <LocalPath> folder. Note On a standalone installation. Scanner profiles. are stored in a folder specific to the scan source and can either be local or shared. shared profiles are not enabled and the shared profiles folder does not exist.Chapter 10 2 3 4 Select Tools | KCN Server | Remote Site Manager. Only users with rights to access Administrative Utilities can save local profiles as shared or revert to shared profiles. If you have cache folders in multiple locations. Configuring Additional File Cache Folder Locations You can perform this step at any time after installing KCN Server. The KCN Server Remote Site Manager dialog box will display. select the remote site. To share scanner profiles. make sure that you have selected the “Allow admin utility usage” setting. select Scan | Scanner Profiles | Save Profiles as Shared. From the list of remote sites. 146 Kofax Capture 8 Installation Guide . see File Cache Folder Locations on page 128. select the remote site profile that you want to assign to the selected remote site. including VRS profiles. For more information on why you might want to use more than one file cache folder location. Note If User Profiles is enabled. From the list of remote site profiles. Scanner Profile Locations The profile storage location is a hierarchical set of folders organized by scan source. Sharing Scanner Profiles You can save profiles to a shared location on the network and make them available to other users. This “cache affinity” reduces network overhead and may increase performance. You cannot have two or more file cache folder locations having the same cache number. Statistics data are only inserted after all batches have been inserted. If you decide to use more than one file cache folder location. first out basis. 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. The path must not exceed 138 characters.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. • Batches are processed in order of priority. Run the KCN Server configuration wizard from the KCN Server installation folder \Bin folder.exe. Shut down all Kofax Capture applications and services. modify the KCN Server section in the <Kofax Capture installation folder>\Config\ACConfig. The rules by which the KCN Service processes work queued at the central site are (in order): • All caches are processed. there are a number of other settings that can override the KCN Service’s natural affinity for its local cache.” You do not need to Kofax Capture 8 Installation Guide 147 . • Batches are processed before statistics data. Batches of a particular priority are processed from the local cache first and then from remote caches. it will be processed before work that was uploaded through the RSA. That is. Batches are processed in order of creation from the local cache first and then from remote caches. however local caches are processed before remote caches. • Batches are processed on a first in.Installing Kofax Capture Network Server However. 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. 4 5 Restart the services that you shut down. Then. The wizard is named “AciCfgWz. • “Interactive” requests are processed first. if you specifically upload a particular batch from Batch Manager. 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. To enable additional KCN Services 1 At the command line.Chapter 10 make any changes on the displays while the configuration wizard is running.exe. you may need to enable additional KCN Services to have better performance. To enable the KCN Service at the central site. enter: <Kofax Capture installation folder>\Bin\aciscfg. the logged in user must have administration rights. Enabling KCN Service – Sample Initial Display 148 Kofax Capture 8 Installation Guide . If you have more than 50 remote sites connected to a single central site. The Enable KCN Service dialog box will display. Figure 10-5. You should see the additional file cache folder locations listed. Enabling Additional KCN Services You can perform this operation at any time. and enable the KCN Service again. 2 In the Log on as area. • Select the User name option. To disable the KCN Service. • Select the User name option. The local system account will be used. if both the Kofax Capture server files folder and the file cache folder locations are on the local computer. Then.exe /d. a dialog box will display listing errors or warnings. Kofax Capture 8 Installation Guide 149 . click OK.Installing Kofax Capture Network Server 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. In the case of warnings. to be able to use the service you must re-enable it. The user name and domain boxes will automatically be populated after you make your selection. the uninstall program will automatically disable the KCN Service. Note We recommend that the KCN Service be installed on any workstation other than the Kofax Capture Server. browse to select the user name and click OK. the KCN Service will successfully enable. Stopping the KCN Service You can perform this operation after KCN Service has been enabled. run the following from the command line: <Kofax Capture installation folder>\Bin\aciscfg. In the case of errors. you need to disable it. correct the errors. The user specified must have Full Control permissions to both the Kofax Capture server files folder and the file cache folder locations. and click OK. After disabling the KCN Service. Only select this option. Note If you attempt to uninstall Kofax Capture and a KCN Service is running. enter the password and domain. 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. and then click OK. Then. Disabling the KCN Service You can perform this operation after KCN Server has been installed. do one of the following: • Select Local System account. If you want to remove the KCN Service from a computer. The Web Server URL dialog box will display. select Administrative Tools | Services | Kofax Capture Service | Action | Stop. It does not remove the service. the Administration module will be disabled at the remote site. 3 150 Kofax Capture 8 Installation Guide . You can then send the .Chapter 10 Stopping the KCN Service causes the service to be made temporarily unavailable. 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.cab files first. export them to . you need to start it to use KCN Server.cab files to your central site. Note After conversion. Remote Site Configuration Tasks This section contains a number of tasks you may need to perform when configuring your remote sites. where they can be imported. you must restart it or reboot. 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. To stop the KCN Service. from the Control Panel. select Options | KCN Server | Convert to Remote Site. select Administrative Tools | Services | Kofax Capture Service | Action | Start. Starting the KCN Service If you stopped the KCN Service. From the menu bar. To convert a remote installation to a remote site 1 2 Open the Batch Manager module at the remote site. Converting a Remote Installation to a Remote Site You can perform this step after the KCN Server is installed. To resume using the KCN Service. Any existing batch classes at the remote installation will be lost. Select Yes to acknowledge the warning. from the Control Panel. To start the KCN Service. If you want to keep these batch classes. If desired. Select Options | KCN Server | Web Server URL. To specify the Web server URL 1 2 3 Open the Batch Manager module.Mysite. A shortcut to the RSA will be installed as an icon in the Windows system tray.com:8080/acis. Specify the Web server URL (for example. you must specify the URL with “https”. if the alternate TCP port number is 8080. See Setting Your IIS Port Configuration on page 165 for more information.” For example. <http >://<Web server>[:port]/acis. The Web server URL dialog box will display.Installing Kofax Capture Network Server 4 Specify the Web server URL (for example. prompting you for valid credentials. For example. You will lose the batch classes and licensing from the old central site. The KCN Server will validate the specified URL by attempting contact the Web site. specify the Web Server URL and the new port number using the following syntax: <http protocol>://<Web server>[:port]/acis. Click OK. http://Web server) If you are not using the default port number. the Connect to Central Site dialog box displays. Note If the Web site requires SSL. instead of “http. 5 6 If authentication was enabled and credentials were not already supplied during installation. if you switch central sites. the URL would be similar to: http://www. Ensure that you have no batches in process. specify the Web Server URL and the new port number using the following syntax: <http protocol>://<Web Kofax Capture 8 Installation Guide 151 . http://Web server) If you are not using the default port number. 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. Http protocol includes both http and https. 7 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. Enter a valid user name and password and click OK. select Yes to confirm that you want to activate the RSA at the remote site. instead of “http. Select Options | KCN Server | Activate RSA on This Station. Http protocol includes both http and https. Activating the RSA You can perform this operation after converting an installation to a remote site.Mysite. To activate the RSA 1 2 Start Batch Manager. You must activate the RSA on at least one station at each remote site. the RSA Authentication Settings dialog displays. the URL would be similar to: http:// www. nothing is saved and the remote site conversion process does not continue. Once proper credentials are provided. it must establish a connection with the central site web server. 4 Click OK. When you are prompted to confirm the activation. if the alternate TCP port number is 8080. Once you have activated the RSA. If an authentication scheme has been enabled. The RSA allows you to upload batches and download batch classes without maintaining an ongoing connection to the Kofax Capture server. Selecting Yes adds the RSA to the Windows system tray (see Figure 10-4 on page 143). 152 Kofax Capture 8 Installation Guide .com:8080/acis. or select No to defer activation. prompting you for a user name and password. you must specify the URL with “https”.” For example. Refer to the Installing Services appendix of the Kofax Capture Getting Started Guide for more information.Chapter 10 server>[:port]/acis. See Setting Your IIS Port Configuration on page 165 for more information. Use the following steps to activate the RSA. they are saved to the database and conversion continues. select either Yes to confirm the activation. you can also choose to install it as a service. Configuring Remote Site Authentication When you convert a Kofax Capture installation to a remote site. <http >://<Web server>[:port]/acis. Note If the Web site requires SSL. For example. The URL will be validated. If proper credentials are not provided. Note Kofax Capture 8. The RSA automatically reads and uses the client certificate when connecting to the KCN Web Server. 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. To share scanner profiles. Currently. Select Scan | Scanner Profiles | Save Profiles as Shared. select Tools | Internet Options | Content | Certificates | Import. During operation. Stop the RSA and then restart it. 2 3 4 5 6 7 Copy the Thumbprint entry for the client certificate. Sharing Scanner Profiles You can save scanner profiles to a shared location on the network and make them available to other users. remote sites must also be configured with a valid client certificate. Start the Windows Registry Editor (Start | Run | Open | regedit). if a valid client certificate is found in the registry. in order to connect. Close the Windows Registry Editor. Navigate to the following registry key: HKLM\SOFTWARE\Kofax Image Products\Kofax Capture\3. select File | Add/Remove Snap-in | Add | Certificates | Add. the RSA automatically uses the client certificate when connecting to the KCN Web Server.0 Create a new binary registry entry named Thumbprint and set the value to the previously copied Thumbprint value in Step 2. This is typically represented as a hexidecimal string. there is no support for the use of client certificates for authentication on WebSphere.0 supports the use of client certificates for authentication only where the KCN Web Server is running IIS. Kofax Capture 8 Installation Guide 153 . • In the Microsoft Management Console. You configure the client certificate by adding an entry to the remote site’s registry.Installing Kofax Capture Network Server Configuring a Client Certificate If the KCN Web Server is configured to require client certificates. x or 5.x to Kofax Capture 8.x to Kofax Capture 8. batches in progress are not allowed at remote sites.0 have been installed at the central site. • You do not need to change or adjust your scanner. Only users with rights to access Administrative Utilities can save local profiles as shared or revert to shared profiles.Chapter 10 Note If User Profiles is enabled. Scanner Profile Locations The profile storage location is a hierarchical set of folders organized by scan source.x to 8. it is not necessary to complete processing batches at the central site prior to upgrading. Upgrading/Updating The steps for upgrading or updating are the same as installing it for the first time.x or 7. Note Until both Kofax Capture 8. However. • You cannot upgrade directly from Ascent Capture 4. The Web site must remain stopped until KCN Server 8.0. • You must stop the Web site before upgrading. Note On a standalone installation.x or 7. • When upgrading Ascent Capture and ACI Server 6. or accelerator settings.0. source devices. make sure that you have selected the “Allow admin utility usage” setting. Scanner profiles. • When upgrading Ascent Capture and ACI Server 6. remote sites cannot synchronize.0 at the central site. shared profiles are not enabled and the shared profiles folder does not exist. However.0 and KCN Server 8. and then upgrade ACI Server remote sites. Shared profiles are stored in the “SharedScannerProfiles” folder beneath the Kofax Capture <ServerPath> folder. are stored in a folder specific to the scan source and can either be local or shared. 154 Kofax Capture 8 Installation Guide . Local profiles are stored in the “ScannerProfiles” folder beneath the Kofax Capture <LocalPath> folder.0 is installed. first upgrade Ascent Capture and then upgrade ACI Server. including VRS profiles. note the following: • Upgrade Ascent Capture and ACI Server at the central site first. Step 1 Step 2 Step 3 Step 4 Step 5 Stop the Web site. 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. Upgrade ACI Server. you must upgrade the remote site to restore its functionality.x batches to send to the central site.Installing Kofax Capture Network Server Converting Batches From Previous Releases After the central site has been upgraded. When these batches are uploaded to the central site. If you do not. Note You must upgrade Ascent Capture and ACI Server at your central site before you upgrade your remote sites. Warning You must stop the Web site for the duration of the entire central site upgrade process. Kofax Capture 8 Installation Guide 155 . You might want to enable the KCN Service on more computers for better performance and while remote sites running older versions still exist. Restart the Web site. you may experience significant KCN Server overhead during the conversion process. you must complete the upgrade at the central site. Enable the ACI Service. the remote site will lose all published batch classes and will not be able to function. remote sites can continue to create and process version 6. Stopping the Web site will prohibit remote sites from attempting to synchronize during the central site upgrade process. Depending on the size and number of batches that require conversion. and a remote site attempts to synchronize with your central site before both Ascent Capture and Ascent Capture Internet Server are upgraded. you must prohibit remote sites from synchronizing with your central site during the entire central site upgrade process. the batches are converted to 8. If this occurs.0 batches.x and 7. which must be done in the order listed. In addition. Upgrade Ascent Capture and republish your batch classes. Upgrading Your Central Site Upgrading your central site involves the following basic steps. Then. upgrade your standalone Ascent Capture station. Note Do not stop the Web site while remote sites are uploading batches. Under Active Service Pages. For more information on performance monitoring. Right-click the Web site folder. One way to check the upload activity is to use the Windows Performance monitor. select Start | Programs | Administrative Tools | Internet Information Services (IIS) Manager. view the Requests Executing statistic. To enable KCN Services at the central site. first upgrade the Ascent Capture server. Step 2: Upgrade Ascent Capture and Republish Your Batch Classes Upgrade your Ascent Capture software at your central site.1. After upgrading the central site. and that you have sufficient licenses. make sure the necessary hardware key is attached to your Ascent Capture server at your central site. see your Microsoft documentation. • For client/server installations. See the Kofax Capture online Help for more information on licensing. select Start | Programs | Administrative Tools | Internet Services Manager. In addition. Step 3: Enable the KCN Service You must enable the KCN Service at the central site. the logged in user must have administration rights. b On your Windows Server 2003 IIS Web server. This may cause batches to become unusable or lost.Chapter 10 To stop the IIS Web site 1 Do one of the following: a On your Windows 2000 Server IIS Web server. republish your batch classes. 2 3 Expand the Internet Information Services tree to display the Web site. Stop the service. To stop the WebSphere Web site 1 2 In your Windows Services manager locate IBM WebSphereAdminServer 5. 156 Kofax Capture 8 Installation Guide . • For standalone installations. and select Stop. and click OK.exe. The user name and domain boxes will automatically be populated after you make your selection. Note We recommend that the KCN Service be installed on any workstation other than the Kofax Capture Server. a dialog box will display listing errors or warnings. click OK. correct the errors. The local system account will be used. Step 4: Upgrade Ascent Capture Internet Server Upgrade the Ascent Capture Internet Server software at your central site. the KCN Service will successfully enable. • Select the User name option. The Enable KCN Service dialog box will display. Then. and then click OK. • Select the User name option. Then. If any problems were found while enabling the KCN Service. Note On a standalone computer or the Server computer. Any previously defined Ascent Capture Internet Server configuration settings will be preserved during the upgrade process. In the case of errors. The user specified must have read/write permissions to both the Kofax Capture server files folder and the file cache folder locations. enter: <Kofax Capture installation folder>\Bin\aciscfg. do one of the following: • Select Local System account. enter the password and domain. if both the Kofax Capture folder and the file cache folder locations are on the local computer. and enable the KCN Service again. browse to select the user name and click OK. 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. the specified user must have access to all KCN Service resources and all resources required by the licensing service. 2 In the Log on as area. The user specified must have read/write permissions to both the server files folder and the file cache folder locations.Installing Kofax Capture Network Server To enable the KCN Service 1 At the command line. In the case of warnings. Kofax Capture 8 Installation Guide 157 . Only select this option. Start WebSphere Application Server. When prompted to do so.1. Right-click the Web site folder. and select Start. reboot your Web server computer.Chapter 10 To upgrade Ascent Capture Internet Server 1 2 Make certain that your Web site on your Web server is stopped. The CD supports AutoPlay. Upgrade your Kofax Capture software at your remote site. so the installation will automatically begin. Note The central site must be upgraded before the remote installations are upgraded. (If it doesn’t start. Restart the service. if it is not already started. To do so. 158 Kofax Capture 8 Installation Guide . refer to Step 1: Stop the Web Site on page 155. you must restart the Web site. run AutoPlay.) Select Install/Upgrade Web Server Components for IIS. To restart the Web site on an IIS Web server 1 2 3 On your Web server. Expand the Internet Information Services tree to display the Web site.exe from the CD. Follow the instructions on your screen to upgrade the software. 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. Insert the Kofax Capture installation CD 1 into the CD drive on your Web server. 3 4 5 Step 5: Restart the Web Site After upgrading to Kofax Capture and KCN Server at your central site. To restart the Web site on a WebSphere server 1 2 3 In your Windows Services manager locate IBM WebSphereAdminServer 5. typically from the program group or a shortcut. select Start | Programs | Administrative Tools | Internet Services Manager. Remote sites will retain their profile settings that were already downloaded.Installing Kofax Capture Network Server 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. If you subsequently reinstall Kofax Capture 8 Installation Guide 159 .0” and click Change/Remove. For example. Note Deactivating or uninstalling a remote site will permanently remove all batches at the remote site. it will not remove your KCN Server virtual directory or change its properties. 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. All completed batches must be uploaded to the central site. close it. If you are upgrading a client/ server installation. • Affect KCN Server remote site profile settings. see Upgrading Client/Server Installations on page 54. right-click the RSA system tray icon and select Close. Open the Add or Remove Programs utility available from the Windows Control Panel. To convert a remote site to a Kofax Capture installation 1 2 3 4 If the RSA is open. Step 2: Upgrade Your Ascent Capture Software at Your Remote Site Upgrade the Ascent Capture software on your remote installation. If you have a remote site that you want to convert to an Kofax Capture-only installation. Kofax Capture will be uninstalled. To do so. To do so. use the Install/Upgrade Remote Site from the Autorun menu. Select “Kofax Capture 8. Reinstall Kofax Capture. Deactivating a Remote Site There is no way to explicitly uninstall or deactivate a KCN Server remote site. use the following procedure. Be sure to complete all batches and upload them to your central site before you execute the following procedure. Select “Kofax Capture Network Server 8.Chapter 10 the KCN Server software at the central site. Uninstalling KCN Server on IIS If you want to uninstall the KCN Server software at your central site. A remote site will download new settings the next time it synchronizes. use the following procedure. To uninstall the central site KCN Server software 1 2 From the Windows Control Panel. 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 WebSphere Refer to Uninstalling KCN Server Components on page 175 for more information about uninstalling KCN Server components on WebSphere. 160 Kofax Capture 8 Installation Guide . select Add or Remove Programs.0” and click Change/Remove. the remote sites and central site may no longer have the same settings. 2 3 Kofax Capture 8 Installation Guide 161 . Expand the Internet Information Services tree to display your KCN Server virtual directories. To display the KCN Server Web site properties 1 Run the Internet Information Services application from your IIS Web server station. The installation also generates a “to do” list. Refer to your Microsoft documentation for details on additional settings.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). you can enable additional settings. IIS settings are set by the KCN Server installation. select Start | Programs | Administrative Tools | Internet Services Manager. Be sure to complete all the items on the list before using 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. If desired. see Step 3: To Install the KCN Web Server Components on page 138. This section identifies the minimum IIS and NTFS security settings required by KCN Server. For a sample “to do” list. Right-click the applicable directory (ACIS or the ACIUpload0 directory) and select Properties. To do so. The KCN Server installation program (configuration wizard) sets the KCN Server virtual directory properties for you. only Windows 2000 Server dialog boxes are shown.Chapter 11 KCN Server Virtual Directory Properties The KCN Server virtual directory stores the KCN Server Web pages and associated program files. If you need to set the properties yourself. make sure the following settings are selected: • For permissions. KCN Server Virtual Directory – Required Properties 162 Kofax Capture 8 Installation Guide . enter KCN Server • For Execute Permissions. choose Read • For Application name. Dialog boxes for other Windows versions are not shown. For brevity. choose Scripts and Executables The KCN Server Properties dialog box will look similar to the following: Figure 11-1. follow the instructions below. To set the KCN Server virtual directory properties 1 On the KCN Server Properties dialog box. ACIUploadn). That virtual directory will be named ACIUpload0.Web Server Settings Note The default value for Application Protection is “High (Isolated)”. However. The ACIUpload virtual directories point to the actual locations of the file cache folders.dll. Note If you need to set the properties yourself. You must ensure that the properties are correct for each ACIUpload folder. you need to number them consecutively (ACIUpload0..dll file should be mapped to the . and then enter the HTTP verbs GET and POST (GET. select Limit to. The aspnet_isapi. ACIUpload Virtual Directory Properties The ACIUpload virtual directory temporarily stores batches as they are uploaded to the central site. For brevity.acis application extension. enter: C:\WinNT\Microsoft.acis application extension. If you add ACIUpload virtual directories. 2 Configure the . Kofax Capture 8 Installation Guide 163 . c For the Extension. This value is recommended.0. we strongly recommend you let the configuration wizard perform this task for you. you will have only one virtual directory where batches will be temporarily stored. This creates a mapping between the file name extension (.acis) and the program or interpreter that processes those files (the dll file). b For the Executable. but not required. only Windows 2000 Server dialog boxes are shown. Dialog boxes for other Windows versions are not shown.acis. The KCN Server installation program (configuration wizard) sets the KCN Server virtual directory properties for you. Generally. a From the KCN Server Properties page.3705\aspnet_isapi. click Configuration | Add. e Ensure that the Script option is selected. and the HTTP verbs that should be passed to the application should be limited to GET and POST. enter .NET\Framework\v1. This option will allow the executable to run. d For the Verbs. POST). follow the instructions on page 162. 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. make sure the following settings are selected: • For permissions. run the KCN Server configuration wizard (see page 138 for more information). This allows completed batches to be uploaded to the central site without remote users having to log on to the IIS Web server. If you choose to configure the KCN Web server components without using the configuration wizard. The additional ACIUpload folders are configured as virtual directories through the 164 Kofax Capture 8 Installation Guide .config file after configuring the ACIUpload folder(s). Adding or Editing File Cache Folder Locations To change the location or number of file cache folders. ACIUpload Virtual Directory – Required Properties On each ACIUpload Properties dialog box. you will need to modify the Web. Anonymous access is required.Chapter 11 The ACIUpload0 Properties dialog box will look similar to the following: Figure 11-2. If you change your port number after installation.. Note Most of the settings in this file should not be changed. change the value assigned to the “webconfigversion” key to increment by 1 any time you change the “filecachefolder” value. you must specify the proper URL at the remote site after installation. except as described below.Forwarder time out value is represented in seconds --> <add key=“forwardertimeout” value=“180”/> <add key=“errorlogpath” value=““/> <!-. and all SSL communications use port 443. At the central site run the Internet Information Services administration tool.x This value is specified in seconds.Written by the KCN Server Configuration Wizard --> <add key=“webconfigversion” value=“1”/> <!-. The contents of the file that you might need to change are listed below. all HTTP communications use port 80. AciUpload0 & AciUpload1 = 2. Setting Your IIS Port Configuration You can change your IIS port configurations at any time either before or after installation. Change the value assigned to the “filecachefolder” key to set the value to the number of file cache folders you have.ACIUploadn).Status retry time for old remote sites. etc.filecachefolder = the number of configured file cache folders AciUpload0 = 1. Kofax Capture 8 Installation Guide 165 . see File Cache Folder Locations on page 128. Also. <appSettings> <!-. AC 5. Refer to your Microsoft documentation for details. If you change the port configuration in IIS prior to installing KCN Server. For more information on why you might want to use more than one file cache folder location.Web Server Settings Microsoft Management Console. Written by the KCN Server Configuration Wizard --> <add key=“filecachefolder” value=“1”/> <!-. This is typically 1. --> <add key=“tidstatusretry” value=“90”/> </appSettings> The only values you should change are as follows. By default. you must change the port number at both the central and remote sites before processing batches can resume. The additional virtual directories must be numbered sequentially when created (ACIUpload1. • If IIS is installed on a member server (rather than a domain controller). if the alternate TCP port number is 8080. 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. For example. 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. the URL would be similar to: http://www. If there are port conflicts. 166 Kofax Capture 8 Installation Guide . you must ensure that the ports you assign are not being used by other applications or services. You may use any anonymous user account if desired.com:8080/acis. but be sure to consider the following when doing so: • If IIS is installed on a domain controller. and has the same password. ensure the anonymous user account exists on both the IIS Web server and the stations where the file cache folders are located. 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. ensure the anonymous user account has permissions on the stations where the file cache folders are located. from Batch Manager select Options | KCN Server | Web Server URL. Note When selecting alternate ports. IIS Authentication Configuration The following section contains important information on configuring authentication for your Web server. This is not recommended.Chapter 11 At the remote site. you may experience intermittent and unpredictable problems.Mysite. • If IIS is not installed within a domain. Specify the Web Server URL and the new port number using the following syntax: <http protocol>://<Web server>[:port]/acis. each on a separate station. Basic Authentication To configure KCN Server for basic authentication on IIS 1 2 3 4 5 6 On your web server. 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). If you install multiple file cache folders. Right-click the Web site folder and select Properties. 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. See your Microsoft IIS documentation for more information on changing passwords. Kofax Capture 8 Installation Guide 167 . Clear the Anonymous access check box. This setting should always remain disabled. you must also change the password in IIS to match. Expand the Internet Information Services tree to display the Web site.Web Server Settings Note You can install multiple file cache folders. select Start | Programs | Administrative Tools | Internet Information Services. The Authentication Methods dialog box will display. 2 3 4 Expand the tree to display Security Settings\Local Policies\User Rights Assignment. select Domain Controller Security Policy rather than the Local Security Policy. Select the Directory Security tab and click Edit. Right-click the “Log on locally” right and select Security. Note If your computer is a domain controller. The Web Site Properties dialog box will display. Select the Basic authentication check box. The users with Log on locally rights are specified in the “Assigned To” list. To display users with “Log on locally” rights 1 Select Start | Programs | Administrative Tools | Local Security Policy. If you change the password for your anonymous user account. This provides the advantage of not having to configure file access permissions for every authenticated user. 10 Click OK on the Web Site Properties dialog box. The Web Site Properties dialog box will display. Select the Directory Security tab and click Edit. Enter a domain name in the Default domain field. Click OK on the Web Site Properties dialog box. 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. Note This configuration is not recommended unless it is in conjunction with SSL. IIS and File Cache Permissions Configuration The following sections provide important information for configuring file cache permissions for IIS. Click OK on the Authentication Methods dialog box. select Start | Programs | Administrative Tools | Internet Information Services. click Yes. we recommend that you disable impersonation. Right-click the Web site folder and select Properties. Disabling Impersonation When using Basic or Windows Integrated authentication.Chapter 11 7 8 9 When the Internet Service Manager message box displays. 168 Kofax Capture 8 Installation Guide . Expand the Internet Information Services tree to display the Web site. Select the Integrated Windows authentication check box. for file cache accessibility. Click OK on the Authentication Methods dialog box. The Authentication Methods dialog box will display. Clear the Anonymous access check box. config file in the <Windows>\Microsoft.NET\Framework\<. Kofax Capture 8 Installation Guide 169 . </system.web> 2 Restart IIS.. Configuring File Cache Write Permissions Disabling impersonation causes IIS to use the account specified by the . For example: <system. 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. 2 Give the account determined in Step 1 write access to the KCN Server file caches.Web Server Settings To disable impersonation 1 Modify the web.. you must determine the name of this account and give it write access to the KCN Server file caches. Note that these folders may be located on separate computers.acis?config=user” KCN Server configuration parameter is an existing KCN Server parameter on IIS. Use the “config.NET framework installation and is an account local to the web server. ensure that the folders (not virtual directories) have the minimum required permissions documented in this section. Therefore. NTFS Security Settings If KCN Server and the file cache folder locations are installed on NTFS partitions.NET Version>\Config folder and view the <processModel> element.config file in the <KCN Server>\Bin\Web folder. the web server’s worker thread operates under the <Local Machine>\ASPNET user account.web> <identity impersonate="false"/> . This parameter outputs data similar to the following: Current Windows identity: TJAMES-WKS-XP\ASPNET Note The the “config. The ASPNET account is created during the . By default.acis?config=user” KCN Server configuration parameter.NET framework when it accesses the file cache. Right-click the applicable folder and choose Properties. To do so. 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.0 of IBM WebSphere. and for the KCN Service user account. The following sections provide important information for configuring this product for use with KCN Server.Chapter 11 Note A reboot is only required for NTFS security setting changes. Select the Security tab to display folder permissions. Logs Folder Permissions Default location: C:\Program Files\KCN Server\Logs on the computer where KCN Server is installed The Logs folder. 170 Kofax Capture 8 Installation Guide . if located on an NTFS partition. or a specialist with equivalent knowledge and experience. if located on an NTFS partition. 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. To display folder permissions 1 2 3 Run Windows Explorer. This document does not provide information on installing WebSphere. 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 the changes did not take effect. must have Read and Execute permissions for the anonymous user account used for the KCN Server virtual directory. must have Full Control permissions for the anonymous user account used for the ACIS virtual directory. WebSphere KCN Server currently supports version 6. select Start | Programs | Accessories | Windows Explorer. Warning WebSphere installation should be performed by the Kofax Professional Services department. xml (usually in the Kofax Capture installation folder) as follows.Kofax Capture installation is required at the central site. Since KCN Web Server Components reside on the application server. Although a. Note This procedure should be performed only by your Web server administrator.0 for KCN Server is supported on the Windows 2000/2003 Server/ Advanced Server platforms. For Solaris. Step 2: Edit ACConfig. you must create the following subfolders: “services” and “Upload” (these names are case-sensitive).Web Server Settings WebSphere 6. as well as Solaris 9 and 10. and subsequent cache folders must be numbered sequentially): <KCNServer> <Cache Number=”0” Path=”\\Eng1\acis\”/> </KCNServer> Kofax Capture 8 Installation Guide 171 . Step 1: Create a Cache Folder Create file cache folders that are accessible from the WebSphere Application Server and Kofax Capture. For Windows: <KCNServer> <Cache Number=”<Cache folder #>” Path=”<unc path for cache folder>”/> </KCNServer> For example (note that the first cache folder is 0. File cache folders do not need to be accessible from the HTTP web server. Kofax Capture is not required on the Web server. Install KCN Server Components on WebSphere After WebSphere 6.0 has been installed and is running correctly. The path to the cache folder cannot exceed 138 characters. the storage folder must be located on a Solaris server. it must have write access to the file cache.xml Specify the file cache folder location (138 characters or less) by modifying ACConfig. Once the storage folder is created. your Web server administrator can install the KCN Server components to WebSphere. enter “KCN Server” for Application Name. browse for the file acis. 2 3 4 5 172 Kofax Capture 8 Installation Guide . then the WebSphere Administrative Console. Refer to Configuring Additional File Cache Folder Locations on page 146 for more information about how to do this. Click the Next button to go to the next page. On the Generate Default Bindings and Mappings page. Note that entries are case-sensitive. From the WebSphere Administration Console welcome page.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. start the IBM Application Server. To install the KCN Server components 1 From the IBM WebSphere group menu. Enter “/acis” for Context Root then click the Next button. 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. Log into the application with the same user ID used when the IBM Application Server was first installed. and click the “Install New Application” option. expand the “Applications” node on the left side of the screen. In the “Step 1” page. and subsequent cache folders must be numbered sequentially): <KCNServer> <Cache Number=“0” Path=“sharename”/> </KCNServer> Note You can create multiple cache folders. In the “Preparing for the application installation” panel on the right.war on the Kofax Capture CD 2 (ACIS\WebSphere). Skip the security warning page by clicking Continue. Step 3: Install KCN Server Components Use the following procedure to install the KCN Server components to WebSphere. Step 4: Edit KCN Server Deployment Descriptor Next. If you don’t specify a location. select the check box next to “Kofax Capture Request Forwarder. WebSphere will store the error log in its default location. and select the “Update Web Server Plugin” option.ear” is now installed as a subfolder under the WebSphere “InstalledApps” folder.ErrorLogPath parameter specifies a suitable location for the error log file. click Next to continue.war/WEB-INF/Web. 12 Expand the “Environment” node on the left side of the screen. 13 In the “Update web server plugin configuration” panel on the right.” In the Clusters and Servers area.war\WEBINF\Web.ear\deployments\ACI Server\acis.acis. Web. then click Save. 18 “ACIServer.xml is located at: <IBM WebSphere>\AppServer\profiles\default\ config\cells\<machine name. select “KCN Server” and click Start. select the “Save to Master Configuration” link. and select the “Enterprise Applications” option.xml is located at: <IBM WebSphere>/AppServer/config/cells/DefaultNode/applications/ACI Server. click Finish. select a Web server and an application server.xml Kofax Capture 8 Installation Guide 173 .ear/deployments/ACI Server/acis. In the “Step 3” page. 9 10 In the “Step 4” page.xml) to be sure the aciupload0 parameter value specifies the correct location for the file cache folder you created in Step 2 above. Also. 11 After the KCN Server components are installed. Web. update the Web application deployment descriptor (Web.kofax. 17 Restart the IBM Application Server. 15 In the “Enterprise Applications” panel on the right.xml For Solaris. 16 Logout of the WebSphere Administrative Console. For Windows. node cell>\applications\ACI Server.Web Server Settings 8 In the “Step 2” page. 14 Expand the “Applications” node on the left side of the screen. then click Apply. Click Next to continue. click OK. confirm that the com. acis</url-pattern> </servlet-mapping> </web-app> Step 5: Configure Web Server To allow the KCN Server component to function properly in WebSphere.</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. the following line must be added to the <IBM HTTP Server>\conf\httpd.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.0 force-response-1.NET CLR” downgrade-1. 174 Kofax Capture 8 Installation Guide .conf configuration file: BrowserMatch “. Configure Basic Authentication Enabling Basic Authentication on the HTTP web server involves creating a password file and optionally creating a group.0 Step 6.</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).kofax.acis</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>ServiceConfigServlet</servlet-name> <url-pattern>/config.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. Uninstalling KCN Server Components Use the following procedure to uninstall the KCN Server components from WebSphere 6. and select the “Enterprise Applications” option. expand the “Applications” node on the left side of the screen. Run the following command: htpasswd –c –b <password file location> <user name> <user password> Note When adding users to the password file. Note Integrated Windows Authentication is not supported by the IBM HTTP Server. Click the Uninstall button. To uninstall the KCN Server components 1 From the WebSphere Administration Console welcome page. When the next screen appears. omit the “-c” option. To create a group file 1 2 Create a group file with the following format: Add the following lines to the httpd. 2 3 Kofax Capture 8 Installation Guide 175 . Navigate to the <IBM HTTP Server Bin> folder.Web Server Settings To create a password file 1 2 3 Open a command prompt. click OK. This is the same command for both Windows and Solaris versions of WebSphere.0. Select the check box next to “KCN Server” and click Stop.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. Chapter 11 4 5 Click the Save link at the top of the page to save the configuration changes to the Master Configuration. 176 Kofax Capture 8 Installation Guide . If any files were manually edited during the installation process. they may need to be manually edited to complete the uninstallation process. Service running per Kofax Capture installation. It is accessed from a menu item added to the Administration module. but only one per computer. Email Import Connector consists of the following two components: • Kofax Capture Import Connector . You can have only one Kofax Capture Import Connector . You can start or stop this service just like any other service running on Microsoft Windows.Chapter 12 Installing and Configuring Kofax Capture Import Connector . Note Do not install and use this service at a remote site. and generates batches.Email (Email Import Connector) feature allows you to import email from one or more designated mailboxes directly into the Kofax Capture workflow.Email . imports them into Kofax Capture.Email .Email . 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. This component (which has no user interface) reads emails from mailboxes. Kofax Capture 8 Installation Guide 177 . • Kofax Capture Import Connector .Email Introduction The Kofax Capture Import Connector .Service (Service): The Service can be installed on any Kofax Capture workstation or standalone system. There can be any number of Administration Plug-Ins in a Kofax Capture client/server installation.Administration Plug-In (Administration Plug-In): The Administration Plug-In can be installed on any Kofax Capture workstation. The CD supports AutoPlay. shown in Figure 12-1.Chapter 12 Installing Kofax Capture Import Connector .” 3 Figure 12-1.Service Installing the Service is straightforward. so the installation will automatically begin.) From the main installation menu. Kofax Capture Main Installation Menu 178 Kofax Capture 8 Installation Guide . To install the Service 1 2 Shut down any applications (including the Control Panel.exe from the CD. virus detection software. (If it doesn’t start.Email . run Autoplay. Insert your Kofax Capture installation CD 1 into the CD drive. and toolbars) that might be running. select “Install Email Import Connector. Email 4 After a few moments. be sure that the account you specify has the rights described in the dialog box. Be sure to read them carefully before proceeding with each step. Kofax Capture Import Connector . When prompted for the logon account. 7 Kofax Capture 8 Installation Guide 179 . you can check your Windows services to confirm that the service is running. The installation instructions contain additional information that will guide you through the installation process. When installation is complete. you will see the following menu: Figure 12-2.Installing and Configuring Kofax Capture Import Connector .Email Installation Menu 5 6 Select “Install Service.” Follow the instructions on your screen to install the software. if desired. Chapter 12 Installing the Kofax Capture Import Connector . and toolbars) that might be running. Kofax Capture Main Installation Menu 180 Kofax Capture 8 Installation Guide .Email Administration Plug-In Installing the Administration Plug-In is also straightforward. The CD supports AutoPlay. select Install Email Import Connector.) From the main installation menu shown in Figure 12-3. virus detection software. To install the Administration Plug-In 1 2 Shut down any applications (including the Control Panel. (If it doesn’t start. 3 Figure 12-3. run Autoplay.exe from the CD. Insert your Kofax Capture installation CD 1 into the CD drive. so the installation will automatically begin. you can run the Administration module and check for the new “Email Import Connector” item in the menu bar.” Follow the instructions on your screen to install the software. you will see the following menu: Figure 12-4. Kofax Capture Import Connector .Email Installation Menu 5 6 7 Select “Install Administration Plug-In.Email 4 After a few moments. the plug-in will not uninstall. Note If you want to uninstall the Administration Plug-In. Kofax Capture 8 Installation Guide 181 . you must do so while Kofax Capture is still installed. If you uninstall Kofax Capture first. if desired. When installation is complete.Installing and Configuring Kofax Capture Import Connector . if desired. To upgrade to the Kofax Capture Import Connector .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. Specify the maximum number of emails to allow in each batch. then reinstalling version 8. Step 1: Configure Kofax Capture Batch Classes Use the following procedure to configure a batch class for use with Email Import Connector. then click Remove. Specify a user profile. Install version 8. If desired.0 of both the Service and the Administration Plug-In. Step 1 Step 2 Step 3 Step 4 Step 5 Step 6 Step 7 Step 8 Step 9 In Kofax Capture.Email If you are setting up Email Import Connector for the first time.Email feature from an earlier version 1 2 3 From the Control Panel. Select Ascent Capture Email Import Service. configure user profiles. if necessary. This procedure assumes that the batch class has already been created. configure your batch classes. following the instructions given on pages 178 and 180. Follow the on-screen instructions to uninstall. Configuring Kofax Capture Import Connector . customize the email notification templates. Add one or more mailboxes. Select or set up your outgoing mail server. In Kofax Capture. you can upgrade the feature by uninstalling the old version of the Service.0 of the Service and the Administration Plug-In. Each step is detailed after this overview. follow these steps. Verify the compatibility of your batch classes. Set up administrator and sender email notifications. select Add or Remove Programs. 182 Kofax Capture 8 Installation Guide .0. make sure that “Kofax fixed pages” is not selected. validate your batch class using the Email Import Connector Compatibility dialog box. in the Definitions panel. ensure that “Allow import of eDocument files” is selected. Right-click and select Properties. The Form Type Properties dialog box displays. you cannot have any batch fields where the “Required” property is set to true. examine the batch fields area.Installing and Configuring Kofax Capture Import Connector . If there are any batch fields where the “Required” property is set to true. Click OK to close the dialog box and save your settings. Although the above procedure covers the necessary settings. In the Definitions panel. The Batch Class Properties dialog box displays. 4 10 Publish the batch class. Kofax Capture 8 Installation Guide 183 . 11 If desired. In the General tab. change it to false (or do not use this batch class with Email Import Connector). Note “Treat non-TIFF images as eDocument files” may be optionally selected or left blank. select the form type you want to use with Email Import Connector. Right-click and select Properties. In the Advanced tab. 5 6 7 8 9 In the Separation and Form Identification tab. Note If the User Profiles feature is enabled. Your batch class is now ready for use by Email Import Connector.Email To configure a batch class for Email Import Connector 1 2 3 From the Administration module. you cannot select a batch class in Email Import Connector unless the specified user profile allows access to that batch class. Ensure that “Fixed number of pages” is not selected (or do not use this form type with Email Import Connector). select the batch class you want to configure. 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. Refer to the online Help and the Kofax Capture Getting Started Guide for information about user profiles. Step 2: Verify Batch Class Compatibility After you have configured a batch class in Kofax Capture. In the Batch Class list. Note User profiles must also be enabled within Kofax Capture. To validate a batch class 1 2 3 4 From the Email Import Connector menu. • In the Form Type Properties dialog box. Step 3: Configure User Profiles If desired. Step 4: Specify a User Profile If you elect to specify user profiles. “Fixed number of pages” must not be selected. “Allow import of eDocument files” must be selected.Chapter 12 • In the Advanced tab. 184 Kofax Capture 8 Installation Guide . • In the Separation and Form Identification tab. you can use the User Profiles Properties dialog box to define a user profile. select Compatibility. you can confirm that it is ready for use by Email Import Connector.User Profile tab displays. Check the Results area for any problems. and fix as necessary. The Compatibility dialog box displays. Email Import Connector will only allow you to use those batch classes permitted by the user profile. To specify a user profile 1 From the Email Import Connector menu. Only published batch classes allowed by the currently specified user profile are displayed. so you must complete this procedure before you can specify or validate a batch class. “Kofax fixed pages” must not be selected. select one or more batch classes. The Configuration dialog box . select Configuration. Click Validate to check the selected batch classes for compatibility. Click OK to close the dialog box and save your settings. In the Administrator Email area. To set up Administrator email notifications 1 2 3 4 5 From the Email Import Connector menu. select Configuration. you should setup the outgoing mail server. Select the “Notify administrator in case of error” option. This address will be used as the destination for a variety of customizable email notifications. Click OK to close the dialog box and save your settings. Select the Advanced tab. Email Import Connector can automatically send a customizable email notification to the sender if desired. In the Password area. Your choice may affect the batch classes listed in the Mailbox dialog box .User Profile tab displays. The Configuration dialog box . Account names are limited to 256 characters or less. The Configuration dialog box . select Configuration.Import Options tab or the Compatibility dialog box.Email 2 In the User Name area. 3 4 Step 5: Set Up Email Notifications Before using Email Import Connector. specify an email account in the “name@domain” format. Kofax Capture 8 Installation Guide 185 .Installing and Configuring Kofax Capture Import Connector . To set up sender email notifications 1 2 3 4 From the Email Import Connector menu. This is a required field. select the user profile you want to use. Select the “Notify sender in case of import error” option. Step 6: Set Up the Outgoing Mail Server Next. Select the Advanced tab. you must provide an email address for the administrator.User Profile tab displays. Click OK to close the dialog box and save your settings. specify the password for the selected user profile. User Profile tab displays. To specify the number of emails in a batch 1 2 3 4 From the Email Import Connector menu. If the outgoing mail server requires authentication. The Configuration dialog box . In “Maximum number of emails per batch. the remainder will be imported into the next batch. Port numbers are limited to 8 characters or less. 186 Kofax Capture 8 Installation Guide .User Profile tab displays. Select the Advanced tab.” Use the DNS name or IP address of the mail server you want to use for outgoing email. select “Use Secure Connection (SSL). select Configuration. Specify the password for the account.” Specify an existing account name that can be used with the outgoing mail server. Specify an “Outgoing mail server. If the number of waiting emails exceeds the limit. The default is 100 emails. Select the Advanced tab.” 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.Chapter 12 To set up the outgoing mail server 1 2 3 From the Email Import Connector menu. If SSL should be used. Account names are limited to 256 characters or less. Specify the port number used to connect to the mail server. select “Server requires authentication. Passwords are limited to 256 characters or less. Addresses are limited to 256 characters or less. select Configuration. Click OK to close the dialog box and save your settings. The Configuration dialog box .” specify a value from 1 to 1000 emails. Installing and Configuring Kofax Capture Import Connector - Email 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.” Kofax Capture 8 Installation Guide 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 Kofax Capture 8 Installation Guide Appendix A Automatic Installations Introduction This section describes automatic installations and initialization files. Automatic Installations 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. Kofax Capture 8 Installation Guide 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 Kofax Capture 8 Installation Guide Automatic Installations • 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. Kofax Capture 8 Installation Guide 191 These attributes specify whether only system files will be installed. and other related attributes. and other attributes related to SecurityBoost.Appendix A Note If you assign values to the workstation attributes in the initialization file before installing Kofax Capture on the server. site ID. These attributes specify the station ID. These attributes specify information related to SQL Server. password. and then insert the initialization file in the Wrkcnfg folder. create the Wrkcnfg folder under the Kofax Capture directory. you specify a value for an attribute by entering the attribute followed by an equal (=) sign. the user ID. These attributes specify the various paths required by the installation. and other related attributes. site name. followed by the value. For example: InstallType=server. Initialization File Elements The initialization file elements. In the initialization file. Element [Main] Description of Elements These attributes specify the installation type. See Planning Your Kofax Capture Installation on page 25 for possible deployment methods. These attributes specify information about the type of scanner adapter you are using. and other related attributes. attributes. ensure that the initialization file is in the Wrkcnfg folder. and default values are described below. any switches that are needed for the executable. These attributes specify the name. The following shows the general structure of the initialization file. Oracle. program folder name. These attributes specify information used with KCN Server. When you deploy Kofax Capture. [SystemFiles] [Path] [Identification] [Hardware Information] [ACIS] [SecurityBoost] [Database] 192 Kofax Capture 8 Installation Guide . or IBM DB2 databases. or No. workstation. if you want to use your server as a workstation.Automatic Installations The [Main] Element The [Main] element is required. and supports the following attributes. The entry cannot contain any of the following invalid characters: /:\*?”<> | . [Main] Attributes Attribute Name InstallType Values Server. Create and execute a script to reboot the computer to complete the Kofax Capture installation. If you need to pass a quoted string. This is ignored if you run the setup from the Wrkinst folder to install a client. The relative or absolute path to the program must be included. Name of your Kofax Capture program group.0 No WorkstationOnServer Yes or No SuppressFinalReboot Yes or No No LaunchExe Executable name none LaunchExeArguments Names of switches none Kofax Capture 8 Installation Guide 193 . if you want to skip the final reboot. the string must be enclosed in a second pair of quotes and a space. ProgramFolder Kofax Capture 8. Name of a custom program or script to be launched at the end of the installation. Specify Yes. if this is to be a server only Specify Yes. or standalone Name for your program group Default Server Description Type of installation. For example: “ “C:\Test\Test.doc” “. and reboot later. Table A-2. Names of the switches used by the custom program or script that you want launched at the end of the installation. if the path is different from that of the setup executable. [SystemFiles] Attributes Attribute Name SystemFilesOnly Values Yes or No Default No Description Upgrades system files only. [Path] Attributes Attribute Name ServerSoftwarePath Values Path information Default Description Program Files\ Path to the server software. if system files are already current. Kofax\Capture SS For server installations only. Only use it after updating the system files. You should use this option with the SuppressSystemFilesReboot option. 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. 194 Kofax Capture 8 Installation Guide . SkipSystemFilesUpdate Yes or No No Skips system files update. Skips reboot after system files have been installed. Table A-4. This option can be used when you are using a custom installation script to manually control when a reboot will occur.Appendix A The [SystemFiles] Element The [SystemFiles] element is required. and supports the following attributes. Table A-3. and supports the following attributes. “ $ ` = \ { } . StandalonePath Path information Program Files\ Kofax\Capture Program Files\ Kofax\Capture WorkstationPath Path information The [Identification] Element The [Identification] element is required. [Identification] Attributes Attribute Name StationID Values Alphanumeric from 1-32 characters. Path to the program files. for server installations. For client workstation installations only. Kofax Capture 8 Installation Guide 195 . Table A-5. For server installations only. Default Description computer name Name of the station. [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. Path to the workstation files. from 1-9999 1 ID of the site. . Computer names longer than 32 characters will be truncated to 32 characters.' . an upgrade will be performed. and you run the setup file with the /u option. For Standalone installations only. and supports the following attributes. cannot include the following characters: . If you include the location of a previous version of Ascent Capture for this option.Automatic Installations Table A-4. / ~!@#^&*()_+ : <> ? % SiteID From 1-4 digits. The element supports the following attribute.“ $ ` = \ { } . [Identification] Attributes (continued) Attribute Name SiteName Values Alphanumeric from 1-32 characters. if you intend to use it with Kofax Capture. [Hardware Information] Attribute Attribute Name ScannerAdapter Values Adrenaline or Other Default Other Description Type of scanner adapter you have. Computer names longer than 32 characters will be truncated to 32 characters. . Domain associated with the ID provided for the RebootUserID. Default Description computer name Name of the site. 196 Kofax Capture 8 Installation Guide . Password associated with the ID provided for the RebootUserID. Table A-6. RebootUserDomain domain none The [Hardware Information] Element The [Hardware Information] element is optional if you are not using an Adrenaline scanner adapter. the “Are you using Hardware VRS?” dialog box takes the default of “No”. For automatic installations. cannot include the following characters: .' . You must have already installed Hardware VRS.Appendix A Table A-5. / ~!@#^&*()_+ : <> ? % RebootUserID RebootUserPassword user ID password none none ID of the user that will be used during the installation. [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. The password associated with the WebServerUserName parameter. 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. Table A-7. WebServerUserName User name none A user name that has the ability to log on to the central site web server. If you specify a port. If the port is not specified.Automatic Installations The [ACIS] Element The [ACIS] element is optional. you can manually convert a site to a remote site through the Batch Manager module. Optionally allows you to specify the Web server port number. WebServerPassword Password none Kofax Capture 8 Installation Guide 197 . and automatically activates the RSA. You must provide the URL for the Web server that is running KCN Server. and enables the KCN Server RSA utility. use the following syntax: <http protocol>://<Web server>[:port]/acis Note that “http” and “https” are the only supported protocols. Use to specify authentication information when the remote site conversion step takes place. and supports the following attribute. Table A-9. password. Table A-8. Oracle. Oracle. and supports the following attributes. This is ignored if the SecurityBoostUserName is empty. and domain. SecurityBoostPassword Password none Password of the SecurityBoost user. or IBM DB2 database during a silent installation. The SecurityBoost parameters are only used for server or standalone installations. SQL Server. or IBM DB2 Default Standard Description Database configuration.Appendix A The [SecurityBoost] Element The [SecurityBoost] element is optional. See the Kofax Capture Getting Started Guide or online Help for more information on SecurityBoost. 198 Kofax Capture 8 Installation Guide . SecurityBoostDomain Domain name local The [Database] Element The [Database] element is required if you want to configure a SQL Server. and specifies the SecurityBoost user name that will be used for the SecurityBoost user. [Database] Attributes Attribute Name Configuration Values Standard. You must provide the SecurityBoost user name. [SecurityBoost] Attributes Attribute Name SecurityBoostUserName Values User name Default none Description Enables the SecurityBoost option. The element supports the following attributes. This is ignored if the SecurityBoostUserName is empty. Domain of the SecurityBoost user. This is ignored if the Configuration value is Standard or Oracle. This is ignored is the ServerName is empty. or No. or if the Configuration value is SQL Server and the Authentication value is SQL Server. This attribute is required if the Configuration value is SQL Server or IBM DB2. This is required if the Configuration value is Oracle or IBM DB2. Name of the SQL Server or IBM DB2 database. Name of the Oracle service. This is ignored if the LoginID is empty. This is ignored if the Configuration value is not SQL Server.Automatic Installations Table A-9. Login ID used to connect to the database. a value for LoginID is required. This is required if the Configuration value is Oracle. If the value is SQL Server. if the database name refers to an existing database. 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 Kofax Capture 8 Installation Guide 199 . This is required if the Configuration value is SQL Server or IBM DB2. This is required if the Configuraiton value is SQL Server and ignored if the Configuration value is not SQL Server. [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. Specifies the authentication method for SQL Server. Specify Yes if you want to create a new database using the database name. BatchesInSqlServer Yes or No No Specify Yes if you want batches stored in SQL Server. or No. or if the Configuration value is SQL Server and the Authentication value is SQL Server. if batches are stored in Access. This is ignored if the Configuration value is Standard or if it is SQL Server and the Authentication value is Windows. [Database] Attributes (continued) Attribute Name Password Values The database login password Default empty Description Password for the database login ID. This is ignored if the Configuration value is not SQL Server. 200 Kofax Capture 8 Installation Guide .Appendix A Table A-9. Use this option if the Configuration value is Oracle or DB2. However. This chapter provides information about installing the server software and server files on separate computers. the server components (server files and server software) should be installed on the same computer. you can use separate computers for the server software and the server files. If you have such a requirement. Refer to Client/Server Installation on page 38 for more information about the server components.Appendix B Setting Up Distributed Server Configurations Introduction In general. 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. Kofax Capture 8 Installation Guide 201 . Minimum Hardware Requirements Processor: System memory: Disk space: Pentium 4 processor. temporary files. You may need even more if you have many batches in progress. or wherever your operating system is installed. 1024 x 768 with 16 bit color. 24 bit color is recommended for the best viewing of online Help Kofax Capture hardware key 100 Mbps Display: USB port: NIC: Supported Operating Systems Refer to Supported Operating Systems on page 5 for more information about the supported operating systems. 202 Kofax Capture 8 Installation Guide . and working space during processing. small fonts. or equivalent 1Gbyte or more 500 Mbytes available on your local C: drive. for installation files.Appendix B Server System Requirements for Server Software The following are the minimum requirements for the server software. shut down any applications (including the Control Panel. so the installation will automatically begin. (Refer to Figure 4-1 on page 39.) From the main installation menu. and their default paths make use of long names. Insert your Kofax Capture installation CD 1 into the CD drive.Setting Up Distributed Server Configurations System Requirements for Server Files The following requirements are for the server files. or equivalent 650 Mbytes or more for working space during processing. Create or select a folder that will be shared during installation of Kofax Capture. virus detection software. server files are installed on a file system that supports long file names. (If it doesn’t start. 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. run AutoPlay.) Follow the instructions on your screen to install the software. and toolbars) that might be running.exe from the CD. Normally. The installation instructions contain additional information that will guide you through the 4 5 Kofax Capture 8 Installation Guide 203 . Recommended Hardware Processor: Disk space: Long file names: NIC: Network access: Pentium 4 processor. The CD supports AutoPlay. Distributed Installation To install server software and server files on separate computers 1 2 3 At the server software computer. You may need more if you have many image files or a large database. 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. select one of the installation options. x or 7. 6 After the server installation is complete. The method (UNC or mapped drive) that you use here will dictate how your client workstations will be installed. Use either a UNC path (recommended) or a permanently mapped drive.x or 7. specify a local folder on your server software computer.0. Be sure to read them carefully before proceeding with each step. As you proceed through the instructions. see Upgrading/Updating Kofax Capture on page 49. non-UNC drive. note the following: Note In most cases. select Server.x to Kofax Capture 8. If you want to upgrade from Windows 2000 to Windows Server 2003.x Follow these instructions if you are upgrading an existing Ascent Capture distributed configuration. Upgrading or Updating Distributed Configurations For a description of the differences between upgrading and updating an Kofax Capture installation.0 also supports Windows Server 2003. If this occurs. make absolutely certain that you choose an installation destination path that is accessible to the server software computer and all client workstations.Appendix B update process. Kofax Capture 8. choose to restart the workstation and be sure to use the same user account when logging back on. unmapped. Note Read Important Notes on page 49 before you upgrade your Ascent Capture 6. you should do so prior to upgrading Ascent Capture 6. Since this will be on a different computer from the server software. The installation process will automatically resume once your workstation has been restarted. you can install your client workstations. system files may need to be updated and you may be prompted to restart the workstation. • When you are prompted for a destination for the server files. 204 Kofax Capture 8 Installation Guide . Upgrading Ascent Capture 6. • When prompted for the installation type. Make sure you choose an installation path on a local. • When prompted for a destination for the server software. select a location for them.x installation.x or 7. 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. and toolbars) that might be running.x.x or 7. (If it doesn’t start. Be sure to read them carefully before proceeding with each step. so the installation will automatically begin. After the server installation is upgraded. see To update a client workstation on page 58. see To update a server or standalone configuration on page 58.Setting Up Distributed Server Configurations To upgrade an existing distributed configuration 1 Shut down any applications (including the Control Panel. run Autoplay. Follow the instructions on your screen to upgrade the software.) From the main installation menu. (Refer to Figure 4-1 on page 39.0 distributed server configuration. you can upgrade your client workstations. Kofax Capture 8 Installation Guide 205 . 3 4 5 Updating an Existing Distributed Server Configuration Follow these instructions if you are updating an existing Kofax Capture 8. Note If you moved the Ascent Capture Batch Catalog (database) to your SQL Server in Ascent Capture 6. The installation instructions contain additional information that will guide you through the process. select the Upgrade option.) The upgrade process will detect the previous version of your server software. To update an existing distributed server configuration To update your distributed server.exe from the CD. To update your client workstations. virus detection software. Appendix B 206 Kofax Capture 8 Installation Guide . The Server Files folder is selected during installation and is normally (versions earlier than 7. follow the instructions that come with your software to back up and restore the database. Kofax Capture 8 Installation Guide 207 . follow the instructions in this appendix.x) <Ascent Capture installation folder>\Program Files\AscentSV or (Kofax Capture 8.0. the temporary image directories defined in the batch classes would need to be backed up to preserve the images associated with batches in progress.Appendix C Backing Up and Restoring Your Standard Database Introduction When you upgrade to the latest version of Kofax Capture.x) or Kofax Capture 8. Note This is not a complete back up of Ascent Capture (versions earlier than 7. you might want to back up your Standard database. depending on the version and type of installation (client/server or standalone) you have. For SQL Server database. Please note that your folder paths may be different depending on the type of installation you have (standalone or client/server). These instructions are specifically written for backing up MSDE or Microsoft SQL Server 2005 Express Edition.0) C:\Documents and Settings\All Users\Application Data\Kofax\CaptureSV. 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. 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. Please follow the steps below to properly back up and restore your Standard database. For MSDE or Microsoft SQL Server 2005 Express Edition database. Oracle database. or IBM DB2 database. In addition. To back up the Ascent Capture (version 6.x) MSDE database 1 2 3 4 5 Stop the MSSQL$AscentCapture service.ldf into the folder. Warning This restore needs to be done in conjunction with a restore of the rest of the Ascent Capture file structure.mdf and ACSystem_log. or the restored installation may not be complete.mdf and ACSystem_log_Orig. Copy your backed up ACSystem.ldf.ldf to ACSystem_Orig.x or 7.x) MSDE Database Use the following instructions to back up the MSDE database. Restoring the Ascent Capture (version 6. Backing Up the Ascent Capture (version 6. 208 Kofax Capture 8 Installation Guide .mdf and ACSystem_log.x or 7.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.x) MSDE Database Use the following instructions to restore the MSDE database.x or 7.x) MSDE database 1 2 3 4 Stop the MSSQL$AscentCapture service.ldf – located in \Ascent\Server\DB\MSSQL$AscentCapture\Data\ Start the MSSQL$AscentCapture service.x or 7. To restore the Ascent Capture (version 6. Copy ACSystem. respectively.mdf – located in \Ascent\Server\DB\MSSQL$AscentCapture\Data\ Copy ACSystem_log. Browse to \Ascent\Server\DB\MSSQL$AscentCapture\Data\ Rename the original ACSystem. Start the MSSQL$AscentCapture service. or the restored installation may not be complete. 3 4 Restoring the Kofax Capture 8.ldf to ACSystem_Orig. To back up the Kofax Capture Microsoft SQL Server 2005 Express Edition database 1 2 Stop the SQL Server (ASCENTCAPTURE) service.mdf and ACSystem_log.mdf and ACSystem_log_Orig. Warning This restore needs to be done in conjunction with a restore of the rest of the Kofax Capture file structure.ldf.mdf and ACSystem_log.1\MSSQL\Data Start the SQL Server (ASCENTCAPTURE) service. respectively.1\MSSQL\Data Rename the original ACSystem.Backing Up and Restoring Your Standard Database Backing Up the Kofax Capture 8. Kofax Capture 8 Installation Guide 209 . Start the SQL Server (ASCENTCAPTURE) service.ldf – located in \Documents and Settings\All Users\Application Data\Kofax\Capture\Server\DB\MSSQL.1\MSSQL\Data Copy ACSystem_log.mdf – located in \Documents and Settings\All Users\Application Data\Kofax\Capture\Server\DB\MSSQL.ldf into the folder. Copy your backed up ACSystem. Browse to \Documents and Settings\All Users\Application Data\Kofax\Capture\Server\DB\MSSQL.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. Copy ACSystem.0 Microsoft SQL Server 2005 Express Edition Database Use the following instructions to back up the Microsoft SQL Server 2005 Express Edition database. mdf and ACSystem_log_Orig.x or 7.Appendix C Client/Server Installations The following are the procedures for backing up and restoring the Ascent Capture (version 6.mdf and ACSystem_log.x) MSDE database or Kofax Capture 8. Start the MSSQL$AscentCapture service.ldf – located in \AscentSS\Server\DB\MSSQL$AscentCapture\Data\ Start the MSSQL$AscentCapture service.x) MSDE database 1 2 3 4 5 Stop the MSSQL$AscentCapture service.0 SQL Server 2005 Express Edition database on client/server installations.x or 7.mdf – located in \AscentSS\Server\DB\MSSQL$AscentCapture\Data\ Copy ACSystem_log.ldf to ACSystem_Orig. Copy your backed up ACSystem.x) MSDE database 1 2 3 4 Stop the MSSQL$AscentCapture service. Backing Up the Ascent Capture (version 6.x or 7. or the restored installation may not be complete. Copy ACSystem. 210 Kofax Capture 8 Installation Guide .x) MSDE Database Use the following instructions to restore the MSDE database.x) MSDE Database Use the following instructions to back up the MSDE database.x or 7. To back up the Ascent Capture (version 6.x or 7. Restoring the Ascent Capture (version 6. To restore the Ascent Capture (version 6.ldf into the folder. Warning This restore needs to be done in conjunction with a restore of the rest of the Ascent Capture file structure.ldf. respectively. Browse to \AscentSS\Server\DB\MSSQL$AscentCapture\Data\ Rename the original ACSystem.mdf and ACSystem_log. respectively.1\MSSQL\Data Copy ACSystem_log. To restore the Kofax Capture 8. To back up the Kofax Capture 8.1\MSSQL\Data Start the SQL Server (ASCENTCAPTURE) service.mdf and ACSystem_log_Orig.mdf and ACSystem_log.ldf – located in Documents and Settings\All Users\Application Data\Kofax\Capture\Server\DB\MSSQL.mdf – located in Documents and Settings\All Users\Application Data\Kofax\Capture\Server\DB\MSSQL. Copy ACSystem.ldf to ACSystem_Orig.ldf. 3 4 Restoring the Kofax Capture 8.mdf and ACSystem_log.0 Microsoft SQL Server 2005 Express Edition Database Use the following instructions to back up the Microsoft SQL Server 2005 Express Edition database. Start 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.0 Microsoft SQL Server 2005 Express Edition Database Use the following instructions to restore the Microsoft SQL Server 2005 Express Edition database.0 Microsoft SQL Server 2005 Express Edition database 1 2 Stop 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.ldf into the folder.0 Microsoft SQL Server 2005 Express Edition database 1 2 3 4 5 Stop the SQL Server (ASCENTCAPTURE) service. Kofax Capture 8 Installation Guide 211 .Backing Up and Restoring Your Standard Database Backing Up the Kofax Capture 8. Copy your backed up ACSystem. Appendix C 212 Kofax Capture 8 Installation Guide . The Kofax Capture Service must be run as a user that has Read/Write permission to the folder.Appendix D Required Folder Permissions Introduction To run Kofax Capture. Table D-1. interactive clients require certain permissions. See note below for details. Both of these services run as “Local System” by default. then the KCN Service must also have Read/Write permission to the folder. The SQL Server (ASCENT CAPTURE) service must be run as a user that has Read/Write permission to the folder. Server Files Folder <AppData>\Kofax Batch Class Image Folder Full Control Full Control Full Control Kofax Capture 8 Installation Guide 213 . If you enable the KCN Service on the same computer. 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. Client/Server Required Permissions The table below lists the permissions required to run Kofax Capture in client/server installation. Table D-2. Table D-3. 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. 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. 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 Kofax Capture 8 Installation Guide .Appendix D Standalone Required Permissions The table below lists the permissions required to run Kofax Capture in standalone installation. Table D-4. This section provides information on the minimum folder and file permissions required for the operators and SecurityBoost user. you can use SecurityBoost to protect critical Kofax Capture files. Minimum Permissions for the Operator This section describes the minimum permissions for operators. It also has important additional information about permissions when using the Scan or Release modules.Required Folder Permissions 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. Note The permissions shown in Table D-1 and Table D-2 also apply to the SecurityBoost user. 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. Kofax Capture 8 Installation Guide 215 . Notice that these are considerably more restrictive than the permissions for the SecurityBoost user. See the appropriate table for the system you are using. 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. 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 Kofax Capture 8 Installation Guide . Table D-7. 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.Appendix D Note If you are not planning to use SecurityBoost. Required Folder Permissions 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 Kofax Capture 8 Installation Guide 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 Kofax Capture 8 Installation Guide 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. Kofax Capture 8 Installation Guide 219 Appendix E Command Line Parameters 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 8 Installation Guide 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. Kofax Capture 8 Installation Guide 221 • • • • High Availability Kofax Capture Network Server (KCN Server) Xtrata Kofax Capture Import Connector .Email 222 Kofax Capture 8 Installation Guide .Appendix E Unsupported Installation Configurations The Kofax Capture Deployment Utility cannot reconfigure the following installation configurations. including supported database management systems. Supported Database Management Systems The list below shows the database management systems certified for use with Kofax Capture server files and software.Appendix F Kofax Capture Database Management Requirements Introduction This chapter provides information about Kofax Capture database management requirements. and settings. and 2005 64-bit • Oracle Database 10g Release 2 • IBM DB2 Version 9. 2005. • Microsoft SQL Server 2000 (Version 8).2 Kofax Capture 8 Installation Guide 223 . operating systems.1. 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. only the minimum requirement.Appendix F Configuration Requirements This section contains information on a number of Kofax Capture database management system configuration requirements.3 on IBM System p Windows Server 2003 R2 Red Hat Enterprise Linux 4 AS Certified 224 Kofax Capture 8 Installation Guide . Supported Operating Systems 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. Oracle.0. Following are the versions of the client software that are supported: • Oracle ODAC 10.0 framework.1 Fix Pack 2 or higher Database Settings This section contains required configuration settings for Oracle and IBM DB2 databases.com to check for any updates to the supported operating systems for database management systems used with Kofax Capture 8.NET 2.0 framework.NET 2. The user name provided at installation must have this Kofax Capture 8 Installation Guide 225 .kofax. and IBM DB2 require a Kofax Capture Enterprise License or Evaluation License.NET 2.NET 2. Kofax Capture automatically installs the . The Microsoft .NET data providers for Oracle and IBM DB2 database management systems.2.0 framework.2.0.21 • IBM DB2 Client V9. License Requirements SQL Server Enterprise Edition.NET data providers for Oracle and IBM DB2 are installed by the client software on each workstation.0 framework installed.NET 2.Kofax Capture Database Management Requirements Note Visit the Kofax Web site support page at www. Database Client Software Kofax Capture requires the use of Microsoft . Oracle You must create an empty database schema in Oracle where the Kofax Capture information will be stored. If you plan to install the Oracle or DB2 data provider after installing Kofax Capture. Microsoft . and the system does not already have . you can just install either data provider. you must first install the .0 Framework Requirement Both Oracle and IBM DB2 database configurations require the Microsoft . You can then install Kofax Capture at any time thereafter. If you plan to install the Oracle or DB2 data provider before installing Kofax Capture. As you continue through the installation. See the online Help for more information about the Database Utility application. SQL Server 2005 Express Edition will not be installed. If you select an option other than “Standard”.exe) after the upgrade is complete. SQL Server 2005 Express Edition will be installed. IBM DB2 The user name provided at installation must have a default database schema that is empty. The IBM DB2 database must be configured prior to installing Kofax Capture. in which case the Standard database. Note If you are performing an upgrade and want to change your Kofax Capture database configuration. The other options are SQL Server. your Kofax Capture license 226 Kofax Capture 8 Installation Guide . 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. the database must be set up as a Unicode database prior to installing Kofax Capture. Oracle. The following list specifies these configuration settings. standalone. From the Database Configuration dialog box. • • • • • 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. The user must also have rights to create objects in that schema.Appendix F database schema set as the default schema for the user. The user must also have rights to create objects in that schema. the Database Configuration dialog box will display. and IBM DB2. or KCNS remote site installation. use the Database Utility application (DBUtil. This dialog box will not display during an upgrade. you can select which database configuration to use with Kofax Capture. For IBM DB2 installations running on Windows. “Standard” is the default selection. the instance name will be server\ascentcapture.0 installation CD 1 into the CD drive. If you want to use the Standard database even though you selected another option during the initial installation. For example: E:\Kofax Capture\Setup. type the path of the Setup.Kofax Capture Database Management Requirements will be activated and the Database Utility will display. select Start | Run. you will be unable to use Kofax Capture. or click Browse to locate it. To install SQL Server 2005 Express Edition 1 2 3 4 5 Insert your Kofax Capture 8. Note SQL Server 2005 Express Edition always installs as a named instance.exe file you want to open. In the Open box. where server is the name of the computer where Kofax Capture is installed. If the database is not successfully configured. In Open. Kofax Capture 8 Installation Guide 227 . When the installation is completed. add the /InstallDB option. From the Windows taskbar.exe /InstallDB Follow the instructions on your screen to install. You can then configure the database option that you selected at the start of the installation. you must manually install SQL Server 2005 Express Edition as follows. Appendix F 228 Kofax Capture 8 Installation Guide . SNMP uses 161/udp and 162/udp. Network Requirements The Kofax Capture monitoring feature uses SNMP as the underlying communication protocol. Licensing Requirements The Kofax Capture monitoring feature requires one of the following licenses: • Enterprise • Evaluation • Temporary Kofax Capture 8 Installation Guide 229 . real-time monitoring of an installation. This chapter describes how to install. Kofax Capture Monitoring Requirements The following lists the network and licensing requirements for installing and using the monitoring feature. enable. It also describes how to start and use the provided sample monitoring application.Appendix G Monitoring Kofax Capture Services Kofax Capture provides a solution for remote. and configure the Kofax Capture monitoring solution which uses Simple Network Management Protocol (SNMP). the site ID. At SNMP service startup time.dll.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. To install the monitoring feature. which in turn implements the appropriate MIB (Management Information Base).exe Installing the Monitoring Feature An administrator must initially execute a command script to install the key monitoring components. WmiProvider. WmiProviderCOM.Appendix G Installed Components The typical Kofax Capture installation process installs the following monitoring related files to the executable directory. Installed Monitoring Components Filename SnmpExtensionAgent. site name.dll) invokes the appropriate extension-agent DLL. The provided sample monitoring application. 230 Kofax Capture 8 Installation Guide . WMI schema This is a Windows service that exposes Capture site information to SNMP. This includes information about the configured queues. It collects and returns information as requested by a management system. and site GUID. run the following command script from the Capture executable directory: Install_Monitoring. Table G-1.cmd Note This step is required to install the monitoring feature.exe Monitor. the SNMP service (Snmp. but is not required for the normal operation of Kofax Capture.dll SiteMonitorService. Configuring the SNMP Service After installing the monitoring feature. enter a valid user name and password.Monitoring Kofax Capture Services The Install_Monitoring command script performs the following: • Attempts to programmatically install the Windows SNMP service. If you decline. To continue. You can suppress error dialog boxes using the “/unattended” switch with InstallUtil. You will be prompted to install this service. 1 Display the property dialog for the SNMP service (Start | Programs | Administrative Tools | Component Services | Right-click SNMP service | Properties). • Installs the extension agent (SnmpExtensionAgent. Select the Security tab.exe.dll).exe. See Configuring the SNMP Service on page n for more information. • Installs the WMI schema (WmiProvider.cmd script).xml configuration file. it prompts you to enter credentials to use the service. you must configure the SNMP service. If the service is not installed or the appropriate license is not found. • Optionally installs the site monitor service (SiteMonitorService.dll). 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. • Updates the ACConfig. Temporary.dll and WmiProviderCOM. or Evaluation license. Site Monitor Service Credentials If you choose to install the site monitor service (SiteMonitorService. The SNMP Service Properties dialog box will look similar to the following: 2 Kofax Capture 8 Installation Guide 231 . you can install it later using InstallUtil.exe) during the initial Monitoring feature installation (Install_Monitor. an error dialog box displays.dll). This process may prompt you for a Windows CD to complete the installation. exe utility. You can enter a valid user name and password.exe) during the initial Monitoring feature installation (Install_Monitor. select the “Accept SNMP packets from any host” option. Click OK. select the “Send authentication trap” check box. SNMP Service Properties Dialog Box 3 4 5 6 On the Security tab.cmd script). 232 Kofax Capture 8 Installation Guide . Separate Site Monitor Service Installation If you chose not to install the site monitor service (SiteMonitorService. you can install it later using the InstallUtil. see the Microsoft documentation. Restart the SNMP service For more information about configuring the SNMP service.Appendix G Figure G-1. it prompts you to enter credentials to use the service. Site Monitor Service Credentials When this service is installed. On the Security tab. The SNMP MIB is located in the same folder as the sample application. Kofax\Capture\Source\VB. The sample application is written in Visual Basic . If the appropriate license is not found. For example: InstallUtil.exe. When calling InstallUtil.exe License Verification The site monitor service installation also checks to see if Kofax Capture is configured with an Enterprise. this folder is located in the CaptureSV folder. You can use the application “as is” or as a springboard for your custom monitoring application.Net Samples\Monitor Note For a client/server installation. The provided VB.NET project contains all of the source and components necessary to build the application and is located in the following folder. or Evaluation license.exe /username=Jsmith /password=Q8642Z SiteMonitorService. Sample Monitoring Application Kofax Capture includes a sample monitoring application that monitors Kofax Capture services and displays their status.xml file. Temporary.NET. 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. Note The sample application is not 508 compliant. an error dialog box displays.exe. run the application with no arguments: Kofax Capture 8 Installation Guide 233 . You can suppress any dialog boxes using the “/unattended” switch with InstallUtil.Monitoring Kofax Capture Services You can also supply valid credentials using the “/username” and “/password” switches to InstallUtil. the credentials parameters must be specified before the assembly name.exe. the application runs however the host list and activity list will be empty.EXE [<host configuration file>] The host configuration file is an XML file that specifies a list of host servers.Appendix G C:\> MONITOR. <Workstations> <Workstation Host=”SystemName"/> </Workstations> 234 Kofax Capture 8 Installation Guide . 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. 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. The syntax is: C:\> MONITOR.EXE If Kofax Capture is not installed. 73 adding locations. 19 Business continuity. 70. 102 Adrenaline hardware installation. 21 Cluster file share folder. 71 NTFS security settings. 20 Configuring backup license server. 101 switching. 171 in multiple locations. 127 disk space required. 140 UNC support. 150 Cache folder. 155 Custom modules. 223 settings.exe. 35 B Backing up Microsoft SQL Server 2005 Express Edition. 140. 146 affinity.Index A ACConfig. 224 Database support. 137 anonymous account access. 43 support. 128 network access. 118 Capture virtual directory automatic password synchronization. 166 Automatic batch recovery. 98 Citrix. 207 Batch class import and export. 20 Anonymous access. 139. 77 C Cab files. 129 configuration options.xml. 225 supported database systems. 170 Converting batches. 125 configuration data. 223 supported operating systems. 143. 166 user account. 146 and Local System account. 167 IIS password control. 70 Configurator scanner. 97 considerations. 94 Database management components. 124 user account access. 119 D Data recovery. 71 Administrative data. 78 substitution.exe. 74. 155 Browser support. 127 Cache folder access. 18 DBUtil. 128. 225 requirements. 119 for WebSphere. 167 Central site deleting. converting. 18 license requirements. 103 Batches. 169 Websphere. 164. 67 Automatic password synchronization. 167 specify during installation. 70 Kofax Capture 8 Installation Guide 235 . 139. 171 ACLicSrvCfg. 14. 34 Development environment support.0 framework. 25 Exporting batch classes. 143. 77 replication. 61 Environment variables. 169 File locations. 170 G Group file. 103. 173 Deployment modes. 168 write permissions. 182 emails per batch. 77 data and path substitution. 184 batch class configuration. 78 overview. 153 configuring.NET 2. 201 Domain controller. 91 setup. 175 H Hardware accelerators and controllers. 106 F File cache impersonation. 28 Folder permissions K KCN Server folder permissions. 169 integrated windows authentication. 94 features. 20 Hardware keys. 187 outgoing mail server. 161 file cache configuration. 90 restoring batches. 167 basic authentication. 180 batch class compatibility. 184 Email notification templates. 121 High (Isolated) application protection. 170 Upload. 79 shared license. 104 user profiles. 163 High availability. 170 Properties dialog box. 88 business continuity. 162 automatic password synchronization. 162 236 Kofax Capture 8 Installation Guide . 19 Disabling impersonation. 166 ASP pages. 225 automatic batch recovery. 187 notification templates. 30 IIS anonymous account. 182 components. 156 at remote sites. 177 configuring.Index Deployment descriptor. 104 user profiles. 168 for NTFS. 88. 33 types. 150 KCNS profiles. 168 Disaster recovery backup and restore. 62 I IBM DB2 . 30 Enterprise installation. 68 options. 167 client certificates. 226 ICR engine. 167 Upload virtual directory. 166 for NTFS. 186 mailboxes. 106 Installation modes. 27 E Email Import Connector Administration Plug-In. 17 settings. 168 password control. 103 KCNS profiles. 187 Enhanced bar code engine. 178 user profiles. 163 Importing batch classes. 82 Distributed server. 186 Service. NET 2. 28 Monitoring installation. 153 KCNS profiles import and export. 25 KCN Server. 15 installing from. 203 M Member server. 120 network components. 213 SecurityBoost. 120 server operating system. 33 Modules running as services. 104 Kofax technical support. 166 Long file names. 30 Operating requirements browser.Index KCN Server Web site installation. 18 development environment. 169 KCN Service operating requirements. 66 P Password file. 140 NTFS security settings.0 framework. 68. 48 load balancing. 225 L License backup. 15 Novell. 5 standalone operating system. 120 KCN Web Server client certificates. 217 upload folder. 169 O OCR engine. 166 Microsoft . 230 Kofax Capture services. 69 Modes of deployment. 175 Permissions folders. 34 Modes of installation automatic. 203 NTFS partitions. 62 management. 229 suppress dialog boxes. 229 license requirements. 142. 225 automatic batch recovery.NET 2. 17 settings. 25 folder access on NTFS. 225 Microsoft Cluster Services. 25 security settings. xvii training. 169 remote sites. 233 SNMP. 151. 203 NTFS security settings. 68 options. 61 N Network components. 165 Kofax Capture 8 Installation Guide 237 . 9 database management components. 19 distributed server configurations. 229 sample application. See network load balancing Novell. 230 installed components. 70 server failover. 225 Oracle. 231 Multiple license servers. 72 NLB. 33 interactive. 117 KCN Service. 201 environment variables. 66.0 framework IBM DB2. 215 SecurityBoost user. 14. xvi Web site. 14 server. 19 client operating system. 71 Log on locally permission. xvii Kofax Capture Enterprise. 12 Oracle Database . 66 Utility. 170 Port number setting. 20 238 Kofax Capture 8 Installation Guide . 152 converting a site to a. 218 permissions. 64 Restart login mode. 146 sharing. 29 SNMP. 14 license server failover. 94 release script setup. 163. 66 Solaris. 143. 164 SecurityBoost and Windows 2000. 69 RecoStar Professional upgrade.Index Proxy servers. 113 SQL Server. 163 Upload virtual directory required properties. 67 storing batches. 27 U UNC paths. 20 T Technical support. xvii Templates for email notification. 167 VirtualReScan scanner support. 139 central site. 171 Source devices. 82 Sharing scanner profiles. 29 Site name. 69. 207 Running modules as services. 28 Shared license. 163 User profiles import and export. 59 Upgrading Ascent Capture at remote site. 28 Software-based licensing configure backup license server. 150 deactivating. 20 Scanner Configuration Utility. 18 Station ID. 111 Resilient system. 40 install standalone workstation. xvi Types of installations. xv Remote site authentication. 167 Upload. 229 Softbridge Basic Language. 143. 71 install Kofax Capture server. 67 SQL Server 2005 Express Edition. 96 S Sample monitoring application. 91 Restoring Microsoft SQL Server 2005 Express Edition. 33 Restoring batches. 155 Upload Properties dialog box. 159 central site. 21 Training. 116. 20 support. 30 Related documentation. 43 license management. 150 Scanner adapter. 116. 116. 124 R RAID drive. 106 V Virtual directories KCN Server. 166 write permission. 159 release. 28 software. 215 Server files. 95 image path. 233 Saving batch classes. 70 automatic batch recovery. 187 Terminal servers. 29 Substitution custom data. 113 Scanner profiles locations. 32 configurator. 28 Uninstalling Kofax Capture. 146 Security settings anonymous access. 18. 146 Site ID. 68. 72 Web Server hardware requirements. 68 WebSphere not supported. 20 Visual C++. 54 repair.Index Visual Basic.xml. 19 VRS driver installation. 174 configuring. 54 W Web farm. 170 file cache. 71 optimizing. 119 web. 47 reinstall. 74 support. 173 WebSphere basic authentication. 119 system requirements. 19 Visual Basic . 171 installing server components.NET. 35 Kofax Capture 8 Installation Guide 239 . 172 Workflow agent considerations. Index 240 Kofax Capture 8 Installation Guide .