Front-Office Server 2.7

KOFAX Front-Office Server 2.7 Administrator s Guide 10300835-000

2007-2009 Kofax, Inc., 15211Laguna Canyon Road, Irvine, California 92618, U.S.A. All rights reserved. Use is subject to license terms. Third-party software is copyrighted and licensed from Kofax s suppliers. 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 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.

Contents How to Use This Guide...7 Introduction...7 Additional Documentation and Resources...7 Kofax Front-Office Server Installation Guide...7 Multifunction Peripheral (MFP) Administrator Guides...8 Kofax Front-Office Server Configuration Guide for Kofax Capture...8 Help for Kofax Front-Office Server Applications...8 Release Notes...8 Training...8 Technical Support...8 Overview...9 Stopping and Restarting Kofax Front-Office Server...9 About File and Folder Locations in this Guide...9 When Enabling Security with SSL...9 Identifying the URLs for Kofax Front-Office Server Applications...10 Using the Administration Console...11 Starting the Administration Console...11 Registration and Licensing...12 Connecting to Directory Services...12 Connecting to Active Directory...13 Connecting to LDAP...13 To Disconnect from Directory Service...13 Identifying Internal and Linked Users...14 Internal Users...14 Linked Users...14 Linked Users from Non-Default Domains...14 Viewing Logs...15 Purging the Log Entries...15 Backing Up and Restoring...15 Departmental Configurations...15 Enterprise Configurations...17 Configuring Kofax Front-Office Server Destination Types...18 Configuring Folders for the Network Location Destination...18 Sending Documents through the Web Client...18 Using Shared Folders with MFP Global Shortcuts...18 Kofax, Inc. 3

Contents Changing the Location of the Master Configuration File...19 Changing the Locations for Scanned Images and Inboxes...19 Configuring a Watched Folder...21 Sharing a Watched Folder...21 Specifying the Watched Folder Path...21 Example of Setting Up a Watched Folder...22 Managing Free Drive Space...23 Blocking Requests when Drive Space is Limited...23 Changing the Host Name...24 Defining the Page Size for the Web Client List of Documents...24 Setting Up to Scan Directly from the Web Client...24 Setting Up to Scan with a Certified Scanner...25 Setting Up the Scanner...26 Setting Up the Appropriate Security Policy for an Enterprise...27 Setting Up the Appropriate Security Policy on a Client Workstation...29 Setting Up a Scanner Profile...30 Setting Up to Use a Kofax Document Scan Server...32 Changing the Default VRS Settings for Document Scan Server...33 Configuring Retries for Failed Scan Jobs...33 Configuring Database Retries...34 Configuring Retries to Storage Destinations...34 Changing the Database Credentials and Encrypting the Password...35 Tracking Document Activity...36 Retrieving Information from the Embedded Database: Examples...36 Accessing the Embedded Database...36 Retrieving All Scan Jobs...37 Purging the Database...37 Enterprise Installations...37 Departmental Installations...37 Customization...38 Using Custom Validation and Enhanced Field Lookup...38 Kofax Fax Connector...39 Fax Destination...39 Lookup List for Send Email, Fax, and Kofax Capture Destinations...39 Database Table Lookup...40 Active Directory or LDAP Lookup...41 Contacts List Lookup...41 Setting Up Queuing in Kofax Front-Office Server Web Client...42 Using the DesQueueDefinition.xml File...42 Elements and Attributes of the DesQueueDefinition.xml...43 QueueSet Element (Required)...43 CustomFields Element (Required)...44 4 Kofax, Inc.

Contents CustomField Element (Required)...44 Queues Element (Required)...45 Queue Element (Required)...45 Filters Element (Required)...45 Filter Element (Optional)...46 Roles Element (Required)...47 Role Element (Required)...47 Process of Setting Up a Queue...47 Planning Your Queue Setup...48 Making Sure Roles Exist in the Administration Console...49 Defining Queues in the DesQueueDefinition.xml File...50 Viewing Kofax Queue, Queue Sets, and Queues...51 Setting Up Queue Shortcuts in the Administration Console...52 Setting Up Queues: Example 2...53 Planning Queue Setup: Example 2...53 Making Sure Roles Exist in the Administration Console: Example 2...54 Defining Queues in the DesQueueDefinition.xml File: Example 2...55 Viewing Kofax Queue, Queue Sets, and Queues: Example 2...56 Setting Up Queue Shortcuts in the Administration Console: Example 2...57 Setting Up Queues: Example 3...57 Considerations When Setting Up or Modifying Queues...59 About the Queue Schema File...59 Troubleshooting...60 Firefox...60 Remembered Password Used in the Administration Console...60 Missing Cursor...60 Destinations...60 Problems Sending Documents to Destinations...60 Coversheets...60 Problems with Coversheets...60 Kofax Capture...61 Limitations in Value Lists In Kofax Capture...61 Problems Transferring Large Image Files to Kofax Capture...61 Index...63 Kofax, Inc. 5

Contents 6 Kofax, Inc.

How to Use This Guide Introduction 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 destination types (such as Kofax Capture) that you will use with Kofax Front-Office Server. Additional Documentation and Resources In addition to this guide, Kofax Front-Office Server includes the following documentation. Except for the Help and release notes, you can select to view any of the documentation by opening guides.html on the installation media root or \Documentation\KFSguides.html after installation. Figure 1. Guides Page Kofax Front-Office Server Installation Guide Refer to the installation guide for instructions on planning and installing Kofax Front-Office Server. The guide is located in the root of the installation media, and is installed with the software in the \Documentation folder. Kofax, Inc. 7

Multifunction Peripheral (MFP) Administrator Guides These guides show how to make Kofax Front-Office Server features available on MFP front panels. The MFP administrator guides are in the \setup\guides folder on the installation media. They are also installed with the software in the \Documentation\Guides folder. Kofax Front-Office Server Configuration Guide for Kofax Capture This guide shows how to connect Kofax Front-Office Server with Kofax Capture. This guide is in the \setup\guides folder on the Kofax Front-Office Server installation media. It is also installed with the software in the \Documentation\Guides folder. For instructions on using Kofax Capture, refer to the Kofax Capture guides and Help. Help for Kofax Front-Office Server Applications Kofax Front-Office Server Web Client (referred to as the Web Client) and Kofax Front-Office Server Administration Console (referred to as the Administration Console) have Help that describes how to use the application. Each Help system has a table of contents, index, and full-text search to assist you in finding information. To view the Help from the application, click the Help button. The Help appears in a separate browser window. You can also view the Help when you are at the server by selecting Start Programs Kofax Documentation and then the Help system. Release Notes Late-breaking product information is available from the release notes. Read the release notes carefully, because they contain information that may not be included in other Kofax Front-Office Server documentation. Documentation for Deprecated Features Documentation for deprecated features is provided for your reference. It is recommended that you use the new features, as indicated in the release notes. Deprecated features are retained in the product for backward compatibility. These features may be removed in a future release. For information about deprecated features and the new features to use instead, refer to the release notes. 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. 8 Kofax, Inc.

The Kofax Web site also contains information that describes support options for Kofax products. Please review the site for details about the available support options. If you need to contact Kofax Technical Support, please have the following information available: Kofax Front-Office Server software version and build number Operating system and service pack version MFP or scanner make and model Kofax Front-Office 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 availability and scalability. Stopping and Restarting Kofax Front-Office Server You may need to stop and restart Kofax Front-Office Server when changing the files in the \conf folder or for routine maintenance. The process depends on which installation and configuration you use, and the instructions are in the installation guide. About File and Folder Locations in this Guide Some files and folders are installed in different locations. For example, many configuration settings can be edited in the various files located in the \conf folder. By default, these files are located in C:\Program Files\Kofax\Front-Office Server\Avalin\jboss\server\avalin\conf. In the rest of this guide, references will be to use just the folder names (such as \conf or \log) without the additional path details. When Enabling Security with SSL By using a self- or CA-signed SSL certificate for your active directory environment, you enable security when transmitting data to and from Kofax Front-Office Server. The use of an SSL certificate encrypts, and thereby protects, the transmission of sensitive data, such as passwords. 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. Kofax, Inc. 9

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 \conf folder. 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. 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 to them 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/kfsadmin If security is enabled with an SSL certificate: https://server:8443/kfsadmin For Kofax Front-Office Server Web Client, type the URL as follows: Where: If security is not enabled with an SSL certificate: http://server/kfswebclient If security is enabled with an SSL certificate and you are not using WebScan: https://server:8443/kfswebclient If security is enabled with an SSL certificate and you are using WebScan: https://servername:8443/kfswebclient 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 name of: The computer with a departmental installation of Kofax Front-Office Server An NLB cluster or IIS server in an Enterprise installation 8443 is the port used by Kofax Front-Office Server for transmitting secure data. 10 Kofax, Inc.

Note the following: In the URL, KFSAdmin and KFSWebClient may be typed in all uppercase or all lowercase, as in these examples: http://server/kfsadmin http://server/kfsadmin You can omit the Web Client portion of the URL to start Kofax Front-Office Server Web Client, as in this example: http://server You can also run Kofax Front-Office Server applications from the server where Kofax Front-Office Server is running. Open a Web browser and enter the full URL as shown above, but use localhost as the server host name. You can also select a command to start an application by selecting Start Programs, Kofax Front-Office Server and then the application. Note Before running any of the applications, complete the installation and make sure that Kofax Front-Office Server has started. When you start an application, its Log On page appears. Enter the user name and password. Passwords are case-sensitive. Using the Administration Console Use the Administration Console to add internal users and to link to directory services users, to link to directory services groups, to create and assign roles, to install licenses, to add MFPs, to create global shortcuts, to deploy profiles of shortcuts to MFPs, and to perform other server administration tasks. This section shows you how to start the Administration Console and perform initial setup and registration. For full instructions on using the Administration Console refer to its online Help. Starting the Administration Console You can start the Administration Console from the server or from any computer that can connect to the server where Kofax Front-Office Server is installed. 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. To start the Administration Console 1 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 on page 10. If you are at the server, select Start Programs Kofax Kofax Front-Office Server Administration Console. The the Administration Console Log On page appears (Figure 2). Kofax, Inc. 11

Figure 2. The Administration Console Log On Page Tip Bookmark the the Administration Console Log ON page to make it convenient to start it each time. 2 Type the user name and password of the administrator you defined during installation. Passwords are case-sensitive. After you have logged on successfully, the Administration Console appears (Figure 3). Figure 3. The Administration Console Expand the nodes in the menu on the left to add users and perform other Kofax Front- Office Server management tasks. Registration and Licensing Kofax Front-Office Server is installed with an evaluation license. For production use, delete the evaluation license and install the license file that you received from Kofax. Refer to the Administration Console Help for instructions. Connecting to Directory Services This section contains information about connecting to Active Directory or LDAP directory services. If you don t want to connect to a directory service, see To Disconnect from Directory Service. If you disconnect, all users must be added in the Administration Console as internal users maintained in the embedded database, and the Groups security option will be unavailable. Once you are connected to your directory service, you can use the Administration Console to manage users, groups, and roles. See the Administration Console Help for instructions. 12 Kofax, Inc.

Warning Before deleting a linked user from directory services, make sure that user s Kofax Front- Office Server Web Client Inbox is empty. Connecting to Active Directory By default, Kofax Front-Office Server will connect to Active Directory in the domain, and will use the account used to run the KofaxServer service. Departmental installation can use the Local System account, which is the predefined local account used by the service control manager, and which has unrestricted access to Active Directory Domain Services. Enterprise installations require a domain user, which is specified during installation. The following conditions apply when using an Active Directory connection: The computer running Kofax Front-Office Server must be on the Windows domain where the Active Directory server is running. The KofaxServer service must be run using either a domain user (Enterprise or Departmental installations) or the Local System account (Departmental installations). For a directory services user to log on to the Administration Console or the Web Client, the samaccount name, not the common name, must be used. There is no way to configure authentication using common name. Connecting to LDAP To connect to your LDAP server, you must configure the \conf\avalin_security.properties file and restart Kofax Front-Office Server. To configure an LDAP server connection 1 In the \conf folder, locate the avalin_security.properties file and open it in a text editor. a Comment out the property: #type=activedirectory b Uncomment the property: type=ldap 2 Edit the url property to change localhost to the LDAP computer. 3 Following the commented information in the file, change any other properties to reflect your configuration, including whether you want users to log on using the common name (the default) or uncomment useattrasusername=samaccountname. 4 Save the file. 5 Stop and restart Kofax Front-Office Server. Restarting encrypts the password and obfuscates the password in the properties file. To Disconnect from Directory Service To disconnect from directory services, you must configure the \conf\avalin_security.properties file and restart Kofax Front-Office Server. To disconnect from directory services 1 In the \conf folder, locate the avalin_security.properties file and open it in a text editor. a Comment out the property: Kofax, Inc. 13

b #type=activedirectory or #type=ldap Uncomment the property: type=none 2 Save the file. 3 Stop and restart Kofax Front-Office Server. Identifying Internal and Linked Users In the Administration Console, you can add internal users whose data is stored in the embedded database, and you can also link users from a directory service. For example, for Active Directory, a user can come from the default, child, or trusted domains. For LDAP connections, the list of external users is based on how you configured the conf\avalin_security.properties file. All users are identified and authenticated based on the following: In the Administration Console and the Web Client and MFP log on: domain (optional), user name, password At the MFP for Send to KFS Inbox: domain (optional) and user name Internal Users Internal users are not associated with a domain, so any user name that does not include the domain will be checked against internal users first. Linked Users Linked users from the default domain can omit the domain when logging on to the Administration Console, the Web Client, or when sending to KFS Inbox from an MFP. For example, user DefaultDomain\mjames can log on simply as mjames. Special Case: When User Name and Password are the Same If a linked user on the default domain is also an internal user with the same password, and the domain is not included in the log on, the internal user will always be used. To be recognized as the linked user, the log on would have to include the domain, such as DefaultDomain/mjames. Note For LDAP connections, the domain name external is used, so the log on would be external\mjames Linked Users from Non-Default Domains For linked users on the non-default domains (child or trusted), the domain must always be included as part of the user name. 14 Kofax, Inc.

Viewing Logs To view the logs, you can do either of the following: Use the Administration Console to view the server and console logs. You can filter the display of messages and delete them. Open the log files in a text editor. The files are located in the \log folder in \Avalin\jboss\server\avalin. To filter the messages that get included in the log files located the \log folder, locate the \conf\log4j.xml file. Edit the log4j.xml file in a text editor. For information about working with a log4j file (version 1.2), see the following Web site: logging.apache.org/log4j. Purging the Log Entries Old log entries should be purged periodically to prevent the Kofax Front-Office Server database from growing too large and affecting performance. By default, log entries are purged after they remain in the log for 10 days. You can specify a threshold for removing entries (such as removing entries older than three days), or you can disable the automatic purge. To purge log entries or disable purging 1 In the \conf folder, locate the log_purge.properties file and open it in a text editor. 2 Edit the property values to your specifications. See the comments in the file for instructions. 3 Save the file. 4 Stop and restart Kofax Front-Office Server for the new values to take effect. Backing Up and Restoring This section provides instructions for backing up and restoring Departmental 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. To backup data 1 Make a record of the following: The password of the postgres user account that Windows uses to start the database service. This is the password you supplied on the Database Configuration screen of the Installer. The user name and password of the database administrator account. This is the user name and password you supplied on the Database Administrator screen of the Installer. The user name and password of the initial administrator account. This is the user name and password you supplied on the Initial Administrator screen of the Installer. Kofax, Inc. 15

2 Create backup copies of the folders \Avalin, \Resources, and \PostgreSQL at the root of the Kofax Front-Office Server installation. 3 Verify that the backup was successful, and store in a safe location. With the backup data gathered, you can proceed with the restore. 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. As you install, enter the information you entered during the original installation: Password for the database service account User name and password for the database administrator User name and password for the initial administrator 3 In the Services console, stop the following services: PostgresSQL Database Server 8.2 KofaxServer 4 If this is a 32-bit computer with the Kofax Server Monitor running in the system tray, right-click the icon and select Exit. 5 In the folder where you installed Kofax Front-Office Server, delete the following folders: \Avalin \Resources \PostgreSQL 6 Copy the \Avalin, \Resources, and \PostgreSQL folders from the backup data to the folder where you installed Kofax Front-Office Server. 7 Change the permissions for the following folders: Set Security permissions of the \PostgreSQL folder to grant Full Control to the Windows postgres user. Set the Security permissions of the \Avalin and \Resources folders to grant Full Control to the Windows SYSTEM user. 8 Skip this step if your shared folder where the \Inbox and \scanjobs are located was not in one of the folders copied in the backup. Share the folder where the \Inbox and \scanjobs are located, and set the Share name as KFS. Set the Security permissions to grant Full Control to the Windows SYSTEM user. Important If the new installation root folder is not the same path as the previous one, be sure to change the \runonce folder property in the avalin_startup_deployer.properties in the \conf folder before you restart the services in the next step. 9 In the Services console, start the following services: PostgresSQL Database Server 8.2 KofaxServer 16 Kofax, Inc.

10 On 32-bit computers, you can display the Kofax Server Monitor in the system tray by selecting Start Programs Kofax 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. To backup data 1 Make a record of the location of the shared folder. You can find the share path in the SharedFolder.properties file in the \conf folder. 2 Create backup copies of the folders \Avalin and \Resources at the root of the Kofax Front-Office Server installation. 3 Verify that the backup was successful, and store in a safe location. 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. As you install, enter the same path to shared folder. 3 In the Services console, stop the KofaxServer service. 4 If this is a 32-bit computer with the Kofax Server Monitor running in the system tray, right-click the icon and select Exit. 5 In the folder where you installed Kofax Front-Office Server, delete the \Avalin and \Resources folders. 6 Copy the \Avalin and \Resources folders from the backup data to the folder where you installed Kofax Front-Office Server. 7 Skip this step if your shared folder where the \Inbox and \scanjobs are located was not in one of the folders copied in the backup. Share the folder where the \Inbox and \scanjobs are located, and set the Share name to the share folder property in the SharedFolder.properties file in the \conf folder. For example, in the following example the Share name would be KFSshares. share=//myserver04/kfsshares Set the Security permissions on the share to grant write permission to the user account that runs the KofaxServer service. Important If the new installation root folder is not the same path as the previous one, be sure to change the \runonce folder property in the avalin_startup_deployer.properties in the \conf folder before you restart the services in the next step. 8 In the Services console, start the KofaxServer service. Kofax, Inc. 17

9 On 32-bit computers, you can display the Kofax Server Monitor in the system tray by selecting Start Programs Kofax Kofax Server Monitor. Configuring Kofax Front-Office Server Destination Types The following destination types are deployed with Kofax Front-Office Server installation: Kofax Capture Network Location to send documents to a network folder Kofax Queue to send documents to a queue To configure Kofax Front-Office Server for additional destinations, refer to the configuration guides provided for each destination. You will find the configuration guides in the following folders: The \Documentation\Guides folder in the installed location The \setup\guides folder on the installation media You must enable destination types before they can be available to Kofax Front-Office Server users. Use the Administration Console to enable destinations. Refer to Using the Administration Console on page 11 and the Administration Console Help for instructions. To set up queues, refer to Setting Up Queuing in Kofax Front-Office Server Web Client on page 42. Configuring Folders for the Network Location Destination Folders used as Network Location destinations can be on any computer available to Kofax Front- Office Server or shared storage such as Microsoft Cluster Service nodes. The folders must be shared, and users must have Change permissions. Refer to the Windows documentation for information about setting up user accounts and sharing folders. Users can then send documents to these folders through Kofax Front-Office Server Web Client or from or personal shortcuts on the MFP front panel. Additional steps are needed to configure folders to be used for global shortcuts. Note If users receive an Invalid login. Please try again error when releasing a document to a network folder, make sure that you have granted those users Read permissions for that folder. Sending Documents through the Web Client In the Web Client, users must use the Lookup button the first time they use a folder on a computer. They are prompted to log on if they have not established credentials with a computer or if their password has changed. If they type the path in the Destination field without establishing credentials, they will receive a logon failure. For more information about sending documents to a network folder, refer to the Web Client Help. Using Shared Folders with MFP Global Shortcuts If you plan to use a shared folder for a global shortcut on the MFP front panel, you need to associate the credentials of a user with folder access rights to the shortcut. For information about setting up global shortcuts, refer to the the Administration Console Help. 18 Kofax, Inc.

Changing the Location of the Master Configuration File During installation a shared folder is specified or created, and the file MasterConfig.properties is created in the root of the share. This file contains several properties that are used by other Kofax Front-Office Server components (for example, the migration utilities and the IIS component installer), so the components need to be able to find MasterConfig.properties when they are run. How do the components find the file? The SharedFolder.properties file in the \conf folder contains the share property, whose value for share is the location of the share specified or created during installation. Anytime after installation, you can specify a different location for the shared folder to contain the file. Before changing the location, create the share noting the following: Make sure that the user account that runs the KofaxServer service has read/write access to the folder you specify. If you want to limit access, add the service user account as a user for that shared folder. For information about locating and changing the service user account, refer to Example of Setting Up a Watched Folder on page 22. Make sure that the folder is configured for read and write access. Selecting a read-only folder can cause program errors. Note the full UNC path, a full drive letter path from a local drive, or a path that is relative to the \bin folder. Mapped network drives are not certified. If you have clustered storage in a highly available environment, you can use Microsoft Cluster Service to create a file share accessible through a UNC path and specify the clustered storage. Important Do not remove the shared folder or the \scanjobs or \Inboxes folders that may be in the share. A description of those folder s use and instructions on changing their location are in the next section Changing the Location of the Master Configuration File. To change the location of MasterConfig.properties 1 In the \conf folder, locate the SharedFolder.properties file and open it in a text editor. 2 Locate the property share, and enter the value in the appropriate format: UNC path to the folder in //server/share name format. A local drive on a server running Kofax Front-Office Server. Use forward slashes, such as C:/folder. 3 Save the file. 4 Copy the file to the \conf folder on each machine in a cluster. 5 Stop and restart Kofax Front-Office Server on each machine in the cluster. Changing the Locations for Scanned Images and Inboxes During installation a shared folder is specified or created, and the following folders are created in the shared folder: The \scanjobs folder is used to store scanned images. The images are deleted when a workflow process has been successfully started to send the images to the appropriate location. The \Inboxes folder contains a folder for each user s the Web Client inbox. The Inboxes folder is actually created when the first user logs on to the Web Client. In addition, the MasterConfig.properties file is created in the root of the share. Kofax, Inc. 19

Anytime after installation, you can specify a different location for these folders. Before changing the location, do the following: Make sure that the user account that runs the KofaxServer service has read/write access to the folders you specify. If you want to limit access, add the service user account as a user for that shared folder. For information about locating and changing the service user account, refer to Example of Setting Up a Watched Folder on page 22. Make sure that the folder is configured for read and write access. Selecting a read-only folder for scanned images and inboxes can cause data loss. Make sure that there are no documents in any user s Inbox. Changing the folder while there are documents in any Inbox can corrupt data. Specify a full UNC path, a full drive letter path from a local drive, or a path that is relative to the \bin folder. Mapped network drives are not certified. If you have clustered storage in a highly available environment, you can use Microsoft Cluster Service to create file shares accessible through a UNC path and specify the clustered storage. Important Do not remove the shared folder or the MasterConfig.properties file that is in the root. A description of the file s use and instructions on changing the location of the file are in the previous section Changing the Location of the Master Configuration File. To change the locations for storing scanned images and inbox folders 1 In the \conf folder, locate the shared_resources.properties file and open it in a text editor. 2 Locate the following properties: scanjobsdir inboxdir 3 If you want to change the scan jobs storage location, change the value after scanjobsdir to the path you want to use for the folder in the appropriate format: UNC path to the folder in //server/folder name format. A local drive on a server running Kofax Front-Office Server. Use forward slashes, such as C:/folder. For example, if you want to use the share tempscans folder on the KFS1 server for scan job storage, you would change the scanjobsdir property as follows: scanjobsdir=//kfs1/tempscans 4 If you want to change the location of user \Inboxes folders, change the value after inboxdir to the path you want to use. Use a UNC or a mapped local or network drive path as shown for scanjobsdir. For example, if you want user inbox folders to be stored on the KFS1 server in a folder with the share name KofaxShare, you would change the line as follows: inboxdir=//kfs1/kofaxshare Note The \Inboxes folder is automatically appended to the path you specify when the first user logs on to the Web Client. Thus, on the KFS1 server, user Inbox folders are found in \KofaxShare\Inboxes. As another example, if you wanted to use drive Z on the Kofax Front-Office Server, you would change the line as follows: inboxdir=z: 5 Save the file. 20 Kofax, Inc.

6 Copy the file to the \conf folder on each machine in a cluster. 7 Stop and restart Kofax Front-Office Server on each machine in the cluster. Configuring a Watched Folder Note The watched folder feature is deprecated in Kofax Front-Office Server 2.7. In the Web Client, users can select a watched folder for bringing documents into their Inbox. Files that are copied into the folder are automatically imported into the Web Client. Each user can select a folder on a network share or on that user s local computer. Users can select a watched folder in the Web Client, but users will need your help to assign the Input Watcher permission, and to share the folder and set the proper permissions. This section provides guidelines and a sample procedure. Refer to the Windows documentation for more information about performing these procedures. Refer to the the Web Client Help for instructions on selecting a watched folder. Sharing a Watched Folder Do the following to enable the use of watched folders: In the Administration Console, assign users and groups who will use the watched folder to a role that has Input Watcher as an associated KFS Web Client permission. Set up the watched folder as a shared folder so that files can be copied into it from users and services such as fax importers. Grant the user accounts Full Control permissions. You can limit access to only the user accounts that need it. If the watched folder is on a system other than the server, change the user account used to run the KofaxServer service to one that has access to the shared folder. You need to restart Kofax Front- Office Server after changing the user account. If users want to use a folder on their local computer, have them do the following: Make sure that their computer is on the same domain as Kofax Front-Office Server. The watched folder cannot be on a different domain. Share the folder so it is accessible by the user account that runs the KofaxServer service. If they want to limit access, have them add the appropriate user account as a user for that shared folder. Grant at least Read permissions to the appropriate user account. If users want to delete documents automatically after they have been successfully uploaded, also have them grant Modify permissions to the user account. Specifying the Watched Folder Path When users specify the watched folder in the Web Client, they must specify a UNC path or a local path on the server. If users want to use a shared folder on their computer, they need to use a UNC path to their shared folder. Kofax, Inc. 21

Important To prevent two users from watching the same folder, have all your users enter the UNC path using either the host name or the IP address of the machine where the shared folder is located. This allows Kofax Front-Office Server to notify a user when the path being entered is already watched by another user: if a UNC path using host name is entered for one user and another use enters the same path using the IP address, both users will end up watching the same folder. Example of Setting Up a Watched Folder This section provides an example of how to set up a watched folder on a user s local computer. For this example, the user s computer name is accounting1, and the folder that the user wants to share is invoices. The user wants to limit access to only the KofaxServer service user account and to delete documents automatically after they have been successfully uploaded. To set up a watched folder 1 On the server, change the user account for the KofaxServer service from the local system account to a user account that can also access the accounting1 computer. Do the following: a Select Administration Tools Services. Depending on the version and configuration of Windows, the Administration Tools are in Control Panel or Programs. b Locate KofaxServer in the Services console. c Right-click KofaxServer and select Properties. d Click the Log On tab. 2 Under Log on as, select This account. Select the user account and type the password for it. Click OK. 3 Right-click KofaxServer and select Restart. When KofaxServer service restarts, close the Services console. 4 On the user s computer, right-click the invoices folder and select Properties. 5 Select the Sharing tab and complete it as follows: a Select Share this folder. The Share name field displays invoices as the default name. Users can change this field, if desired. b Click Permissions. The Permissions for invoices window appears. c Click Add. The Select Users or Groups window appears. d In the Enter the object names to select field, type the user account for the KofaxServer service and click Check Names. You may need to click Locations and change to the domain of the user account. When you have selected the user account, click OK. The Select Users or Groups window closes, and the user account appears in the Permissions for invoices window under Group or user names. e Select the user account for KofaxServer. The permissions that are currently assigned to the user are selected. f In the Allow column, select the box for Modify. This enables Kofax Front-Office Server Web Client to delete documents after they have been uploaded successfully to the Inbox. g Click OK to close the Permissions for invoices window. 6 Click the Security tab and add the KofaxServer service user as follows: 22 Kofax, Inc.

a b Click Add. The Select Users or Groups window appears. Add the KofaxServer service user account as shown in step 3d. The KofaxServer user account appears under Group or user names. c Select the user account for KofaxServer. The permissions that are currently assigned to the user are selected. d In the Allow column, select the box for Write and make sure that the Read permission is also selected in the Allow column. e Click OK to close the properties window for the folder. 7 Set up the watched folder in Kofax Front-Office Server Web Client as follows: a Have the user log on to Kofax Front-Office Server Web Client. b Make sure that the Inbox is displayed. If it is not, click Inbox in the Sent & Received panel. c Click Options in the toolbar. The Inbox Options window appears. d Click the Watched Folder tab. e Type \\accounting1\invoices as the path of the folder. Note Always use the UNC path to specify the path to the watched folder instead of specifying a mapped drive. If you attempt to specify a mapped network drive as the path of a watched folder, the following error may occur: The folder path does not exist. Where path is the drive and folder you specified. f g Select an option for deleting documents after they have been successfully uploaded to the Inbox. Click OK. 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. Kofax Front-Office Server automatically blocks requests and suspends folder watching when free drive space reaches a minimum amount. This amount is adjustable. Blocking Requests when Drive Space is Limited When drive space reaches a minimum threshold, 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. Kofax, Inc. 23

Changing the Host Name 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 with licensing and connecting to MFPs. You can restore licensing 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 for the same device. Defining the Page Size for the Web Client List of Documents When you are viewing a list of documents in the Inbox or a queue, 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 or queue 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. To define the page size of the list of documents 1 In the \conf folder, locate the desportal.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 You can scan directly to your Inbox by doing one of the following: Scanning with a certified scanner connected to a client workstation You can connect a certified scanner to a client workstation installed with VRS 4.2 or the manufacturer s TWAIN driver. Then, using a feature (referred to as WebScan) included in Kofax Front-Office Server Web Client with the installation of Kofax Front-Office Server, you can set up an option that enables you to scan a document directly from the Web Client. To ensure the best image quality, it is recommended that you use WebScan with VRS 4.2. Scanning with a Kofax Document Scan Server 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. 24 Kofax, Inc.

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, see the Kofax Front-Office Server Release Notes or 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. The setup for and scanning with a connected scanner is not supported with Mozilla Firefox, which will not be supported in the versions of Kofax Front-Office Server past 2.7. 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 4.2 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. WebScan Role for the Applicable User Assign the role WebScan to each applicable user, including the administrator, in the Administration Console. This assignment is required to enable a user and the administrator to use WebScan. (The administrator role does not automatically enable use of WebScan for the administrator.) For more information about defining and assigning roles, see the the Administration Console Help. Optionally, modify the WebScan role to assign permission to change the scanner settings when using WebScan. Kofax, Inc. 25

Scanner Settings in the Web Client Prior to scanning with the scanner connected to your client workstation, access Kofax Front-Office Server Web Client, and in Inbox Options on the Scanner Settings tab, specify one of the following: Kofax Software VRS - TWAIN If you are scanning with VRS 4.2 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 4.2 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. To set up the scanner if you will be scanning with VRS 4.2 1 Install VRS on the client workstation. For details, see the user documentation for 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. To set up the scanner if you will not be scanning with VRS 1 Install the manufacturer s TWAIN driver supplied by the manufacturer. For details, see the manufacturer s user documentation. 2 To complete the setup, configure the scanner in Windows. Typically, at this point, the scanner is set up for successful operation. However, see the user documentation for your scanner for any additional setup required or recommended. 26 Kofax, Inc.

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. 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. Under Tasks, select Code Access Security Policy Create Deployment Package. In the Deployment Package Wizard, under Select the security policy level to deploy, select Machine. Then, browse to a domain-accessible, shared folder in which to store the MSI. Complete the wizard instructions. Kofax, Inc. 27

Figure 4. Microsoft.NET Framework 2.0 Configuration Tool To distribute the MSI, assign the MSI to a group policy. To do so, on the domain controller, for the appropriate group policy, open the Group Policy Object Editor. Select Computer Configuration Software Settings. Right-click Software Installation. Select New Package. Then, browse to the MSI you created previously. Deploy the software. Figure 5. Group Policy Object Editor To have the group security policy take effect, restart any applicable servers and client workstations. 28 Kofax, Inc.

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. 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 6. Setting Kofax Front-Office Server As a Trusted Site 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. Kofax, Inc. 29

2 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. 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. 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. 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. 4 In the Sources list, select Kofax Software VRS - TWAIN, and click Select. 30 Kofax, Inc.

5 Select File Setup. 6 Specify your scanner settings. The settings you specify are used each time you scan with WebScan. It is not necessary to save the settings as a profile. Figure 7. Scanner Settings in Twacker Note 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. 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. 7 Click OK to save your scanner settings and exit Twacker. Kofax, Inc. 31

To set up a scanner profile when scanning with a TWAIN driver (not VRS) 1 Determine the appropriate name to use when you save the scanner profile XML file. The file name must match the scanner name as it appears in the Web Client. 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 \conf\scannerprofiles folder, locate and copy the sample_profile.xml file. Then, rename the copied file with the name determined in Step 1. Note The scanner profile schema, WebScanProfiles.xsd, is located in the <installation folder>\kofax\front-office Server\Avalin\jboss\server\avalin\conf\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 \conf\vrs-dss.properties file. See Changing the Default VRS Settings for Document Scan Server for instructions. 32 Kofax, Inc.

To set up to use to a Kofax Document Scan Server 1 Connect the Kofax Document Scan Server to a network that is available to Kofax Front- Office Server. Then, connect a certified scanner to the Kofax Document Scan Server. Refer to the Kofax Document Scan Server documentation for instructions. 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 \conf 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 Restart Kofax Front-Office Server. Restarting encrypts the password and obfuscates the password in the properties file. 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 \conf folder, and you can change the property values. To change the VRS property settings 1 In the \conf 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 the 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 for Failed Scan Jobs A scan job may fail, for example, if a workflow cannot start or is not available. If the workflow process creation fails a series of retries begins: if using default settings, the retries will continue every 30 seconds for a maximum of 3 tries. If a scan job fails on all retries, it is moved to an Errors subfolder in the scanjobs directory. To retry failed scan jobs, move the directory for the scan job Kofax, Inc. 33

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. To change the frequency and number of retries 1 In the \conf 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 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. To change the number and frequency of retries 1 In the \conf 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. 4 Restart the Kofax Front-Office Server. Configuring Retries to Storage Destinations If a destination location (inbox, watched folder) is not available to receive a document or file, by default a series of retries begins and continues every 500 milliseconds for 30000 milliseconds. You can change the properties for retry timeout and interval between retries. 34 Kofax, Inc.

To change the number and frequency of retries 1 In the \conf 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. 4 Restart Kofax Front-Office Server. Changing the Database Credentials and Encrypting the Password If your database username or password is changed, you need to update that information in Kofax Front-Office Server. This section provides instructions for changing the database user name and encrypting the embedded database password. To change the database credentials 1 Create the encrypted password: a On a machine where Kofax Front-Office Server is installed, open a Command Prompt window and browse to the \Avalin\jboss folder where Kofax Front-Office Server is installed (by default, C:\Program Files\Kofax\Front-Office Server\Avalin\jboss). b Execute the following command, where [password] is the password you want to encrypt (do not include the brackets): C:\Program Files\Kofax\Front-Office Server\jre\bin\java -cp lib/ jboss-common.jar;server/avalin/lib/jbosssx.jar;server/avalin/lib/ jboss-jca.jar org.jboss.resource.security.secureidentityloginmodule [password] The command will return an encoded password as in this example: Encoded password: -1d5bcec446b79907df8592078de921bc c Use the Command Prompt menu commands Mark and Copy to copy the encrypted password to the clipboard. You can then paste it into the correct location in the next step. 2 Configure the login-config.xml file: a In the \conf folder, locate the login-config.xml file and open it with a text editor. b Replace the password in the <module-option name= EncryptedLocalPassword > with the encrypted value. In the following example, it is -1e5978ed73fc8964d82d3c5c876adfd8. <application-policy name="encryptedlocalpassword"> <authentication> <login-module code="org.jboss.resource.security.secureidentityloginmodule" flag="required"> <module-option name="username">admin</module-option> <module-option name="password">-1e5978ed73fc8964d82d3c5c876adfd8</module-option> <module-option name="managedconnectionfactoryname">jboss.jca:name=kofaxdesds,service=localtxcm</module-option> </login-module> </authentication> </application-policy> Kofax, Inc. 35

3 Save and close the file. For the changes to take effect, stop and restart Kofax Front-Office Server. 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 to a destination Documents sent from the Web Client to a destination This information can be used for chain of custody tracking or to determine which records are no longer needed and can be purged. 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 8. Entity Diagram: Kofax Front-Office Server Database View Retrieving Information from the Embedded Database: Examples This section provides information about accessing the embedded database, and an example of a SQL statement for retrieving information from the database. Accessing the Embedded Database For a new installation, you access the embedded database by using the user name and password you specified for the database administrator during installation. 36 Kofax, Inc.

Retrieving All Scan Jobs The following statement retrieves all scan jobs. The returned information includes the scan job ID, user name, and device. Destination information is also included if provided. select * from view_doctracking_20 Purging the Database Old document tracking records should be purged periodically to prevent the Kofax Front-Office Server database from growing too large and affecting performance. Enterprise Installations For Enterprise installations using Oracle or SQL Server databases, you can use an administration tool to purge the desired records. You can, for example, purge records with older creation dates or those with backenddocumentid entries which indicate the documents were successfully released to the destination. You can delete records directly from the doctracking_scanjob table. Departmental Installations To purge the Departmental installation embedded database, you can use the KFS_db_cleanup.bat file. You can specify a threshold for removing records (such as removing records older than three days). The batch file is in the \OtherResources\DBCleanup folder where Kofax Front-Office Server is installed, and it needs to be run from that folder. You can edit the file to change its settings. Note Allow sufficient time for the batch file to run. If you specified a large number of records, the batch file could take time to complete. To prepare the batch file 1 Edit the batch file with a text editor, changing the lines indicated in Table 1: Table 1. Lines to Change in DES_db_cleanup.bat Line DAYS_OLD_THRESHOLD KFS_HOME echo *:*:*:username: password Changes Indicate the number of days that you want to keep records. Records older than the specified number of days are deleted. If you set the purge.entries.days value to 0 (zero) or leave the value blank, the default value of 30 days is used. Change to the full Kofax Front-Office Server installation path if it is different from the default. Change username and password to the user name and password for the embedded database administrator user account. You may need to change this data if you upgraded from an earlier version of Kofax Front-Office Server that uses a different user name and password for the database administrator. 2 Save and close the batch file. You can now run the batch file to whenever you want to purge the database. Kofax, Inc. 37

Customization Resources for developing and implementing custom release connectors, data validation, and field lookup are provided on the Kofax Front-Office Server installation media. To view instructions for using these resources, browse to \OtherResources\DeveloperResources and open devindex.html. Figure 9. Developer Resources as Viewed in devindex.html Using Custom Validation and Enhanced Field Lookup In the Web Client, any text entered for index fields is validated with the destination for an appropriate data type and data length. For a more detailed validation and a variety of field lookup options, you can configure Kofax Front-Office Server to perform the following additional steps in the order they are listed: Field validation and selection: Each field value is validated as soon as it has been changed. You can determine which fields to validate, and whether other fields will be filled in automatically or provide a selection list after successful validation. For selection lists, you 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. To implement custom validation 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. 38 Kofax, Inc.

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 In the \conf folder, locate the desportal.properties file and open it in a text editor. 3 In 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. Kofax Fax Connector Note The Kofax Fax Connector is deprecated in Kofax Front-Office Server 2.7. The Kofax Fax Connector connects Kofax Front-Office Server with Biscom, RightFax, or TOPCALL fax servers, so that incoming faxes can be sent directly to a Kofax Front-Office Server Web Client user s Inbox. The Kofax Fax Connector Installation Guide PDF provides installation and configuration instructions, and it is installed in the \OtherResources\FaxConnector folder where Kofax Front-Office Server is installed (by default, C:\Program Files\Kofax\Front-Office Server). Fax Destination You can set up a Fax destination. Follow the instructions in the Kofax Front-Office Server Configuration Guide for Fax. The guide is installed in the \Documentation\Guides folder where Kofax Front-Office Server is installed (by default, C:\Program Files\Kofax\Front-Office Server). Lookup List for Send Email, Fax, and Kofax Capture Destinations Note The Send Email and Fax destinations are deprecated in Kofax Front-Office Server 2.7. They are replaced by the Kofax Capture Export Connector - Fax and Kofax Capture Export Connector - Email. This section explains how the Address Book Lookup List search functions for the MS Exchange 2003 Send Email, FAX Fax, and Kofax Capture destinations. However, for Kofax Capture there are some configuration tasks that are described in the Kofax Front-Office Server Configuration Guide for Kofax Capture. Note The same search functionality is available on HP MFPs. When a user is going to send a document to the Send Email, Fax, or Kofax Capture (if Kofax Capture has been configured) destinations in the Web Client, the user can click the Lookup List button next to fax or email address fields. The Lookup List Address Book window appears, where the user can search for and select field entries. When the user types a search string and clicks Go in Kofax, Inc. 39

the window, the search is performed against the following sources, and the items found are combined before returning the search results. An explanation of each of the sources follows. In the Web Client, Lookup fields retrieve email addresses and fax numbers from these sources as follows: A table in the Kofax Front-Office Server database: users with data for the particular search (email address or fax number) will be returned from the search. This search is automatically enabled: no configuration is needed. The users in the connected directory service: users with data for the particular search (email address or fax number) will be returned from the search. This search is automatically enabled: no configuration is needed. Of course, for configurations not using a directory service nothing will be returned for this source. The Microsoft Outlook Contacts list of the logged on user. Contacts matching the search criteria and that have data that match the search type (email address or fax number) will be returned in the results list. To enable the Contacts search, follow the instructions in To enable Microsoft Outlook Contacts search below. Figure 10. Lookup List Window for Send Email Destination Database Table Lookup You can either manually edit the customemailfaxlookup table or use a tool to import email addresses and fax numbers. Figure 11 shows the table columns. 40 Kofax, Inc.

Figure 11. Database table: customemailfaxlookup Active Directory or LDAP Lookup Based on the search entry, the directory service search returns user and group information, which includes email addresses and fax numbers. Of course, for configurations not using directory services nothing will be returned for this source. If you use Active Directory, there are no configuration steps: connection and lookup capability is automatic. If you use LDAP, you must specify the name of the attributes that contain email address and fax number in \conf\avalin_security.properties. These are the email and fax attributes in the avalin_security.properties file: ############################################################### # Attributes for fax and email ############################################################### userfaxattribute= useremailattribute= groupfaxattribute= groupemailattribute= Contacts List Lookup If Contacts search is enabled, users can search their Microsoft Exchange Contacts list if the user is logged on to the Web Client using their directory service account. When the user sends a document to the Send Email destination, a log on is attempted using the current credentials used to log on to the Web Client. If those credentials fail authentication, a log on screen appears where the user can log on to the Microsoft Exchange account. Note The Contacts search is automatically enabled for the Microsoft Exchange destination, as explained in the Kofax Front-Office Server Configuration Guide for Microsoft Exchange. Contacts matching the search criteria and that have data that match the search type (email address or fax number) will be returned in the results list. Important For the Contacts list lookup to work, Outlook must be configured with the Microsoft Exchange Server account type, and Use Cached Exchange Mode must be enabled. Any newly added Contacts will become available the next time the user s Outlook client synchronizes with the Exchange Server. For example, user Max James logs on to the Web Client using his samaccount name mjames, and clicks the MS Exchange 2003 destination type. If his company s Microsoft Exchange log on also uses the samaccount name, he will not be prompted for an additional log on. However, if his company uses the first.last convention for user name, then Max will be prompted to enter his password and user name max.james to log on to the destination. A Lookup List search would Kofax, Inc. 41

include his Contacts. If user mjames were to log on to the Web Client using another user s credentials, the destination would become available but a Lookup List search would not include Max s Contacts list. To enable Microsoft Outlook Contacts search 1 Copy the file rs.connector.exchange2k3.properties from the \Resources\setup folder to the \Avalin\jboss\server\avalin\conf folder where Kofax Front-Office Server is installed. 2 Open rs.connector.exchange2k3.properties in a text editor. Modify the following properties, and then save and close the file: conf.exchange.domain conf.exchange.server 3 Stop and restart Kofax Front-Office Server. Setting Up Queuing in Kofax Front-Office Server Web Client Queuing enables you to send documents to a predefined queue in the Web Client, instead of an individual s Inbox. The received documents can then be viewed by any user with access to that queue. The process of working with the received documents in a queue is essentially the same as for documents received in the Inbox. Documents are routed to a queue when sent with the appropriate queue information, typically based on shortcuts (for example, for your MFP) set up in the Administration Console. A queue enables you to receive and view documents based on the following criteria: The nature of the document (its type, purpose, or other company-defined criteria) (such as new account setup documents, or documents associated with a project) Specific areas of your company (or other company-defined criteria) (such as particular departments or branches) For example, with the appropriate queue setup, you may route documents related to opening new customer accounts, for particular company branches. With additional queue setup, you may route other documents related to HR (Human Resources) activities, for particular HR work teams. Note For information about routing incoming faxes to a queue, see the Kofax Fax Connector Installation Guide. Using the DesQueueDefinition.xml File One of the primary activities in setting up a queue involves editing the sample queue definition provided in the DesQueueDefinition.xml file (the format of which is defined by the queue schema file). When you set up a queue, you identify the following: One or more sets of queues (or queue sets) (with each queue set providing an association for documents to a particular document type or purpose, or other company-defined criteria) One or more queues, within each queue set (that provide one or more views of the documents for that queue set, such as for particular departments or branches) 42 Kofax, Inc.

Within the file, edit the sample queue definition as needed to create one or more queue sets and one or more queues. To set up a single queue, the contents of the file would contain the following elements (where bold indicates attribute variables you specify): <?xml version="1.0" encoding="utf-8"?> <q:desqueuedefinition xsi:schemalocation="http://www.kofax.com/desqueuedefinition_1_00 schemas/queue/desqueuedefinition.xsd" xmlns:q="http://www.kofax.com/desqueuedefinition_1_00" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <q:queueset name="qsetname"> <q:customfields> <q:customfield datatype="string" name="customfieldname" id="1"/> </q:customfields> <q:queues> <q:queue name="qname"> <q:filters> <q:filter customfieldname="customfieldname" operator="equals" value="data"/> </q:filters> <q:roles> <q:role name="user"/> </q:roles> </q:queue> </q:queues> </q:queueset> </q:desqueuedefinition> Elements and Attributes of the DesQueueDefinition.xml When editing the sample queue definition in the file to set up queues, you need to appropriately configure the following elements. QueueSet Element (Required) You need at least one queue set within which to set up one or more queues. A queue set contains the following attributes. Table 2. QueueSet Attributes Attribute Type Description Required? name NameType 1-255 characters Specifies the name of the queue set. Specify the attribute as follows: name="qsetname" Where qsetname is the name you assign to this queue set. Caution: Do not use the name Inbox or any variation thereof based on capitalization. Yes filestoragedirectory String Specifies where the received document files are to be stored on a network drive. Specify the attribute as follows: filestoragedirectory="//server/sharedfolder" Where server and sharedfolder are the names of your specific server and shared folder. Only ASCII characters are valid when specifying the attribute. If this attribute is not specified, the document files are stored as specified in shared_resources.properties for the inboxdir property, in the QueueSets folder. No Kofax, Inc. 43

CustomFields Element (Required) Under the CustomFields element, define up to five CustomField elements. A custom field enables you to define the data element by which you will subsequently filter documents to appear in a queue, thereby associating certain documents with a queue within the queue set. Where the queue set is comparable to the type of document to be associated with the queue set, the custom fields are comparable to index fields, which provides the basis for associating a document with a particular queue. Although you can define up to five custom fields for a queue set, having more than one custom field makes it possible for a user to send a document to more than one queue. This situation occurs when the user provides information for more than one custom field when scanning or moving a document to a queue. By using only one custom field for any queue set, you eliminate the possibility of sending or moving a document to more than one queue. CustomField Element (Required) This element contains the following attributes enabling you to define a custom field for the queue set. Table 3. CustomField Attributes Attribute Type Description Required? datatype String Specifies the type of data required for defining this attribute. Specify the attribute as follows: datatype="string" Currently, the only valid setting is "string". Yes name NameType 1-255 characters Specifies the name of the custom field. Specify the attribute as follows: name="customfieldname" Where customfieldname is the name you assign. This name is used when providing or prompting for queue information in the the Web Client and the Administration Console. Caution: The name does not use the following, if entered as part of the name in the XML file: Spaces at the beginning of the name Spaces at the end of the name More than one consecutive space within the name (only one space is used) Yes id unsignedinteger 1 character Specifies the unique ID of the custom field (for internal database purposes). Specify the attribute as follows: id="1" Where 1 is a valid numerical ID setting. Valid settings are: "1", "2", "3", "4", "5". Caution: The ID must be unique for each custom field defined for a queue set. Yes 44 Kofax, Inc.

Queues Element (Required) Under the Queues element, define the elements for one or more queues within the queue set. Queue Element (Required) This element contains the following attributes enabling you to set up a queue within the queue set. Table 4. Queue Attributes Attribute Type Description Required? name NameType 1-255 characters Specifies the name of the queue within the queue set. Specify the attribute as follows: name="qname Yes Where qname is the name you assign to this queue. Caution: Do not use the name Inbox or any variation thereof based on capitalization. The name does not use the following, if entered as part of the name in the XML file: Spaces at the beginning of the name Spaces at the end of the name More than one consecutive space within the name (only one space will display) defaultmode String Determines in what mode the queue displays documents when the queue is selected in the the Web Client. Specify the attribute as follows: defaultmode="qmode" Where qmode is the display mode for the queue. Valid settings are: "Get Next" which displays the fields for sending the next available document. This is the recommended and default setting if this attribute is not specified. "Browse" which displays a list of documents. Caution: Using the setting "Browse" may produce undesirable results during operation, based on the following: Allows a user (User B) to attempt to send a document that is already being worked on by another user (User A), thereby resulting in a locked message for User B Uses more system memory Requires more system resources because database and server overhead will be higher No Filters Element (Required) Under the Filters element, define one Filter element for filtering which documents are to appear for the queue. You can define only one filter. Kofax, Inc. 45

Filter Element (Optional) This element contains the following attributes to define a filter. If this element is not included in the definition of a queue, then all documents appear in the queue. Table 5. Filter Attributes Attribute Type Description Required? customfieldname NameType 1-255 characters Must be one of the named custom fields specified for the QueueSet element. Specify the attribute as follows: Yes customfieldname="customfieldname" Where customfieldname is the name defined for a custom field for the queue set. Caution: The name does not use the following, if entered as part of the name in the XML file: Spaces at the beginning of the name Spaces at the end of the name More than one consecutive space within the name (only one space is used) operator String Specifies the operation to occur between the filter value (defined for this element) and the value entered for routing a document to this queue in Kofax Front-Office Server Administration Console and Kofax Front-Office Server Web Client. Specify the attribute as follows: operator="equals" Where Equals is one of the following valid settings: "Equals", "Not Equals", "Like", "Greater Than", "Less Than". If you use the operator "Like", the following wildcard characters may be used: % and _. Yes value ValueType 1-255 characters Specifies the specific data, when processed with the operator for this element, that associates a document with this queue. Specify this attribute as follows: Yes value="data" Where data is the value for associating the document with this queue. You use this data value when setting up a shortcut in the Administration Console for sending a document to a queue, and when moving a document to a queue in the Web Client. Note: Any spaces used when entering the value in the XML file are preserved. The data value is case sensitive. 46 Kofax, Inc.

Roles Element (Required) Under the Roles element, define one or more Role elements for determining which users, based on roles defined in Kofax Front-Office Server Administration Console, have access to this queue. Role Element (Required) This element contains the following attributes to assign a role to a queue. Table 6. Role Attributes Attribute Type Description Required? name String. 1-128 characters Specifies the name of the role that provides the associated users access to this queue. Specify this attribute as follows: name="user" Where user is a valid name for a role as defined in the Administration Console. Warning: If you specify an invalid role (for example, you misspell the role name), the queue is not available to users for the intended role, and no error message will appear for the queue. Therefore, use care in specifying a valid role. Yes Process of Setting Up a Queue The overall process of setting up queues consists of the following stages, each described further in the sections that follow: Plan your queue setup. Take some time to identify the information you need for setting up queues. Make sure the appropriate user roles are set up in the Administration Console. To facilitate the defining of queues, make sure that roles are set up that allow the appropriate access to the queues you are defining. Define the queues in the DesQueueDefinition.xml file. Edit the sample queue definition in the DesQueueDefinition.xml file for your specific needs, based on your queue setup plan. View Kofax Queue, queue sets, and queues in the Administration Console and the Web Client. Once a queue is defined in the DesQueueDefinition.xml file, Kofax Queue, queue sets, and queues can be viewed in the Administration Console and the Web Client. You need to enable Kofax Queue in the Administration Console. Set up queue shortcuts in the Administration Console. Queue shortcuts are used to send or move documents to a queue in the Web Client. With the appropriate default custom field data set up for the shortcut, you ensure that a document is sent or moved to a valid queue. Kofax, Inc. 47

Planning Your Queue Setup Use the following table to assist you in planning the setup of the desired queues. This particular plan also provides an example to help illustrate the process. Table 7. Queue Setup Plan Planning Item Identify the nature of the documents for a queue set. What is the particular type of document, or type of project that the documents support, for which you want to create a queue set, containing one or more queues? Name the Queue Set What name is the most meaningful for this queue set, based on the nature of the documents? Identify where to store the document files for the queue set. In which server and shared folder do you want the document files, associated with this queue set, to be stored? Example You receive applications in the Web Client that are needed for setting up new accounts. You want these documents to appear in queues that allow multiple users (account representatives) to view and process the documents. You want to use Account Setup as a descriptive name for this queue set. You want to use the default storage area. No alternate storage location is desired. Identify the custom fields (data elements) for filtering documents for the specific queues in the queue set. What custom fields do you want to use for determining which documents are associated with and viewed in the different queues in the queue set? The application documents are to be sent to and viewed in different queues based on the branch office for which the application is intended. There are two branch offices for which you receive documents: the Los Angeles Branch and the San Diego Branch. Name the queues in the queue set. What queue names are the most meaningful for your users when selecting a queue to view and process documents? To make the queue names more recognizable in the Web Client for your account representatives, you want the following queue names: Account Setup-LA Branch Account Setup-SD Branch Account Setup-All Branches The third queue name represents an all documents queue, to be accessible by the system administrator. You are defining this queue as recommended to enable the administrator to view all documents that may be sent to the queue set with invalid queue data. Identify the default display mode for documents in each queue. How do you want to have documents appear in a queue: the next available document with the automatic display of fields for sending the document to a destination ( Get Next mode), or as a list of documents ( Browse mode)? You want to use the default mode, which displays the next available document with fields for sending it to a destination. However, you want the Account Setup-All Branches queue to display a list of documents. Because this all documents queue is used by the administrator to troubleshoot for misrouted documents, a list of documents is more appropriate. 48 Kofax, Inc.

Table 7. Queue Setup Plan (continued) Planning Item Identify the actual data for filtering documents to each queue, based on the custom fields identified earlier. What is the specific data for the custom fields to be used for filtering the documents for the different queues in the set? Example Based on the custom fields planned for the queue set, you want to use the following data to designate which queue a document is to be sent: LA Branch for the queue named Account Setup-LA Branch SD Branch for the queue named Account Setup-SD Branch The queue named Account Setup-All Branches will contain no filtering data. Identify who should have access to each queue, based on the role associated with applicable users. Which personnel should have access to the different queues? Only the appropriate personnel for each branch office should have access to the documents received in the queue for that branch. Therefore, you make sure that the Administration Console contains the following defined roles that include only the applicable personnel for the respective branch offices: AcctRepsLABranch AcctRepsSDBranch The role, when specified for a queue, will limit user access to a queue. the Web Client also includes the default Administrator role. This role is to be specified for the Account Setup-All Branches queue. Additionally, it is recommended that each queue include the Administrator role. Identify the shortcuts to set up for the queues. What shortcuts do you need for the different queues in the queue set? To avoid having your users enter custom field data for a queue, you set up a shortcut for each queue with default data. You want the following named queue shortcuts and the following default custom field data: Acct Setup-LA with default data LA Branch Acct Setup-SD with default data SD Branch Making Sure Roles Exist in the Administration Console In the Administration Console, make sure the appropriate user roles are set up, per your queue setup plan. Also, make sure any new role you set up contains the same associations (Activities, Components, Modules, and Workflows) as the role DES user installed with Kofax Front-Office Server. For instructions on setting up roles, see the the Administration Console Help. The following figure is an example of roles, based on the example provided in Planning Your Queue Setup on page 48. Kofax, Inc. 49

Figure 12. Roles in the Administration Console: Example Defining Queues in the DesQueueDefinition.xml File Use the following procedure to define queues in the DesQueueDefinition.xml file. The procedure includes references to the example provided in Planning Your Queue Setup on page 48. To define queues in the DesQueueDefinition.xml file 1 In the \conf folder, locate and open the DesQueueDefinition.xml file (using an appropriate XML or text editor). 2 Using the information you identified in the queue setup plan, edit the sample queue definition. Based on the example presented in Planning Your Queue Setup on page 48, note the following: Because the example plan indicates the default storage location for document files, the filestoragedirectory attribute is not specified with the QueueSet element. Because the example plan indicates to have all documents appear in the queue named Account Setup-All Documents, the Filter element is not specified. 3 Save the file. Based on the example, the contents of the file would contain the following (specified attributes are noted in bold): <?xml version="1.0" encoding="utf-8"?> <q:desqueuedefinition xsi:schemalocation="http://www.kofax.com/desqueuedefinition_1_00 schemas/queue/desqueuedefinition.xsd" xmlns:q="http://www.kofax.com/desqueuedefinition_1_00" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <q:queueset name="account Setup"> <q:customfields> <q:customfield datatype="string" name="branch" id="1"/> </q:customfields> <q:queues> <q:queue name="account Setup-LA Branch"> 50 Kofax, Inc.

<q:filters> <q:filter customfieldname="branch" operator="equals" value="la Branch"/> </q:filters> <q:roles> <q:role name="acctrepslabranch"/> <q:role name="administrator"/> </q:roles> </q:queue> <q:queue name="account Setup-SD Branch"> <q:filters> <q:filter customfieldname="branch" operator="equals" value="sd Branch"/> </q:filters> <q:roles> <q:role name="acctrepssdbranch"/> <q:role name="administrator"/> </q:roles> </q:queue> <q:queue name="account Setup-All Branches" defaultmode="browse"> <q:filters/> <q:roles> <q:role name="administrator"/> </q:roles> </q:queue> </q:queues> </q:queueset> </q:desqueuedefinition> Viewing Kofax Queue, Queue Sets, and Queues Once you complete the queue definition in the DesQueueDefinition.xml file, the following is available for viewing: Kofax Queue in the Administration Console Kofax Queue appears listed under Destination Types in the Administration Console. Be sure to enable Kofax Queue, which then enables you to prepare shortcuts for the queues. For instructions on enabling a destination, see the the Administration Console Help. Figure 13. Kofax Queue in the Administration Console: Example Queue Sets in Kofax Front-Office Server Administration Console Any queue sets you set up in the DesQueueDefinition.xml file appear listed under Kofax Queue. The Index Field Name column identifies the custom fields you defined for the queue set. Kofax, Inc. 51

Figure 14. Queue Sets in the Administration Console: Example Kofax Queue, Queue Sets, and Queues in the Web Client. Kofax Queue and any queue sets defined in the DesQueueDefinition.xml file appear under Destinations. The defined queues appear in the Inbox and Queue Selection drop-down list. Figure 15. Kofax Queue, Queue Sets, and Queues in the Web Client: Example Setting Up Queue Shortcuts in the Administration Console To ensure your users send or move documents to a valid queue, set up shortcuts for the queues in the the Administration Console. The shortcut enables you to provide default custom field data for the queue. When the shortcut is used by your users, the document is routed to the appropriate queue. 52 Kofax, Inc.

Set up global queue shortcuts which you then deploy to your MFPs. The shortcuts are then used at the MFP to scan documents to the queue. Associate your queue shortcuts with user groups, to have these shortcuts appear in the Web Client, for moving documents to a queue within the Web Client. For instructions on setting up and managing shortcuts, see the the Administration Console Help. The following figure is an example of queue shortcuts, based on the example provided in Planning Your Queue Setup on page 48. Figure 16. Queue Shortcuts in the Administration Console: Example Setting Up Queues: Example 2 The following sections provide another example of setting up queues, involving a little more complexity. Planning Queue Setup: Example 2 The following table illustrates an example of planning a queue set with multiple custom fields and an alternate storage location for document files. Table 8. Planning Queue Setup: Example 2 Planning Item Identify the nature of the documents for a queue set. Name the Queue Set Identify where to store the document files for the queue set. Example HR (Human Resources) documents for employee benefit enrollment (401K, Medical, Stock Purchase Plan), and recruitment resumes (Professional, Office Staff) HR Server = SVR07 Shared folder = HR Identify the custom fields (data elements) for filtering documents to the respective queues in the queue set. Employee Benefit Recruitment Kofax, Inc. 53

Table 8. Planning Queue Setup: Example 2 (continued) Planning Item Name the queues in the queue set. Example HR-Employee Benefit 401K HR-Employee Benefit Medical HR-Employee Benefit Stock HR-Recruitment Professional HR-Recruitment Staff HR-All Identify the default display mode for documents in each queue. Get Next mode (the default) for the following: HR-Employee Benefit 401K HR-Employee Benefit Medical HR-Employee Benefit Stock HR-Recruitment Professional HR-Recruitment Staff Browse mode for HR-All Identify the actual data for filtering documents to each queue, based on the custom fields identified earlier. Identify who should have access to each queue, based on the role associated with applicable users. Identify the shortcuts to set up for the queues. 401K for HR-Employee Benefit 401K Medical for HR-Employee Benefit Medical Stock for HR-Employee Benefit Stock Professional for HR-Recruitment Professional Staff for HR-Recruitment Office Staff [No filter] for HR-All HREmpBenefit HRRecruitment Administrator HR-401K (with custom field default 401K ) for HR-Employee Benefit 401K HR-Medical (with custom field default Medical ) for HR-Employee Benefit Medical HR-Stock (with custom field default Stock ) for HR-Employee Benefit Stock Plan HR-Professional (with custom field default Professional ) for HR-Recruitment Professional HR-Staff (with custom field default Staff ) for HR-Recruitment Office Staff Making Sure Roles Exist in the Administration Console: Example 2 The following figure illustrates user roles for the example provided in Planning Queue Setup: Example 2 on page 53. 54 Kofax, Inc.

Figure 17. Roles in the Administration Console: Example 2 Defining Queues in the DesQueueDefinition.xml File: Example 2 Use the same instructions for defining a queue in the DesQueueDefinition.xml file as found in Defining Queues in the DesQueueDefinition.xml File on page 50 For this example, the contents of the file would contain the following (specified attributes are noted with boldface). Note the following; Because the example plan indicates an alternate storage location for document files, the filestoragedirectory attribute is specified with the QueueSet element. Because the example plan indicates two data elements for filtering documents to queues, two custom fields are specified. <?xml version="1.0" encoding="utf-8"?> <q:desqueuedefinition xsi:schemalocation="http://www.kofax.com/desqueuedefinition_1_00 schemas/queue/desqueuedefinition.xsd" xmlns:q="http://www.kofax.com/desqueuedefinition_1_00" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <q:queueset name="hr" filestoragedirectory="//svr07/hr"> <q:customfields> <q:customfield datatype="string" name="employee Benefit" id="1"/> <q:customfield datatype="string" name="recruitment" id="2"/> </q:customfields> <q:queues> <q:queue name="hr-employee Benefit 401K"> <q:filters> <q:filter customfieldname="employee Benefit" operator="equals" value="401k"/> </q:filters> <q:roles> <q:role name="hrempbenefit"/> <q:role name="administrator"/> </q:roles> </q:queue> <q:queue name="hr-employee Benefit Medical"> <q:filters> <q:filter customfieldname="employee Benefit" operator="equals" value="medical"/> </q:filters> <q:roles> <q:role name="hrempbenefit"/> <q:role name="administrator"/> </q:roles> </q:queue> <q:queue name="hr-employee Benefit Stock"> Kofax, Inc. 55

<q:filters> <q:filter customfieldname="employee Benefit" operator="equals" value="stock"/> </q:filters> <q:roles> <q:role name="hrempbenefit"/> <q:role name="administrator"/> </q:roles> </q:queue> <q:queue name="hr-recruitment Professional"> <q:filters> <q:filter customfieldname="recruitment" operator="equals" value="professional"/> </q:filters> <q:roles> <q:role name="hrrecruitment"/> <q:role name="administrator"/> </q:roles> </q:queue> <q:queue name="hr-recruitment Office Staff"> <q:filters> <q:filter customfieldname="recruitment" operator="equals" value="staff"/> </q:filters> <q:roles> <q:role name="hrrecruitment"/> <q:role name="administrator"/> </q:roles> </q:queue> <q:queue name="hr-all" defaultmode="browse"> <q:filters/> <q:roles> <q:role name="administrator"/> </q:roles> </q:queue> </q:queues> </q:queueset> </q:desqueuedefinition> Viewing Kofax Queue, Queue Sets, and Queues: Example 2 The following figures illustrate Kofax Queue, queue set, and queues for the example provided in Planning Queue Setup: Example 2 on page 53. Figure 18. Kofax Queue and HR Queue Set in the Administration Console: Example 56 Kofax, Inc.

Figure 19. Kofax Queue, HR Queue Set and Queues in Kofax Front-Office Server Web Client: Example Setting Up Queue Shortcuts in the Administration Console: Example 2 The following figures illustrates queue shortcuts for the example provided in Planning Queue Setup: Example 2 on page 53. Figure 20. Queue Shortcuts in Kofax Front-Office Server Administration Console Setting Up Queues: Example 3 This example illustrates the contents of the DesQueueDefinition.xml if the desired queue setup combined the requirements from both of the previous examples (Planning Your Queue Setup on page 48 andplanning Queue Setup: Example 2 on page 53), thus illustrating multiple queue sets. Kofax, Inc. 57

<?xml version="1.0" encoding="utf-8"?> <q:desqueuedefinition xsi:schemalocation="http://www.kofax.com/desqueuedefinition_1_00 schemas/queue/desqueuedefinition.xsd" xmlns:q="http://www.kofax.com/desqueuedefinition_1_00" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <q:queueset name="account Setup"> <q:customfields> <q:customfield datatype="string" name="branch" id="1"/> </q:customfields> <q:queues> <q:queue name="account Setup-LA Branch"> <q:filters> <q:filter customfieldname="branch" operator="equals" value="la Branch"/> </q:filters> <q:roles> <q:role name="acctrepslabranch"/> <q:role name="administrator"/> </q:roles> </q:queue> <q:queue name="account Setup-SD Branch"> <q:filters> <q:filter customfieldname="branch" operator="equals" value="sd Branch"/> </q:filters> <q:roles> <q:role name="acctrepssdbranch"/> <q:role name="administrator"/> </q:roles> </q:queue> <q:queue name="account Setup-All Branches" defaultmode="browse"> <q:filters/> <q:roles> <q:role name="administrator"/> </q:roles> </q:queue> </q:queues> </q:queueset> <q:queueset name="hr" filestoragedirectory="//svr07/hr"> <q:customfields> <q:customfield datatype="string" name="employee Benefit" id="1"/> <q:customfield datatype="string" name="recruitment" id="2"/> </q:customfields> <q:queues> <q:queue name="hr-employee Benefit 401K"> <q:filters> <q:filter customfieldname="employee Benefit" operator="equals" value="401k"/> </q:filters> <q:roles> <q:role name="hrempbenefit"/> <q:role name="administrator"/> </q:roles> </q:queue> <q:queue name="hr-employee Benefit Medical"> <q:filters> <q:filter customfieldname="employee Benefit" operator="equals" value="medical"/> </q:filters> <q:roles> <q:role name="hrempbenefit"/> <q:role name="administrator"/> </q:roles> </q:queue> <q:queue name="hr-employee Benefit Stock"> <q:filters> <q:filter customfieldname="employee Benefit" operator="equals" value="stock"/> </q:filters> <q:roles> <q:role name="hrempbenefit"/> <q:role name="administrator"/> </q:roles> </q:queue> <q:queue name="hr-recruitment Professional"> <q:filters> <q:filter customfieldname="recruitment" operator="equals" value="professional"/> </q:filters> <q:roles> <q:role name="hrrecruitment"/> <q:role name="administrator"/> </q:roles> </q:queue> <q:queue name="hr-recruitment Office Staff"> <q:filters> <q:filter customfieldname="recruitment" operator="equals" value="staff"/> 58 Kofax, Inc.

</q:filters> <q:roles> <q:role name="hrrecruitment"/> <q:role name="administrator"/> </q:roles> </q:queue> <q:queue name="hr-all" defaultmode="browse"> <q:filters/> <q:roles> <q:role name="administrator"/> </q:roles> </q:queue> </q:queues> </q:queueset> </q:desqueuedefinition> Considerations When Setting Up or Modifying Queues Consider the following when you are setting up new or editing existing queue sets or queues in the DesQueueDefinition.xml file. Updating the File Whenever you update the DesQueueDefinition.xml file (adding, changing, or removing queues), the updates take affect when a user logs on to the Web Client. To prevent disruptions to your users during the update process, consider placing a copy of the DesQueueDefinition.xml and queue schema files (maintaining the appropriate file path) in a temporary work area. Once the update is completed, copy the updated DesQueueDefinition.xml file to the \conf folder. Modifying an Existing Queue A user may receive an error when a document is submitted to its destination in the the Web Client if one of the following occurs in the DesQueueDefinition.xml file: You modify the contents of the file where the XML is not well formed or valid. You modify the elements or attributes of a queue, significantly changing the original set up of the queue. You remove the queue. Adding a New Queue Set or Queue Any new queue sets and queues set up in the XML file will be available to users only when they exit Kofax Front-Office Server Web Client and log on again. Setting Up an All Documents Queue It is highly recommended that you set up one queue in each queue set that specifies no filter, thereby allowing all received documents to be viewed for that queue set. This all documents queue enables at least the administrator to view and find any document received for that queue set, in the event a document is sent to an invalid queue. Enabling Administrator Access to Each Queue It is recommended that you specify the Administrator role for each queue, in addition to the applicable user roles. This setup ensures access to each queue by at least the administrator. About the Queue Schema File For information purposes only, DesQueueDefinition.xsd can be located with the files installed for Kofax Front-Office Server in the <installation folder>\kofax\front-office Server\Avalin\jboss\server\avalin\conf\schemas\queue folder. Kofax, Inc. 59

It is highly recommended that you not modify the queue schema file. Modifying the file may cause undesirable results with the DesQueueDefinition.xml file. Troubleshooting This section provides troubleshooting information. Firefox Remembered Password Used in the Administration Console If you set Firefox to remember your logon password for the Administration Console, that password will be entered in the Password field whenever you create a new user. The password is concealed with asterisks (*), but you need to remove the password from the field before entering a password for a new user. If you have already saved the password in Firefox, use the Firefox Options to remove it. Missing Cursor In Firefox 1.5 and 2.0, the cursor may not appear in the text fields in the Inbox Options screen in Kofax Front-Office Server Web Client. You can click in a field to make sure that the cursor is in it. Destinations Problems Sending Documents to Destinations If a document was not sent to a destination, check the following: Make sure that the field names do not contain single or double quotation marks. the Web Client does not support field names that contain those characters. Remove quotation marks from the field names and then try releasing documents to the destination. If you want to send documents to a network folder, first browse to the folder in Windows Explorer and enter your user name and password if prompted. Since you are not prompted to log on to the folder in the Web Client, documents will not be sent to that folder if you are not already authenticated. Coversheets Problems with Coversheets If documents that you scan with a coversheet do not appear at their destination, check the following: Check the avalin_server.log file for errors. The log file is in the \Avalin\jboss\server\avalin\log folder where Kofax Front-Office Server is installed. An error message does not appear in the Web Client. Make sure that the bar code is the correct size. Some browsers reduce graphics to fit in the browser window. Use the option to expand the graphic to full size. Make sure that the printer is the correct resolution and graphics quality to print the graphic clearly. Adjust the printer margins of your printer. 60 Kofax, Inc.

Kofax Capture Limitations in Value Lists In Kofax Capture When using value lists with forced match selected, invalid values entered at the MFP do not get imported into Kofax Capture. Workaround: Edit the value in Kofax Capture after the document has been imported. Problems Transferring Large Image Files to Kofax Capture If you are unable to process large images, it is because ASP.NET, which is used by Kofax Capture Import Connector - Web Services (referred to as Ascent Collection Server for Ascent Capture 7.5), has a limit of 4 MB per transfer. Kofax Front-Office Server also appends data to the image, which may cause images that are slightly smaller than 4 MB to have problems with transferring. If you are experiencing problems with transferring images, you can do either of the following: Reduce the size of images by changing the resolution or color settings. Locate the web.config file that is installed with Kofax Capture Import Connector - Web Services and add a maxrequestlength attribute. Refer to Microsoft documentation for instructions. Kofax, Inc. 61

62 Kofax, Inc.

Index A Active Directory connecting to, 13 Administration Console logs, 15 starting, 11 URL, 10 using, 11 B Backing Up and Restoring a Departmental Configuration, 15 Backing Up and Restoring an Enterprise Configuration, 17 D Database for tracking document activity, 36 purging, 37 retrieving information from, 36 Deprecated features, documentation for, 8 Destinations configuring retries for storage, 34 Directory Services connecting to, 12 connecting to Active Directory, 13 connecting to LDAP, 13 Directory services connecting to, 12 Doctracking database for tracking document activity, 36 Document activity tracking, 36 Drive space freeing, 23 DSS changing VRS settings, 33 setting up to use, 32 F Fax as a destination, 39 Field lookup implementing custom, 38 I Inbox changing location of, 19 K Kofax Capture destination configuration guide, 8 Kofax Document Scan Server setting up to scan directly from the Web Client, 32 Kofax Fax Connector general information, 39 Kofax Front Office Server database retrieving information from, 36 Kofax Front-Office Server stopping and restarting, 9 Kofax Front-Office Server database tracking document activity, 36 Kofax Front-Office Server service user account, 21 L LDAP connecting to, 13 Licensing, 12 Log files purging, 15 viewing, 15 Logs, viewing, 15 Lookup fields customizing, 38 M Master Configuration file changing the location of, 19 N Network destination configuring folders for, 18 Network Location, configuring folder, 18 P Password encrypting PostgreSQL, 35 Purging Kofax, Inc. 63

Index Q database, 37 log entries, 15 Queue setup basics, 47 Queue XML file using, 42 Queuing planning, 48 setting up in the Web Client, 42 R Registration, 12 Related documentation, 7 Restarting Kofax Front-Office Server, 9 Retries configuring for destinations, 34 for database access, 34 for failed scan jobs, 33 S Scan jobs configuring retries for failed, 33 Scanned images changing location of, 19 Scanner setting up to use, 25 Scanning directly from the Web Client setting up, 24 security enabling with SSL, 9 Security policy setting up to scan directly from the Web Client, 27 Shared folders Network Location destination, 18 SSL enabling security, 9 Stopping Kofax Front Office Server, 9 System requirements when setting up to scan directly from the Web Client, 25 V Validation implementing custom, 38 VRS settings changing for DSS, 33 W Watched folder configuring, 21 setting up, 22 Watched folder, setting up, 21 Web Client Inbox location, 19 scanning directly from, 24 starting, 11 URL, 10 watched folder setup, 21 WebScan when scanning directly from the Web Client, 24 X XML file for queuing, 42 T Technical support, 8 Training, 8 Troubleshooting, 60 U URLs, Kofax Front-Office Server applications, 10 Users identifying internal and linked, 14 64 Kofax, Inc.