Professional Documents
Culture Documents
SERVER
June 2014
ELO Digital Office GmbH
http://www.elo.com
Copyright 2014 ELO Digital Office GmbH
All rights reserved
E090-HBSB-EN
[02.06.2014-09:52 - en - 9.0]
Table of Contents
Preface........................................................................................... 5
Welcome......................................................................................................... 7
Conventions....................................................................................................8
Installation preparation...........................................................17
ELO installation software......................................................................... 20
Installation checklist.................................................................................. 21
ELOenterprise 9 Server............................................................ 90
Apache Tomcat Installation.................................................................... 97
Tomcat memory adjustment................................................................109
ELO OCR Service installation................................................................ 112
ELOenterprise server installation.........................................................117
Updating ELOenterprise........................................................259
ELO Viewer............................................................................. 274
ELO Windows Client.............................................................. 277
Standard Client Installation.................................................................. 279
Automatic Client Installation................................................................286
Appendix.................................................................................. 309
Additional Installation Information....................................................310
Directory Access Rights.......................................................................... 311
Parameters in config.xml.......................................................................313
Log Files......................................................................................................317
Third-Party Licenses................................................................................ 319
Further references................................................................................... 320
Index.......................................................................................... 321
Table of Contents
Preface
Important Information
Copyright Notices
ELO Digital Office GmbH is the copyright holder for this program,
manual, and all other relevant documentation. These products
may only be used and copied in accordance with the License
Agreements.
It is illegal to wholly or partly copy, reproduce, or distribute ELO
server software as a full version.
No part of this manual may be reproduced, transmitted, translated or otherwise duplicated without the prior written consent of
ELO Digital Office GmbH. The contents of this manual in no way
represent an entitlement on the part of the purchaser. The contents of this manual have been diligently prepared, however the
accuracy of the content cannot be guaranteed. ELO Digital Office
GmbH accepts no liability for any damages resulting from the use
of this product or documentation. The details of this product are
subject to change without notice.
Preface
Trademarks
ELOenterprise 9 Server and ELOprofessional 9 Server are registered trademarks of ELO Digital Office GmbH.
Microsoft Windows, Microsoft Word and Microsoft Excel are
registered trademarks of Microsoft Corporation. All other product names are protected by copyright and are registered trademarks/brand names of their respective owners. The use of trademarks, brand names and product names in this manual does not
imply that such names are not protected by copyright
Disclaimer
Every effort has been made to ensure that this product is as accurate as possible. However, as we are continuously developing ELO
SERVER and are undertaking development on several parallel versions, the program is subject to change without notice. In certain
circumstances minor errors or inaccuracies may, therefore, occur
in the content of this manual. We would like to apologize in advance for any inconvenience this may cause. Visit the ELO website
to find the latest versions of ELO documentation.
Preface
Welcome
ELO - the leader in
document management software
This document describes in detail how to install and run the standard ELO server software components and associated modules.
Both the installation of ELOenterprise and ELOprofessional are described in the following. This document also includes notes on
updating server applications that are already installed. Additional
components that require the purchase of supplemental licenses,
such as ELO DocXtractor or ELO for Sharepoint, are not included
in this guidebook. For notes on how to maintain and optimize the
server applications, please consult the other ELO documentation,
the ELO Support Forum, or the ELO Support Department.
Preface
Conventions
The manual contains numerous notes, instructions and suggestions for program dialog boxes, menu items and tips. The following conventions are followed in this documentation:
Notes
Please note: This information should be noted to ensure the program runs without problems.
Italics
Upper case
Keyboard shortcuts are printed in UPPER CASE. A plus sign (+) between the key descriptions means the keys should be pressed simultaneously. Keys that should be pressed in sequence are designated by a comma (,). Example: CTRL + C
Bold
Courier
Program code, program input and output, and scripts are shown
in Courier font. Example: MsgBox "Hello world!"
Preface
The image above shows the ELO server and clients along with the
protocols used to communicate among them. Though the image
may seem intimidating at first glance, it can be very helpful in understanding the ELO system as a whole.
ELO server fundamentals
10
The ELO system requires a webserver and a database to run at minimum. The supported database types are Microsoft SQL Server, Oracle, and IBM DB2. Most of the time, you will not need to interact with the database directly after it is installed, so these databases are described more specifically in a later chapter. For the webserver, ELO uses Apache Tomcat to manage and deliver archive
services to the clients. The four main components of the Tomcat
server engine are the ELO Indexserver, Access Manager, Document
Manager, and Fulltext module.
The ELO Access Manager is the gatekeeper to all users and pieces
of information in ELO. The ELO Windows Client accesses the Access Manager directly for user authentication, but all other clients
log on via the Indexserver, which forwards such requests to the
Access Manager.
ELO Indexserver
The ELO Indexserver is the point of contact to the ELO server applications for most ELO clients. The ELO Administration Console,
Java Client, Web Client, ELO for Mobile Devices, and other applications log on via the Indexserver and perform requests through
the proprietary Indexserver interface. Hence if the Indexserver is
not running properly, most ELO clients will fail to function as well.
The ELO Windows Client, which is based on somewhat older technology, will not be significantly affected - only a few components
like iSearch will be disabled.
11
Microserver architecture
Architecture
Logging on
12
Document storage
13
Fulltext
14
An optional Fulltext module can be installed for each archive (Document Manager). If the Fulltext module is required for more than
one archive, it must be installed once for each of the archives. The
multiple instances can be installed on a single central computer
or can be distributed between a number of computers. Each Fulltext module also requires an individual textreader instance. The
Textreader instance or instances can also be installed on a central
computer or distributed between a number of computers. In order to provide this modularity, the Fulltext and Textreader modules must be installed separately.
Scalability
15
16
Installation
preparation
Operating system information
System requirements
User accounts
Installation preparation
17
The New User dialog box appears. Enter a name for the service
user (for example, "EloService") and a password. Clear the checkbox for User must change password at next logon and select the
box for Password never expires. Create the new user with OK.
18
Installation preparation
If the option of User must change password at next logon is selected for a service account, you must log on with that account manually and change the account password before it can be used. If this
is not done, services associated with that account will not start.
Installation preparation
19
Step
1
2
3
4
5
6
20
Instructions
Create your installation checklist.
Install an SQL server.
Install Java.
Notes
Only on ELOenterprise
Install Apache Tom- Only on ELOentercat.
prise
Install ELO OCR Ser- Only on ELOentervice.
prise (optional)
Install ELO server.
Installation preparation
Installation checklist
Before you install ELO, create a checklist of information required
by the system to function. Keep this information secure and decide
on the settings before starting the installation process. You may
not need all of the information listed below for your installation use it as a general guide.
Accounts
Database service
Database accounts:
ELO accounts:
Administrator
Tomcat accounts:
Administrator (manager-gui)
Database
Tomcat
Installation preparation
Computer name
Database port
Port
Version
21
Installation prerequisites
22
23
24
25
26
The next screen lists Microsoft's license terms. Accept them and
click Next.
27
The next screen shows you whether Product Updates have been
found, which can be installed automatically with the server. If you
choose to install the updates with the server, the installer will
download the files after clicking Next. Click Next to continue.
28
In the final screen of this step, the setup program prepares the
installation files along with any updates chosen in the previous screen. It continues automatically to the Setup Support Rules
screen without further user input.
29
Please note: Before configuring the SQL server, it is recommended to create a separate user account in Windows for running the
SQL Server service. Instructions for doing this can be found at the
beginning of the chapter under User accounts.
The setup initially checks the system and displays the Setup Support Rules again. Click Next and continue through the Product Key
and License Terms screens to the Setup Role screen. ELOenterprise
only requires certain server features to be installed. Select SQL
Server Feature Installation and click Next.
30
On the Feature Selection screen, the installation paths can be modified and the specific SQL server components can be individually
selected. ELOenterprise server and ELOprofessional server requires
the installation of both the Database Engine Services and the Management Tools - Complete. The analysis and reporting services can
be additionally installed if desired. Click Next to proceed.
31
The Installation Rules screen indicates that the setup has checked
whether the desired features can be installed on the system. If the
tests on this screen all show Passed, the database should install
properly. Click Next to continue.
32
33
The next window shows the amount of disk space required for
installation. If the server has sufficient free disk space, click Next
to continue.
34
35
36
You can specify the default directories for this SQL server instance
on the Data Directories tab. The directories include the Data Root
Directory, System Database Directory, User Database Directory, User
Database Log Directory, Temp DB Directory, Temp DB Log Directory, and Backup Directory. You can keep the default settings if you
wish.
Please check whether the data directories exist and are correct.
Create the correct directories as needed.
The next tab of the Database Engine Configuration is the
FILESTREAM. FILESTREAM can be enabled if needed. Consult the
Microsoft documentation for more information on this topic.
After configuring the database engine, click Next to continue.
37
At this point, the setup checks whether all conditions for successful installation have been met. Assuming all tests show Passed,
click Next to continue.
38
Click Next to open the Ready to Install screen, which shows all
details of the SQL server to be installed. Click Install to install Microsoft SQL Server 2012.
39
Click Next. Use the Installation Progress page of the SQL 2012 server installation wizard to monitor the status of the SQL Server Setup.
40
On the Complete page, review the location of the SQL server summary upgrade log file and additional items. Click Close to finalize
the installation.
Please note: At this point the SQL server is fully installed. The following section, "Creating database user elodb", only needs to be
followed if you are installing ELOenterprise. If you are installing
ELOprofessional, you can skip the following section and continue
to the ELOprofessional installation chapter. The elodb user can be
created automatically when ELOprofessional is installed.
Creating database
user elodb
41
42
43
Switch to the Server Roles page and activate the server role dbcreator. Click OK to create the elodb database user.
Close the SQL Management Console to begin installing the ELO
server components.
44
ELOprofessional 9
server
ELOprofessional 9
server installation
This chapter describes how to install and update the ELOprofessional 9 server. Instructions for installing additional components
can be found on the ELO DVD or ELO SupportWeb.
Place the ELOprofessional DVD in your DVD drive. If the start program does not start automatically, navigate to the DVD and run
Start.exe.
Start.exe opens a browser menu, showing you the following
screen. Select the entry for Basic Installation:
From there, click the entry for Server Installer for Windows.
ELOprofessional 9 server
45
Run Setup.exe.
46
ELOprofessional 9 server
ELOprofessional 9 server
47
Choose the installation directory. If you need to use a different directory than the default directory, click Browse... to select another
location. Click Next to continue.
48
ELOprofessional 9 server
Either accept the default ports for the Application Server or enter
different ones. Click Next to continue.
You can check whether the default ports are open on your computer by entering netstat -aon | find "9090" to the Windows command line. Check ports 9091 and 9092 in the same way.
ELOprofessional 9 server
49
50
ELOprofessional 9 server
ELOprofessional 9 server
51
52
ELOprofessional 9 server
The installer for the server-based OCR service starts. Click Next to
continue.
ELOprofessional 9 server
53
Select the directory in which you want to install the ELO OCR service. Click Next to continue.
54
ELOprofessional 9 server
Click Install to install the ELO OCR service. This will take a few minutes to complete.
ELOprofessional 9 server
55
After the OCR service has successfully installed, the above screen
appears. Click Finish to continue installing ELOprofessional.
56
ELOprofessional 9 server
The installation routine now takes a few minutes to install files before opening a new window. Select the directory where Tomcat
will be installed, which is the basis for the ELO Application Server. The default path is recommended, but it can be changed with
Browse... if desired. Click Next to continue.
Select the language for database entries. The setting chosen here
affects:
ELOprofessional 9 server
57
58
It may also be useful to use an alias name for the database server
rather than the computer name of the SQL server on the network.
Alias names are managed from the domain controller and can
significantly reduce downtimes and administrative effort when
changing servers, for example.
If you are installing ELO to a database instance rather than
the main database account, enter the server name, followed
by a backslash, followed by the instance name. For example:
SQLSERVER\ELOSQL01.
If you did not create a database user for ELO previously, you can
use the setup program to do this for you now. This will create a
user automatically that has all the required rights for ELO. Click
Create database account to create the ELO database user.
ELOprofessional 9 server
59
A dialog box opens to verify the password for the new database
user. It is also necessary to enter the authentication for the administrator account established when the SQL server was installed.
Click OK to close this dialog box, then click Next to continue.
60
ELOprofessional 9 server
Oracle
Enter the database settings for Oracle and the password for the
database account. Click Next to proceed.
IBM DB2
ELOprofessional 9 server
61
Enter the database settings for DB2 and the password for the
database account. Click Next to proceed.
All database types
Next, enter a name for the new archive in the Settings Window.
Before clicking Next to continue, select whether you want to keep
the default application settings or use custom settings.
If Custom application settings was chosen in the previous dialog,
two additional dialog windows are shown.
62
ELOprofessional 9 server
In the first, enter the paths to the data root directory, the archive,
and the search index. Next you can define the name of the ELO
service user with administrator rights. Please note the information
below regarding the "Administrator" account. Underneath you
can change the settings for the number of simultaneous database
connections for ELOam, ELOdm, and ELOix. The default number
of database connections will work in most environments, but may
provide insufficient speed if a large number of ELO users are anticipated.
As a rule of thumb, you should set the number of simultaneous
database connections for ELOam and ELOdm to 1-3% of the expected simultaneous users of ELO. Note that any number less than
3 will result in significantly reduced ELO performance. Increasing
the number of database connections will also result in increased
static RAM usage, so this setting may need to be adjusted to find
the setting that guarantees optimum performance.
ELOprofessional 9 server
63
64
ELOprofessional 9 server
You may install the ELO Web Client along with ELOprofessional if
you wish. Depending on your license, the type of Web Client installed may be limited to access via mobile devices, or it may support ELO access via any modern browser. However, installing the
ELO Web Client means the server will require more memory to run.
See the ELO Web Client manual for more information.
ELOprofessional 9 server
65
66
ELOprofessional 9 server
ELOprofessional 9 server
67
The final window of the installation routine notifies you that the
service user was created and that the iSearch search indexer will
only start to run after 24 hours have passed. This delay allows you
to perform additional administrative tasks before this automated
task starts working. If you need the indexer to start immediately,
please see the chapter below on installing ELO iSearch to see how
to manually re-index the iSearch database.
You can now install and configure additional ELO components as
needed.
68
ELOprofessional 9 server
A new function called Create external link was added to the ELO
Java Client in ELOprofessional 9. This function shares documents
within an ELO archive with persons who do not have an ELO user
account. When the ELOprofessional server is first installed, however, these "external" links only work with computers that are located within the same network or domain as the ELO server. In order to share ELO documents via this function with all computers
with an Internet connection, proceed as follows.
1. Assign a fixed IP address to the computer on which the ELOprofessional server is running. Depending on your network settings,
you may need to change various settings on your network controller and/or firewall to make sure the ELO server can be reached
by the Internet.
2. Open the ELOprofessional Application Server Manager and click
the entry for the Indexserver to open its status page:
3. Click the entry for the Indexserver to open its status page. The
entry is highlighted in red in the image above.
ELOprofessional 9 server
69
5. The ELOprofessional setup program normally sets the ixUrlBase option for the Indexserver to the following format: http://
<computer name>:<server port>/ix-<archive name>/
ix. Replace the computer name with the fixed IP assigned to the
ELO server. Click Save, then Reload to save the change and then
apply it to the server.
70
ELOprofessional 9 server
If ixUrlBase has not been set for your Indexserver, you can add it
to the list via the drop-down menu in the last line of the table. Enter the value as described above, then click Add to add the option
to the list. Click Save and Reload afterwards to apply the setting.
ELOprofessional 9 server
71
Use the newest release DVD of ELOprofessional. This updates Java, Tomcat, and the ELOprofessional server all at
the same time.
2. Place the ELOprofessional DVD in the ELO server's DVD drive and
run Start.exe.
3. Navigate to the Basic Installation tab and click Server Installer
for Windows. If the server is running a 32-bit version of Windows,
open a command window and enter the following command:
<drive letter>\Start\Server\Basis\Install\Server_Windows
\setup.exe -X86
72
ELOprofessional 9 server
3. Download the newest version of the ELOprofessional Server Setup files from the ELO SupportWeb. Extract the ZIP file to the following directory:
<ELOprofessional>/prog/serversetup/
ELOprofessional 9 server
73
74
ELOprofessional 9 server
7. A confirmation dialog box appears if you select the correct directory. This confirmation notifies you that the installer has found
an existing ELO installation and asks to overwrite the existing files
there. Click Yes to confirm.
ELOprofessional 9 server
75
76
ELOprofessional 9 server
ELOprofessional 9 server
77
10. Select an installation directory for the OCR service and click
Next.
78
ELOprofessional 9 server
11. Click Install to install the OCR service. After it completes, the
ELO server update continues.
12. Select the ELO Application Server directory, then click Next to
continue.
ELOprofessional 9 server
79
13. A selection screen appears with Update all applications selected by default. Click Next to continue.
14. An update notice appears. If you have proceeded with the update according to the instructions here, you do not need to perform any additional steps. Click Next to continue.
80
ELOprofessional 9 server
15. Select the language for database entries. This must be the
same language used when the server was first installed. The correct entry should be selected by default. Click Next to continue.
16. Select the type of database already in use by ELO. The correct
entry should be selected by default. Click Next to continue.
ELOprofessional 9 server
81
82
ELOprofessional 9 server
18. A dialog box appears in which you can update the ELOprofessional serial number. If you are upgrading to a new full version of
ELO (such as from ELOprofessional 2011 to 9), it is necessary to
update the serial number. Click Next to continue.
19. The update program gives you the ability to install some new
programs if they are not installed already. Click Next to continue.
If you are not installing any additional applications, you can skip
to step 23 now.
ELOprofessional 9 server
83
20. Enter the search index directory for ELOis, followed by the ELO
server name. An alias can be used for the server name. Click Next
to continue.
21. Enter the user name and password for an existing ELO user. It is
recommended to use the ELO service user. Click Next to continue.
84
ELOprofessional 9 server
23. The Input Complete screen appears. You can go back and
change your input for steps 12-22 by clicking Back now. Click Next
to install the updates.
ELOprofessional 9 server
85
24. The update is performed and shows the progress of the update
as it occurs. If any errors occur, attempt to correct them and then
run the update program again. Click Next to continue.
If errors occur and you need to repeat the update, you do not need
to run it from the DVD. You can run it from the serversetup directory (see following section), which skips the Java and ELO Application Server update.
86
ELOprofessional 9 server
25. Any final notes regarding the installation are shown on this
screen. Read through these notes to see if any additional steps are
required. Click Finish to close the ELOprofessional Server Setup.
Manual application
update
There are several ways to update ELOprofessional server applications. In ELOprofessional 2011 and earlier, the applications
were extracted to separate directories, complicating the update
process. Starting with ELOprofessional 9, the WAR files that contain the ELO applications are loaded dynamically to Tomcat at runtime. To update ELOprofessional 9 server applications, proceed as
follows:
The ELO Application Server does not need to be stopped to perform an update in this way. However, increased server RAM will
be required until the ELO server is restarted. It is recommended to
perform a server restart after performing an ELO application update as soon as it is convenient to do so.
1. Download the new ELO application from the ELO SupportWeb.
See the included documentation for any dependencies between
the application and other ELO server applications or client programs. Also check whether the configuration files for the application need to be changed.
2. Navigate to the directory:
ELOprofessional 9 server
87
<ELOprofessional>/prog/webapps/
Check to see that the application you want to update already exists in this directory. Each ELO application uses a special abbreviation (such as dm.war for the ELO Document Manager, ix.war for
the Indexserver, and so on.
If the updated application is not located in this directory, use the
update method following this one titled Manual update with
transfer directory.
3. Extract the updated ELO application to your hard drive and rename it (if necessary) so it has the same name as the old ELO application.
4. Copy the updated ELO server application to the prog/webapps
directory so that it overwrites the old application.
5. Tomcat will automatically load the updated application to
memory. Check the status page of the updated application in your
browser in the ELOprofessional Server Manager. If the application
has a status of Running and no errors are displayed, the application has updated successfully.
Manual update with
transfer directory
88
ELOprofessional 9 server
ELOprofessional 9 server
89
ELOenterprise 9 Server
General note
The following chapters provide installation notes for ELOenterprise. If you installed ELOprofessional in the previous chapter, you
can skip the following chapters, since the ELOprofessional setup
program installs Java, Tomcat, and the ELO server components automatically.
Java installation
90
ELOenterprise 9 Server
ELOenterprise 9 Server
91
92
ELOenterprise 9 Server
ELOenterprise 9 Server
93
94
ELOenterprise 9 Server
ELOenterprise 9 Server
95
Solaris
96
ELOenterprise 9 Server
Tomcat ports
ELOenterprise 9 Server
97
Oracle 9 and later uses port 8080 for XML access. This can be
changed in the Oracle Enterprise Manager Console.
Starting the Tomcat
Installation
98
ELOenterprise 9 Server
ELOenterprise 9 Server
99
You must accept the terms and conditions in the License Agreement by clicking I Agree to continue. You can now select the components you want to install.
The Service Startup and Manager components are required and
must be selected. Clear the option for Native operation. If you are
installing for a productive system, clear the option for Examples as
well to ensure secure and stable operation. The other components
are optional. The selection of non-default components automatically switches the installation type to Custom.
100
ELOenterprise 9 Server
ELOenterprise 9 Server
101
The server shutdown port is used to shut down the ELO Application Server remotely. Its default value is 8005. If you observe that
your ELO server does not appear to start normally, double-check
to see that the server shutdown port is not in use by another application.
The HTTP/1.1 connector port is the port used to connect to the
ELO Application Server applications. The default value for the port
is 8080, but this can be changed as needed.
The AJP/1.3 connector port is primarily relevant to environments
where the Tomcat Java web applications are integrated into a web
interface that also contains static content. It is not used by ELO
and therefore does not necessarily need to be free for ELO to work
properly. Consult the Apache Tomcat documentation for more information on this feature.
Any name can be chosen as the Windows service name. It can be
seen in Windows Services by clicking the start menu in Windows
and entering services.msc. Use a name like ELOenterprise here to
more easily distinguish it from other running services.
102
ELOenterprise 9 Server
At the bottom, enter a user name and password for the administrator and make sure that this information is also on your installation checklist. After entering this data, click Next to continue to
the Java Virtual Machine window.
The Tomcat users and passwords are stored in plaintext in <Tomcat install directory>\conf\tomcat-users.xml. This
is useful if you lose the paper copy of this information and need to
regain access to the Tomcat Manager interface, but it also increases your security requirements. Make sure that the directory is not
shared on the network, and especially that it cannot be reached
on the Internet.
ELOenterprise 9 Server
103
Please note: The increased attention paid to security in newer versions of Windows (after XP) complicates the administration of ELO
and Tomcat if they are installed to the Program Files directory. For
this reason, we recommend installing Tomcat outside of the default Program Files directory.
After entering all necessary information, start installing Tomcat by
clicking Install.
104
ELOenterprise 9 Server
After installation has completed, ensure Run Apache Tomcat is selected in the final dialog box before clicking Finish.
ELOenterprise 9 Server
105
Once Tomcat has started, its icon should appear in the notification
area of the taskbar. A green arrow indicates that the service is running. If the icon is red, this means that the service is not running.
If the icon remains red, right-click the icon and select Start service
from the context menu.
Fig. Tomcat taskbar indicator: service stopped (left), service started (right)
106
ELOenterprise 9 Server
After successfully installing Tomcat, it will use the local system account by default. This is not optimal for security purposes. Rightclick the Tomcat icon on the desktop and select Configure..., then
go to the Log On tab. Enter the logon details for a non-administrator user (ideally created specifically for Tomcat) to This account.
Tomcat - Linux installation
ELOenterprise 9 Server
107
As user tomcat:
Enter the command su tomcat and navigate to the bin folder
in the terminal. Run startup.sh or shutdown.sh.
When starting Tomcat as a daemon, you can set start error messages to be written to the log file. In SUSE Linux, the log file is
found at:
/usr/share/tomcat/logs
The installation log file produced by Tomcat can also be found in
the /logs folder.
To test whether the installation has been successful, open a web
browser and enter the following to the address bar:
http://localhost:8080/
If Tomcat was installed correctly, you will see the Tomcat start
screen.
Please note: in order to start the Tomcat Manager with Tomcat
7.0 or later, a user with the role manager-gui must be present in
<Tomcat install directory>\conf\tomcat-users.xml.
This user is created automatically when Tomcat is installed in Windows, but you may need to create it manually in Linux. Use the
following syntax to create the user:
<user
username="admin"
roles="manager-gui"/>
Solaris
108
password="password"
ELOenterprise 9 Server
MaxPermSize = 350 MB
If you continue to see PermGen errors in your log files, you can increase the values further. For optimal performance, MaxPermSize
should be about one-third of the Maximum memory pool.
Windows
There are two ways to adjust these values in Windows: via the
Tomcat server properties and via the registry.
To open the Tomcat properties, right-click the Tomcat tray icon
and select Configure or run Configure Tomcat from the start menu.
The Apache Tomcat Properties window opens. Navigate to the Java tab.
ELOenterprise 9 Server
109
In the Java Options field, enter the following line at the end of the
options:
-XX:MaxPermSize=350m
If you are running a 32-bit server, leave out the Wow6432Node portion of the path.
110
ELOenterprise 9 Server
The setting for the Maximum memory pool is stored in hexidecimal format to the JvmMx parameter.
The MaxPermSize is stored as a multi-string value to the Options
parameter.
Linux and Solaris
In Linux and Solaris operating systems, change the memory settings for Tomcat by modifying the CATALINA_OPTS system variable. To modify this variable in SUSE Linux Enterprise Server
11, add a line like the following to the tomcat7 file in /etc/
sysconfig:
CATALINA_OPTS="-Xms1000m -Xmx1000m -XX:MaxPermSize=350m"
ELOenterprise 9 Server
111
112
ELOenterprise 9 Server
ELOenterprise 9 Server
113
114
ELOenterprise 9 Server
ELOenterprise 9 Server
115
7. Click Finish to close the installer. See the ELO OCR Service documentation for additional information on using the ELO OCR Service and any additional settings you may need to enter.
116
ELOenterprise 9 Server
Click Server Installer for Windows from the DVD menu to open the
following installer:
ELOenterprise 9 Server
117
Installation
After copying the server setup files to the computer and starting
the ELOenterprise Server Setup program, the following screen appears. Select Install a new application, then click Next.
When you are installing ELOenterprise for the first time, you must
install the Access Manager and Document Manager before installing other ELO applications. The following chapter describes
how to do this. Subsequent chapters describe how to install additional ELO server components.
118
ELOenterprise 9 Server
If you have just run the ELOenterprise server setup extractor, the
following screen opens automatically. Otherwise, run setup.exe
(setup.sh in Linux or Solaris environments). These files are located
in the /prog/serversetup/ directory.
119
120
On the next screen, select Access Manager and Document Manager. The components can be installed separately (they are the next
two items in the list, respectively), but it is easier to install them at
the same time.
Note: A separate Document Manager must be installed for each
archive.
121
Now select the database type in use. ELOenterprise supports Microsoft SQL Server, Oracle, and DB2 databases. The database must
already be installed when the ELOenterprise setup is run, but it
does not need to be installed to the same computer as the ELO
server.
122
Now enter the location on the computer where Tomcat was installed. If the default value is not correct, click Browse... to navigate
to the Tomcat directory.
123
Next, enter the location where ELO will store its log files. The default location is a subdirectory of Tomcat and can generally be accepted.
On the next screen, enter the ELOam data directory and the
ELOdm archive directory.
ELOam data directory: This is the directory for Access Manager
data. A variety of configuration data is stored here.
ELOdm archive directory: This is where the physical documents
in the archive are stored. Make sure that sufficient disk space is
available there and that the directory is backed up regularly.
When installing on a Windows system, UNC paths can be used. If
you are working with UNC paths, please ensure that the Tomcat
service user has access to the directories. Neither of the directories
specified here should be used to store other documents.
124
Next, enter the database settings. The options provided here depend on the type of database in use.
Microsoft SQL values
Database server name: Name or IP address for the database server on the network. This can also be the local computer. If multiple
instances of Microsoft SQL Server are in use, place a backslash (\)
after the server name, followed by the instance name.
Port: The database port. 1433 is the default value for the Microsoft
SQL server and this does not need to be changed in most cases.
Existing database account: An existing account, (e.g. elodb) with
the right to create databases. This account is used by the setup
program, Access Manager and the Document Manager. The standard account name is elodb.
Password: Password for the database account.
New Database for ELOam: The database name for the Access
Manager could be eloam. Alternative names should only be used
when an access manager already exists on the current SQL server,
such as in multi-client operation or for development and testing
environments.
125
New database for ELOdm (archive name): The Document Manager database name and the name of the archive. The default
name is elo, but it is recommended to change this to a name that
informs the users of the archive in use (in this example the name is
Archive01). The name cannot contain spaces, non-alphanumeric
characters, or accents.
Oracle values
The following values are required in the General Settings when using an Oracle database.
Database server name: Name or IP address for the database server in the network. This can also be the local computer.
Database name (SID): Name of the existing database instance.
The Oracle SID (system identifier) should be entered here and
not the global database name. An entry in the Oracle file
tnsnames.ora is not required. This name can be freely assigned
and is not restricted.
Port: Port for the database. The value in the text field is the standard value from Oracle for databases. Check whether this entry is
correct and change it as needed.
126
The following values are required in the General Settings when using IBM DB2.
127
Database server name: Name or IP address for the database server in the network. This can also be the local computer.
Database name: Name of the existing database instance. The DB2
should be entered here and not the global database name.
Port: Database port. The value in the text field is the standard value from DB2 for databases. Check whether this entry is correct and
change it if needed.
Existing database account: This account must already exist and
is used by the setup program to administer the accounts with the
appropriate tables.
Password: Password for the database account.
New schema for ELOam: The database name for the Access Manager should be eloam. Alternative names should only be used
when an Access Manager already exists on the current server (for
example multi-client operation or development and test environments).
New schema for ELOdm (archive name): This is the account
which should be created for ELOdm.
All database types
128
129
Oracle
130
In the following window, enter the serial number, the Access Manager server name and the Access Manager Tomcat port.
The serial number must be a valid ELOenterprise number. ELOprofessional serial numbers cannot be used.
The password for the ELO administrator must be entered next. This
is the password used by the administrator when logging on to
ELO.
A note on the Administrator account: Some care needs to be
taken when entering administrator information here. Though the
window requests the logon credentials for the ELO administrator,
the same password will be used automatically to create the ELO
Service user. It is quite easy to change the password for the administrator, but changing the password for ELO Service also requires
data in several ELO module configuration files to be changed as
well. Therefore, please enter the password for the ELO Service
user here, then change the administrator password after installation is complete.
131
The next dialog indicates that all entries necessary for the installation have been successfully made. Before clicking Next, double-check that Tomcat is stopped in order for files to be copied to
its installation directory.
132
133
Before proceeding with the next part of the installation, a connection test is required. Start Tomcat, then click Next.
The setup is now ready to finish the installation process. Click Next
to proceed.
134
135
Check installation
Check that the new web applications have been successfully installed by opening a browser to the following address
to log on to the Tomcat Application Manager: http://localhost:8080/manager. Enter the Tomcat administrator user
name and password (as entered during the Tomcat installation).
The browser should display a list of installed web applications, including the ELO Access Manager and the ELO Document Manager.
If errors occur, check the logs in Tomcat's log directory. If the problem cannot be readily determined (for example if a log indicates
an incorrect database password or invalid serial number), contact
the ELO support department.
136
ELO Indexserver
The Indexserver
ELO Indexserver
137
ELO Indexserver
Under Additional Applications, select Indexserver (requires a Document Manager) and click Next to continue.
ELO Indexserver
139
Under Database, select the database type in use and click Next.
140
ELO Indexserver
The default location for the Indexserver's log directory is the Tomcat log directory. If another location is desired, use Browse... to
change the path setting. Click Next to continue.
ELO Indexserver
141
Next you must select the Indexserver data directory. Click Next to
continue.
Microsoft SQL Server
142
ELO Indexserver
If Microsoft SQL Server is used for the database, the following settings need to be entered:
Database server name: Name or IP address of the database server
on the network. This can also be the local computer (localhost) or
an alias name. If a non-standard version of Microsoft SQL Server
is in use, enter the server name, followed by a backslash (\), then
the instance name.
Port: The port used to access the database. The default value of
1433 is the standard port used by the Microsoft SQL Server.
Database account: An existing account with the "database creator" right. This account is used by the setup program and new
web applications. Use the same account used during the Access
Manager and Document Manager installation. The standard account name is elodb.
Password: The database account password.
Database of ELOam: The name of the database used by the previously installed Access Manager.
Database of ELOdm: The name of the database used by the Document Manager, which is also the archive name. The database and
all of the database tables must already exist.
Click Next to continue.
ELO Indexserver
143
If you are using Microsoft SQL Server, you now need to enter the
maximum number of database connections. This is the number of
database connections which will be permanently used by the Indexserver in its connection pool. As a general rule, you should enter between one and ten percent of the total number of simultaneous users. The default value is 100. If the number entered here
is too low, there will be a performance penalty, while entering a
larger number here will increase the amount of required server
RAM. Click Next to continue.
144
ELO Indexserver
Oracle
145
ELOix maximum number of database connections: The number of database connections which will be permanently used by
the Indexserver in its connection pool. The number of connections
must be restricted. As a general rule one to ten percent of the total
number of simultaneous users should be used. The default value
is 100.
ELOdm tablespace: The predefined table of the Document Manager. This tablespace must already exist.
ELOdm index tablespace: The predefined table of the Document
Manager's index. This tablespace must already exist.
146
ELO Indexserver
IBM DB2
If DB2 is being used for the database, the following settings need
to be entered:
Database server name: Name or IP address for the database server on the network. This can also be the local computer.
Database name: Name of the existing database instance.
Port: Port for the database. The value in the text field is the standard value from DB2 for databases. Check whether this entry is
correct and change it as needed.
Database account: This account must already exist and is used by
the setup program to administer the accounts with the appropriate tables.
Password: Password for the database account.
Schema of ELOam: The database name for the previously installed Access Manager.
Schema of ELOdm: The existing database account used by the
Document Manager.
Click Next to advance to an additional setup dialog for DB2.
ELO Indexserver
147
148
ELO Indexserver
On the Server Setup screen, enter the server names and port numbers for the ELO Application Manager, Indexserver, and iSearch.
Continue with Next.
ELO Indexserver
149
A connection test is now necessary before installing. Be sure Tomcat is running before clicking Next.
In the next step, enter the ELO service user name and password.
The default name for this user is ELO Service. The Indexserver uses this user for certain functions, but usually the Indexserver performs actions using a ticket from client applications. Click Next to
continue.
150
ELO Indexserver
Under ELO Administrator User, enter the user name and password
of a user with administrator rights. This user is usually named "Administrator". Click Next to continue.
ELO Indexserver
151
Once the Installation dialog has reached 100 percent, click Finish
to close the dialog box.
Open the ELO Server Manager to verify that the Indexserver is installed and running.
152
ELO Indexserver
Post-installation adjustments
Enable Create external
link
A new function called Create external link was added to the ELO Java Client in ELOenterprise 9. This function shares documents within an ELO archive with persons who do not have an ELO user account. When the ELOenterprise server is first installed, however,
these "external" links only work with computers that are located
within the same network or domain as the ELO server. In order to
share ELO documents via this function with all computers with an
Internet connection, proceed as follows.
1. Assign a fixed IP address to the computer on which the Indexserver is running. Depending on your network settings, you
may need to change various settings on your network controller
and/or firewall to make sure the Indexserver can be reached by
the Internet.
2. Open the Tomcat Server Manager and click the entry for the
Indexserver to open its status page:
3. Click the entry for the Indexserver to open its status page. The
entry is highlighted in red in the image above.
ELO Indexserver
153
5. The ELOenterprise setup program normally sets the ixUrlBase option for the Indexserver to the following format: http://
<computer name>:<server port>/ix-<archive name>/
ix. Replace the computer name with the fixed IP assigned to the
ELO server. Click Save, then Reload to save the change and then
apply it to the server.
If ixUrlBase has not been set for your Indexserver, you can add it
to the list via the drop-down menu in the last line of the table. Enter the value as described above, then click Add to add the option
to the list. Click Save and Reload afterwards to apply the setting.
154
ELO Indexserver
ELO Indexserver
155
iSearch installation
156
157
Select the language used by the ELO database and click Next to
continue.
158
Under Database, select the database type in use and click Next to
continue.
159
Under Directory Setting, enter the path to the Tomcat server. If the
displayed path is incorrect, use Browse... to find the correct location. Click Next to continue.
The default location for iSearch's log directory is the Tomcat log
directory. If you wish to use another location, click Browse... to
change the path. Click Next to continue.
160
The next step is to select the data directory for the iSearch. The
data directories for the iSearch will then be created under this directory. Click Next to continue.
161
If Microsoft SQL Server is being used for the database, the following settings need to be entered:
Oracle
Database server name: Name or IP address for the database server on the network. This can also be the local computer.
Database name (SID): Name of the existing database instance.
The Oracle SID (system identifier) should be entered here and
not the global database name. An entry in the Oracle file
tnsnames.ora is not required. This name can be freely assigned
and is not restricted.
Port: Port for the database. The value in the text field is the standard value from Oracle for databases. Check whether this entry is
correct and change it as needed.
Database account (with role DBA): This account must already
exist and is used by the setup program to administer the accounts with the appropriate tables. The separate document
ELO_oracle.pdf should be consulted when setting up this user.
It explains the various permissions which are required for the user.
The document can be found on the installation medium.
Database account of ELOam: The database name for the previously installed Access Manager.
ELO iSearch and Search Indexer
163
If DB2 is being used for the database, the following settings need
to be entered:
Database server name: Name or IP address for the database server in the network. This can also be the local computer.
Database name: Name of the existing database instance.
Port: Port for the database. The value in the text field is the standard value from DB2 for databases. Check whether this entry is
correct and change it as needed.
Database account: This account must already exist and is used by
the setup program to administer the accounts with the appropriate tables.
Password: Password for the database account.
Schema of ELOam: The database name for the previously installed Access Manager.
164
Under Server Setup, enter the server names and port numbers
for both the ELO Access Manager and Indexserver. Continue with
Next.
A connection test is now necessary before installing. Ensure Tomcat is running before clicking Next.
165
Enter the user name and password for the ELO service user. Click
Next to continue.
166
167
The final message advises you to check the status page of the
Tomcat Application Manager to make sure that the connection to
iSearch is working.
The note at the bottom shows that the iSearch indexer will not
start to catalog archive entries until 24 hours have passed. Indexing can be started manually on the iSearch Indexer status page
(see below).
168
iSearch re-indexing
Immediately after installing iSearch, the iSearch functions will become visible in the ELO clients. However, performing a search at
this point will not return any results. This is because the iSearch
Indexer does not start work for a 24-hour period after installation.
169
To start using the iSearch immediately, click the ELO iSearch Indexer on the Tomcat Application Manager to open its status page.
Click Edit in the upper right-hand corner of the status page and reenter the Tomcat administrator credentials. In the Re-indexer area
of the status page, you will now see an additional button on the
right-hand side of the Status line:
Click RE-INDEX NOW to start the indexer. iSearch will now work as
expected.
Possible iSearch Error
170
ELO Fulltext
Basics
One of the most important aspects of the ELO system is the powerful range of search functions. The server-side processes supporting
these functions consist of the Fulltext module, the ELO Textreader,
the OCR components, and ELO iSearch. The following section describes the installation of the Fulltext module in ELOenterprise.
The ELO Fulltext module is an optional module which can be used
with the ELOprofessional and ELOenterprise systems. It is installed
automatically by the ELOprofessional setup routine. When the
Fulltext module is installed, a second database is created for full
text information alongside the standard ELO database. This full
text database is used to find information with iSearch.
The ELO Fulltext module indexes the textual content of documents for iSearch.
The Fulltext module runs as a server-based process installed to the
archive server. The archived documents are indexed for the Fulltext database automatically at regular intervals. Since the process
runs on the server, it does not reduce client application performance. This indexing process transfers the textual contents of documents into the Fulltext database. Each word within a document
is assigned an index value. The index values are internally structured in such a way to optimize search times for each term.
ELO Fulltext
171
The process for entering documents consisting of coded information into the Fulltext database is relatively straightforward. The
Fulltext module copies the documents into one of a number of
folders, depending upon the type of document. For example, Microsoft Word files are copied into the .doc folder. The Textreader then collects the documents from these folders and translates
the documents into pure text documents, which are then saved in
a .txt folder designated for text files. The Fulltext module then
transfers the contents of the text files into the Fulltext database
and indexes the detected terms.
Non-coded information
172
ELO Fulltext
OCR analysis
Two processes are used by the OCR analysis: pattern matching and
feature recognition.
Feature recognition: Significant characteristics of the actual pixel patterns, as opposed to the white space around
the patterns, are used to search for unmistakable properties which allow the identification of characters.
ELO Fulltext
173
OCR analysis is not used on documents that only contain machine-readable text, such as Microsoft Word documents.
The overall recognition rate is dependant upon the following factors:
Usage example
174
ELO Fulltext
In addition, the complete applications are entered into the Fulltext database via the OCR. When searching for the documents, the
user now has two possibilities. Either the manually entered keywording or the Fulltext data can be used to search for a relevant
word or term.
ELO Fulltext
175
176
ELO Fulltext
ELO Fulltext
177
178
ELO Fulltext
Under Database, select the database type in use and click Next.
ELO Fulltext
179
180
ELO Fulltext
Under Log Directory, enter the location where ELOft will store its
log files. The default entry is the standard Tomcat log directory,
but it can be changed by clicking Browse.... Click Next to continue.
Select a location where the Fulltext module will store its data in
the Directory Setting dialog. Click Next to continue.
Note: The Fulltext data directory may grow quite large if a large
number of documents are contained in the archive. This folder
can also grow quickly if a Fulltext module is added to an existing
archive, or a large data import occurs. Please ensure sufficient disk
space is made available to this folder.
ELO Fulltext
181
182
ELO Fulltext
The General Settings for the Access Manager and Fulltext service
are required next.
Database server name: Name or IP address of the database server
on the network. This can also be the local computer (localhost) or
an alias. When using a non-standard installation of Microsoft SQL
Server, enter the instance name as well, separated from the server
name by a \.
Port: Port used by the database. The existing value in the text field
is the default port used by Microsoft SQL Server.
Database account: An existing account with the "database creator" right. This account is used by the setup program and new
web applications. The account used for the Access Manager and
Document Manager installation should be used. The standard account name is elodb.
Password: Password for the database account.
Database of ELOam: The name of the database used by the Access Manager, which is usually eloam.
ELO Fulltext
183
Database of ELOdm: Name of the database used by the Document Manager, which is the same as the archive name. The database and all of the database tables must already exist. This is the
archive associated with the Fulltext module.
Oracle
Database server name: Name or IP address for the database server in the network. This can also be the local computer.
Database name (SID): Name of the existing database instance.
The Oracle SID (system identifier) should be entered here and
not the global database name. An entry in the oracle file
tnsnames.ora is not required. This name can be freely assigned
and is not restricted.
Port: Port for the database. The value in the text field is the standard value from Oracle for databases. Check whether the entry is
correct and change it as needed.
Database account (with role DBA): This account must already exist and is used by the setup program to manage accounts and their
corresponding tables. The separate document ELO_oracle.pdf
should be consulted when setting up this user. The file is supplied
with the installation DVD and explains the various rights that the
user requires.
184
ELO Fulltext
Database account of ELOam: the database name for the previously installed Access Manager.
Database account of ELOdm: the existing database account used
by the previously installed Document Manager.
Password for these accounts: password for the existing database
accounts.
IBM DB2
Database server name: Name or IP address for the database server in the network. This can also be the local computer.
Database name: Name of the installed database instance.
Port: Port for the database. The value in the text field is the standard value from DB2 for databases. Check whether this entry is
correct and change it as needed.
Database account: This account must already exist. It is used by
the setup program to manage the accounts and corresponding
tables.
Password: Password for the database account.
Schema of ELOam: the database name for the previously installed
Access Manager.
ELO Fulltext
185
The Server Setup details have to be entered next. Enter the server name and access port for the Access Manager and Document
Manager. These applications do not need to be installed on the
same computer. Alias names or localhost can be entered here.
186
ELO Fulltext
A connection test is carried out, and then the ELO User dialog box
is displayed.
ELO Fulltext
187
Enter an existing ELO user and password. This entry is required for
the Fulltext module to read documents, as the service needs to
access the Access Manager to do so. The Administrator account
should not be used. You can change the Fulltext user account at
any time in the ELO Windows Client.
188
ELO Fulltext
Click Next to display a list of directories that have been created and
registered in the database in order for the Fulltext module to run.
ELO Fulltext
189
190
ELO Fulltext
Additional Document
Types
ELO Fulltext
Folders for the common document types are created automatically in the data directory. The folders are created for the document types supported by the Java Textreader. If further document
types need to be added to the Fulltext database, additional text interpreter software must generally be installed. These are not provided by or supported by ELO. Create corresponding folders for
these file types in the data directory and enter the file types to the
Fulltext configuration. Restart the Fulltext web application afterwards.
191
ELO Textreader
Please note: The instructions for the installation of this component only apply to ELOenterprise.
Installation
192
ELO Textreader
ELO Textreader
193
In the Additional Applications dialog box, select the option for Textreader (requires Fulltext and an Indexserver).
Select the language used in the database for the archive. If you
have run the program on this computer already, the correct language should be selected by default.
194
ELO Textreader
ELO Textreader
195
Next, enter the location where ELOtr will store its log files.
196
ELO Textreader
In the next screen, enter the Fulltext module's data directory. This
must be the directory selected during the Fulltext setup.
ELO Textreader
197
Next, enter the maximum file size for documents. If you increase
this value above 25 MB, a warning message appears, notifying you
that the amount of memory allocated to Tomcat may need to be
increased as well.
198
ELO Textreader
Now enter connection data for the Access Manager and Indexserver. If you have already installed ELO server applications to
this computer, the correct entries should be entered by default.
ELOam server name: The computer name or IP address of the ELO
Access Manager.
ELOam server port: The Tomcat port used by the Access Manager.
ELOix server name: The computer name or IP address of the Indexserver.
ELOix server port: The Tomcat port used by the Indexserver.
Click Next to continue.
ELO Textreader
199
Enter the authentication data for an ELO user. The ELO service user
should usually be used here. Click Next to continue.
200
ELO Textreader
After reaching the Input Complete screen, click Next to install the
Textreader.
ELO Textreader
201
202
ELO Textreader
The ELO XML Importer is an ELO application used to import documents automatically into an ELO archive based on an XML control file. The XML Importer monitors a specific directory at regular intervals to initiate an import process. Please see the ELO XML
Importer documentation for more information on how to use the
XML Importer.
The XML Importer requires a running Indexserver, Access Manager, and Document Manager to work.
To install the ELO XML Importer in ELOenterprise environments,
proceed as follows:
Navigate to the directory containing the ELOenterprise setup files (normally <ELOenterprise>\prog\serversetup\,
where <ELOenterprise> is a directory you specify when the setup extractor is run). Run setup.exe. The following screen appears:
203
204
Select the language used by ELO in the database and click Next.
This must be the setting chosen when the Access Manager and
Document Manager were first installed.
205
206
Select the directory in which you want to store log files produced
by the XML Importer, then click Next.
Select a directory where the XML Importer will store its data and
click Next.
207
Enter the database names for the Access Manager (usually eloam)
and Document Manager (the name of the archive). Click Next to
continue.
Oracle
208
Enter the database account names for the Access Manager (usually eloam and the Document Manager (the name of the archive).
Click Next to continue.
IBM DB2
Enter the schema names for the Access Manager (usually eloam
and the Document Manager (the name of the archive). Click Next
to continue.
209
210
Now you must select an import directory for the XML Importer.
This is the directory the Importer monitors for documents to import. Click Next to continue.
Enter connection data for the ELO Access Manager and Indexserver.
ELO XML Importer
211
ELOam server name: The computer name or IP address of the Access Manager.
ELOam server port: The Tomcat port used by the Access Manager.
ELOix server name: The computer name or IP address of the Indexserver.
ELOix server port: The Tomcat port used by the Indexserver.
On the Signal File screen, you must specify whether the XML Importer uses a signal file for imports. If this option is selected, a .SIG
file must be present in the import directory in order to initiate an
import. Click Next to continue.
212
Make sure the ELO Tomcat server is running locally, then click Next.
Enter the authentication data for an existing ELO user. The ELO
service user should usually be used here. Click Next to continue.
213
The final screen shows the progress of the XML Importer installation. Wait for the progress bar to reach 100 percent and then click
Finish to close the installer.
214
If errors occur, try to correct them and then run the XML Importer
installation again.
After closing the installer, go to the Tomcat Manager status page
and check that the XML Importer is installed and running:
215
ELO Automation
Services
ELOas was named ELO Mover in earlier versions of the software.
216
217
Select the language selected previously for the database and click
Next.
218
219
Select the location where ELOas will store its logs and click Next.
Microsoft SQL Server
Oracle
Enter the database account names for the Access Manager (usually eloam and the Document Manager (the name of the archive).
Click Next to continue.
IBM DB2
221
Enter the schema names for the Access Manager (usually eloam
and the Document Manager (the name of the archive). Click Next
to continue.
Enter the computer name and ELO port for the Access Manager
and Indexserver, then click Next.
222
Enter the user name and password for the ELO service user (ELO
Service by default). Click Next to continue.
In principle, any user can be used by ELOas, as long as the user option to force a password change has not been set. However, since
ELOas performs all functions within this user context, a user with
administrator rights is recommended.
223
Once the screen above appears, click Finish to close the setup program.
224
Check the Tomcat Host Manager to make sure that ELO Automation Services is running.
225
2. Copy the GUID of the new ELOas Base folder to a text editor.
226
Fig. ELOas Base 2 folder GUID (your folder's GUID may differ)
3. Stop the instance of Tomcat where you will install the new
ELOas.
4. Go to the Tomcat's webapps directory and copy ELOas under a
new name. In this example, name the new instance of ELOas asArchive2.war.
5. Go to the web application configuration directory (<tomcat install>\conf\Catalina\localhost) and copy the
application's xml file in the same way as step 4. In this example,
copy as-Archive.xml to as-Archive2.xml.
6. Open the copied .XML file in Notepad or a similar text editor and
change the entry for webappconfigdir and Context path to
reflect the new ELOas instance. In this example, it would be:
<Context path="/as-Archive2">
<Environment name="webappconfigdir" value="C:\ELOenterprise\config\as-Archive2" type="java.lang.String"
override="false"/>
</Context>
227
8. Enter the new directory, then open the config.xml file within
it in a text editor. Change the rootguid entry to reflect the folder
in the archive from step 2:
229
ELO Workflow
230
ELO Workflow
ELO Workflow
231
Select the language used in your ELO database for entries and click
Next.
232
ELO Workflow
ELO Workflow
233
Select the directory where ELOwf log files will be saved and click
Next.
Microsoft SQL Server
The General Settings for the Access Manager and Fulltext service
are required next.
234
ELO Workflow
ELO Workflow
235
Database server name: Name or IP address for the database server in the network. This can also be the local computer.
Database name (SID): Name of the existing database instance.
The Oracle SID (system identifier) should be entered here and
not the global database name. An entry in the oracle file
tnsnames.ora is not required. This name can be freely assigned
and is not restricted.
Port: Port for the database. The default value in the text field is
the standard value from Oracle for databases. Check whether the
entry is correct and change it as needed.
Database account (with role DBA): This account must already exist and is used by the setup program to manage accounts and their
corresponding tables. The separate document ELO_oracle.pdf
should be consulted when setting up this user. The file is supplied
with the installation DVD and explains the various rights that the
user requires.
Database account of ELOam: The database name for the previously installed Access Manager.
Database account of ELOdm: The existing database account
used by the previously installed Document Manager.
Password for these accounts: Password for the existing database
accounts.
Click Next to continue.
236
ELO Workflow
IBM DB2
Database server name: Name or IP address for the database server in the network. This can also be the local computer.
Database name: Name of the existing database instance.
Port: Port for the database. The value in the text field is the standard value from DB2 for databases. Check whether this entry is
correct and change it as needed.
Database account: This account must already exist and is used by
the setup program to manage the accounts with the corresponding database tables.
Password: Password for the database account.
Schema of ELOam: The database name for the previously installed Access Manager.
Schema of ELOdm: The existing database account used by the
Document Manager.
Click Next to continue.
ELO Workflow
237
Start the ELO Application Server (Tomcat) if it is not already running, then click Next.
238
ELO Workflow
Enter the user credentials for an ELO user. Use the service user
here. For most ELO environments, the user will require administrator rights.
ELO Workflow
239
A progress bar appears along with installation messages. After "Installation finished." appears, click Finish to close the server setup
program.
Open the ELO Application Manager to make sure ELOwf has been
installed properly:
240
ELO Workflow
The ELO Web Client allows users to log on to and use the ELO
archive via most common Internet browsers. For more information
on using and managing the Web Client, see the corresponding
manual.
A separate license is required to use the full Web Client functionality. If you install the Web Client without purchasing a license, access will be restricted to devices running ELO for Mobile Devices.
Full vs. FMD Web
Client
241
242
243
Select the directory in which you installed Tomcat and click Next.
Select the directory in which you want to store Web Client log files
and click Next.
244
Select the directory where the Web Client will store its data and
click Next.
Microsoft SQL Server
245
Oracle
246
247
Enter the user name and password of an existing ELO user. This
user needs to have Main administrator rights. The ELO service user
is normally used here. Click Next to continue.
248
249
250
Bookmark this page to see the current status of the Web Client at
a glance.
251
Administration
Console
The Administration Console is a module in ELO that allows you
to perform administrative tasks, such as setting up and managing
users, keywording forms, ELOas rulesets, backup settings, client
configuration and so on. To install the Administration Console, run
the server setup program.
252
Administration Console
Administration Console
253
Select the directory into which the ELO Application Server was installed and click Next.
254
Administration Console
Select a directory for the Administration Console log files and click
Next.
Administration Console
255
ELOix server name: Enter the computer name to which the Indexserver was installed.
ELOix server port: Enter the port used by the Indexserver.
Note: In Oracle environments, the Document Manager database
account is required here. In IBM DB2, you must enter the Document Manager schema. The Administration Console is otherwise
the same for all database types.
Click Next to continue.
If you are installing the Administration Console to a server on Linux, you will be given the option to set ownership for certain directories. Enter the Tomcat user and (optionally) the Tomcat user's
group. Click Next to continue.
Make sure the ELO server is running, then click Next to continue.
256
Administration Console
Click Finish to close the installer. Open the ELO Application Manager to check whether the Administration Console is running properly:
Administration Console
257
You can now start the Administration Console by clicking the link.
It is a good idea at this point to create a shortcut to the application
on the desktop, in the Windows start menu, and wherever else it
will be useful.
For information on how to use the Administration Console, continue to the Administration Console user guide.
258
Administration Console
Updating
ELOenterprise
Due to its high degree of modularity, updating ELOenterprise requires more work than updating ELOprofessional. Since ELOenterprise can be distributed to several different servers, it may be necessary to repeat the update process on each of them. Follow the
steps in this chapter to correctly update your server software.
Before updating ELOenterprise web applications:
Backup
Before making any major changes to the ELO server (such as updating it), make sure to back up a working version of the software.
Repeat steps 1-3 for each computer that runs ELOenterprise applications.
1. Back up the Tomcat installation directory and all child directories.
2. Back up the config and data directories. By default, these are
child directories of the Tomcat installation directory.
3. Back up the webapps directory. By default, this is a child directory of the Tomcat installation directory (<Tomcat installation>\server\webapps, as well as <Tomcat installation>\prog\webapps in ELOenterprise 9).
4. Back up the database. The storage format differs depending on
which database (Microsoft SQL, IBM DB2, or Oracle) is used, but
create backup copies of all archives and all Access Managers.
Updating ELOenterprise
259
Update Java
1. Check the version compatibility table in the server update documentation to see which version of Java is required for the update
you are performing. If you are updating from the ELOenterprise
DVD, the required version of Java is included on the DVD.
2. Next, open a command window and enter java -version.
If your installed version of Java is lower than the version required
for the ELOenterprise server update, you must update Java.
3. Download Java JRE from the Internet or click the link to it on the
ELOenterprise DVD and run the setup program to update Java.
4. Update Java in the same way on all computers running ELOenterprise server applications.
Update Tomcat
Update ELOenterprise
260
Updating ELOenterprise
Use the newest release DVD of ELOenterprise. Please ensure that you update Java and Tomcat first if necessary.
2. Place the ELOenterprise DVD in the ELO server's DVD drive and
run Start.exe.
3. Navigate to the Basic Installation tab and click Server Installer for
Windows.
Updating ELOenterprise
3. Download the newest version of the ELOenterprise Server Setup files from the ELO SupportWeb. Extract the ZIP file to a local
directory and run ELOenterprise.exe.
261
262
Updating ELOenterprise
Updating ELOenterprise
263
7. Select the language used in the database for ELO entries, then
click Next.
264
Updating ELOenterprise
Updating ELOenterprise
265
10. Select the directory in which you want to store log files and
click Next.
266
Updating ELOenterprise
11. The setup program now lists the server applications that it detects and can update. If the list is not correct, click Cancel to close
the program. Click Next to continue.
12. The setup program gives you the opportunity to change the serial number. If you are upgrading ELOenterprise from version 2011
to ELOenterprise 9, you must change the serial number to perform
the update. Click Next to continue.
Updating ELOenterprise
267
Oracle
268
Updating ELOenterprise
14. This screen also only appears in Oracle environments. Enter the
tablespace and index tablespace for the Access Manager and Document Manager. Click Next to continue.
All database types
15. Stop the Tomcat server before proceeding. It is recommended to check the Task Manager in Windows or to check the list of
running processes in Linux or Solaris environments to ensure the
server has completely shut down. Click Next to install the updates.
Updating ELOenterprise
269
270
Updating ELOenterprise
There are several ways to update ELOprofessional server applications. In ELOprofessional 2011 and earlier, the applications
were extracted to separate directories, complicating the update
process. Starting with ELOprofessional 9, the WAR files that contain the ELO applications are loaded dynamically to Tomcat at runtime. To update ELOprofessional 9 server applications, proceed as
follows:
The ELO Application Server does not need to be stopped to perform an update in this way. However, increased server RAM will
be required until the ELO server is restarted. It is recommended to
perform a server restart after performing an ELO application update as soon as it is convenient to do so.
Updating ELOenterprise
271
Check to see that the application you want to update already exists in this directory. Each ELO application uses a special abbreviation (such as dm.war for the ELO Document Manager, ix.war for
the Indexserver, and so on.
If the updated application is not located in this directory, use the
update method following this one titled Manual update with
transfer directory.
3. Extract the updated ELO application to your hard drive and rename it (if necessary) so it has the same name as the old ELO application.
4. Copy the updated ELO server application to the prog/webapps
directory so that it overwrites the old application.
5. Tomcat will automatically load the updated application to
memory. Check the status page of the updated application in your
browser in the ELOprofessional Server Manager. If the application
has a status of Running and no errors are displayed, the application has updated successfully.
Manual update with
transfer directory
272
Updating ELOenterprise
3. Copy the new web application (a .WAR file) into the transfer
directory, then give it the same name (without extension) as the
configuration file, such as tr-Archive1.war.
4. Open the ELO Server Manager and locate the application you
want to update, then click Undeploy:
Updating ELOenterprise
273
ELO Viewer
The ELO Viewer is a tool that allows you to export archive contents
along with a read-only version of ELOoffice, which allows anyone
with a Windows PC to view archive contents. A portable archive
retains all the advantages of a normal ELO export data set and
can be reimported as usual. However, the portable archive lets you
also do the following:
The ELO Viewer should not be confused with the ELO viewer plugins, which are used to view special file types in the ELO client applications.
The ELO Viewer is installed automatically with ELOprofessional.
Use the following instructions to install it in ELOenterprise:
To install the ELO Viewer, place the ELO installation medium in
the computer to which you installed ELOam. This is the ELO server if you installed ELOprofessional. Navigate to the Basic Installation tab and click the link to Viewer. The ZIP file containing
the installation files opens. Open the files directory and copy all
files within it to <server installation directory>\data\am-eloam\configuration\viewerpostbox. This directory will have been created automatically during ELOam installation.
274
ELO Viewer
The Viewer can now be used to export a portable archive from any
Windows Client on the ELO system. See the Windows Client Manual for instructions on how to export and use a portable archive.
Alternative ELO Viewer languages
ELO Viewer
275
[Settings]
Language="E"
Replace the E in the example above with the letter in your downloaded UIT file.
ELO320.uit must be saved in UTF-8 (little-endian) format to work
properly.
276
ELO Viewer
The installation process for the ELO Windows Client is the same for
both ELOenterprise and ELOprofessional. The ELO Windows Client
can be installed to computers running the Microsoft Windows operating system. There are two ways to install the client:
The first option is installed directly from the DVD. The second (automatic installer) option is rolled out to users over the network.
Either can be used for any ELO installation process, but the first
option is perhaps most appropriate for administrator computers
or testing environments. The second installer option is useful for
quickly installing ELO to a network using group policy options, because the installation information only needs to be entered once
on one computer for any number of client installs.
The following sections first describe the standard installation routine for the ELO Windows Client. The setup instructions for the automatic client installer follow.
277
278
The ELO Windows Client can be installed directly from the DVD or
from a shared location on the network. A server running ELOenterprise or ELOprofessional must be working correctly on the network for the client to work, but it is not required at installation.
If the ELO server uses an Oracle database, the Oracle Client must
also first be installed on each client computer.
Installation
279
4. When the Installation Wizard appears, click Next to start the installation process.
280
5. Here you can define the directory to which the client will be
installed. Click Next to continue.
Some configuration files (such as language files for non-German
ELO environments) are stored directly to the installation directory. Windows Vista and later virtualize access to the Program Files
directory, which can cause compatibility problems if the ELO Windows Client is installed there. For this reason, it is recommended to
choose an alternative directory, such as C:\ELOprofessional.
281
6. In this dialog box, enter access settings for the Access Manager.
Enter the computer name of the server, the port used by the ELO
Application Server ("8080" is the default setting for ELOenterprise,
"9090" for ELOprofessional), and in ELOenterprise, the name of
the database instance (not applicable for ELOprofessional). Click
Next to continue.
282
7. Next, the dialog box to enter the ODBC settings appears. The
ELO Windows Client uses an ODBC connection to access the database. Enter the SQL server name here, followed by the Data Source
Name and the ELO user account on the database. If you are using
Microsoft SQL Server, the installer can create a System DSN automatically at this point. If your ELO environment uses an Oracle or
IBM database, the DSN must be created manually outside of the
installer. Click Next to continue.
283
8. You are now ready to begin the client installation. Click Back to
review or change your settings. Otherwise, click Install to start the
installation.
284
9. Once the installation is completed, the final dialog box gives you
the option of starting the ELO Windows Client immediately and/
or to view the readme file. Click Finish to close the installer.
285
Installation
286
2. After the DVD menu has loaded in the browser, select the entry
on the left for ELO Windows Client, then click Automatic Client Installation.
287
The Automatic Client Setup starts. Enter the following data to this
screen:
288
289
The files and folders needed for installing the client software will
now be copied into the shared folder entered in Setup Directory.
4. Once the process has finished, click Exit to close the dialog box.
The setup.exe for the client program and other modules will
now be available on the network in the ClientInst subfolder of the
designated folder.
290
291
292
The InstallShield Wizard opens to guide you through the installation process.
293
Next, select the directory to which you want to install the ELO Java
Client. The default directory within the program files folder can be
used in most cases.
294
You are given the option to enter a serial number for the ELO Barcode component. Click Next to continue.
295
Click Install to install the ELO Java Client. When it is complete, click
Finish to exit the wizard.
296
After installing the Java Client, run it from the Windows start
menu or by double-clicking the icon on the desktop.
Enter a name for the archive to the Name field. You can use any
name you want and is used locally to distinguish between profiles. In the Indexserver URL field, enter the URL to the Indexserver
in the format http://<server name>:<Tomcat port>/ix<Archive name>/ix. If your Indexserver URL entry is correct,
the Java Client then connects to the Indexserver and you can enter your user name, password, and select a different language and
archive if you wish.
You can also create profiles for the Java Client in the registry so
that this screen does not appear. See the section titled Java Client
registry entries for more information.
297
298
To install the ELO Java Client Web Start, extract the .ZIP file to a
local directory. You will need to change a configuration file before
it can be deployed to the server.
1. Depending on whether you are using ELOenterprise or ELOprofessional, rename ELOenterprise.html or ELOprofessional.html to
index.html.
2. Open EloClient.jnlp in the main directory in a text editor and
change the following line of code:
codebase="http://[SERVER]:[PORT]/[DIRECTORY]/"
to the server name and port of your ELO Application Server, followed by a directory name of your choosing like ELOJavaClient.
3. In EloClient.jnlp change an additional two lines of code. The
original file has the following two lines of code:
<property name="elo.archive.default.name" value="[ARCHIVEPROFILE-NAME]"/>
<property name="elo.archive.default.path"
value="[INDEXSERVER-URL]"/>
Change the text in the first set of brackets to include the name of
the archive profile. This is the name shown in the logon window
when selecting an archive in the client. On the second line, enter
the URL to the Indexserver, just as you would when creating a profile directly in the Java Client.
4. Depending on your specific environment requirements, you
may add additional archive profiles, enter Kerberos authentication information, or change the amount of RAM allocated to the
Java Client at startup and at maximum.
5. Stop the ELO Application Server.
6. Create a directory with the same name as in step 2 above in
your ELO Application Server's /server/webapps/ directory. In the
example above, it would be /server/webapps/ELOJavaClient. Copy
all Web Start files from the .ZIP into this new directory.
7. Start the ELO Application Server.
Result
The ELO Java Client Web Start should now be correctly installed
and configured. Test this by opening the ELO Server Manager,
where an application named the same as the directory you created should now appear. Click the link to the application. A new tab
in the browser will open, showing you the following screen:
299
If you are using an ELOenterprise environment (and therefore renamed ELOenterprise.html to index.html), the title at the top will
show ELOenterprise instead. If you wish the button to show "Start
ELO Java Client" instead of the German title, edit index.html accordingly. Click the button to start the client. Test logging on to
the archive to make sure it is working properly.
When you click the link to Start ELO Java Client, your computer will
download and run a file of type .jnlp. This must be run with a 32bit version of the Java (TM) Web Start Launcher, which by default
is located at C:\Program Files (x86)\Java\jre7\bin\javaws.exe.
After testing that the Java Client Web Start works properly, you
can copy the link in the browser to add it to your favorites, create a
shortcut on the desktop, link to it from other applications or documents, and so on.
300
When you select the Installation Program for ELO Java Client (Windows) with Additional Components menu item on the DVD, the
window to the left opens. The program selects by default a directory shared as ELO JC OIA Installer on the local computer. If you
attempt to start copying files and the directory does not exist, you
will receive an error message.
Click the browse button to the right of the field to select a directory on the local computer or network. Click Start Copy to copy the
files. After all files have been copied successfully, the progress bar
will show solid green and you will see the status message Copying
finished. Click End and navigate to that directory in a file browser.
You will see a number of files and folders in this directory that allow you to customize the installer for the ELO Java Client. Immediately after copying the files, you will see two files (an .EXE and
a .TXT file) that both start with EloJC. Run the .EXE file to see the
following window:
301
As you can see in the image, the all-in-one installer by default installs the ELO Java Client along with all available optional components. The default entries for installation directory, archive profile name, and Indexserver URL are only samples of valid entries
and usually need to be adjusted for your specific requirements.
Though all options can be selected or cleared from this window,
you can also affect the presets by changing the name and parameters of the .EXE file. The latter option is particularly useful for
network rollouts. The following is a list of possible installation options:
Installation directory
302
This is the directory to which the ELO Java Client will be installed
on the local machine when it is run. You can change the default
directory by adding INSTALLDIR="<path>" as a command line
parameter when the file is run.
This is the name the user will see for the profile when logging on
to the archive with the ELO Java Client. Any name you wish can be
entered here, but it is recommended to use a name that helps the
user recognize what archive they are about to enter. Define the
profile name by entering a text string to the area between the last
underscore and the .EXE in the file name.
Indexserver URL
This
is
the
URL
to
the
Indexserver
for
your
archive.
Change
the
default
by
changing
the
file name from ...http_localhost_9090_elo... to
...<http(s)>_<server domain name or IP>_<port
number>_<archive name>.
Select the features you want to install: Here you will probably
want to keep the Java Client selected. The ELO OCR service performs text recognition on image files, usually from the ELO Mailbox. The TIFF and PDF printer options install printer drivers that
allow documents to be printed from or to ELO in each of the respective output formats. See the ELO Java Client user guide for
more information on these features. To select or remove each of
these features from the AIO installer by default, change the .EXE
in the area after the first underscore and add or remove the J (Java
Client), C (OCR service), T (TIFF printer), or P (PDF printer).
Select the programs you want to link to ELO with the macro:
In this area, define to which programs in Windows you want to
install an ELO add-in. The add-in provides you with additional inprogram buttons that send documents directly to the ELO archive
or Mailbox. To change the defaults, change the .EXE file name in
the same area as the above and add or remove W (Microsoft Word
macro), E (Microsoft Excel macro), I (Microsoft PowerPoint), O (Microsoft Outlook), N (Microsoft Internet Explorer), D (Windows Explorer), and F (Mozilla Firefox).
Unlisted options
A few other options are available in the all-in-one installer that are
particularly useful for a rollout installation. The first is that of the
silent installation. To activate it, add an S to the block of other
activated options in the .EXE file name. This causes the installer to
run without user interaction in the background. Note that the nature of the silent installation option only permits the installation
options to be affected by the file name and the additional parameters.
303
The Java memory reservation settings allow maximum and minimum sizes of memory used by the Java Virtual Machine which
runs the ELO Java Client. The default value allows up to 1000 MB
of RAM to be used, which is fine for most environments. However, increasing the maximum value may increase performance
in certain situations. This is done with the command line parameter XMX="<number>m". Increasing the minimum memory
can yield performance benefits as well, especially if users have
a lot of unused RAM available to them and regularly work with
image-heavy documents. Increase the minimum RAM allocation
with XMS="<number>m".
The barcode serial number is added to the installation by adding
the command line parameter SERNO_BARCODE="<serial
number>".
File name prefix: The section of the all-in-one installer file name
before the first underscore can be anything you want. However,
the last two characters shown when the files are initially copied to
the hard drive signify the defined installer interface language: En
for English, Ge for German, or Fr for French.
Result
304
305
However, after clicking OK, the installer will open as usual, allowing you to perform a manual installation.
306
307
(String) name
language
lastlogin
lastselected
rrc_<...>
serno
308
Value
en, de, fr, etc. Determines the
default display language for
the Java Client at logon. Entering an invalid language code
will cause the fallback language, English, to be used.
User name shown by default
in the logon window.
The name of the archive profile selected by default in the
logon window.
Please see the documentation
titled Registry Remote Control for a detailed explanation
of these settings.
This registry entry shows up
in bold in the lower left of the
logon window. It will be overwritten by the value from the
Indexserver at next logon.
Appendix
The following topics are covered in the appendix: Additional Installation Information, Directory Access Rights, Parameters in the
File config.xml, Log Files, Increasing Tomcat Memory, and Thirdparty Licenses.
Appendix
309
310
Appendix
Appendix
311
Example
In SUSE the name of the Tomcat account is tomcat (see file /etc/
init.d/tomcat). There is also a user group with the same name.
From within the ELOenterprise directory, the commands are as
follows:
312
Appendix
Parameters in config.xml
For most cases, the config.xml file is correctly configured with
the appropriate values during the installation process and will not
require manual changes. In special situations which demand a customized installation, the file must be manually changed. The following table includes a list of all parameters for the file.
The description of the config.xml files for the Administration
Console, the form-based workflow service, ELOas, and the XML
Importer is included in their respective manuals.
ELOam, ELOdm,
ELOix, and ELOft
Parameter
dbdriver
jdbcurl
database
dbconnections
dbuser
dbpwd
eloftoptgroup
proxyslot
Appendix
Description
Java database driver (pure JDBC driver)
Java database connection via JDBC.
Database used
This parameter should only be set when
Microsoft SQL Server is used, or a compatible database engine that permits switching between databases with the USE
commands is used instead.
If nothing is entered here, the database
must be included in jdbcurl (Oracle).
Number of database connections that are
permanently in use (not for ELOix).
Name of the database user.
When using Oracle, an individual database
account is used by the Document Manager
for each archive.
Password of the database user. It is created
in an encrypted form during installation
(multiple numbers separated by a hyphen),
but can be used in a non-encrypted form.
Group number for the values in the database table eloftopt. This should not normally be changed. (Only ELOft)
Slot number (1-4) of the branch office
sharing the same ELOdm when proxy mode is used. "0" is for the main office. (Only
ELOdm)
313
Textreader (ELOtr)
Parameter
dirs_doc
dirs_docx
dirs_dot
dirs_pdf
dirs_xls
dirs_xla
dirs_xlsx
dirs_htm
dirs_html
dirs_mht
dirs_mmf
dirs_msg
dirs_eml
dirs_pps
314
Description
Source and target directory for files with
the .doc extension, separated by a pipe
character.
Source and target directory for files with
the .docx extension, separated by a pipe
character.
Source and target directory for files with
the .dot (Word templates) extension, separated by a pipe character.
Source and target directory for files with
the .pdf extension, separated by a pipe
character.
Source and target directory for files with
the .xls extension, separated by a pipe character.
Source and target directory for files with
the .xla (Excel add-in) extension, separated
by a pipe character.
Source and target directory for files with
the .xlsx extension, separated by a pipe
character.
Source and target directory for files with
the .htm extension, separated by a pipe
character.
Source and target directory for files with
the .html extension, separated by a pipe
character.
Source and target directory for files with
the .mht extension, separated by a pipe
character.
Source and target directory for files with
the .mmf (COLD documents) extension, separated by a pipe character.
Source and target directory for files with
the .msg (Microsoft Outlook) extension, separated by a pipe character.
Source and target directory for files with
the .eml extension, separated by a pipe
character.
Source and target directory for files with
the .pps (Powerpoint slideshow) extension,
separated by a pipe character.
Appendix
Textreader (ELOtr),
cont.
Appendix
Parameter
dirs_ppt
Description
Source and target directory for files with
the .ppt (Powerpoint presentation) extension, separated by a pipe character.
dirs_pptx
Source and target directory for files with
the .pptx extension, separated by a pipe
character.
dirs_rtf
Source and target directory for files with
the .rtf extension, separated by a pipe character.
dirs_vcf
Source and target directory for files with
the .vcf extension (vCard), separated by a
pipe character.
dirs_vsd
Source and target directory for files with
the .vsd extension (Microsoft Visio), separated by a pipe character.
dirs_xml
Source and target directory for files with
the .xml extension, separated by a pipe
character.
dirs_zip
Source and target directory for files with
the .zip extension, separated by a pipe character.
dirs_jpg &
The path for JPEG files extracted from text
dirs_jpeg
documents (e.g. PDF files).
dirs_png
The path for PNG files extracted from text
documents (e.g. PDF files).
dirs_tif & dirs_tiff The path for TIFF files extracted from text
documents (e.g. PDF files).
file_max_error
If files of a particular type cannot be converted for any reason, they will remain in
their respective directory. When the total size of all files remaining in a particular directory reaches the value entered in
file_max_error, the Textreader will stop
with an error message and the files must
be manually removed from the directory.
file_max_size
Maximum size in MB of the files that can
_MB
be processed. If the size of a file exceeds
this value, it will be deleted and not processed. If a large value is entered here, the
RAM assigned to Tomcat may need to be
increased.
315
Textreader (ELOtr),
cont.
Parameter
Description
file_err_move_dir An existing directory can be entered here
and any files that cannot be processed will
be moved into this directory. If a value is
not entered here the files will be deleted.
convert not pos- Error value used when conversion fails.
sible value
Parameter
user
password
ixurl
316
Description
The account used for ELO iSearch and ELO
iSearch Indexer. The default user created
when initially installing ELOenterprise is
ELO Service.
This is the password for the user account in
encrypted form. (Passwords can be encrypted by using password.bat.)
The URL of the Indexserver.
Appendix
Log Files
Various log files are written during ELO's installation as well as
afterwards when using ELO applications like the Access Manager. These files are found in various locations depending upon
whether ELOprofessional Server or ELOenterprise is used. The information contained in these files is useful not only when searching for errors, but also when analyzing the normal operation and
status of the ELO applications.
Tomcat
The standard location for the log files of the Tomcat application
manager is the sub-directory logs in either the Tomcat program
folder (ELOenterprise) or in the child directory of the same name
in the ELO program folder (ELOprofessional). If another path was
chosen for these files during installation, then they will be located
there.
tomcat7-stderr.*.log
and tomcat7-stdout.*.log
These two log files save any messages received from Tomcat. Messages from ELO can also occasionally be found within these log
files. Normally these logs must only be checked when problems
have occurred.
ELO Components
Separate log files are written for each of the ELO applications. These are located either in Tomcat's sub-directory logs
(ELOenterprise)or in the same-named sub-directory in the ELO
program folder (ELOprofessional)
am-*.log
as-*.log
This log file contains the log data for ELO Automation Services.
dm-*.log
This log file contains the log data for the Document Manager.
ft-*.log
im-*.log
Appendix
This log file contains the log data for the Access Manager.
This log file contains the log data generated when operating the
Fulltext module.
This log file contains the log data for the XML Importer.
is-*.log
ix-*.log
This log file contains the log data for the Indexserver.
sx-*.log
This log file contains the log data for the iSearch Indexer.
317
tr-*.log
log4j
318
This log file contains the log data for the Textreader.
wf-*.log
This log file contains the log data for the form-based workflow
service.
serversetup.log
This log file contains the log data for the installation process and
is located in the server installation directory.
The log4j library is used by web applications and controls the storage of data in the log files. Each log file has an individual configuration file, log4j.properties, and the format of the log data
can be modified within this file. The default location for these files
is the ELO sub-directory ...\prog\serversetup\configdata\templates. The protocol level for the log file can also be
modified here by changing the level from INFO to DEBUG. Note
that changing the logging level to DEBUG can reduce performance significantly and cause the log file to grow exponentially
in size over time. The log files should be saved in an area of the
server where they cannot influence system performance by filling
up hard drives, for example. New log files are started every day
at midnight and the existing file is renamed with the appropriate
date at the end of the name. These files can be deleted at any time.
Normally no modifications to the configuration file or the log file
are needed. Further information on this subject is included in the
log4j manual from the Apache Software Foundation.
Appendix
Third-Party Licenses
Comprehensive information to the licenses can be found on the ELOenterprise or ELOprofessional installation medium. For the Apache License see http://www.apache.org/licenses.
Library name
Log4j
Jakarta Commons
Logging
Jakarta Commons
HttpClient
JDOM
Jakarta POI
Java Excel API
PDFBox
JZlib
Majix
Xp
Xt
Java Web Services
Developer Pack 2.0
Microsoft SQL Server
2012 R2 JDBC Driver
Oracle 11g JDBC Driver
DB2 JDBC Driver
JAR-File
log4j-1.2.8.jar
commons-logging.jar
commons-httpclient- 2.0.jar
jdom.jar
poi-3.7-final.jar
jxl.jar
pdfbox-1.4.0.jar
jxl.jar
majix.jar
xp.jar
xt.jar
(diverse)
License
Apache SW Lic. 2.0
Apache SW Lic. 2.0
Apache SW Lic. 2.0
sqljdbc4.jar
JDOM License
Apache SW Lic. 2.0
GNU Lesser GPL
Apache SW Lic. 2.0
BSD
Mozilla Public Lic. 1.1
Xp License
Xt License
(siehe Textdatei auf der
CD)
Microsoft
ojdbc6.jar
Oracle
db2jcc.jar
IBM
319
Further references
It is impossible for this guide to cover all areas relevant to managing an ELO environment. If your question was not covered by the
present documentation, please visit the links below for further information.
Internet links
ELO partner forum: The ELO partner forum is a primarily German-language Internet forum where ELO partners can exchange
information on all topics relating to ELO. It is recommended
for non-German speakers to browse the website using the auto-translate feature in the Chrome browser. It is located at: http://
forum.elo.com.
ELO SupportWeb: The ELO SupportWeb provides links to all current documentation and program files. It is located at: http://
forum.elo.com/supportweb.
ELO Knowledge Base: This specific area of the SupportWeb deserves special mention. The Knowledge Base is divided into categories of server and client modules and deal with most common
ELO configuration issues. It is located at: http://forum.elo.com/
supportweb/en/knowledge-base.
ELO Documentation: This area of the SupportWeb provides complete documentation for all ELO modules, as well as current language files for the ELO Windows Client. The documents with Manual in the name are specifically designed to be useful for end users
as well as developers. The documentation is located at: http://
forum.elo.com/supportweb/en/documentation.
320
Appendix
Index
Access Manager, IBM DB2 - 127
Checklist, installation - 21
Indexing - 175
config.xml - 313
Conventions - 8
Copyright - 5
Disclaimer - 6
Document storage - 13
Installation, Tomcat - 97
elodb, user - 41
ELOenterprise installation - 90
ixUrlBase - 69,153
JAVA_HOME - 92
ELOprofessional, update - 72
JAVA_HOME, Linux - 95
ELOprofessional 9 installation - 45
JAVA_HOME, Solaris - 96
Fulltext - 14,171
Index
321
Textreader - 314,315,316
Java installation - 90
Keywording - 175
log4j - 318
Tomcat installation - 97
Tomcat port - 97
Microserver architecture - 12
Trademarks - 6
Update, ELOprofessional - 72
User accounts - 17
Viewer - 274
322
Index