Module 3 Installing Kofax Capture Slide 1 Installing Kofax Capture Prerequisites and system requirements Remote access and virtualization support Network considerations & configuration Installation server or standalone Site Name, Site ID and Station ID Folders and files installed Attended and unattended queues Unattended queues as Windows services Multiple system administrators Kofax Deployment Utility MSI Installation Upgrading The License Utility Installing Kofax Capture Slide 2 Module 3 Installing Kofax Capture Client and Standalone Hardware Requirements Hardware (Minimum) Processor: Pentium 4 class processor, or equivalent System Memory: 512 Mbytes or more Disk Space: 680 Mbytes (client) or 760 Mbytes (standalone) plus 300 Mbytes for install & working; more for image files and large database 1024 X 768 SVGA Display with 24 bit color, small fonts USB Port and hardware key (required only if using hardware-based licensing) 600 DPI printer recommended to support Separator Sheet Utility 100 Mbps Network Interface Card (NIC) (client only) Check the Kofax Web site (Support section) and the Kofax Capture Installation Guide included with Kofax Capture for additional installation details and the most current system requirements. Slide 3 Module 3 Installing Kofax Capture Page 1
Server Hardware Requirements Hardware (Minimum) Processor: Pentium 4 class processor, or equivalent System Memory: 1 Gbytes or more Disk Space: 1.3 Gbytes plus 300 Mbytes for install & working; more for image files and large database 1024 X 768 SVGA Display with 24 bit color, small fonts USB Port and hardware key (required only if using hardware-based licensing) 600 DPI printer recommended to support Separator Sheet Utility 100 Mbps Network Interface Card (NIC) Slide 4 Module 3 Installing Kofax Capture Supported Operating Systems Windows XP Professional SP 3 and Professional x64 SP3 Windows Vista Business and Enterprise (32 & 64 bit) SP2 Windows 7 Professional, Ultimate, and Enterprise (32 & 64 bit) Windows 8 Professional and Enterprise (32 & 64 bit) Windows Server 2003 Standard, Enterprise, Datacenter (32 & 64 bit) Windows Server 2003 R2 Standard, Enterprise, Datacenter (32 & 64 bit) Windows Small Business Server 2003 Standard & Premium Windows Server 2008 Standard, Enterprise, Datacenter (32 & 64 bit) SP2 Windows Server 2008 R2 Standard, Enterprise, Datacenter (64 bit) Windows Small Business Server 2011 Windows Server 2012 Foundation, Essentials, Standard & Datacenter Check the Kofax Web site (Support section) and the Kofax Capture Installation Guide included with Kofax Capture for additional installation details and the most current system requirements. Slide 5 Module 3 Installing Kofax Capture Default Database For new Kofax Capture installations, SQL Server Express 2008 Edition Revision 2 (R2) is installed automatically. This standard database ships with Kofax Capture, and requires no additional software or configuration. The database configuration can be selected at the start of the install process, or it can be switched at any time after installation (using DBUtil). For upgrades from Kofax Capture 8.0 or 9.0, the existing database configuration will be maintained. No option to switch databases is provided during an upgrade, however the database can be switched at any time after the upgrade. If the current installation is using the default database (SQL Server 2005/2008 Express Edition), SQL Server Express 2008 Edition Revision 2 (R2) will be automatically installed. Slide 6 Module 3 Installing Kofax Capture Page 2
Database Options To actively administer the database, or for scalability and availability, the following databases can be optionally installed or converted after installation: SQL Server 2008, SQL Server 2005, SQL Server 2005 64-bit Oracle IBM DB2 Kofax Capture does not ship with or install these databases. A Kofax Capture Enterprise license is required when using SQL Server Enterprise, Oracle, or IBM DB2. Check the Kofax Web site for the latest database versions supported. Slide 7 Module 3 Installing Kofax Capture Other Requirements Other network components and requirements include: TCP/IP protocol (Kofax Capture utilizes TCP ports for communication between clients and the server.) Client for Microsoft Networks and File and Printer Sharing for Microsoft Networks A network interface card (NIC) in every machine (not required for standalone installations) To make use of the Instant Batch Notification feature, make sure port 2424 is open on all workstations To install Kofax Capture, the logged-in user must have administrative privileges to the local computer. The online Help for Kofax Capture requires Internet Explorer 6 (or higher) be set as the default browser. Slide 8 Module 3 Installing Kofax Capture Remote Access Support You can operate Kofax Capture via a Terminal Services or Citrix session. Once logged into the session, Kofax Capture operates as if it were installed on the local computer. Kofax Capture 10 has been certified for use with Citrix XenApp 5, 6, 6.5 and supports Citrix Presentation Server 4.5, Enterprise Edition. Station licenses apply to the session rather than the computer. This allows running multiple licensed applications in one session. Licensed applications that are running within the same session will share this same station license. However, licensed applications that are running within different sessions will not share the same station license. Slide 9 Module 3 Installing Kofax Capture Page 3
Virtualization Support Virtualization Support Kofax Capture is supported and has been certified for virtual computers hosted by the following products: VMware ESX Server VMware ESXi VMware vsphere Citrix XenServer Microsoft Hyper-V 2008 R2 Slide 10 Module 3 Installing Kofax Capture Language Packs Language packs are used to set the language that is available on workstations for localized Kofax Capture versions. When Kofax Capture is installed or upgraded using setup.exe, all currently available language packs on the installation media are automatically installed. If Kofax Capture is installed using the Microsoft Windows Installer (MSI) option, each available language pack is included with the installation media in a separate Windows Installer patch file (.msp) and must be installed individually. The default language can then be set from within Kofax Capture. Slide 11 Module 3 Installing Kofax Capture Globalization Enhancements Multiple languages on a single system through language packs. Facilitates deployment and administration by enhancing availability of languages for cross-departmental and crossgeography deployments. Installed language will be detected, and GUI items change dynamically. Localization is the process of adapting a product or service to a particular language, culture, and desired local "look-and-feel. Slide 12 Module 3 Installing Kofax Capture Page 4
Language Selection Localized in 11 language options: English Deutsch Spanish Portuguese Czech Swedish French Simplified Chinese Russian Japanese Polish Slide 13 Module 3 Installing Kofax Capture Affects of Localization Settings The following items are affected by localization settings: Module title bars Field type properties Kofax Capture default values Custom module and export connectors Names of Kofax Capture services The following items are unaffected by localization settings: Display labels for: batch fields, document index fields, or folder index fields Slide 14 Module 3 Installing Kofax Capture Deployment Options There are a number of ways that Kofax Capture can be deployed. Installation media or ISO file download Network (for client/server installations) Kofax Capture Deployment Utility Windows Installer (MSI) Slide 15 Module 3 Installing Kofax Capture Page 5
Installation Steps Steps for installing Kofax Capture are stated below. (Must be followed in the order shown. Depending on the unique configuration, all steps may not need to be performed.): Step 1. Install Kofax Capture. Step 2. Install language packs. Only required if language packs are desired on a workstation. Step 3. Install scanner drivers. Only required if scanner drivers are desired on a workstation. Step 4. Install and configure Kofax Capture Network Server (KCNS) components. Only required for uploading from or processing batches at remote sites using the Internet or intranet. Slide 16 Module 3 Installing Kofax Capture Installing Kofax Capture from Media Launch AutoRun.exe Slide 17 Module 3 Installing Kofax Capture The Kofax Capture Installation Menu Select Install Kofax Capture Slide 18 Module 3 Installing Kofax Capture Page 6
Welcome Note: The detailed steps for installation and their order may differ slightly based on the operating system of your computer. Slide 19 Module 3 Installing Kofax Capture Accept the License Agreement Slide 20 Module 3 Installing Kofax Capture Select Installation Type Slide 21 Module 3 Installing Kofax Capture Page 7
Select Destination Folder Slide 22 Module 3 Installing Kofax Capture Configure the Database Remember: A Kofax Capture Enterprise System license is required when using SQL Server Enterprise, Oracle, or IBM DB2. To use an alternate database from the standard: First install your database and create an empty schema (in most cases). Then, at Kofax Capture installation, be connected to the database and select the appropriate radio button for the desired database. Slide 23 Module 3 Installing Kofax Capture Enter Site Name and Site ID Slide 24 Module 3 Installing Kofax Capture Page 8
Enter Station ID Slide 25 Module 3 Installing Kofax Capture Set Reboot and Login Options Slide 26 Module 3 Installing Kofax Capture Start Installation Slide 27 Module 3 Installing Kofax Capture Page 9
System File Update System File Update looks for a standard Windows DLL set and availability. Installation begins Slide 28 Module 3 Installing Kofax Capture The Installation Begins A reboot prompt may be presented Slide 29 Module 3 Installing Kofax Capture VRS Component is Installed The VRS component is installed Slide 30 Module 3 Installing Kofax Capture Page 10
Batch Catalog Server The batch catalog setup occurs after reboot This takes a while please be patient Slide 31 Module 3 Installing Kofax Capture Windows Configures Kofax Capture Following a brief message indicating MSI Installer setup, Windows configures Kofax Capture Slide 32 Module 3 Installing Kofax Capture License Activation Begins This window will open automatically when the installation is finished. Insert a hardware key if one is being used and allow Kofax Capture to automatically activate the license. Slide 33 Module 3 Installing Kofax Capture Page 11
License Activation Options Licenses must be activated before Kofax Capture can be permanently used. Two options for licensing Kofax Capture exist (choice at time of purchase): 1) Software license activation A Kofax serial number and product code are provided from Kofax. 2) Hardware key A hardware key ( dongle ) is shipped for use with the product. When prompted during installation, either insert the hardware key or enter the serial number and product code based on the selected option for licensing. Licenses can be activated and upgraded over the Internet. Slide 34 Module 3 Installing Kofax Capture Software License Activation For software activation, select the [Software] radio button, enter the Kofax serial number and Product code provided, then click the [Automatic] button. Slide 35 Module 3 Installing Kofax Capture Activating a Hardware Key If a hardware key has been inserted into the computer, Kofax Capture will detect it and display the serial number. Click on the [Automatic] button to activate your license. Slide 36 Module 3 Installing Kofax Capture Page 12
Finalizing License Activation A message will appear during and at the successful conclusion of license activation Slide 37 Module 3 Installing Kofax Capture Finalizing Installation Slide 38 Module 3 Installing Kofax Capture Folders and Files Installed Location 1 See Reference section for file and folder details Kofax Capture creates folders and files in two locations: ProgramData\Kofax\Capture and Slide 39 Module 3 Installing Kofax Capture Page 13
Folders and Files Installed Location 2 Slide 40 Module 3 Installing Kofax Capture Program Files(x86)\Kofax\Capture Installing in a Client/Server Environment When installing in a client/server environment, install Kofax Capture on the server first, then on each client workstation. Installation on the server is almost identical to the instructions for a standalone with some exceptions. Select [Server] Slide 41 Module 3 Installing Kofax Capture Server Software Folders Slide 42 Module 3 Installing Kofax Capture Page 14
Server File Folders A prompt to share this directory will be presented. Note: In a client-server installation, this should always be a UNC path such as: \\Server\CaptureSV. Slide 43 Module 3 Installing Kofax Capture Completing the Server Installation The rest of the setup is the same Slide 44 Module 3 Installing Kofax Capture Client/Server License Activation Options Typically, the Kofax Capture system license is activated on the server. For a variety of reasons, the license can be activated on a client machine. When activating the license on a client machine, the ACConfig.xml file in the Server Files Folder Config directory (Example: \\Server\CaptureSV\Config) will need to updated to identify the client machine as the new license server for the Kofax Capture system. (The license server configuration utility can assist: Program Files(x86)\Kofax Capture\Bin\ACLicSrvCfg.exe) Slide 45 Module 3 Installing Kofax Capture Page 15
Server Folders and Files Installed Location 1 See Reference section for file and folder details Slide 46 Module 3 Installing Kofax Capture Kofax Capture creates folders and files in two locations: ProgramData\Kofax\CaptureSV and Server Folders and Files Installed Location 2 Slide 47 Module 3 Installing Kofax Capture Program Files(x86)\Kofax\CaptureSS Installing on a Client Workstation From each workstation, connect to the share CaptureSV and the WrkInst folder on the Kofax file server and run Setup.exe The rest of the setup is the same Slide 48 Module 3 Installing Kofax Capture Page 16
Installation from a Network Kofax Capture and its components can be installed from a network, rather than from the installation media, making it easier for installations on multiple computers having access to a single network folder. To install components from a network: 1. Copy the contents of the Kofax Capture installation media into a single folder on your network. 2. From any computer attached to your network, browse to the folder where you copied the contents and double-click the AutoRun.exe file. 3. Complete the installation as described previously in this module. Slide 49 Module 3 Installing Kofax Capture Silent Install Option In addition to the manual and automatic installation, there is also an option for a silent installation. Deploy unique Kofax Capture systems across your enterprise quickly. Use default settings or Create an initialization file that defines installation settings and parameters See Chapter 13 of the Kofax Capture Installation Guide for details on writing an initialization file. Slide 50 Module 3 Installing Kofax Capture Kofax Deployment Utility Deploy unique Kofax Capture systems across an enterprise quickly. Central source for configuring Kofax Capture settings for destination computers. Assists system administrators with installing Kofax Capture on multiple computers. Command line executable: C:\Program Files(x86)\Kofax\Capture\Bin\ACDeployUtil.exe The following four values are set: Server Path Site Name Site ID Station ID Slide 51 Module 3 Installing Kofax Capture Page 17
Steps for the Deployment Utility Step 1: Set up a prototype machine Step 2: Back-up the prototype machine Use a fast back-up that creates a complete machine image ( Ghost image ) Step 3: Restore back-up on new machine Step 4: Set machine-specific settings on new machine Step 5: Repeat Steps 3 and 4 for all needed machines. Run ACDeployUtil Run ACDeployUtil Run ACDeployUtil Original Software Prototype Machine Create Image Production Machine 1 Production Machine 2 Production Machine 3 Slide 52 Module 3 Installing Kofax Capture MSI Windows Installer Windows Installer (MSI) can be used to deploy Kofax Capture. MSI package is essentially a database that contains installation information used by the Windows Installer engine to perform installation of the specific product. The MSI package contains installation information used by the Windows Installer engine to install Kofax Capture, and represents an alternative to stand-alone executable installers such as InstallShield. Slide 53 Module 3 Installing Kofax Capture Reasons to Use MSI Deployment of Kofax Capture and updates can be a major issue for enterprise customers. Possibility for hundreds of stations Possibility for hundreds of remote sites Accessibility issues Manpower issues MSI files generally offer more flexibility when installing MSI installers allow you to repair your current installation, instead of having to uninstall and reinstall a damaged program Group Policy installs only support MSI install packages Workstations can be installed disconnected (no server online) Slide 54 Module 3 Installing Kofax Capture Page 18
Using the MSI Option Advanced users can deploy Capture.MSI directly Administrator must ensure all pre-requisites are installed Configuration options specified as properties rather than through user prompts Remember if the MSI Installer is not being used, the standard installation menu that uses setup.exe can still be used which: Prompts user and installs prerequisites as in previous releases Uses Capture.MSI for install Slide 55 Module 3 Installing Kofax Capture MSI Prerequisites The following software must be installed before running the MSI installer: Kofax VRS Elite 5.1 Sentinel Driver 7.5.0 or later Visual C++ 2010 Runtime SP1 (32-bit version)* Visual C++ 2008 Runtime SP1 (32-bit version)* Visual C++ 2005 Runtime SP1 (32-bit version)*.net Framework 4.0.NET Framework 3.5 SP1 Visual Basic 6.0 Runtime SP6 Supported database Microsoft Access Database Engine 2010 SP1 (32-bit version) *If using a 64-bit operating system, be sure to install the 32-bit version, not the 64-bit version. Slide 56 Module 3 Installing Kofax Capture Loading MSI Prerequisites If the prerequisites don t already exist on the system, pause the MSI installation and access the required software from the media. Location of the software is in the following directory on the media: Kofax Capture \ Prerequisites Install the software and restart the MSI installation Slide 57 Module 3 Installing Kofax Capture Page 19
Supported MSI Deployment Technologies Deployment technologies supported include: Microsoft System Center Configuration Manager IBM Tivoli Symantec Altiris HP Openview Information for using MSI Installer is available in the Kofax Capture Installation Guide. Slide 58 Module 3 Installing Kofax Capture Upgrading to Kofax Capture 10 The installation supports upgrading from Kofax Capture 8.x or 9.x to Kofax Capture 10. Batches may be in progress. If an earlier version of Ascent Capture (7 or earlier) is installed, an upgrade to an intermediate version is required. When upgrading a client/server installation, the server must be upgraded first, then the clients are upgraded from the server. Slide 59 Module 3 Installing Kofax Capture Upgrade from the Kofax Capture Installation Menu To upgrade, Select Install Kofax Capture Slide 60 Module 3 Installing Kofax Capture Page 20
Upgrading from Kofax Capture 8.x or 9.x Doing an upgrade will automatically convert existing batch classes Slide 61 Module 3 Installing Kofax Capture Upgrade Warning Slide 62 Module 3 Installing Kofax Capture Conversion Window The conversion log displays automatically after restart Slide 63 Module 3 Installing Kofax Capture Page 21
Convert.log is Created in the Logs Directory ProgramData\Kofax\Capture\Logs Slide 64 Module 3 Installing Kofax Capture The Kofax Capture Program Group The Kofax Capture 10.1 Program Group Slide 65 Module 3 Installing Kofax Capture The Kofax Capture License Utility An independent license module that no longer depends on Kofax Capture to function. Continues to provide all the license-related processing for Kofax products that require it. Access the license utility from the Kofax Capture program group or from: Program Files(x86)\Kofax\Capture\Bin\KSALicenseUtility.exe Slide 66 Module 3 Installing Kofax Capture Page 22
Select the License Utility Slide 67 Module 3 Installing Kofax Capture The Kofax License Utility Interface The License Utility displays the current status of all active licenses on the system Lists active licenses Lists available, maximum, remaining, and full count values Lists expiration and renewal dates Displays the license serial number information Displays server information Slide 68 Module 3 Installing Kofax Capture Steps for Manual License Activation File Activate First, obtain the Kofax Capture serial number. This can be done by reading it from the label affixed to the hardware key, or by plugging in the key and opening the license utility (File Activate) Serial number Slide 69 Module 3 Installing Kofax Capture Page 23
Obtain the Activation Code Next, navigate to the Kofax Activation Web Page (http://activatelegacy.kofax.com/suppo rt/activation/manual.aspx), enter the license serial number and email address, and then [Submit]. Copy the activation code that gets displayed. 1. Enter the serial number, email address, and version. 2. Click [Submit]. 3. Copy the activation code. Slide 70 Module 3 Installing Kofax Capture Activate the License Finally, return to the license utility and paste the code to complete the activation. File Activate 1. From the Activate window, click on [Manual] 2. Paste the entire activation code into the Manual Activation window and click on [Activate] Slide 71 Module 3 Installing Kofax Capture Running Unattended Queues as Windows Services Once Kofax Capture is installed, any unattended queue can be run as a Windows service. Here are the instructions to do that: 1. Open a command window 2. Go to the Program Files(x86)\Kofax\Capture\Bin directory On a client\server install, use UNC 3. Simply type the name of the executable* followed by a space and -install. For example: ocr.exe -install 4. To uninstall, type the name of the executable followed by a space and -uninstall. *(Refer to the Kofax Capture Installation Guide for executable names.) Slide 72 Module 3 Installing Kofax Capture Page 24
Running Multiple Queues as Services Multiple unattended queues can be run as services on the same computer. In this case, a single station license will suffice. Remember, with a Kofax Capture Enterprise System license, multiple instances of the same unattended queue can be run as services on a single station. Slide 73 Module 3 Installing Kofax Capture Installing Multiple Services To install multiple instances of a service, just repeat the installation procedure for that service. An ID is automatically appended to the service name for each instance. For example, to install three instances of the OCR Full Text service, repeat the installation command line three times: "< Kofax Capture installation folder>\bin\ocr.exe" -install "< Kofax Capture installation folder>\bin\ocr.exe" -install "< Kofax Capture installation folder>\bin\ocr.exe" -install Each multiple instance of the OCR Full Text service is assigned a unique instance ID, as shown in the example below: Slide 74 Module 3 Installing Kofax Capture Multiple Simultaneous System Administrators Multiple system administrators can run the Administration module on multiple workstations for each Kofax Capture installation. The Administration module may be opened on multiple stations at the same time (but still only once per station). Different batch classes may be edited by different administrators or different tasks may be performed at different stations. (Example: remote site profiles may be edited by one administrator at the same time a batch class is being edited by another administrator.) Multiple Simultaneous System Administration is enabled by default for any Kofax Capture 10 installation. Slide 75 Module 3 Installing Kofax Capture Page 25
Locking Multiple Simultaneous System Administration To protect the integrity of batch classes, some resources are protected from being edited and accessed at the same time from different Administration instances Implemented by temporarily locking the resource about to be changed This is done to primarily protect against the following: Prevent duplicate index fields in document and folder classes Prevent the export connectors from being invoked by more than one workstation at a time If an administrator tries to edit an object that is already being edited by another system administrator (it is locked) an error message is displayed that the object is being edited If an administrator receives no message and is able to edit the item concurrently with another system administrator the last changes saved remain in effect Slide 76 Module 3 Installing Kofax Capture Multiple Simultaneous System Admins Error Message If an administrator tries to edit an object that is already being edited (locked) by another system administrator, an error is returned. Slide 77 Module 3 Installing Kofax Capture To Disable the Feature To disable this feature: Close the Administration module. In the KfsDB element of the ACConfig.xml file, add the following element: <AllowMultipleAdmins>0</AllowMultipleAdmins> Slide 78 Module 3 Installing Kofax Capture Page 26
Error Messages If Multiple Simultaneous System Administration has been disabled and a second instance of the Kofax Administration module is opened, the following error is returned: An error message will appear when importing a batch class if the Replace duplicates with items imported option is selected, and one of the duplicate batch classes is currently being edited: Slide 79 Module 3 Installing Kofax Capture Accessing the Kofax Capture Documentation A complete set of Kofax Capture documentation is available in PDF format on the media accessible from the menu. Select View Documentation Slide 80 Module 3 Installing Kofax Capture Related Documentation Kofax Capture documentation includes: Kofax Capture Installation Guide Provides a description of the installation procedures and requirements. Kofax Capture API Reference An online reference that provides the details of each API library needed to customize Kofax Capture, designed to be used with the Kofax Capture Developer s Guide for customizing Kofax Capture. Kofax Capture Export Type Library API Reference Contains the details of the Kofax Capture Export Type Library, which is used to customize Kofax Capture export connectors. Designed for use with the Kofax Capture Developer's Guide. Kofax Capture Administrator s Guide Provides a description of the configuration features and procedures of Kofax Capture. Slide 81 Module 3 Installing Kofax Capture Page 27
Related Documentation (continued) Kofax Capture Developer s Guide Provides guidance information regarding reasons for customizing Kofax Capture and instructions to do so. Several examples and code segments are provided to enhance Kofax Capture processing. Kofax Capture Online Help Provides online assistance for system administrators and operators. Slide 82 Module 3 Installing Kofax Capture Viewing the Documentation and Help Files Documentation (PDF files) and browser-based Help for Kofax Capture can be viewed by clicking the associated links. Slide 83 Module 3 Installing Kofax Capture Demonstration DVD contents, installation of Kofax Capture, license activation Slide 84 Module 3 Installing Kofax Capture Page 28
Lab Installing Kofax Capture 10 Creating a desktop shortcut to Kofax Using the License Utility Refer to the Kofax Capture 10 Lab and Reference Guide Slide 85 Module 3 Installing Kofax Capture Page 29