KOFAX Document Exchange Server 2.5 Installation Guide for WebLogic 10001816-000
2007-2009 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 Document Exchange Server Installation Guide...2 Software Installed with Kofax Document Exchange Server...2 Supported System Configurations...2 System Requirements...3 Managed Server Requirements...3 Operating System...3 Minimum Hardware Requirements...3 Certified VMWare Configurations...3 Certified VMWare Configurations...4 Open Ports...4 Client Requirements...4 Certified Web Browsers...5 Adobe Reader Requirement...5 Monitor Display Resolution...5 Pre-Installation Planning...5 Network Configuration Requirements...5 Cluster Planning...5 Installing on a Local Drive...5 Requirement for Free Hard Drive Space...5 Dedicated Server Requirement...6 Registry Access...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 Migrating from a Previous Version of Kofax Document Exchange Server on WebLogic...7 Installation Notes for 64-Bit Computers...7 Installing Kofax Document Exchange Server...7 Setting Environment Variables...7 Getting Oracle Connection Information...8 Creating Shared Folders...8 Sharing the Configuration Files...8 Installing the Kofax Document Exchange Server Components...9 Kofax, Inc. iii
Contents Installing on One Machine...9 Installing on Separate Machines (one or more managed servers on the same domain as the administration and proxy server)...10 Preparing an Oracle Database...12 Recovering from a SQL Failure...13 Configuring the install.properties File...13 Mandatory Settings...14 Java configuration...14 OS Configuration...14 Initial admin user to deploy license and workflow...15 Information about the WebLogic installation...15 Domain configuration...15 Cluster configuration...16 Managed servers configuration...17 Cluster URL configuration...20 Proxy server configuration...20 Server Java VM startup options...21 Oracle DB Configuration...21 Optional Custom Settings...22 About the Installation Scripts...23 Running the Installation Scripts...24 Install Managed Servers...25 Install a Proxy Server...25 Deploy the Proxy Server...26 Deploy Document Exchange Server...26 Special Instructions for Installing on Non-English Operating Systems...27 Recovering from Install Script Failure...27 Starting the Cluster...27 Viewing the Installation Log Files...28 Uninstalling Kofax Document Exchange Server...28 Adding New Managed Servers to a Cluster...29 install.properties: An Example...30 What s in Weblogic Administration Console?...34 What Needs to be Done After Installation?...34 Configuring for Oracle RAC...35 Create the XA Data Sources...35 Create the XA Multi Data Source...37 Create the Non-XA Data Sources...38 Create the Non-XA Multi Data Source...40 Reset the Persistent Stores Data Source...40 Configuring Destination Types...41 Deploying Connectors for Additional Destinations...42 Installing MFP Front Panel Software...45 iv Kofax, Inc.
Contents Other Configuration Tasks...45 What if Port 7001 is in Use: Changing the Admnistration Server Port...45 Changing the WebLogic Administrator Credentials...46 Stopping and Restarting Kofax Document Exchange Server...46 Troubleshooting...46 Technical Support...47 Kofax, Inc. v
Contents vi Kofax, Inc.
Introduction This guide includes instructions on installing Kofax Document Exchange Server with a WebLogic 9.2 MP3 (maintenance pack 3) 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. 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). 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. If you select to install Documentation during the setup process, the guide is installed with Kofax Document Exchange in the \Documentation folder. 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. If you select to install Documentation during the setup process, they are 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 Kofax, Inc. 1
media. If you choose to install documentation, they are installed with the software in the Documentation\Guides folder. Kofax Document Exchange Server Installation Guide These guides show how to install Kofax Document Exchange Server as a standalone or as a cluster. Kofax Fax Connector Installation Guide The Kofax Fax Connector Installation Guide provides installation and configuration instructions for the Kofax Fax Connector. If you select to install Documentation during the setup process, 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. The release notes are available for viewing or downloading from the Kofax Web site. Software Installed with Kofax Document Exchange Server The following software is installed with Kofax Document Exchange Server: To ensure the installation ant scripts can run as documented, a version of Ant is installed and added to the System path. 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. Bonjour: Software that discovers devices on a network. VirtualReScan (VRS): Kofax product for improving image quality. Supported System Configurations The following system configurations are supported. WebLogic 9.2 MP3 administration server and managed server installed on one machine Oracle 10g Release 2 database or Oracle RAC Shared network storage or Microsoft Cluster Server shared storage WebLogic 9.2 MP3 administration server and proxy server on one or two machines and one or more managed servers on separate machines. All machines must be in the same domain. Oracle 10g Release 2 database or Oracle RAC 2 Kofax, Inc.
Shared network storage or Microsoft Cluster Server shared storage Important There can be no spaces in the JRockit installation path (see Setting Environment Variables on page 7 for more information). Also, if you will be using a proxy server, the System path environment variable cannot contain any quotation marks. System Requirements The administration, proxy, and managed servers 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. Managed Server Requirements This section contains requirements for each managed server in the cluster, as well as the administration and proxy server machines. Important The Kofax Document Exchange Server installation for WebLogic does not support computer names with the underscore _ character in the name. Use only computer names that have letters, numbers, dashes, or periods. Or, if your computer name has underscores but can have a fixed IP address, you can use the IP address. Operating System Kofax Document Exchange Server requires either of the following versions of Microsoft Windows Server for production use: Windows Server 2003 Enterprise x64 Edition with Service Pack 2 Windows Server 2003 Enterprise x86 Edition with Service Pack 2 Windows Server 2003 Standard x64 Edition with Service Pack 2 Windows Server 2003 Standard x86 Edition with Service Pack 2 Minimum Hardware Requirements The cluster machines must meet the following minimum hardware requirements. 2 GHz Pentium 4 or compatible microprocessor 4 GB RAM 100/1000 Mbps network card (10 Mbps not supported) Certified VMWare Configurations Kofax Document Exchange Server supports the following host operating systems. For a list of the supported hardware for running VMWare, please refer to the VMWare installation guide available from the manufacturer's website. Kofax, Inc. 3
ESX Server version 3.5 Windows Server 2003 Enterprise x64 Edition with Service Pack 2 Windows Server 2003 Enterprise x86 Edition with Service Pack 2 Windows Server 2003 Standard x64 Edition with Service Pack 2 Windows Server 2003 Standard x86 Edition with Service Pack 2 VMWare Server 1.0.8 and 2.0 Windows Server 2003 Enterprise x86 Edition with Service Pack 2 Windows Server 2003 Standard x86 Edition with Service Pack 2 Certified VMWare Configurations The following VMWare configurations have been certified for Kofax Document Exchange Server. ESX Server version 3.5 Host Hardware: HP ProLiant DL360 G4 Dual Intel Xeon CPU 3.0 GHz with HT 6 GB RAM Internal Hard drives 100 MB NIC Operating System: Windows 2003 Server, Standard SP2 VMWare Server 1.0.8 and 2.0 Windows 2003 Server, Enterprise SP2 32 bit 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. Port 7001 must be available during the installation, but can be released after installation is complete. If you have an application that uses that port and the application can be temporarily configured to use another port, follow the instructions in What if Port 7001 is in Use: Changing the Admnistration Server Port on page 45. 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. Client Requirements This version of Kofax Document Exchange Server provides browser-based applications, Kofax Document Exchange and Kofax Administration Console, which require the following: 4 Kofax, Inc.
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. Monitor Display Resolution To view client software correctly in a browser, the monitor display resolution must be at least 1024 x 768 with 16-bit color and Normal fonts. Pre-Installation Planning This section contains information and options you should read, understand, and verify before starting the installation. 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. Cluster Planning The WebLogic cluster must have a unique IP address and listen port combination for each of its managed servers. Installing on a Local Drive The Kofax Document Exchange Server must be installed on a local drive, which can be any drive letter. Do not install the 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 Kofax, Inc. 5
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 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. 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. Restarting the Server Do not restart a machine manually while the 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 hyper threading 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. Workaround: Configure the VM as a dual virtual processor system. If the problem continues, set the BIOS of the host computer to turn off hyper threading. 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. 6 Kofax, Inc.
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. Migrating from a Previous Version of Kofax Document Exchange Server on WebLogic If you are using a previous version of Kofax Document Exchange Server, you must uninstall it before installing this version of Kofax Document Exchange Server. Tell users to release all of their documents in their Kofax Document Exchange Inbox before you migrate to the Kofax Document Exchange Server. There is no way to migrate Inbox documents after you have uninstalled the old version. If you use a directory service, this version of Kofax Document Exchange Server uses the samaccount name for authentication. The common name is no longer used, and there is no way to configure authentication using common name. Refer to the Kofax Document Exchange Server Administrator s Guide for information about connecting to directory services. 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 is installed in C:\Program Files (x86). All other files are installed in the installation path you specified. Installing Kofax Document Exchange Server This section provides the steps to install Document Exchange Server in a WebLogic cluster using an Oracle database or an Oracle RAC. You will create an administration server, an optional proxy server, and one or more managed servers. Follow the instructions in the exact order they are presented. You must log on to each machine as a user with Administrator rights to install Kofax Document Exchange Server Setting Environment Variables WebLogic 9.2 MP3 and JRockit should be installed on the administration server and all machines that will be in the cluster. You must manually set the correct System path environment variables on each machine in the cluster, including the administration and proxy servers, because the variables are not set automatically during the installation procedure. Kofax, Inc. 7
Important For 64-bit WebLogic installations, install JRockit first and to a path that does not have spaces, such as C:\bea. Kofax Document Exchange Server installation does not support spaces in the installation path, so the default WebLogic installation path of C:\Program Files cannot be used. On each machine, set the JAVA_HOME System path environment variable to the JRockit path: For 32-bit WebLogic systems, the default is C:\bea\jrockit_150_12 For 64-bit WebLogic systems, <installfolder>\jrockit-r27.5.0-jdk1.5.0_14 (note that if you have two JRockit folders, the variable is to the jdk not the jre). Then, add %JAVA_HOME%\bin to the System path environment variable. Getting Oracle Connection Information An Oracle 10g database or Oracle Real Application Cluster (RAC) is required. You can leverage Oracle RAC to improve both the scalability and availability of Kofax Document Exchange Server. Warning There is a known issue that the JMS server will require a restart if the database is shut down for a significant amount of time. For a single Oracle database, this might be approximately 2 minutes. With Oracle RAC, the problem is less severe because WebLogic will issue a connection retry in 15 seconds (the WebLogic default is 1 second, but Kofax Document Exchange Server installation configures this to 15 seconds), but the problem may still occur. Tip Oracle database and RAC configuration and tuning is critical for achieving optimal performance. We recommend you take advantage of the many diagnostic and tuning tools and resources that are available. Create an Oracle user account that will own the Kofax Document Exchange Server information. The user must also have privileges to create objects in the schema, as well as a quota on a default tablespace. You will provide this username and password later in the install.properties file. You will also provide the host name of the database server, the Oracle SID, and the Oracle port. Creating Shared Folders You need to create shared file storage locations for scanjobs and inbox content. The shared storage must be accessible to all the other machines in the cluster. There is no particular naming convention you must follow, as you will supply the UNC paths when you configure the install.properties file in a later step. In addition, the account that will be used to run the cluster must have read/write access to the shared storage locations. Note If you have clustered storage in a highly available environment, you can use Microsoft Cluster Server to create file shares accessible through a UNC path and then specify that path in the install.properties file. Sharing the Configuration Files There are many configuration files that are installed to the \conf folder in the root of the WebLogic domain. The Kofax Document Exchange Server Administrator s Guide has instructions on 8 Kofax, Inc.
how to use these files to customize your implementation. In a clustered environment, all managed servers in the cluster should use the same configuration settings. The recommended way to accomplish this is to maintain each managed server s local \conf folder and manage the files either manually or by using a centralized management tool. Another alternative is to create a network share, place the configuration files in that share, and specify the share location in a property in the install.properties file. When you create the share, the final location in the path must be a folder named \conf. Then, modify the avalin.domain.conf.path property in the install.properties file with a value of the full UNC path to the share, or UNC path to clustered shared storage location. After installation, if you need to change the location of the shared domain configuration folder, you can create the new share ending with \conf, copy the configuration files to the new location, and then edit the WeblogicDomainConf property in the \conf\des.properties file. Once the cluster is restarted, the new share will be used. Important If you use this method to share the configuration files and the network share fails, all of the servers in the cluster will be affected. Installing the Kofax Document Exchange Server Components This section provides instructions for installing Kofax Document Exchange Server, related components, and installation scripts. You will be running an installation program from the installation media. Follow the instructions that apply to your planned implementation: If you will be installing the administration server and a managed server on the same machine, see Installing on One Machine. If your administration server and managed servers are on separate machines, see Installing on Separate Machines (one or more managed servers on the same domain as the administration and proxy server) Installing on One Machine 1 Insert the Kofax Document Exchange Server installation media into your drive. 2 Browse to the \setup folder, and run setupweblogic.exe. 3 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. 4 You will be prompted to select features to install. Select all features (however, selecting to install Documentation is optional) and click Next to continue. Figure 2. Custom Installation Set: All Features Selected Kofax, Inc. 9
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 are case-insensitive, cannot include spaces, and the following characters are not permitted: ~ # % * \ ; / : &?. ', " ` $ < + > Passwords are case-sensitive and 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 Accept the default installation path, or choose another location. Click Next to continue. 7 Review the installation parameters and click Install to begin the installation. Note If you are installing on 64-bit OS, the installation of Bonjour is not a silent installation: you will be prompted to complete the Bonjour installation screens. Installing on Separate Machines (one or more managed servers on the same domain as the administration and proxy server) On the machine that will host the administration server Note If you will not have the administration server and proxy server on this same machine, you must repeat these installation steps on the proxy server machine. 1 Insert the Kofax Document Exchange Server installation media into your drive. 2 Browse to the \setup folder, and run setupweblogic.exe. The Introduction screen appears (Figure 3). Click Next. Figure 3. Kofax Document Exchange Server Installer Introduction Screen 10 Kofax, Inc.
3 On the License Agreement screen, review the license agreement and select I accept the terms of the License Agreement. Click Next to continue. 4 On the Choose Features screen, select all features except DES Prerequisites (however, selecting to install Documentation is optional) and click Next to continue. Tip The DES Prerequisites installation would install VRS, Bonjour, and other software that is not needed on the administration server. Figure 4. Custom Installation Set: DES Prerequisites Unselected 5 On the Initial Administrator screen, 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 are case-insensitive, cannot include spaces, and the following characters are not permitted: ~ # % * \ ; / : &?. ', " ` $ < + > Passwords are case-sensitive and 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 On the Choose Installation folder screen, accept the default installation path, or choose another location. Click Next to continue. 7 On the Pre-Installation Summary screen, review the installation parameters and click Install to begin the installation. Important Do not close the Installer window until the installation is complete. Interrupting the installation can leave the system in an unrecoverable state. 8 A screen indicates when the installation is done. Click Done to close the Installer. 9 Continue to the next step: installing the managed servers. Important You must perform the following installation steps on every managed server in the cluster. On each machine that will host a managed server 1 Insert the Kofax Document Exchange Server installation media into your drive. Browse to the \setup folder, and run setupweblogic.exe. Kofax, Inc. 11
2 On the License Agreement screen, review the Kofax Document Exchange Server license agreement and select I accept the terms of the License Agreement. Click Next to continue. 3 On the Choose Features screen, select all features except Administration Server Prerequisites (however, selecting to install Documentation is optional) and click Next to continue. Figure 5. Custom Installation Set: Administration Server Prerequisites Unselected 4 On the Choose Installation Location screen, accept the default installation path, or choose another location. Click Next to continue. 5 On the Pre-Installation Summary screen, review the installation parameters and click Install to begin the installation. 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. 6 A screen indicates when the installation is done. Click Done to close the Installer. 7 Repeat the installation on any additional managed servers. Preparing an Oracle Database Before configuring install.properties, the database administrator must run SQL scripts to create Kofax Document Exchange Server users in the Oracle database. Have the database administrator perform the procedure in this section. When the database administrator is finished, obtain the credential for the new user schema to use in configuring the install.properties file. To prepare an Oracle database 1 On the administration server, browse to the folder \AppServer\install\SQLScripts\oracle where Kofax Document Exchange Server was installed. 2 Edit the weblogic_oracle_jdbc.sql and drop_weblogic_oracle_jdbc.sql files according to the instructions in the files. Save and close the files. 3 Create an Oracle user that Kofax Document Exchange Server will use to access the database. 4 Run the scripts in the user schema you created in the following order: a create_oracle.sql b create_doctracking_oracle.sql c create_documents_oracle.sql 12 Kofax, Inc.
d e f weblogic_oracle_jdbc.sql create_des_users_oracle.sql create_des_oracle.sql Recovering from a SQL Failure To recover from SQL failure, the database administrator runs the drop scripts in the following order: 1 drop_weblogic_oracle_jdbc.sql 2 drop_documents_oracle.sql 3 drop_doctracking_oracle.sql 4 drop_oracle.sql The database administrator may reduce the new user privileges after running the scripts. Configuring the install.properties File You must modify some properties in the file install.properties before creating the Kofax Document Exchange Server WebLogic Server domain. Tip There are many properties in the file that do not need to be changed if your installation of WebLogic is in the default location, and you want to accept the default domain installation name, location, and other values. To see what lines you might need to modify, you can examine an example install.properties file in install.properties: An Example on page 30. On a managed server (it does not matter which one), browse to the folder \AppServer\install where Kofax Document Exchange Server was installed, and edit install.properties as directed in the following instructions. After you have finished editing the install.properties file, copy it to the same location (\AppServer\install) on every machine in the cluster, overwriting the existing file. Important In all Document Exchange Server configuration and properties files, file paths should always use forward-slashes. There are two areas in this section where the properties in this file are described: Mandatory Settings You must set these for a successful installation. Note that not all of the properties in a set are listed in this section, as some default values (such as the WebLogic installation path) are already included to make configuration easier. Java configuration Scanjob share location Inbox share location Initial admin user to deploy DES license and workflows WebLogic information home admin user name admin password Domain configuration administration server host name Kofax, Inc. 13
shared configuration path nodemanager user name nodemanager password Cluster information number of physical machines in the cluster (less admin or proxy) number of managed servers in the cluster Managed server configuration host names of each managed server Cluster configuration list of all managed servers in the cluster Proxy server configuration proxy server host name list of managed servers Java startup options use defaults for 32-bit: modify for 64-bit Oracle DB configuration host name user name password Optional Custom Settings Specific settings you can use to customize your domain, or if Weblogic is not installed on the default location. There are some properties in the file that are used for internal purposes only and should not be altered. These include some properties with values and also some that should be left blank. Do not alter any property unless directed to do so in the Mandatory or Optional Custom Settings sections. Important Passwords are encrypted in install.properties when you run the installation script or use the script to start or stop the cluster. If you need to change a password, type the new password in place of the encrypted one. The new password is encrypted the next time the cluster is started. After the new password has been encrypted in install.properties, copy the file to each of your managed servers. This ensures that all servers have the same install.properties file that contains the encrypted new password. Mandatory Settings This section explains the properties you must set for a successful implementation. Properties are listed under their commented grouping title in the file. Java configuration avalin.java.home Set this property to the location of your JRockit Java Virtual Machine. Remember to use forward slashes when entering file paths. OS Configuration des.scanjobsdir Set this property to the full UNC path of an available folder for use by Kofax Document Exchange Server to store temporary files. It is recommended that this be a network shared folder, as this folder must be accessible to all machines that will host servers that are part of 14 Kofax, Inc.
the Kofax Document Exchange Server WebLogic Server cluster. This folder must grant read/ write access to the account that will be used to run the cluster. If you are using a clustered storage in a highly available environment, you can use Microsoft Cluster Server to create the file shares and specify the UNC to the clustered storage. des.inboxdir Set this property to the full UNC path of an available folder for use by Kofax Document Exchange Server to store files for each user s inbox. It is recommended that this be a network shared folder as this folder must be accessible to all machines that will host servers that are part of the Kofax Document Exchange Server WebLogic Server cluster. This folder must grant read/write access to the account that will be used to run the cluster. If you are using a clustered storage in a highly available environment, you can use Microsoft Cluster Server to create the file shares and specify the UNC to the clustered storage. Initial admin user to deploy license and workflow startup.deployer.username Set this property to the user name previously provided to the Installer as the initial Kofax Document Exchange Server administrator. startup.deployer.password Set this property to the password previously provided to the Installer for the initial Kofax Document Exchange Server administrator. Information about the WebLogic installation bea.home Set this property to the location of your WebLogic installation folder. avalin.weblogic.admin.name Used to set the WebLogic administrator account name: this is the user name you will use to log on to the WebLogic Administration Console. The default value is weblogic. Note that the WebLogic administration name and password must be at least eight characters. avalin.weblogic.admin.password Used to set the WebLogic administrator account password. This is the password you will use to log on to the WebLogic Administration Console. The default value is weblogic. Domain configuration avalin.domain.host Set this property to the name of the machine that will run the administration server. If the computer name is bound to more than one IP Address, set this to the appropriate fixed IP Address instead of the computer name. Important The installation for WebLogic does not support computer names with the underscore _ character in the name. Use only computer names that have letters, numbers, dashes, or periods. Or, if your computer name has underscores but can have a fixed IP address, you can use the IP address. avalin.domain.conf.path Kofax, Inc. 15
Set this property to the location of the WebLogic domain \conf folder that contains the configuration files. By default, the value is the \conf folder in the des domain on each managed server. You can have all the managed servers in the cluster share a single configuration folder by creating a network or cluster share ending with a \conf folder and using the UNC path as the value for this property. See Sharing the Configuration Files for more information. avalin.nodemgr.logon.user Set this property to the user name of the Windows account to use to start the servers in the Kofax Document Exchange Server WebLogic Server cluster. The avalin.nodemgr.logon.user account must have all of the following: Be an account with Administrator rights on each machine in the cluster. A domain account is preferred. Important You cannot enter a domain account in the install.properties file (slashes are not supported). To use a domain account for the NodeManager service, follow the steps below. Log on as service rights on each machine in the cluster. To provide service rights, go to the Control Panel Administrative Tools Local Security Policy. Expand Local Policies, select User Rights Assignment, and then in the right panel select Log on as a service and add the user to the list. Read/write access to the WebLogic Document Exchange Server domain folder. Read/write access to the des.scanjobsdir and des.inboxdir folders specified in the OS Configuration section. If a shared configuration folder is used, read/write access to the \conf folder wherever it is located. To set a domain user account for NodeManager service 1 Set this property to a local user account that has the rights in the list above. Each machine in the cluster must have the same local account. 2 On the administration server after running the ant script install-admin-server, and on each managed server after running the ant script install-managed-server, do the following: a Go to the Services panel and manually change the login account for the des NodeManager service to a domain account that meets the criteria listed in the bullet list above. b Restart the service and resume the next step in the installation instructions. avalin.nodemgr.logon.password Set this property to the password of the user account specified in avalin.nodemgr.logon.user. Cluster configuration The following two properties are both required, and should have identical values. avalin.machines and avalin.managed.servers Set these properties to the number of managed servers in the Kofax Document Exchange Server WebLogic Server cluster. For each of the managed servers, there needs to be a set of properties in the next section Managed servers configuration. 16 Kofax, Inc.
Managed servers configuration avalin.managed.server.1 Set this property to the computer name of a machine that will be a managed server. Important If a computer name is bound to more than one IP Address, set avalin.managed.server.<number> to the IP Address that is accessed first by network services instead of the computer name. By default, this section of the install.properties file is set up to use three managed servers, so there is one set of properties for each server. Each set of properties begins with the line avalin.managed.server.n=myservern and ends with avalin.managed.server.1.channel1.client.certificate.enforced=false as shown here: avalin.managed.server.1=myserver1 avalin.machine.1.addresses=${avalin.managed.server.1} avalin.machine.1.nodemgr.host=${avalin.managed.server.1} avalin.machine.1.nodemgr.port=5556 avalin.managed.server.1.host= avalin.managed.server.1.port=8080 avalin.managed.server.1.ssl.port=8443 avalin.managed.server.1.cluster=1 avalin.managed.server.1.machine=1 avalin.managed.server.1.replicationgroup=group1 avalin.managed.server.1.domain.home=${avalin.domain.dir} avalin.managed.server.1.java.home=${avalin.java.home} avalin.managed.server.1.bea.home=${bea.home} avalin.managed.server.1.channel1.name=channel-http-80 avalin.managed.server.1.channel1.protocol=http avalin.managed.server.1.channel1.listen.port=80 avalin.managed.server.1.channel1.external.listen.port=80 avalin.managed.server.1.channel1.enabled=true avalin.managed.server.1.channel1.client.certificate.enforced=false avalin.managed.server.n.< lines two through the end of a set> Set the number values n in all the lines in a set to the same number, which must be unique to the managed server. For example, you could set the first managed server s number values to 1, the second managed server number values to 2, etc. as in the following examples. avalin.managed.server.1.cluster=1 Do not change this value: you will be installing only one cluster, so this value needs to be 1. avalin.managed.server.1.channel1.protocol=http Do not change any of the six channel values in each section: this value needs to be 1 for all managed servers in the cluster. Examples One managed server: avalin.managed.server.1=myserver1 avalin.machine.1.addresses=${avalin.managed.server.1} avalin.machine.1.nodemgr.host=${avalin.managed.server.1} avalin.machine.1.nodemgr.port=5556 avalin.managed.server.1.host= Kofax, Inc. 17
avalin.managed.server.1.port=8080 avalin.managed.server.1.ssl.port=8443 avalin.managed.server.1.cluster=1 avalin.managed.server.1.machine=1 avalin.managed.server.1.replicationgroup=group1 avalin.managed.server.1.multicastinterfaceaddress= avalin.managed.server.1.domain.home=${avalin.domain.dir} avalin.managed.server.1.java.home=${avalin.java.home} avalin.managed.server.1.bea.home=${bea.home} avalin.managed.server.1.channel1.name=channel-http-80 avalin.managed.server.1.channel1.protocol=http avalin.managed.server.1.channel1.listen.port=80 avalin.managed.server.1.channel1.external.listen.port=80 avalin.managed.server.1.channel1.enabled=true avalin.managed.server.1.channel1.client.certificate.enforced=false Two managed servers: avalin.managed.server.1=myserver1 avalin.machine.1.addresses=${avalin.managed.server.1} avalin.machine.1.nodemgr.host=${avalin.managed.server.1} avalin.machine.1.nodemgr.port=5556 avalin.managed.server.1.host= avalin.managed.server.1.port=8080 avalin.managed.server.1.ssl.port=8443 avalin.managed.server.1.cluster=1 avalin.managed.server.1.machine=1 avalin.managed.server.1.replicationgroup=group1 avalin.managed.server.1.multicastinterfaceaddress= avalin.managed.server.1.domain.home=${avalin.domain.dir} avalin.managed.server.1.java.home=${avalin.java.home} avalin.managed.server.1.bea.home=${bea.home} avalin.managed.server.1.channel1.name=channel-http-80 avalin.managed.server.1.channel1.protocol=http avalin.managed.server.1.channel1.listen.port=80 avalin.managed.server.1.channel1.external.listen.port=80 avalin.managed.server.1.channel1.enabled=true avalin.managed.server.1.channel1.client.certificate.enforced=false avalin.managed.server.2=myserver2 avalin.machine.2.addresses=${avalin.managed.server.2} avalin.machine.2.nodemgr.host=${avalin.managed.server.2} avalin.machine.2.nodemgr.port=5556 avalin.managed.server.2.host= avalin.managed.server.2.port=8080 avalin.managed.server.2.ssl.port=8443 avalin.managed.server.2.cluster=1 avalin.managed.server.2.machine=2 avalin.managed.server.2.replicationgroup=group1 avalin.managed.server.2.multicastinterfaceaddress= avalin.managed.server.2.domain.home=${avalin.domain.dir} avalin.managed.server.2.java.home=${avalin.java.home} avalin.managed.server.2.bea.home=${bea.home} avalin.managed.server.2.channel1.name=channel-http-80 avalin.managed.server.2.channel1.protocol=http 18 Kofax, Inc.
avalin.managed.server.2.channel1.listen.port=80 avalin.managed.server.2.channel1.external.listen.port=80 avalin.managed.server.2.channel1.enabled=true avalin.managed.server.2.channel1.client.certificate.enforced=false Three managed servers: avalin.managed.server.1=myserver1 avalin.machine.1.addresses=${avalin.managed.server.1} avalin.machine.1.nodemgr.host=${avalin.managed.server.1} avalin.machine.1.nodemgr.port=5556 avalin.managed.server.1.host= avalin.managed.server.1.port=8080 avalin.managed.server.1.ssl.port=8443 avalin.managed.server.1.cluster=1 avalin.managed.server.1.machine=1 avalin.managed.server.1.replicationgroup=group1 avalin.managed.server.1.multicastinterfaceaddress= avalin.managed.server.1.domain.home=${avalin.domain.dir} avalin.managed.server.1.java.home=${avalin.java.home} avalin.managed.server.1.bea.home=${bea.home} avalin.managed.server.1.channel1.name=channel-http-80 avalin.managed.server.1.channel1.protocol=http avalin.managed.server.1.channel1.listen.port=80 avalin.managed.server.1.channel1.external.listen.port=80 avalin.managed.server.1.channel1.enabled=true avalin.managed.server.1.channel1.client.certificate.enforced=false avalin.managed.server.2=myserver2 avalin.machine.2.addresses=${avalin.managed.server.2} avalin.machine.2.nodemgr.host=${avalin.managed.server.2} avalin.machine.2.nodemgr.port=5556 avalin.managed.server.2.host= avalin.managed.server.2.port=8080 avalin.managed.server.2.ssl.port=8443 avalin.managed.server.2.cluster=1 avalin.managed.server.2.machine=2 avalin.managed.server.2.replicationgroup=group1 avalin.managed.server.2.multicastinterfaceaddress= avalin.managed.server.2.domain.home=${avalin.domain.dir} avalin.managed.server.2.java.home=${avalin.java.home} avalin.managed.server.2.bea.home=${bea.home} avalin.managed.server.2.channel1.name=channel-http-80 avalin.managed.server.2.channel1.protocol=http avalin.managed.server.2.channel1.listen.port=80 avalin.managed.server.2.channel1.external.listen.port=80 avalin.managed.server.2.channel1.enabled=true avalin.managed.server.2.channel1.client.certificate.enforced=false avalin.managed.server.3=myserver3 avalin.machine.3.addresses=${avalin.managed.server.3} avalin.machine.3.nodemgr.host=${avalin.managed.server.3} avalin.machine.3.nodemgr.port=5556 avalin.managed.server.3.host= avalin.managed.server.3.port=8080 Kofax, Inc. 19
avalin.managed.server.3.ssl.port=8443 avalin.managed.server.3.cluster=1 avalin.managed.server.3.machine=3 avalin.managed.server.3.replicationgroup=group1 avalin.managed.server.3.multicastinterfaceaddress= avalin.managed.server.3.domain.home=${avalin.domain.dir} avalin.managed.server.3.java.home=${avalin.java.home} avalin.managed.server.3.bea.home=${bea.home} avalin.managed.server.3.channel1.name=channel-http-80 avalin.managed.server.3.channel1.protocol=http avalin.managed.server.3.channel1.listen.port=80 avalin.managed.server.3.channel1.external.listen.port=80 avalin.managed.server.3.channel1.enabled=true avalin.managed.server.3.channel1.client.certificate.enforced=false If you have fewer than three managed servers, delete extra sets accordingly. If you have more than three managed servers, copy a set, paste below the last existing set, and change the values. Cluster URL configuration wls.cluster.url Set this property as a comma-delimited list of all the managed servers in the cluster. The list will have one entry ${avalin.managed.server.1}:${avalin.managed.server.1.port} for each managed server, as shown in the following examples. Example One managed server: ${avalin.managed.server.1}:${avalin.managed.server.1.port} Two managed servers: ${avalin.managed.server.1}:${avalin.managed.server.1.port},${avalin.manag ed.server.2}:${avalin.managed.server.2.port} Three managed servers: ${avalin.managed.server.1}:${avalin.managed.server.1.port},${avalin.manag ed.server.2}:${avalin.managed.server.2.port},${avalin.managed.server.3}:$ {avalin.managed.server.3.port} Proxy server configuration avalin.machine.proxyserver.addresses Set this property to the name of the machine that will run the WebLogic Server cluster proxy server. If the computer name is bound to more than one IP address, set this to the appropriate IP address instead of the computer name. avalin.machine.proxyserver.ip If you are using a proxy server, set this property to the IP address of the proxy server. If you are not using a proxy server, you must leave this property blank. avalin.machine.proxyserver.nodemgr.host Set this property to the same value as avalin.machine.proxyserver.addresses. avalin.managed.servers.list 20 Kofax, Inc.