Kofax Document Exchange Server 2.0 User Manual
KOFAX
Document
Exchange Server
2.0
Installation Guide for JBoss
10300779-000
© 2007–2008 Kofax, Inc., 16245 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.
Contents
Introduction ...................................................................................................................................................1
Related Documentation ........................................................................................................................1
Administrator’s Guide ...................................................................................................................1
Kofax Fax Connector Installation Guide .....................................................................................2
Installation Overview ...................................................................................................................................2
Software Installed with Kofax Document Exchange Server ...........................................................3
System Requirements ...................................................................................................................................3
Server Requirements .............................................................................................................................3
Operating System ...........................................................................................................................3
Minimum Hardware Requirements ............................................................................................4
Hard Drive Space Requirements ..................................................................................................4
Open Ports .......................................................................................................................................4
Host Name .......................................................................................................................................4
Client Requirements ..............................................................................................................................4
Certified Web Browsers .................................................................................................................4
Adobe Reader Requirement .........................................................................................................4
General Installation Notes ....................................................................................................................5
Supported Upgrades for JBoss Configurations (JBoss Only) ...................................................5
Network Configuration Requirements .......................................................................................5
Installing on a Local Drive ............................................................................................................5
Requirement for Free Hard Drive Space .....................................................................................5
Dedicated Server Requirement ....................................................................................................5
Registry Access ...............................................................................................................................6
User Name Requirements .............................................................................................................6
Restarting the Server ......................................................................................................................6
Invalid Drive Path ..........................................................................................................................6
Using Kofax Document Exchange Server on a Virtual Machine (VM) ..................................6
Security Settings for Browsers ......................................................................................................6
Text Resizing in Browsers .............................................................................................................7
Installation Notes for 64-Bit Computers ............................................................................................7
Precautions Before Upgrading ............................................................................................................7
Services Running before Upgrading ...........................................................................................7
Workflow Processes .......................................................................................................................7
Restarting Kofax Document Exchange Server after a Rollback ...............................................8
Upgrade Notes for MFPs ......................................................................................................................8
Preparation for Upgrades ..............................................................................................................8
Upgrading the Kofax Document Exchange Server Application for Fujitsu ..........................8
Upgrading the Client Software for Other MFPs ........................................................................8
Upgrade Notes for Shortcuts ...............................................................................................................8
Kofax, Inc. iii
Contents
Redeploying Global Shortcuts for Kofax Capture .....................................................................8
Installing Kofax Document Exchange Server ...........................................................................................8
Preliminary Tasks Before Upgrading .................................................................................................9
Backing Up Your Existing Installation ........................................................................................9
Saving Custom Workflows .........................................................................................................10
Starting the Installer ............................................................................................................................10
Performing a New Installation ..........................................................................................................10
Upgrading an Existing Installation ...................................................................................................12
Post-Installation Notes ........................................................................................................................14
Shared Folders Created by the Installer ....................................................................................14
Viewing the Installation Log Files .............................................................................................14
Configuring Kofax Document Exchange Server Destination Types ...................................................14
Installing MFP Front Panel Software .......................................................................................................15
Other Configuration Tasks ........................................................................................................................15
Stopping and Restarting Kofax Document Exchange Server ...............................................................15
Using the Kofax Document Exchange Server Status Icon .............................................................15
Using the Services Console ................................................................................................................16
Uninstalling Kofax Document Exchange Server ....................................................................................16
iv Kofax, Inc.
Introduction
This guide includes instructions on installing Kofax Document Exchange Server with a JBoss
application server. Read this guide completely before using the software. This guide was written
with the assumption that you have a thorough understanding of Microsoft Windows and network
configuration.
For instructions on installation for WebLogic application server (single server or clustered
environment), see the Kofax Document Exchange Server Installation Guide for WebLogic.
Related Documentation
In addition to this guide, Kofax Document Exchange 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\DESguides.html after installation (if you select to install Documentation).
Kofax Document Exchange Server Installation Guide for JBoss
Figure 1. Guides Page
Administrator’s Guide
The Kofax Document Exchange Server Administrator’s Guide shows how to change the configuration
by modifying properties files and performing other administration tasks to keep Kofax Document
Exchange Server working properly. The guide is in the setup\Guides folder on the Kofax
Document Exchange Server installation media. It is also installed with the software in the
Documentation\Guides folder.
Kofax, Inc. 1
Kofax Document Exchange Server Installation Guide for JBoss
Multifunction Peripheral (MFP) Administrator Guides
These guides show how to make Kofax Document Exchange Server features available on MFP
front panels. The MFP administrator guides are in the setup\Guides folder on the Kofax
Document Exchange Server installation media. They are also installed with the software in the
Documentation\Guides folder.
Destination Configuration Guides
These guides show how to enable Kofax Document Exchange Server to send documents to
destinations, such as content management and email systems. The destination configuration
guides are in the setup\Guides folder on the Kofax Document Exchange Server installation
media. They are also installed with the software in the Documentation\Guides folder.
Installation Guide for WebLogic
Use this guide if you are installing Kofax Document Exchange Server on a WebLogic application
server.
Kofax Fax Connector Installation Guide
The Kofax Fax Connector Installation Guide provides installation and configuration instructions for
the Kofax Fax Connector. The guide is installed with Kofax Document Exchange in the
OtherResources\FaxConnector folder.
Help for Kofax Document Exchange Server Applications
Kofax Document Exchange and Kofax 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 Document
Exchange Server documentation.
Installation Overview
This guide provides instructions for installing Kofax Document Exchange Server. Before
beginning the installation, refer to System Requirements for installation guidelines and system
requirements. Make sure that your server and client systems have been configured correctly and
are communicating through the network. If you have any difficulties with installing Kofax
Document Exchange Server, refer to the support pages of the Kofax Web site for information.
Follow these general steps to install Kofax Document Exchange Server:
1 Make sure that Kofax Document Exchange Server meets system requirements.
2 Remove the following applications from the computer:
PostgreSQL, Open LDAP, and Bonjour that are not part of a previous Kofax Document
Exchange Server installation
2 Kofax, Inc.
Kofax Document Exchange Server Installation Guide for JBoss
Kofax Capture or Ascent Capture
3 Run the Installer. If you have an existing installation of Kofax Document Exchange Server,
you are prompted to upgrade it.
4 Start Kofax Document Exchange Server and run Kofax Administration Console to install
the license, add users, and configure the system.
5 Configure any destinations you want to add to Kofax Document Exchange Server.
6 Install software to display Kofax Document Exchange Server buttons on the front panel of
an MFP.
7 If you need to change the configuration of Kofax Document Exchange Server, refer to the
Kofax Document Exchange Server Administrator’s Guide.
Software Installed with Kofax Document Exchange Server
The following software is installed with Kofax Document Exchange Server:
PostgreSQL: Database for document data
Java Runtime Environment (JRE): A version of the JRE is installed in the Kofax Document
Exchange Server folders. This JRE is used by Kofax Document Exchange Server and does
not replace any versions of the JRE installed on your system.
OpenLDAP: User security for Kofax Document Exchange Server
JBoss: Java-based application server for running Kofax Document Exchange Server
Bonjour: Software that discovers devices on a network
VirtualReScan (VRS): Kofax product for improving image quality
System Requirements
The server and client workstations used for Kofax Document Exchange Server must meet the
system requirements described in this section. These requirements will be updated as new
configurations are supported. Refer to the Kofax Web site for the latest information.
Server Requirements
Kofax Document Exchange Server must be installed on a dedicated server that meets the
requirements in this section.
Operating System
Kofax Document Exchange Server requires either of the following versions of Microsoft Windows
Server 2003 for production use:
32-bit Microsoft Windows Server 2003 Service Pack 2
64-bit Microsoft Windows Server 2003 Service Pack 2
If you are using a 32-bit version of Windows, you can upgrade an existing Kofax Document
Exchange Server installation or perform a new installation. If you are using a 64-bit version of
Windows, you can only perform a new installation.
Kofax, Inc. 3
Loading...