Document Exchange Server 2.5

Transcription

1 KOFAX Document Exchange Server 2.5 Configuration Guide for Kofax Capture

2 Kofax, Inc., Laguna Canyon Road, Irvine, California 92618, U.S.A. All rights reserved. Use is subject to license terms. Third-party software is copyrighted and licensed from Kofax s suppliers. For information on third-party software included in this product, see DESTHIRDPARTYLICENSEREADME.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.

3 Contents Introduction...1 Additional Documentation...1 System Requirements...1 Setting Up User Accounts...2 Setting Up Batch Classes, Document Classes, and Form Types...2 Setting Up Index Fields...3 Installing Kofax Capture Release Files...3 Taking Advantage of Kofax Document Exchange Server 2.5 Features...4 Information Updates to Kofax Capture...4 Volume Licensing...5 Frequently Asked Questions...5 Technical Support...6 Kofax, Inc. iii

4 Contents iv Kofax, Inc.

5 Introduction This guide shows how to configure Kofax Document Exchange Server so that documents can be sent to Kofax Capture. Kofax Document Exchange Server uses Kofax Capture Import Connector - Web Services to communicate with Kofax Capture, retrieve form types that display as destinations in Kofax Capture, and release documents to those destinations. If you have defined index fields for a document class, they are retrieved by Kofax Document Exchange Server. Users can enter values for them in Kofax Document Exchange or at the MFP front panel. If you have defined values for these fields, users can select them from a drop-down field in Kofax Document Exchange. If you have hidden index fields, they are also hidden in Kofax Document Exchange Server. If you are creating global shortcuts in Kofax Administration Console, you can enter default values for the index fields that display when users send documents through a shortcut. Additional Documentation This guide should be read with the following documentation: Kofax Document Exchange Server Installation Guide or Kofax Document Exchange Server Installation Guide for WebLogic Kofax Document Exchange Server Administrator s Guide Kofax Administration Console Help Kofax Document Exchange Help For information about Kofax Capture and Kofax Capture Import Connector - Web Services, refer to the documentation that came with those products. Tip For additional information about Kofax products, visit the Kofax Web site and go to the Technical Support pages. These pages provide product-specific information, such as supported versions of the destination type, current revision levels, the latest drivers and software patches, technical tips, and a searchable knowledgebase. In addition, updates to product documentation (if any) are available from these pages. System Requirements Before configuring Kofax Capture to operate with Kofax Document Exchange Server, verify the following: Kofax Document Exchange Server is installed. Kofax Capture Import Connector - Web Services is connected to a network that is available to Kofax Document Exchange Server. As additional requirements for features described in Taking Advantage of Kofax Document Exchange Server 2.5 Features on page 4, verify the following: Kofax Capture 8.0 with Service Pack 3 is installed. Kofax Capture Import Connector - Web Services - Service, included on the Kofax Document Exchange Server 2.5 installation media, is installed. For installation instructions, locate the readme.txt file in the \OtherResources\Kofax Capture Import Connector - Web Services folder. Kofax, Inc. 1

6 Before installing the version included on the Kofax Document Exchange Server 2.5 installation media, remove any version of Kofax Capture Import Connector - Web Services - Service currently installed. For removal instructions, see the Kofax Capture Import Connector - Web Services Administrator s Guide. Kofax Capture 8.0 feature package, included on the Kofax Document Exchange Server 2.5 installation media, is installed. To install, double-click the ColorCompressionSetup.msi file, located in the \OtherResources\Kofax Capture folder. Note In addition to features related to Kofax Document Exchange Server 2.5, the feature package contains a Kofax Capture only feature. For more information, see the Release Notes for Kofax PDF Compression on the Kofax Web site. Setting Up User Accounts Kofax Document Exchange Server and Kofax Capture use separate security systems. To send documents to Kofax Capture, you need to log on with a valid Kofax Capture user account as follows: Users sending documents through Kofax Document Exchange are prompted to enter an Kofax Capture user name and account when they expand the list of destinations. Once they have logged on successfully, the credentials are saved. Administrators setting up global and group shortcuts can save an Kofax Capture user name and password for the Kofax Capture destination type. The credentials are used as defaults when creating shortcuts for Kofax Capture destinations. Administrators can override the defaults by assigning different user accounts to individual shortcuts. After the credentials have been saved, users or administrators are not prompted for an Kofax Capture user name and password unless they were changed. Refer to the Help for Kofax Document Exchange and Kofax Administration Console for instructions. Setting Up Batch Classes, Document Classes, and Form Types Note the following when setting up batch classes, document classes, and form types in Kofax Capture to use as Kofax Document Exchange Server destinations: When configuring a batch class, select Allow import of edocument files on the Advanced tab if you are using documents in formats other than TIFF. The Treat imported PDF files as TIFF images option should not be used for PDF files with text. This may cause Kofax Capture to generate an error when it processes a PDF file that contains text. Do not use DataStore and Formtype as index field names. If you have defined fields for a batch or document class, they are retrieved by Kofax Document Exchange Server. Users can enter values for them at the MFP or in Kofax Document Exchange. If you have defined values for these fields, users can select them from a drop-down field in Kofax Document Exchange. Both batch class and form type names appear in the Destination panel in Kofax Document Exchange. The batch class and form type names are separated by two pipe characters ( ), which serve as a separator string (Figure 1). 2 Kofax, Inc.

7 Figure 1. Batch Classes and Form Types in Kofax Document Exchange Do not include the separator string ( ) in the name of a batch class and form type. Setting Up Index Fields If you define fields for a document class, they are retrieved by Kofax Document Exchange Server. Users can enter values for them at the MFP or in Kofax Document Exchange. If you have defined values for these fields, users can select them from a drop-down field in Kofax Document Exchange. If you define batch fields, you can configure them to appear in document classes and Loose Pages destinations for that batch class by setting the formtype.batch.fields.display property in the rs.connector.kofaxcapture.properties file. If you leave this property blank, batch fields do not appear in both document classes and Loose Pages destinations. This setting applies to Kofax Administration Console and Kofax Document Exchange and for shortcuts and profiles you deploy to MFPs. Refer to the next section, Installing Kofax Capture Release Files, for information about this properties file. Installing Kofax Capture Release Files This section describes how to configure Kofax Capture and install Kofax Capture release files to work with Kofax Document Exchange Server. To install Kofax Capture Release Files 1 Install, license, and configure Kofax Capture and Kofax Capture Import Connector - Web Services. Create form types in Kofax Capture to be used as destinations for releasing documents. Also create user profiles as needed and assign the appropriate batch classes and modules. 2 Copy rs.connector.kofaxcapture.properties from the \DES\setup folder to the following folder: Provided application server: The \Avalin\jboss\server\avalin\conf folder where Kofax Document Exchange Server is installed WebLogic application server: The \conf folder in the Kofax Document Exchange Server domain. 3 Open rs.connector.kofaxcapture.properties in a text editor. Modify the properties, and then save and close the file. Kofax, Inc. 3

8 4 Deploy RSModuleConnectorKofaxCapture.ear as follows: Provided application server: Copy the file from the \DES\setup folder to the \Avalin\jboss\server\avalin\deploy folder where Kofax Document Exchange Server is installed. WebLogic application server: Deploy the file using the WebLogic Server Administration Console. Refer to the Kofax Document Exchange Server Installation Guide for WebLogic for instructions. 5 Use Kofax Administration Console to enable the Kofax Capture destination type. Refer to the Kofax Administration Console Help for instructions. Kofax Capture form types should display as destinations in Kofax Document Exchange and Kofax Administration Console. To display these Kofax Capture destinations on the MFP front panel, create and deploy shortcuts with Kofax Document Exchange and Kofax Administration Console. Refer to the Help for these applications for information. Taking Advantage of Kofax Document Exchange Server 2.5 Features The features described in this section are available only when you meet the additional Kofax Capture system requirements provided on page 1. The features are not available for earlier versions of Kofax Capture. Information Updates to Kofax Capture In Kofax Capture, you can view and/or use information about scan jobs that are processed by Kofax Document Exchange Server. These scan jobs are for documents that are scanned from an MFP or released from Kofax Document Exchange to Kofax Capture. The following information generated by document activity in Kofax Document Exchange Server is updated to the following information in Kofax Capture. Table 1. Kofax Document Exchange Server Information Updates to Kofax Capture Kofax Document Exchange Server Kofax Capture Document Activity Information User Tracking Kofax Capture Values Batch History MFP host name (if documents are submitted from an MFP) Source type (if documents are submitted from a source other than an MFP, such as KDE (Kofax Document Exchange) or WebScan) For Batch: Creation station ID {Batch Creator s Station ID} {Scan Operator s Station ID} Station ID User ID (entered for Kofax Document Exchange Server) For Batch: Creation user ID Creation user name For Module Launch: User ID User name {Scan Operator s User ID} (not applicable) Number of pages scanned For Batch Module: Pages scanned (not applicable) (not applicable) 4 Kofax, Inc.

9 Table 1. Kofax Document Exchange Server Information Updates to Kofax Capture Kofax Document Exchange Server Kofax Capture Document Activity Information User Tracking Kofax Capture Values Batch History Date and time the pages were scanned For Batch Module and Module Launch: Start date and time {Batch Creation Date} {Batch Creation Time} For scan queue: Start date & time End date & time If you are upgrading to Kofax Document Exchange Server 2.5 from a previous version, and there are existing documents in Kofax Document Exchange, information for these documents is not updated to Kofax Capture when the documents are released following the upgrade. Note For tracking user information in Kofax Capture, be sure that User Tracking is enabled in Kofax Capture. For more information, see the Kofax Capture documentation. Volume Licensing Volume licensing for Kofax Capture is not affected (page count is not decremented) by documents scanned with an MFP using Kofax Document Exchange Server, for the following licenses: Scan/Import Page Count Kofax PDF Image + Text Page Count Volume licensing is still affected by other Kofax Document Exchange Server activity for documents released to Kofax Capture (such as activity from any custom Web services client). Frequently Asked Questions If the software does not work correctly, or if you have questions about how the software operates, refer to the information in this section. You can find additional information and software updates on the Kofax Web site. Why does Kofax Capture not display as a destination type in Kofax Document Exchange and Kofax Administration Console? Check the following: Make sure you have installed the Kofax Capture files as shown in Installing Kofax Capture Release Files on page 3. Enable the Kofax Capture destination type in Kofax Administration Console. Refresh the browser window. How do I send documents to a destination from the MFP? Create shortcuts in Kofax Administration Console and Kofax Document Exchange. Shortcuts created with Kofax Administration Console are available to all users of an MFP. Users can create their own shortcuts with Kofax Document Exchange. Why am I unable to send documents to Kofax Capture from the MFP? Make sure that you have established credentials for a Kofax Capture user in Kofax Administration Console. Refer to Setting Up User Accounts on page 2 for information. Kofax, Inc. 5

10 Why is there an invalid logon exception when I attempt to connect to Kofax Capture through Kofax Administration Console? You need a Kofax Document Exchange Server user account that matches a user account in Kofax Capture. Refer to Setting Up User Accounts on page 2 for more information about setting up a matching account. How do I display or hide batch fields? Edit rs.connector.kofaxcapture.properties and change the formtype.batch.fields.display property. Refer to Installing Kofax Capture Release Files on page 3. How do I specify which domains are checked for users? Edit rs.connector.kofaxcapture.properties and change the auth.domains property. Refer to Installing Kofax Capture Release Files on page 3 Technical Support For additional technical information about Kofax products, visit the Kofax Web site at and select an appropriate option from the Support menu. The Kofax Support pages provide product-specific information, such as current revision levels, the latest drivers and software patches, online documentation and user manuals, updates to product release notes (if any), technical tips, and an extensive searchable knowledgebase. The Kofax Web site also contains information that describes support options for Kofax products. Please review the site for details about the available support options. If you need to contact Kofax Technical Support, please have the following information available: Kofax Document Exchange Server software version and build number Operating system and service pack version MFP or scanner make and model Kofax Document Scan Server version Destination type name, version, and configuration Special/custom configuration or integration information 6 Kofax, Inc.