installation guide saperion version 7 - kofax · pdf file5 installation r/link for sap ... 10...

Installation Guide SAPERION Version 7.1

Copyright © 2016 Lexmark. All rights reserved.

Lexmark is a trademark of Lexmark International, Inc., registered in the U.S. and/or other countries. All other trademarksare the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in anyform without the prior written permission of Lexmark.

Table of Contents

1 Introduction ......................................................................................................... 1

1.1 SAPERION Architecture ...................................................................................... 1

1.2 SAPERION APIs .................................................................................................. 2

1.3 SAPERION Server ................................................................................................ 3

1.3.1 SAPERION Java Core Server ........................................................................... 3

1.3.2 SAPERION Legacy Server ............................................................................... 3

1.4 SAPERION Clients .............................................................................................. 4

1.4.1 Rich Client ....................................................................................................... 4

1.4.2 Web Client ....................................................................................................... 4

1.5 System Requirements ......................................................................................... 4

1.6 Preparing for the Installation ............................................................................. 4

1.6.1 Microsoft SQL Server ...................................................................................... 5

Setting Up ODBC Data Sources in the Operating System .......................... 6

Activating Microsoft ODBC Tracing ............................................................. 8

1.6.2 Java Environment ............................................................................................ 8

Java Update ................................................................................................... 9

1.6.3 Microsoft Visual C++ Redistributable Package .............................................. 9

System Requirements ................................................................................... 9

Installing ........................................................................................................ 10

1.7 Distribution of Customer-specific Files ............................................................. 10

2 SAPERION Setup ................................................................................................ 11

2.1 Setup of a SAPERION All-In-One System .......................................................... 11

2.2 Setup of a Download Directory .......................................................................... 17

2.3 Setup of a 32 Bit SAPERION Server .................................................................. 19

2.3.1 Starting the SAPERION Java Core Service ..................................................... 23

2.4 Setup of a 64 Bit SAPERION Server .................................................................. 23

2.4.1 Hints Concerning the Characteristics ............................................................ 24

2.4.2 Central Download Installation ........................................................................ 24

Installing the Download Directory ............................................................... 24

Installing the 64 Bit Server ........................................................................... 25

2.4.3 Standalone Installation ................................................................................... 27

2.5 Java Core Server Options ................................................................................... 28

2.5.1 Microsoft SQL Server ...................................................................................... 29

2.5.2 Oracle ............................................................................................................... 30

2.5.3 IBM DB2 .......................................................................................................... 31

2.5.4 Integration of Multiple Databases to Java Core Server ................................. 32

Restrictions .................................................................................................... 33

Verifying the Configuration ........................................................................... 34

2.6 Setup of a SAPERION Client .............................................................................. 34

2.6.1 Installation using SAPERION Setup .............................................................. 35

2.6.2 CLIENT.INI Installation ................................................................................... 36

Characteristics of a CLIENT.INI Installation ................................................ 37

Distribution of Own Files ............................................................................. 37

2.7 Silent Installation ................................................................................................ 38

2.7.1 Silent Client-Installation .................................................................................. 38

Requirements ................................................................................................. 38

Software Distribution .................................................................................... 38

Configuration in "SilentFeature.ini" ............................................................. 39

Executing the Silent Client-Installation ........................................................ 40

Silent Client-Installation under Windows 8 ................................................. 41

Update ............................................................................................................ 41

Deinstallation ................................................................................................. 41

2.7.2 Silent All-in-One-Installation ........................................................................... 41

2.8 Manual Installation of the SAPERION Servers as Services ............................... 43

2.9 Application Maintenance .................................................................................... 44

3 Setup of the Web Client ...................................................................................... 45

3.1 Viewer in the Web Client .................................................................................... 46

3.1.1 Virtual Viewer .................................................................................................. 46

3.1.2 Default Viewer ................................................................................................. 46

4 Configuring the Base System ............................................................................. 47

4.1 Microsoft Management Console (MMC) .......................................................... 47

4.1.1 Setting Up a Console for the SAPERION Server ........................................... 47

Defining a Password ..................................................................................... 48

Connection to Server .................................................................................... 49

Editing Connection Parameters .................................................................... 49

Encrypting Data Transfers ............................................................................. 49

4.2 Setting Up a Complex System ............................................................................ 50

4.2.1 Hints Regarding the Usage of Multiple Core Servers ................................... 50

4.3 Configuration Java Core Server .......................................................................... 51

4.4 Media Handling after Installation ...................................................................... 51

4.4.1 Pool Conditions ............................................................................................... 52

4.4.2 Plug-In Media .................................................................................................. 52

4.4.3 File System Media ........................................................................................... 52

5 Installation R/Link for SAP ................................................................................. 52

5.1 Setup of the R/ Link Server ................................................................................ 53

5.2 Installation of IIS ................................................................................................. 55

5.3 Start of IIS in 32 Bit Mode ................................................................................. 56

5.4 Configuration of IIS for R/ Link ......................................................................... 57

5.4.1 Handler Mappings .......................................................................................... 57

5.4.2 ISAPI and CGI Restrictions ............................................................................ 57

5.4.3 Create Virtual Directory ................................................................................. 58

5.4.4 Properties of Virtual Directory ........................................................................ 58

5.5 Configuration of R/ Link Servers ........................................................................ 59

5.5.1 "General" Tab .................................................................................................. 60

5.5.2 "HTTP" Tab ...................................................................................................... 61

5.5.3 "Host" Tab ....................................................................................................... 61

5.5.4 "Logical Systems" Tab .................................................................................... 62

5.5.5 "Field mapping" Tab ....................................................................................... 63

5.6 Configure Content Repository in SAP ................................................................ 63

5.7 Certificates ........................................................................................................... 64

6 Installation OCR/ Barcode .................................................................................. 64

6.1 SAPERION Licenses ............................................................................................ 65

6.2 Languages ............................................................................................................ 65

6.3 Setup ABBYY FineReader 7 ................................................................................ 65

6.3.1 Hints concerning a CLIENT.INI-Installation .................................................. 66

6.4 Setup ABBYY FineReader 9 ................................................................................ 66

6.4.1 Activating License File .................................................................................... 68

Using Local Licenses .................................................................................... 68

Configuration File FRENGINE.INI ............................................................... 69

Netzwerklizenz verwenden ........................................................................... 70

6.4.2 Hints concerning a CLIENT.INI-Installation .................................................. 71

6.5 Setup ABBYY FineReader 10 .............................................................................. 71

6.5.1 Silent Installation of FineReader 10 ............................................................... 73

6.5.2 Installing the License Manager ..................................................................... 73

6.5.3 Activating Licenses .......................................................................................... 74

License Types ................................................................................................. 77

LicenseSettings.xml ....................................................................................... 77

6.5.4 Barcode Types .................................................................................................. 78

Barcode Recognition via COM ..................................................................... 78

6.6 Update of FineReader 9 to FineReader 10 ......................................................... 79

7 The SAPERION Business Rules Server .............................................................. 80

7.1 Introduction ......................................................................................................... 80

7.1.1 Business Logic ................................................................................................. 80

7.1.2 Java Framework ............................................................................................... 80

7.2 Installation .......................................................................................................... 81

7.3 Starting the Business Rules Server .................................................................... 81

7.4 Update Hint ......................................................................................................... 82

8 SAPERION Web Services .................................................................................... 82

9 SAPERION App Services .................................................................................... 82

9.1 Requirements ....................................................................................................... 82

9.2 Installation ........................................................................................................... 83

10 SAPERION Data Archiving for SAP ILM 1.0 ...................................................... 83

10.1 Requirements ....................................................................................................... 83

10.2 Installation ........................................................................................................... 84

1.1 SAPERION Architecture

1

Installation Guide SAPERION Version 7.1

1 Introduction

This documentation describes the initial installation of SAPERION, as well as the upgrade procedure

from older versions of SAPERION. If you are upgrading from version 7.1 to 7.5, see also the version 7.5

update guideline (in "Best Practices").

Before you can use SAPERION, storage media must also be installed and configured. These steps are

described in the "Plug-Ins" chapter in the Administration manual.

The following sections contain an overview of the system architecture, as well as the system requirements

for the installation of Version 7.

1.1 SAPERION Architecture

SAPERION is a powerful software platform used for company-wide Enterprise Content Management

(ECM) and Business Process Management (BPM). Archiving, Document Management and Workflow

comprise the core modules of ECM.

SAPERION may be installed in customized configurations, depending on the intended use. A SAPERION

system fundamentally consists of at least one download directory, which all authorized users may access,

a Core Server, and the clients (see fig. SAPERION architecture).

This system may be extended by adding any number of servers and clients, while the individual servers

cover a range of specific task areas. This allows SAPERION to offer systems that are as scalable as

required, with convenient options for load distribution.

SAPERION is designed around a client-server system architecture, which delivers significant benefits in

particular for globally active companies with numerous branches, remote locations, etc.

1 Introduction

2

Fig. 1–1: SAPERION architecture

Because of the SOA architecture a simple and fast integration in different systems is enabled. In this

way, the integration of efficient ECM functions in existing company structures are ensured based on the

provided APIs (Application Programming Interfaces): Java, COM, .NET, web services.

1.2 SAPERION APIs

+ COM (Component Object Model)

SAPERION objects allow an extensive integration and automation. COM objects are used in

SAPERION, customers' applications and/ or EventScript.

+ ActiveX Objects

Utilization of pre-defined or self-implemented ActiveX objects, e.g. usage of SAPERION viewer in

customers' applications.

+ DLL / Shared Objects / Java / .NET

The access to SAPERION features is flexible thanks to the standardized interface for all platforms.

+ Web Services

Web services ensure applications from & .NET.

+ JSR170/ JCR 1.0

1.3 SAPERION Server

3

SAPERION is member of JCP & JSR 283 Expert Group

1.3 SAPERION Server

SAPERION servers have the following features:

+ Several different servers can run on a single computer

+ Under heavy load, it is possible to configure distribution across multiple computers

+ All servers are multi-threaded

+ SAPERION servers are configured using the MMC (Microsoft Management Console). Custom snap-

ins are used for this purpose

+ All servers are available as a service, but may also be started as a process

1.3.1 SAPERION Java Core Server

The SAPERION Java Core is the interface opening SAPERION to Java, it facilitates interaction with

numerous Java APIs.

The main function of the Java Core Server is to bundle database accesses and other options for the

clients. This has the advantage that client installations of the SQL database in use should only take

place on the Java Core Server, and not on each individual workstation. The entire ODBC configuration

takes place exclusively on the Core Server. The Core Server needs only to be connected to the SAPERION

network, and may then be started without further configuration.

The Java Core Server receives client database queries, forwards them to the appropriate database server,

and returns the query result to the client. This procedure reduces the amount of data transferred over

the network during a document search to a minimum.

Because the Core Server manages all trays for all users, documents can be exchanged among users'

trays without restrictions. Also the handling of tasks for all clients, such as the rendering (conversion

to PDF, TIF Option "Rendering") of documents is processed here. Additionally the configuration files

and the query and index forms are managed by the Core Server; if necessary, it also provides clients with

necessary program files for download.

Regarding the administration the Core Server's architecture allows a remote access from any computer

using the Microsoft Management Console (MMC).

1.3.2 SAPERION Legacy Server

The Legacy Server is a 32 bit server that is running in a 64 bit environment. Its role is to take over

functions which the Core Server provides until now only in a 32 bit environment by means of Lead Tools.

This is for example the display of Lead-compressed image files in the Web Client.

Futhermore, the Legacy Server enables all Core Server tasks (own EventScripts) to be executed on a 64

Bit server.

1 Introduction

4

The administrator has the possibilty to configure the Legacy Server via the Microsoft Management

Console (MMC) with particular snap-ins.

! Please keep in mind that Legacy Server and Java Core Server must run on the same machine.

1.4 SAPERION Clients

SAPERION offers two types of clients: the Rich Client and the Web Client. These are described in more

detail in the following section.

1.4.1 Rich Client

The SAPERION Rich Client offers the following features:

+ Each time SAPERION starts, the system automatically checks for changes made since the last login.

If necessary, required files are loaded on to the local computer.

+ Program files are saved locally, guaranteeing high performance.

+ Administrative tasks can only be carried out with the Rich Client; this includes e.g., creating forms

and user administration.

1.4.2 Web Client

The SAPERION Web Client is a modern web-based client that can be accessed directly in a browser,

without installation. Because the program interface and navigation correspond with that of the Rich

Client, working with the Web Client is possible without retraining.

1.5 System Requirements

Please refer to the compatibility list of SAPERION to obtain the current system requirements for

SAPERION. The list is provided at the following link:

http://portal.saperion.com/docsxml/downloads/SAPERION_Compatibilitylist_V7.1_SP6.pdf

1.6 Preparing for the Installation

For a SAPERION installation, you have to prepare the system on which SAPERION should be installed.

This may also include the network configuration, the setting up of SQL database, but also the installation

of the appropriate Java environment and the ODBC data sources. These steps are described in this

chapter.

i Installation must be carried out with administrator permissions, because DLLs must be registered

and print drivers installed.


5

For trouble-free installation of the SAPERION system, we recommend to ensure the system requirements

(see above) but also to clarify some questions beforehand, like "Which storage systems will be used".

For this purpose, please refer to the current compatibility list provided by SAPERION.

1.6.1 Microsoft SQL Server

The installation of SAPERION 7.1 requires the presence of a SQL database including ODBC access. First,

check if a database with user and necessary rights are already installed for SAPERION. If not, set up a

database.

For the authentication a specific database user has to be stated with the following rights:

+ Create and configure database views

+ Create and configure own user-specific functions

For Microsoft SQL Server, this means SQL authentication must be used. It is not possible to use NT

authentication.

Database connections must be configured appropriately for multi-user database access.

1. Install the Microsoft SQL Server with "Mix Mode Authentication". A must be specified.

2. Specify a password for the user "sa". This password is required in the following procedures

to log in to the database.

3. Open the SQL Server Configuration Manager from Start > All Programs > Microsoft Server

> Configuration Tools > SQL Server Configuration Manager.

4. Click "SQL Server Network Configuration".

5. Click " Protocols for MSSQLServer".

6. Open the right-click shortcut menu for "TCP/ IP" and select the "Enable" entry.

7. Then open the right-click shortcut menu for "TCP/ IP" and select the "Properties" entry.

8. Go to the "IP Addresses" tab and delete the entries in the "TCP Dynamic Ports" field in

the "IPAll" section.

1 Introduction

6

9. Enter 1433 (default port of the SQL server) in the "TCP Port" field..

10. The address can then be tested under "jdbc:sqlserver://<...server IP address...>".

1.6.1.1 Setting Up ODBC Data Sources in the Operating System

To be able to access data saved in the SQL database, at least one ODBC data source (standard data

source) must be set up on the Core Server.

! A 32-bit data source is required, even under 64-bit Windows. This may be created under ":

"%WINDIR%\SysWOW64\odbcad32.exe".

ODBC data sources store information on how a connection to the SQL database is to be established.

For more information on data sources, see the Microsoft Help system.

You can define any number of additional data sources, and in this way distribute SAPERION tables across

multiple different SQL databases on the network as required.

ODBC data sources are configured in the "ODBC Data Source Administrator" dialog.

Proceed as follows to create a new data source:

1. Open the "ODBC Data Source Administrator" dialog from Start > Administrative Tools >

Data Sources (ODBC) to create ODBC data sources.

2. Go to the "System DSN" tab.


7

3. Click [Add] to add a new data source.

4. Select the desired ODBC driver. Click [Finish] to save the settings.

Depending on the selected driver, the "Create New Data Source" dialog may appear to

guide you through the process of setting up the data source.

5. Enter a meaningful name for the new data source and click [Finish] to save the settings.

! Only alphanumeric characters are permitted for data source names;

space characters are not allowed.

6. Now select the desired database server.

7. Click [Next].

8. Select SQL server authentication using a login ID and password entered by the user.

9. Enter the user name and password assigned during database creation for SQL server

authentication.

10. Specify the default database.

1 Introduction

8

11. Follow the remaining instructions.

1.6.1.2 Activating Microsoft ODBC Tracing

You can activate the Microsoft ODBC log from the "Tracing" tab. This will generate a highly detailed log.

Because the SAPERION log is generally also highly detailed, it should only be necessary to activate the

Microsoft ODBC log in rare cases.

! Activating the ODBC log results in a significant performance hit for your system, and should

therefore only be used in serious situations.

Fig. 1–2: Dialog "ODBC Data Source Administrator“ - Tracing

i More detailed help can be found in the Windows Online Help system.

1.6.2 Java Environment

! Server start problem when using Java 1.6 Update 29: The service of the Java Core Server sends

a false signal when using JDK 1.6 Update 29. While the server is starting and can be networked,

the Windows service status is wrong. A downgrade to Java 1.6 Update x (e.g., 1.6_20 or 1.6_28)

enables a trouble-free installation

For the use of SAPERION the Java Development Kit is necessary. If no appropriate Java version is

installed, proceed as follows:


9

1. Go to the website http:\\java.sun.com.

2. Select the version of Java appropriate for your operating system and download it.

i A 32-bit Java environment is also required on 64-bit operating

systems if a 32-bit Java Core Server is installed.

3. Install Java on your system.

1.6.2.1 Java Update

If you have executed a Java update after the SAPERION installation, it is absolutely necessary to change

the Java version in the "wrapper.conf" file.

1. Open the "wrapper.conf" file in the following directory:

"...\SAPERION\Application\scr\scr-javacoreserver\config".

2. Enter in the following section your current Java version:

wrapper.java.command=C:\PROGRAM FILES\JAVA\<Java Version>\BIN\java

1.6.3 Microsoft Visual C++ Redistributable Package

The Microsoft Visual C++ 2008 resp. 2010 Redistributable Package (x86) installs runtime components

of Visual C++ Libraries required to run applications developed with Visual C++ on a computer that does

not have Visual C++ 2008 resp. 2010 installed. This package installs runtime components of C Runtime

(CRT), Standard C++, ATL, MFC, OpenMP and MSDIA libraries. For libraries that support side-by-side

deployment model (CRT, SCL, ATL, MFC, OpenMP) they are installed into the native assembly cache, also

called WinSxS folder, on versions of the Windows operating system that support side-by-side assemblies.

These C components are required so the JNI (Java Native Interface) can connect with the SAPERION

Core Server, because the connection takes place over a defined C-Java interface and a Modula-C interface

on the Core side. This is necessary because the C-Java connection is a standardized component, while

a Modula-Java connection does not exist.

1.6.3.1 System Requirements

i Make sure you have the latest service pack and critical updates for the version of Windows that

you are running. (Visit the Microsoft Windows update site to find the latest security updates.)

Microsoft Visual C++ 2008 Redistributable Package (x86)

+ Supply Source x86

http://www.microsoft.com/en-us/download/details.aspx?id=29

+ Supply Source x64


1 Introduction

10

+ Supported operating systems

Windows 2000 Service Pack 4, Windows Server 2003, Windows Vista, Windows XP

+ Required software

Windows Installer 3.0 Windows Installer 3.1 or later is recommended.

+ Hardware Requirements

Hard disk space minimum 6 MB (x86)

Microsoft Visual C++ 2010 SP1 Redistributable Package (x86)

+ Supply Source x86


+ Supply Source x64


+ Supported operating systems 2010

Windows 7, Windows Server 2003, Windows Server 2008, Windows Server 2008 R2, Windows Vista,

Windows XP

+ Required Software

Windows Installer 3.0 Windows Installer 3.1 or later is recommended.

+ Hardware Requirements

Hard disk space minimum 25 MB (x86)

1.6.3.2 Installing

Proceed as follows to install:

1. To download the Microsoft Visual C++ package, go to the website mentioned above.

2. Click [Download] to start the download.

3. Select one of the following:

+ Click [Run] to start the installation immediately.

+ Click [Save] to save the download to your computer for installation at a later time.

+ Click [Cancel] to cancel the installation.

4. Follow the instructions in the Setup wizard during installation.

i If you have installed previous pre-release versions of Visual C++ 2008 resp. 2010 or

Visual Studio 2008 resp. 2010, such as Beta 1, Beta 2 or Community Technical Preview (CTP)

builds, then you must uninstall these versions via Add/Remove Programs in Control Panel before

installing the final released version.

1.7 Distribution of Customer-specific Files

With the SAPERION installation package you are provided with the possibilty to distribute individual

files. For example, a PROGRAM.INI adapted to your own requirements or company-internal OCX-files

2.1 Setup of a SAPERION All-In-One System

11

can be copied into the folder ("CustomFiles") which is specifically intended for this purpose. These files

are then copied automatomatically into the SAPERION installation directory at a new installation, update

or repair process.

Please copy the required files into the following directory: "...:\x86\components\CustomFiles".

i Please keep in mind that you have to ensure the availability of corresponding DLLs when

distributing OCX-files.

2 SAPERION Setup

After you have finished preparing the system on which you want to install SAPERION, you can now

execute the installation.

i At a new installation of SAPERION, a at least a medium, a server pool, a global pool and also a

write buffer must have been configured before starting the client.

The installation of a distributed system is divided into several steps. These are:

+ Installing a download directory

+ Installing the required servers using the installation CD

+ Installing the clients


With an All-in-One installation, a completely functional SAPERION system is installed on a computer

with all available servers and the client. All components are installed on a single computer.

The following installation steps are necessary:

1. Open the "SAPERION 7.1 Setup" dialog by double-clicking the "setup32.exe" file.

2. Select the language in which you want to carry out the setup procedure from the drop-

down menu.

You may optionally specify a log file to log the steps carried out by the setup procedure.

Click [Next].

2 SAPERION Setup

12

3. A message window will appear with some important hints. Click [Next] to continue with

the installation.

4. Select the "SAPERION All-In-One System" installation mode by clicking the corresponding

radio button, then click [Next].

5. Select the installation directory. The default installation directory for 32-bit is "...\Program

Files(x86)\SAPERION". You can change it by clicking the [Browse] button. Click [Next].


13

6. Next, enter the serial number provided and the associated license key. Click [Next].

The combination of the serial number and feature key allows SAPERION to recognize

which program options are available to you. In the case of an all-in-one installation, all

servers and options approved by the license key are installed on the computer.

7. You have the option to select servers in the next step.

In addition to the Java Core Server, which must be installed, other servers available

in SAPERION may also be installed in an all-in-one installation. Selecting the servers

automatically installs the corresponding server as a service.

8. Depending on your purchased key, the following options may be activated on the client

side:

+ Sample Project File Application

+ MMC Snap-Ins

+ Barcode

+ OCR

+ Scanner

2 SAPERION Setup

14

+ KOFAX

+ COLD

+ Security

+ PDF Tools

i When you do a new installation with the project file application, you

will need to manually choose the corresponding forms for the project

documents after restarting the client.

Click [Next].

9. Enter the system defaults for the configuration:

+ NamedPipe/ IPHost

The default value of the current computer is shown here. You should not change this

setting since only one Core Server is installed in an all-in-one installation.

+ Default language

You can specify the system language via the dropdown box.

+ Default mail option

Specify the type of e-mail connection via the dropdown box.

Click [Next].

10. Specify a user account to be used to execute a service. Click [Next].

i The "Local system" is selected by default for the all-in-one

installation; this setting does not need to be changed.


15

11. Provide the following entries on the ODBC data source in use:

i The ODBC data source must be set up before installing SAPERION.

+ DSN

The drop-down menu lists all available system data sources. Select the desired

source.

The 32 bit DSN is only necessary when SAPERION should be installed as 32 bit. When

calling up the "setup32.exe" the installer recognizes the 32 bit data sources; when

executing the "setup64.exe" the 64 bit data sources are displayed.

+ DB User

Enter the username of the database user in the free text field.

+ DB Password

Enter the password required for communication with the database.

Click [Next].

12. You can optionally select a scanner driver. The settings made here can also be made or

changed at a later point in time. Click [Next].

13. At least one medium is required to work with SAPERION. This default medium is created

automatically during installation. You can change the target directory for the medium by

clicking [Browse]. Click [Next] to continue the installation process.

2 SAPERION Setup

16

14. Choose the path to the "java.exe" with which you would like to start the Java Core Server.

Click [Next].

15. Now define the Java Core Server options. Further details can be found in the section "Java

Core Server Options" below.

16. The installation can now be started by [Next].

During the installation procedure, all components are copied to the specified directory, and the

subdirectories are created.

After the installation procedure completes successfully, an executable all-in-one system is installed

and is immediately ready for use on the computer once the server and the client have been started.

Corresponding entries will appear in the Start menu for you to easily start the program.

It is necessary to change the password after the first time you log in as administrator (user name:

Administrator, password: Berlin). The Rich Client must be started to carry out this task, as the password

can only be changed using the Rich Client.

2.2 Setup of a Download Directory

17

i In case of a new installation the user "Administrator" and also "DFEngine" and

"WfBusinessRuleServer" are applied. These are used for system internal purposes and must not

be removed.

2.2 Setup of a Download Directory

Under this installation type, a download directory is created on the computer, containing all files

necessary for the servers and clients distributed across the network. Proceed as follows:



down menu.


Click [Next].

3. Select the "SAPERION Download Folder" option by clicking the corresponding radio

button. Click [Next].



2 SAPERION Setup

18

5. Next, enter the serial number provided and the associated license key. Click [Next].

6. Now select the feature "Download" and click [Next].

7. Enter the system defaults for the configuration:

+ NamedPipe/ IPHost

2.3 Setup of a 32 Bit SAPERION Server

19

The default value of the current computer is shown here. You should not change this

setting since only one Core Server is installed in an all-in-one installation.

+ Default language

You can specify the system language via the dropdown box.

+ Default mail option

Specify the type of e-mail connection via the dropdown box.

Click [Next].

8. The installation can now be started by [Next].

During installation, the "Share" directory is created, through which installation of servers and clients on

other computers takes place. If necessary, the directory name may be changed.


If you select this type of installation, a server that updates its program files from the central download

directory according to CLIENT.INI will be installed on the computer. This requires that a download

directory exist, and that sharing is configured. A prerequisite for this is that a released download directory

has already been created. Furthermore, the network path to this directory must be known.



down menu.


Click [Next].

3. Select the "SAPERION Server" installation mode by clicking the corresponding radio


2 SAPERION Setup

20



5. Enter the path to the central download directory (PROGRAM.INI) via the [Browse] button.

6. With the [Get License] button the serial number and the corresponding license key can be

obtained out of the stated PROGRAM.INI. Click [Next].

7. Next, select the server and features to be installed on this computer. Click [Next].


21

8. Depending on your purchased key, the following options may be activated on the client

side:


+ MMC Snap-Ins

+ Barcode

+ OCR

+ Scanner

+ KOFAX

+ COLD

+ Security

+ PDF Tools




Click [Next].


10. Provide the following entries on the ODBC data source in use:

2 SAPERION Setup

22

i The ODBC data source must be set up before installing SAPERION.

+ DSN

The drop-down menu lists all available system data sources. Select the desired

source.

The 32 bit DSN is only necessary when SAPERION should be installed as 32 bit. When

calling up the "setup32.exe" the installer recognizes the 32 bit data sources; when

executing the "setup64.exe" the 64 bit data sources are displayed.

+ DB User

Enter the username of the database user in the free text field.

+ DB Password

Enter the password required for communication with the database.

Click [Next].


Click [Next].




23

13. Click [Next], and the installation will begin.

2.3.1 Starting the SAPERION Java Core Service

After having successfully installed the SAPERION Java Core Server you can start it as service. By default,

the services is automatically installed in the local system account.

i We recommend not to register the SAPERION Java Core Server service with the local system

account.

Modifications of the account can be made in the properties of the Java Core Server service.

Fig. 2–1: Dialog "SAPERION Java Core Server Properties"


For the installation of a 64-bit server, there are two possibilities available:

+ Central download installation

+ Standalone installation

as for this installation type the 64-bit server is based on the 32-bit version which enables access to the

MMC.

2 SAPERION Setup

24

i We recommend the central download installation.

2.4.1 Hints Concerning the Characteristics

Please keep in mind that the following features cannot be used with the 64-bit server:

+ LTANS (Long-Term Archiving and Notary Service)

+ Signature Service from AuthentiDate

+ Secrypt Server

+ Macro editor Cypress from Cypress Software

+ Annotations cannot be created in the Web Client

+ Server-based rendering

The following feature has to be activated manually in the PROGRAM.INI if required:

+ dtSearch Engine for full text search

[Modules64]

Retrieval=DTSEAR64.RET

2.4.2 Central Download Installation

This type of installation creates a download directory on the current computer. It contains all files

necessary for the server and clients distributed on the network. During this process the PROGRAM.INI

is created which contains details (i.e. the IP address) about the installation directory of the Core Server.

The installation is identical to the installation of a 32 bit SAPERION server because the 64 bit server is

built upon it. This enables inter alia the access to MMC.

Please make the following two steps for this installation:

+ Installation of a download directory

+ 64 bit server installation

2.4.2.1 Installing the Download Directory

First, execute the installation of the download directory which is described in chapter "Installing a

Download Directory" above.


25

i Please activate the "setup32.exe" file for this purpose as only by this file a download directory can

be installed.

2.4.2.2 Installing the 64 Bit Server

After having successfully installed the download directory, you can install a 64-bit server. Please note

that you will need a 64 bit license key as well as a CPU license or a Core Server license.

Follow the steps below to install a 64 bit SAPERION server:

1. Make a double click on the "setup64.exe" file to open the "SAPERION 7.1 Server x64

Setup" dialog.

2. Select the desired installation language in the following dialog. You can also create an

optional installation log file. Click [Next].


the installation.

4. Select the destination folder. Click [Next].

5. Select the type of installation in the following dialog. Activate the radio button "Central

download installation". By doing so you have the facility to select the PROGRAM.INI from

the central download directory via the [Browse] button.

6. Click [Get license] to get serial number and license key from the central download directory

and to automatically enter them in the respective text fields. Click [Next].

7. Select in the following dialog the features:

2 SAPERION Setup

26


+ Fulltext




Click [Next].

8. Enter the respective details below to configure the ODBC source:

+ DSN

+ DB user

+ DB password

Click [Next].


Click [Next].


27



11. Click [Next] to complete the installation.

2.4.3 Standalone Installation

With this installation type no administrative access to the server via the MMC is offered.

For standalone installation of a 64 Bit SAPERION server follow the steps described below:

1. Make a double click on the "setup64.exe" file to open the "SAPERION 7.1 Server x64

Setup" dialog.

2. Select the desired installation language in the following dialog. You can also create an

optional installation log file. Click [Next].


the installation.

4. Select the installation directory. You can change it by clicking the [Browse] button. Click

[Next].

5. Activate the radio button "Standalone Core Server". Enter the serial number and license

key in the provided text fields. Click [Next].

2 SAPERION Setup

28

6. Select in the next dialog the features:


+ Fulltext




Click [Next].

7. Enter the respective details below to configure the ODBC source:

+ DSN

+ DB user

+ DB password

Click [Next].


Click [Next].



10. Click [Next] to complete the installation.

2.5 Java Core Server Options

You have to specify some parameters for the Java Core Server during the SAPERION setup. This chapter

contains the example configurations for the following servers:

+ Microsoft SQL Server

+ Oracle

+ IBM DB2


29

Fig. 2–2: Java Core Server Options

The here stated values can always be modified in the [ApplicationServer] section of the ARCHIEF.INI.

2.5.1 Microsoft SQL Server

Example

[ApplicationServer]

dbdriver=com.microsoft.sqlserver.jdbc.SQLServerDriver

dbtype=MSSQL

schema=dbo

dbpoolurl=jdbc:sqlserver://<IP-address>:1433;instanceName=sqlserver;database=saperion;

dbpoolsize=200

dbpooltimeout=1000

dbpooluser=saperion

dbpoolpass=saperion

guestuser=

guestpass=

useinsertimage=True

Configuration for Microsoft SQL Server

dbdriver JDBC driver to establish the JDBC database connection:


dbtype Database used in SAPERION. This parameter is required to generate objects related to the

database.

schema Database schema used. The information on the schema is required to generate and execu-

te SQL requests, user-specified functions, and stored procedures.

dbpoolurl URL of the database to establish a connection to the data source

dbpoolsize JDBC connection pool

dbpooltimeout Database connection timeout

dbpooluser User name of the database user

dbpoolpass Password of the database user (encrypted using the JConsole)

2 SAPERION Setup

30

useinsertimage When accessing a SAPERION document, an image file is used instead of the original appli-

cation.

Default: TRUE

i Since SAPERION version 7.1 SP1 the switch "user_timeout" is no longer in use. If you need to

configure a timeout whose exceeding which leads to a new user login, you have to set manually

the CleanupTimeout (in seconds) in the [Broker] section of ARCHIEF.INI.

2.5.2 Oracle

Example

[ApplicationServer]

dbdriver=oracle.jdbc.driver.OracleDriver

dbtype=ORACLE

schema=

dbpooluser=saperionuser

dbpoolpass=saperionpassword

dbpoolurl=jdbc:oracle:thin:saperionuser/saperionpassword@<IP-address>/<name>

dbpoolsize=500

dbpooltimeout=1000

guestuser=<...>

guestpass=<...>

useinsertimage=True

i Since SAPERION version 7.1. SP1 the switch "user_timeout" is no longer in use. If you need to

configure a timeout whose exceeding which leads to a new user login, you have to set manually

the CleanupTimeout (in milliseconds) in the [Broker] section of ARCHIEF.INI.

Configuration for Oracle

dbdriver JDBC driver to establish the JDBC database connection

dbdriver=oracle.jdbc.driver.OracleDriver

dbtype Database used in SAPERION. This parameter is required to generate objects related to the

database.

schema Database schema used. The information on the schema is required to generate and execu-

te SQL requests, user-specified functions, and stored procedures.

dbpoolurl URL of the database to establish a connection to the data source.

General form:

jdbc:oracle:thin:[user/password]@[host][:port]:SID

jdbc:oracle:thin:[user/password]@//[host][:port]/SID






31

guestuser User name of the SAPERION user in use.

guestpass Password of the SAPERION user in use.


cation.

Default: TRUE

Oracle Version 11.2. and Java version 1.7

! When using Oracle version 11.2 or higher together with Java version 1.7 or higher, the "ojdbc6.jar"

must be used.

Please copy the "ojdbc6.jar" file into the ".../scr-javacoreserver/lib"-directory and remove the existing

"ojdbc14.jar".

The "ojdbc6.jar" can be copied from the installation directory of your Oracle client on the server

(e.g., "<ORACLE installation path>\Administrator\product\11.2.0\dbhome_1\jdbc\lib") or alternatively

a download is available under this link:

http://www.oracle.com/technetwork/database/enterprise-edition/jdbc-112010-090769.html

2.5.3 IBM DB2

Please note the following information when using IBM DB2:

+ DB2 version 9.07 64-bit is supported

+ ODBC driver : 64-bit or 32-bit

+ IBM DB2 has to be installed with UTF 8

+ The table space has to be 32K

The following ODBC settings have to be configured for DB2:

Example

[ApplicationServer]

;DB2

dbname_1=DB2_64

dbdriver_1=com.ibm.db2.jcc.DB2Driver

dbtype_1=DB2

schema_1=DEV71

dbpooluser_1=DEV71

dbpoolpass_1=saperion

dbpoolurl_1=jdbc:db2://DB2-W2K8R2:50000/saperion

dbpoolsize_1=200

dbpooltimeout_1=300

useinsertimage_1=TRUE

2 SAPERION Setup

32

Configuration for IBM DB2

dbdriver JDBC driver to establish the JDBC database connection:

dbdriver=com.ibm.db2.jcc.DB2Driver

dbtype Database used in SAPERION.

This parameter is required to generate objects related to the database.

schema Database schema used:

The information on the schema is required to generate and execute SQL requests, user-

specified functions, and stored procedures.

dbpoolurl URL of the database to establish a connection to the data source:

Example

dbpoolurl=jdbc:db2://DB2-W2K8R2:50000/saperion

DB2-W2K8R2 = Name of the DB server

50000 = Port

saperion = DB alias name





guestuser User name of the SAPERION user in use.

guestpass Password of the SAPERION user in use.


cation.

Default: TRUE

2.5.4 Integration of Multiple Databases to Java Core Server

! The configuration of multiple data sources to the Java Core Server is supported from SAPERION

7.1 SP1 on.

If you want to use several databases you have to make the configuration in the [ApplicationServer] section

of the ARCHIEF.INI.

Multiple data sources can be configured by adding a counter to the necessary parameters. Parameters

for the default data source have no counters.

Below the integration of two databases is illustrated by means of an example configuration.

The data source named "saperion" is applied as default data source on a MS SQL server and the

additional data source named „oraclexe“ is on an Oracle server. (For a third data source the according

parameters ought to be extended by the counter „_2“).

[ApplicationServer]

# MSSQL

dbname=saperion



33

dbtype=MSSQL

dbpoolurl=jdbc:sqlserver://127.0.0.1:1433;instanceName=sql;database=

saperion;

schema=dbo

dbpooluser=saperion

dbpoolpass=b6auU8WVCP+nLWNDCTbAkg==

dbpoolsize=200

dbpooltimeout=1000

# ORACLE

dbname_1=oraclexe

dboffline_1=false

dbdriver_1=oracle.jdbc.OracleDriver

dbtype_1=ORACLE

dbpooluser_1=SAPERION

dbpoolpass_1=b6auU8WVCP+nLWNDCTbAkg==

dbpoolurl_1=jdbc:oracle:thin:@127.0.0.1:1521:xe

schema_1=SAPERION

dbpoolsize_1=200

dbpooltimeout_1=1000

Parameters for the integration of multiple databases

Parameter Description

dbname Name of the data source

NOTE: Please keep in mind that each data source must have a unique name (this is also

required for already existing databases). The name must then be identical to the name of

the configured data source applied in the MMC.

dboffline Optional

TRUE = The data source is set offline. In this mode no queries on tables of this data source

is possible. Please note that the default data source cannot be set to the offline mode.

i In order to deposit the password for the database user in an encrypted form in the ARCHIEF.INI

the JConsole or another JMX-client can be used. The parameters of the ARCHIEF.INI can be found

under "Saperion > backend > attributes".

2.5.4.1 Restrictions

Please keep the following restrictions in mind:

+ System Tables

All of the system tables, such as "xnmain", "xlocks" or "xrevise" must always be on the default data

source.

+ File Application/ Outliner Application

For the File application/ Outliner application the respective documents DDC and folder DDC must

be on the same database.

+ Document Collections

2 SAPERION Setup

34

In order to be able to add documents to document collections the documents DDC must be on

the default database.

+ IXOS Connector

The DDC for IXOS Connector must be on the default database.

+ Fulltext Search

In cases multiple data sources are used via the Classic Connector and these data sources are on

different database systems (e.g., MSSQL and Oracle) the fulltext search only works on default data

sources.

2.5.4.2 Verifying the Configuration

When the logger of the Java Core Server is set to level "Info" messages about the configured data sources

are issued at the start. For the above mentioned example configuration the following message will be

issued:

INFO com.saperion.rmiserver.SaDataSourceManager:208 - Added data-source. Name: saperion, type: MSSQL, default: true

INFO com.saperion.rmiserver.SaDataSourceManager:208 - Added data-source. Name: oraclexe, type: ORACLE, default: false

For each data source an own object-related mapping for the access to the tables is created. To verify

the mapping the optional parameter "writeHibernateMapping=TRUE" in the "saperion.properties" file

can be specified. At the restart of the Java Core Server XML-files containing the content of the mapping

are generated. These files are named according to the pattern "hibernateConfig-<Name of the data

source>.xml" and then stored in the configuration directory of the Java Core Server.

i The XML-files serve only the verification of the mapping and will be overwritten at every restart

of the Java Core Server.

2.6 Setup of a SAPERION Client

This installation type installs a SAPERION client on the current computer. This requires that a download

directory already exist, that sharing is configured, and that the path to this directory is known.

Two different options are available for the installation of the SAPERION client:

+ Installation using SAPERION setup

+ Client Installation with dynamic update and without the CD ("CLIENT.INI-Installation")

i Use SAPERION setup to install the clients that will be used to administer the SAPERION system,

because the MMC snap-ins may be selected here.


35

2.6.1 Installation using SAPERION Setup

This type of installation is primarily used for clients with special options, scanners, etc. Proceed as follows

to install the client on the computer:



down menu.


Click [Next].

3. Select the "SAPERION Client" installation mode by clicking the corresponding radio





2 SAPERION Setup

36



7. Next, select the server and features to be installed on this computer. Click [Next].

+ Sample Project file application docs

+ MMC Snap-Ins

MMC Snap-Ins are used for the administration and configuration of the SAPERION

server. They need to be installed on the client which is intended for the administration.

+ Barcode

+ OCR

+ Scanner

+ KOFAX

+ COLD

+ Security

8. Click [Next ] to start the installation of the SAPERION client including the selected features.

9. Click [Finish] to complete the installation.

2.6.2 CLIENT.INI Installation

Simple clients on which no special functions are to be used can be set up without the installation CD

using the dynamic CLIENT.INI file.

This client installation is dynamic and may carry out an update if necessary (if the system settings in

the central system have since changed) or load any missing components as necessary (e.g., to switch

to another language).

If an error occurs during a CLIENT.INI download, it will be recorded in the event log.

Proceed as follows:

1. Copy the "archie32.exe" file from the central SAPERION installation to the locally

configured SAPERION directory.

2. Create a CLIENT.INI file in the local directory. This file contains the path to the central

download directory, and is structured as follows:


37

[Config]

SourcePath=<path>

UseProxy=TRUE

LogEvents=TRUE

Parameters of the [Config] section


SourcePath Please specify path as HTTP, FTP or file.

Example

SourcePath=http://www.Saperion.de/example

Using a secure SSL connection:

SourcePath=https://www.Saperion.de/example

SourcePath=\\<computer name>\<Name of the

released folder>

SourcePath=ftp://ftp.Saperion.de

UseProxy TRUE = Using the Internet Explorer proxy settings

LogEvents TRUE = Activate event logging for the update

using CLIENT.INI.

Set to FALSE by default.

3. Run the local "archie32.exe". A download will begin automatically.

2.6.2.1 Characteristics of a CLIENT.INI Installation

If you are planning a new installation with CLIENT.INI please consider the following notes: independent

from the administrator right for the registration of SAPERION DLLs (e.g. CodeJock-OCX), both normal

user and the user with appropriate rights (administrator) must have the possibility to access the files

from the network SAPERION share directory (network rights).

2.6.2.2 Distribution of Own Files

You have the facility of distributing automatically own files (such as DLLs or configuration files) during

installation. For this purpose the PROGRAM.INI of the server must be adapted.

! Please keep in mind that the User Account Control (UAC) has to be adapted as well in some cases.

Example

[Distribute]

Test1=test1.exe

test2=test\test2.exe,signed

test31=test\sign1.exe,signed

The specified path is relative to the SAPERION directory. After the file name, two options may be

specified:

2 SAPERION Setup

38

+ signed: must be signed by SAPERION

+ register: will be registered after download

2.7 Silent Installation

2.7.1 Silent Client-Installation

SAPERION supports the so called "silent" client installation. In this case the installation of the program

files will be executed completely without user input (e.g. directory names, key, serial number).

This kind of installation will be done by calling "msi.exec" with appropriate parameters. This is a kind of

Microsoft program which enables the controlling and automation of the installation of MSI- packages.

! Please do not execute a silent client installation on the machine where a Core Server is already

installed, because this may lead to defective overwriting of existing server settings.

2.7.1.1 Requirements

For an automatic installation of a SAPERION client with "msiexec.exe" the following requirements must

be given:

+ The Core Server must have been installed and started

+ The Core Server must be reachable over network.

2.7.1.2 Software Distribution

First, copy the installation resources into an own directory. Installation resources are files that are

distributed on the SAPERION-DVD. Please keep in mind that the directory structure must not be

changed.

For the software distribution you may downsize the directory structure. The following notes have to be

considered:

Fig. 2–3: SAPERION Directory Structure

+ The "Share"-directory must only contain the "Program.init"-file.

i From SAPERION version 7.1 SP 1 on the "Share"-directory can be omitted.

+ The "Application"-directory must contain all files that are in the "Root"-directory.


39

+ Depending on which additional features you need the "finered9", "kofax" and "security"-directories

have to maintained.

The activation of these features can be done in the configuration file "SilentFeature.ini" by

setting the parameters for the respective features to TRUE (see also chapter Configuration in the

"SilentFeature.ini" below).

+ all files in the "ubi"-directory have to be maintained.

2.7.1.3 Configuration in "SilentFeature.ini"

! Please note that the "SilentFeature.ini" configuration file must exist for all kinds of installation

(new installation, update, modifying and repairing). If not so, the installation will be interrupted

and you will get the following message in the logfile: "Installation terminated, missing

'SilentFeature.ini'".

1. Open the directory where "setup.msi" of SAPERION is deposited.

2. Here, you will find the "Template_SilentClientFeature.ini"-file. Rename the file to

"SilentFeature.ini".

3. Make now the required configuration in the below stated sections.

Example

[CLIENT]

Client=TRUE

SilentClient=TRUE

UBI=TRUE

MMCSnapIns=TRUE

Barcode=TRUE

FineReader9=TRUE

Inbound=TRUE

ISIS=TRUE

SCSI=TRUE

KOFAX=TRUE

Secrypt_Local=TRUE

Authentidate_Local=TRUE

COLD_LOCAL=TRUE

PDFTools=TRUE

[CORE_SERVER]

S_CORE=DokuTestW2003SQL

S_CORE_IP=<IP address>

S_LANGUAGE=German32.lng

[SYSTEM]

KEY=xxxxx

SERIAL=xxxxx

2 SAPERION Setup

40

Parameters of the "SilentFeature.ini"


SilentClient This option must be active (=TRUE) in order to be able to process the silent installation.

S_CORE Named Pipe of the Core Server

S_CORE_IP IP-address of the Core Server

S_LANGUAGE Language that should be activated for the client

KEY Enter the license key.

SERIAL Enter the serial no.

2.7.1.4 Executing the Silent Client-Installation

1. By means of the following call the installation can be executed:

msiexec.exe /i "<Path to setup.msi>" INSTALLDIR="<Target path for client installation>" SILENT=TRUE

/q

The parameter "/q" causes an installation without display of the MSI interface.

! Please always type the value for the "SILENT" parameter in capital

letters (=TRUE); lower case letters (=true) will always be evaluated

as FALSE.

2. Beside this parameter all parameters which are supported from "msiexec.exe" can be

used, e.g. logging output.

A complete list of these parameters can be found under http://support.microsoft.com/

kb/314881/en.

Example

msiexec.exe /i "C:\download\saperion\setup.msi" INSTALLDIR="D:\saperion7" SILENT=TRUE /q

3. In cases the installation is executed error-free the logfile contains the following entry:

"Installation operation completed successfully." In the system control SAPERION is listed

as installed program.

By means of the following parameter the logfile is written:

/l <Path>\<Logfile name>

Example

/l D:\SilentLogfile.txt

4. Via the "archie32.exe" the client can be started when the Core Server has been started and

is reachable over the network.


41

i For an automated installation of multiple clients the use of installation scripts or tools for software

distribution is recommended.

2.7.1.5 Silent Client-Installation under Windows 8

Executing a client installation under Windowws 8 per "SilentFeature.ini" with the administrator account,

the SAPERION start icon is only created for the administrator.

In order to make available the SAPERION link also for users execute the installation by means of the

following call:

Example

msiexec.exe /i "C:\download\saperion\setup.msi" INSTALLDIR="D:\saperion7" ALLUSERS=1 SILENT=TRUE /q

The behaviour is controlled by the switch ALLUSERS:

ALLUSERS=1: the start icon is available for all users.

! Please always type the value for the "SILENT" parameter in capital letters (=TRUE); lower case

letters (=true) will always be evaluated as FALSE.

2.7.1.6 Update

To update an installation, you use the same "msiexec.exe" file used for a new installation. In an update,

only currently installed features are updated.

2.7.1.7 Deinstallation

1. Call up the "msiexec.exe" with parameter "x".

Example

msiexec /x "setup.msi" /q

2. SAPERION will be removed from the list of installed programs. In the logfile you will get

the following entry: "Removal completed successfully".

2.7.2 Silent All-in-One-Installation

The silent installation can also be performed for an all-in-one system. Installations of this kind issue

- analog to the user-guided installation - an instant operating SAPERION-system.

The execution of installation, update and deinstallation is the same way as the silent client-installation

(which are described in the previous chapters above). For the configuration of the silent

all-in-one-installation you have to make the following steps:

2 SAPERION Setup

42

1. First, copy the installation resources into an own directory. Installation resources are

files that are distributed on the SAPERION-DVD. Please keep in mind that the directory

structure must not be changed.

2. Open the directory where "setup.msi" of SAPERION is deposited.

3. Here, you will find the "Template_SilentClientFeature.ini"-file. Rename the file to

"SilentFeature.ini".

! Please note that the "SilentFeature.ini" configuration file must exist

for all kinds of installation (new installation, update, modifying and

repairing). If not so, the installation will be interrupted and you will

get the following message in the logfile: "Installation terminated,

missing 'SilentFeature.ini'".

4. Make now the required configuration in the below stated sections.

i Contrary to the silent client-installation the feature "SilentClient"

must not be set TRUE.

Example

Client=TRUE

UBI=TRUE

MMCSnapIns=TRUE

Barcode=TRUE

FineReader9=TRUE

Inbound=TRUE

ISIS=TRUE

SCSI=TRUE

KOFAX=TRUE

Secrypt_Local=TRUE

Authentidate_Local=TRUE

COLD_LOCAL=TRUE

PDFTools=TRUE

[CORE_SERVER]

S_CORE=<hostname core server>

S_CORE_IP=<ip core server>

S_LANGUAGE=German32.lng

S_MEDIUMPATH=C:\test

[SYSTEM]

KEY=<Saperion Feature Key>

SERIAL=<Saperion serial number>

[INSTALLMODE]

S_INSTALLMODE=IMFull

[CORE_SERVER_FEATURES]

Fulltext=TRUE

2.8 Manual Installation of the SAPERION Servers as Services

43

RLinkServer=TRUE

Download=TRUE

[ODBC]

DSN=<Data source>

DBUSER=

PWD=

2.8 Manual Installation of the SAPERION Servers as

Services

The SAPERION servers may also be installed manually as services. This may be necessary if the

installation program failed to set up the services properly, for example.

i Administrator rights are necessary to register the services.

The following section lists the corresponding registry calls for the individual servers.

+ Core Server 32 bit

regsvr32 /n /i:BrokerService:"SAPERION Core Server" base32.dll

+ Core Server 64 bit

regsvr32 /n /i:BrokerService:"SAPERION Core Server" base64.dll

+ Application Server

regsvr32 /n /i:AppService:SASRV32 base32.dll

+ R/ Link

regsvr32 /n /i:SAPService:SARLSR32 base32.dll

+ Java Core Server

Start the "InstallJavaCoreServer-NT.bat" file. This file is delivered with the SAPERION distribution

and can be found in your SAPERION installation directory under this path: ...\SAPERION\scr\scr-

javacoreserver\service

2 SAPERION Setup

44

i Please do not install the SAPERION Java Core service with a local system account, but

with a regular service user.

2.9 Application Maintenance

Running the setup program again on a computer with an existing SAPERION installation allows you to

add or remove options. It is also possible to uninstall the software from the computer.

! The options available for these procedures, in particular the removal of options, may lead to errors

and data loss in the SAPERION system. For this reason, it is recommended to make a backup

of all data beforehand.

Fig. 2–4: Modifying the Installation

The following options are available in application management:

+ Modify

The "Modify" option allows you to install or remove individual options at a later point. The feature

selection will be displayed, with the previously installed features visible. Selecting or deselecting

individual features will modify the installation on the computer.

+ Repair

Defective installations can be reinstalled with the "Repair" option. It is not possible to modify

options with this selection. Any changes that have been made will be overwritten.

+ Remove

"Remove" removes SAPERION from the computer. Registry entries and program files will be

completely deleted.

2.9 Application Maintenance

45

During the delete procedure, you will be asked if the entire program directory should be deleted.

If you respond to this query with [No], any definitions, forms and similar material you may have

created will remain present in the program directory. If you select [Yes], the entire directory will be

deleted.

3 Setup of the Web Client

A "war" file is supplied for the installation of the Web Client. This file must be copied to the "webapps"

directory of the Apache Tomcat and the server must then be restarted.

i Please also consider the "Best Practice Web Client Customizing" which offers useful tips for

customizing the Web Viewer.

i http://portal.saperion.com/docsxml/en/saperion-75/bestpractice/e-BP_webtuning.html

In the case of a standard installation of the Apache Tomcat, the following steps must be carried out:

1. Stop Apache Tomcat.

2. Copy the "scr-webclient.war" file from the SAPERION "...\SAPERION\scr\scr-webclient"

directory to the "...\Apache Foundation\Tomcat <version>\webapps" directory of the

Tomcat installation.

3. Start Apache Tomcat. This will create the "scr-webclient" directory, which contains the files

for the Web Client.

4. In cases the installation of Apache Tomcat and of the Core Server are on different machines

the configuration-file "saperion.properties" needs to be adapted. This file can be found in

the directory "...\scr-webclient\WEB-INF\classes\config".

Enter in the following section the address of your Core Server:

brokerhost=<IP-address Core Server>

i In this file you can also define the server for failover situations or the

load distribution.

5. Using the Web Client it is necessary to start the SAPERION system via the Java Core Server.

For this purpose there are two possibilities:

+ via the delivered Windows batch script "start_scr_javacoreserver.bat" which

can be found in the subfolder "...\Program Files (x86)\SAPERION\scr\scr-

javacoreserver\scripts\windows".

+ or alternatively via the installed service "SAPERION Java Core Server".

6. Open "http://<IP address of Tomcat>:8080/scr-webclient" to start the Web Client.

3 Setup of the Web Client

46

i Before an administrator can log in with the Web Client in a new installation, they must have logged

in previously with a Rich Client in order to perform the required password change.

i Beginning with version 26 of Mozilla Firefox, the Java plugin is blocked on all websites by default.

Before the SAPERION Web Client can be used, the Java plugin must be activated using the Firefox

“click to activate” feature. For more information about this feature, see the Firefox support site.

3.1 Viewer in the Web Client

3.1.1 Virtual Viewer

With SAPERION you will have as a standard the Virtual Viewer which displays documents archived in

SAPERION in the Web Client. Also editing of image files including annotations in the Virtual Viewer is

posssible.

Generally the Virtual Viewer supports the following formats:

Supported formats in the Virtual Viewer

File Type Formats

Image JPG, PNG, BMP, GIF, TIF

Application DOC, DOCX, XLS, XLSX, PPT, MSG, PDF, TXT, TIF

Using the Virtual Viewer you may make some adjustment according to your requirements. Please refer

to the administrator's manual, chapter "General Viewer Settings".

3.1.2 Default Viewer

The Default Viewer for the Web Client - contrary to the Virtual Viewer - can only display a small icon as

placeholder and the corresponding file name. Clicking to the symbol by the Web Client user the browser

tries to open the document. If not possible the dialog "Download/ Open" opens. The Default Viewer

can be deactivated in the "web.xml".

The Default Viewer is deactivated by default at the initial installation of the Web Client and can be

activated in the "web.xml". This configuration file contains all necessary entries for the Default Viewer.

In order to activate it, you only need to remove the corresponding line commented out.

In cases you don't want to use the Virtual Viewer for viewing SAPERION documents, you can deactivate

it and use the Default Viewer instead (see also next chapter). For deactivating the Virtual Viewer proceed

as follows:

1. Open the configuration file "web.xml" which is located in "scr-webclient\WEB-INF\" of

the Application Server.

2. Deactivate the Virtual Viewer in the following section by commenting out the entry:

<!-- Only for Snowbound Applet

4.1 Microsoft Management Console (MMC)

47

&SnowBoundVirtualViewer; -->

! Only one single viewer can be activated for the Web Client - if there are more than one viewer

activated, the last listed one will be used.

4 Configuring the Base System

This section describes the basic configuration of your newly installed or updated system. For more details

on further configuration necessary to be able to work with SAPERION (for example the generation of

forms, the creation of user accounts, and so on), please see the SAPERION Administrator Manual.


After installing the system, the servers can be configured and adjusted to the particular system.

SAPERION uses the Microsoft Management Console (MMC) for the configuration and management

of the server. The MMC is a tool provided by Microsoft for the management of networks, computers,

services, and other system components. SAPERION is also able to take advantage of the convenient

functions offered by the MMC.

You can find a detailed introduction to using the MMC in the Microsoft Help system, which may be

opened using "Display help file."

To set up the MMC, the appropriate snap-ins for the server are required. These must be selected during

client installation on the computer where the MMC is to be used.

i Under 64 bit Windows systems, you must start an empty MMC with "mmc/32," as the 32 bit

SAPERION server snap-ins will otherwise not be displayed.

4.1.1 Setting Up a Console for the SAPERION Server

To set up a console, the appropriate snap-ins for the server are required. Snap-ins may be selected for

installation during client installation.

1. Create a new MMC console by selecting "Start > Run" and entering "mmc". An empty

MMC appears, to which the snap-ins may then be added.

2. Select "File > Add/ remove snap-in" from the menu. The "Add or remove snap-in" dialog

appears. All available previously installed snap-ins are listed.


48

3. Select the desired snap-ins from this list "Available snap-ins" and click [Add]. Selecting

the "SAPERION Core Server Administration" snap-in is necessary in all cases.

4. When you are finished, save the current settings in the MMC console to an MSC-file.

5. For each of the added snap-ins, you can now select a server from the existing network

environment on which the Core Server is running using "Server > Connect."

Already selected servers are available in a menu list for selection, while new servers may

be selected by clicking "Select" in the "Network environment" dialog.

If you know the name of the server, you may also enter it directly in the "Server" text field.

Click [OK] after making your entry.

i To select a server, it must be started on the respective computer (as

a process or service).

6. To simplify starting the MMC, create a corresponding icon on your desktop or in the

Windows Quick Launch bar so that the MMC can be opened again at any time by double-

clicking.

i Please note that system resources will be increasingly consumed as long as the MMC is open.

4.1.1.1 Defining a Password

After initial setup of the Core Server, a password must be defined to prevent unauthorized changes to

the server configuration.

1. Open the "Set server password..." dialog from the "Server > Password" menu.


49

2. Enter the password in the appropriate text fields and click [OK]. The new password is

saved.

When first assigning a password, the "Previous password" field, in which the previous

password is to be entered, remains empty.

4.1.1.2 Connection to Server

If necessary, you may interrupt existing MMC connections to individual servers using the "Connection

> Disconnect" command.

The connection can be re-established at any time using "Server > Select."

4.1.1.3 Editing Connection Parameters

RPCs (Remote Procedure Calls) facilitate high-performance and direct communication between

individual servers and clients. The "Connection > Parameters" menu item allows you to display the

network protocol used for communication with the selected server in the "Network protocol selection"

dialog.

i If IP addresses in your network are assigned dynamically (e.g., through a DHCP server), you may

also enter the DNS names of particular computers in PROGRAM.INI, instead of the IP address.

4.1.1.4 Encrypting Data Transfers

Two options are available for secure communication between client and server:

+ SAPERION internal RPC encryption

+ Use of an SSL tunnel (e.g., OpenSSL)

RPC Encryption

SAPERION offers an in-house solution to transfer encrypted data between client and server using an RPC.

Blowfish (256 bit) is used as the encryption algorithm. To use this method, the "ENCRYPT" parameter

must be added to the definition of the connection parameters. This parameter is added using the MMC.

1. Select the "Connection > Parameters" menu item from the Core Server right-click shortcut

menu. The "Network protocol selection" dialog appears.

2. Open the corresponding connection with a slow mouse click to make the appropriate

changes.

This will enter the "ENCRYPT" parameter behind the IP address in the section in which

the Core Server connection parameters are defined in the PROGRAM.INI file (example:

<IP-address>:<Port>:ENCRYPT).

This change may also be made manually in PROGRAM.INI.

3. Restart the Core Server for these changes to take effect.


50

Using an SSL Tunnel

SAPERION supports the use of an SSL tunnel for encrypted data transfer between client and server.

To use this method, the SSL tunnel must be set up according to the documentation of the program in

use (e.g., OpenSSL, OpenSSH). Depending on the SAPERION server to which the connection is to be

established, the corresponding port must be opened:

+ Core Server: 12347

+ R/ Link: 12208

i If the Core Server is running externally (e.g., via VPN/Site-to-site), the tunnel must be configured

so that the client can reach the Core Server on port 12347.

4.2 Setting Up a Complex System

Complex systems consist of a number of components, such as servers, all connected and interacting

with one another. When setting up complex systems, the points described in the following sections are

to be observed for the individual servers.

4.2.1 Hints Regarding the Usage of Multiple Core Servers

+ Core Server in the system

Each Core Server has a list of all available Core Servers and their tasks. If changes are made here,

they will be sent by broadcast to all Core Servers.

+ Default Core Server

The default Core Server is entered when setting up the download directory. If different default

Core Servers are installed for different locations, it is necessary to set up corresponding download

directories. The Core Servers involved are made known to one another in the MMC before any

additional servers are started.

+ Resources

Resources managed by other Core Servers are requested and transferred by the default Core Server

of the client.

+ Failover server

When logging in to their default Core Server, all clients have information on which other Core Servers

are integrated in the system (this information is saved in the client’s ARCHIEF.INI file).

If the connection to the default Core Server fails, the client will connect to its failover server and

continue working with this server. To do so, the following requirements must be met:

+ The failover Core Server must have access to all current system data.

+ The failover Core Server must be able to manage all resources that have "gone down."

4.3 Configuration Java Core Server

51

+ Failover fulltext is only available if the fulltext SQL server is configured.

4.3 Configuration Java Core Server

For the configuration of the Java Core Server the configuration file "saperion.properties"

is available. You can find it in the SAPERION installation directory under this path:

"...\SAPERION\scr\scr-javacoreserver\config". In this file you have the following configuration

possibilities:

Example

starttimeout=800

sslDisabled=true

writeHibernateMapping=true

rmi.port=1099

rmi.server.port=1100

rmi.system.port=1101

rmi.userservice.enabled=true

Parameters "saperion.properties"


starttimeout Defines the timeout in seconds for starting the SCR RMI server, if this value is exceeded,

the start fails and an error will be reported.

sslDisabled Parameter to disable SSL encryption for RMI connection to Java Core Server.

writeHibernateMapping TRUE = The Hibernate mapping will be written to XML for the purpose of debugging.

rmi.port Port of the RMI connection factory

rmi.server.port Port of the RMI server

rmi.system.port Port of the RMI system

rmi.userservice.enabled

4.4 Media Handling after Installation

During the SAPERION installation a default file system medium is created as default medium. This

means that entries for the database definition XNMAIN (navigation settings of the clients) are also

written on this medium. Before starting a client for the first time, it is advisable to reconfigure the medium

to a separate medium defined by pool conditions for production systems.

Similarly, separate media where delete procedures are allowed (e.g., workflow) should be used for new

system data in version 7.1. for workflow and records management. We recommend to use preferably

plug-in media (e.g., GenericNAS).

! Media databases, write caches and read caches should not remain in the standard configuration

(in the SAPERION installation directory).

5 Installation R/Link for SAP

52

4.4.1 Pool Conditions

If you are intending to store system data for navigation on separate media, you can specify it by the

following pool conditions:

Examples

Simple Pool Condition

+ System data

dbname="XNMAIN"

+ Workflow

dbname="xdfdocvector"

and/ or

Composed Pool Condition

+ System data

(dbname="XNMAIN") OR (dbname="XNCLASSES")

+ Records Management

(dbname="xretentionclasses") OR (dbname="xcontenttype")

4.4.2 Plug-In Media

Preferably plug-in media (GenericNAS) should be used. This has the benefit that only required storage

space is used up. However you have to ensure a continuous monitoring of the storage location

consumption.

4.4.3 File System Media

The third option is to use file system media which offers the advantage that required storage occupancy

has been already reserved.


The component SAPERION ECM R/ Link for SAP is the base module for SAPERION ECM Compliance

Suite for SAP. It serves as linking server to the SAP ArchiveLink interface. The module provides all variants

of the standard SAP ArchiveLink documents and data repository-

5.1 Setup of the R/ Link Server

53

This chapter describes the installation of IIS on Windows Server 2008 R2 and subsequent configuration

of SAP R/Link. In addition, you have to install the following components:

+ ISAPI Extensions

+ CGI

+ Management Compatibility (all subcomponents).

5.1 Setup of the R/ Link Server



down menu.


Click [Next].

3. Select the "SAPERION Server" installation mode by clicking the corresponding radio





54




7. Select the feature R/ Link Server which will be installed on the current machine. Click

[Next].


5.2 Installation of IIS

55

9. The system is now ready for installation. Click [Next] in order to start the process.

10. If the installation is complete, click [Finish].

5.2 Installation of IIS

Follow the procedure below to install IIS on Windows Server 2008 R2:

1. Call up the system control via "Start".

2. Start the Server Manager via "Programs > Turn Windows feature on or off".

3. Mark in the navigation tree on the left side the "Roles" entry. On the right side you are

offered an overview of all installed roles on the server. Click "Add Role Services".

4. Activate in the dialog "Add Role Services" the option "Web Server (IIS) Support". All

necessary components of IIS are displayed.


56

5. Click the [Add required role services] button.

6. In the next dialog a short introduction into Webserver (IIS), but also some important hints

are displayed. Select in the navigation tree on the left side the "Role Services" entry.

7. Click node "Application Development" and activate options "CGI", "ISAPI Extensions"

and "ISAPI Filters".

8. Click node "Management Tools" and activate option "IIS 6 Management Compatibility"

and all corresponding subitems. When you are finished, click [Next].

9. Click [Install] to close the summary and install the selected components.

10. After the installation has been completed you are offered an overview of the installation.

Click [Close] to exit the dialog.

5.3 Start of IIS in 32 Bit Mode

1. In the DOS window, change to directory "C:\inetpub\AdminScripts". If Windows is

installed on a drive other than "C:", enter the respective drive letter.

2. In the folder "AdminScripts", enter the following command:

cscript adsutil.vbs set w3svc/AppPools/Enable32bitAppOnWin64 1

5.4 Configuration of IIS for R/ Link

57

+ Value "1" for "Enable32bitAppOnWin64" determines that Windows "w3svc" runs in

32 bit mode.

+ If you enter "0", Windows runs in 64 bit mode.

3. Enter "iisreset".

5.4 Configuration of IIS for R/ Link

5.4.1 Handler Mappings

1. Open the Internet Information Services (IIS) Manager.

2. Double-click on "Handler Mappings" to open the properties window. Customize these

settings on server level.

3. Highlight the entry "ISAPI-dll" and edit permissions via context menu or menu item "Edit

Feature Permissions".

4. Activate options "Read", "Script" and "Execute". Click [OK] to close the dialog.

5. Click [OK] to save your settings. ISAPI.DLL is activated.

5.4.2 ISAPI and CGI Restrictions


2. Double-click "ISAPI and CGI Restrictions" to open the properties window. Customize

these settings on server level.

3. Click on menu item [Add] to create a new entry.


58

4. Enter the path to SARLIIS.DLL or click [...] to search for the file. Enter "SAPERION" as a

description in the bottom field. Activate field "Allow extension path to execute" as well.

5. Click [OK] to close the dialog. In the list of ISAPI and CGI Restrictions a new entry is

displayed.

6. Highlight the created entry. Edit the permissions via context menu or menu item [Edit

Feature Settings].

7. Activate the both options "Allow unspecified CGI modules" and "Allow unspecified ISAPI

modules." Then close the dialog by clicking [OK].

5.4.3 Create Virtual Directory


2. Select in the navigation tree on the left side the "Default Web Site" entry which is under

the "Sites" entry.

3. Click "View Virtual Directories" from the actions menu. You are offered the list of already

existing virtual directories.

4. Click the entry "Add Virtual Directory" from the context menu resp. from the actions menu.

5. Enter the directory name in field "Alias". Default name is "Archive". Click [...] to select the

physical path to the directory.

6. Click [OK] to save your settings.

5.4.4 Properties of Virtual Directory

After the creation of a virtual directory (see above), you can adapt the feature "Default Document".

5.5 Configuration of R/ Link Servers

59

1. Select in the navigation tree on the left side the "Archive" entry which is under the "Default

Web Site" entry.

2. Double-click "Default Document" to open the respective properties window.

3. Create via "Add..." from the context menu resp. from the actions menu an new item. The

"Add Default Document" dialog opens.

4. Enter SARLIIS.DLL as default document in this dialog and click [OK] to close it. This entry

is displayed on top of the list automatically with entry type "local".

i Important parameters for saving large files: By default,

"MaxAllowedContentLength" is set to 30 MB. In IIS you can find this

parameter in "RequestFiltering". However, the respective icon is only

displayed if you have installed the IIS administration pack.


Use the Microsoft Management Console (MMC) from the SAPERION system to configure the R/ Link

server.

1. Select in the console root under "R/ Link Server Administration" the "Content servers"

entry.


60

2. In the context menu of the right window area, click "New..." in order to add a new content

repository. The dialog "R/ Link Content Repository" opens.

3. Make your settings in the following tabs which are described in detail in the respective

chapters:

+ General

+ HTTP (The "HTTP" tab is only activated if you have activated HTTP protocol on tab

"General".)

+ Host

+ Logical systems

+ Field mapping

4. Click [OK] to save your settings.

5.5.1 "General" Tab

Fig. 5–1: "General" tab

Settings "General"

Field Content

Name Name of SAP content repositories


61

Field Content

Description Random but clear description

HTTP protocol Select HTTP communication (is activated by default)

Barcode BAPI 4.6 Use of a BAPI BAPI_BARCODE_SENDLIST to send barcodes to SAP instead of individual

transfers

5.5.2 "HTTP" Tab

Fig. 5–2: "HTTP" tab

Settings "HTTP"

Field Content

Table Name of DDC

Security Access mode for filed documents; is only activated if you use a certificate (see description

of ArchiveLink interface with SAP)

Ignore delete By activating the "Ignore delete" checkbox you can prevent the deletion in a SAPERION re-

pository when the user is deleting a document in SAP.

NOTE: This parameter will be set respectively in the ARCHIEF.INI as Ignore.Delete=TRUE.

Please note that there is no global effect so that you have set this parameter for each repo-

sitory if required.

Script If you use a client version you can specify individual virtual directories and scripts per client

(in SAPERION).

5.5.3 "Host" Tab

Fig. 5–3: "Host" tab

Settings "Host"

Field Content

Host IP-address of the SAP system

Service Gateway service of the SAP system


62

Field Content

System No. System number of the SAP system

SID ID of the SAP system

5.5.4 "Logical Systems" Tab

Fig. 5–4: "Logical systems" tab

Entries on this tab are required for the FastLink connection/ barcode transfer. Click [New] to create a

new entry. The "Edit Logical System" dialog opens.

Fig. 5–5: "Edit Logical System" dialog

Settings "Logical System"

Field Content

Name Name of SAP system (logical system name)

User cpic user in SAP

Client SAP client

Password Password of cpic user

Re-enter Re-enter password

Archive Content repository in SAP

Protocol Corresponding to SAP system

Directory Exchange directory: Only for RFC communication

Mask Index mask of used DDC, important for barcode transfer

5.6 Configure Content Repository in SAP

63

Field Content

Table Name of index table in SAPERION

5.5.5 "Field mapping" Tab

Fig. 5–6: "Field mapping" tab

Via the column "Field" index and system fields can be selected. Via the column "Value" values can

be directly entered or assigned by means of variables. Possible variables are for example, "RL_SID" or

"RL_CR".

5.6 Configure Content Repository in SAP

Enter transaction OAC0 to create a content repository in SAP. Change to full administration and create

a new content repository.

Fig. 5–7: Content Repository in SAP

i You can find further information to customize the ArchiveLink interface in SAP in the respective

documentation of the SAP system.

Content Repository in SAP

Field Content

Content Rep. Name of content repositories

6 Installation OCR/ Barcode

64

Field Content

Description Meaningful description

Document Area Select document area e.g. ArchiveLink, data archiving/DMS

Storage type RFC/HTTP

Protocol Name of communication protocol

Version no. Version of protocol

HTTP server Name of webserver (for SAPERION)

Port Number /SSL Port Number Communication port

HTTP Script Name of virtual directory and SAPERION script

Basic Path Spool path for data from SAP

Phy. bas.Path Spool path for data from SAP

Archive Path Spool path for data from SAP

Phys. arch.path Spool path for data from SAP

OutputDevice Spool path for data from SAP

No signature Activate if you work without a certificate

5.7 Certificates

When you have finished setting up a Content Repository in SAP and in R/Link, you can run a connection

test from the SAP system.

1. Enter transaction OAC0 or OACT to activate the test. Afterwards, click

2. If the connection test was successful, click the following icon to transfer the SAP system

certificate to SAPERION:

This certificate is then displayed in the list of certificates of the R/Link server management

console.

3. Double-click on the certificate to activate it. It is saved in file "rlink.pab".

Location depending on system account used for R/Link service:

+ Windows 2008 (32-Bit):

c:\windows\system32\config\systemprofile\...\SAP-HTTP\rlink.pab

+ Windows 2008 R2:

c:\windows\syswow64\.....


For OCR/ barcode recognition in SAPERION the OCR software "ABBYY FineReader" is used. The

FineReader creates electronic files out of scanned documents which can then be edited and archived.

Please refer to the website of the manufacturer for further information about the product "ABBYY

FineReader": http://www.ABBYY.de/.

6.1 SAPERION Licenses

65

The currently supported FineReader version is listed in the SAPERION compability list.

i From SAPERION Version 6 on the FineReader 9 will be installed by default.

This section contains the description of necessary installation steps for ABBYY FineReader. Depending

on the FineReader version different setup and basic configuration have to be carried out. Please refer to

the appropriate chapter for information about your version.

i The sections "SAPERION Licenses" and "Languages" apply to all versions.

6.1 SAPERION Licenses

Please keep the following requirements in mind:

+ To use OCR and/or Barcode, the "OCR & Barcode" server option must be licensed for each Core

Server.

+ To use OCR, the "FineReader Runtime (OCR & Barcode)" client option must also be licensed. This

is a volume license; the scope of the volume cannot be shared across multiple clients; a separate

license is required for each client.

+ If only barcode is to be used, the "FineReader Runtime (Barcode)" client license is sufficient. The

license is bound to the workstation.

6.2 Languages

FineReader is provided by default in the following languages:

+ English

+ German

+ French

+ Russian

+ Italian

+ Spanish

i OCR supports languages for which a corresponding language file (file extension "AMD" and

"AMM") is available in the FineReader folder. For additional languages the necessary files must

be copied to the FineReader directory.

6.3 Setup ABBYY FineReader 7

For FineReader version 7 proceed as follows:


66

1. After the installation of the "OCR" option, copy the license file into the SAPERION

program directory.

2. Enter in the ARCHIEF.INI in the section [FineReader] the name of the license file.

Example

[FineReader]

LicFile=<name license file>

In cases the license file is located in a different directory, the complete path to the license

file must be entered.

i For version 7 an activation of licenses is not necessary.

6.3.1 Hints concerning a CLIENT.INI-Installation

When carrying out a CLIENT.INI installation, ensure that the following entry is present in ARCHIEF.INI:

[Modules32]

OCR=SAFIN732.DLL

Furthermore following files must be copied into the SAPERION download directory:

+ "\finerdr7" subdirectory

+ "safin732.dll" file


Within an already installed SAPERION system FineReader can be setup at any time by means of the

"setup32.exe". Please follow these steps for this purpose:

1. Double-click the "setup32.exe" file.


down menu.


Click [Next].


67

3. Select in the next step via radio button the "Modify" option of the Application

Maintenance. Click [Next].

4. Wählen Sie die Funktion "OCR" aus. Klicken Sie auf [Weiter].

5. Select the OCR component "FineReader" in the dropdown box. Click [Next].

6. The system is now ready for installation. Click [next] to start the installation.


68

7. When the installation has been completed click [Finish].

In the SAPERION installation directory the subfolder "finereader9" has been created.

6.4.1 Activating License File

After the installation or the update via the SAPERION installation program the licenses need to be

activated when using the ABBYY FineReader version 9.

6.4.1.1 Using Local Licenses

Local licenses are managed on the client on which they were activated. They can be activated on the

client, as well as released again.

After the SAPERION installation or update, the "FREngineLM.exe" file can be found in the "\finerdr9"

subdirectory. Proceed as follows to license FineReader:

1. Open the "FREngineLM.exe" file. The FineReader License Manager, which is used to

manage FineReader licenses, will appear.

2. Click [Add new]; the "Enter Serial Numbers" dialog will appear.

3. Enter the license number in the "Add a new serial number" field. Click [Add]. The entered

number is now listed in the list "Added serial numbers" below.

4. Click [OK]. The Activation Wizard opens.


69

5. Select the activation method by clicking the corresponding radio button. Click [Next]

to start the activation procedure. The SAPERION OCR function can be used once the

procedure has completed successfully.

The "\finerdr9" directory now contains a "*.frelf" file, which may not be changed or deleted.

i The activated license key can be used only once by one computer. The license key remains locked

for others until it is released by the local license manager.

6.4.1.2 Configuration File FRENGINE.INI

The Configuration file FRENGINE.INI is located in the sub-directory "...\finerdr9" of the SAPERION

installation directory. This file has to be adapted as follows:

Example

[Protection]

ServerName=<MyServer>

ProtectionType=Server

TCPIPPort=3825

RPCSecurityLevel=None

[Protection] section


ServerName Name of the license server

ProtectionType

TCPIPPort By default ABBYY works with port 3826.

NOTE: If the ProtectionType=Server is set, we recommend using port 3825. To activate the

client license, port 3825 must be available on both the server and the client

RPCSecurityLevel NONE: If the server running the license server is not in the same domain as the workstati-

on, you must assign the value NONE to the RPCSecurityLevel key, on both the server and

the workstation, to enable the license activation.

The ABBYY services must be restarted after modifying the FRENGINE.INI file.


70

! If you plan an update please keep in mind to rename the FRENGINE.INI file, because settings

are overwritten when updating.

6.4.1.3 Netzwerklizenz verwenden

Network licenses are managed centrally from a server. For more information on the license server, please

see the supplied documentation, which may be found as a PDF in the program directory of the license

server.

1. Install the license server. The installation program "Setup.exe" can be found in the

"\components\finerdr9\LicenseServer" directory on the SAPERION DVD.

2. After successful installation the "FREngineNLM.exe" file can be found in the following

directory: "...\Program Files (x86)\ABBYY FineReader Engine 9.0 License Server". Double-

click this file to open the Network License Manager for the administration of network

licenses

3. Click the [Add new license...] button to open the "Add Licenses" dialog.

4. Enter the serial number and then click [Add]. The number is now listed in the "Added serial

numbers" field. Click [OK] to confirm.

All managed licenses appear in the main view of the license manager. Click [License

properties] to display the properties of a license.

! If "unlimited" appears as the license type, it is only truly unlimited if

the valid license duration is also "unlimited." If this is not the case,

the number of pages appearing under "Page limitation" is valid.

5. In order to be able to use one of the licenses from a workstation, copy the FRENGINE.INI

and the ".frelf" files to the "\finerdr9" directory of the SAPERION client.

One of the free licenses on the license server will be booked after starting the SAPERION client and

selecting "Options: OCR".


71

If there are problems with the network license management, the connection between the license server

and the SAPERION client carrying out the OCR can be tested as follows:

1. Copy all files except "EngineDongleManager.exe" and the license file from the license

server directory to a separate directory in the client.

2. Restart the "FREngineNLM.exe" from this directory.

3. Once the connection to the server has been made, you should see all instances of the

license.

6.4.2 Hints concerning a CLIENT.INI-Installation

When carrying out a CLIENT.INI installation, ensure that the following entry is present in ARCHIEF.INI:

[Modules32]

OCR=SAFIN932.DLL

Furthermore following files must be copied into the SAPERION download directory:

+ "\finerdr9" subdirectory

+ "safin932.dll" file


i The ABBYY FineReader 10 is only supported from SAPERION version 7.1 SP3 on.

Contrary to FineReader 9, we provide for the FineReader Engine version 10 an own MSI for the

installation.

Follow the here described instructions in order to process the setup:

! Administrator access rights are necessary for the installtion.

1. Go to the following directory of the SAPERION installations DVD:

"...\x86\components\finerd10".

Here, you will find these two files:

+ FRengine10.msi

+ License Server.zip

2. Double-click the MSI-file to open the installation wizard. Then click [Next].


72

3. Because the FineReader engine must be located in the folder "finerd10" under the

SAPERION client directory, the installer is looking for the recently used SAPERION client

installation and proposes this installation path.

Via the [Browse] button you can modify the installation directory. Click [Next].

4. Click [Next] to start the installation.

5. During installation the mandatory folder "finerd10" is created automatically where all

necessary files are copied into.

6. After the installation has been processed successfully you will receive a confirmation. Click

[Finish] to complete the setup.

In the ARCHIEF.INI of the client the following entry is set automatically after the installation of

FineReader 10:

[Modules32]

OCR=safi1032.dll


73

6.5.1 Silent Installation of FineReader 10

A silent installation of FineReader 10 is possible as follows:

msiexec.exe /i FRengine10.msi INSTALLDIR=<installation direction> /q /l*v .\FR10install.log

6.5.2 Installing the License Manager

The second step is the installation of the License Manager.

1. Go to the directory: "...\x86\components\finerd10" of the SAPERION installation DVD.

The "License Server.zip"-file has to be unpacked.

2. In the "License Server" folder you will find the "setup.exe" for the installation of the License

Manager. Double-click the file to open the installation wizard.

3. In the field "Install to" the proposed installation path is shown. if you need to modify the

path, click [Browse] to change it as required.

4. Then select in the dropdown menu the network protocol "TCP/IP". Click [Next].

5. In the next dialog an overview of the installation settings is offered. Click [Install] for

initiating the installation.

6. After successful installation you will be confirmed.

In order to be able to work immediately with the License Manager, activate the checkbox

"Launch License Manager now". Click then [Finish] to complete the installation. The

License Manger utility will be opened immediately.


74

6.5.3 Activating Licenses

The License Manager utility allows you to administrate licenses of all types. You may activate,

deactivate or update a license. Furthermore properties of activated licenses are provided here ("Licens

Parameters").

1. If you have activated the checkbox "Launch License Manager" when installing the License

Manager, the application is opened directly.

Otherwise click START > LICENSE MANAGER.

2. Click the [Activate License...] button. The license activation wizard opens.


75

3. Enter your ABBYY FineReader serial number and then click [Next].

4. Select by activating the appropriate radiobutton the required activation method:

+ via the Internet: The activation is carried out automatically. An Internet connection

is required.

+ via E-Mail: The activation wizard is creating automatically an email message which

you have to send without any modifications to the specified address. You will then

receive a reply with detailed instructions for license activation.

+ If you have already a license file, select the option "Load license file". You are then

allowed to load it in the next step by specifying the storage location of the license file.


76

5. You will receive confirmation of the activation of your license. Click [Finish] to complete

the activation process.

In the License Manager dialog the license is now listed and the service "ABBYY SDK 10

License Server - Licensing Service" is automatically started.

Following information about activated licenses are available in the License Manager:


77

License information

Column Description

Serial Number ABBYY FineReader Engine 10 serial number.

NOTE: The colored squares in front of each entry indicates whether the respective license

is in use.

The license is not in use and can be used for processing.

The license is in use but some recognition processes may be run with this license.

The license is in use and no more recognition processes can be run with this license.

Functionality subset License type

Protection type Software (File) - Software Protection Key

Installation type Standalone: The license is used on local computer.

Network: The license is located on a network computer.

Expiration date Date of expiration.

6.5.3.1 License Types

For FineReader10 there are two different license types available:

+ Runtime license

Using the runtime license you need to install the License Server on each working station where

FineReader should be available for the purpose of activating licenses.

+ Network license

If you are using a network license the license server needs only be installed centrally once. In this

case the "LicenseSettings.xml" file has to be distributed on all working stations and copied into the

main directory of FineReader 10 respectively (see also section "LicenseSettings.xml").

6.5.3.2 LicenseSettings.xml

The "LicenseSettings.xml" file is used for the supply of required license information at the work stations.

A sample file can be found in this directory: "...\x86\components\finerd10\License Server.zip\License

Server".

Basically, the IP-address of the License server has to be specified here.

Example

<?xml version="1.0" encoding="UTF-16"?>

-<LicensingSettings xmlns="http://www.abbyy.com/Protection/LicensingSettings">

- <LicensingServers>

<MainNetworkLicenseServer ProtocolType="TCP/IP" ServerAddress="myserver"/>

</LicensingServers>

</LicensingSettings>


78

LicenseSettings.xml


MainNetworkLicenseServer ProtocolType Network protocol

Default setting: TCP/ IP

ServerAddress Specify the IP-address of the License Server according to your settings.

6.5.4 Barcode Types

The FineReader version 10 supports the below listed barcode types. In contrast to previous versions it

is possible to specify barcode types to be recognized.

i If no barcode type is specified the automatic barcode recognition is automatically used.

Barcode types

0 BT_Autodetect

3 BT_Interleaved25

4 BT_Code39

6 BT_Code93

7 BT_Code128

8 BT_Codabar

9 BT_UPCA

10 BT_PDF417

11 BT_PostNet

12 BT_DataMatrix

13 BT_QRCode

14 BT_Industrial25

15 BT_IATA25

16 BT_Matrix25

17 BT_UCC128

18 BT_Patch

19 BT_Aztec

20 BT_EAN8

21 BT_EAN13

22 BT_UPCE

6.5.4.1 Barcode Recognition via COM

In the following example the barcode type "QRCode" is recognized.

Sample

6.6 Update of FineReader 9 to FineReader 10

79

Sub OCR2D_my()

Dim oDoc As Object

Dim oSubDoc As Object

Dim oBitmap As Object

Dim sOCR As String

Dim i As Integer

'msgbox application.RemainingOcrUnits

Set oDoc = Application.CreateDoc()

oDoc.InsertImage "D:\test\bc\Barcodes\QRCode\qr90.tif"

Set oSubDoc = oDoc.subdocument(1)

Set oBitmap = oDoc.subdocument(1).Bitmap()

sOCR = oSubDoc.OCR(1, 1, oBitmap.Width, oBitmap.Height, 11, "", "", "", "", "", "13")

MsgBox sOCR

End Sub

6.6 Update of FineReader 9 to FineReader 10

In order to execute an update of FineReader 9 to version 10 you have first to deinstall the previous

version. Please follow the described steps and hints:

1. Call up via a doubleclick the SAPERION " setup.msi".

2. Select the mode "Modify" by activating the appropriate radiobutton. Then click [Next].

3. Deactivate the option "OCR" by clicking the "Entire feature will be unavailable" entry. Click

[Next].

7 The SAPERION Business Rules Server

80

4. After FineReader 9 has been deinstalled successfully, execute the setup of version 10 as

described above.

5. Execute the deinstallation of the License Server 9 via CONTROL PANEL > PROGRAMS >

PROGRAMS AND FEATURES.

6. For FineReader10 Engine the appropriate license server must be available. Follow the

instruction described in chapter "Installing the License Manager" for this purpose.

7 The SAPERION Business Rules Server

7.1 Introduction

The Business Rules Server (BRS) is a Java-based application which serves to process regularly automated

tasks. Like Core Server tasks that are based on EventScripts, the BRS can run scheduled automated tasks,

for example as part of a workflow process. The BRS provides a framework with which you can integrate

business logic in the form of Java classes.

Start the Business Rules Server as a service as well, in order to utilize respective business logic for

automation processes.

i Please note that the Business Rules Server can also be used in a multi-client system. For this

purpose you need to setup a performer for each client.

7.1.1 Business Logic

The business logic is a set of rules or the compendium of all business rules within a company.

These rules describe procedures, conditions, limits and relationships within business processes. They

could be generally valid (e.g. principles), sector-specific (e.g. limit values) or company-specific (e.g. best

practices). Furthermore rules can be recorded and implemented in a variety of ways (e.g. by means of

special software).

Application options within SAPERION are, for example, web service calls for credit rating agency queries,

accessibility of a Business Rule Engine or the verification of index fields.

The SAPERION Fileplan Cloner is an application sample which is provided with the SAPERION

installation. The archive file "folderperfomer.jar" contains all the business logic which is necessary for

automatically generating a new efile with all substructures and documents. These substructures and

documents must be previously defined in a template (see Administrator's Manual chapter "Business

Rules Server").

7.1.2 Java Framework

The general Java framework of the Business Rules Server allows you to convey tasks in various formats

to the SAPERION system:

7.2 Installation

81

+ tasks that are programmed directly in Java

+ tasks that are created, administrated and processed within a Business Rules Engine

+ tasks that are extracted from other digital formats (XML, tables, text, properties etc.)

All these formats are supported by the Business Rules Server when the respective interfaces are available

or appropriately programmed in Java.

Programmers can create their own business logic structures as Java classes for automation of tasks

within the framework (additional information is available in the programmer's guide).

7.2 Installation

The SAPERION installation provides the Business Rules Server. You will find the configuration file

"runner.properties" and the installation script in the "scr-businessruleserver" directory.

1. In your SAPERION installation, open the directory: "...SAPERION\scr\scr-

businessruleserver\Service\".

2. Start the batch file "InstallBRS-NT.bat" to begin installation of the Business Rules Server.

This installs the service "SAPERION BusinessRulesServer".

i Before starting the Business Rules Server you must first start the Java Core Server. When the Java

Core Server stops, this stops the Business Rules Server as well.

7.3 Starting the Business Rules Server

Before the Business Rules Server can be started you have to make some configuration which is described

in detail in the SAPERION Administrator's Manual, chapter "Business Rules Server".

The following two facilities are provided for starting the BRS:

+ via batch script: In the folder "...SAPERION\scr\scr-businessruleserver/service" the start script

"BRS.bat" can be found. Execute the start by double-clicking on the file.

8 SAPERION Web Services

82

+ you can alternatively start the service "SAPERION BusinessRuleServer".

7.4 Update Hint

Please keep in mind that the backup of configuration files is mandatory before processing a SAPERION

update. The saved files can then be used after your system has been updated.

8 SAPERION Web Services

The SAPERION web services provide SOAP and REST based interfaces for third party applications to

communicate with the SAPERION back end.

The SAPERION web services are shipped along with the SAPERION distribution. They can be found in

the folder "scr-webservices". This folder contains the web services "javadoc" documentation, the license

information and the web services itself.

To deploy the web services on a Apache Tomcat servlet container use Tomcat’s ‚Tomcat Manager‘ web

application or copy the "scr-webservices.war"-file to Tomcat’s 'webapps' directory. (For more information

on how to deploy a web application please refer to the Apache Tomcat documentation.)

The web services are shipped with some configuration files. Before the services can be used, these

files need to be adjusted. The configuration files are found in the directory "<tomcat installation

folder>/webapps/scr-webservices/WEB-INF/classes/config".

i A detailed description of how to configure the web services can be found in SAPERION

Administration Manual, chapter "SAPERION Web Services".

9 SAPERION App Services

The SAPERION App Services are SOAP web services that enable the interoperability of mobile devices

and SAPERION.

If you want to use the app iSAPERION the App Services are mandatory.

In this chapter you will learn about the installation of App Services.

i A detailed description of how to configure App Services can be found in SAPERION Administration

Manual, chapter "SAPERION App Services".

9.1 Requirements

The following requirements must be met:

9.2 Installation

83

+ App Services are supported from SAPERION 7.1 SP1 on

+ The database definition "uploadarchive.DDC" must be deployed to SAPERION.

The DDC is delivered along with the SAPERION distribution and can be found under "web-inf/

classes" directory. If you want to create this DDC by yourself, please be aware that the system fields

SYSINDEXCONTENT and SYSDOCUMENTDESCRIPTION are mandatory.

+ To deploy the App Services as a web application an application server is needed. The App Services

are currently tested for the Apache Tomcat 6.0.20. The used application server must use Java JDK

1.6 or higher.

+ In the SAPERION system there must be an application that matches the "applicationname.filter"

and that uses a DDC by the name of "uploadarchive.name" (see configuration section). Otherwise

uploaded documents would not be retrievable by the App Services.

9.2 Installation

To deploy the SAPERION App Services on a Apache Tomcat servlet container use the Tomcat Manager

web application or copy the "appservices.war" file to Tomcat's "webapps" directory.

For more information on how to deploy a web application please refer to the Apache Tomcat

documentation (http://tomcat.apache.org/tomcat-6.0-doc/index.html).

After the App Services have been deployed on the Tomcat you need to configure them according to your

requirements.

10 SAPERION Data Archiving for SAP ILM 1.0

The SAPERION SAP ILM service provides a WebDAV-based interface for the SAP NetWeaver Information

Lifecycle Management (ILM). The SAPERION SAP ILM service fulfills the SAP ILM interface specification.

With this service SAPERION can be used as an external storage system connected via the WebDAV

protocol to the SAP NetWeaver ILM for the final storage of archived data.

In this chapter you will find the description of the installation of SAPERION SAP ILM.

i A detailed description of how to configure SAP ILM Services can be found in SAPERION

Administration Manual , chapter "SAPERION SAP ILM Services".

10.1 Requirements

The following requirements must be met:

+ SAPERION 7.1 with patch level 50996 or higher

+ Java Core Server Application Server: Apache Tomcat 6.0.20

10 SAPERION Data Archiving for SAP ILM 1.0

84

+ Java: JDK 1.6 or higher

10.2 Installation

To deploy the SAPERION SAP ILM service on an Apache Tomcat servlet container use the Tomcat

Manager web application or copy the "sap_ilm_service.war" file to Tomcat's "webapps" directory. For

more information on how to deploy a web application please refer to the Apache Tomcat documentation.

installation guide saperion version 7 - kofax · pdf file5 installation r/link for sap ... 10...

Documents