Kofax Front-Office Server 3.0 User Manual

KOFAX

Front-Office Server

2.7

Installation Guide

10300836-000

Third-party software is copyrighted and licensed from Kofax’s suppliers. For information on third-party software included in this product, see “KFSTHIRDPARTYLICENSEREDME.txt.”

This product is protected by U.S. Patent No. 6,370,277.

THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF KOFAX, INC. USE, DISCLOSURE OR REPRODUCTION IS PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF KOFAX, INC.

Kofax, the Kofax logo, VirtualReScan, the “VRS VirtualReScan” logo, and VRS are trademarks or registered trademarks of Kofax, Inc. in the U.S. and other countries. All other trademarks are the trademarks or registered trademarks of their respective owners.

U.S. Government Rights Commercial software. Government users are subject to the Kofax, 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.

How to Use This Guide ................................................................................................................................7

Introduction ............................................................................................................................................7

Related Documentation ........................................................................................................................7

Training ...................................................................................................................................................8

Technical Support ..................................................................................................................................8

Overview ........................................................................................................................................................9

Types of Kofax Front-Office Server Configurations .........................................................................9

Scaling and High Availability Options ......................................................................................................9

Load Balancing with IIS Components for Kofax Front-Office Server .........................................10

Adding Kofax Front-Office Server Nodes ................................................................................11

Scaling the IIS Servers .........................................................................................................................11

Specifying the ProxyServer Value .............................................................................................12

Removing the Kofax IIS Components .......................................................................................12

Adding Kofax Front-Office Server Nodes to an IIS Cluster ...................................................12

Removing Kofax Front-Office Server Nodes from an IIS Cluster .........................................14

Load Balancing with Microsoft NLB ................................................................................................14

NLB Using VM Images ................................................................................................................15

Specifying the ProxyServer Value .............................................................................................15

Adding Kofax Front-Office Server Nodes to an NLB Cluster ...............................................16

Removing Kofax Front-Office Server Nodes from an NLB Cluster .....................................16

System Requirements .................................................................................................................................16

Server Requirements ...........................................................................................................................16

Supported Operating Systems ....................................................................................................16

Certified VMWare Configurations ............................................................................................17

Supported Databases for the Enterprise Configuration .........................................................17

Support for User Account Control (UAC) ................................................................................18

Minimum Hardware Requirements ..........................................................................................18

Hard Drive Space Requirements ................................................................................................18

Host Name .....................................................................................................................................18

Port Configuration .......................................................................................................................19

Client Requirements ............................................................................................................................19

Monitor Display Resolution ........................................................................................................19

Certified Web Browsers ...............................................................................................................19

Adobe Reader Requirement .......................................................................................................19

Preparing for New Installations ...............................................................................................................19

Log On Requirements .........................................................................................................................19

Network Configuration Requirements ............................................................................................20

Installing on a Local Drive .................................................................................................................20

Requirement for Free Hard Drive Space ..........................................................................................20

Kofax, Inc. 3

Contents

Registry Access ....................................................................................................................................20

Restarting the Server ...........................................................................................................................20

Invalid Drive Path ...............................................................................................................................21

Using Kofax Front-Office Server on a Virtual Machine (VM) ......................................................21

Browser Configuration .......................................................................................................................21

Security Settings for Browsers ....................................................................................................21

Text Resizing in Browsers ...........................................................................................................21

Installing Kofax Front-Office Server with Kofax Capture .............................................................21

Required Database Information for Installation .............................................................................22

Database Information for the Departmental Configuration ..................................................22

Database Information for the Enterprise Configuration ........................................................23

Installation Notes for 64-Bit Computers ..........................................................................................23

Preparing for Upgrades .............................................................................................................................24

Types of Upgrades ..............................................................................................................................24

Supported Upgrades ....................................................................................................................24

Unsupported Upgrades ...............................................................................................................25

Precautions and Preliminary Tasks Before Upgrading ..................................................................25

Upgrade Notes for User Accounts .............................................................................................25

Internet Connection Requirement ..............................................................................................26

Role-Based Permissions for Web Client Activities ..................................................................26

Services Running before Upgrading .........................................................................................26

Authentication from Directory Services after Upgrades ........................................................26

Inbox Documents .........................................................................................................................26

Documents in a Queue ................................................................................................................27

Workflow Processes .....................................................................................................................27

Backing up before Upgrading ....................................................................................................27

Upgrade Notes for MFPs ....................................................................................................................28

Preparation for Upgrades ............................................................................................................28

Upgrading the Kofax Front-Office Server Application for Fujitsu .......................................28

Upgrading the Client Software for Other MFPs ......................................................................28

Upgrade Notes for Shortcuts .............................................................................................................29

Upgrade Notes for Destinations ........................................................................................................29

Notes for Kofax Capture .............................................................................................................29

Installing a New System ............................................................................................................................29

Installing a Departmental Configuration .........................................................................................29

Installing an Enterprise System .........................................................................................................32

Installing on One Server or the First Server of a Cluster ........................................................32

Installing on Additional Servers in a Cluster ...........................................................................33

Upgrading Existing Systems .....................................................................................................................34

Performing an In-Place Upgrade .......................................................................................................35

Upgrading by Migrating ............................................................................................................................35

Preliminary Steps before Migrating ..................................................................................................36

Migrating Destination Types ......................................................................................................36

Exporting Data from the Current Installation .................................................................................36

Importing Data into the New Installation ........................................................................................37

4 Kofax, Inc.

Contents

Troubleshooting Migration ................................................................................................................39

Post-Installation and Upgrade Notes ......................................................................................................39

Licensing ...............................................................................................................................................39

Editing Default Roles after Migration ..............................................................................................39

Shared Folders Created by the Installer ...........................................................................................39

Maintaining Configuration Files in an Enterprise Cluster ............................................................39

Viewing the Installation Log Files .....................................................................................................40

Reinstalling Custom Workflows and Destinations after an Upgrade .........................................40

Managing MFPs after an Upgrade or Migration ............................................................................40

Managing MFPs after an Upgrade .............................................................................................40

Managing MFPs after Migration ................................................................................................41

Configuring Kofax Front-Office Server Destination Types ..................................................................41

Installing MFP Front Panel Software .......................................................................................................41

Other Configuration Tasks ........................................................................................................................42

Stopping and Restarting Kofax Front-Office Server ..............................................................................42

Using the Kofax Front-Office Server Status Icon ............................................................................42

Using the Services Console ................................................................................................................43

Uninstalling Kofax Front-Office Server ...................................................................................................43

Index ..............................................................................................................................................................45

Kofax, Inc. 5

Contents

6 Kofax, Inc.

How to Use This Guide

Introduction

This guide includes instructions on installing Kofax Front-Office Server. Read this guide completely before using the software. This guide was written with the assumption that you have a thorough understanding of Microsoft Windows and network configuration.

Training

Kofax offers both classroom and computer-based training that will help you make the most of your Kofax Front-Office Server solution. Visit the Kofax Web site at www.kofax.com for complete details about the available training options and schedules.

Technical Support

For additional technical information about Kofax products, visit the Kofax Web site at www.kofax.com and select an appropriate option from the Support menu. The Kofax Support pages provide product-specific information, such as current revision levels, the latest drivers and software patches, online documentation and user manuals, updates to product release notes (if any), technical tips, and an extensive searchable knowledgebase.

The Kofax Web site also contains information that describes support options for Kofax products. Please review the site for details about the available support options.

8 Kofax, Inc.

If you need to contact Kofax Technical Support, please have the following information available:

 Kofax Front-Office Server software version and build number  Operating system and service pack version  MFP or scanner make and model  Kofax Document Scan Server version  Destination type name, version, and configuration  Special/custom configuration or integration information

Overview

Kofax Front-Office Server enables documents from a variety of sources, including multifunction peripherals (MFPs), to be delivered to content management systems, email servers, and other destinations. You can install Kofax Front-Office Server on a single server or in a load-balanced cluster of multiple servers for maximum scalability and availability. See Scaling and High

Availability Options for more information.

Types of Kofax Front-Office Server Configurations

You can install Kofax Front-Office Server in the following configurations:

Kofax Front-Office Server Installation Guide

 Departmental: Install Kofax Front-Office Server on a single computer using the embedded

database.

 Enterprise: Install Kofax Front-Office Server on one computer or several computers in a

load-balanced cluster with a Microsoft SQL Server or Oracle database.

Table 1 shows which configuration you would use for the type of Kofax Front-Office Server system you want to set up.

Table 1. When to Use Different Configurations

Type of System Recommended Configuration

Evaluation or training system Departmental

Small Departmental system when an external database is not available Departmental

Any size system with an external database Enterprise

A single-computer system with the option for expansion Enterprise

A load-balanced clustered system Enterprise

Use IIS as a Web server and load balancer Enterprise

Scaling and High Availability Options

You can implement a variety of Enterprise options that will provide scalability and high availability. With an Enterprise installation, there are many load balancing options available. This section describes two possible options:

 Kofax IIS Components for Kofax Front-Office Server, which integrate the JK load balancer

with IIS (this is the recommended option).

 Microsoft Windows Network Load Balancer (NLB)

Kofax, Inc. 9

Kofax Front-Office Server Installation Guide

Load Balancing with IIS Components for Kofax Front-Office Server

You can use the integrated JK load balancer installed by Kofax IIS Components. You install the Kofax IIS components on an IIS Web server to distribute requests among multiple Kofax FrontOffice Server nodes. The Kofax IIS components installer installs and integrates the Apache Tomcat Connector (also known as mod-jk or JK) load balancer into IIS.

Figure 2. IIS/JK integrated Load Balanced Enterprise Installation

The IIS server and Kofax Front-Office Server must be on separate machines, and the IIS server must have ports 8080, 8888, and 8443 free.

The supported versions of IIS are:

 Microsoft IIS 6 running on Windows 2003 server  Microsoft IIS 7 running on Windows 2008 server

Some advantages of using IIS to load balance are:

 You can configure Kofax Front-Office Server to use HTTPS by configuring Microsoft IIS.  Authentication and authorization for IIS can be managed through the Microsoft IIS Web

server.

Note IIS authentication does not enable users to automatically log on to the

Administration Console or the Web Client (also known as single sign-on).

X To install the IIS components

1 On the IIS server, make sure IIS is enabled and the “Default Web Site” is present.

Note The installer only supports using the “Default Web Site” of IIS to host the load-

balancer, so this Web site must be present.

2 Insert the Kofax Front-Office Server installation media into your drive. 3 Run setupiis.exe, which is in the root of the Kofax Front-Office Server installation media.

Note The setupiis program detects a 32-bit or 64-bit computer and starts the correct

installer.

4 Review the Kofax Front-Office Server license agreement and select “I accept the terms of

the License Agreement” to continue with the installation. Click Next to continue.

10 Kofax, Inc.

Kofax Front-Office Server Installation Guide

5 Accept the default installation path of C:\Program Files\Kofax\IIS Components for KFS,

or browse and choose another location. Click Next.

6 Choose the folder that is shared by the Kofax Front-Office Server nodes. Click Next. 7 The Proxy Server screen notifies you that you must set the ProxyServer value after

installation. Click Next.

8 Review the pre-installation summary. To start the installation, click Install. 9 When the installation is complete, click Done. 10 On one of the Kofax Front-Office Server nodes, in the \conf folder, locate the

des.properties file and open it in a text editor. In the ProxyServer property, type the host

name or IP address of the IIS machine. Save the file.

Caution You must enter the value for the ProxyServer property.

11 Copy the des.properties file you just edited to the \conf folder on each of the remaining

Kofax Front-Office Server nodes.

12 Stop and restart Kofax Front-Office Server on each of the nodes.

Note If you are using IIS 7 and an HP MFP, you may need to increase the maximum

allowed HTTP request size to accommodate

larger documents. Refer to the Kofax Front-

Office Server Administrator’s Guide for HP MFPs for instructions.

Adding Kofax Front-Office Server Nodes

You can add additional Kofax Front-Office Server nodes at any time.

X To add a new node, install Kofax Front-Office Server on the new node, following the

instructions in Installing on Additional Servers in a Cluster

. The name of the new node is automatically added to the load balance servers property in the master configuration file in the shared folder.

Scaling the IIS Servers

You can scale the number of IIS servers by installing the IIS Components for Kofax Front-Office Server on additional IIS servers. Follow the installation instructions in Load Balancing with IIS

Components for Kofax Front-Office Server for each IIS server.

When all IIS servers have been configured, use a load-balancer such as NLB to create a cluster and add all the IIS servers as hosts in the cluster. You use the URL of the NLB cluster to log on to the Administration Console and Web Client.

To create the NLB cluster, the following must be true of each IIS server:

 Each IIS server must use a static IP address.  Each machines networkk adapter must have a unique adapter GUID. If you are using VM

images, see NLB Using VM Images

for instructions.

Kofax, Inc. 11

Kofax Front-Office Server Installation Guide

Figure 3. Scaled and Highly Available Enterprise Installation

Specifying the ProxyServer Value

Once your NLB cluster is configured, you need to specify the cluster information as the ProxyServer value in a configuration file. This will identify the cluster as the host address URL for connection to the Kofax Front-Office Server applications.

X To specify the ProxyServer value

1 In the \conf folder, locate the des.properties file and open it in a text editor. 2 In the ProxyServer property, type the IP address of the NLB cluster. 3 Save the file.

Removing the Kofax IIS Components

To remove the Kofax IIS components, use the Control Panel Add/Remove Programs to remove “IIS Components for Kofax Front-Office Server.”

Adding Kofax Front-Office Server Nodes to an IIS Cluster

You can add additional Kofax Front-Office Server nodes to an existing IIS cluster at any time.

X To add a new node

1 Install Kofax Front-Office Server on the new node, following the instructions in “Installing

on Additional Servers in a Cluster on page 33”.

2 Go to the any IIS server in the existing IIS cluster. In the <installation path>\IIS

components for Kofax Front-Office Server\Apache Software Foundation\Jakarta Isapi Redirector\conf folder, locate the workers.properties.minimal file and open it in a text editor such as WordPad.

3 You will see a section with five lines for each existing node. An example of a node section:

# Node KFS01 worker.KFS01_node.port=8009 worker.KFS01_node.host=KFS01 worker.KFS01_node.type=ajp13 worker.KFS01_node.lbfactor=1

12 Kofax, Inc.

Kofax Front-Office Server Installation Guide

4 Copy and paste a section to create a new section for each new node, and edit each of the

properties to match the host name of the node. See the example below.

Caution Do not change the values of any of the properties except for the

worker.[hostname]_node.host value. This value should be changed to match the host name of the new node.

5 Edit the property worker.loadbalancer.balance_workers, adding the new node to the

comma-delimited list of nodes.

6 Save the file, and replace workers.properties.minimal on all the IIS servers in your

configuration with the new copy, and restart IIS on each server.

Example

Here is an example of a file for an existing IIS cluster of KFS01 and KFS02:

# Define list of KFS01 workers that will be used for mapping requests

# Node KFS01 worker.KFS01_node.port=8009 worker.KFS01_node.host=KFS01 worker.KFS01_node.type=ajp13 worker.KFS01_node.lbfactor=1

# Node KFS02 worker.KFS02_node.port=8009 worker.KFS02_node.host=KFS02 worker.KFS02_node.type=ajp13 worker.KFS02_node.lbfactor=1

worker.loadbalancer.type=lb worker.loadbalancer.balance_workers=KFS01_node,KFS02_node, worker.loadbalancer.sticky_session=1 worker.list=loadbalancer worker.status.type=status

Here is the file after performing the editing steps to add a new node for IIS server KFS03. After pasting the new section for the new KFS03 node, the edits you make are shown in a colored font.

# Define list of KFS01 workers that will be used for mapping requests

# Node KFS01 worker.KFS01_node.port=8009 worker.KFS01_node.host=KFS01 worker.KFS01_node.type=ajp13 worker.KFS01_node.lbfactor=1

# Node KFS02 worker.KFS02_node.port=8009 worker.KFS02_node.host=KFS02 worker.KFS02_node.type=ajp13 worker.KFS02_node.lbfactor=1

# Node KFS03 worker.KFS03_node.port=8009

Kofax, Inc. 13

Kofax Front-Office Server Installation Guide

worker.KFS03_node.host=KFS03 worker.KFS03_node.type=ajp13 worker.KFS03_node.lbfactor=1

worker.loadbalancer.type=lb worker.loadbalancer.balance_workers=KFS01_node,KFS02_node,KFS03_node, worker.loadbalancer.sticky_session=1 worker.list=loadbalancer worker.status.type=status

Important Host names and IP addresses are not interchangeable in the

workers.properties.minimal file. You must always use host names. If you are in an environment where the host names of other machines in your configuration are not being resolved correctly or consistently, you should fix this by editing your Windows hosts file in \Windows\system32\drivers\etc.

Removing Kofax Front-Office Server Nodes from an IIS Cluster

To remove a node, delete the node information in the workers.properties.minimal file, and copy the file to and restart all IIS servers in the cluster. Then use the Control Panel Add/Remove programs to remove Kofax Front-Office Server on the removed node.

Load Balancing with Microsoft NLB

You can use NLB to create a load-balanced cluster, which will redirect Kofax Front-Office Server client HTTP traffic to all nodes in the cluster. If a node fails, convergence is initiated to redistribute the load among the remaining nodes. However, the NLB nodes will not replicate HTTP sessions, so if a user is logged on to the Administration Console or Web Client and that node fails, the user will have to log back on.

Figure 4. Possible Load Balanced (NLB) Enter pr ise Installation

You can have up to 32 nodes in an NLB cluster, so the Kofax Front-Office Server installations are scalable. In an NLB cluster, all servers monitor each other with a heartbeat signal, so there is no single point of failure.

14 Kofax, Inc.

+ 32 hidden pages