0% found this document useful (0 votes)
804 views52 pages

OpenText Information Extraction Service For SAP Solutions 16.5 - Administration Guide English (CPIE160500-AGD-En-09)

Uploaded by

Ignacio Francia
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
804 views52 pages

OpenText Information Extraction Service For SAP Solutions 16.5 - Administration Guide English (CPIE160500-AGD-En-09)

Uploaded by

Ignacio Francia
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 52

OpenText™ Information Extraction

Service for SAP® Solutions

Administration Guide

This guide describes installation and administration of


OpenText Information Extraction Service for SAP® Solutions.

CPIE160500-AGD-EN-09
OpenText™ Information Extraction Service for SAP® Solutions
Administration Guide
CPIE160500-AGD-EN-09
Rev.: 2019-Sept-20
This documentation has been created for software version 16.5.
It is also valid for subsequent software versions as long as no new document version is shipped with the product or is
published at https://knowledge.opentext.com.

Open Text Corporation

275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1

Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: https://support.opentext.com
For more information, visit https://www.opentext.com

Copyright © 2019 Open Text. All Rights Reserved.


Trademarks owned by Open Text.

One or more patents may cover this product. For more information, please visit https://www.opentext.com/patents.

Disclaimer

No Warranties and Limitation of Liability

Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
Table of Contents
1 About Information Extraction Service ..................................... 5
1.1 How does it work? ............................................................................. 5
1.2 Technology ....................................................................................... 6
1.3 Machine learning ............................................................................... 7
1.4 IES architecture and SAP integration .................................................. 9
1.5 Solutions and profile configuration .................................................... 10
1.6 Supported languages ...................................................................... 12
1.7 Supported image formats ................................................................. 13

2 Installing IES ............................................................................ 15


2.1 Installation procedure overview ........................................................ 15
2.2 Prerequisites for the installation ....................................................... 16
2.3 Installing IES .................................................................................. 16
2.4 Installing patches and service packs ................................................. 17

3 Configuring IES ....................................................................... 19


3.1 Configuring authorizations for validation user .................................... 19
3.2 Adding a certificate for client/server authentication for secure
communication using HTTPS (optional) ............................................ 20
3.3 Configuring the web service ............................................................. 20
3.3.1 Specifying the application pool ......................................................... 21
3.3.2 Configuring SSL settings for secure communication using HTTPS
(optional) ........................................................................................ 21
3.3.3 Increasing the upload size (IIS 7.0 and later versions) ....................... 22
3.3.4 Configuring internal application settings ............................................ 23
3.4 Configuring tracing .......................................................................... 24
3.4.1 Tracers ........................................................................................... 25
3.4.2 Trace listeners ................................................................................ 25
3.4.3 Trace root path ............................................................................... 25
3.4.4 Trace levels .................................................................................... 26
3.4.5 Trace configuration ......................................................................... 27
3.4.6 Location of trace files and trace configuration files ............................. 30
3.4.7 Format of traces .............................................................................. 30
3.4.8 Analyzing trace files using Trace Viewer ........................................... 31
3.4.8.1 Selecting a trace configuration ......................................................... 33
3.4.8.2 Filtering messages .......................................................................... 34
3.4.8.3 Searching trace messages .............................................................. 35
3.5 Controlling cache behavior .............................................................. 36
3.6 Working with configuration data (production system) ......................... 37
3.6.1 Technical configuration data ............................................................ 37
3.6.1.1 Load Manager files .......................................................................... 37

OpenText Information Extraction Service for SAP Solutions – Administration Guide iii
CPIE160500-AGD-EN-09
Table of Contents

3.6.1.2 Trace configuration files ................................................................... 37


3.6.2 Runtime files ................................................................................... 37
3.6.2.1 Temporary files of Document Reader and Document Extraction ......... 37
3.6.2.2 Trace folder .................................................................................... 38
3.6.3 Registry entries ............................................................................... 38
3.6.4 Microsoft Windows services ............................................................. 38
3.6.5 Moving IES data to a different location .............................................. 38
3.6.5.1 Configuring cache location ............................................................... 38
3.6.5.2 Configuring trace file location ........................................................... 39
3.6.5.3 Configuring program data location of components ............................. 39
3.7 Configuring load balancing .............................................................. 39
3.7.1 Understanding the Load Manager .................................................... 39
3.7.2 Configuring cluster nodes ................................................................ 40
3.7.2.1 Changing cluster node properties ..................................................... 41
3.7.2.2 Changing IES Server Node properties .............................................. 42
3.8 Starting and stopping services on the IES Server .............................. 43
3.9 Setting up the SLD registration on the SAP system ........................... 43

4 Monitoring IES ......................................................................... 45

5 Configuring high availability .................................................. 47

6 Configuring security ............................................................... 49


6.1 User management and authorization concept ................................... 49
6.2 Logging of security-relevant events .................................................. 49
6.3 Encryption of communication channels ............................................. 49
6.4 Secure configuration ....................................................................... 50
6.5 Responsibilities ............................................................................... 50

7 Troubleshooting ...................................................................... 51

iv OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
Chapter 1
About Information Extraction Service

1.1 How does it work?


OpenText Information Extraction Service for SAP® Solutions (IES) is the next
generation data extraction service for business documents processed in SAP context.
It follows a new paradigm with regards to integration, operation, deployment and
usability.

As a single, unified extraction service, the solution supports OpenText™ Vendor


Invoice Management for SAP® Solutions (Vendor Invoice Management (VIM)) and
OpenText™ Business Center for SAP® Solutions (BC) on SAP ERP Central
Component (SAP ECC) and SAP S/4HANA.

IES is easy to:

• Deploy: The configuration is completely done in VIM and BC. No separate


configuration in IES is necessary.
• Operate: IES only needs the connection to the SAP system. No data persists in
IES.
• Use: IES comes with preconfigured best practice solutions for processing
business documents which fit to VIM and BC solutions.

Business IES supports the following business scenarios:


scenarios/
solutions
Vendor Invoice Management
OpenText™ Invoice Capture Center for SAP® Solutions. For more information,
see section 17 “ICC Integration” in OpenText Vendor Invoice Management for SAP
Solutions - Configuration Guide (VIM-CGD).
Business Center

• Solution for Incoming Sales Orders. For more information, see part III
“Solution for Incoming Sales Orders” in OpenText Business Center for SAP
Solutions - Scenario Guide (BOCP-CCS).
• Solution for Incoming Quotations. For more information, see part IV
“Solution for Incoming Quotations” in OpenText Business Center for SAP
Solutions - Scenario Guide (BOCP-CCS).
• Solution for Incoming Delivery Notes. For more information, see part V
“Solution for Incoming Delivery Notes” in OpenText Business Center for SAP
Solutions - Scenario Guide (BOCP-CCS).
• Solution for Incoming Order Confirmations. For more information, see part
VI “Solution for Incoming Order Confirmations” in OpenText Business Center
for SAP Solutions - Scenario Guide (BOCP-CCS).

OpenText Information Extraction Service for SAP Solutions – Administration Guide 5


CPIE160500-AGD-EN-09
Chapter 1 About Information Extraction Service

• Solution for Incoming Remittance Advices. For more information, see part
VII “Solution for Incoming Remittance Advices” in OpenText Business Center
for SAP Solutions - Scenario Guide (BOCP-CCS).
• Solution for Incoming HR Documents. For more information, see part VIII
“Solution for Incoming HR Documents” in OpenText Business Center for SAP
Solutions - Scenario Guide (BOCP-CCS).

1.2 Technology
IES recognition technology is based on adaptive learning algorithms which learn
from user feedback. This provides a fast project setup as no rules or parameters for
data extraction are required, and a fast success rate for excellent recognition results.
IES combines a proven invoice knowledge base with learning algorithms, which
extends the recognition rate within short time of productive use to a new level.

VIM and BC Beyond excellent recognition results, the tight integration of IES with VIM and BC
integration provides an ideal technical footprint, not requiring an external repository, but using
SAP repository, not requiring any data duplication from SAP system but keeping all
data in the SAP system. The connection to SAP is implemented based on REST based
web services supporting HTTP and HTTPS. This architecture is ideal for hosting IES
on cloud platforms as an alternative to the on premises installation.

ICC and BCC Customers using OpenText™ Invoice Capture Center for SAP® Solutions (ICC) or
integration OpenText™ Business Center Capture for SAP® Solutions (BCC) can integrate IES, as
it can run in parallel, also connecting to the BC Inbound framework. You can use
existing Validation Clients for processing IES profiles in parallel to ICC and BCC
applications.

6 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
1.3. Machine learning

1.3 Machine learning


Field types The key advantage of IES is the reduction of implementation and configuration
efforts, combined with fast learning success. That is why IES includes preconfigured
scenarios.

All scenarios are based on intelligent field types for the data transfer to the VIM or
BC solution. These fields include:

• Amount
• Business partner
• Classification
• Date
• Decimal
• List
• Lookup
• String
• Table

Intelligent field types include the knowledge about the data structure, potential local
formats, their meaning in different business contexts, tax compliance and how they
are used in SAP. As an example, a field type specifies date formats, for example
MMDDYYYY, DDMMYYYY, DD.MM.YYYY, DD/MM/YYYY, and date writing styles, for example
month spelled out, without the need of defining it for any solution.

Learning For the invoice solution the invoice knowledge base has been integrated and runs
algorithms combined with the intelligent field types leveraging a learning voting algorithm.
Thus IES starts learning as soon as the first document is processed. The learning is
based on a combination of two different algorithm types and a mixture of both:

• Layout based algorithms, for example business partner determination, and item
table recognition. These work based on the layout and where the data is typically
located on the document.
Layout based algorithms learn very fast, providing automatic recognition result
from the second pass of the same layout. For complex tables more passes may be
necessary.
• Layout independent algorithms, for example data, such as amounts, dates and
document references. These algorithms identify relevant data structures and
keywords and learn to extract this on documents with an entirely different
layout.
Layout independent algorithms take more time to learn data structures, related
keywords and surrounding text. What has been learned by this algorithm type
will also be applied to completely unknown documents containing the same data
structures, keywords and surrounding text. With this technique, the data entry

OpenText Information Extraction Service for SAP Solutions – Administration Guide 7


CPIE160500-AGD-EN-09
Chapter 1 About Information Extraction Service

effort diminishes more and more, and the longer the system is in production it
learns more document layouts.

Learning Before using IES, the user manually entered data from business documents. With
system IES, the user continues to do his daily work, and with this he provides feedback data
to the learning service, which learns to capture the data automatically starting from
the second pass of a document with either the same layout or showing the same data
type, for example date field with the same format and key word.

Learning is permanently active for adapting continuously to the documents


processed in customer environment.

For invoices the user starts from a higher level, because he will get “out of the box”
recognition results from the invoice knowledge base where applicable. They will
only need to enter data for additional fields that are not supported by the invoice
knowledge base, for example a material number, or that could not be extracted by
the invoice knowledge base for some reason, for example complex invoice line
items.

No training phase is required as the system learns unattended in the background.


The business user is the best source of knowledge for the learning process because
they know exactly which is the relevant data to be captured for creating a business
object in SAP.

8 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
1.4. IES architecture and SAP integration

1.4 IES architecture and SAP integration


IES is a Microsoft Windows based data extraction service which is called by SAP via
REST based web services, supporting HTTP and HTTPS.

IES connects to VIM and BC using the ABAP component Inbound Framework (IDF),
where an Information Extraction Service API complements the existing BCC APIs.

IES provides three services which are called from SAP by the IES API:

• Configuration Service: Receives configuration data for recognition profiles


related to business scenarios.
• Extraction Service: Receives requests from IDF for extracting data from an image
file and provides result data.
• Feedback Service: Receives feedback data resulting from user feedback.
Depending on the configuration in the scenario, feedback can be returned after
validation in Validation Client or processing in VIM or BC.
OpenText recommends configuring feedback from the Validation Client in the
current version. The Feedback Service processes the learning data (model data)
and stores it in the SAP database. With this, the learning data is safely stored and
included in the backup process of the SAP repository.

OpenText Information Extraction Service for SAP Solutions – Administration Guide 9


CPIE160500-AGD-EN-09
Chapter 1 About Information Extraction Service

1.5 Solutions and profile configuration


IES supports all VIM and BC solutions. For more information, see “Business
scenarios/solutions” on page 5.

The configuration of the solutions is completely done in BC Inbound IMG, that


means there is no configuration needed on the IES Server. For more information, see
the OpenText Business Center for SAP Solutions - Configuration Guide (BOCP-CGD).
Here you can find information about the IDF configuration, business solutions, the
application profile configuration, and a description of the complete document
processing data flow beginning with inbound scanning or e-mail, and ending with
starting the VIM or BC workflow.

Profile configu- For every IES scenario, at least one profile must be configured. The number of
ration profiles per scenario or overall number of profiles is not limited.

A profile defines the set of fields that are required for extraction based on the fields
of the standard scenario. The profile also defines the behavior and sequence of the
fields in the Validation Client, which can be set as required, read-only or hidden.
The profile creation depends on the specific business requirement, such as different
company codes or countries.

The default fields can be extended by adding following custom fields: Date,
Decimal, String. The custom fields will also be shown in the Validation Client.

10 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
1.5. Solutions and profile configuration

Learning data The learning data will be stored in the repository of the SAP system. In the current
configuration version IES connects to one SAP system only. That means only one feedback link can
be configured.

Validation The Validation Client is the user interface for comfortable data completion and
Client configu- manual data entry. All user actions contribute to the continuous learning process.
ration
The client itself can be used on an unlimited number of workstations without
charge.

The Validation Client has no connection to the IES Server, it connects only to the
SAP system using an RFC call and polls for assignments. If a document is assigned
to the validation step, the Validation Client loads the profile settings, notably the list
and sequence of fields, as well as the invoice image, including the full text
recognition details but without any connection to the archive system.

You can configure the Validation Client in BC Inbound IMG. The configuration
defines if validation is used or not, which are the criteria for documents used for
validation, and which validation agents are assigned to the different profiles.

The profile configuration defines how data fields are shown in the Validation Client.

Data capturing The Validation Client provides comfort functions for fast and secure data capture:

• With Single Click Entry (SCE), the user can pick the data directly from the image
into the data fields and does not need to type the data. This avoids errors due to
typos.
• With Table Auto Completion (TAC), the user only needs to pick the data of the
first item line with Single Click Entry (SCE), Table Auto Completion (TAC)
automatically captures the data of all line items.

The image view highlights all data that has been recognized automatically and the
user can see at first glance if data is missing, for example line items.

OpenText Information Extraction Service for SAP Solutions – Administration Guide 11


CPIE160500-AGD-EN-09
Chapter 1 About Information Extraction Service

1.6 Supported languages


IES can extract information contained on documents from foreign countries
including:

• Character sets supported by the text recognition engine which supports most of
the languages worldwide with high precision.
• Data interpretation for different cultures and languages. Cultures refers to the
typical writing styles for data in a country. In Germany, for example, the date
format is typically 10.12.2018 and spelled out in words as 10. Dezember 2018.
In the United States it is 12/10/2018 and December 10, 2018. For the latter, the
language must also be understood for the correct interpretation of the month,
and the context may be required to determine whether the data is European or
the U.S. for the correct interpretation of the numeric date. In some countries, very
specific date formats need to be considered, such as the Emperor date in Japan.
Also, amounts are culture specific with regards to the use of decimal separators
and the number of decimals used. The same also applies to quantities.
• For some documents, such as invoices, country specific reference fields, local
taxes and tax compliance requirements, such as mandatory tax invoice, need to
be considered.

For more information of supported languages and character sets, see the Release
Notes of VIM and BC.

IES supports multi-country profiles. Countries can be combined in one profile


depending on the criteria of the business scenario, such as:

• Country groups related to company codes in SAP.


• Country groups with the same tax system, for example VAT and GST.

12 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
1.7. Supported image formats

• Country groups using the same data fields. A profile also defines data fields for
the screen in the Validation Client for data completion.

In Inbound IMG, the preferred culture for data interpretation can be configured. For
example, by selecting the UK as the first sequence, the date and amount fields are
interpreted with first priority for the UK format, but the formats of other cultures are
still recognized if no UK date or amount exist on the document.

1.7 Supported image formats


IES processes:

• All document formats used for invoices, such as DIN A4, Legal, Letter, and
smaller formats, in portrait and landscape orientation with a minimum font size
of 1.5 mm high and 0.5 mm wide.
• JPEG for color and gray images with a maximum image resolution of 400 dpi.
• PDF
• TIFF 6.0 binary images in the compression modes:

– Uncompressed
– Fax Group 3
– Fax Group 4
– Packbits
– LZW

OpenText Information Extraction Service for SAP Solutions – Administration Guide 13


CPIE160500-AGD-EN-09
Chapter 2
Installing IES

2.1 Installation procedure overview


Notes

• For more information on supported platforms, hardware and software


requirements, as well as product dependencies and restrictions, see the
Release Notes. You can find the latest version of the Release Notes in My
Support (https://knowledge.opentext.com/knowledge/llisapi.dll/Open/
15448194).
• The software is available on My Support as product ISO image. For more
information, see https://knowledge.opentext.com/knowledge/llisapi.dll/
Open/75964622. You may burn the ISO image on a DVD as the installation
medium. This documentation refers to the term <installation medium> as the
container for the ISO image. Alternatively, you can also mount the ISO
image. However, this is not explained by this documentation.
• Check My Support (https://knowledge.opentext.com/) for service packs or
patches that may have been posted after the initial release of IES.
Check also the patches for the Capture Imaging Plug-In component (https://
knowledge.opentext.com/knowledge/llisapi.dll/Open/61183571) if a newer
version is available.
• The descriptions in this guide are based on the assumption that BC and VIM
are already installed and configured.
• IES can be installed and run together with BCC on the same system if both
products have the same version. As a prerequisite, install first BCC. When
running the IES setup it will be installed as add-on into the same directory as
BCC. Note that the available system resources will be shared between both
products which you should consider when planning the system sizing.
• The Validation Client cannot be installed and run on the same system as IES.
You can download the Validation Client from My Support. For more
information, see section 2.3.3 “Installing the Validation Client” in OpenText
Business Center Capture for SAP Solutions - Administration Guide (CPBC-AGD).
• Sign in as user with local administration rights.

Install and configure IES in the following sequence:

1. Install IES.
2. Configure BC respectively VIM. For more information, see section 4.5.2
“Customizing Information Extraction Service” in OpenText Business Center for
SAP Solutions - Configuration Guide (BOCP-CGD).

OpenText Information Extraction Service for SAP Solutions – Administration Guide 15


CPIE160500-AGD-EN-09
Chapter 2 Installing IES

2.2 Prerequisites for the installation


Before you install IES, install Microsoft Internet Information Services (IIS).

To install and configure IIS:

1. Start the Server Manager.

2. On the Dashboard, click Add roles and features.

3. Proceed to the Server Roles page.

4. Select Web Server (IIS).

5. Open this node and its subnode Application Development, and then select
ASP.NET 4.5 and later versions.

6. Click Next and then click Install.

2.3 Installing IES


To install IES:

1. In the root folder of the installation media, start setup.exe, or run


<drive>:\Information Extraction Service 16.5.msi.
By default, the files are installed into the folder %ProgramFiles(x86)%\Open
Text\Information Extraction Service 16.5.

2. In the Welcome dialog box, click Next.

3. In the End-User License Agreement dialog box, accept the license agreement,
and then click Next.

4. In the Destination Folder dialog box, check the path to the installation folder,
and then click Next.
If you want to install IES at a different location, click Change, and then choose
the desired path in the appearing folder dialog box.

5. Click Install.

6. Click Finish.

16 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
2.4. Installing patches and service packs

2.4 Installing patches and service packs


Check My Support (https://knowledge.opentext.com/) for service packs or patches
that may have been posted after the initial release of IES.

Service packs are cumulative, that is a service pack contains all changes contained in
previous service packs of the respective IES version. Therefore, it is sufficient to
install only the latest service pack after installing IES. For the same reason, the
Release Notes of a service pack list the changes of all previous service packs.

However, you can install a service pack on IES with any previous service pack.

Patches are related to a service pack, that is you can only install a patch on an IES
system where the corresponding service pack has been installed. Patches are
cumulative, that is a patch contains all changes contained in previous patches for the
same service pack.

To install a service pack or a patch:

1. In the Server group of the General tab, click Cluster, and wait until all cluster
nodes have finished processing, that is, until all are in state Ready.

2. In the Internet Information Services (IIS) Manager, stop the


InformationExtractionService web service.
3. Install the service pack or patch.

4. In the Internet Information Services (IIS) Manager, start the


InformationExtractionService web service.

OpenText Information Extraction Service for SAP Solutions – Administration Guide 17


CPIE160500-AGD-EN-09
Chapter 3
Configuring IES

3.1 Configuring authorizations for validation user


As soon as the validation user has started the Validation Client, the user has to log in
to SAP ERP or SAP S/4HANA using a prepared SAP user. This user needs the
following authorizations:

• S_RFC:ACTVT=16,RFC_TYPE=FUGR,RFC_NAME=RFC1
• S_RFC:ACTVT=16,RFC_TYPE=FUGR,RFC_NAME=RFC_METADATA
• S_RFC:ACTVT=16,RFC_TYPE=FUGR,RFC_NAME=SDIFRUNTIME
• S_RFC:ACTVT=16,RFC_TYPE=FUGR,RFC_NAME=SYSU
• S_RFC:ACTVT=16,RFC_TYPE=FUGR,RFC_NAME=SYST
• S_RFC:ACTVT=16,RFC_TYPE=FUGR,RFC_NAME=SRFC
• S_RZL_ADM:ACTVT=03
• S_RFC:ACTVT=16,RFC_TYPE=FUGR,RFC_NAME= /OTX/PF11_VALIDATION
• For BC Inbound Framework version 16.3.1 and later, full authorization for the
J_6NPF_RFC object is required for all users. For more information, see section 7.4
“Authorization objects” in OpenText Business Center for SAP Solutions -
Configuration Guide (BOCP-CGD).

As of SAP Basis Release 7.10 you can choose a finer granularity for authorizations.
For more information, see SAP Note 460089. You can execute the authorization
check on individual function modules, instead of entire function groups.

You can replace the following authorizations:

• S_RFC:ACTVT=16,RFC_TYPE=FUGR,RFC_NAME=SYST
replace with
S_RFC:ACTVT=16,RFC_TYPE=FUNC,RFC_NAME=RFCPING
• S_RFC:ACTVT=16,RFC_TYPE=FUGR,RFC_NAME=SRFC
replace with
S_RFC:ACTVT=16,RFC_TYPE=FUNC,RFC_NAME=RFC_PING
• S_RFC:ACTVT=16,RFC_TYPE=FUGR,RFC_NAME=RFC1
replace with
S_RFC:ACTVT=16,RFC_TYPE=FUNC,RFC_NAME=RFC_FUNCTION_SEARCH
S_RFC:ACTVT=16,RFC_TYPE=FUNC,RFC_NAME=RFC_GET_FUNCTION_INT
ERFACE
• S_RFC:ACTVT=16,RFC_TYPE=FUGR,RFC_NAME=SDIFRUNTIME
replace with

OpenText Information Extraction Service for SAP Solutions – Administration Guide 19


CPIE160500-AGD-EN-09
Chapter 3 Configuring IES

S_RFC:ACTVT=16,RFC_TYPE=FUNC,RFC_NAME=DDIF_FIELDINFO_GET

You can also replace the other function group authorizations by the function module
authorizations but it is not necessary because nearly each function module within
the groups is used.

3.2 Adding a certificate for client/server


authentication for secure communication using
HTTPS (optional)
To setup secured communication using HTTPS, install a server and client certificate
on the system(s). Thereby, you can use a combined certificate for server and client
authentication. It should be issued to the name of the unique service URL (entry set
to subject attribute CN).

To install and configure the certificate:

1. Create or purchase the certificate. Ensure that you also have the private key.

2. Import the certificate into the Local Computer account. Ensure to select Allow
private key to be exported.

3. Assuming that the Internet Information Services (IIS) website is running under
ApplicationPoolIdentity, do the following:

a. Run certlm.msc.
b. In the console tree, expand Certificates - Local Computer > Personal >
Certificates.
c. In the result pane, right-click the appropriate certificate, and then click All
tasks > Manage Private Keys.
d. Add the %LOCALSYSTEM%\IIS_IUSRS user and grant it Full control.
e. Click Apply.

3.3 Configuring the web service


Install Internet Information Services (IIS) with activated ASP.NET features.

To configure the web service:

1. Start the Internet Information Services (IIS) Manager (inetmgr.exe).

2. On the Connections view, right-click Sites, and then click Add Web Sites.

3. In the Add Website dialog box, enter InformationExtractionService in the


Site name box.

4. In the Physical path box, enter the installation path of IES with its subfolder
WebServiceAPI.

20 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
3.3. Configuring the web service

5. In the Type list, click http or https depending on your connection type, and
then enter the port in the Port box.

Note: The port must not be used by any other process.

6. Optional If you want to use a SSL certificate for HTTPS communication, click
Select, and then browse to the certificate file (optional). For more information,
see “Adding a certificate for client/server authentication for secure
communication using HTTPS (optional)” on page 20.

7. Click OK to close the Add Website dialog box.


The new web site is now shown as subnode InformationExtractionService in
the Connections view on the left side, and the node is selected.

8. On the Actions view on the right side, under Manage Web Site, check if web
site is already started. If not, click Start, and then click Browse.
The default web browser opens and shows a start message which indicates that
the web service is running.

9. In the web browser address, add status.aspx to the URL which is already
openend, and then press RETURN.
A webpage should be shown which shows information about the web service
and additional status information on the processed jobs.

3.3.1 Specifying the application pool


To specify the application pool:

1. On the Connections view, click Application pools.

2. In the Application Pools list, double-click the respective site name.

3. In the Edit Application Pool dialog box, select .NET CLR v4.0.30319 in
the .NET CLR version list if it is not already selected, and then click OK.

3.3.2 Configuring SSL settings for secure communication


using HTTPS (optional)
To configure SSL settings:

1. On the Connections view, at the Sites node, click


InformationExtractionService.

2. Double-click SSL Settings.

3. Select the Require SSL check box.

4. Under Client certificates, click the Require option, and then click Apply on the
Actions view.

OpenText Information Extraction Service for SAP Solutions – Administration Guide 21


CPIE160500-AGD-EN-09
Chapter 3 Configuring IES

3.3.3 Increasing the upload size (IIS 7.0 and later versions)
To increase the upload size to the web service, change the properties
maxAllowedContentLength, and maxRequestLength:

1. On the Connections view, below the Sites node, click


InformationExtractionService.

2. Double-click Configuration Editor.

3. On the Configuration Editor view, in the Section list, open the


System.webServer node.

4. On the Security subnode, click requestFiltering, open requestLimits, select the


maxAllowedContentLength property, and then enter the maximum upload
size you want to support (up to 4 GB). The default value is 30000000 bytes
(approximately 28,6 MB).

5. On the Actions view, click Apply.

6. On the Configuration Editor view, in the Section list, open the System.web
node.

7. Click httpRuntime, select the maxRequestLength property, and then enter the
maximum upload size you want to support (up to 2 GB). The default value is
4096 bytes (4 KB).

8. On the Actions view, click Apply.

To increase the upload size for the IES web application which communicates
via HTTPS, change the property uploadReadAheadSize:

1. On the Connections view, below the Sites node, click


InformationExtractionService.

2. Double-click Configuration Editor.

3. On the Configuration Editor view, in the Section list, open the


System.webServer node.

4. Click serverRuntime, select the uploadReadAheadSize property, and then


enter the maximum upload size you want to support (up to 2 GB). The default
value is 4096 bytes (4 KB).

5. On the Actions view, click Apply.

22 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
3.3. Configuring the web service

3.3.4 Configuring internal application settings


Internal application settings are stored in the web.config file.

To configure internal application settings:

1. In the Internet Information Services Manager, on the home site


InformationExtractionService, in the Features View, open Application
Settings.

2. Define the settings, and then click OK.

CompressMultipartResponse
Compress the HTTP multipart which gets sent to the leading (SAP) system.
The default value is true and must not be changed.

DefaultOcrTimeout
Maximum runtime of an operation. If runtime exceeds this value, the
operation will be cancelled. The default value is 50 minutes and must not be
changed.

LoadManagerMasterServer
Hostname of the Load Manager Server. The default value is 127.0.0.1
(localhost) and must not be changed.

NoOfOcrRetries
The number of retries if an operation gets failed. Not used for productive
use because retry handling is set by leading (SAP) system. The default value
is 0 and must not be changed.

SupportedSecurityProtocolTypes
Security protocols that are supported for secure communication via HTTPS.
The TLS protocol types Tls,Tls11,Tls12 are supported by default. A comma-
separated string or also a single value can be entered here. If the value is
empty, the default system setting will be used. For more intensive security
reason some SAP systems does not support older TLS protocols than Tls12.
In this case the setting should be changed to value Tls12 only.

TracingConfigFileName
Name of the configuration file which is used for application tracing setup.
The default value is InformationExtractionService.traceconfig and must
not be changed.

WebProxyAddress
Web proxy address if a proxy is used for outbound calls.

When you use client certificates for the communication via HTTPS (see “Adding
a certificate for client/server authentication for secure communication using
HTTPS (optional)” on page 20), set the following configuration parameters
accordingly:

OpenText Information Extraction Service for SAP Solutions – Administration Guide 23


CPIE160500-AGD-EN-09
Chapter 3 Configuring IES

StoreCertLocation
Each of the Microsoft Windows certificate stores has the following types
which you can use:

• localMachine (preferred setting)


• currentUser

ClientCertificateOption
Value that indicates if the certificate is automatically picked from the
certificate store or if the caller is allowed to pass in a specific client
certificate.

• manual (preferred setting)


• automatic

DistinguishedCertName
Subject value of the client certificate which is used for sending HTTP
requests to the leading SAP system(s). This value must match to an existing
subject name located in the local cert store, for example CN=*.opentext.
net, OU=SAP Solutions Development, O=OpenText, C=DE.

Additional there are a few settings which offers support for error analysis, for
example StoreRequestToFolder, which prints out the HTTP multipart request
to a text file on the local storage. But these settings should only be used by
administrators or customer service for temporary analysis.

3.4 Configuring tracing


You can use trace data to analyze and fix problems at runtime. The tracing
component has the following features:

• Output to multiple tracing targets.


• Hierarchical tracing architecture.
• Easy configuration on-the-fly through XML configuration files or software.
• Trace Viewer to view trace files, filter and search trace data, and observe
applications on several hosts.

24 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
3.4. Configuring tracing

3.4.1 Tracers
A tracer represents the source of a trace message. Tracers are named entities with a
hierarchical structure. Hierarchy levels are separated by dots. This corresponds to
the naming of .NET classes including namespaces. Therefore usually the class name,
for example DOKuStar.Runtime.Server, is used as name of the respective tracer.

The tracer name is used to configure the properties of the tracer such as the trace
level. You may use the full name of the trace or only a part of the name. If a
particular trace has not been configured explicitly, it inherits its configuration from
its parent tracer.

A special tracer, called the RootTracer, is the parent of all tracers and has no name.

3.4.2 Trace listeners


Trace listeners represent the destination of trace messages. The tracing system ships
with a collection of trace listeners:

RollingFileListener
This trace listener writes trace messages to a file. It generates a new file with a
unique file name for every process by merging the current time and the process
identifier into the file name. The output is flushed every 30 seconds. A new file
is created each day. Files older than 10 days (configurable) are removed.
RemotingTraceListener
This listener writes trace messages to a remote sink, for example the Trace
Viewer in order to display trace messages on-the-fly.
ConsoleTraceListener
Writes trace messages to console output.

Trace listeners may trace at different levels. Every tracer may have assigned its own
collection of trace listeners but usually only the root tracer has them all and all other
tracers inherit them.

3.4.3 Trace root path


Information Extraction Service writes trace messages to trace files located relative to
a root path for all applications. The default root path is %ALLUSERSPROFILE%
\Application Data\Open Text\Trace.

Note: The Application Data folder is hidden. Therefore, select the respective
option in the Folder Options of Microsoft Windows Explorer to display the
folder.

To change the default trace folder:

1. Set the registry value TraceRootPath (type REG_SZ) at the key HKLM\SOFTWARE
\Open Text, and on 64-bit systems also at the key HKLM\SOFTWARE
\Wow6432Node\Open Text to a new path.

OpenText Information Extraction Service for SAP Solutions – Administration Guide 25


CPIE160500-AGD-EN-09
Chapter 3 Configuring IES

2. To keep the trace configuration, copy the trace configuration files


(extension .traceconfig) to the new trace path.

3. If you want to use a remote trace folder, run the service with a domain user
account instead of the LocalSystem account.

4. Restart the DOKuStar Load Manager Microsoft Windows service and the
DOKuStar Tracing Microsoft Windows service.

Trace configuration files are stored directly under the root path. Trace files are
written to a subfolder, typically the folder name is the application name, for example
DOKuStar Load Manager.

3.4.4 Trace levels


Tracers and trace listeners have trace levels used to control the volume of the tracing
output. You can use following trace levels:

Fatal
Used in case of errors where the administrator has to be called immediately.
Those errors risk to crash down processing for example disk full.

Error
Used in case of errors that aborted the current job. Probably processing
continues with the next job.

Warning
An unexpected issue occurred and should be traced in order to be able to
analyze it later especially if it occurs again.

Info
This is the default level. It is use to trace normal progressing as an administrator
would see it in a monitor, for example:

• service has been started


• job <...> has been started
• job <...> has terminated status <...>
• service has been stopped

Fine
First debug level, for example to additionally trace failed polling calls or
important parameters, and so on.

Finer
Next debug level.

Finest
Highest debug level.

26 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
3.4. Configuring tracing

Note: The default level is Info. Do not stress tracing using this level Info with
your debug messages.

Configuration is reread on-the-fly if the configuration file changes. You do not


need to restart the load manager service.

3.4.5 Trace configuration


Several trace configuration files in the trace folder specify which trace messages a
distinct Information Extraction Service component writes to the trace folder. For
example, a trace configuration file defines the trace level for the trace messages.
Only trace messages with this specified trace level or higher are written to the trace
folder.

The trace configuration files must reside in the current trace folder. Therefore do not
forget to copy the trace configuration files to the new location if you change the trace
root path.

You may configure traces by editing the appropriate trace configuration file directly
or by selecting a predefined trace configuration in the Trace Viewer. For more
information, see “Analyzing trace files using Trace Viewer” on page 31. Selecting a
predefined trace configuration in the Trace Viewer changes the trace configuration
files automatically.

The trace configuration file has three types of elements:

listener
This element configures a trace listener by specifying the following:
name
Any describing name.
type
The full qualified name of the class which implements the listener.
threshold
Trace level (optional, default is Finest).
It also specifies other trace listener-specific parameters.

<listener name="file"

type="DOKuStar.Diagnostics.Tracing.RollingFileTraceListener">
<file value="DOKuStar Load Manager\
\DOKuStarClusterNode.log" />
</listener>
<listener name="remote"
type="DOKuStar.Diagnostics.Tracing.RemoteTraceListener">
<url value="tcp://localhost:20304/
DOKuStar.Diagnostics.Tracing" />
<threshold value="fine" />
</listener>

OpenText Information Extraction Service for SAP Solutions – Administration Guide 27


CPIE160500-AGD-EN-09
Chapter 3 Configuring IES

root
This element configures the root tracer by specifying the following:

level
Trace level.

listener-ref
The listeners. Usually all listeners are configured only at the root tracer, not
at the categories.

<root>
<listener-ref ref="file" />
<listener-ref ref="remote" />
<level value="fine" />
</root>

category
This element configures certain tracers by specifying the following:

name
Name of the tracer or part of its hierarchical name.

level
Trace level.

<category name="DOKuStar.Cluster.Operation">
<level value="fine" />
</category>

There are two types of configuration files:

merge (default)
Configures only a few items and merges them with a configuration that may
have been initialized by software and already has specified its root tracer and
trace listeners so that you only want to change trace levels of certain categories.

Example:

<?xml version="1.0" encoding="utf-8" ?>


<trace>
<category name="DOKuStar.Cluster.Operation">
<level value="fine" />
</category>
<category name="DOKuStar.Cluster.ClusterNode">
<level value="fine" />
</category>
<category name="DOKuStar.Cluster.Extraction">
<level value="fine" />
</category>
</trace>

28 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
3.4. Configuring tracing

overwrite
Configures all features and completely resets an initial configuration made
through software. You must specify the root tracer and its listeners.

Example:

<?xml version="1.0" encoding="utf-8" ?>


<trace update="overwrite">
<listener name="file"

type="DOKuStar.Diagnostics.Tracing.RollingFileTraceListener">
<file value="DOKuStar Load Manager\
\DOKuStarClusterNode.log" />
</listener>

<listener name="remote"
type="DOKuStar.Diagnostics.Tracing.RemoteTraceListener">
<url value="tcp://localhost:20304/
DOKuStar.Diagnostics.Tracing" />
<threshold value="fine" />
</listener>

<root>
<listener-ref ref="file" />
<listener-ref ref="remote" />
<level value="fine" />
</root>

<category name="DOKuStar.Cluster.Operation">
<level value="fine" />
</category>
<category name="DOKuStar.Cluster.ClusterNode">
<level value="fine" />
</category>
<category name="DOKuStar.Cluster.Extraction">
<level value="fine" />
</category>
</trace>

Tip: You can find examples for trace configuration files in the <Information
Extraction Service_install>\TraceConfig folder.

OpenText Information Extraction Service for SAP Solutions – Administration Guide 29


CPIE160500-AGD-EN-09
Chapter 3 Configuring IES

3.4.6 Location of trace files and trace configuration files


All kind of Information Extraction Service requests run within a cluster controlled
by the Load Manager. There are separate trace files for the Load Manager service
and every cluster node. There are two configuration files, one for the Load Manager
service and one shared by all cluster nodes.

Load Manager and Cluster Nodes

• Trace files
<TraceRoot>\DOKuStar Load Manager\DOKuStarLoadManager*.log
<TraceRoot>\DOKuStar Load Manager\DOKuStar.ClusterNode*.log
• Trace config file
<TraceRoot>\DOKuStarLoadManager.traceconfig
<TraceRoot>\DOKuStarClusterNode.traceconfig

Customizing Client

• Trace files
<TraceRoot>\rda1\rda1*.log
• Trace config file
<TraceRoot>\rda.traceconfig

All services
The Microsoft Windows event log is used to log creating, starting, and stopping
of the services.

3.4.7 Format of traces


Traces written to trace files have the following format:

<DateTime> <Level>:<Computer> <Application> <PID> <Category> <ThreadId>


[[<Message>]]

DateTime
Time when the trace message was written, sortable format yyyy.
MM.ddTHH:mm:ss.

Level
Trace level Fatal, Error, Warning, Info, Fine, Finer or Finest.
Computer
Name of the host where the trace message was written.
Application
Name of the application that wrote the trace message.

30 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
3.4. Configuring tracing

PID
ID of the process that wrote the trace message.
Category
Trace category (hierarchically to reflect classes and modules).
ThreadId
ID of the thread that created the trace message.
Message
Trace message enwrapped with 2 squared brackets at begin and end. Note: A
trace message is multi-line; it may contain carriage return and line feed.

Example: 2018.09.04T10:17:45 Error: SYS2186 DOKuStarLoadManager 2264


DOKuStar.Cluster.Configuration 1 [[this is the error message]]

3.4.8 Analyzing trace files using Trace Viewer


The Trace Viewer is used to show trace messages created by the Information
Extraction Service components and permits you to:

• View trace files.


• Search text using regular expression.
• Filter trace messages.
• Record trace information on-the-fly even on multiple computers simultaneously.
• Drop files into the viewer.

To analyze trace files with Trace Viewer:

1. In the Customizing Client, on the General tab, in the Tools group, click Trace
viewer.

Tip: Alternatively, you can start the Trace Viewer on the Microsoft
Windows start menu in the OpenText Information Extraction Service for
SAP® Solutions program group.

The Trace Viewer shows a list of all trace files found on the local computer. The
list is grouped by the different components.

Tip: If the toolbar is not shown, right-click in the right area, and then click
Toolbar.

Local Machine
You can open the trace folder by clicking the link in the header.
Filter
You can display only trace files containing messages of the respective types
by clicking All, Only errors, or Only errors and warnings in the Filter list.

OpenText Information Extraction Service for SAP Solutions – Administration Guide 31


CPIE160500-AGD-EN-09
Chapter 3 Configuring IES

Trace configuration
You can select one of three trace configurations. For more information, see
“Selecting a trace configuration” on page 33.
Display Level
You can specify one of seven different trace levels. In the most restrictive
level only fatal error messages are shown. In the most talkative trace level,
messages of all message types are shown.
The toolbar text indicates the currently selected trace level.
Display filter
You can set different kinds of filters that control which log messages are
shown. For more information, see “Filtering messages” on page 34.
Find
You can search in the currently open file. For more information, see
“Searching trace messages” on page 35.

Tip: You can enable more functions in the main menu, or in the context
menu of the right area.

• Open: Opens a trace that is not available in the file list.


• Set Trace folder: Permits to switch to a different folder containing trace
files.
• Clear all, clear: Removes all messages from the messages list view.
• Top window: Stays the Trace Viewer window on top. To switch this
feature off, use the command again.
• Columns: Controls which columns are shown in the messages list
view.
• Options: Opens the Options dialog box where you can change the
language of the Trace Viewer user interfaces.
• Auto scroll: If this option is selected, the view shows the last lines,
when log messages are added.

2. Double-click a file in the list.


The contents of the file is shown in the messages list view on the right side.

3. Double-clicking a message in the messages list view.


The Trace Message dialog box shows the complete message and its details.

32 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
3.4. Configuring tracing

3.4.8.1 Selecting a trace configuration


Notes

• This configuration affects the local computer. If you want to search an error
on a processing cluster, you may need to modify the trace configurations on
all computers of the cluster.
• The dialog box cannot indicate the current trace configuration, because you
could modify the trace configuration files using a text editor at any time,
creating a custom configuration differing from all three default
configurations described below.

To select a trace configuration:

1. Click Trace configuration.

2. Click one of the following trace configurations:

Debugging production system


Can be used to search for errors. Here all trace levels are set to the level
finest. This mode produces a large amount of trace data.
Development
Can be used to search for errors in your own code. Here the trace level for
all namespaces starting with DOKuStar is set to info, whereas all other
levels are set to finest. Thus you get the maximum amount of trace data for
project modules and plug-ins if you use a separate namespace.
Production
Intended for production systems. It traces all errors, warnings, and info
traces, but does not produce too much trace data.

OpenText Information Extraction Service for SAP Solutions – Administration Guide 33


CPIE160500-AGD-EN-09
Chapter 3 Configuring IES

3.4.8.2 Filtering messages


Specified filters only affect the messages list view of the Trace Viewer. They do not
modify the contents of the trace files and they do not control which messages are
written to trace files.

To filter messages:

1. In the toolbar, click Display filter. Alternatively, in the context menu of the
message list view, click Filter.

2. Select the filters:

Level
This filter permits to switch all trace messages off or to specify a trace level.
If the trace level is set to Error, only error messages are shown. The other
values add messages of other types successively. If the trace level is set to
Finest, messages of all types are shown.
Computer
Lists computers of the cluster used by the project. By default, messages
from all computers are shown. If you work with a cluster you can exclude
some computers or restrict output to the messages of a single computer.
Application
Lists all applications of the current project. By default, all applications are
enabled.
PID
Lists process IDs of all processes of the current project. By default, all
processes are enabled.
ThreadId
Lists thread IDs that created the trace message.
EventId
Lists event IDs that created the trace message.
Category
A category is a group of classes. This filter permits to restrict messages of
the type Info to functional units within the Document Reader during
debugging.
Find filter
If the text box in this area is not empty only matching messages are shown
in the messages list view. The check boxes permit to control text matching.

• If the Match case check box is selected, the message must contain the
string in exactly the same spelling with respect to upper and lower case
letters.
• If the Match whole word only check box is selected, the string will not
be matched against a part of a word.

34 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
3.4. Configuring tracing

• If the Regular expression check box is selected, the specified string is


used as a regular expression.

3.4.8.3 Searching trace messages


You can search for strings in the trace message files shown in the messages list view.

To search trace messages:

1. In the toolbar, click Find. Alternatively, in the context menu of the message list
view, click Find.

2. In the Find dialog box, enter the search string. You have the following
additional options: Match case, Match whole word only, Regular expression

OpenText Information Extraction Service for SAP Solutions – Administration Guide 35


CPIE160500-AGD-EN-09
Chapter 3 Configuring IES

3. Click Find Next or Find Previous to search the message list. The next or
previous matching trace message is selected in the messages list view.

3.5 Controlling cache behavior


During recognition, the Document Reader uses a cache to store input data and result
files. For each recognition job, a separate cache entry is created, which is a subfolder
of the cache folder with a GUID as unique name.

By default, the number of cache entries in each project cache is controlled in relation
to a specified cache size. If the number of entries reaches twice the specified number,
the oldest entries are deleted until the number of entries equals the specified cache
size. The default value of the cache size is 32.

To controll the cache behavior:

1. Go to the IES program files folder, and then open the configuration file
DOKuStarClusterNode.exe.config.

2. Go to the tag appSettings, and then change the parameters which are specified
as key and value attributes of an add tag.

3. Use a CacheSize parameter, for example:

<appSettings>
<add key="CacheSize"value="20" />
</appSettings>

4. Optional Optionally, you can use following parameters:

CacheLifeTime
Minimizes the cache size on a production system by switching to non-
buffered mode. The cache entries are deleted as soon as a job is terminated.
The specified cache size does not take effect in this case.

SaveIntermediateResult
Reduces further cache size by specifying that intermediate results that are
useful for error analysis but are not needed for the following processing
steps should not be stored in the cache folder.

Example: The example shows the respective part of the configuration file where the
appSettings tab and the two additional parameters have been added:

<?xml version="1.0"?>
<configuration>
. . .
<appSettings>
<add key="CacheLifetime"value="NonBuffered" />
<add key="SaveIntermediateResult"value="false" />
</appSettings>
</configuration>

36 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
3.6. Working with configuration data (production system)

Tip: To modify these parameter settings temporarily, for example to analyze


problems, you can set CacheLifetime to Buffered, and
SaveIntermediateResult to true.

3.6 Working with configuration data (production


system)
After performing the installation steps described in chapter “Installing
IES“ on page 15, your IES configuration consists of a defined amount of server
cluster nodes (= Cluster Master).

The following sections describe which components are located on which participants
and how the different participants interact in respect to the components.

3.6.1 Technical configuration data


3.6.1.1 Load Manager files
An IES server cluster contains one IES Cluster Master (= IES Server). The Cluster
Master distributes the workload on the hardware of the IES cluster. The Cluster has
to be configured on the Cluster Master with the Load Manager Configuration tool.
For more information, see “Configuring cluster nodes” on page 40. The Load
Manager Configuration tool saves the cluster configuration files into the folder
%ALLUSERSPROFILE%\Application Data\Captaris\DOKuStar Load Manager on the
Cluster Master.

3.6.1.2 Trace configuration files


Each participant of a IES system writes trace files to its local trace folder
%ALLUSERSPROFILE%\Application Data\Open Text\Trace. In the trace folder there
are several trace configuration files specifying, for example, the trace level of the
trace messages. For more information, see “Configuring tracing” on page 24.

3.6.2 Runtime files


3.6.2.1 Temporary files of Document Reader and Document Extraction
On the IES Cluster Nodes the actual extraction is done by a component named
Document Extraction. Superordinate tasks, like splitting of pages or export of results
are done by a component named Document Reader. Both components write
temporary files into the Microsoft Windows temp folder.

If the Load Manager Service of a IES Cluster Node is running using the
LocalSystem account, which is the default, the temporary files are written into the
temp folder defined in the system temp variable.

OpenText Information Extraction Service for SAP Solutions – Administration Guide 37


CPIE160500-AGD-EN-09
Chapter 3 Configuring IES

3.6.2.2 Trace folder


You can change the location of the Trace folder by creating a registry entry. For
more information, see “Configuring tracing” on page 24.

3.6.3 Registry entries


During installation, IES adds some entries to the Microsoft Windows registry, for
example installation paths and version information.

3.6.4 Microsoft Windows services


IES is based on OpenText™ Capture Center. The runtime environment of Capture
Center consists of several programs and Microsoft Windows services. In the
standard configuration, the following Capture Center Microsoft Windows services
run on the IES Server:

• Load Manager Service (DOKuStar Load Manager)


The Load Manager Service on the IES Server distributes the workload on the IES
Server Nodes by communicating with the Load Manager Services on the nodes.
• Tracing Service (DOKuStar Tracing)
The Tracing Service provides tracing.

3.6.5 Moving IES data to a different location


By default, IES stores all configuration files and all temporary files in different
folders on the system drive. Sometimes the system drive is reserved for operating
system data and it is not allowed to store any application-specific data on the system
drive. In this case, you can move most of the configuration and runtime data of IES
to a different location.

3.6.5.1 Configuring cache location


The caches used to store temporary recognition and download data reside in a
subfolder DOKuStar Professional/3.0/Cache of the temporary files folder on the
IES Server and each IES Server Node. It uses the user account that you specified in
the Service Account dialog box during installation. You can move this data to a
different location.

To move files created in the temporary files folder to a different location:

1. Create the registry key HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Open


Text\Capture Common.

2. At this key, create a string value tempPath containing the path for these data.
3. For the change to take effect, restart the service DOKuStar Load Manager.

Alternatively, you can move the location of the whole temporary files folder using
Control Panel.

38 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
3.7. Configuring load balancing

3.6.5.2 Configuring trace file location


Trace file location is controlled by a registry value on each IES Server. For more
information, see “Trace root path” on page 25.

3.6.5.3 Configuring program data location of components


By default, the Load Manager creates configuration files in subfolders of the
%PROGRAMDATA% folder on the system drive.

You can move the program data files, for example to a different drive.

To move program data files to a different location:

1. Create the registry key HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Open


Text\Capture Common.

2. For this key, create a string value named CommonApplicationDataPath


containing the path for these program data.

3.7 Configuring load balancing


3.7.1 Understanding the Load Manager
The Load Manager enables load balancing of multiple instances of the IES Server on
a multi-processor system. This provides a scalable performance, and a load
balancing capable of both multi-client and multi-application.

The Load Manager is a Microsoft Windows service which runs on the IES Server.
This Microsoft Windows service is started automatically after installation and at
every system start. The Load Manager on the IES Server is the master and controls
the load balancing. This master receives job requests and distributes these tasks.
Usually the IES Cluster contains as many cluster nodes as processors. If the IES
Server is a two-processor computer and if there are no further IES Server Nodes, the
IES Cluster will consist of two Cluster Nodes.

A Cluster Node hosts a service of a specified type called the Service Type. For the
IES Server, the default services types are Document Extraction, Learning (Feedback)
and Configuration.

The IES Server automatically creates and configures the appropriate jobs which runs
within specific Cluster Nodes at the Load Manager. You do not need to configure
them manually.

The Load Manager processes a job request by creating an operation. The Load
Manager keeps a list of waiting and active operations and manages them until their
execution has been completed.

The Jobs view and the Cluster view on the IES Server Cluster Monitor permit to
monitor the Load Manager.

OpenText Information Extraction Service for SAP Solutions – Administration Guide 39


CPIE160500-AGD-EN-09
Chapter 3 Configuring IES

The cluster configuration is managed centrally at the IES Server. You can configure
the IES Server Cluster with the Load Manager Configuration tool hosted within the
Cluster Monitor.

To open the Cluster Monitor:

1. Click the Start menu.

2. Type Cluster Monitor.

3. In the Apps list, select Cluster Monitor.

To open the Load Manager Configuration:

• In the Cluster Monitor, on the Tools menu, click Cluster Configuration.

3.7.2 Configuring cluster nodes


The cluster nodes and load balancing will be configured automatically during
installation and/or when processing is started, that is after the first run of an IES job,
triggered by the external SAP system and passed to by internal Load Manager.

The pre-configuration of the IES Server Cluster will setup a defined number
of cluster nodes which depends on the available system hardware, that is one IES
Server Node for each processor of the IES Server. The pre-configuration of the IES
Server Cluster will look as follows on a computer with four processors:

With a high number of processing nodes, you also need more RAM to be able to use
them effectively or throughput will decrease because of increased swapping.
Typically, you need about 1.5 GB per Runtime Node.

40 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
3.7. Configuring load balancing

3.7.2.1 Changing cluster node properties


To change the properties of a cluster node:

1. Open the Load Manager Configuration.

2. In the Load Manager Configuration dialog box, click the Cluster node you
want to change in the tree view.

3. Click the property you want to change, define the value, and then click OK.

LookupInterval
Time interval after which the Load Manager checks whether the cluster
node is still alive.
Operation Types
Load Manager operation type.
Optimization Time Window
To prevent loading time, the Load Manager tries to assign an operation of
the currently loaded operation type to a node that becomes available. As
soon as the first operation in the Load Manager queue waits longer than the
specified time, it is assigned to the next available node. Enter the time in the
format hh:mm:ss.
Process Priority
With the default value BelowNormal, priority of the computationally
intensive Runtime Node processes is reduced. Otherwise other important
processes would often have to wait for processor time and would respond
slowly. If you set this property to Normal, priority is not reduced.
Reset Cycle
After the specified number of operations the cluster node is reset
automatically. This can also be used to ensure that the project is reloaded.
Reset on failure
If this property has the value True, the Load Manager tries to reset the
cluster node in case of failure.
Startup Time
Specifies the maximum time the Runtime Nodes should need for start-up. If
the start-up of a Runtime Node exceeds this limit, the corresponding
process is terminated. Enter the time in the format hh:mm:ss.
Use IPC Channel
As default, the Load Manager uses TCP for communication with the local
cluster nodes. If this property is set to True, it uses IPC channels (named
pipes) instead.

OpenText Information Extraction Service for SAP Solutions – Administration Guide 41


CPIE160500-AGD-EN-09
Chapter 3 Configuring IES

3.7.2.2 Changing IES Server Node properties

Note: Within IES you do not need to modify any properties.

To change the properties of a IES Server Node:

1. Open the Load Manager Configuration.

2. In the Load Manager Configuration dialog box, click the IES Server Node you
want to change in the tree view.

3. Click the property you want to change, define the value, and then click OK.

Name
Cannot be edited. It is comprised from the computer name, service type and
instance number.
Agent Url
URL of the agent service for this cluster node within the cluster.
Description
Only for logging purposes.
Exclusive Operation Types
Restricts a cluster node to the specified Load Manager operation types.
Priority
Priority of the cluster node. The Load Manager prefers Runtime Nodes with
a higher priority value when it wants to assign an operation to a Runtime
Node. The default value is 0. To give a node a higher priority, enter a value
greater 0, to give a node lower priority, you can enter a negative value.

42 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
3.8. Starting and stopping services on the IES Server

3.8 Starting and stopping services on the IES Server


On the IES Server, the following Microsoft Windows services are running:

• DOKuStar Load Manager


• DOKuStar Tracing

These services are started automatically after the installation and at every system
start. In case of failures, you may need to stop, start, or restart a service.

To stop, start, or restart a service:

1. Use Microsoft Windows shortcut keys WIN + R to launch Run.

2. Type services.msc into the dialog box.

3. Press Enter.

Tip: If after system reboot a service does not automatically start although its
Startup Type is set to Automatic, set the Startup Type to Automatic (Delayed
Start).

3.9 Setting up the SLD registration on the SAP


system
You set up the SLD registration on the SAP system with the IES application specific
data.

To get the IES application specific data:

1. Check if the sap_metadata.xml file is available in the folder <Information


Extraction Service\WebServiceAPI>.

Note: This file is delivered with a patch. Make sure you have installed
the latest patch. For more information, see “Installation procedure
overview” on page 15, and “Installing patches and service packs”
on page 17.

2. Open the IIS manager, and then click the site with the default name
InformationExtractionService.
The settings should be the same as listed in step 2 and 3.

3. In the Actions view, click Basic Settings, and then copy the following settings:

• Site name: InformationExtractionService


• Application pool: InformationExtractionService
• Physical path: C:\Program Files (x86)\Open Text\Information
Extraction Service

OpenText Information Extraction Service for SAP Solutions – Administration Guide 43


CPIE160500-AGD-EN-09
Chapter 3 Configuring IES

4. In the Actions view, click Bindings, and then copy the following settings:

• Type: http

• Binding Information:

To set up the SLD registration on the SAP system:

1. Install SAP Diagnostics Agent, and then connect it to Solution Manager. For
more information, see SAP Note 1365123.

2. Upgrade the SAP Host Agent to the latest version. For more information, see
SAP Note 2598404.

3. Open the Agent Administration in Solution Manager, and then click the Non-
authenticated Agents tab.

4. Update the Diagnostic Agent agent, and then click Trust Agents.

5. Open Landscape Management (LMDB), click Technical Systems > Select Type:
Microsoft Internet Information Services.

6. Expand the IIS tree.

a. Click Software, and then add and configure the Product Instances, and
Software Component Versions.

b. Click Technical Instances, and then copy the IES application specific data
into the corresponding areas.

MSIIS Applications

• Site Name: InformationExtractionService

• Application Path: C:\Program Files (x86)\Open Text


\Information Extraction Service

MSIIS Pools

• Name of Application Pool: InformationExtractionService

MSIIS Sites

• Site Name: InformationExtractionService

• Web Binding Info:

• Web Protocol: http

44 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
Chapter 4
Monitoring IES

For monitoring of an IES system, you can use external monitoring tools, and the
Inbound Configuration and Inbound Administration work center in Business Center
or VIM. For more information, see section 4 “Business Center Workplace: Inbound
Administration work center” in OpenText Business Center for SAP Solutions - User
Guide (BOCP-UGD), and section 4 “Inbound Configuration” in OpenText Business
Center for SAP Solutions - Configuration Guide (BOCP-CGD).

Monitoring IES with external monitoring tools

If you monitor IES with external monitoring tools, take the following considerations
into account:

• CPU usage: On the server and on Recognition Nodes, CPU usage will often be at
100% while a document is being processed. Whereas a single page is processed in
a few seconds, processing may take up to several minutes for a document with a
large number of pages. Therefore high CPU usage may indicate a problem only if
it persists for more than about 5 to 10 minutes depending on the maximum
number of pages of your documents.
• Disk space: IES does not collect and accumulate data. Temporary files written
during document processing are being deleted when the document is exported.
Trace files are deleted automatically after several days. Therefore disk space
should pose no problems if you provided sufficient resources.
• Main memory: Because the Cluster Node processes on the IES Server and the
Recognition Nodes are reset automatically after a certain number of documents
has been processed, main memory usage should not grow on the long run. If you
provided sufficient main memory depending on the number of Cluster Nodes,
main memory problems should not occur.
• Microsoft Windows services: For document processing, the Microsoft Windows
services DOKuStar Load Manager, and DOKuStar Tracing must be available.
Therefore it is meaningful to monitor whether these services are running. If a
service is not running, start it.

OpenText Information Extraction Service for SAP Solutions – Administration Guide 45


CPIE160500-AGD-EN-09
Chapter 5
Configuring high availability

The most critical part of a IES system is the BC Inbound Configuration, or the ICC
Dispatcher, respectively. These components are parts of BC or VIM in SAP ERP.
Therefore their high availability is guaranteed.

The application configuration data are stored in SAP ERP. Therefore, the high
availability of the application configuration data is guaranteed.

The Operation Nodes which runs on the IES Server are not critical at all. Therefore,
there is no fail-over scenario defined for them.

For more information about high availability in SAP ERP, see the SAP Netweaver
Technical Operations Manual (https://help.sap.com/doc/erp2005_ehp_03/6.03/en-US/
72/cd1e4261ea5433e10000000a155106/frameset.htm).

OpenText Information Extraction Service for SAP Solutions – Administration Guide 47


CPIE160500-AGD-EN-09
Chapter 6
Configuring security

6.1 User management and authorization concept


IES has no own user management. It uses Microsoft Windows user management. It
is not possible to define or change Microsoft Windows users within IES. Provide the
required user accounts using the respective Microsoft Windows if needed.

Per default the Load Manager service runs under Local System. There is no need to
change this setting to a domain user account as long as no remote communication
will be setup.

If you want to use a domain user account for running the service, you must prepare
it before the installation and enter during installation. In this case the Load Manager
Service user must have local administrator rights.

For more information about using the Microsoft Windows user management, see
Best Practice Guide for Securing Active Directory Installations (https://
docs.microsoft.com/en-us/windows-server/identity/ad-ds/plan/security-best-
practices/best-practices-for-securing-active-directory).

6.2 Logging of security-relevant events


Because IES uses the Microsoft Windows user management, you can use the
Microsoft Windows features to log security events in the Microsoft Windows event
folder. To define which security events should be logged by Microsoft Windows,
implement an audit policy. For more information, see the Microsoft Windows Server
2016 Security Guide (http://download.microsoft.com/download/5/8/5/585DF9E9-
D3D6-410A-8B51-81C7FC9A727C/
Windows_Server_2016_Security_Guide_EN_US.pdf).

Security-relevant events on the SAP ERP side can be logged using SAP ERP means.

6.3 Encryption of communication channels


All participants of a IES system communicate with the BC Inbound Configuration in
SAP ERP by HTTP or HTTPS, depending on the configuration of the web service.

OpenText Information Extraction Service for SAP Solutions – Administration Guide 49


CPIE160500-AGD-EN-09
Chapter 6 Configuring security

6.4 Secure configuration


IES provides a secure configuration by default:

• All application specific configuration is stored in SAP ERP.


• The heart of a IES system, BC Inbound Configuration/ICC Dispatcher, is an SAP
ERP component.
• The repository is part of the SAP ERP system.
• HTTPS communication can be setup with the use of client/server certificates.

6.5 Responsibilities
In an IES system, no real users are involved.

On the BC/VIM SAP system, there are additional user types and responsibilities.

50 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09
Chapter 7
Troubleshooting

BC or VIM manages the documents which are then proceed by IES. The components
manage a list of all documents and their current states. This list can be monitored
with defined tools in SAP ERP. When a specific request cannot be processed by the
IES Server, the corresponding entry in the SAP ERP system gets an error status.

Communication issues
All communication between the SAP ERP system and the IES Server takes place
using HTTP(S). All HTTP(S) request are logged by the IES Server and IES
application level also. In general, there could be various reasons for
communication problems using HTTP(S).
IIS web server
Before the IES web application receives any incoming requests, IIS is checking
for valid HTTP(S) first. By default, all IIS logs are written to the local folder
C:\inetpub\logs\LogFiles. The incoming requests are logged to specific trace
files having timestamp information in the file name.

Example: No client certificate is send with the HTTPS request, although it is requested
by the service. In this case the IIS refuses the request with the following response: “HTTP
error code: 403 / HTTP error message: The page you are attempting to access requires
your browser to have a Secure Sockets Layer (SSL) client certificate that the Web server
recognizes.”

In case IIS reports the HTTP error code 403 13, disable the client revocation
check on the IIS web server as described in https://blogs.msdn.microsoft.com/
kaushal/2012/10/15/disable-client-certificate-revocation-crl-check-on-iis.
IES web application
The IES web application defines the following specific HTTP response codes for
temporary and permanent error cases:

• Issue with action specific data: HTTP 400 (bad request)


• Unsupported action or protocol version: HTTP 501 (not implemented)
• Service unavailable (for example due to overload or repository not
accessible): HTTP 503 (service unavailable)
• Other permanent errors: HTTP 500 (internal server error)

If an error occurs refer to the application traces for more information. The IES
web application logs are written to a specific trace folder and can be viewed
using the Trace Viewer Tool. For more information, see “Configuring tracing”
on page 24.
Monitoring activity
The IES setup installs following tools which helps you monitoring the requests:

OpenText Information Extraction Service for SAP Solutions – Administration Guide 51


CPIE160500-AGD-EN-09
Chapter 7 Troubleshooting

• Cluster Monitor. For more information, see “Configuring cluster nodes”


on page 40.
• Trace Viewer. For more information, see “Analyzing trace files using Trace
Viewer” on page 31.

Additional IES offers a web page where general information about the service
and jobs which has been processed are available. You can open the web page
using http(s)://<hostname>:<port>/status.aspx.
You can see the last jobs that were processed, together with eventual errors.
Only a limited number of jobs is shown. It may even happen that memory was
recently cleared and no details are shown, this is not an error. In this case check
the status again a few minutes later.
Restart web service and Microsoft Windows services
Sometimes temporary issues can be resolved by restarting the IES web service
on the IIS Manager and additionally restarting the Microsoft Windows services
DOKuStar Load Manager and/or DOKuStar Tracing.
If the status web page cannot be displayed on a web browser running on a
remote system, wait for a few minutes to see whether this is only a temporary
network problem. If the issue persists, restart the web service.
If some of the runtime jobs run into same error case, first stop the IES web
service on the IIS Manager and, if the service has been stopped, wait for a view
minutes, and then restart the Microsoft Windows service DOKuStar Load
Manager.

52 OpenText Information Extraction Service for SAP Solutions – Administration Guide


CPIE160500-AGD-EN-09

You might also like