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
Kofax Document Exchange Server Installation Guide for JBoss
Minimum Hardware Requirements
The server must meet the following minimum hardware requirements. Production systems
should exceed these requirements.
2 GHz Pentium 4 or compatible microprocessor
2 GB RAM
100/1000 Mbps network card (10 Mbps not supported)
Hard Drive Space Requirements
Make sure that there is sufficient space on the hard drive for the database. A minimum of 25 GB is
recommended as an initial amount of free hard drive space for the database. Additional space will
be needed as the database grows. Refer to the Kofax Document Exchange Server Administrator’s
Guide for information about configuring Kofax Document Exchange Server to allow sufficient free
drive space.
Open Ports
Ports 80 and 8080 must be available for use by Kofax Document Exchange Server. If Internet
Information Services (IIS), a Web server, or another application uses these ports, reconfigure it to
use different ports. If IIS, a Web server, or an application cannot be reconfigured, disable or
uninstall it or install Kofax Document Exchange Server on another computer.
Some MFPs also need port 8888 open in the network connection between Kofax Document
Exchange Server and the device. Refer to the MFP administrator guide for information.
Host Name
The host name should not exceed 15 characters, which is a requirement for the database
installation. If you cannot modify the computer’s host name to meet this requirement, install
Kofax Document Exchange Server on another computer.
Client Requirements
This version of Kofax Document Exchange Server provides browser-based applications, Kofax
Document Exchange and Kofax Administration Console, which require the following.
Certified Web Browsers
Kofax Document Exchange Server requires a Web browser to run thin clients and view the Help.
The following browsers have been tested with Kofax Document Exchange Server:
Microsoft Internet Explorer 6.0 and 7.0
Mozilla Firefox 1.5 and 2.0
Adobe Reader Requirement
To view PDF files on Kofax Document Exchange Server client workstations, you need the current
version of Adobe Reader.
Note For information on additional requirements if you want to scan directly from the Kofax
Document Exchange (using the feature called WebScan), see the Kofax Document Exchange Server
Administrator’s Guide.
4 Kofax, Inc.
Kofax Document Exchange Server Installation Guide for JBoss
General Installation Notes
This information applies to all installations of Kofax Document Exchange Server.
Supported Upgrades for JBoss Configurations (JBoss Only)
Table 1 shows direct upgrades to Kofax Document Exchange Server version 2.0. Notice that you
may need to upgrade an older version of Kofax Document Exchange Server to version 1.2 before
upgrading to version 2.0.
Table 1. Supported Upgrades to Kofax Document Exchange Server Version 2.0 for JBoss
Version Upgrade Supported
1.2 (on 32-bit Windows) Yes.
1.2 (on 64-bit Windows) No.
1.1 Yes, but only if you upgrade to 1.2 first, and then
upgrade to 2.0. A direct upgrade to 2.0 is not supported.
1.0 No.
Important After upgrading from 1.1 to 1.2 to 2.0, change the PostgreSQL password in
login_config.xml to the password you originally assigned in 1.1. The database administrator
password remains unchanged during the upgrade, but login_config.xml needs to be changed
from the password that is assigned for installations after 1.1. After changing the password, secure
the password by encrypting it manually as shown in the Kofax Document Exchange Server
Administrator's Guide.
Network Configuration Requirements
Destination types and Kofax Document Scan Server devices need to be on the same network as
Kofax Document Exchange Server with routable addresses from the server.
Kofax Document Exchange Server uses the IP address of the first network connection listed in the
connection order. If there are multiple network cards in the server, you may need to change the
order of network connections so that the connection used by MFPs and destination types is first.
Refer to the Microsoft Windows Server 2003 documentation for instructions on changing the
connection order.
Installing on a Local Drive
Kofax Document Exchange Server must be installed on a local drive, which can be any drive letter.
Do not install Kofax Document Exchange Server on a network drive, including a mapped drive.
Requirement for Free Hard Drive Space
Make sure that there is sufficient space on the hard drive for the database. A minimum of 25 GB is
recommended as an initial amount of free hard drive space for the database. Additional space will
be needed as the database grows. You can manage the database size by periodically purging old
records. Kofax Documentation Exchange Server can also block database requests if the free drive
Kofax, Inc. 5
Kofax Document Exchange Server Installation Guide for JBoss
space reaches a specified threshold. For information about freeing hard drive space, refer to the
Kofax Document Exchange Server Administrator’s Guide.
Dedicated Server Requirement
Kofax Document Exchange Server should not be installed on a domain controller or a system with
Active Directory. OpenLDAP, which is installed with Kofax Document Exchange Server, conflicts
with the port used by Active Directory and generates the following error: “OPENLDAP
Deployment Failure.”
Registry Access
Kofax Document Exchange Server needs to modify the Registry during installation. If you are
using software that restricts changes to the Registry, turn it off while installing Kofax Document
Exchange Server.
User Name Requirements
When typing the administrator user name during installation, note these rules:
The user name must be unique on the server.
You can enter any number of characters, but spaces and the following characters are not
permitted:
~ # % * \ ; / : & ? . ' , "
User names are case-sensitive.
Restarting the Server
Do not restart the server manually while the Kofax Document Exchange Server installation
program is running. Restarting the server will cause the installation to fail.
Invalid Drive Path
If you change the default path during installation, you must select an install path that includes a
valid local drive letter. The following error appears if you select a drive letter that does not exist.
You do not have write permissions to the chosen installation destination.
Using Kofax Document Exchange Server on a Virtual Machine (VM)
Kofax Document Exchange Server may not run properly on a VMware Virtual Machine when the
host computer has multiple processors, multiple cores, or hyperthreading enabled. The following
problems may occur:
When users attempt to download a PDF file, the following error appears. The text in italics
varies depending on your system and the files affected.
KDE 16017 - Cannot download the document. Verify that document is not
locked by another process. If the document cannot be downloaded, have the
system administrator verify that the VRS component has been installed with
the Kofax Document Exchange Server.
If PDF is selected as the format for a destination file, scanned documents will not be sent to
that destination. This setting also affects documents scanned from Kofax Document Scan
Server. These documents may appear in Kofax Document Exchange without pages and
preview images.
6 Kofax, Inc.
Kofax Document Exchange Server Installation Guide for JBoss
Workaround: Configure the VM as a dual virtual processor system. If the problem continues, set
the BIOS of the host computer to turn off hyperthreading.
Security Settings for Browsers
If a browser is set to the highest security setting, Kofax Administration Console and Kofax
Document Exchange may not work correctly. These applications depend on JavaScript, and they
must be able to communicate with the server. Therefore, make Kofax Administration Console,
Kofax Document Exchange, and their Help systems trusted sites and enable JavaScript and
cookies.
Text Resizing in Browsers
Panels and scroll bars are not resized automatically when the text size changes. This can cause
enlarged text to appear outside the borders of a panel. It can affect automatic scrolling, such as
when you drag a document to the bottom of a Destination panel to scroll down the list of
destinations. To cause resizing, use the browser’s Refresh command so the panels and scroll bars
are resized to fit the text.
Installation Notes for 64-Bit Computers
If you are installing Kofax Document Exchange Server on a 64-bit computer, note the following
additional requirements.
Kofax Document Exchange Server supports the AMD64 instruction set and architecture on the
Windows operating system. Intel Itanium processors are not supported.
The C:\Program Files (x86) folder is still required for some components of Kofax Document
Exchange Server. To support these components, the Installer does the following:
Bonjour is installed in both C:\Program Files and C:\Program Files (x86). A Bonjour
subfolder is created in each folder.
VRS and PostgreSQL are installed in C:\Program Files (x86). The PostgreSQL database is
installed on the C drive even if Kofax Document Exchange Server is installed on another
local drive. There must be sufficient space on the C drive to accommodate the database.
Refer to Requirement for Free Hard Drive Space on page 5 for more information.
All other files are installed in the installation path you specified.
Precautions Before Upgrading
Services Running before Upgrading
Make sure that OpenLDAP-slapd and PostgreSQL Database Server, which are used by Kofax
Document Exchange Server, are running before you perform the upgrade. If one of those services
is shut down early during the upgrade, the Installer may be unable to roll back the installation to
the previous state.
Workflow Processes
Make sure that all workflow processes are in completed state before upgrading. Paused and
terminated workflows must be processed before an upgrade, because the pause and resume
options have been discontinued to support clustering in Kofax Document Exchange Server 2.0.
Kofax, Inc. 7
Kofax Document Exchange Server Installation Guide for JBoss
Workflow processes that are in failed state cannot be restarted after an upgrade. If you attempt to
restart a failed workflow process after an upgrade, the following error occurs:
KAC 20004 - Cannot process the request at server “localhost.” The reported
error is “Internal data processing error: ‘Cannot find the definition, ID =
‘mfpRelease@3.00.10’, in database’”.
Failed, paused, and terminated workflows can only be removed after an upgrade.
Restarting Kofax Document Exchange Server after a Rollback
After rolling back a failed Kofax Document Exchange Server upgrade, you may need to do the
following to restore normal operation:
Restart the KofaxServer service and any other services used by Kofax Document Exchange
Server.
Clear the browser’s cache.
Upgrade Notes for MFPs
Preparation for Upgrades
Before upgrading a Kofax Document Exchange Server with attached MFPs, make sure that all scan
jobs from the MFPs have been sent to the server. Any scan jobs that have not arrived at the server
are lost during the upgrade.
Upgrading the Kofax Document Exchange Server Application for Fujitsu
The Kofax Document Exchange Server application for the Fujitsu fi-6000NS network scanner must
be upgraded in order to use it with Kofax Document Exchange Server 2.0. If the application is not
upgraded, the device will not connect with Kofax Document Exchange Server 2.0. Refer to the
Kofax Document Exchange Server Administrator’s Guide for Fujitsu Network Scanners for instructions
on removing and installing the Kofax Document Exchange Server application.
Upgrading the Client Software for Other MFPs
Upgrading the MFP client software is optional for the other MFPs. For these devices, Kofax
Document Exchange Server 2.0 is backward-compatible with earlier versions of MFP client
software. If there are new features of the MFP client software that you want to use, uninstall the
current version of the client software, install or deploy the new client software, and redeploy your
profiles from Kofax Administration Console.
Refer to the Kofax Document Exchange Server administrator’s guide for your MFP for instructions
on installing client software.
Upgrade Notes for Shortcuts
Some global and personal shortcuts may need to be deleted and recreated after upgrading.
Redeploying Global Shortcuts for Kofax Capture
Global shortcuts created for Ascent Capture are upgraded for Kofax Capture. After the upgrade,
you need to redeploy the profiles for the global shortcuts in order for the shortcuts to work from
the MFPs.
8 Kofax, Inc.
Kofax Document Exchange Server Installation Guide for JBoss
Installing Kofax Document Exchange Server
Run the Installer to install Kofax Document Exchange Server and all necessary components on
your server. You must log on to the computer as a user with Administrator rights to install Kofax
Document Exchange Server.
After you start the Installer, it detects if there is a previous version of Kofax Document Exchange
Server that can be upgraded. If there is not a previous version, continue with a new installation,
and you are prompted to specify the installation location and other settings. If there is a previous
version, you are prompted to upgrade it. If there is a previous version that cannot be upgraded,
you are prompted to exit the Installer and uninstall the previous version manually before
continuing with the installation.
Important Refer to the Kofax Document Exchange Server Release Notes for information about which
versions of Kofax Document Exchange Server can be upgraded.
Preliminary Tasks Before Upgrading
Before upgrading Kofax Document Exchange Server, do the following:
Back up your data and settings.
Save custom workflows to reinstall after the upgrade.
Make sure that all scan jobs from the MFP and other inputs have been sent to the server.
Any scan jobs that have not arrived at the server are lost during the upgrade.
If you have Kofax Fax Connector installed with Kofax Document Exchange Server, see the
Kofax Fax Connector Installation Guide before you install the Kofax Document Exchange
Server upgrade.
Backing Up Your Existing Installation
You should back up your Kofax Document Exchange Server installation before upgrading. You
can use the backup to restore your installation if there is a problem with the upgrade.
Back up the following:
All files in the folder where you installed Kofax Document Exchange Server
All Registry settings
Note The backup may require large amounts of disk space.
The Installer also backs up folders and data in case an error prevents the upgrade from
completing. The Installer can then use the backup to roll back to your previous configuration.
The following folders are backed up:
Avalin
DES, except DES and EmailWatcher
Documentation
Uninstall
Install Logs
jre
Kofax, Inc. 9
Kofax Document Exchange Server Installation Guide for JBoss
The following are also backed up or exported:
Database
Registry (Kofax Document Exchange entries only)
Workflows
VRS and JRE are not backed up and cannot be rolled back. When the upgrade has been completed
successfully, you have the option of deleting some or all of your backup files.
Even though the Installer performs this automatic backup, you should still back up your data and
settings manually in case a failed upgrade cannot be rolled back.
Saving Custom Workflows
Custom workflows are not upgraded. During the upgrade, workflows are exported from the
database as part of the backup. The exported workflows are saved in the backup folder you
specify in the Installer in a workflow folder. Use the exported workflow files if you do not have
the original .wfd files.
After performing the upgrade, deploy the custom workflow on the server with Kofax
Administration Console. Refer to the Kofax Administration Console Help for more information.
Starting the Installer
Start the installation or upgrade by running the Installer from the Kofax Document Exchange
Server installation media.
Note Do not run the Installer from a UNC path.
X To start the Installer
1 Insert the Kofax Document Exchange Server installation media into your drive.
2 Run setup.exe, which is in the root of the Kofax Document Exchange Server installation
media.
Note The setup program detects a 32-bit or 64-bit computer and starts the correct Installer.
The screens that appear next depend on whether or not there is a previous version of Kofax
Document Exchange Server that can be upgraded:
If there is not a previous version, continue with the next section, Performing a New
Installation, for a new installation. You can perform this procedure with the 32- or 64-bit
version of Windows.
If there is a previous version that can be upgraded, continue with Upgrading an Existing
Installation on page 12. Upgrades cannot be performed with the 64-bit version of Windows.
If there is a previous version, but it cannot be upgraded, the Installer will stop. Click OK to
exit the Installer.
Performing a New Installation
For a new installation, you are prompted to specify an initial administrator user, a password for
the database service, and a path for the program.
10 Kofax, Inc.
Kofax Document Exchange Server Installation Guide for JBoss
X To continue with a new installation
1 You are prompted to confirm that the necessary ports are open. Refer to Open Ports on
page 4 for more information. If the ports are available for Kofax Document Exchange
Server, click OK to continue the installation.
2 The introduction screen appears (Figure 2). Click Next.
Figure 2. Kofax Document Exchange Server Installer Introduction Screen
3 If you have VRS installed on your system that is not part of a previous Kofax Document
Exchange Server installation, you have the option to upgrade it and clean up any leftover
files. Click OK to do this.
4 Review the Kofax Document Exchange Server license agreement and select “I accept the
terms of the License Agreement” to continue with the installation. Click Next to continue.
5 Type the user name and password for the initial Kofax Document Exchange Server
administrator. Use this user account to log on to Kofax Administration Console for the
first time. The user name and password must meet the following rules:
User names must be unique on the server.
User names cannot include spaces, and the following characters are not permitted: ~ #
% * \ ; / : & ? . ' , " ` $ < + >
User names and passwords are case-sensitive.
Passwords can include spaces, but not at the beginning or end. There can be no
repeating spaces.
The password for the initial administrator cannot include the following characters that
are prohibited by the database: & $ < ' > \ * / "
You can create additional administrators by assigning the Administrator role to other
users in Kofax Administration Console.
Click Next to continue.
6 Type a password for a PostgreSQL account that the database service will use to start. Note
the following rules:
Follow the password policy established by your Network Administrator.
The following characters are not permitted: < > / "
Click Next to continue.
Kofax, Inc. 11
Kofax Document Exchange Server Installation Guide for JBoss
7 Type the folder where Kofax Document Exchange Server will be installed. Use the default
folder or change it by clicking Choose and selecting the path from the window that
appears. The install path must be on a local drive and have a maximum of 65 characters. If
you want to switch back to the default folder, click Restore Default Folder. When you
have selected the folder, click Next.
Note You cannot specify a UNC path or install Kofax Document Exchange Server on a
network drive.
8 Review the pre-installation summary (Figure 3). To start the installation, click Install.
Figure 3. Pre-Installation Summary
Note the following while the Installer is running:
Do not close the Installer window until the installation is complete. Interrupting the
installation can leave the system in an unrecoverable state.
If you are installing on the 64-bit version of Windows, the installation of Bonjour is not
a silent installation. You will be prompted to complete the Bonjour installation screens.
9 A screen indicates when the installation is finished. Click Finish to close the Installer.
Upgrading an Existing Installation
If you already have Kofax Document Exchange Server, you are prompted to upgrade it. The
upgrade preserves your existing settings and data, and you are not prompted to specify a new
administrator, database service password, and installation path.
During the upgrade, Kofax Document Exchange Server is shut down. We recommend that you
schedule the upgrade when Kofax Document Exchange Server is not used and inform users not to
use it during the upgrade.
Follow the steps in this section after you have started the Installer as shown in Starting the Installer
on page 10.
12 Kofax, Inc.
Kofax Document Exchange Server Installation Guide for JBoss
X To continue with an upgrade
1 The Installer indicates that an existing version of Kofax Document Exchange Server is on
the computer, and it can be upgraded. Click Next to continue.
2 The introduction screen appears. Click Next.
3 If you have VRS installed on your system that is not part of a previous Kofax Document
Exchange Server installation, you have the option to upgrade it and clean up any leftover
files. Click OK to do this.
4 Review the Kofax Document Exchange Server license agreement and select “I accept the
terms of the License Agreement” to continue with the installation. Click Next to continue.
5 Select the folder that the Installer uses for its backup. Use the default folder or change it by
clicking Choose and selecting the path from the window that appears. The path must be
on a local drive and have a maximum of 65 characters. If you want to switch back to the
default folder, click Restore Default Folder. When you have selected the folder, click Next.
Figure 4. Choosing the Backup Folder
6 Review the installation settings. To start the upgrade, click Install. The Installer begins the
upgrade and indicates the status. When it is finished, it indicates whether the upgrade
was successful.
Warning Do not close the Installer window until the upgrade is complete. Interrupting
the installation can leave the system in an unrecoverable state.
7 If the upgrade is successful, you have the option of deleting the files that were backed up
during the upgrade. Select the option if you want to delete the backup files.
8 If you have custom workflows and destinations, do the following:
Redeploy custom workflows with Kofax Administration Console. Refer to the Kofax
Administration Console Help for more information.
Reinstall custom destinations. Refer to the instructions provided with your custom
destination.
Kofax, Inc. 13
Kofax Document Exchange Server Installation Guide for JBoss
9 If you have MFPs connected to the upgraded Kofax Document Exchange Server, do the
following:
Upgrade the client software for the MFP, if necessary. Refer to the Kofax Document
Exchange Server Release Notes and the support pages of the Kofax Web site to determine
if there is new MFP client software that needs to be installed.
Redeploy your profiles from Kofax Administration Console.
Post-Installation Notes
When the installation is complete, note the following about folders installed by Kofax Document
Exchange Server. This section also provides information in case a problem prevents Kofax
Document Exchange Server from installing successfully.
Shared Folders Created by the Installer
The Installer automatically sets permissions to the folders. Administrators group members share
the \DES\DES folder, which is located in the Kofax Document Exchange Server folder you
specified and is used for storing user inboxes. You can change this folder as shown in the Kofax
Document Exchange Server Administrator’s Guide for instructions.
Do not share any other folders in the folder where Kofax Document Exchange Server is installed.
Users other than administrators do not need to have rights to the folders in order to use Kofax
Document Exchange Server.
Viewing the Installation Log Files
If you need to resolve a problem with the installation, you can view the installation log files for
detailed information. The location of the log files depends on the result of the installation or
upgrade. Refer to Table 2.
Table 2. Log File Location
Installation or Upgrade Result Log File Location
Installation or upgrade finished
successfully
Installation or upgrade failed or
canceled
Uninstallation completed C:\Kofax Install Logs\Document Exchange Server
Install Logs folder where Kofax Document Exchange Server is
installed
C:\Kofax Install Logs\Document Exchange Server
Important The installation log files include passwords in plain text. After you are finished with
the files, delete them or save them in a secure location.
Configuring Kofax Document Exchange Server Destination Types
Two destination types are preinstalled with Kofax Document Exchange Server:
Network Location to send documents to a network folder
Kofax Queue to send documents to a queue
14 Kofax, Inc.
Note For information about configuring network folders to use as destinations and setting up
queues, refer to the Kofax Document Exchange Server Administrator’s Guide.
To configure Kofax Document Exchange Server for additional destination types, you need to
deploy one or more connector files and modify a properties file with configuration options. Refer
to the configuration guides provided with Kofax Document Exchange Server for each destination.
You will find the configuration guides in the following folders:
The Documentation\Guides folder where Kofax Document Exchange Server is installed
(usually C:\Program Files\Kofax\Document Exchange Server)
The setup\Guides folder on the Kofax Document Exchange Server installation media
Installing MFP Front Panel Software
Your MFP may require additional software to display Kofax Document Exchange Server shortcut
buttons on the front panel. Instructions for installing the software and other information about
setting up the MFP are in administrator guides in the following folders:
The Documentation\Guides folder where Kofax Document Exchange Server is installed
(usually C:\Program Files\Kofax\Document Exchange Server)
The setup\Guides folder on the Kofax Document Exchange Server installation media
Kofax Document Exchange Server Installation Guide for JBoss
For more information about supported MFPs, refer to the Kofax Web site.
Other Configuration Tasks
Refer to the Kofax Document Exchange Server Administrator’s Guide for instructions for modifying
properties files and making other configuration changes.
Stopping and Restarting Kofax Document Exchange Server
You may need to stop and restart Kofax Document Exchange Server when changing configuration
files or for routine maintenance. The process depends on which application server and
configuration you use. These instructions are for JBoss application servers.
Kofax Document Exchange Server is installed as a Windows service named KofaxServer. You can
start and stop the service when needed from the Services console. Let all currently running
workflow processes finish before stopping the KofaxServer service.
Tip If you are using JBoss with the 32-bit of Microsoft Windows, an icon on the taskbar displays
the status of Kofax Document Exchange Server.You can stop and start KofaxServer service by
right-clicking the status icon instead of using the Services console.
Kofax, Inc. 15
Kofax Document Exchange Server Installation Guide for JBoss
Using the Kofax Document Exchange Server Status Icon
If you are using JBoss with the 32-bit version of Microsoft Windows, a status icon appears in the
notification area on the right side of the task bar to indicate the status of Kofax Document
Exchange Server. This icon does not appear in the 64-bit version of Microsoft Windows.
Table 3. Kofax Document Exchange Server Icon (For 32-Bit Windows Only)
Icon Description
Green (bottom) light: Server is running
Red (top) light: the Server is stopped
Right-click the status icon to display a menu of commands:
Start
Starts Kofax Document Exchange Server after it has been stopped.
Stop
Stops Kofax Document Exchange Server if it is running.
Exit
Removes the Kofax Document Exchange Server icon from the notification area, but does
not affect the operation of Kofax Document Exchange Server.
Note To display the icon again after removing it with the Exit command, select Start |
Programs | Kofax | Kofax Server Monitor.
Using the Services Console
You can use the Services console to start and stop KofaxServer on a JBoss system or configure it to
start manually or automatically. For more information about using the Services console, refer to its
Help.
X To control Kofax Document Exchange Server through the Services console
1 Select Administration Tools | Services. Depending on the version and configuration of
Windows, the Administration Tools are in the Control Panel or Programs.
2 Locate KofaxServer in the Services console.
3 Do either of the following to start or stop the Kofax Document Exchange Server service:
Right-click KofaxServer and select the command.
Select KofaxServer and use the toolbar buttons.
Depending on the status, you can start, stop, or restart the service. Pause and Resume are
not supported.
X To select automatic or manual startup
1 Locate KofaxServer in the Services console and do either of the following:
Right-click KofaxServer and select Properties.
Select KofaxServer and click the Properties button in the toolbar.
The KofaxServer Properties window appears.
16 Kofax, Inc.
Kofax Document Exchange Server Installation Guide for JBoss
2 Select the General tab.
3 In the “Startup type” field, select Automatic or Manual.
Uninstalling Kofax Document Exchange Server
Use Add or Remove Programs in the Control Panel to remove Kofax Document Exchange Server
and all software installed with it from the computer.
Warning Uninstalling Kofax Document Exchange Server shuts down the service, logs off any
users, deletes all user data, and reboots the server. If you had saved files and settings that are
preserved during an upgrade, they are also deleted. Make sure that you have backed up your data
and all Kofax Document Exchange Server files are closed before proceeding.
X To uninstall Kofax Document Exchange Server
1 Open Control Panel from the Windows Start menu.
2 From Control Panel, select Add or Remove Programs.
3 Locate Kofax Document Exchange Server in the list of currently installed programs. Click
Change/Remove. The Uninstaller starts and displays an introduction screen (Figure 5).
Click Next.
Figure 5. Uninstall Kofax Document Exchange Introduction Screen
4 A message explains what the uninstallation does and asks if you want to continue the
process. Click OK to continue.
5 At the Uninstall Options window, make sure that Complete Uninstall is selected.
(Uninstall Specific Features is reserved for future use.) Click Next.
6 Click Next to start the uninstallation process. Follow the instructions on the screen to
remove the software. When the process is complete, click Finish.
Kofax, Inc. 17
Kofax Document Exchange Server Installation Guide for JBoss
18 Kofax, Inc.
Loading...