Front Office Server 3.0

(1)

Administrator’s Guide

Kofax

(2)

Third-party software is copyrighted and licensed from Kofax’s suppliers. For information on third-party software included in this product, see “KFSTHIRDPARTYLICENSEREADME.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

(3)

Preface ...5

About the Configuration Folder Location in this Guide ...5

Preface

This guide is intended to be used by the administrator who will configure and maintain the Kofax Front Office Server installation.

This guide assumes that you have a thorough understanding of application servers, Internet technologies and Web servers, your network configuration, and Kofax Capture.

About the Configuration Folder Location in this Guide

There are several shared configuration files you can edit to change product behavior. During Kofax Front Office Server installation, the location of the Kofax Capture server installation is identified, and a subfolder structure \KFS\Config is created to hold the configuration files for Kofax Front Office Server. By default, the full path is:

Windows Server 2003

For standalone installations:

C:\Documents and Settings\All Users\Application Data\Kofax\Capture\KFS\Config For Enterprise installations:

C:\Documents and Settings\All Users\Application Data\Kofax\CaptureSV\KFS\Config Windows Server 2008

For standalone installations:

C:\ProgramData\Kofax\Capture\KFS\Config For Enterprise installations:

C:\ProgramData\Kofax\CaptureSV\KFS\Config

In the rest of this guide, references will use just the folder names \KFS and \KFS\Config without the additional path details.

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 Assistance for your Kofax Product

Support for your Kofax product is provided by your primary application support provider, which is specified as part of the maintenance agreement associated with your purchase. Please contact your Kofax application support provider for technical assistance.

For more information about your product, visit the Kofax Support pages at www.kofax.com for:

Product information and release news Access to the Kofax Knowledgebase

Access to the online Case Management System (for eligible customers) Downloadable product documentation

Before contacting your Kofax application support provider, please gather the following information where applicable:

Product name, version, and serial number Log files

Product license Exact error message(s) Reproduction scenario

Overview

Kofax Front Office Server, an add in for Kofax Capture, enables documents from a variety of sources, including multifunction peripherals (MFPs), to be delivered directly to Kofax Capture, or to the Web Client application for additional processing before release to Kofax Capture.

Integration with Kofax Capture

Kofax Front Office Server integrates with Kofax Capture and takes advantage of the following features.

User Authentication

(8)

Note Access to the Administration Console is restricted to Kofax Capture users who have rights to the Kofax Capture Administration module. All Kofax Capture users can be assigned permission to access the Web Client without special Kofax Capture rights.

Licensing

Kofax Front Office Server integrates with the Kofax Capture centralized license management scheme.

System Licenses

Kofax Front Office Server

System license to run Kofax Front Office Server standard installations using the Microsoft SQL Server Express database.

Kofax Front Office Server Enterprise

System license to run Kofax Front Office Server Enterprise installations using a SQL Server or Oracle database.

Station Licenses

Kofax Front Office Server Device

Limits the number of devices that can be added to the Administration Console. When no more device licenses are available, no more devices can be added. You can either remove devices, or purchase additional licenses.

Kofax Front Office Server Web Client

Limits the number of concurrent open sessions of the Web Client. When no more station licenses are available, users cannot log on. You can either have current users log off, or purchase additional licenses.

Volume Licensing and MFPs

Volume licensing for the following Kofax Capture licenses is not affected (page count is not decremented) for any documents that are scanned at an MFP and come through Kofax Front Office Server:

Scan/Import page count

Kofax PDF Image+Text page count

Any documents that did not originate at an MFP (for example, scanned or uploaded into the Web Client and then released) also decrement page count.

Shared Folder in Kofax Capture Server Files Location

The Kofax Front Office Server installation detects the location of the Kofax Capture server files, and creates a \KFS subfolder where users inboxes, scanjob images, and configuration files (among other items) are stored.

Warning If the location of the Kofax Capture server files is ever changed after Kofax Front Office Server installation, you must follow the instructions in

Validation

(9)

Volume Licensing

Volume licensing for Kofax Capture is not affected (page count is not decremented) by the scanning or releasing of documents with Kofax Front-Office Server for the following licenses:

Scan/Import Page Count

Kofax PDF Image + Text Page Count

Volume licensing is still affected by activity from any custom Web services client.

Starting the Kofax Front Office Server Applications

Before starting either of the applications, complete the installation and make sure that Kofax Front Office Server has started.

Starting the Administration Console

You can start the Administration Console from the Kofax Capture Administration Module, or from a browser by entering the URL.

Before starting the Administration Console, do the following:

Make sure that the Web browser is certified by Kofax Front Office Server. Enable the browser to use cookies and JavaScript.

Make sure that Kofax Front Office Server has been properly installed and is running.

Once you start the Administration Console, you can click the Help button for information about the particular node and tab you are on, and from there you can access the entire Help system or select other nodes. The Introduction to the Administration Console topic is a good place to start, because it outlines the general steps to configure MFPs and describes the tasks you can perform. X To start the Administration Console from the Kofax Capture Administration Module

1 Start the Kofax Capture Administration Module.

2 From the Kofax Front Office Server menu, select one of the Administration Console nodes.

3 The Administration Console appears (Figure 2).

(10)

2 Start the Administration Console by doing either of the following:

Open a certified Web browser and type the URL for Kofax Front Office Server

Administration Console. For the URL, refer to Identifying the URLs for Kofax Front Office Server Applications.

If you are at the server, select Start | Programs | Kofax | Front Office

Server |Administration Console.

3 The Administration Console Log On screen appears (Figure 3). If automatic log on (also called single-sign on) does not occur, the Administration Console Log On screen appears.

Figure 3. The Administration Console Log On Screen

Tip Bookmark the Administration Console Log On screen to make it convenient to start it each time.

4 Type your Kofax Capture user ID and password. Passwords are case-sensitive.

5 After you have logged on successfully, the Administration Console appears (Figure 2). Expand the nodes in the menu on the left to add MFP devices and perform other management tasks.

Starting the Web Client

Before you can log on to the Web Client, you need the following:

The URL of the Web Client. For the URL, refer to Identifying the URLs for Kofax Front

Office Server Applications.

A user name and password if you are prompted for lon on credentials A Web browser supported by the Web Client.

Cookies and JavaScript enabled on the browser.

Tip Bookmark the Web Client Log On page to make it convenient to start it each time. X To log on to the Web Client

(11)

Figure 4. The Web Client Log On Screen

2 Type your Kofax Capture user ID and password. Passwords are case-sensitive. 3 Click Log On. The Web Client window appears.

Identifying the URLs for Kofax Front Office Server Applications

Provide all users of Kofax Front Office Server applications with the URL they need to connect from a Web browser.

For Kofax Front Office Server Administration Console, type the URL as follows: If security is not enabled with an SSL certificate:

http://server/KFS/KFSAdmin

If security is enabled with an SSL certificate:

https://server:8443/KFS/KFSAdmin

For Kofax Front Office Server Web Client, type the URL as follows: If security is not enabled with an SSL certificate:

http://server/KFS/KFSWebClient

If security is enabled with an SSL certificate and you are not using WebScan:

https://server:8443/KFS/KFSWebClient

If security is enabled with an SSL certificate and you are using WebScan:

https://servername:8443/KFS/KFSWebClient

Where:

server is the IP address or host name of:

The computer with a departmental installation of Kofax Front Office Server An NLB cluster or IIS server in an Enterprise installation

servername is the host or DNS name of:

(12)

Note the following:

In the URL, “KFSAdmin” and “KFSWebClient” may be typed in all uppercase or all

lowercase, as in these examples:

http://server/KFS/KFSADMIN http://server/KFS/kfsadmin http://server/KFS/KFSWEBCLIENT http://server/KFS/kfswebclient

You can omit the Web Client portion of the URL to start, as in this example:

http://server/KFS/

Stopping and Restarting Kofax Front Office Server

You may need to stop and restart Kofax Front Office Server when changing some of the files in the \KFS\Config folder or for routine maintenance. The process depends on which type of

installation and configuration you use, and the instructions are in the Kofax Front Office Server Installation Guide.

Changing Host Names

The host name of a computer should not be changed after Kofax Front Office Server has been installed. Changing the host name may cause problems connecting to MFPs. You can restore connections by changing the host name back to the one you used when you licensed Kofax Front Office Server.

The host name of an MFP also should not be changed after it has been added to Kofax Front Office Server. Because the Administration Console does not recognize that the MFP’s host name has changed, it instead recognizes it as a different device. If you add the device with the new host name, the Administration Console will have two records and use two input licenses for the same device.

Security Options

This section contains infromation about security options available to you.

LDAP Signing Requirement

For security reasons, Microsoft recommends that you enable LDAP signing. However, user authentication will fail if the LDAP signing requirement is enabled on the domain controller but not on all the workstations, and the following message appears in the log:

[security.SecurityPrincipalManager] A more secure authentication method is required for this server.

If you choose to enable LDAP signing, make sure the settings on all workstations match that of the domain controller.

Enabling Security with SSL

(13)

Tip If you use the DSA algorithm when creating a self-signed certificate for use with SSL, users will not be able to connect to the HP MFP. To use SSL with the HP, you must create the certificate using the RSA algorithm. We recommend you use the RSA algorithm when generating self-signed certificates.

In preparing to enable security with SSL, note the following:

Kofax Front Office Server ships with a default self-signed SSL certificate, with the file

avalin.keystore which specifies “avalin” as the host name for the installation.

The avalin.keystore file is located in the \Kofax\Front Office

Server\Avalin\jboss\server\avalin\conf folder where Kofax Front Office Server is installed.

You can replace the file avalin.keystore, using the same file name to ensure a smooth

implementation and to avoid having to edit other server and/or network properties.

If replacing the file avalin.keystore using the same file name, note the following:

Keystore password=avalin

Host name=The full name for the server where Kofax Front Office Server is installed.

For example: www.mycompany.com or Server01.

Key password=avalin

Kofax Front Office Server by default uses port 8443 for the secured transmittal of

encrypted data.

The URL for accessing the Administration Console or the Web Client requires https instead

of http.

For more information, see Identifying the URLs for Kofax Front Office Server Applications.

About Single Sign On

Kofax Front Office Server supports single sign on for Kofax Capture linked users. If users log on to a computer using a user account that is linked in Kofax Capture and have the appropriate access rights, users can start the Administration Console or the Web Client without being prompted to log on.When authentication fails, or if the user is not authorized to log on, a log on screen appears to allow users to manually enter credentials. This section assumes you are familiar with Group Policy configuration and using and registering a Service Principal Name (SPN).

To use the single sign-on feature, the following conditions have to be met:

If using IIS, the IIS authentication method must be set to “Enable anonymous access.” Clients must use Internet Explorer 7 or 8.

Clients and Kofax Front Office Server must be on the same domain.

Internet Explorer must have the “Enable Integrated Windows Authentication” option

turned on.

If users are using the Fully Qualified Domain Name (FQDN, Internet Explorer must have

(14)

Important When adding to the Trusted zone, the IE Security Settings option “User Authentication |Logon” must be set to “Automatic logon with current user name and password.”

The user you specify with SPN must be in the Administrators group on the computer

registered with DNS. X To enable single sign on

1 In the \KFS\Config folder, open kfs.properties in a text editor. 2 Change the EnableSingleSignOn to true as shown:

EnableSingleSignOn=true

3 Save and close the file. The change takes effect automatically in less than a minute. In the following section Examples of Possible Configurations, there are some additional configuration tasks listed in the tables to register DNS and SPN. Although it is expected that system administrators will know how to perform those tasks, we include the following instructions.

X To register DNS entry pointing to some machine to hosting the physical server

Note You do this before you register the SPN because you need to use the URL that you will create as part of the SPN command line entry when you register SPN in the next set of steps. Note also that you must create a DNS entry for all configurations, including a standalone (Departmental), that will not use the host name in the URL.

1 On your domain controller, open Administrative Tools |DNS.

2 Expand Forward Lookup Zones, select your domain, then right-click and select New Host (A).

3 In the “Name” field, type a name that will be the first part of the URL (for example, www-kfs). This will be the URL address. Be sure the name you enter is not already used on the domain.

4 In the “IP address” field, enter your standalone IP or the IP of your proxy IIS, IBM HTTP for WebSphere, or NLM cluster host.

5 Click Add Host.

X To register SPN (service Principal Name) under the user account running the KofaxServer service.

(15)

1 On the domain controller machine (where directory service runs), open a Command Prompt and run:

Setspn -A <http/DNS name> <domain>\<user>

For example, in an domain named domain01 for the account Kfs-service-user, you would run:

Setspn -A http/wwwcomputer01 Kfs-service-user

This registers SPN for Kfs-service-user.

2 Change the log on account for all your KofaxService services to the account you just registered.

Examples of Possible Configurations

The remainder of this section provides examples and lists any additional configuration needed for different installations, log on accounts to run KofaxServer service, and URLs used to log on to the Web Client (used in the examples) and the Administration Console.

Single Server Installation (Department or Enterprise)

Figure 5 illustrates a single server installation on a domain (Kofax.com). Both the server (named kfs-svr) and client (names Mike-xp-wks) are on the same domain. A domain account Kfs-service-user has been created to be used instead of the built-in Local System account. Clients access the server using either host name or a DNS name.

Figure 5. Single Server

Table 1. Client Connects to Server Using the Host Name URL Entered by Mike on

Mike-xp-wks

Log on Account for KofaxServer Service

Additional Configuration Required by a Domain Administrator

http://kfs-svr/KFS/ KFSWebClient

Local System1 None

intranet (kofax.com) Mike-xp-wks

(16)

1 If you need to use a domain user account, then you must use a DNS name. See the next table for information. .

Enterprise Cluster with Proxy Server

Figure 6 illustrates an Enterprise installation using a proxy. The cluster is configured to include kfs-svr-node1, kfs-svr-node2 and the proxy server kfs-svr-proxy. All servers and clients are on the same domain. Clients access the cluster through the proxy server’s designated DNS name.

http://kfs-svr.kofax.com/ KFS/KFSWebClient

Local System1 Add the FQDN (kfs-svr.kofax.com) to the Intranet zone or Trusted zone in Internet Explorer. This can be done individually on each client browser, or it can be done on the domain controller with Group Policies so that the setting will be applied to all clients in the domain.

Note that the DNS and SPN steps in the following configurations are not necessary since they are done automatically for server host names.

Table 2. Client Connects to Server Using a DNS Name URL Entered by Mike on

Mike-xp-wks Log on Account for KofaxServer Service Additional Configuration Required by a Domain Administrator

http://www-kfs/KFS/

KFSWebClient Kfs-service-user On the domain controller, register DNS entry pointing www-kfs.kofax.com to host machine kfs-svr.

On the domain controller, register SPN HTTP/ www-kfs-svr.kofax.com under user account Kfs-service-user. Then, configure the computer to use Kfs-service-user as the KofaxService log on account

http://www-kfs.kofax.com/

KFS/KFSWebClient Kfs-service-user Same two steps above plus:_{Add the FQDN (kfs-svr.kofax.com) to the} Intranet zone or Trusted zone in Internet Explorer. This can be done individually on each client browser, or it can be done on the domain controller with Group Policies so that the setting will be applied to all clients in the domain.

Table 1. Client Connects to Server Using the Host Name (continued) URL Entered by Mike on

Mike-xp-wks

(17)

Figure 6. Cluster with Proxy Server.

Enterprise Cluster with NLB

Figure 7 illustrates an enterprise installation using NLB. The NLB cluster is configured to include kfs-svr-worker1 and kfs-svr-worker2. The cluster name is www-kfs.kofax.com. All servers and clients are on the same domain. Clients access the cluster through the cluster’s DNS name. Table 3. Client Connects to Proxy Server Using DNS Name

URL Entered by Jack on

Jack-xp-wks Log on Account for KofaxServer Service Additional Configuration Required by a Domain Administrator

http://www-kfs/KFS/

KFSWebClient Kfs-service-user On the domain controller, register DNS entry pointing www-kfs.kofax.com to host machine kfs-svr-proxy.

On the domain controller, register SPN HTTP/ www-kfs.kofax.com under user account Kfs-service-user. Then, configure every Kofax Front Office Server in the cluster to use Kfs-service-user as the KofaxService log on account http://www-kfs.kofax.com/

(18)

Figure 7. Cluster with Microsoft NLB

Managing Free Drive Space

The Kofax Front Office Server database expands in size as it accumulates logs and document tracking records. If destination types go offline for a prolonged period of time, requests are queued on the server, which also consumes hard drive space. If the hard drive runs out of space, Kofax Front Office Server may operate unpredictably.

Tip You can monitor the KFS.log file for any drive space errors. Table 4. Client Connects to Server (NLB Cluster) Using DNS Name

URL Entered by Jill on Jill-xp-wks

Additional Configuration Required by a Domain Administrator

http://www-kfs/KFS/ KFSWebClient

Kfs-service-user On the domain controller, register DNS entry www-kfs.kofax.com as NLB cluster name pointing to the static IP address assigned to the NLB cluster.

On the domain controller, register SPN HTTP/ www-kfs.kofax.com under user Kfs-service-user. Then, configure every Kofax Front Office Server in the cluster to use Kfs-service-user as the KofaxService log on account.

http://www-kfs.kofax.com/

(19)

Blocking Requests when Drive Space is Limited

When drive space reaches a minimum threshold (the default minimum threshold is 5 GB), Kofax Front Office Server blocks requests until more drive space is made available. You can adjust this amount by editing the system.resource.checker.properties file. It is located in the \conf folder. Modify the following properties in a text editor:

enabled limits

check.frequency.millis

accept.requests.on.disk.check.error

When you have finished modifying the file, stop and restart Kofax Front Office Server.

Backing Up and Restoring

This section provides instructions for backing up and restoring Standard and Enterprise configurations.

Departmental Configurations

This section provides instructions for gathering backup data and restoring a Departmental configuration. You may want to back up important data before upgrading, and regularly to be able to restore a failed system to a certain state.

Make sure that you have your original Kofax Front Office Server installation media (or installation media of the same version) before proceeding.

X To backup data

1 In the Services console, stop the SQL Server (KFS) service. 2 Create backup copies of the following folders:

<Kofax Capture Server folder>\KFS

\Avalin, \Resources, and \SQLServer at the root of the Kofax Front Office Server

installation

3 Verify that the backup was successful, and store in a safe location. X To restore Kofax Front Office Server

1 Remove the non-functional Kofax Front Office Server installation from the computer. This can be done by uninstalling the software or restoring the computer a state before Kofax Front Office Server was installed. Be sure that all Kofax Front Office Server software is removed from the computer.

2 Install the same version of Kofax Front Office Server as you previously backed up, because the installer versions must match. If possible, install to the same path as the original installation.

3 In the Services console, stop the following services:

(20)

\Avalin, \Resources, and \SQLServer at the root of the Kofax Front Office Server

installation

6 Replace the deleted folders with the backup data folders.

7 Set the Security permissions of the following folders to grant Full Control to the Windows user that was specified for the Kofax Front Office Server service during installation:

\Avalin and \Resources at the root of the Kofax Front Office Server installation folder.

8 Set the Security permissions of the \SQLServer at the root of the Kofax Front Office Server installation to grant Full Control to the NETWORK SERVICE user.

9 In the Services console, start the following services:

KofaxServer SQL Server (KFS)

10 On 32-bit computers, you can display the Kofax Server Monitor in the system tray by selecting Start |Programs | Kofax Front Office Server| Kofax Server Monitor.

Enterprise Configurations

This section provides instructions for gathering backup data and restoring an Enterprise configuration. You may want to back up important data before upgrading, and regularly to be able to restore a failed system to a certain state.

Make sure that you have your original Kofax Front Office Server installation media (or installation media of the same version) before proceeding.

X To backup data

1 Create backup copies of the following folders:

\Avalin and \Resources at the root of the Kofax Front Office Server installation

2 Verify that the backup was successful, and store in a safe location. 3 Backup your SQL Server or Oracle database state.

X To restore Kofax Front Office Server

1 Remove the non-functional Kofax Front Office Server installation from all computers in the cluster. This can be done by uninstalling the software or restoring the computers a state before Kofax Front Office Server was installed. Be sure that all Kofax Front Office Server software is removed from the computer.

2 Install the same version of Kofax Front Office Server as you previously backed up, because the installer versions must match. If possible, install to the same path as the original installation.

3 In the Services console, stop the KofaxServer service.

4 If you have a 32-bit computer with the Kofax Server Monitor running in the system tray, right-click the icon and select Exit.

5 Delete the following folders:

(21)

6 Replace the deleted folders with the backup data folders.

7 Set the Security permissions of the following folders to grant Full Control to the Windows user that was specified for the Kofax Front Office Server service during installation:

\Avalin and Resources at the root of the Kofax Front Office Server installation

8 Restore your backed-up SQL Server or Oracle database state. 9 In the Services console, start the KofaxServer service.

10 On 32-bit computers, you can display the Kofax Server Monitor in the system tray by selecting Start |Programs | Kofax Front Office Server| Kofax Server Monitor.

Setting Options for the Web Client

This section contains instructions on how to set up some options related to the Web Client.

Defining the Page Size for the Web Client List of Documents

When you are viewing a list of documents in the Inbox, only a certain number of these documents display at one time, on a page of the list. If the number of documents in the Inbox exceed a defined maximum for a page, you can view additional pages of the list.

The Web Client installs with a default page size for the list of documents. If you have a preference, you can change the maximum number of documents to display on a single page of the list. You can set the page to display from 1 to 150 listed documents.

X To define the page size of the list of documents

1 In the \KFS\Config folder, locate the KFSportal.properties file and open it in a text editor. 2 Edit the following property to specify the desired maximum number documents for a

page of the list of documents:

paging.page.size

For example, to set the maximum number to 25, define the property as follows:

paging.page.size=25

3 Save the file.

For the change to take effect, users need to log out of and log in to the the Web Client.

Setting Up to Scan Directly from the Web Client

Users can scan directly to the Inbox by doing one of the following:

Scanning with a certified scanner connected to a client workstation

(22)

You can set up a connection between the Web Client and a Kofax Document Scan Server that is in turn connected to a certified scanner. With this connection set up in the Web Client, you can scan a document directly from the Web Client.

Note Effective January 2010, Kofax Document Scan Server is a retired product and is no longer supported. You can continue to use Kofax Document Scan Server with Kofax Front Office Server 3.0, but no further development will occur and any reported defects will not be fixed.

For each logged on user, only one of these options can be used at a time. When you have successfully connected to either a certified scanner or Kofax Document Scan Server, buttons for scanning documents are enabled in the Web Client.

For a list of certified scanners, go to the Kofax Web site (www.kofax.com). Setting Up to Scan with a Certified Scanner

To successfully scan with a certified scanner connected to a client workstation, the following criteria must be met:

Internet Explorer 6.0 or 7.0 on the Client Workstation

Make sure Internet Explorer 6.0 or 7.0 is available on the client workstation and is used to log on to the Web Client.

Microsoft .NET Framework 2.0 on the Client Workstation

If the client workstation is using Windows XP, make sure Microsoft .NET Framework 2.0 is installed.

If the client workstation is using Windows Vista, Microsoft .NET Framework 2.0 is not required.

Note If you have a later version of Microsoft .NET Framework, use the instructions presented later in this section as described for Microsoft .NET Framework 2.0.

Scanner Setup on the Client Workstation

Connect a certified scanner to the client workstation. Make sure VRS or the manufacturer’s TWAIN driver is installed on the client workstation. For more information, see Setting Up the Scanner.

Security Policy for Your Enterprise (or the Client Workstation)

Make sure the appropriate security policy is set up for your enterprise. For more information, see Setting Up the Appropriate Security Policy for an Enterprise. As an alternative, you can also set up the security policy for an individual client

workstation. For instructions, see Setting Up the Appropriate Security Policy on a Client Workstation. However, it is recommended that you set up the security policy for your enterprise.

KFS WebScan Permission for the Applicable Users or Groups

In the Administration Console, associate the Web Client Permission “KFS WebScan”

(23)

WebScan. For more information about assigning Web Client Permissions, see the the Administration Console Help.

Optionally, modify the KFS WebScan permission and associate the activity “Change

Scanner Settings in WebScan” that permits changing the scanner settings directly in the Web Client when using WebScan.

Scanner Settings in the Web Client

Prior to scanning with the scanner connected to your client workstation, access Kofax Front Office Server Web Client, click “Set Inbox options.” On the Scanner Settings tab, specify one of the following:

Kofax Software VRS - TWAIN

If you are scanning with VRS for the connected scanner

Scanner model

If you are scanning with the manufacturer’s TWAIN driver, and not VRS, for the connected scanner

For more information about scanner settings in the Web Client, see the the Web Client Help.

Scanner Profile (Optional) When Scanning with VRS or the TWAIN Driver

Optionally, define a scanner profile to be used by the selected scanner when scanning. For more information, see Setting Up a Scanner Profile.

Setting Up the Scanner

When setting up the desired scanner, use the following summarized procedures after connecting the scanner to your client workstation.

X To set up the scanner if you will be scanning with VRS

1 Install Kofax VRS on the client workstation. For details, see the user documentation for Kofax VRS.

2 During the installation, select the scanner you will be scanning with.

If the appropriate scanner is not available for selection, select “I will configure my scanner later.”

Complete the VRS installation.

3 If the scanner was available during the installation of VRS, skip to Step 4.

If the scanner was not available during the installation of VRS, install the scanner driver provided by VRS from another source (such as the Scanner Configuration Utility installed with VRS or the Kofax Web site). If a driver is not available by VRS, install the TWAIN driver supplied by the manufacturer. (For details, see the manufacturer’s user

documentation.).

4 To complete the setup, configure the scanner in Windows. X To set up the scanner if you will not be scanning with VRS

(24)

Setting Up the Appropriate Security Policy for an Enterprise

To ensure all users within your enterprise can successfully scan with a connected scanner, the following items need to be completed:

Kofax Front Office Server As a Trusted Site

Define a group policy in Active Directory to specify the Kofax Front Office Server URL as a trusted site.

Code Access Security Policy

Create a security policy deployment package and distribute the package across your enterprise. For more information, see Creating and Distributing a Security Policy Deployment Package.

Creating and Distributing a Security Policy Deployment Package

Use the following summarized instructions to create and distribute the security policy

deployment package (as a Microsoft Installer or MSI) to the client workstations in your domain. For more information, see the .NET Framework Enterprise Security Policy Administration and Deployment document on the Microsoft Developer’s Network (MSDN).

The distributed package installs the .NET machine-level, run-time security policy for KofaxDesktopScan.

X To create the security policy deployment package (or MSI) 1 Create a template for your enterprise-wide .NET security policy.

To do so, on a server or client workstation that is installed with .NET Framework 2.0, in a command prompt window, enter the following command:

C:\Windows\Microsoft.NET\Framework\v2.0.50727\caspol -machine -addgroup

All_Code -zone Trusted FullTrust -name “KofaxDesktopScan”

Where: C:\Windows\Microsoft.NET\Framework\v2.0.50727 is the path where Microsoft .NET Framework 2.0 is installed.

When prompted, confirm that you want to perform the operation. 2 Create and store the MSI.

To do so, run the Microsoft .NET Framework Configuration tool, which is available in the Microsoft .NET Framework 2.0 SDK.

(25)

Figure 8. Microsoft .NET Framework 2.0 Configuration Tool X To distribute the MSI, assign the MSI to a group policy.

(26)

Setting Up the Appropriate Security Policy on a Client Workstation

Although it is recommended that you set up the security policy for your enterprise, you can set up the security policy for individual client workstations. To do so, you need to set up Kofax Front Office Server as a trusted site and a code access security policy on each applicable client workstation.

X To set up Kofax Front Office Server as a trusted site, in Internet Explorer, specify the Kofax Front Office Server URL as a trusted site in Internet Options.

For example, on the Tools menu, select Internet Options. Then, on the Security tab, select “Trusted sites” and click Sites. In the “Trusted sites” window, enter the URL for Kofax Front Office Server and click Add.

For example, enter http://kfs.company.com

Where: kfs.company.com is the host name registered with DNS or IP address for Kofax Front Office Server.

Note If security is enabled with an SSL certificate, you must specify the trusted site with the host name.

Figure 10. Setting Kofax Front Office Server As a Trusted Site X To set up the code access security policy (with caspol.exe)

1 On your client workstation, open a Command Prompt window.

For example, on the Windows desktop, go to Start | All Programs | Accessories | Command Prompt.

2 Enter the following command:

C:\Windows\Microsoft.NET\Framework\v2.0.50727\caspol -machine -addgroup

All_Code -zone Trusted FullTrust -name “KofaxDesktopScan”

(27)

When prompted, confirm that you want to perform the operation.

Note As an alternative to using caspol.exe (Code Access Security Policy Tool), you can use the Microsoft .NET Framework Configuration tool, if installed on the client

workstation.

X To ensure that the security policy setup takes effect, it is recommended that you close and then open Internet Explorer before using WebScan for the first time.

Setting Up a Scanner Profile

When you scan from the Web Client using WebScan, scanning is performed with the following:

Scan settings (such as resolution or color mode) resident on the scanner, either pre-defined

by the manufacturer or user-defined on the scanner as an override to the manufacturer’s setting

If you are using VRS, image quality (or advanced) settings available in a default profile

installed with VRS

If you prefer to specify scanner settings for WebScan, you can optionally set up a scanner profile based on whether you are scanning with VRS or the manufacturer’s TWAIN driver (not VRS):

When scanning with VRS

Set up a scanner profile, including advanced image quality settings, using a utility called Twacker. This utility is available with the installation of VRS. For more information, see To set up a scanner profile when scanning with VRS.

When scanning with the manufacturer’s TWAIN driver (not VRS)

Create a scanner profile XML file, based on the scanner profile schema and a sample scanner profile XML installed with Kofax Front Office Server. With a valid scanner profile XML file saved in the appropriate location on the server, the defined scanner settings are used automatically when scanning from Kofax Front Office Server Web Client. For more information, see To set up a scanner profile when scanning with a TWAIN driver (not VRS).

A scanner profile XML file needs to be created for each applicable scanner model with which you want to use a scanner profile.

X To set up a scanner profile when scanning with VRS

1 Make sure VRS is not currently in use on your client workstation. This includes logging off the Web Client if Kofax Software VRS - TWAIN is the selected scanner setting for WebScan.

2 On the client workstation, locate and open the Twack_32.exe file. The file is typically located in the \Windows\Twain_32\Kofax folder. 3 In Twacker, select File | Select Source.

(28)

Figure 11. Scanner Settings in Twacker

7 If you want to specify image quality settings with VRS, click Advanced. In the VirtualReScan Interactive Viewer, specify your image quality settings. Then, save the settings as a new profile. Click OK to return to Twacker.

Figure 12. Interactive Viewer

The image quality settings that are used when you scan are those saved for the named profile that appears in the drop-down list in the Viewer. For details about specifying image quality settings and profiles in VRS, see the VRS user documentation.

8 Click OK to save your scanner settings and exit Twacker.

X To set up a scanner profile when scanning with a TWAIN driver (not VRS)

(29)

To view the name: On a client workstation that the scanner is connected to, in the Web Client, go to Inbox Options | Scanner Settings tab. The name appears in the list box for the selected scanner.

For naming the XML file, use only the following characters that appear in the displayed scanner name: letters and numbers, period (.), and hyphen (-). For any other character, such as a space, replace the character with an underscore character (_).

For example, to create a scanner profile XML file for the scanner name that appears as Canon DR-2010C TWAIN, name the file Canon_DR-2010C_TWAIN.xml.

2 In the \KFS\Config\ScannerProfiles folder, locate and copy the sample_profile.xml file. Then, rename the copied file with the name determined in Step 1.

Important The sample_profile.xml file must remain in the \KFS\Config\ScannerProfiles folder for WebScan to read scanner-specific files.

The scanner profile schema, WebScanProfiles.xsd, is located in the

\KFS\Config\schemas\ScannerProfiles folder. Refer to the schema to review the valid elements, attributes, and settings for the scanner profile XML file.

3 With an appropriate editor, open the scanner profile XML file and edit the settings. Then, save the file.

Important Changes made to a scanner profile while a user is logged on to the Web Client are not available until the user logs out and logs on again.

The following is an example of a scanner profile XML file.

<?xml version="1.0" encoding="utf-8" ?> <Profile xmlns="http://www.kofax.com/support/BatchCapture/KofaxDesktopScan" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <CurrentSettings> <ColorMode Value="Grayscale" /> <PageSize Value="LETTER" /> <ScanDPI Value="200" /> </CurrentSettings> </Profile>

Note Although you can use a scanner profile XML file when scanning with VRS, it is recommended that you use Twacker to set up the scanner profile.

Setting Up to Use a Kofax Document Scan Server

To successfully scan with a Kofax Document Scan Server, you need to establish the connection with the Web Client.

Tip You can change some scan settings in the \KFS\Config\vrs-dss.properties file. See Changing

(30)

2 Create scan profiles for the Kofax Document Scan Servers. All of the Web Client users can select the scan profile they want to use.

3 In the \KFS\Config folder, locate the DSSConfiguration.properties file and open it in a text editor.

4 Edit the following properties:

username password

5 Save the file.

6 Stop and restart Kofax Front Office Server. Restarting encrypts the password.

7 Prior to scanning, set up the connection to the Kofax Document Scan Server in the Web Client. You need to enter the IP address or host name of the device. For instructions, see the the Web Client Help.

Changing the Default VRS Settings for Document Scan Server

When you scan with Kofax Document Scan Server, certain VRS settings are used and they take precedence over the settings in the Kofax Document Scan Server scan profile. For example, if you select a scan profile that is set up to scan in color, and the properties file is set for black/white, the scanned images will be in black/white.

The settings are stored as properties in the vrs-dss.properties file in the \KFS\Config folder, and you can change the property values. Acceptable values for each property are documented in the comments for each property directly in the file.

X To change the VRS property settings

1 In the \KFS\Config folder, locate the vrs-dss.properties configuration file and open it in a text editor.

2 Modify the values of the properties you want to change.

For example, the ColorMode property controls the color format of the image:

# Specifies the color format of the output image. # 1=color, 2=grayscale, 3=black/white

ColorMode=3

So, if you want to change to color scanning and your scanner supports color, change the value to 1.

3 Save the file.

4 You don’t have to restart Kofax Front Office Server or have users log off of the Web Client: when you save the file the changes are applied to the next scan.

Configuring Retries

This section contains instructions on how to configure retries related to failover.

Configuring Retries for Failed Scan Jobs

(31)

scan job files from the \Errors subfolder to the \Unprocessed folder. Kofax Front Office Server then starts processing the scan job.

You can change the properties for retry frequency and the maximum number of retries. X To change the frequency and number of retries

1 In the \KFS\Config folder, locate the shared_resources.properties configuration file and open it with a text editor.

2 Locate the following properties and change the values as follows. Both properties are optional.

scanjob.server.retry.frequency Specify the time to wait between retries for a scan

job, in seconds. If this property is unspecified, the default 30 will be used.

scanjob.server.retry.limit Specify the number of retries for a scan job. If this

property is unspecified, the default 3 will be used. 3 Save the file.

4 Stop and restart Kofax Front Office Server.

Configuring Database Retries

The database retry applies when a database operation (for example insert, query, update, etc.) fails. Based on the retry settings, the failed operation will be retried.

You can change the properties for the maximum number of retries and for retry frequency, and you can also change those values specifically for the Web Client transactions (you may want to make the values smaller so you limit any possible wait time for the Web Client users.

X To change the number and frequency of retries

1 In the \KFS\Config folder, locate the shared_resources.properties configuration file and open it in a text editor.

2 Locate the following properties and change the values as follows.

db.failover.retry.count Specify the time to wait between retries, in seconds. If

this property is unspecified, the default 10 will be used.

db.failover.retry.interval Specify the number of retries. If this property is

unspecified, the default 1 will be used.

kde.db.failover.retry.count Specify the time to wait between retries, in seconds.

If this property is unspecified, the default 10 will be used.

kde.db.failover.retry.interval Specify the number of retries. If this property is

unspecified, the default 1 will be used. 3 Save the file.

(32)

X To change the timeout and interval between retries

1 In the \KFS\Config folder, locate the shared_resources.properties file and open it in a text editor.

2 Locate the following properties and change the values as follows. All properties are optional.

filesys.retry.timeout.millis Specify a timeout period before stopping retries if a

file cannot be delivered to the storage destination, in milliseconds. If this property is unspecified, the default 30000 will be used.

filesys.retry.wait.millis Specify the time to wait between retries if a file cannot

be delivered to the storage destination, in milliseconds. If this property is unspecified, the default of 500 will be used.

3 Save the file.

Changing the Default VRS Settings

All documents scanned at an MFP are processed by Kofax VirtualReScan (VRS) based on numerous VRS settings. Which settings are used depends on where the document is sent:

Documents sent to Inbox, Send to Me, or Coversheets all use the settings in the

vrs-default.properties file. Instructions for changing the settings follows.

Documents sent to Global or Personal shortcuts use the settings specified for the shortcut

(on the Scan Time Image Processing tab, shown in Figure 13), and then use the other settings in vrs-default.properties.

Note Documents imported into the Web Client do not undergo VRS processing, and WebScan and DSS scan documents use their own VRS settings.

Figure 13. Shortcuts - Scan Time Image Processing Tab VRS Image Settings X To change the VRS default property settings

(33)

2 Modify the values of the properties you want to change. Acceptable values for each property are documented in the comments for each property directly in the file. For example, the ColorMode property controls the color format of the image:

# Specifies the color format of the output image. # 1=color, 2=grayscale, 3=black/white (Bitonal) ColorMode=3

So, if you want to change to color scanning and your scanner supports color, change the value to 1.

3 Save the file. You don’t have to restart Kofax Front Office Server or have users log off of the Web Client When you save the file the changes are applied to the next scan.

Changing SQL Server Database Authentication

If your SQL Server database authentication username or password is changed after installation, you need to change the database authentication credentials in both Kofax Capture and Kofax Front Office Server.

X To change the database authentication

1 In the database management console, make the changes to the database credentials. 2 For Kofax Capture, do the following:

a On the Kofax Capture server, on the Windows Taskbar, select Start | Run, and type “DBUtil” in the text field. Click OK. The Database Utility will start.

b If you are prompted for credentials for a Kofax Capture user, enter credentials of a user with administration utilities rights and click OK.

c Connection to the database cannot be made, so the Kofax Capture - Password screen appears, where you enter the new database access credentials.

d Click OK. A message that the credentials have been changed briefly appears. 3 For Kofax Front Office Server, do the following:

a Stop Kofax Front Office Server on the local host and, if you have a cluster installation, all other hosts in the cluster.

b On the local Kofax Front Office Server host or any host machine in a cluster, run <installation path>\Kofax\Front Office Server\OtherResources\Utilities\kfsutil.bat. c If you are prompted for credentials for a Kofax Capture user, enter credentials of a

user with administration utilities rights and click OK.

d Connection to the database cannot be made, so the Kofax Front Office Server Utilities - Database Authentication screen appears, where you enter the new database access credentials.

e Click OK. A message that the credentials have been changed briefly appears. f Restart Kofax Front Office Server on the local host and, if you have a cluster

installation, all other hosts in the cluster

(34)

The following information generated by document activity in Kofax Front Office Server is updated to the following information in Kofax Capture.

In addition, the following is true:

The {Scan Operator's User ID} resolves to: MFP user name if authenticated on the device [Anonymous] if not authenticated on the device Coversheets: the user that created the coversheet {Scan Operator's Station ID} resolves to:

MFP host name if the host name is non-empty

MFP IP address if the host name is empty (or unattainable)

Client IP address if originating from the Web Client (file upload, web scan)

If you are upgrading to Kofax Front Office Server from a previous version, and there are existing documents in the Web Client, information for these documents is not updated to Kofax Capture when the documents are exported following the upgrade.

Note For tracking user information in Kofax Capture, be sure that User Tracking is enabled in Kofax Capture. For more information, see the Kofax Capture documentation.

Table 5. Kofax Front Office Server Information Updates to Kofax Capture

Kofax Front-Office Server Kofax Capture

Document Activity Information User Tracking Kofax Capture Values Batch History

MFP host name

(if documents are submitted from an MFP)

Source type

(if documents are submitted from a source other than an MFP, such as KFSWC (Kofax Front Office Server Web Client) or WebScan)

For Batch:

Creation station ID

{Batch Creator’s Station ID} {Scan Operator’s Station ID}

Station ID

User ID

(entered for Kofax Front Office Server)

For Batch: Creation user ID Creation user name For Module Launch: User ID

User name

{Scan Operator’s User ID} (not applicable)

Number of pages scanned For Batch Module: Pages scanned

(not applicable) (not applicable) Date and time the pages were scanned For Batch Module and

Module Launch: Start date and time

{Batch Creation Date} {Batch Creation Time}

(35)

Batch Names

Batches are created from documents that are exported from the Web Client and MFPs. By default, batches are named in the following formats:

For documents exported from the Web Client:

[User name]-[Web Client host name (or IP address if host name is unavailable)]-[MM/DD/YYYY HH:MM:SS.ms (UTC offset)]

For documents exported from an MFP:

If user is logged on or a coversheet is used:

[User name]-[MFP host name]-[MM/DD/YYYY HH:MM:SS.ms (UTC offset)] If there is no user logged on:

-[MFP host name]-[MM/DD/YYYY HH:MM:SS.ms (UTC offset)]

If you use a coversheet, User name indicates the user who created the coversheet.

The time stamp is based on the local time zone of the server where Kofax Front Office Server is installed. The time is followed by the local time UTC offset, such as (-5:00). The time is shown to the nearest millisecond.

For example, if a document is sent from host name “myserver” by user “jill” at 2:45 p.m. on August 18, 2009, the batch is named as follows:

[jill]-[myserver]-[08/18/2009 2:45:00.234 PM (-8:00)]

If a user name is not provided (such as if you use a global shortcut at an MFP without logging on), it is omitted from the batch name as shown:

-[MFP hostname]-[08/18/2009 2:45:00.234 PM (-8:00)]

Documents submitted from an MFP to the Web Client, then from the Web Client to a final destination are treated as MFP documents, and will have the MFP hostname.

Custom Batch Names

You can also define your own batch names by setting property values in the kc.properties file in the \KFS\Config folder:

batchname.kofaxcapture.usedefault

If the property value is set to true, batches are named using the Kofax Capture batch name format (defaults to false). If this property is enabled, the document tracking entries for backenddocumentid are blank, so for reporting statistics, use Kofax Capture User Tracking.

batchname.indexfield

In Kofax Capture, create an index field where users can enter the name for the generated batch. Assign the index field to the batch class, and use the index field name as the value for this property. Note that this property is ignored if batchname.kofaxcapture.usedefault is set to true.

(36)

Tracking Document Activity

Information about the following document activity is stored in the Kofax Front Office Server database in the table doctracking_scanjob:

Documents scanned with an MFP Scanned documents sent from an MFP Documents sent from the Web Client

Note Departmental installations that use the embedded standard database do not have access to the database. To view database information, you need to move to a database that an administrator can edit. See Using the Kofax Front Office Server Utilities on page 47 for instructions.

This information can be used for chain of custody tracking or to determine which records are no longer needed and can be deleted. The database records information related to creating and releasing documents. This information includes the following:

Device name Form type Destination User

Creation and release times

The following entity diagram shows the view into the Kofax Front Office Server database, with the columns and primary key (PK). Bold text indicates columns for required data.

Figure 14. Entity Diagram: Kofax Front Office Server Database View

Managing Document Tracking Data

(37)

For configurations using the Standard database (SQL Server Express), there is no direct way to access the database, so the Kofax Front Office Server Utilities provides two Document Tracking menu options:

Export

This option exports all the data to a file as CSV (comma separated values). As a product of the export, four files will be placed in a folder you select during the export process:

doctracking_event.csv doctracking_eventsource.csv doctracking_eventtype.csv doctracking_scanjob.csv Delete

This option deletes all the data without exporting any records.

Note These options can also be used for exporting or deleting document tracking data from other databases, but they are the only way to do so for SQL Express.

See Using the Kofax Front Office Server Utilities on page 47 for instructions on running the utilities.

Customizing a Connector, Data Validation, and Field Lookup

Resources for developing and implementing a custom Web services connector, data validation, and field lookup are provided for Kofax Front Office Server. To view instructions for using these resources, go to \OtherResources\DeveloperResources\devindex.html in the program files or in the location of the installed software.

Figure 15. Developer Resources as Viewed in devindex.html

Customizing Data Validation and Field Lookup

For the Web Client and MFPs, any data entered for index fields is validated for an appropriate data type and data length.

(38)

can additionally define whether users will have to select a value from the list or whether they can also type a value which is not in the list.

Form validation: All the field values of a form and their interdependencies can be

validated.

Customizing with a Kofax Capture Validation Script

You can create or edit a Visual Basic .NET validation script in Kofax Capture to validate data provided for index fields in Kofax Front Office Server Web Client or an HP MFP. The data is validated for index fields for documents in a particular Kofax Capture document class. Validation occurs when the user exits the index fields.

The validation script implemented in Kofax Capture is used for both Kofax Capture and Kofax Front Office Server. The validation script determines in which context it was called (Kofax Capture or Kofax Front Office Server), and in which context for Kofax Front Office Server it was called (the Web Client or an HP MFP).

This method of customizing data validation can be used instead of, and not in conjunction with, creating a validation class for Kofax Front Office Server (as described in Customizing with a Validation Class for Kofax Front Office Server (Deprecated)).

Note This feature requires Kofax Capture 9, or Kofax Capture 8 with Service Pack 5.

X To create a new or edit an existing VB.NET validation script, go to the Kofax Capture Administration module. Then, on the Scripts menu, select Document Validation. (For additional information, see the Kofax Capture user documentation.)

Figure 16. Kofax Capture Document Validation Script Window When preparing the validation script, note the following:

For the scripting language, be sure VB.NET is selected.

The VB.NET project for the validation script contains the following:

A class that inherits from Kofax.AscentCapture.Scripting.DocumentValidationScript Members for each field in the document class, tagged with an attribute indicating the

field name it represents

Create or edit the validation script using a sample validation script, and the API reference

and Readme.

(39)

Figure 17. Data Validation and Lookup Customization for Developer Resources

To implement Kofax Front Office Server-specific functionality, add a reference to

Kofax.KFSLib.KFSValidation.dll, the assembly that contains classes necessary to handle Kofax Front Office Server behavior. The file is located in the \Bin\KFS folder, where Kofax Capture is installed.

This reference must maintain the Copy Local property, to ensure that other validation stations can perform properly if the appropriate version of Kofax Capture is not installed.

Add the attribute KFSIndexFieldAttribute to each field, specifying the following

parameters:

Validate (true or false) ReadOnly (true or false)

Optionally, use a static property in the ValidationContext class that indicates if the script is

called through Kofax Front Office Server or Kofax Capture validation.

Be aware that only FieldPostProcessing is called from within Kofax Front Office Server.

FieldPreProcessing is ignored.

Optionally, implement a single event handler from one of the following: DocumentPreProcessing: Called each time a new document is opened DocumentPostProcessing: Called when a document is closed

When FatalErrorException or RejectAndSkipDocumentException is encountered in your

validation script, the exception is handled the same as ValidationErrorException.

Unique to Kofax Front Office Server, a utility method is provided that allows you to

(40)

Validation will not perform as desired if a batch field and document index field have

the same name.

Customizing with a Validation Class for Kofax Front Office Server (Deprecated)

You can create a validation class, using a Java-based API, to validate data provided for index fields in the Web Client or an HP MFP.

This method of customizing data validation can be used instead of, and not in conjunction with, creating a validation script in Kofax Capture (as described in Customizing with a Kofax Capture Validation Script).

Note This feature is deprecated for Kofax Front Office Server 3.0. X To create a validation class

1 Create a validation class using the Data Validation SDK, located in the \OtherResources\DeveloperResources\DataValidation folder. The corresponding methods are:

For field validation, implement validateField. To define which fields to validate,

implement getFieldsToValidate.

For form validation, implement validateForm.

Tip If you want to use only one of these validation methods, modify the one you do not need so that the validation method will always return null.

For more information about how to develop and deploy your data validation class, refer to the readme and Javadoc that is part of the SDK.

2 To enable validation for the Web Client, open the \KFS\Config\KFSportal.properties file, in a text editor. Then, for the validation.class element, specify the fully-qualified name of the validation class.

For example, if the name of the validation class is FormValidation and the package is com.company, the file will contain the following:

validation.class=com.company.FormValidation

3 To enable validation for an HP MFP, open the \KFS\Config\mfp.validation.properties file, in a text editor. Then, for the validation.class element, specify the fully-qualified name of the validation class.

For example, if the name of the validation class is FormValidation and the package is com.company, the file will contain the following:

validation.class=com.company.FormValidation

4 Save and close the file. For the changes to take effect, stop and restart Kofax Front Office Server.

Note For later changes to take effect, it is sufficient to save and close the file.

When preparing a validation class, note the following, particularly if you want to continue using a validation class that was prepared for a previous version of Kofax Front Office Server:

The backend ID is identified as “KofaxCapture” and the form type is the actual name of the

Front Office Server 3.0

Administrator’s Guide

Kofax

Preface

About the Configuration Folder Location in this Guide

Related Documentation

Training

Technical Assistance for your Kofax Product

Overview

Integration with Kofax Capture

Volume Licensing

Starting the Kofax Front Office Server Applications

Stopping and Restarting Kofax Front Office Server

Changing Host Names

Security Options

LDAP Signing Requirement

Enabling Security with SSL

About Single Sign On

Examples of Possible Configurations

Managing Free Drive Space

Blocking Requests when Drive Space is Limited

Backing Up and Restoring

Departmental Configurations

Enterprise Configurations

Setting Options for the Web Client

Defining the Page Size for the Web Client List of Documents

Setting Up to Scan Directly from the Web Client

Configuring Retries

Configuring Retries for Failed Scan Jobs

Configuring Database Retries

Changing the Default VRS Settings

Changing SQL Server Database Authentication

Batch Names

Tracking Document Activity

Managing Document Tracking Data

Customizing a Connector, Data Validation, and Field Lookup

Customizing Data Validation and Field Lookup