DCS AdministratorsGuide en

DOKuStar Capture Suite
Administrator's Guide
Administrator's Guide
Rev.: V3.0 SR02 (2010-02-23)
Open Text Document Technologies GmbH
Max-Stromeyer-Straße 116
D-78467 Konstanz – Germany
Phone: +49 7531 87 0
Support:
Phone: +49 89 4629 2121
E-Mail: de-support@opentext.com
Internet: http://www.opentext.com/2/global/services-home/services-support-contact.htm
Copyright  Open Text Document Technologies GmbH

ACKNOWLEDGEMENTS
SAP®, R/3® and SAP CRM® are registered trademarks of SAP AG.
Microsoft®, Microsoft SQL®, and Microsoft Sharepoint® are either registered trademarks or trademarks of Microsoft Corporation in
the United States and/or other countries.
Artifex®, the Artifex logo, Ghostscript®, and the Ghostscript logo are registered trademarks of Artifex Software Inc.
PostScript® is a trademark of Adobe Systems Incorporated.
PCL® is a trademark of Hewlett Packard Company.
Portions copyright  2003-2009 AllMyPapers.
All other products or company names are used for identification purposes only, and are trademarks of their respective owners. All
rights reserved.
Contents
System Requirements 1
Flow Server and Extraction Cluster Node ..............................................................................1
Validation Client...................................................................................................................2
Network Requirements .........................................................................................................2
Installing 3
Installing the DOKuStar Capture Suite on a Single Machine..................................................3
Full Installation .......................................................................................................3
Basic Configurations for a Full Installation ..............................................................7
Installing Your DOKuStar Capture Suite Application ..............................................8
Installing the DOKuStar Capture Suite on a Distributed System.............................................9
Installation Overview ..............................................................................................9
Installation of the Flow Server...............................................................................10
Installation of an Extraction Cluster Node..............................................................15
Installation of a Validation Client ..........................................................................20
Basic Configurations for a Distributed System .......................................................24
Installing Your DOKuStar Capture Suite Application ............................................26
Upgrading from Version 2.0................................................................................................27
Documentation 28
DOKuStar Capture Suite.....................................................................................................28
DOKuStar Professional.......................................................................................................28
DOKuStar Validation..........................................................................................................29
DOKuStar Extraction..........................................................................................................30
Configurations 31
Components of the Standard Configuration .........................................................................31
Overview ..............................................................................................................31
Configuration Data................................................................................................31
Runtime Files........................................................................................................34
Databases..............................................................................................................36
Services ................................................................................................................37
Increasing Throughput ........................................................................................................39
Overview ..............................................................................................................39
Increasing the Number of Extraction Cluster Nodes ...............................................39
Using a Separate File Server..................................................................................39
Replacing the SQL Server Express Edition ............................................................39
Running the Scheduler Service (additionally) on another Machine .........................39
Using a Second Extraction Cluster.........................................................................40
Using a Second DCS System .................................................................................40
DOKuStar Capture Suite Administrator's Guide Contents • iii

Providing High Availability ................................................................................................40
Overview ..............................................................................................................40
Flow Server on a Microsoft Cluster Using an Already Existing SQL Cluster ..........41
Flow Server as Virtual Machine Hosted on ESX Server – Cold Standby.................43
Security ..............................................................................................................................45
Best Practice for Users and Groups........................................................................45
Encryption of Communication Channels................................................................48
Encryption of the Repository.................................................................................49
Improving Security on the Validation Clients.........................................................49
Logging of Security Events ...................................................................................49
Logging of Configuration Data Changes................................................................49
Configuration Techniques ...................................................................................................50
Adding a Further Extraction Cluster Node .............................................................50
Adding a Further Extraction Cluster ......................................................................50
Creating a DOKUSTAR Instance Manually...........................................................51
Removing the sa User after Installation..................................................................51
Using a SQL Server on another Machine for the Flow Database.............................52
Creating the File FlowService.dcf..........................................................................53
Using a SQL Server on another Machine for the ART Database .............................53
Using a SQL Server on another Machine for the ACT Database .............................54
Using another Repository Location........................................................................54
Using another Configuration Location ...................................................................54
Changing the Trace Folder ....................................................................................55
Changing the Account of a Capture Suite Windows Service...................................56
Running an Additional Scheduler Service on another Machine...............................56
Running the Scheduler Service on another Machine...............................................56
Using a Validation Client for Several DCS systems ...............................................56
Configuration of the Connection to the ART Database...........................................57
Configuration of the Connection to the ACT Database...........................................58
Configuring Shortcuts ...........................................................................................58
Changing the User Interface Language of Validation .............................................58
Administration 59
Overview............................................................................................................................59
Creating a New System View..............................................................................................61
Modifying a System View...................................................................................................63
Adding a New Shape to the System View ..............................................................63
Adding a Service to a System View .......................................................................64
Removing Items from a System View....................................................................65
Monitoring Several Systems................................................................................................66
Menus ................................................................................................................................67
File Menu .............................................................................................................67
View Menu ...........................................................................................................67
Windows Menu.....................................................................................................68
Help Menu............................................................................................................68
iv • Contents DOKuStar Capture Suite Administrator's Guide

Views and Windows ...........................................................................................................69
Introduction ..........................................................................................................69
Controlling Views .................................................................................................69
Controlling Windows ............................................................................................71
System Window....................................................................................................72
Shapes View .........................................................................................................73
Summaries View...................................................................................................74
Job Class View......................................................................................................78
Activities and Jobs View .......................................................................................79
Activity Details Dialog .......................................................................................................85
Job Details Dialog...............................................................................................................86
Scheduler Dialog ................................................................................................................88
CleanUp Dialog ..................................................................................................................89
Periodical Tasks..................................................................................................................92
Monitoring the System ..........................................................................................92
Deleting Trace Files ..............................................................................................92
Monitoring Flow Database Size.............................................................................92
Monitoring Reporting Data....................................................................................92
ART and ACT Training.........................................................................................93
Monitoring the Size of ART Database Files ...........................................................93
Further Runtime Files............................................................................................93
Broken Jobs: Trouble Shooting ...........................................................................................94
Backups of the Dispatch Repository 96

Overview............................................................................................................................96
Stopping Processing............................................................................................................96
Backup Data .......................................................................................................................97
Starting the Services ...........................................................................................................97
Restoring Data....................................................................................................................97
Backups of the ART Database 98
Backups of the ACT Database 99
Removing the Software 100
Working with Hot Spots 101

Hot Spots - An Overview .................................................................................................. 101
Configuring Hot Spots ...................................................................................................... 102
Creating Hot Spots .............................................................................................. 102
Configuring Polling Cycle and Project File.......................................................... 103
Configuring a Hot Spot of Type File System........................................................ 104
Configuring a Hot Spot of Type FTP ................................................................... 105
Configuring a Hot Spot of Type Mail .................................................................. 106
Configuring a Hot Spot of Type SharePoint ......................................................... 107
Administering Hot Spots ..................................................................................... 108
DOKuStar Capture Suite Administrator's Guide Contents • v

Reporting 111
Introduction ...................................................................................................................... 111
Initializing Reporting........................................................................................................ 112
Report Viewer .................................................................................................................. 116
Overview ............................................................................................................ 116
Toolbar of the Report Viewer .............................................................................. 117
Changing the Reporting Database........................................................................ 118
Classification Report ........................................................................................... 119
Document Hit Rate Report .................................................................................. 120
Field Hit Rate Report .......................................................................................... 121
Interaction Summary Report................................................................................ 122
Activating Interaction Statistics ........................................................................... 124
Load Manager 125

Introduction ...................................................................................................................... 125
Dispatching jobs.................................................................................................. 126
Reducing Unnecessary Re-initialization............................................................... 126
Exclusive Profiles ............................................................................................... 126
Failover .............................................................................................................. 126
Monitoring.......................................................................................................... 126
Starting the Load Manager .................................................................................. 126
Monitoring ....................................................................................................................... 127
Overview Tab Page ............................................................................................. 127
Cluster Nodes Tab Page ...................................................................................... 128
Operations Tab Page ........................................................................................... 129
History Tab Page................................................................................................. 130
Configuration ................................................................................................................... 131
Configuring Cluster Nodes .................................................................................. 131
Properties of the Cluster Node ............................................................................. 134
Profiles ............................................................................................................... 135
Error Documents............................................................................................................... 136
Tracing 137
Overview.......................................................................................................................... 137
Trace Root Path ................................................................................................................ 137
Configuration ................................................................................................................... 138
Trace Viewer .................................................................................................................... 138
Trace File Location........................................................................................................... 141
vi • Contents DOKuStar Capture Suite Administrator's Guide

Licensing of DOKuStar Products 143
Introduction ...................................................................................................................... 143
Licensing Concept ............................................................................................................ 143
Licensing Components ........................................................................................ 143
Network Installation of the License Manager ....................................................... 146
Moving the WIBU Box to Another PC ................................................................ 146
Evaluation Kit..................................................................................................... 146
Separate Installation of a License File.................................................................. 147
License Update ................................................................................................... 147
Trouble-Shooting.............................................................................................................. 148
DCOM Configuration.......................................................................................... 148
Using License Manager with Firewalls ................................................................ 157
Microsoft Loopback Adapter............................................................................... 158
Using different Windows Domains...................................................................... 158
License Manager Command Line Reference........................................................ 159
DOKuStar License Observer ............................................................................................. 159
Running the License Observer ............................................................................. 159
Configuration...................................................................................................... 161
Index 163
DOKuStar Capture Suite Administrator's Guide Contents • vii

System Requirements
Flow Server and Extraction Cluster Node

System Requirements
Hardware:
• Pentium IV processor, 3 GHz or more
• 1 GB RAM
• 20 GB disk space
• Interface for dongle, if needed (USB, parallel or serial)
These are minimum requirements.
Software:
• Operating Systems:
System 32 bit 64 bit

Windows XP SP3 x
Windows 2003 Server SP2 x x
Windows 2003 Server R2 SP2 x x
Windows 2008 Server x
Windows 2008 Server R2 x
• .NET Framework 2.0 and 3.5

• Internet Explorer 6.0 or higher
DOKuStar Capture Suite can be used with VMWare (ESX-Server).
On the computers of a DOKuStar Professional cluster the Windows Firewall must be deactivated.
DOKuStar Capture Suite Administrator's Guide System Requirements • 1

Validation Client
System Requirements
Hardware:
• Pentium IV processor, 2,4 GHz or more
• 512 MB RAM
• 20 GB disk space
• Interface for dongle, if needed (USB, parallel or serial)
These are minimum requirements.
Software:
• Operating Systems:
System 32 bit 64 bit

Windows XP SP3 x
Windows Vista SP1 x
Windows 7 x
Windows 2003 Server SP2 x x
Windows 2003 Server R2 SP2 x x
Windows 2008 Server x
Windows 2008 Server R2 x
• .NET Framework 2.0 and 3.5

• Internet Explorer 6.0 or higher
The Validation Client can be used with VMWare (ESX-Server).
Network Requirements
The protocol TCP/IP must be supported. Windows File Sharing is needed.
2 • System Requirements DOKuStar Capture Suite Administrator's Guide

Installing
Installing the DOKuStar Capture Suite on a

Single Machine
Full Installation
Insert the installation DVD. If installation doesn’t start automatically, start the program setup.exe in its root folder:
At runtime the Flow Server will keep its flow data in a SQL Server database. Therefore the installation of DOKuStar
Capture Suite will create a flow database in a local SQL Server instance named DOKUSTAR. The existence of this
local SQL Server DOKUSTAR instance with sa user password #DOKuStar# is a precondition of the DOKuStar
Capture Suite Flow Server installation. You only can install DOKuStar Capture Suite Flow Server if the local
DOKUSTAR instance is available.
There are several possibilities to create the required DOKUSTAR instance depending on the SQL Server edition that is
already installed or that should be installed on the local machine.
If there is no SQL Server already installed on the local machine:
• If you want to use the Microsoft SQL Server Express Edition (2005 Service Pack 2, language English), click
Install Microsoft SQL Server. The setup will install the Express Edition and create the DOKUSTAR
instance automatically. See below for further instructions.
• If you want to use another language edition of the Microsoft SQL Server Express Edition, click Install
Microsoft SQL Server. In the Microsoft SQL Server Setup (see below) click Change and
select the respective setup.exe. The setup will install the specified Express Edition and create the
DOKUSTAR instance automatically. See below for further instructions.
DOKuStar Capture Suite Administrator's Guide Installing • 3

• If you want to use another SQL Server edition, exit the DOKuStar Capture Suite Setup, install the SQL Server
and create the DOKUSTAR instance manually. See Creating a DOKUSTAR Instance Manually for further
information.
If a SQL Server is already installed on the local machine:
• If the installed SQL Server version is Microsoft SQL Server Express Edition (2005 Service Pack 2, language
English), click Install Microsoft SQL Server. The setup will create the DOKUSTAR instance in the
installed SQL Server Express Edition automatically. See below for further instructions.
• If the installed SQL Server version is another language edition of Microsoft SQL Server Express, click
Install Microsoft SQL Server. In the Microsoft SQL Server Setup (see below) click Change
and select the respective setup.exe. The setup will create the DOKUSTAR instance in the installed
SQL Server Express Edition automatically. See below for further instructions.
• If another SQL Server edition is already installed, exit the DOKuStar Capture Suite Setup and create the
DOKUSTAR instance manually. See Creating a DOKUSTAR Instance Manually for further information.
The following instruction describes the steps for creating a local DOKUSTAR instance in a local SQL Server Express
edition (English or other language) that should be installed or that is already installed on the current machine.
Note: The SQL Server needs the .NET Framework 2.0. If it is not present on the system, you can install the .NET
Framework manually or you can perform the first steps of the DOKuStar Capture Suite installation (start the DOKuStar
Capture Suite installation and terminate it, after the .NET Framework has been installed). Then install the SQL Server,
and start the DOKuStar Capture Suite installation again.
In the DOKuStar Capture Suite Setup window click Install Microsoft SQL Server. The Microsoft SQL
Server Setup dialog is shown:
As already mentioned, the SQL Server 2005 Express Edition (English) will be used as default. If you want to install
another language edition of the Microsoft SQL Server Express Edition or if another language edition of the Microsoft
SQL Server Express Edition is already installed, click Change, select the setup program of your SQL installation in the
appearing folder dialog and confirm with Open. Then confirm with Next and follow the instructions of the SQL
Server installation.
After the Microsoft SQL Server has been installed successfully, click Install DOKuStar Capture Suite in the
DOKuStar Capture Suite Setup window.
As a first step, some Microsoft software components will be installed, if necessary. At first the .NET Framework 2.0 and
3.0 will be installed, if necessary. Afterwards the following dialog may appear:
4 • Installing DOKuStar Capture Suite Administrator's Guide

Click Install. When the Microsoft components have been installed, installation of the product starts with a Welcome
page:
When you click on Next, the license agreement is shown:
To be able to proceed with the installation, accept the license agreement by selecting the respective option and click on
Next. The Custom Setup dialog appears:

On this dialog, you specify the components that should be installed. As default, all components are selected so that a full
installation will be performed if you don’t change the settings.
This dialog is also used to specify the root folder, where all components will be installed. The default is the Program
Files folder on the system drive. To change the installation folder, click on Change and select another folder in the
appearing Folder dialog.
When you have specified the components that should be installed, confirm with Next. The Service Account page is
shown:
DOKuStar Capture Suite installs several Windows services. Most of the services will run using the LocalSystem
account, but some services needs to run using a domain user account with local administrator rights. Specify a domain
user with local administrator rights. Enter the domain and user name, and the corresponding password.
Confirm with Next. The setup is now ready to install the software:

When you click Install, installation will start. Setup will install all necessary components one after the other. This will
take some minutes. During installation different dialog windows with progress indicators for the various components
will appear. When the software has been installed completely, the following page will be shown:
Confirm with Finish.
Basic Configurations for a Full Installation

Installing the License Files
DOKuStar Capture Suite is protected by a dongle and license files. The License Manager that is always installed together
with DOKuStar Capture Suite controls licensing. To be able to work with DOKuStar Capture Suite, you have to install
the license files and to plug in the dongle.
Together with the DVD containing the software, you will have received a CD containing the license files for DOKuStar
Extraction and DOKuStar Validation.
Insert the CD containing the license files, and under Tools in the DOKuStar Capture Suite program group of the
Windows start menu select Install License File. A file dialog opens. Go to the CD, select the file
DOKuStar.xml and click Open. Again use Install License File, and this time select the file
DOKuStarValidation.xml.

Checking the Services
After installation, you should check the Windows services created during installation.
Go to the Control Panel, start the Administrative Tools, and double-click on Services. In the services list,
check the following services:
DOKuStar Flow,
DOKuStar CleanUp,
DOKuStar Professional Link,
DOKuStar Scheduler,
DOKuStar Load Manager 3.0,
DOKuStar HotSpot 3.0,
DOKuStar Reporting 3.0,
DOKuStar Tracing.
If you installed all features, all services should be installed and started (except the Reporting Service).
If a service, that should be started, doesn’t show Started as state, please check the event log. To open the event log,
double-click on Administrative Tools in the windows Control Panel. In the Adminitrative Tools window
double-click on Event Viewer and in the Event Viewer window select Application. In most cases the messages
will permit to detect what caused the problem.
Sometimes an invalid user account or password may have been used during installation. In this case use the
Administrative Tools window to open the services list, click on the respective service with the right mouse button
and choose Properties from the context menu. The Properties dialog of the service opens. Select the Log On tab
page, select the second option, enter a user account and password, and click Apply.
Installing Your DOKuStar Capture Suite Application

During installation an empty project with project file FlowConfig.dfp has been installed in the DOKuStar Capture
Suite configuration folder (<computer name>\DOKuStarDispatchData\config). This project file is
needed because DOKuStar Dispatch expects complete configuration data when it starts to work and would create an
error message if the configuration didn't comprise a flow project.
If you want to install your DOKuStar Capture Suite Application, you have to copy your DOKuStar Capture Suite project
file and your project folder to the DOKuStar Capture Suite configuration folder <computer
name>\DOKuStarDispatchData\config.
Then you have to activate your project. Start the DCS Administration. If you open the DCS Administration for the first
time, you will have to create a new system. Use the New command of the File menu to start the New System
wizard. On the Server dialog, select your computer from the drop-down menu of the Server field. On all other
dialogs you can accept the default settings. When you finish the wizard, a System view for your system will be shown.
Now click the Stop button in the All Services line of the Services shape to stop the services.
Start the DCS Designer and open your project file. Use the Activate command of the Project menu to activate your
application project. (If the Activate command is disabled, the project has already been activated.) Close the DCS
Designer. In the DCS Administration start all services.
Refer to the DOKuStar Capture Suite Developer's Guide, chapter Exporting or Importing a Flow for further information.

Installing the DOKuStar Capture Suite on a
Distributed System
Installation Overview
A DOKuStar Capture Suite Production system consists of:
• Flow Server,
• Extraction Cluster,
• Validation Client(s).
The Extraction Cluster performs character recognition and interpretation of documents. Subsequently the recognition
results are corrected at the Validation Clients. Finally the Extraction Cluster exports the recognition results. The Flow
Server controls the whole process.
Depending on the number of documents that have to be processed per time unit, the Extraction Cluster of DOKuStar
Capture Suite can consist of one or more computers and it can use more than one CPU on one or more computers. Load
balancing, included in DOKuStar Capture Suite, distributes the workload on the hardware of the Extraction Cluster
automatically. The number of Validation Clients also depends on the number of documents.
Installation of the DOKuStar Capture Suite on a distributed system consists of the following steps:
• Installation of the Flow Server
• Installation of the Extraction Cluster Node(s)
• Installation of the Validation Client(s)
• Basic Configurations

Note: If the Flow Server machine is a multi-processor machine and if the Flow Server machine has free capacities, you
can use the Flow Server machine as Flow Server and as Extraction Cluster Master (with or without further Extraction
Cluster Nodes). Simply install all components on the Flow Server machine and configure the Extraction Cluster Master
on the Flow Server machine. This installation strategy is also useful to install a test system on a single computer.
Note: A DOKuStar Capture Suite installation consisting of a Flow Server, an Extraction Cluster and several Validation
Clients is called standard configuration in the following chapters.
Installation of the Flow Server

At runtime the Flow Server will keep its flow data in a SQL Server database. Therefore the installation of DOKuStar
Capture Suite will create a flow database in a local SQL Server instance named DOKUSTAR. The existence of this
local SQL Server DOKUSTAR instance with sa user password #DOKuStar# is a precondition of the DOKuStar
Capture Suite Flow Server installation. You only can install DOKuStar Capture Suite Flow Server if the local
DOKUSTAR instance is available.
Note: The local DOKUSTAR instance is only required during installation. So, even if you want to use a SQL Server
on another machine, you have to provide a local DOKUSTAR instance for the installation of DOKuStar Capture Suite.
After the installation of DOKuStar Capture Suite you can change the configuration to use a SQL Server on another
machine. Refer to Using a SQL Server on another Machine for the Flow Database for further information.
Note: DOKuStar Capture Suite uses the sa user of the DOKUSTAR instance to create the flow database. At runtime,
the sa user is not used. It is recommended to remove the sa user or to change the password of the sa user after
installation.
There are several possibilities to create the required DOKUSTAR instance depending on the SQL Server edition that is
already installed or that should be installed on the local machine.

If there is no SQL Server already installed on the local machine:
• If you want to use the Microsoft SQL Server Express Edition (2005 Service Pack 2, language English), click
Install Microsoft SQL Server. The setup will install the Express Edition and create the DOKUSTAR
instance automatically. See below for further instructions.
• If you want to use another language edition of the Microsoft SQL Server Express Edition, click Install
Microsoft SQL Server. In the Microsoft SQL Server Setup (see below) click Change and
select the respective setup.exe. The setup will install the specified Express Edition and create the
DOKUSTAR instance automatically. See below for further instructions.
• If you want to use another SQL Server edition, exit the DOKuStar Capture Suite Setup, install the SQL Server
and create the DOKUSTAR instance manually. See Creating a DOKUSTAR Instance Manually for further
information.
If a SQL Server is already installed on the local machine:
• If the installed SQL Server version is Microsoft SQL Server Express Edition (2005 Service Pack 2, language
English), click Install Microsoft SQL Server. The setup will create the DOKUSTAR instance in the
installed SQL Server Express Edition automatically. See below for further instructions.
• If the installed SQL Server version is another language edition of Microsoft SQL Server Express, click
Install Microsoft SQL Server. In the Microsoft SQL Server Setup (see below) click Change
and select the respective setup.exe. The setup will create the DOKUSTAR instance in the installed
SQL Server Express Edition automatically. See below for further instructions.
• If another SQL Server edition is already installed, exit the DOKuStar Capture Suite Setup and create the
DOKUSTAR instance manually. See Creating a DOKUSTAR Instance Manually for further information.
The following instruction describes the steps for creating a local DOKUSTAR instance in a local SQL Server Express
edition (English or other language) that should be installed or that is already installed on the current machine.
Note: The SQL Server needs the .NET Framework 2.0. If it is not present on the system, you can install the .NET
Framework manually or you can perform the first steps of the DOKuStar Capture Suite installation (start the DOKuStar
Capture Suite installation and terminate it, after the .NET Framework has been installed). Then install the SQL Server,
and start the DOKuStar Capture Suite installation again.
In the DOKuStar Capture Suite Setup window click Install Microsoft SQL Server. The Microsoft SQL
Server Setup dialog is shown:
As already mentioned, the SQL Server 2005 Express Edition (English) will be used as default. If you want to install
another language edition of the Microsoft SQL Server Express Edition or if another language edition of the Microsoft
SQL Server Express Edition is already installed, click Change, select the setup program of your SQL installation in the
appearing folder dialog and confirm with Open. Then confirm with Next and follow the instructions of the SQL
Server installation.

After the Microsoft SQL Server has been installed successfully, click Install DOKuStar Capture Suite in the
DOKuStar Capture Suite Setup window.
Click Install. When the Microsoft components have been installed, installation of the product starts with a Welcome
page:
When you click Next, the license agreement is shown:

To be able to proceed with the installation, accept the license agreement by selecting the respective option and click
Next. The Custom Setup page appears:
On this page, you specify the features of DOKuStar Capture Suite that should be installed. As default, all features are
selected so that a full installation will be performed if you don’t change the settings. A full installation will only be done
on a developer system or on a testing system.
The installation of the Workflow Server feature on the Flow Server is a must. All other features are optional. In this
document a standard installation of the Flow Server is proposed, but you can choose another constellation more suitable
for your project and situation.
Note: The following chapters assume that the Flow Server has been installed like proposed in this chapter.
In standard configuration, the Flow Server will act as License Manager and Reporting Server; the Administrator tool will
be used on the Flow Server. Therefore the Reporting and Statistics feature, the License Manager feature and
the Administrator feature have to be installed on the Flow Server.
The standard configuration assumes that you may want to use DOKuStar Capture Suite development tools on the Flow
Server to do basic configurations, even if the development of your flow project may already have been finished.
Therefore you have to install the Designer feature. If Designer stays selected, DOKuStar Professional
Server, DOKuStar Validation Client, Administrator, and License Manager will also be needed and
must not be deselected due to dependencies between the features.
So, in the standard configuration almost all features will be installed on the Flow Server:
Deselect the sub-feature Adapter of the DOKuStar Professional Server feature. The following features are
selected and will be installed on the Flow Server:
• Workflow Server
• Designer
• Administrator
• DOKuStar Professional Server
• Reporting and Statistics
• License Manager
Note: If you want to use the Flow Server as Extraction Cluster Master, do not deselect the sub-feature Adapter of the
DOKuStar Professional Server feature. Then, the Flow Server will also act as Extraction Cluster Master.

This page is also used to specify the root folder, where all components will be installed. The default is the Program
Files folder on the system drive. To change the installation folder, click Change and select another folder in the
When you have specified the components that should be installed, confirm with Next. The Service Account page is
shown:
account, but some services need to run using a domain user account with local administrator rights. Specify a domain
Refer to Best Practice for Users and Groups for further information.

Confirm with Finish. The installation of the Flow Server is now complete.
Installation of an Extraction Cluster Node

In the DOKuStar Capture Suite Setup window click Install DOKuStar Capture Suite.

Click Install. When the Microsoft components have been installed, installation of the DOKuStar Capture Suite starts
with a Welcome page:

selected so that a full installation will be performed if you don’t change the settings.
Deselect the features Workflow Server, Designer, Administrator, and DOKuStar Validation Client.
In an Extraction Cluster with several computers one computer will act as master. Only on this computer the sub-feature
Adapter of the DOKuStar Professional Server feature should be installed. So if the Extraction Cluster Node
that is currently being installed should act as master, leave the sub-feature Adapter of the DOKuStar
Professional Server feature selected, otherwise deselect the Adapter feature.
The following features are selected and will be installed on the Extraction Cluster Node:
• DOKuStar Professional Server
o (Adapter only on the Extraction Cluster Master)
• License Manager
When you have specified the components that should be installed, confirm with Next. The Flow Server page is
shown:

Enter the computer name of the Flow Server and confirm with Next. The Service Account page is shown:

Confirm with Finish. The installation of the Extraction Cluster Node is now complete.

Installation of a Validation Client
In the DOKuStar Capture Suite Setup window click Install DOKuStar Capture Suite.
Click Install. When the Microsoft components have been installed, installation of the DOKuStar Capture Suite starts
with a Welcome page:


selected so that a full installation will be performed if you don’t change the settings.
Deselect the features Workflow Server, Designer, Administrator, and DOKuStar Professional Server.
The following features are selected and will be installed on the Validation Client:
• DOKuStar Validation Client
• License Manager
When you have specified the components that should be installed, confirm with Next. The Flow Server page is
shown:
Enter the computer name of the Flow Server and confirm with Next. The Service Account page is shown:

Confirm with Finish.

Setup has installed the Importer program on the Validation Client. The Importer program is a tool for testing and analysis
purposes only. It should not be available for end users. Therefore, remove the Importer Link in Documents and
Settings\All Users\Start Menu\Programs\DOKuStar Capture Suite 3.0.
The installation of the Validation Client is now complete.

Basic Configurations for a Distributed System
Installing the License Files and Configuring the License Server
DOKuStar Capture Suite is protected by a dongle and license files. The License Manager that is always installed together
with DOKuStar Capture Suite controls licensing. To be able to work with DOKuStar Capture Suite, you have to install
the license files on a computer that will act as license server. On this computer, the dongle must be plugged in. On all
other machines of the system, you have to tell the License Manager which computer acts as License Server.
Together with the DVD containing the software, you will have received a CD containing the license files for DOKuStar
Extraction and DOKuStar Validation.
Typically you will use the Flow Server as License Server. Therefore, on the Flow Server insert the CD containing the
license files, and under Tools in the DOKuStar Capture Suite program group of the Windows start menu select
Install License File. A file dialog opens. Go to the CD, select the file DOKuStar.xml and click Open. Again
use Install License File, and this time select the file DOKuStar-Validation.xml.
On all computers except the License Server, you have to tell the License Manager the location of the License Server.
Therefore on these computers, under Tools in the DOKuStar Capture Suite program group of the Windows
start menu select Set License Manager Location. On the Set License Manager Location dialog mark
the option Remote Server, enter the computer name of the License Server, and confirm with OK.
Checking the Services

After installation, you should check the Windows services created during installation on the Flow Server, on the
Extraction Cluster Nodes, and on the Validation Clients.
Go to the Control Panel, start the Administrative Tools, and double-click on Services. In the services list,
check the following services:
Service Flow Server Extraction Cluster Extraction Cluster Validation Client

Master Slave
DOKuStar Flow Started, automatic -- -- --
DOKuStar CleanUp Started, automatic Not started, manual Not started, manual Not started, manual
DOKuStar Scheduler Started, automatic Not started, manual Not started, manual Not started, manual
DOKuStar Professional Link -- Started, automatic -- --
DOKuStar Load Manger 3.0 Started, automatic, not Started, automatic Started, automatic --
used, can be stopped
DOKuStar HotSpot 3.0 Started, automatic Started, automatic Started, automatic --
DOKuStar Reporting 3.0 Not started, manual Not started, manual Not started, manual Not started, manual
DOKuStar Tracing Started, automatic Started, automatic Started, automatic Started, automatic
If a service, that should be started, doesn’t show Started as state, please check the event log. To open the event log,
double-click on Adminitrative Tools in the windows Control Panel . In the Adminitrative Tools window
double-click on Event Viewer and in the Event Viewer window select Application. In most cases the messages
will permit to detect what caused the problem.

Sometimes an invalid user account or password may have been used during installation. In this case use the
Administrative Tools window to open the services list, click on the respective service with the right mouse button
and choose Properties from the context menu. The Properties dialog of the service opens. Select the Log On tab
page, select the second option, enter a user account and password, and click Apply.
Configuring the Extraction Cluster

Depending on the number of documents that have to be processed per time unit, you will have installed one Extraction
Cluster Node or several Extraction Cluster Nodes. On one Extraction Cluster Node you will have installed the DOKuStar
Capture Suite sub-feature Adapter of the DOKuStar Professional Server feature. This Extraction Cluster Node
is the Extraction Cluster Master.
Note: If you have installed the sub-feature Adapter of the DOKuStar Professional Server feature on the Flow
Server machine, the Flow Server machine will also act as Extraction Cluster Master. In this case you have to configure
the Extraction Cluster on the Flow Server machine.
On the Extraction Cluster Master, select Load Manager Monitor in the DOKuStar Capture Suite program
group of the Windows start menu. Load Manager Monitor is opened.
On the Tools menu, click Cluster Configuration to open the Configuration dialog.
Add a computer node for the Extraction Cluster Master. Add a Runtime Node to the Extraction Cluster Master computer
Node. If the Extraction Cluster Master machine is a multi-processor machine, add further Runtime Nodes until there is
one Runtime Node for each processor of the Extraction Cluster Master machine.
Note: If you have installed the Flow Server and the Extraction Cluster Master on the same machine, add one Runtime
Node less. One processor should be free for the work of the Flow Server.
Then add a computer node for each Extraction Cluster Slave. For each Extraction Cluster Slave computer node, add a
Runtime Node. If the Extraction Cluster Slave machine is a multi-processor machine, add further Runtime Nodes until
there is one Runtime Node for each processor of the Extraction Cluster Slave machine.
As a result, each Extraction Cluster computer node has as many Runtime Nodes as own processors.
On the Flow Server open the DOKuStar Capture Suite Designer and open your DOKuStar Capture Suite project file in
the folder \\<Flow Server name>\DOKuStarDispatchData\config. Select the job step
Extraction and set the property MaxDlmLoadingCount to <Number of all Runtime Nodes of the
Extraction Cluster> + 1.
Select the job step Export and set the property MaxDlmLoadingCount to (<Number of all Runtime
Nodes of the Extraction Cluster> + 1) / (average duration of the Extraction job
step in seconds / average duration of the Export job step in seconds).
On the Extraction Cluster Master restart the DOKuStar Professional Link Service.
For further information refer to Load Manager.
Configuring Reporting
To be able to use Reporting, you have to configure a Reporting Server using the Create Reporting Database
Wizard. The wizard will start the Reporting service, create a reporting database, and configure the service to use the
new database.
To activate Reporting in DOKuStar Professional, a Reporting module has to be added to the pipelines of the
DOKuStar Professional project. To activate Reporting for Validation, you have to modify the Validation configuration
file.

Removing the sa User or Changing the Password
During installation of the Flow Server, the setup has created a database. The flow database is created in the local
DOKUSTAR instance on the Flow Server using the sa user with the password #DOKuStar#. DOKuStar Capture
Suite only uses the sa user during installation; it won't need the sa user at runtime.
For security reasons, it is recommended to remove the sa user from the SQL Server instance(s) or to change the
password of the sa user(s) after installation.
See Removing the sa User after Installation.
Note: When you will re-install or upgrade the Flow Server in the future, you will have to temporarily provide the sa user
with the password #DOKuStar#.
Configuring Users and Rights

Refer to Best Practice for Users and Groups for configuring users and rights.
Installing Your DOKuStar Capture Suite Application

During installation an empty project with project file FlowConfig.dfp has been installed on the Flow Server in the
DOKuStar Capture Suite configuration folder (<Flow Server name>\DOKuStarDispatchData\
config) . This project file is needed because DOKuStar Dispatch expects complete configuration data when it starts to
work and would create an error message if the configuration didn't comprise a flow project.
If you want to install your DOKuStar Capture Suite Application on a production system, you have to copy your
DOKuStar Capture Suite project file and your project folder to the DOKuStar Capture Suite configuration folder
<Flow Server name>\DOKuStarDispatchData\config.
Then you have to activate your project. Start the DCS Administration on the Flow Server. If you open the DCS
Administration for the first time, you will have to create a new system. Use the New command of the File menu to start
the New System wizard. On the Server dialog, select your computer from the drop-down menu of the Server
field. On the Services page of the wizard, take care to specify the correct name of the system each service is running on.
When you finish the wizard, a System view for your system will be shown. Now click the Stop button in the All
Services line of the Services shape to stop the services.
On the Flow Server, start the DCS Designer and open your project file. Use the Activate command of the Project
menu to activate your application project. (If the Activate command is disabled, the project has already been
activated.) Close the DCS Designer.
In the DCS Administration start all services.
Refer to the DOKuStar Capture Suite Developer's Guide, chapter Exporting or Importing a Flow Application for further
information.

Upgrading from Version 2.0
Some features have changed incompatibly compared to DOKuStar Capture Suite 2.0 and require a migration during
upgrade. The following describes known topics. For some of them, migration is done automatically during installation
while others require some kind of action.
• This version is not compatible with previous versions (3.8 and earlier) of DOKuStar Extraction and DOKuStar
Validation. Before installing DOKuStar Capture Suite 3.0, remove these products if they are present.
Sometimes common files of these products are not removed correctly. Therefore remove the subfolder
ODT-OCE\DOKuStar of the common files folder and the respective path from the system path, if still
present.
• The file ClientConfig.dfp that is used by the client computers to find the configuration data on the
flow server has been moved from the folder ODT-OCE to Captaris in the application data folder. An
existing file will be copied to the new folder automatically during installation
• The shared folder DOKuStarDispatchData that is used for the configuration data and the repositories
has been moved from the folder ODT-OCE used in version 2.0 to Captaris in the application data folder.
If you only need the configuration data, you can just copy them to the new folder. If the repository still
contains unfinished jobs, you could set the shared folder to its previous path to be able to continue work with
the existing data.
• Namespaces occurring in configuration files have been modified. The respective files will be updated
automatically during installation.
• The SQL password of the flow users (dfadmin, dfreader, dfworker) has been changed. For an
existing flow database, the password will be modified automatically during installation.
• The SQL sa password of the DOKUSTAR instance has been changed. If an instance is found during
installation, the older password will be used.
• Job ticket configuration is now stored in the project file and no longer in a separate file. For migration, open
the project in the DCS Designer and save it. The name of the old job ticket file will be extended with the
extension .bak. This file is no longer needed and can be removed.
• Naming and Location of the job class assemblies has changed from config\<project>\<jobclass>.dll
to config\bin\<project>.<jobclass>.dll. In addition, the namespace has changed from the job class
name to the project name. Migration will be done when you open and save the project in the DCS Designer.
For sources files that could have been modified by the application developer, a warning will appear.
• The schema of the flow database has changed. An existing database and its contents will be upgraded
automatically during installation.
• Application-specific custom clients have to be recompiled with version 3.0.
• DOKuStar Professional project modules have to be recompiled with version 3.0.

Documentation
The following sections describe the available documentation. The manuals you will find in the Manuals subfolder of
the installation folder.

• DOKuStar Capture Suite – Getting Started (DCS_30_GettingStarted_en.pdf): This
gives an overview of application development with the DOKuStar Capture Suite on a single page.
• DOKuStar Capture Suite – Administrator’s Guide
(DCS_30_AdministratorsGuide_en.pdf): This manual. It describes installation, configuration,
and administration of the DOKuStar Capture Suite.
• DOKuStar Capture Suite – User Manual (DCS_30_UserManual_en.pdf): This manual
describes the standard importer program and the Validation interface.
• DOKuStar Capture Suite – Developer's Guide (DCS_30_DevelopersGuide_en.pdf):
This manual describes the Flow Designer that is used to create and configure the DOKuStar Capture Suite
applications.
DOKuStar Professional
• DOKuStar Professional – Developer’s Guide (DSP_30_DevelopersGuide_en.pdf):
This manual describes how to create and test a DOKuStar Professional project.
• DOKuStar Professional – ART Training (DSP_30_ARTTraining_en.pdf): This manual
describes how to train new documents using the ART Training Client of DOKuStar Professional. If you
don’t use DOKuStar ART, you will not need to read it. This manual is also available in German language
(DSP_30_ARTTraining_de.pdf).
• DOKuStar Professional – ACT Training (DSP_30_ACTTraining_en.pdf): This manual
describes how to train new documents using the ACT Training Client of DOKuStar Professional. If you
don’t use DOKuStar ACT, you will not need to read it. This manual is also available in German language
(DSP_30_ACTTraining_de.pdf).
An additional help file describes the DOKuStar Professional programming interfaces (DSP_API_en.chm).
28 • Documentation DOKuStar Capture Suite Administrator's Guide

DOKuStar Validation
The DOKuStar Validation manuals you will find in the Manuals folder of the DOKuStar Validation installation path.
• DOKuStar Validation – Administrator’s Guide
(DSV_40_AdministratorsGuide_en.pdf): This manual describes, amongst others, installation and
licensing. You won't need this manual normally. It is also available in German language
(DSV_40_Administratorhandbuch_de.pdf).
• DOKuStar Validation – User Manual (DSV_40_UserManual_en.pdf): This manual describes
the user interface of the product version of DOKuStar Validation. There you will find a detailed description
of Single Click Entry (data capturing using the mouse).
DOKuStar Validation – Benutzerhandbuch (DSV_40_Benutzerhandbuch_de.pdf):

German language version of the User Manual.
This document is also available as online help within DOKuStar Validation.

• DOKuStar Validation – Programming Manual (DSV_40_ProgrammingManual_en.pdf):
This manual describes the programming interface of DOKuStar Validation that permits to modify user
interface and behavior of DOKuStar Validation. You won’t need this manual normally.
An additional help file describes the DOKuStar Validation Data Object Models. You will not need this help file
normally.
The setup installs DOKuStar Validation WV without VBA (Visual Basic for Applications). Sections in the Programming
Manual of DOKuStar Validation that refer to VBA and the VBA Editor do not apply to this version. The Examples
subfolder of the DOKuStar Capture Suite installation path contains an example that demonstrates programming
DOKuStar Validation using a library. Events can be used in the same way as described in the Programming Manual and
the VBA programming examples in the DOKuStar Validation examples folder will also be useful if you want to
program DOKuStar Validation.
DOKuStar Capture Suite Administrator's Guide Documentation • 29

DOKuStar Extraction
• DOKuStar Extraction –Developer’s Guide (DSE_41_DevelopersGuide_en.pdf): This
manual describes DOKuStar Extraction and how to create, test, and maintain a DOKuStar Extraction
project. It is also available in German language (DSE_41_Entwicklerhandbuch_de.pdf).
This document is also available as online help in the DOKuStar Design Studio.
• DOKuStar Extraction – Programming Manual (DSE_41_ProgrammingManual_en.pdf):
This manual describes the programming interfaces and project and result file formats of DOKuStar
Extraction. You will not need this document.
• DOKuStar Extraction – Tutorial (DSE_41_Tutorial_en.pdf): This manual describes the
examples installed with DOKuStar Extraction and contains a tutorial for the DOKuStar Design Studio.
This document is also available as online help in the DOKuStar Design Studio.
An additional help file (DOKuStar.Extraction.Result.chm) describes a programming interface for access to
the DOKuStar Extraction result files.
30 • Documentation DOKuStar Capture Suite Administrator's Guide

Configurations
Components of the Standard Configuration

Overview
After performing the installation steps described in chapter Installing, your DCS project configuration consists of a Flow
Server, an Extraction Cluster with one Extraction Cluster Master and optionally several simple Extraction Cluster Nodes
(Extraction Cluster Slaves), and one or many Validation Clients. On each machine participating in a DCS system you
have installed a different selection of DOKuStar Capture Suite components and you have performed some configuration.
As a result, the participants differ in terms of configuration files, databases, repositories, available administration tools,
and running Windows services. As the Flow Server plays the central part in the DCS system, most components are
located on the Flow Server.
The following sections describe which components are located on which participants and how the different participants
interact with respect to the components.
Configuration Data
Config Folder, ServerConfig.dfc, and ClientConfig.dfc
During installation of the Flow Server a shared folder named DOKuStarDispatchData is created on the Flow
Server. This shared folder is located in Documents and Settings\All Users\Application
Data\Captaris\DOKuStar Dispatch\data on the Flow Server. The sub folder config of
DOKuStarDispatchData is the most important configuration folder of a DCS system. It contains the Flow Server
configuration file ServerConfig.dfc, the project file <name of DCS project>.dfp and the project
folder <name of DCS project>.
The ServerConfig.dfc file specifies the name of the Flow Server machine, the name and the location of the
default repository (see Runtime Files), and the name of the active DOKuStar Capture Suite project.
At runtime the Validation Clients and the Extraction Cluster Nodes access the config folder to get their configuration
data. Therefore the config folder with all sub folders must be readable for the Windows users working at the
Validation Clients and for the account(s) of the Extraction Cluster Nodes (strictly speaking for the account(s) of the Load
Manager Services running on the Extraction Cluster Nodes, see Services).
In order to be able to change some configuration settings the administrator of your DCS system must have write
permissions on the config folder.
DOKuStar Capture Suite Administrator's Guide Configurations • 31

Each participant of a DCS system, even the Flow Server itself, has a file named ClientConfig.dfc located in its
local folder Documents and Settings\All Users\Application
Data\Captaris\DOKuStar Dispatch. This file contains a tag named
DefaultServerConfigLocator telling the Validation Client or Extraction Cluster Node where to look for the
project configuration.
Note: The local folder Documents and Settings\All Users\Application

Data\Captaris\DOKuStar Dispatch on the Validation Clients and Extraction Cluster Nodes only serves
for providing the ClientConfig.dfc file and some dlls that are needed only locally.
Each local ClientConfig.dfc must be readable for the respective participant, e.g. the ClientConfig.dfc
on a Validation Client has to be readable for the Windows users working at the Validation Clients, the
ClientConfig.dfc on the Flow Server has to be readable for the account of the Flow Service running on the
Flow Server (see Services). The administrator must have write permissions on each ClientConfig.dfc file.
Note: The ServerConfig.dfc file is part of the central configuration (in the standard configuration on the Flow
Server). There is only one ServerConfig.dfc file in the whole DCS system.
The ClientConfig.dfc file is not part of the central configuration. The ClientConfig.dfc file is located
in the local folder Documents and Settings\All Users\Application
Data\Captaris\DOKuStar Dispatch on the Validation Client, Extraction Cluster Node or Flow Server.
There are as many ClientConfig.dfc files in the DCS system as participating machines.
It is possible to use another location for the central configuration. See Using another Configuration Location for further
information.
32 • Configurations DOKuStar Capture Suite Administrator's Guide

Flow Server Configuration File
In the standard configuration the Flow Server keeps its flow data in a database of a local SQL Server instance named
DOKUSTAR. The Flow Server machine is also the SQL Server machine. If you want to use a SQL Server on another
machine, you have to provide a file named FlowService.dcf in the folder Documents and
Settings\All Users\Application Data\Captaris\DOKuStar Dispatch on the Flow
Server machine.
The FlowService.dcf file specifies connection tags that tell the Flow Server how to access the flow database.
The connection tags define the database name, the name of the SQL Server instance hosting the database, and access
information.
The FlowService.dcf file must be readable for the account of the Flow Service running on the Flow Server (see
Services). The administrator must have write permissions.
FlowService.dcf:
<?xml version="1.0" encoding="utf-8"?>
<BUSYInfoServices xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" Subject="Service and Database Setup">
<CoreInfoServices>
<Accessor Name="Default">
<Any>
<Server>SYS9999\DOKUSTAR</Server>
<SID>DBFLOW</SID>
<IntegratedSecurity>true</IntegratedSecurity>
</Any>
</Accessor>
</CoreInfoServices>
</BUSYInfoServices>
Refer to Databases and Using a SQL Server on another Machine for the Flow Database for further information.
License Files
In the standard configuration the Flow Server is also the License Server. The license files are located in the folder
Documents and Settings\All Users\Application Data\Captaris\DOKuStar
License Manager on the License Server.
The License Server must have read permission on the License files. The License Server is a DCOM server running with
the LocalSystem service account.
If you want to use another machine as License Server refer to Licensing of DOKuStar Products for further information.

Load Manager Files
As already mentioned, a DCS project Extraction Cluster contains one Extraction Cluster Master. The Extraction Cluster
Master distributes the workload on the hardware of the Extraction Cluster. The Cluster has to be configured on the
Master with the Load Manager tool (see Load Manager). The Load Manager tool saves the cluster configuration files
into the folder Documents and Settings\All Users\Application
Data\Captaris\DOKuStar Load Manager on the Extraction Cluster Master.
The Extraction Cluster Master, strictly speaking the account of the Load Manager Service running on the Extraction
Cluster Master (see Services), must have read and write permissions on the files in this directory. The administrator of
your DCS system should also have read and write permissions.
Cleanup Service Configuration File

In the standard configuration, a Windows service named Cleanup Service is running on the Flow Server (see Services).
The Cleanup Service can be parameterized with the Cleanup Dialog (see CleanUp Dialog). The Cleanup Dialog saves
the parameter data into the file DOKuStarControlledService.exe.cfg in the installation folder on the
machine providing the Cleanup Service.
The DOKuStarControlledService.exe.cfg file must be readable for the account of the Cleanup Service.
The administrator must have write permissions.
Trace Configuration Files

Each participant of a DCS system writes trace files to its local trace folder Documents and Settings\All
Users\Application Data\Open Text\Trace. In the trace folder there are several trace configuration
files specifying e.g. the trace level of the trace messages. See Tracing for further information.
Hot Spot Files

If Hot Spots are used, the configuration and data files are stored in subfolders under Documents and
Settings\All Users\Application Data\Captaris\DOKuStar
Professional\3.0\HotFolders. All these files are created and administered by the Hot Spot configuration
dialog and the Hot Spot service on the local machine and they need write access to that folder.
Reporting Files
If Reporting is used, the configuration and data files are stored in subfolders under Documents and
Settings\All Users\Application Data\Captaris\DOKuStar Professional\3.0\Reporting.
DOKuStar Professional and DOKuStar Validation will store reporting data in a Cache subfolder as long as they can’t
establish a connection to the Reporting service. As soon as a connection can be established, the stored data will be
transmitted and deleted.
Administrator Settings
When the administrator works with the Administrator tool, administrator specific settings are saved in the folder
Documents and Settings\<administrator user>\Application Data\Captaris
Document Technologies GmbH\DOKuStar Professional.
Runtime Files
Repository
As already mentioned, during installation of the Flow Server a shared folder named DOKuStarDispatchData is
created on the Flow Server. This shared folder is located in Documents and Settings\All
Users\Application Data\Captaris\DOKuStar Dispatch\data on the Flow Server. The sub

folder Repositories of DOKuStarDispatchData is the default location of the repository of the DCS system.
The repository serves for temporarily keeping the imported image files and the results of the Extraction Cluster Nodes
and Validation Clients.
At runtime, the Validation Clients and the Extraction Cluster Nodes access the Repositories folder to get the
image files and the results of the previous processing steps and to save their own results. Therefore the
Repositories folder must be writeable for the Windows users working at the Validation Clients and for the
account(s) of the Extraction Cluster Nodes (strictly speaking for the account(s) of the Load Manager Services running on
the Extraction Cluster Nodes, see Services).
In order to be able to control job processing, the administrator of your DCS system must have write permissions on the
Repositories folder.
A Windows service called Cleanup Service (see Services) removes files in the repository that are no longer needed. The
account of the Cleanup Service also must have write permissions on the Repositories folder.
The use of the Repositories folder of the Flow Server is not a must. The program importing the image files into
the DCS system can specify another repositories folder. See Using another Repository Location for further information.
Import Folders
The import of the image files into the DCS system can be done by different means, e.g. by a project specific importer
program or by DOKuStar Professional Hot Spot.
The import folder locations can be set in the configuration of the importing program.
Temporary Files of DOKuStar Professional and DOKuStar Extraction

On the Extraction Cluster Nodes the actual extraction is done by a program named DOKuStar Extraction. Superordinated
tasks, like splitting of pages or export of results is done by a program named DOKuStar Professional. Both programs
write temporary files into the Windows temp directory.
If the Load Manager Service of an Extraction Cluster Node (see Services) is running using the LocalSystem account,
the temporary files are written in the temp directory defined in the system temp variable.
If the Load Manager Service is running using a domain account, the temporary files are written into the temp directory
defined in the user temp variable.
Trace folder
Users\Application Data\Open Text\Trace. Each participant must have write permissions on its local
Trace folder.
The location of the Trace folder can be changed by creating a registry entry. See Changing the Trace Folder for further
information.
For further information about trace files and the Trace Viewer tool refer to Tracing.

Databases
SQL Server Instance DOKUSTAR
DOKUSTAR. The Flow Server machine is also the SQL Server machine. The DOKUSTAR instance is
automatically created during installation. It uses the mixed mode authentification.
See Creating a DOKUSTAR Instance Manually.
Flow Database
DOKUSTAR. The Flow Server machine is also the SQL Server machine.
The name of the flow database is DBFLOW. The according DBFLOW.MDF file is located in the folder
Programs\Captaris\databases\MSSQL.<Version>\MSSQL\Data. During installation the
DBFLOW database and a user named dfadmin is automatically created. The user dfadmin is the owner of the
DBFLOW database.
In the standard configuration the Flow Server accesses the flow database using the dfadmin user.
If you want to change the standard configuration, e.g. if you want to use a SQL Server on another machine than the Flow
Server machine, or if you want to access the flow database using Windows security, you have to provide a
FlowService.dcf file for the Flow Server. See Configuration Data and Using a SQL Server on another Machine
for the Flow Database.
If you use Windows security to access the flow database, the Flow Server (strictly speaking the account of the Flow
Service running on the Flow Server, see Services) must have full access on the flow database. The administrator has also
full access on the flow database.
Note: The flow database does not contain intermediate or final extraction results. It only contains data about the flow of
document processing.
ART and ACT Databases

If your DCS project includes ART and / or ACT modules, there will be an ART and / or an ACT database. In the
standard configuration, you will create ART or ACT databases in the SQL Server instance named DOKUSTAR on the
Flow Server.
The according MDF files will be located in the folder Programs\Captaris\databases\
MSSQL.<Version>\MSSQL\Data on the Flow Server.
You can move the ART database or the ACT database to another SQL Server instance later. See Using a SQL Server on
another Machine for the ART Database and Using a SQL Server on another Machine for the ACT Database for further
information.
If you use Windows security to access the ART / ACT databases, the Extraction Cluster Nodes (strictly speaking for the
account(s) of the Load Manager Services running on the Extraction Cluster Nodes, see Services) must have read access
on the databases. The administrator and the user performing the ART / ACT training must have full access on the ART /
ACT databases.

Reporting Database
If you use Reporting, data for reports will be collected in a database. To initialize Reporting and to create the database,
you will have to run the Create Reporting Database Wizard. In a standard configuration, you will create the
Reporting database in the DOKUSTAR instance of the SQL Server on the Flow Server. But the wizard permits to
select another SQL server or instance.
Services
The runtime environment of DOKuStar Capture Suite consists of several programs and Windows services. In the
standard configuration the following Capture Suite Windows services are installed on the Flow Server and on the
Extraction Cluster Nodes:
§ Flow Server
o Flow Service (DOKuStar Flow)
o Scheduler Service (DOKuStar Scheduler)
o Cleanup Service (DOKuStar CleanUp)
o Tracing Service (DOKuStar Tracing)
o Reporting Service (DOKuStar Reporting 3.0)
o Hot Spot Service (DOKuStar HotSpot 3.0)
§ Extraction Cluster Master Node
o DOKuStar Professional Link Service (DOKuStar Professional Link)
o Load Manager Service (DOKuStar Load Manager 3.0)
§ Extraction Cluster Node
o Load Manager Service (DOKuStar Load Manager 3.0)
Note: For installation reasons, the Load Manager Service also runs on the Flow Server, but is not used and can be
stopped. A service named Hot Spot Service runs on the Flow Server and on the Extraction Cluster Nodes. You can stop
this service on all machines where the Hot Spot feature is not used for import.
The Flow Service is the heart of the Flow Server. It controls the processing of the document images. The processing of a
document or a set of documents is called a job. The Flow Service keeps the flow data of the jobs in the flow database
(see Databases). Each job runs through several job steps. The Scheduler Service is responsible for determining the next
job step for a job. The Cleanup Service deletes finished jobs with all their data in the repository after a specified time
span and performs some other housekeeping and timeout watching.

To increase throughput on the Flow Server the Scheduler Service can be moved to other machines. See Running the
Scheduler Service on another Machine and Running an Additional Scheduler Service on another Machine for further
information.
The DOKuStar Professional Link Service is the connection between the Flow Service and the Extraction Cluster. It
provides the Extraction Cluster with processing jobs. The Load Manager Service on the Extraction Master distributes the
workload on the Extraction Nodes by communicating with the Load Manager Services on the Extraction Cluster Nodes.
If you want to use Reporting, you run the Create Reporting Database wizard on the machine that should act as
reporting server. The wizard creates a reporting database in a specified SQL server and initializes the Reporting service
to write all reporting data to this database. On all other machines, the Reporting service can be stopped.
If Hot Spots are used for data import, it will typically run on the Extraction Cluster Master because it needs DOKuStar
Professional. You can either use the Hot Spot Tray program, or work with the Hot Spot service. In production, you
normally will use the service. In this case you configure the Hot Spots using the DOKuStar Input HotSpot
Configuration program; the service will then poll the configured Hot Spots automatically. On all other computers,
the Hot Spot service can be stopped.

Increasing Throughput
Overview
The architecture of DOKuStar Capture Suite has been designed to achieve maximum flexibility in order to support all
sizes of applications from a few thousand up to millions of documents per year. The architecture allows numerous
configurations – ranging from a single-station system for demonstration or testing purposes to cluster configurations of
different sizes where components of DOKuStar Capture Suite are distributed over several computers within a network.
For DCS systems with very high throughput, special configurations and additional measures permit to further increase
performance and achieve throughput values up to many million documents per year.
The suitable configuration for a DCS system depends on different factors:
• number of documents to be processed per hour,
• number of needed Validation stations,
• used hardware and system environment.
The following sections describe how to change the standard configuration to achieve a higher throughput.
Increasing the Number of Extraction Cluster Nodes

To increase the number of Extraction Cluster Nodes, install further Extraction Cluster Nodes as described in Installation
of an Extraction Cluster Node. Add the respective computers to the Extraction Cluster. See Adding a Further Extraction
Cluster Node for further information.
Using a Separate File Server

With increasing workload the file-IO on the Flow Server may become the bottleneck. In this case, a separate File Server
should be used for input data and the repository. See Using another Repository Location for further information.
It is also recommended to run the importing program on the File Server or on another machine.
Replacing the SQL Server Express Edition

With increasing workload, access to the flow database may become the bottleneck. In this case you should replace the
SQL Server Express Edition with the SQL Server Enterprise Edition because it supports the use of two processor nodes.
Running the Scheduler Service (additionally) on another

Machine
On systems with very high throughput, CPU usage on the Flow Server may become critical. In this case, the Scheduler
Service should be started on another system. This could be a separate computer or the File Server, if CPU usage on this
computer is not too high.
See Running the Scheduler Service on another Machine for further information.

It is also possible to leave the Scheduler Service on the Flow Server and to run an additional Scheduler Service on
another machine. See Running an Additional Scheduler Service on another Machine for further information.
Using a Second Extraction Cluster

If CPU usage on the Extraction Cluster Nodes is always near 100%, and if there is an increasing queue for the Extraction
job step, you should install and configure a second Extraction Cluster.
Install a second Extraction Cluster Master and further Extraction Cluster Nodes as described in Adding a Further
Extraction Cluster. On the new Extraction Cluster Master start the Load Manager Cluster Configuration tool and add
Runtime Nodes for the new Extraction Cluster Nodes. Don't forget to update the MaxDImLoadingCount parameter
of the job steps Extraction and Export of your DOKuStar Capture Suite project.
Using a Second DCS System

For an extremely high workload, it is recommended to configure two separate DCS systems, even if the workload could
be processed on a single system with optimized configuration as shown in the previous section.
Working with two separate systems will also provide high availability.
A special configuration of the Validation Clients allows that the Validation Clients can work for several DCS systems. If
this special configuration is done, the user at the Validation Client can choose the DCS system, he wants to work with.
One DCS system is the default system. If the default system is broken, the users at the Validation Clients will work with
another system.
See Using a Validation Client for Several DCS systems.
Providing High Availability

Overview
This section describes two different high availability scenarios. The critical parts of a DCS system that should be high
available are:
• Flow Server
• Configuration folder
• Repository
• Flow Database
• Import folder and traces
• (Extraction Cluster)
The Extraction Cluster is not regarded as critical as the Flow Server. In case of failure it is very easy to setup one of the
Extraction Cluster Slaves as Master and to add further Extraction Cluster Nodes. No data will be lost.
If you want to improve the availability of the Extraction Cluster nevertheless, you can provide a second Extraction
Cluster (see Adding a Further Extraction Cluster). Both Extraction Cluster Masters will distribute the workload on their
Slaves. If one Extraction Cluster Master fails, the other Extraction Cluster will still work. You can move the Slaves of
the failed Extraction Cluster Master easily to the working Extraction Cluster Master.

Or you can install two Extraction Cluster Masters in your Extraction Cluster and configure the Extraction Cluster on
both Masters. Stop the DOKuStar Profession Link Service on the second Extraction Cluster Master. Now the second
Extraction Cluster Master behaves as a normal Slave. In case of failure of the first Extraction Cluster Master, simply start
the DOKuStar Professional Link Service on the second Extraction Cluster Master.
These techniques can be used in both following scenarios.
The Validation Clients are not regarded as critical at all. So there is no failover scenario defined for them.
Flow Server on a Microsoft Cluster Using an Already

Existing SQL Cluster
Architecture
In this scenario the high availability of the Flow Server is achieved by using the Microsoft Cluster Technology with two
Flow Server nodes. In case of failure of the active node, the second node becomes active. All jobs, which are in the
processing workflow in the moment of the failure, will become broken. After the second node has become active, the
broken jobs can be reset manually by the administrator. Then the jobs will be processed by the Flow Server on the
second node without any lost.
For further information about the Microsoft Cluster Technology refer to
http://www.microsoft.com/windowsserver2003/enterprise/clustering.mspx.
The high availability of the configuration folder, repository, import folder, and trace folder is provided by using a SAN.
The high availability of the flow database (and possibly of the ART and the ACT database) is achieved by using an
already existing corporate SQL cluster.

Products
• Microsoft Windows Server 2003 Enterprise Edition
• DOKuStar Professional 3.0
Cluster
The cluster system consists of two machines
• First cluster node (active)
• Second cluster node (passive)
Prerequisites
• Microsoft Windows Server 2003 Enterprise Edition on both nodes
• SAN disk for quorum and data
• Network connection between the nodes and the shared disk
• Domain user with administrator rights on every system involved
• Enough fixed IP addresses available (minimum five)
Sequence of Installation and Configuration

1. Install the Flow Server on each node (see Installation of the Flow Server).
2. (Install the Extraction Cluster Nodes and Validation Clients on the respective machines (see Installation of an
Extraction Cluster Node and Installation of a Validation Client).
3. Stop all services on both nodes.
4. Move the config folder to the SAN (see Using another Configuration Location). Be sure to update the
ClientConfig.dfc file on both nodes and on all Extraction Cluster Nodes and Validation Clients.
5. Change the trace folder for both nodes, the Extraction Cluster Nodes, and the Validation Clients (see Changing
the Trace Folder).
6. Move the flow database to the corporate SQL Server (see Using a SQL Server on another Machine for the Flow
Database). Be sure to provide a suitable FlowService.dcf file on both nodes.
7. Possibly move the ART database to the corporate SQL Server (see Using a SQL Server on another Machine for
the ART Database).
8. Possibly move the ACT database to the corporate SQL Server (see Using a SQL Server on another Machine for
the ACT Database).
9. Setup the Microsoft cluster with the New Server Cluster wizard.
10. Define the services Flow Service, Scheduler Service, Cleanup Service, Tracing Service, Reporting service, and
HotSpot service as generic services.
11. Restart the services on both nodes.
12. During import use a repository location on the SAN (see Using another Repository Location).

Flow Server as Virtual Machine Hosted on ESX Server –
Cold Standby
Architecture
In this scenario the high availability of the configuration folder, repository, import folder, and trace folder is provided by
using a SAN as in the previous scenario.
The high availability of the flow database ((and possibly of the ART and the ACT database) is achieved by using an
already existing corporate SQL cluster like in the previous scenario.
The high availability of the Flow Server is provided by using the ESX technology with two nodes. An active one is
powered on and a passive one is powered off. The passive node is an exact copy of the active node. In case of failure of
the active node, e.g. a blue screen, the second node has to be started manually. All jobs, which are in the processing
workflow in the moment of the failure, will become broken. After the second node has been started, the broken jobs can
be reset manually by the administrator. Then the jobs will be processed by the Flow Server on the second node without
any lost.
Furthermore you can use the high availability features of the ESX technology with several ESX servers to assure the
availability of the Flow Server in case of a broken ESX server.
For further information about the ESX technology refer to http://www.vmware.com.
The Extraction Cluster Nodes are also realized as virtual machines.

Products
• Microsoft Windows 2003 Server SP1 or higher
• DOKuStar Capture Suite 3.0
• ESX 3.5
System
The system consists of two virtual machines
• First node – active – powered on
• Second node – passive – powered off
Prerequisites
• Virtual machine with Microsoft Windows Server 2003
• ESX Server
• SAN disk for data
• Network connection between the nodes and the shared disk
• Domain user with administrator rights on every system involved
• Enough fixed IP addresses available
Sequence of Installation
1. Install the Flow Server on the virtual machine (see Installation of the Flow Server).
2. (Install the Extraction Cluster Nodes and Validation Clients on the respective machines (see Installation of an
Extraction Cluster Node and Installation of a Validation Client)).
3. Stop all services on the Flow Server.
4. Move the config folder to the SAN (see Using another Configuration Location).
5. Change the trace folder for the Flow Server, the Extraction Cluster Nodes, and the Validation Clients (see
Changing the Trace Folder).
6. Move the flow database to the corporate SQL Server (see Using a SQL Server on another Machine for the Flow
Database). Be sure to provide a suitable FlowService.dcf file for the Flow Server.
7. Possibly move the ART database to the corporate SQL Server (see Using a SQL Server on another Machine for
the ART database).
8. Possibly move the ACT database to the corporate SQL Server (see Using a SQL Server on another Machine for
the ACT database).
9. Restart the services on the Flow Server.
10. Shut down the virtual machine (= first node) and create an identical copy of it (= second node).
11. Restart the first virtual machine.

Security
This section describes several techniques to achieve a secure configuration of your DCS system.
Best Practice for Users and Groups

Overview
It is recommended to run the DCS system in an own separate sub net.
DOKuStar Capture Suite uses the Windows user management both for the services and for the users (administrator and
users working at the Validation Clients). It is recommended to use the following users and groups:
• One administrator account with administrator rights on all systems involved
• One service account for all DOKuStar Capture Suite services on the Flow Server and on the Extraction
Cluster Nodes (see Services)
• One user group for all users working at the Validation Clients
Most of the services of DOKuStar Capture Suite on the Flow Server and on the Extraction Cluster Nodes are started
using the LocalSystem service account. To change the accounts of the services perform the steps described in
Changing the Account of a Capture Suite Windows Service. The service account needs local administrator rights.
Read and write permissions on files or folders have to be provided by changing the Windows security. The section Files
and Folders provides an overview about the needed rights.
For further information about using the Windows user management refer e.g. to Best Practice Guide for Securing Active
Directory Installations or to the Windows Server 2003 Security guide (downloadable at
http://www.microsoft.com/downloads).
The databases in a DCS system are using mixed mode authentification. Read and write permissions on databases have to
be provided by defining special SQL users in the SQL Server instance and by providing database rights to Windows
users or groups in the SQL Server instance.
Database Rights
The Flow Server keeps the flow data in the flow database. Therefore the Flow Service needs full access on the flow
database.
The flow database uses mixed mode authentication. By default, the Flow Service accesses the flow database using the
SQL user dfadmin.
Note: During installation of the Flow Server the flow database and a SQL user named dfadmin are created in a local
SQL Server instance named DOKuStar. The SQL user dfadmin is the owner of the flow database. By using the
dfadmin user to access the flow database, the Flow Service will automatically have the afforded read and write
permissions on the flow database.

If you want to use a SQL Server on another machine than the Flow Server, it is recommended to change the
configuration of the Flow Service so that the Flow Service uses the account it is running with to access the flow
database. You have to provide a FlowService.dcf file for the Flow Server. In this file the
<IntegratedSecurity> tag must be set to true; this will cause the Flow Service to use the account it is
running with (if the tag is false, the Flow Service will use the SQL Server user dfadmin). See Configuration Data
and Databases for further information.
The easiest way to provide the Flow Service with the needed read, write and change permissions on the flow database is
to make the account of the Flow Service to the owner of the flow database. But it is also possible to provide the rights
explicitly without making the account of the Flow Service to the owner of the flow database.
The administrator also has read and write permissions on the flow database.
The administrator accesses the ART database when training the fields. At runtime, the Extraction Cluster Nodes access
the ART database to extract the values of the trained fields. The administrator and the Extraction Cluster Nodes access
the ART database using the security that has been specified during creation of the ART database.
The administrator accesses the ACT database during training. At runtime, the Extraction Cluster Nodes access the ACT
database to classify the document. The administrator and the Extraction Cluster Nodes access the ACT database using
the security that has been specified during creation of the ACT database.
See Databases and Configuration of the Connection to the ART Database , and Configuration of the Connection to the
ACT Database for further information.
If you want to use Reporting, you will have to initialize it using the Create Reporting Database wizard. The
wizard will create a reporting database, and it will initialize the Reporting service on the machine where the wizard is
running. This Reporting service needs read and write access to the Reporting database. On the machine where you want
to create reports, the Report Viewer needs read and write access to the Reporting database. Write access is needed
because the Report Viewer permits to delete old reporting data.

Files and Folders
The following table gives an overview about the needed rights.
File or folder Administrator User working at the Service account

Validation Client
Config folder (only once in the system, Read and write permission Read permission Read permission
usually on a SAN location)
ClientConfig.dfc (on the Flow Read and write permission Read permission on the Read permission on
Server, on each Extraction Cluster Node, on all files local file the local file
and on each Validation Client)
FlowService.dcf (on the Flow Read and write permission --- Read permission
Server)
Load Manager Files (on the Extraction Read and write permission --- Read and write
Cluster Master) permission
DOKuStarControlled Read and write permission -- Read permission
Service.exe.cfg (on the Flow
Server or on the machine where the Cleanup
Service is running)
Repository (usually on a SAN location) Read and write permission Read and write Read and write
permission permission
Import folder(s) Read and write permission -- Read and write
permission
Trace configuration files Read and write permission -- Read permission
Trace folder Read and write permission Read and write Read and write
Hot Spot configuration and processing data Read and write permission - Read and write
permission
Reporting configuration and processing data Read and write permission Read and write Read and write

Rights, Tasks, and Responsibilities
According to the permissions described in the previous sections the administrator has the following tasks and
responsibilities:
• Installation of all DCS project components including the databases
• Improving the configuration of the DCS system, e.g. adding further Extraction Cluster Nodes, moving
databases
• Creating an ART or ACT database if needed and adjusting the DCS project accordingly.
• Providing high availability
• Importing documents
• Monitoring the system, checking for broken jobs, analyzing and solving problems
• Caring for ART or ACT training if one of these modules is used
• Removing the software if needed
The administrator has read and write access to the tables in the application database.
According to the permissions described in the previous section a user working at a Validation Client has the following
tasks and responsibilities:
• Validating and completing the extraction results
The Validation user can't change the project configuration data. He hasn’t access to the flow database, and he can't
access the repository.
The service account is a technical account used only by the services; the users and the administrator can’t use this
account. The service account has as many rights as needed to perform the services' tasks (see Services).
Emergency User Concept

As already mentioned, DOKuStar Capture Suite uses Windows user management. A DCS project administrator is a
Windows administrator with administrator rights on all systems involved (including databases). All administration tasks
of a DCS project can be done with certain Windows and database rights.
So, an emergency user concept is not applicable. If one administrator is locked or disabled, another Windows
administrator, provided with the needed rights, can do the DCS project administrator job.
Encryption of Communication Channels

Files and Databases
By default all network communication in a Windows network is protected by the standard Windows security protocol
IPSec. IPSec supports network-level peer authentication, data origin authentication, data integrity, encryption, and replay
protection (see IPSec for further information).
So, all network communication to file systems and databases in a DCS system is protected by IPSec.

Encryption of the Repository
The Microsoft Windows Encrypting File System (EFS) that is integrated in most Windows operating systems can not be
used to encrypt the repository. EFS is user-based. Only the user who encrypted the file will be able to decrypt it. In a
DCS system each participant has to read the intermediate results of its preceding participant. If EFS was used for the
repository, the participant would not be able to read the results of its preceding participant, e.g., the Validation Client
would not be able to read the extraction results of the Extraction Cluster.
Improving Security on the Validation Clients

The users, working at the Validation Clients, have read and write permissions on the repository. To improve security, the
Validation users only should be able to use the Validation application. Tools like the Windows Explorer, the Internet
Explorer, the DOS prompt, should not be available for the Validation users on the Validation machines. This can be
achieved by different means, e.g. by using Citrix XenApp (see http://www.citrix.com for further information).
Logging of Security Events

As DOKuStar Capture Suite uses the Windows user management, the Windows features can be used to log security
events in the Windows event folder. In order to define what security events should be logged by Windows, you have to
implement an audit policy (see Windows Server 2003 Security guide (downloadable at
http://www.microsoft.com/downloads) for further information).
The security events occurring with respect to the databases also can be logged to the Windows event log. You just have
to change the settings of the SQL Server instance (see e.g. SQL Server 2005 Security Best Practices
(http://www.microsoft.com/downloads) for further information).
Logging of Configuration Data Changes

As already mentioned, the central config folder contains all configuration data of the DCS system. So, changes of the
configuration data can be logged to the Windows event log. If you want to log the changes, you have to enable object
access auditing by defining auditing policy settings for the object access event category on the Flow Server (see Define
or modify auditing policy settings for an event category for further information). Then you have to apply appropriate
auditing policy settings for the config folder (see Apply or Modify Auditing Policy Settings for a Local File or Folder
for further information).

Configuration Techniques
Adding a Further Extraction Cluster Node
Install an Extraction Cluster Node as described in Installation of an Extraction Cluster Node. Open the Load Manager
Cluster Configuration Tool on the Extraction Master and add the computer where you have installed the new Extraction
Cluster Node to the cluster. Add one Runtime Node for each processor of the new Extraction Cluster Node computer to
the Extraction Cluster computer node, e.g. if the new Extraction Cluster computer is a dual-processor machine, add two
Runtime Nodes to the new Extraction Slave computer node.
Start the DOKuStar Capture Suite Designer and open the project file in the folder \\<Flow Server
name>\DOKuStarDispatchData\config. Select the job step Extraction and set the property
MaxDImLoadingCount to <Number of all Runtime Nodes of the Extraction Cluster> + 1.
Select the job step Export and set the property MaxDlmLoadingCount to (<Number of all Runtime Nodes of the
Extraction Cluster + 1) / 4.
Save the project. On the Extraction Cluster Master restart the DOKuStar Professional Link Service.
For further information refer to Load Manager.
Adding a Further Extraction Cluster

Install one Extraction Cluster Master and several Extraction Cluster Nodes as described in Installation of an Extraction
Cluster Node. Open the Load Manager Cluster Configuration Tool on the Extraction Master and configure the new
Extraction Cluster as described in Configuring the Extraction Cluster.
For further information refer to chapter Load Manager.

Creating a DOKUSTAR Instance Manually
Install a SQL Server instance named DOKUSTAR with any edition of the Microsoft SQL Server 2005.
If you create the DOKUSTAR instance in order to be able to install the DOKuStar Capture Suite Flow Server (see
Installation of the Flow Server), you have to specify mixed mode authentication and to specify #DOKuStar# as sa
user password.
If you create the DOKUSTAR instance when the Flow Server has been installed successfully, you can use Windows
authentication mode instead of mixed mode.
In any case, leave the default collation Latin1_General_CI_AS.
Removing the sa User after Installation

1. On the Flow Server open the Administrator and stop the Flow Service.
2. On the Flow Server in the Windows control panel, set the account of the Flow Service to a domain user. See
Changing the Account of a DOKuStar Capture Suite Windows Service.
3. On the Flow Server install the SQLSE Management Studio (provided on the DCS project DVD).
4. In the SQLSE Management Studio, detach the flow database DBFLOW.MDF (folder
Programs\Captaris\databases\MSSQL.<Version>\MSSQL\Data).
5. In the SQLSE Management Studio, possibly detach the ART database.
6. In the SQLSE Management Studio, possibly detach the ACT database.
7. Eleminate the sa user by uninstalling the DOKUSTAR instance.
8. On the Flow Server install a new DOKUSTAR instance with Windows authentifaction mode instead of mixed
mode – thus without sa user (see Creating a DOKUSTAR Instance Manually).
9. Attach DBFLOW.MDF to the new DOKUSTAR instance. Add the domain user from step 2 to the database
DBFLOW with dbowner rights.
10. On the Flow Server create a suitable FlowService.dcf file in the folder Documents and
Settings\All Users\Application Data\Captaris\DOKuStar Dispatch (see
Creating the File FlowService.dcf).
11. Possibly attach the ART database. Provide read access to the database for the Extraction Cluster Nodes. Provide
read and write access to the database for the administrator.
12. Possibly attach the ACT database. Provide read access to the database for the Extraction Cluster Nodes. Provide
read and write access to the database for the administrator.
13. On the Flow Server restart the Flow Service.

Using a SQL Server on another Machine for the Flow
Database
The existence of a local SQL Server instance named DOKuStar is a precondition of the DOKuStar Capture Suite Flow
Server installation. So even if you want to use a SQL Server on another machine than the Flow Server, you have to
install a local SQL Server instance on the Flow Server first. To use another SQL Server machine perform the following
steps:
1. On the Flow Server install the required DOKuStar instance by using the Microsoft SQL Server Express setup of
DOKuStar Capture Suite. See Installation of the Flow Server for further information.
2. Install the Flow Server like described in Installation of the Flow Server.
3. On the Flow Server open the Administrator and stop the Flow Service.
4. On the Flow Server in the Windows control panel, set the account of the Flow Service to a domain user. See
Changing the Account of a DOKuStar Capture Suite Windows Service.
5. On the Flow Server install the SQLSE Management Studio (provided on the DCS project DVD).
6. On the Flow Server in the SQLSE Management Studio, detach the flow database DBFLOW.MDF (folder
Programs\Captaris\databases\MSSQL.<Version>\MSSQL\Data).
7. On the remote machine install a SQL Server DOKuStar instance (see Creating a DOKUSTAR Instance
Manually).
8. Copy DBFLOW.MDF to the remote SQL Server.
9. On the remote SQL Server attach DBFLOW.MDF. Add the domain user from step 4 to the database DBFLOW
with dbowner rights.
10. On the Flow Server create a suitable FlowService.dcf file in the folder Documents and
Settings\All Users\Application Data\Captaris\DOKuStar Dispatch (see
Creating the File FlowService.dcf).
11. On the Flow Server restart the Flow Service.

Creating the File FlowService.dcf
The FlowService.dcf tells the Flow Service where to find and how to access the flow database. It has to be
located in the folder Documents and Settings\All Users\Application
Data\Captaris\DOKuStar Dispatch on the Flow Server.
The file has the following structure:

<BUSYInfoServices xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" Subject="Service and Database Setup">
<CoreInfoServices>
<Accessor Name="Default">
<Any>
<Server>SYS9999\DOKUSTAR</Server>
<SID>DBFLOW</SID>
<IntegratedSecurity>true</IntegratedSecurity>
</Any>
</Accessor>
</CoreInfoServices>
</BUSYInfoServices>
Change the <Server> tag to your corporate SQL Server.

The <IntegratedSecurity> tag controls how the Flow Server accesses the flow database. False means: The
Flow Server uses the SQL Server user dfadmin to access the database.
If the SQL Server runs on another machine than the Flow Server, it is recommended to change the account of the Flow
Service to a domain user and to use <IntegratedSecurity>true. The Flow Server uses the account to access
the flow database. This account must have full access on the flow database.
Using a SQL Server on another Machine for the ART

Database
Usually the ART database is created in the local SQL Server instance named DOKuStar on the Flow Server. If you
want to move the ART database to another SQL Server instance, you have to perform the following steps:
1. On the Extraction Cluster Master stop the Load Manager Service.
2. On the Flow Server install the SQLSE Management Studio (provided on the DOKuStar Capture Suite DVD).
3. On the Flow Server in the SQLSE Management Studio, detach the ART database (folder
Programs\Captaris\databases\MSSQL.<version>\MSSQL\Data).
4. On the remote machine install a SQL Server instance if necessary.
5. Copy the ART database file to the remote SQL Server.
6. On the remote SQL Server attach the ART database file. Provide read access to the database for the Extraction
Cluster Nodes.
7. Change the database access configuration of the Extraction Cluster Nodes like described in Configuration of the
Connection to the ART Database.
8. On the Extraction Cluster Master restart the Load Manager Service.
Note: Instead of using SQLSE Management Studio, you can use the DOKuStar Professional Visual Designer – ART
Explorer View to copy the ART database to another SQL Server instance. See DOKuStar Professional Developer's
Guide for further information.

Using a SQL Server on another Machine for the ACT
Database
Usually the ACT database is created in the local SQL Server instance named DOKuStar on the Flow Server. If you
want to move the ACT database to another SQL Server instance, you have to perform the following steps:
9. On the Extraction Cluster Master stop the Load Manager Service.
10. On the Flow Server install the SQLSE Management Studio (provided on the DOKuStar Capture Suite DVD).
11. On the Flow Server in the SQLSE Management Studio, detach the ACT database (folder
Programs\Captaris\databases\MSSQL.<version>\MSSQL\Data).
12. On the remote machine install a SQL Server instance if necessary.
13. Copy the ACT database file to the remote SQL Server.
14. On the remote SQL Server attach the ACT database file. Provide read access to the database for the Extraction
Cluster Nodes.
15. Change the database access configuration of the Extraction Cluster Nodes like described in Configuration of the
Connection to the ACT Database.
16. On the Extraction Cluster Master restart the Load Manager Service.
Note: Instead of using SQLSE Management Studio, you can use the DOKuStar Professional Visual Designer – ACT
Explorer View to copy the ACT database to another SQL Server instance. See DOKuStar Professional Developer's
Guide for further information.
Using another Repository Location

To use another Repository location, simply specify the repository folder to be used in configuration of the importing
program. The specified repository folder must be writeable for the Windows users working at the Validation Clients and
for the account(s) of the Extraction Cluster Nodes (strictly speaking for the account(s) of the Load Manager Services
running on the Extraction Cluster Nodes, see Services). The Cleanup Service (normally running on the Flow Server)
must have write permissions, too.
Using another Configuration Location

In the standard configuration the config folder is located in the folder \\<Flow Server name>\
DOKuStarDispatchData. You can move this folder to another location, e.g. to a SAN.
Note: Instead of moving the config folder, you can move the complete DOKuStarDispatchData share (with
the sub folders config and Repositories) to the new location.
The config folder with all sub folders and files must be readable for the Windows users working at the Validation
Clients and for the account(s) of the Extraction Cluster Nodes (strictly speaking for the account(s) of the Load Manager
Services running on the Extraction Cluster Nodes, see Services).
Each participant of a DCS system, even the Flow Server itself, has a file named ClientConfig.dfc located in its
local folder Documents and Settings\All Users\Application
Data\Captaris\DOKuStar Dispatch. This file contains a tag named
<DefaultServerConfigLocator> telling the Validation Client or Extraction Cluster Node where to look for
the config folder.

After copying the config folder to its new location, you have to update the ClientConfig.dfc files of all
participants of your DCS system.

<ClientConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.DOKuStar.com/Flow/ClientConfig/V03">
<DefaultServerConfigLocator
VisualName="SYS9999">\\SYS9999\DOKuStarDispatchData\config\ServerConfig.dfc</DefaultServerConfigLocat
or>
</ClientConfig>
Changing the Trace Folder

Users\Application Data\Open Text\Trace. To change the trace location you have to create a new
registry key TraceRootPath (type REG_SZ) in HKLM\SOFTWARE\Open Text\ on each participant. Enter
the new path into the value field of the key.
Tracing is done by the Tracing Service running in the context of the LocalSystem account. If you want to use a
remote trace folder, the Tracing Service will not have the afforded access rights to write the trace files. You have to run
the service with the Service Account (see Services). To change the account of the service, perform the steps described in
Changing the Account of a Capture Suite Windows Service.
For further information about tracing refer to Tracing.

Changing the Account of a Capture Suite Windows
Service
Open the Windows services control panel and select the respective service. Stop it and open the properties of the service.
Change the account for the service and restart it.
Running an Additional Scheduler Service on another

Machine
To run an additional Scheduler Service on another machine, you have to install DOKuStar Capture Suite on that
machine. Follow the instructions described in Installation of the Flow Server, but on the Custom Setup page deselect
all components except Workflow Server.
After the installation open the Windows services control panel on that machine and deactivate the services:
• Flow Service (DOKuStar Flow)
• Cleanup Service (DOKuStar CleanUp)
• Tracing Service (DOKuStar Tracing)
Open the file ClientConfig.dfc located in its local folder Documents and Settings\All
Users\Application Data\Captaris\DOKuStar Dispatch and change the value of the tag named
<DefaultServerConfigLocator> to the config folder (in the standard configuration on the Flow Server).
Now the Scheduler Service will run on the Flow Server and on this second Scheduler Server.
Running the Scheduler Service on another Machine

To run the Scheduler Service on another machine than the Flow Server, you have to perform the steps described in
Running an Additional Scheduler Service on another Machine. Then open the Windows services control panel on the
Flow Server and deactivate the Scheduler Service (DOKuStar Scheduler).
Now the Scheduler Service will only run on this new Scheduler Server.
Using a Validation Client for Several DCS systems

A special configuration of the Validation Clients allows that the Validation Clients can work for several DCS systems. If
this special configuration is done, the user at the Validation Client can choose the DCS system, he wants to work with.
One DCS system is the default system. If the default system is broken, the users at the Validation Clients will work with
another system.
Each Validation Client has a file named ClientConfig.dfc located in its local folder Documents and
Settings\All Users\Application Data\Captaris\DOKuStar Dispatch. This file contains
a tag named <DefaultServerConfigLocator> telling the Validation Client where to look for the config
folder. The <DefaultServerConfigLocator> tag specifies the default DCS system for the Validation Client.
You can add further <ServerConfigLocator> tags to specify further DCS systems.

<ClientConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.DOKuStar.com/Flow/ClientConfig/V03">
<DefaultServerConfigLocator
VisualName="SYS9999">\\SYS9999\DOKuStarDispatchData\config\ServerConfig.dfc</DefaultServerConfigLocat
or>
<ServerConfigLocator
VisualName="SYSXXXX">\\SYSXXXX\DOKuStarDispatchData\config\ServerConfig.dfc</ServerConfigLocator>
</ClientConfig>
Validation will still start with the default DCS system, but it will show an additional command Select
Configuration in the File menu. This command opens the Select Configuration dialog:
The Configuration field shows the specified name of the currently selected Flow Server. To switch to another flow
system, the user can select the respective entry from the list.
Configuration of the Connection to the ART Database

The ART database is accessed by the Extraction Cluster Nodes at runtime. The configuration of the connection to the
ART database is done by DOKuStar Professional Visual Designer. If you move the ART database to another SQL Server
instance, you have to change the connection configuration like follows:
Start DOKuStar Professional Visual Designer and open the DOKuStar Professional project file including the ART
module. Select the ART module.
In the Properties view, on the General tab select the button in the Repository box. The Select Repository
dialog opens:
Use the command Register Computer in the context menu of the dialog to add the computer hosting the ART
database to the tree. Then open this computer node, select the ART database and confirm with OK.
Save the project and exit Visual Designer.

Configuration of the Connection to the ACT Database
The ACT database is accessed by the Extraction Cluster Nodes at runtime. The configuration of the connection to the
ACT database is done by DOKuStar Professional Visual Designer. If you move the ACT database to another SQL Server
instance, you have to change the connection configuration like follows:
Start DOKuStar Professional Visual Designer and open the DOKuStar Professional project file including the ACT
module. Select the ACT module.
In the Properties view, on the General tab select the button in the Repository box. The Select Repository
dialog opens:
Use the command Register Computer in the context menu of the dialog to add the computer hosting the ACT
database to the tree. Then open this computer node, select the ACT database and confirm with OK.
Save the project and exit Visual Designer.
Configuring Shortcuts
The Visual Designer, the ART Training Client, and the ACT Training Client will immediately open a project that is
supplied as parameter when they are started. This permits to configure a shortcut that starts the respective program and
opens your project automatically.
To achieve this, create a shortcut. E.g. go to the respective item in the program group, and from the context menu choose
Send to -> Desktop (create shortcut). Then go to the properties of the new shortcut and append the full path
name of the DOKuStar Professional project file (extension .sitemap) to the Target string. Don’t forget to include the
file path into quotes, if it contains spaces.
Changing the User Interface Language of Validation

With this release, DOKuStar Validation is always installed with English user interface. To change the user interface
language, start the registry editor, go to HKEY_LOCAL_MACHINE\Software\Captaris\DOKuStarValidation\3.7
and set the value Language accordingly. The following values are allowed:
1031 German,
1033 English,
1034 Spanish
1036 French,
1040 Italian.

Administration
Overview
To start the Administration, select Administration in the DOKuStar Capture Suite program group or use the icon
DCS Administration on the desktop.
Note: If you start the administration program for the first time, you might get a security warning from the Windows
firewall, asking you, whether the program should be blocked. Confirm that the program should no longer be blocked.
The Administration program permits to monitor and control the different components. For these tasks the Administration
provides a set of views. The central view that permits to monitor the complete application and to activate different views
is the System window. When you start the Administration for the first time, the System window is empty:
As a first step, create a System tab page for your system. Open the New System wizard using the New command
of the File menu.
On a running system, where a System tab page has been created, a project has been activated, and jobs have been
imported, the different views of the administration program permit to monitor the application:
DOKuStar Capture Suite Administrator's Guide Administration • 59

The System view shows an overview of the services and the DOKuStar Professional cluster. Here you can see at a
glance whether all services are running and whether the DOKuStar Professional nodes are working.
The Summaries view on the right side shows for each job step of the different job classes the number of activities in
different states. Here you control the size of the different queues and detect problems such as broken jobs.
The Job Class view shows the same data for a single job class in a different presentation. The job steps and links
defined for the job class are shown in the same way as in the DCS Designer. Below each job step, the number of
activities in the different states is shown.
The Activities and Jobs view permits to show lists of activities or jobs. If you click on a queue in the
Summaries or Job Class view, the respective activities will be shown in this view. In addition, you can show
subsets by defining filters for any column of the view. If you select activities or jobs, you can get detailed information or
perform administrative tasks for the respective items using context menu commands or the toolbar buttons of the view.
E.g. you can suspend, reset, or delete activities or jobs, or change their priority.
The Shapes view is only needed to add items to the System view by dragging them from the Shapes view onto
the System view with the mouse. As soon as your System view is complete and you no longer want to modify it, you
can close the Shapes view or set it to mode AutoHide.
You can add more than one System view The Administrator program can thus be used to monitor several DOKuStar
Capture Suite applications. The System views appear as tab pages showing the name of the respective flow servers in
the tab, and you can switch between the different applications by selecting the respective tab. The other views will be
adapted automatically.
60 • Administration DOKuStar Capture Suite Administrator's Guide

Creating a New System View
To create a new System view, use the New command of the File menu. The New System wizard starts:
Confirm the first dialog step with Next. The Server dialog appears:
Select the flow server from the drop-down list, or enter the name into the field, if it is not yet available. Normally you
will work with the default option. It will create a view with a Services shape containing all services of the DOKuStar
Capture Suite and a DOKuStar Professional shape.
If you select the second option, you will get an empty view and you will have to add all needed items manually.
When you confirm with Next, the DOKuStar Professional Cluster dialog appears:

If you don’t want to add a DOKuStar Professional shape to the view, unmark the option.
Otherwise enter the computer name of the master of the DOKuStar Professional cluster. The default value localhost
will only be valid if all components are installed on a single system for development or if administration is configured on
the DOKuStar Professional cluster master.
When you confirm with Next, the Services dialog is shown:
If you don’t want to add a Services shape to the view, just unmark the option Add a Services Shape.
If you don’t want to add a special service, just unmark it. For each service you have to enter the name of the system
where the system is running. As default, the name of the flow server is shown. This setting will only be valid, if all
components are installed on a single computer for development or testing. In a typical cluster installation, the
DOKuStar Professional Link and the Cluster service will reside on another computer, the master of the
DOKuStar Professional cluster.
When you confirm with Next, the wizard is ready to create the System view:

When you click OK, a new System tab with the specified items will be added to the Administrator.
Modifying a System View

In most applications it will not be necessary to modify the System view that has been created with the New System
wizard. But sometimes you may want to add additional services or a descriptive text. And if your system uses more than
one DOKuStar Professional cluster, you will have to modify the view by adding a second DOKuStar Professional
shape.
Adding a New Shape to the System View

To add a shape to a System view, drag it from the Basic Shapes list in the Shapes view to an empty area of the
System view. In the following example, a Description shape is just being dragged to the System view:

When you add a Description or a DOKuStar Professional shape, a dialog appears as soon as you release the
mouse button. For a Description shape you enter the text that should be shown:
For a DOKuStar Professional shape you can enter computer name and port number of the respective DOKuStar
Professional cluster master:
If you add a Services shape, an empty shape will appear:
You can then add the desired services.
Adding a Service to a System View

The Administrator permits to monitor any Windows service. In the Services list of the Shapes view you will find
separate items for the services used by the DOKuStar Capture Suite. An additional item can be used to add any Windows
service.
Services can only be added to a Services shape on the System view. Thus you can add a new service to an already
present shape, or add a new Services shape first.
To add a DOKuStar Capture Suite service, just drag it onto the respective Services shape with the mouse. In the
following example, a Cluster service is just being dragged to an empty Service shape:

As soon as you release the mouse button, a dialog will ask for the system name:
For a Cluster or a DOKuStar Professional Link service, this will be the system name of the cluster master of
the respective DOKuStar Professional cluster.
For the services Flow, Scheduler, and CleanUp, it will be the name of the flow server for typical configurations.
When you add a Windows Service item, a dialog will appear where you can select the desired service:
If you want to add a service on the local machine, you can leave the Machine Name field empty. Otherwise enter the
name of the respective computer first. When you click onto the Service field, the services available on the specified
computer are determined and will then appear. Select any service and confirm with OK.
Removing Items from a System View

Each item shown on a System view can be removed separately.
To remove any shape from the view, click on the shape with the right mouse button and click Delete Shape on the
appearing context menu.
To remove a service from a Services shape, select it by clicking into an empty area of the respective service line. The
selected service is then shown highlighted in light orange color. Then click onto the Services shape with the right
mouse button and click Remove Service on the appearing context menu.

Monitoring Several Systems
In order to monitor several DOKuStar Capture Suite systems with a single administrator station, you create a separate
System view for each system. Each view will appear as a separate tab page that shows the system name of the
respective flow server in its tab:
When you select a tab, the System view will show the respective system. The Summaries view, the Job Class
view, and the Activities and Jobs view will then be updated automatically.
If you don’t need to monitor a system for some time, you can close its System view. Select the respective view and
close it by clicking on the cross icon in the top right corner of the view.
To show any previously configured system, use the Open command of the File menu. An Open System dialog lists
all configured systems. Select the respective system and confirm with OK.
To remove a previously configured system permanently, use the Delete command of the File menu.

Menus
File Menu
New…
This command creates a new System view. The New System wizard starts. There you can specify the
items that should be shown and the system names of the respective computers.
Open…
With this command you can open a previously created System view. A dialog shows a list of all configured
systems. Select a system and confirm with OK. The respective System view will then be displayed.
Delete…
With this command you can delete a previously created System view permanently. A dialog shows a list of
all configured systems. Select a system and confirm with OK. The respective System view no longer be
available.
Exit
Terminates the Administration.
View Menu
Summaries,
Shapes,
Activities and Jobs,
Job Class
These commands open the selected view. If the respective view or window is currently shown, the command
has no effect. To close a view, click on the cross shown in the upper right corner of each view.
Note: To show a previously created System view, use the Open command of the File menu.

Windows Menu
Load Layout…
This command permits to switch to a layout that has been previously saved using the command Save
Layout As.
Save Layout
This command saves the current layout to the last used layout file. You can then later restore the layout by
loading this file with the command Load Layout.
Save Layout As…
This command permits to save the current layout to a file. You can then later restore the layout by loading it
with the command Load Layout.
Help Menu
Administrator’s Guide
This opens the online help.
About…
This command shows a dialog box with version information.

Views and Windows
Introduction
The user interface of the Administration shows several views and windows that can be arranged very flexibly in different
ways. It is important to understand the underlying concepts in order to be able to use the user interface effectively.
The user interface distinguishes between views and windows. The Administration program has four views, the Shapes
view, the Summaries view, the Job Class view, and the Activities and Jobs view. There is only a single
instance of each view that can be shown, or hidden respectively, by a corresponding command in the View menu. As
default, each view is shown in a separate area of the program window. Views provide different display modes.
Windows can be created dynamically and are used to show the configuration of different DOKuStar Capture Suite
systems. As default all windows are shown as tab pages of a common area of the program window. There may be several
instances of the same window type. Each window can be closed individually. The command Close All Windows of
the Windows menu will close all windows, i.e. all System views. The currently existing windows can be arranged in
different horizontal or vertical tab groups.
Controlling Views
The Administration user interface contains four views, the Shapes view, the Summaries view, the Job Class
view, and the Activities and Jobs view. In the standard layout, each view is shown in a separate area of the
program window.
Each view can be moved to different positions within the program window. To move a view to a new location, just go to
the title bar of the view and drag it with the mouse. As soon as you drag a view, several symbols will appear on the
program window that help you to move the view to special positions:

Here the Shapes view is just being moved. The arrow symbols at the left, right, upper and lower border of the program
window permit to position the view at the respective border of the program window. The size of all other views and
windows will be adapted accordingly. A group of symbols is shown on the view or program window area, where the
view is just being moved over. In the above image the symbols are just shown on the window area. The arrow symbols
permit to position the view at the respective border of the view or program window area. The symbol in the middle
permits to show the view as tab page of the respective view. As soon as the mouse is positioned on one of the symbols, a
shaded area will appear to indicate where the view will be positioned. If you release the mouse button, while it is
positioned on a symbol, the view will be moved to the respective position. If you release the mouse at another position,
the view will be shown as a separate floating window that can be positioned at any location of the desktop.
Each view has different display modes that can be controlled by a context menu that will appear when you click on the
title bar of a view with the right mouse button:
Dockable
When Dockable is marked, the view is shown in a separate area or window. When Dockable is not
marked, the view will be shown as tab page of the window area. Please take notice that the view as a window
has special properties. It will still show the commands Dockable, Hide, and Floating in the context
menu of the tab while normal windows don’t show these commands.
Hide
This command closes the respective view. To reopen it, use the corresponding command of the View menu.
Floating
If Floating is marked, the view is shown as a separate floating window that can be moved to any position on
the desktop independently of the Administration program window. If you then click on Floating, the view
will return to its previous position within the program window.
Auto Hide
If this option is marked, the view is normally shown as symbol in a small toolbar at the border of the program
window. When you move the mouse to the toolbar the view is shown automatically. When you click into
another area of the program window, it is hidden again.
The following example shows the Shapes view in Auto Hide mode:
Auto Hide mode can also be activated by clicking on the pin symbol in the title bar of the view.
Note: Auto Hide mode is available only, while the view is dockable and not floating.

Controlling Windows
Several windows may be shown as tab pages of a special area of the program window.
Windows behave differently than views. Windows can’t be moved outside the special window area and they don’t
support the different display modes of views. In addition, there may exist several instances of the same type of view.
Windows can be arranged in different tab groups within the window area. To create a new tab group, click on the tab of a
window with the right mouse button. The following context menu appears:
The commands permit to close the window or to create a new horizontal or vertical tab group. The respective view will
then appear as the only tab page of the newly created tab group.
You can either create a set of horizontal tab groups, or a set of vertical tab groups. As soon as you create a second
horizontal tag group, the command New Vertical Tab Group disappears from the context menus and vice versa.
When two or more tab groups exist, the context menu will show additional commands that permit to move the respective
window to the adjacent group:
A similar context menu appears, when you go to the tab of a window and drag it onto another tab group.
In the following example, the command New Horizontal Tab Group has been used while two System views
were shown as tabs of the system window area. As a result, two horizontal tab groups are shown, and the second
System view is now shown in the second group:

System Window
The System window permits to provide an overview of the whole application on a server cluster. The activities of the
different components and of selected windows services can be monitored at the same time. Links are provided that
permit to activate or open additional views in order to show a detailed view of a component.
The layout of the System window is configurable. In the following example a Services shape is shown on the left
side, containing the five services used by the DOKuStar Capture Suite. In addition, a DOKuStar Professional shape and a
description shape with describing text are shown:
For some components, state information is indicated. The Scheduler and the CleanUp services show moving bars,
while the respective component is working. Normally, the bars are shown in green color. If an error occurs, the bars are
shown in red color. These indicators permit to watch the polling activity of these components.
The service items show the name of the computer where the system is located, and the state of the respective service at
the time of the last refresh. Some of the service names are shown as links. A click on a link will make detailed
information available:
• When you click on CleanUp, the CleanUp dialog opens. It shows detailed information about the activity
of the CleanUp service and permits to modify its parameters.
• When you click on Schedule, the Scheduler dialog opens. It shows detailed information about the
activity of the Scheduler service and permits to modify its parameters.
You can stop and start each service separately using the buttons in the line of the respective service. With the buttons in
the All Services line you can stop or start all services in the shape
The DOKuStar Professional shape shows the activity of the respective DOKuStar Professional cluster graphically.
It shows how much processing nodes are currently working and how much were active during the last few minutes.
When you click on Load Manager Monitor, the DOKuStar Load Manager Monitor is started. It permits to
watch the activity of the DOKuStar Professional cluster and to configure the Load Manager.
You can change the layout of the System window by moving the shapes with the mouse. Select a shape by pointing to
its border with the mouse. As soon as the mouse cursor changes, you can drag the shape to another position.
The layout of the System window has to be configured. When the Administration is started for the first time, the
window will be empty. In this case use the New command of the File menu and specify the details of your system in
the appearing New System wizard.

Shapes View
The Shapes view can be used to configure a System window. It shows a list of all available objects, here called
shapes. Because the view is only used during configuration of the Administration, it should be in display mode Auto
Hide. It will then be represented as a little symbol in a toolbar at the border of the program window and will thus not
occupy a part of the program window unnecessarily. If you move the mouse onto the symbol, the view will open
temporarily as shown here:
Each shape listed in the Shapes view can be dragged to a System window with the mouse. The respective shape will
then appear in the System window.
Typically you will configure the System window completely in the New System wizard. In this case you will not
need the Shapes view unless you have to add an additional windows service or a second DOKuStar Professional
shape, or if you want to add a description shape.

Summaries View
Overview
With the Summaries view you can monitor workload and state of a DOKuStar Capture Suite system. It has two tab
pages.
The Activities tab page shows for all or selected job classes the number of activities for each job step and state. In the
following example only a single job class and only the job steps and states with non-empty queues are displayed:
Using its toolbar, the tab page can be configured to show all or only specified job classes, and to show all job steps and
states, or only items whose queue is not empty. You can also configure that some states should not be displayed. If you
click on a link, the Activities and Jobs view will display a list of the respective items.
The Jobs tab page shows for all or selected job classes the number of jobs in the different job folders. In the following
example there is only a single job class containing a folder Demo:
If you click on a link, the Activities and Jobs view will display a list of the respective jobs.
As default, both tab pages will refresh automatically. Using the toolbar you can request an immediate refresh, and you
can modify the refresh time, or switch off automatic refresh.

Toolbar of the Summaries View
With the toolbar buttons you can control refresh, and configure the Activities tab page of the Summaries view:
Controlling Refresh:
Refresh
When you click this button, the contents of the view will be refreshed immediately.
Configure timer
This button opens the Timer dialog:
Here you can specify the time interval in seconds for automatic refresh, or switch off automatic refresh. On a
production system with high workload, you should not specify a short refresh interval of only a few seconds
because this could slow down processing.
Deleting a Job Class:
Delete a job class

This button can be used, to remove an obsolete job class from the flow database. You can only delete a job
class, if no activities exist any more, i.e. if the Summaries view doesn’t show an activity in any queue.
When you click this button, a drop-down menu shows all defined job classes. If you try to delete a non-empty
job class, an error message will be shown.
Configuring the Activities Tab Page:
These buttons are only available while the Activities tab page is selected.

Configure job classes
This button opens the Job Classes dialog:
As default, the Activities view shows the activities of all job classes of the current project. If you want to
suppress some job classes of a project with several job classes, mark the second option and deselect the job
classes that should no longer be shown.
Configure states
This button opens the States dialog where you can specify which states should be displayed in the extended
presentation of the Activities tab page of the Summaries view.
An activity may run through a lot of states during its lifetime. Thus the list of all job steps and their states will
become very long in the extended presentation, if all states are shown. Therefore some states are not shown as
default. In the States dialog you can specify which state should be shown. In addition, you can modify the
colors used for the different states:
View all jobs or only pending activities

This buttons toggles between two presentations of the Activities tab page. A compressed presentation
doesn’t display states of a job step whose queue is and job steps were all queues are currently empty. This
presentation is short and gives a good overview; but the shown job steps and states may change with every
refresh because other state queues become empty.
An extended presentation shows all job steps and state values while most queues will be empty normally.
When you want to work with this presentation, you could use Configure states to suppress certain state values
and show only the most important queues.

Context Menu of the Summaries View
In the context menu of the Summaries view, you find the same commands as in the toolbar:
Refresh
This command starts a refresh immediately.
Configure timer
This button opens the Timer dialog. There you can specify the time interval in seconds for automatic refresh,
or switch off automatic refresh. On a production system with high workload, you should not specify a short
refresh interval of only a few seconds, because this could slow down processing.
Delete a job class
This command can be used, to remove an obsolete job class from the flow database. You can only delete a job
class, if no activities exist any more, i.e. if the Summaries view doesn’t show an activity in any queue.
When you click this button, a drop-down menu shows all defined job classes. If you try to delete a non-empty
job class, an error message will be shown.
The last three commands are only available while the Activities tab page is selected.
Configure job classes
This command opens the Job Classes dialog. As default, the Activities view shows the activities of all
job classes of the current project. If you want to suppress some job classes of a project with several job
classes, mark the second option and deselect the job classes that should no longer be shown.
Configure states
This command opens the States dialog where you can specify which states should be displayed in the
extended presentation of the Activities tab page of the Summaries view.
An activity may run through a lot of states during its lifetime. Thus the list of all job steps and their states will
become very long in the extended presentation, if all states are shown. Therefore some states are not shown as
default. In the States dialog you can specify which state should be shown. In addition, you can modify the
colors used for the different states:
View all jobs or only pending activities
This buttons toggles between two presentations of the Activities tab page. A compressed presentation
doesn’t display states of a job step whose queue is and job steps were all queues are currently empty. This
presentation is short and gives a good overview; but the shown job steps and states may change with every
refresh because other state queues become empty.
An extended presentation shows all job steps and state values while most queues will be empty normally.
When you want to work with this presentation, you could use Configure states to suppress certain state values
and show only the most important queues.

Job Class View
The Job Class view shows an overview about the queues of the job steps for a single job class.
The view shows the workflow of the job class graphically. Arrows denote possible routes for jobs. Below each job step,
non-empty queues with activities in a certain state are shown. Empty queues are never shown in this view.
When you click on a queue, the Activities and Jobs view will show a list of the respective activities. When you
click on a job step icon, it will show a list of all activities of the respective job step. When you click on the job class
name, it will show all activities of the job class.
An additional job step Scheduling is shown separately. To be quite correct, the scheduler would have to be shown
between each pair of job steps because after each job step the scheduler transfers a schedule to the next job step
according to specified rules. On the other hand the scheduler is a single entity that controls the workflow for all job steps.
In addition the scheduler works fast and often no schedules are waiting or in progress at any time. Therefore only a
single item Scheduling is shown, and typically most or all queues will be empty and therefore not shown.
The view gives a quick overview about the state of a job class. You can see immediately, how many activities are in state
Ready, i.e. waiting, at the different job steps. In the above example, no activities are in state Working at the
Validation job step, i.e. no validation operators are working. Some activities are in state Broken, i.e. a problem
has occurred and should be looked after.
As default, the view will be refreshed regularly. The first toolbar button permits to request an immediate refresh. With
the second button you can open a Timer dialog and modify the refresh interval, or switch off automatic refresh.
The Job Class view always shows only a single job class. To show a job class, open the Job Class drop-down list
in the toolbar of the view and select a job class.
Note: The Job Class view shows the same data as the Summaries view for a single job class. If you don’t need
this view, you can close it, or move it to another location so that it will be shown as tab page together with another view.

Activities and Jobs View
The Activities and Jobs view permits to display different lists of activities or jobs:
There are different ways to select which activities or jobs should be shown in the view:
• A click on the first field of the toolbar of the view will open a list with predefined reports.
• When you click on a link for a queue in the Summaries view, the respective activities will be displayed.
• When you click on a queue in the Job Class view, the respective activities will be displayed.
• The last two toolbar buttons permit to show the corresponding job for a selected activity, or the activities
belonging to a selected job respectively.
• Filters that can be specified in the header of the view permit to extract special activities or jobs that are of
special interest.
With a click on a column header you can sort the items according to the respective column.
When you click on selected activities with the right mouse button, a context menu permits to perform different
commands. E.g., you can request detailed information, suspend, resume, reset, or delete activities, or change their
priority.
In the same way, a context menu for selected jobs permits to request detailed information, to delete the jobs, or to change
their priority.

Toolbar of the Activities and Jobs view
The toolbar of the Activities and Jobs view permits to select different reports, to modify the view, and to perform
commands on selected items:
If you click on the first field, a drop-down menu shows all available types or activity and job reports:
For activities, you can request a report for all activities, all suspended activities, or all activities with errors (Caution
will list all activities that need administration before they can be processed, i.e. all activities in states Suspended,
Broken, and Failed). In addition, you can request a report for a single job. For a single job class you can request a
report of all activities of the job class, or all activities of a specified job step or state. During selection of a job class
report, submenus will appear where you can select the respective items.
For jobs, you can request a report of all jobs, or report for a specified repository, folder, or job.
Refresh
With this button yon can refresh the contents of the view. The Activities and Jobs view doesn’t provide
an automatic refresh. A refresh would be a nuisance if you were just selecting items in order to perform a
command. In addition, on a large system with thousands of jobs, a refresh might need considerable time and
frequent refresh on a large report could slow down the system.
Cancel Refresh
While a refresh is performed, you can cancel it with this button if it takes too long.
Select Columns
This button opens the Columns dialog where you can select which columns should be shown. When the
current report refers to a single job class the dialog shows a button Configure job ticket columns. A
click on this button opens a dialog showing the job ticket fields of the respective job class. Mark the job ticket
fields that should be available for the Activities and Jobs view and confirm with OK. The marked ticket
fields will then be available in the Columns dialog and can thus be shown in reports for the respective job
class.
Delete
With this button you can delete selected activities, or jobs respectively.

Suspend Activity
This button transfers the selected activities to the Suspended state. While the activities remain in this state,
they will not be processed by the corresponding job step.
Resume Activity
This button transfers selected activities from state Suspended to state Ready so that they are again
available for processing at their respective job step.
Reset Activity to…
With this button you can reset selected activities to another job step. When you click it, a drop-down menu
with the available job steps is shown. Select the desired job step and click on it.
Abort Activity
With this button you can abort selected broken activities. It is only available if all selected activities are in
state Broken.
Show Details
This button opens the Activity Details dialog that makes detailed information about the activity and the
corresponding job available. It is only available while a single activity is selected.
Change Priority
This button opens the Priority dialog where you can modify the priority of the selected activities, and of the
corresponding jobs:
View Input Files

This button permits to view any input file of the selected activity. It is only available while only a single
activity is selected. When you click it, a drop-down menu shows the available input files. When you click on a
file in the menu, the file is opened in the corresponding viewer.
Show associated job

When you click this button, a job report with the associated job is shown. It is only available while an activity
report is shown and a single activity is selected.
Show associated activity

When you click this button, an activity report with the associated activities is shown. It is only available while
a job report is shown and a single job is selected.

Activities and Jobs view - Filtering and Sorting
The Activities and Jobs view is very flexible and permits to extract the desired data by different standard reports
and filtering and sorting features.
To sort a shown report, just click on the respective column header. The report will then be sorted according to the
specified column. A little arrow in the column header will indicate sorting. In the following example, a report has been
sorted according to ascending creation date:
To sort in descending order, just click on the column header again.

The line below the column header can be used to specify filters. To specify a filter, you select a logical operator and a
value using drop-down menus, or windows respectively, below the respective column header. In the following example,
the logical operator menu of the Creation Date column has just been opened:
The set of available operators depends on the column type. For a text column a lot of additional operators, such as
Starts with, Ends with, or Contains etc., are available.
To specify a value, click on the down-arrow icon of the respective column that will appear when you move the mouse
cursor to the respective field below the column header. In the following example, value selection has just been opened
for the Creation Date column. Here a calendar window permits to select a date comfortably:
For other column types, a drop-down menu shows, amongst others, all values occurring in any line of the current report.
When you specify a filter for a column, a little clear filter symbol appears below the column header. To remove a filter,
click on this symbol.

Context Menu of Activities
If you click on selected activities in the Activities and Jobs view with the right mouse button, the following context
menu appears:
Delete
This command deletes the selected activities.
Suspend
This command transfers the selected activities to the Suspended state. While the activities remain in this
state, they will not be processed by the corresponding job step.
Resume
This command transfers selected activities from state Suspended to state Ready so that they are again
available for processing at their respective job step.
Reset to…
With this command you can reset selected activities to another job step. It shows a submenu with the available
job steps. Select the desired job step and click on it.
Abort
With this command you can abort selected broken activities. It is only available if all selected activities are in
state Broken.
Details…
This command opens the Activity Details dialog that makes detailed information about the activity and the
corresponding job available. It is only available while a single activity is selected.
Priority…
This command opens the Priority dialog where you can modify the priority of the selected activities, and of
the corresponding jobs:

Show Job
When you use this command, a job report with the associated job is shown. It is only available if a single
activity is selected.
View Input Files…
This command permits to view any input file of the selected activity. It is only available while only a single
activity is selected. It shows a submenu with the available input files. When you click on a file in the menu,
the file is opened in the corresponding viewer.
Context Menu of Jobs

If you click on selected jobs in the Activities and Jobs view with the right mouse button, the following context
menu appears:
Delete
This command deletes the selected jobs.
Details…
This command opens the Job Details dialog that makes detailed information about the job available. It is
only available while a single job is selected.
Priority…
This command opens the Priority dialog where you can modify the priority of the selected jobs:
Show Activities
When you use this command, an activity report with the associated activities is shown. It is only available if a
single job is selected.

Activity Details Dialog
The Activity Details dialog provides access to detailed information about an activity and the associated job. To open
the dialog, select an activity in an activity report in the Activities and Jobs view, and use the Details command in
its context menu, or the corresponding toolbar button. The General tab page shows general information, such as job
class, job step, state, priority. In addition, it shows the repository and folder, and permits to open them in the Windows
Explorer:
The History tab page shows the job steps, the corresponding job already went through:
When you select a job step, you can view additional details. When you select an activity and click on Details, a dialog
will show detailed information about the selected activity. With Reset you can reset the respective activity, if possible.
When you click on Input Files or Output Files, a dialog shows a list of the respective files. A double-click on a
selected image or XML file will open it.

The Error tab page shows error text and error details if an error occurred for the current activity. In the shown example,
the DOKuStar Extraction license could not be found, i.e. the dongle or the license file was missing:
The Advanced tab page shows internal state information. You won’t need it normally.
Job Details Dialog

The Job Details dialog provides access to detailed information about a job. To open the dialog, select a job in a job
report in the Activities and Jobs view, and use the Details command in its context menu, or the corresponding
toolbar button.
The General tab page shows general parameters of the job, e.g. job priority, state, and the repository and folder the job
resides in. The History tab page shows a list of all job steps the job went through. When you select a job step, you can
request additional information for that step:

When you click on Details, an Activity Details dialog opens and shows detailed information about the respective
activity.
A click on Reset will reset the respective job step, if possible.
When you click on Input Files or Output Files, a dialog lists the respective files. In the following example, the
output files of an Extraction jobs step have been requested:
A double-click or a click on Open for a selected image or XML file will open the respective file.

Scheduler Dialog
The Scheduler dialog permits to watch the activities of the job scheduler.
To open the Scheduler dialog, click on the respective link in a Services shape of a System window. If this link is
not yet present, add a Scheduler item to a Services shape on the System window by dragging it from the
Shapes view with the mouse.
The scheduler scans the available jobs regularly and protocols its activities in the message window.

CleanUp Dialog
During job processing a lot of temporary files are produced, that are no longer needed after the corresponding job has
been exported. In addition, there may be jobs that got terminated prematurely, or jobs that can’t be terminated properly
due to some problem and are hanging in the system permanently.
The clean-up service that is implemented as a windows service (name: DOKuStar CleanUp), checks data within the
DOKuStar Dispatch workflow regularly, and deletes data in accordance with specified parameters.
The activities of the clean-up service can be watched and controlled using the CleanUp dialog.
To open the CleanUp dialog, click on the respective link in a Services shape of a System window. If the link is
not yet present, you must add a CleanUp item to a Services shape by dragging it from the Shapes view with the
mouse.
The CleanUp service scans the available data regularly and protocols its activities in the message window. There you
can watch how much jobs, folders and data units have been deleted during the last activity of the service.

Options and Properties of the Clean-Up Service
The CleanUp dialogs permits to control the activities of the clean-up service.
Note: Normally you should not change these settings.
If you click on Show Params, the dialog shows the options and properties of the clean-up service. To be able to
change settings, click on Stop CleanUp at End of JobStep, to stop the activities of the clean-up service
temporarily. The settings will then become available in a few seconds:
The following options and properties are available:

Break running jobSteps older than
The clean-up service checks job steps regularly. Job steps that have not finished after the specified time will
be set to the state broken, is this option is marked.
Undo broken jobSteps
If this option is marked, job steps that enter the broken state will be reset and repeated automatically.

Abort broken jobSteps
If this option is marked, job steps that enter the broken state, will be set to state aborted automatically.
The broken state may be caused by the clean-up service due to a time-out, or it may be set by the job step
itself due to an error during processing.
Job steps with state aborted are shown in a special color in the monitor program. The state aborted can
only be revoked manually by the administrator; e.g. he could reset an aborted job step.
Close jobs waiting for termination since
If this option is marked, job steps that wait for termination for the specified time, will enter the closed state.
They will then no longer be shown in the activities list of the monitor program, but they are still present in the
system with their data.
Remove jobs terminated or aborted before
If this option is marked, jobs with the state closed or aborted will be removed with all their data and files
after the specified time has elapsed.
Abort sessions older than
If this option is marked, sessions that are older than the specified time, will be aborted together with their job
steps.
Remove unbound sessions created before
If this option is marked, sessions that are no longer active, will be removed.
Note: A session is created by the clients when they connect to the workflow in order to start operation. E.g. a Validation
session is created, when a Validation station is started. A Validation session is terminated when the Validation station is
terminated. A DOKuStar Professional client terminates a session automatically after some hours and creates a new one.
Remove empty folders older than

If this option is marked, empty folders that are older than the specified time, will be removed.
Remove data units older than
If this option is marked, data units that can be used for statistics, will be deleted after the specified time has
elapsed.
Defragment indices each
If this option is marked, the indices of the flow database will be defragmented regularly. As default, this will
be performed every two hours.
When you have stopped the clean-up activities in order to change settings, click on Run CleanUp afterwards to restart
the clean-up activities.
Note: Stopping the clean-up activities with the respective button of the CleanUp window is an internal software
feature that will not stop or terminate the windows service. If you terminate the windows service, the Administration
program will not be able to access the service. In this case the CleanUp window will display an error message and the
settings will not be available.

Periodical Tasks
Monitoring the System
It is recommended to monitor your DCS system at least twice a day.
• Check for broken jobs, analyze and solve the problems (see Broken Jobs: Trouble Shooting).
• Check the number of jobs waiting at the distinct job steps. If the number of jobs waiting at a specific job step
tends to increase stedaily, you will have to change the configuration of your system (see Increasing
Throughput).
Monitor your system more often
• if you always find many broken jobs, e.g. due to network problems,
• if your system has to process a very high number of documents,
• if your documents always have to be processed on the same day when they have been imported,
• in the first weeks after setting up your system.
Deleting Trace Files

Normally, each trace file will be automatically deleted after ten days, but trace files reporting an error will not be deleted
automatically. So check the trace folder twice a week and delete old trace files you don’t need.
Monitoring Flow Database Size

After validated document extraction results have been exported, the corresponding job data in the flow database will be
deleted automatically. So the flow database will only grow in the first weeks and then keep the same size. But if one day
the system has to process many more documents than usual, the flow database will grow again. So, monitor the flow
database size at least once a week. If you expect an unusual high number of documents to be processed, monitor the flow
database size more often.
Monitoring Reporting Data

If Reporting is used in your application, you should delete old reporting data regularly to prevent unrestricted growth of
the Reporting database. Start the Report Viewer and click Delete Data in the toolbar to open the Delete
Reporting Data dialog. As default this dialog suggests to delete data older than one year, but you can choose a
specific date instead.

ART and ACT Training
If ART or ACT modules are used in the DOKuStar Professional project, and documents are collected in a
DocumentsToTrain folder for an ART or ACT module, these documents should be trained regularly, to improve
recognition quality. When a training session is terminated, you should delete the contents of the corresponding
DocumentsToTrain folder, or the next session will again show the documents in the Training Client. The
documents are contained in files with extension .data that contain the images together with the recognition results
needed for training.
Monitoring the Size of ART Database Files

If ART training is performed regularly and unused samples are removed repeatedly, the file size of the ART database file
may increase considerably. If you detect that the file size of the database file is unreasonably large, you should reduce it.
There are two methods to reduce database size:
1. Perform a backup of the database and then restore it.
2. Install the SQL Server Management Studio Express. It can be found in the Components folder of the
DOKuStar Professional DVD. Start the Management Studio, connect to your SQL Server, open the
Databases node in the Object Explorer view, click on the ART database with the right mouse button,
and from the context menu under Tasks – Shrink select Database or Files.
Further Runtime Files

The files in the repository (see Repository) and the temporary files of DOKuStar Professional and DOKuStar Extraction
(see Temporary Files of DOKuStar Professional and DOKuStar Extraction) will be deleted automatically. You don't
have to delete these files manually.

Broken Jobs: Trouble Shooting
The following section provides an overview about problems and solutions concerning broken jobs.
• Error message: Operation: timeout expired
o Problem: The timeout is too low for a document consisting of many pages.
o Solution:
1. Stop the services on the Flow Server.
2. Start the DOKuStar Capture Suite Designer and open your DCS project file.
3. Double click on the job step Extraction and open the Project Settings dialog (menu
Project, command Settings).
4. On the Advanced tab change the timeout. Save the project.
5. Restart the services on the Flow Server.
6. Reset the broken job to the job step in which it got broken.
• Error message: Extraction failed, image file path longer than 240 characters is not
supported
o Problem: The path and filename for temporary files is too long.
o Solution:
1. Suspend all jobs in state Ready at DSP and Export job steps.
2. Wait until all jobs in state Working have terminated processing at DSP and Export job steps.
3. Now stop the remaining running jobs.
4. Stop the services on the Flow Server and on the Extraction Cluster Nodes.
5. Change the system and user temporary variables to a location with a short path, e.g. C:\temp
for all Extraction Cluster Nodes.
6. Start the services on the Flow Server and on the Extraction Cluster Nodes.
7. Restart the jobs.
8. Reset the broken job to the job step in which it got broken.
• Error message: Extraction process crashed
o Problem: Undefined problem in the Extraction process.
o Solution:
1. Reset the broken job to Extraction.

• Error message: Job Ticket file not existing
o Problem: Job ticket file could not be written or could not be read maybe due to network problems.
o Solution:
1. Reset the broken job to the job step that precedes the job step in which it got broken.
2. If the job gets broken again, find the image name in the error message of the broken job, delete the
broken job and import the image again.
• Jobs remain working in the Extraction job step
o Problem: Extraction Cluster Node is not working correctly.
o Solution:
1. Restart the Load Manager Service of the respective Extraction Cluster Node.
2. Then the jobs become broken (Error message: Operation orphaned, cluster node
<cluster node name>).
3. Reset the broken jobs to Extraction.

Backups of the Dispatch Repository
Overview
If you want to backup the current data of the DOKuStar Dispatch, you will have to stop processing first, in order to bring
DOKuStar Dispatch into a state, where it could restart on the current data.
Afterwards you will have to save the data in the repository together with the corresponding administration data contained
in a database.
When the backup has been performed, data processing with DOKuStar Dispatch may be continued.
In order to restore data from a backup after some kind of a crash, you will again have to stop processing first. When you
continue processing following a restore, some jobs, that were already processed and whose data have already been
exported, will again wait for processing or be waiting at some processing step. Therefore you will have to do some clean-
up, in order to remove jobs that were already processed. Or the application will need a mechanism to remove results of
jobs that were processed twice. Thus, to be able to use backup and restore in a meaningful way, an application needs a
concept and according rules, how to perform a restore and necessary clean-up operations.
Note: It is recommended to use a high availability configuration for your DCS system (see chapter "Providing High
Availability") instead of a backup-recovery strategy.
The following sections describe how to perform a backup.
Stopping Processing
Before you can backup the data of DOKuStar Dispatch, you need to stop processing. This requires the following steps:
• Make sure that no new jobs will be imported.
• Start the DCS Administration and suspend all jobs in state Ready at a DOKuStar Professional job step.
• Wait until all jobs in state Working have terminated processing. Validation operators should complete their
current document, then close it, and exit Validation.
After processing has stopped completely, stop all services, and then stop the service SQL Server (DOKuStar). For
the last service use the Services dialog of the Administrative Tools of the Windows Control Panel, or add this
service to the Services shape of the DOKuStar Capture Suite Administration.
96 • Backups of the Dispatch Repository DOKuStar Capture Suite Administrator's Guide

Backup Data
To backup the current data of DOKuStar Dispatch, you should backup the repository as well as the database containing
the administration data of DOKuStar Dispatch by copying the respective files and folders.
Normally the repository will reside in the Repositories subfolder of the configuration folder.
The database file DBFLOW.mdf can be found in a subfolder of the folder Captaris\databases under the program
files folder.
Starting the Services

When the backup is complete, restart the SQL Server (DOKuStar) service, the DOKuStar Flow service, and the
remaining services of DOKuStar Dispatch. To start processing, use the Resume command on all suspended jobs in the
DCS Administration.
Restoring Data
If you need to restore data from a backup, again stop processing as described above, and wait until processing has
stopped completely. Then restore the repository and database files and restart the services and suspended jobs.
DOKuStar Dispatch will now start processing with the current data. Jobs that have been processed and exported, after the
backup has been performed, may now be processed and exported a second time, and jobs that were created between
restore and backup and were still unfinished will disappear. So some cleaning up will have to be done to remove
duplicate jobs or results, or to re-import documents for lost jobs.
DOKuStar Capture Suite Administrator's Guide Backups of the Dispatch Repository • 97

Backups of the ART Database
To be able to administer the ART database of your DCS system, start the DOKuStar Professional Visual Designer and
use the ART Repository Explorer command of the View menu. The ART Repository Explorer view opens.
This view permits to administer ART repositories on different computers using the context menus and the toolbar of the
view.
To be able to access a repository on a computer, the computer must be registered first using the command Register
Computer in the context menu or the toolbar of the view. Registered computers are shown as root nodes in the view.
If you register the computer hosting the ART database (in the standard configuration the Flow Server), a repository node
for the ART database will be shown as sub node of the computer node.
The context menu of the repository node provides menus for backup and restore. Refer to DOKuStar Professional
Developer’s Guide, chapter ART Repository Explorer View for further information.
98 • Backups of the ART Database DOKuStar Capture Suite Administrator's Guide

Backups of the ACT Database
To be able to administer the ACT database of your DCS system, start the DOKuStar Professional Visual Designer and
use the ACT Repository Explorer command of the View menu. The ACT Repository Explorer view opens.
This view permits to administer ACT repositories on different computers using the context menus and the toolbar of the
view.
To be able to access a repository on a computer, the computer must be registered first using the command Register
Computer in the context menu or the toolbar of the view. Registered computers are shown as root nodes in the view.
If you register the computer hosting the ACT database (in the standard configuration the Flow Server), a repository node
for the ACT database will be shown as sub node of the computer node.
The context menu of the repository node provides menus for backup and restore. Refer to DOKuStar Professional
Developer’s Guide, chapter ACT Repository Explorer View for further information.
DOKuStar Capture Suite Administrator's Guide Backups of the ACT Database • 99

Removing the Software
During setup, several components are installed that will show up separately in the Windows Control Panel. For a
complete installation this will comprise the following:
• DOKuStar Capture Suite
• DOKuStar Validation V4.0 SR01,
• DOKuStar License Manager,
• Microsoft SQL Server 2005,
• Microsoft SQL Server Native Client,
• Microsoft SQL Server Setup Support Files
• Microsoft SQL Server VSS Writer,
• WIBU-KEY Setup (WIBU-KEY Remove).
If you want to upgrade to a new build or release, you could only remove components that will have changed using the
Control Panel. Normally, this will be at least DOKuStar Capture Suite. Please refer to the Administrator’s Guide of the
new release.
Removing the software components will not remove all files. Besides others, the repositories and some configuration
files will not be removed automatically. To completely remove the software, go to the installation path (normally
Program Files\Captaris on an English language system) and delete the folders of the respective components. In the
same way remove the folders DOKuStar, LicMan and Tracing in the sub-folder Captaris of the common files
folder.
Normally you will not remove the .NET Framework, even if you did install it only for this product, because it is required
by an increasing number of software products.
100 • Removing the Software DOKuStar Capture Suite Administrator's Guide

Working with Hot Spots
Hot Spots - An Overview

Hot Spots provide an easy way to implement an automatic import into the DOKuStar Capture Suite using DOKuStar
Professional. The files that should be processed can just be transferred to some input source that is specified as a Hot
Spot. The Hot Spot will fetch the files and call DOKuStar Professional automatically. The DOKuStar Professional
project will contain just a single project module that imports the current Runtime Document into the workflow.
The Hot Spot service can watch any number of input sources. Each input source can either be a base folder on a file
system, a remote folder on an FTP site, an e-mail folder, or a SharePoint list. Each Hot Spot can be administered
separately, i.e. you can create, start, stop, activate, or delete any Hot Spot at any time, independent of the state of other
specified Hot Spots.
At specified scheduling times, the service will transfer all documents found in an input source to an internal folder were
they are waiting for processing. When a document could be transferred successfully, it is then deleted from the input
source. If an error occurs during transfer, the document will remain in the input source and a transfer error is reported in
the Configuration dialog.
Documents waiting in the internal folder are then processed using the specified DOKuStar Professional project. If an
item has been processed, it will be transferred to an internal Done folder.
If an error occurs during processing, the document is transferred to an internal Error folder, and a processing error is
reported in the Configuration dialog. If the problem could be fixed, processing can be restarted for those documents.
Hot Spots can be processed in two different modes: either by a Windows service or by a program.
During installation, a service DOKuStar HotSpot 3.0 is created with startup type manual. To use the service, start
the service and change its startup type to automatic. To configure and administer the Hot Spots, use the configuration
program that can be found in the Tools menu of the DOKuStar Capture Suite program group.
To work with the program, start the Hot Spot Tray that can be found in the DOKuStar Capture Suite program group.
The program adds an icon to the system tray. To configure and administer Hot Spots you can open the Configuration
dialog using the context menu of this icon.
You can’t use both Hot Spot modes at the same time. E.g., if the tray program is active, the Windows service can’t be
started.
Note: The path to the input files in the DOKuStar Professional cache is quite long. Its length depends on the path of the
user temp folder, and with default setting on the user name and system language. In addition, processed versions of the
input files with extended file names will be created. Therefore you shouldn’t use long file names for input files.
Otherwise errors could occur because the full path name of some files exceeds the maximum path length.
DOKuStar Capture Suite Administrator's Guide Working with Hot Spots • 101
Configuring Hot Spots
Creating Hot Spots
To be able to configure Hot Spots, open the Configuration dialog:
If you use the Windows service DOKuStar HotSpot 3.0, start the configuration program you will find in the Tools
menu of the DOKuStar Professional program group.
If you use the Hot Spot program, start the Hot Spot Tray from the DOKuStar Professional program group. The
DOKuStar Spot tray icon ( ) appears in the system tray. Its context menu permits to open the Configuration
dialog:
The Configuration dialog opens:
To create a new Hot Spot, click on New and select the desired Hot Spot type from the context menu:
102 • Working with Hot Spots DOKuStar Capture Suite Administrator's Guide
Configuring Polling Cycle and Project File
For each Hot Spot, you can specify a source name that will appear in the Name column of the configuration dialog:
For all Hot Spot types, you can configure the polling cycle in the Scheduling section of the Configuration dialog.
With the default settings, the Hot Spot will be polled every minute each day. When you select the option Workdays,
polling will be restricted to Monday through Friday. If you select Custom, you can specify weekdays as required. On
the right side you can specify a polling period in minutes, or a polling period in hours. If you select Fixed time, the
Hot Spot will be polled only once a day at the specified time.
Under DSP project you have to specify the DOKuStar Professional project that should be used to process the
incoming documents. When you click Browse, a file dialog opens. Go to the project folder, select the project file
(extension .sitemap) and click Open. When you click New, the Visual Designer starts and the New Project
dialog opens so that you can immediately create a new DOKuStar Professional project.
Configuring a Hot Spot of Type File System
For a Hot Spot of type File system, the hot spot service will control the specified file folder at the specified
scheduling times (and all its subfolders, if specified). All found input files matching the specified file filter will then be
transferred to DOKuStar Professional for processing.
Besides name, scheduling options, and the DOKuStar Professional project, you have to specify the file folder that should
be watched and additional options as needed:
To specify the file folder, click the button following the Folder field. A folder dialog opens. Go to the desired folder
and confirm with OK.
At Input file filter you can specify one or several file extensions that should be watched and processed. As default, all
files will be watched. The file extensions specify a file type; i.e., if you specify .tif this will also include files with
extension .tiff.
If you mark the option Include subfolders, all subfolders of the specified folder will also be watched. As default, a
separate Runtime Document will be created for each file found in a subfolder, i.e. the files will be processed
independently.
When you mark One job for all files in folder, you will also have to specify a file name for a signal file. In this
case, a single Runtime Document will be created for all files contained in a single subfolder at the time when the signal
file is detected. Thus all these documents will be processed as a batch in a single processing step. Take notice that very
large may need much processing time and may be terminated due to timeout. A reasonable batch size would be up to
about 100 images. If the folder size exceeds 5 MB, you will also have to check the option Activate large image
handling.
If several subfolders with documents are found, a separate Runtime Document will be created for each folder containing
a signal file with the specified name.
When you mark Delete folder, a subfolder will be deleted as soon as all files have been transferred and deleted.
Very large image files exceeding 5 MB must be handled differently. To process large image files, mark Activate
large image handling, and specify a shared network folder that can be accessed from all computers of the
extraction cluster.
Configuring a Hot Spot of Type FTP

For a Hot Spot of type FTP, the Configuration dialog looks like this:
Besides name, scheduling options, and the DOKuStar Professional project, you have to specify the properties for the
FTP connection. When you have entered user name, password, server name and the path to the remote folder, you can
click Check connection in order to check whether the FTP location can be reached with the specified parameters.
Configuring a Hot Spot of Type Mail
For a Hot Spot of type Mail, the Configuration dialog looks like this:
Besides name, scheduling options, and the DOKuStar Professional project, you have to enter the parameters needed to
access incoming emails. You can then click Check connection in order to test whether the specified email server
can be accessed with the specified properties.
If the IMAP protocol is used, you have to specify the folder that should be watched. Choose a folder from the drop-down
menu of the Folder field. To show the current folders click on Update.
As default, processed emails will be deleted. If you mark the option Mark as deleted, the emails will not be deleted,
but just marked as deleted.
If you want to use a secure connection, mark the respective option and click Advanced. The SSL Settings dialog
opens:
As default, a Runtime Document containing all attachments of the mail will be created, while the body text of the mail
will be ignored. When you mark the option Attach body as TIF file, the body text will be converted to a binary
image, and the Runtime Document will contain the mail body as main document and the attachments as subdocuments.
Configuring a Hot Spot of Type SharePoint

For a Hot Spot of type SharePoint, the Configuration dialog looks like this:
Besides name, scheduling options, and the DOKuStar Professional project, you have to specify a user account and the
SharePoint source.
If you want to use the current user account, you can accept the default option in the Login section. If you need to user
another user account, select the second option, and enter user name and password.
To select a SharePoint source, click on the button behind the List field. The SharePoint Selector dialog opens.
Enter the address of the SharePoint server into the Site field, and click the Refresh button:
The available web sites and lists will then be shown. Now navigate to the desired web site on the SharePoint server. To
open a web site, double-click the respective row. To return to an upper level click the Up one level button. When you
have reached the correct web site, select the desired SharePoint list. Its address will then be shown in the Url field.
When you select an item, the corresponding address will be shown in the Url field. Select the desired source. Confirm
with OK. The address of the selected SharePoint list will now appear in the List field of the configuration dialog.
Administering Hot Spots

To administer Hot Spots, click on the Hot Spots icon in the system tray with the right mouse button and choose
Configuration from the context menu. The Configuration dialog opens. It shows all configured Hot Spots. When
you select a Hot Spot, you can administer it using the toolbar or the context menu of the dialog:
The Name column shows the name you specified at the Source name field during configuration of the respective
Hot Spot. Location indicates the location of the Hot Spot, for example the path of a file system folder, or the library
name of the specified SharePoint library.
The State column shows the current state:
• If the Hot Spot has just been configured or stopped, it is in state Disabled, i.e. it is not working. Use the
Start command or toolbar button to activate the Hot Spot. In this state you can delete the Hot Spot, if it is no
longer needed.
• If the Hot Spot has been started, but is currently waiting, it is in the state Scheduled. If you want to disable
it, use the Stop command or toolbar button. If the Hot Spot should process documents immediately, use the
Run Now command or toolbar button.
The Last run column shows the last polling time, and how many documents could be transferred from the input source
to the internal working folder.
The Processing column shows the number of documents that are waiting for processing in the internal working
folder.
The Message column will show an error message, if a document is in error state. In this case use the command
Transfer and Processing Details in the context menu of the Hot Spot to show detailed information. A dialog
will show detailed information about the data transfer from the input source to the internal working folder in its
Transfer tab page:
In the above example, some document files could not be read or deleted so that they cannot be processed properly.
The Processing tab page will show detailed information about errors that occurred during document processing
within DOKuStar Professional:
If a processing error occurs, the Hot Spot service transfers the document into an internal error folder.
If the problem has been solved, you can restart selected documents or all documents by clicking on Restart, or
Restart All respectively. If some document causes an error that can’t be fixed, you can remove the document from the
Hot Spot service using the Remove button.
The Hot Spot service will move the result file, a Runtime Document containing the source documents, to an internal
Done folder as soon as a document has been processed successfully.
Reporting
Introduction
If the Reporting feature has been installed, you can collect data for reporting in a special reporting database during
document processing. Later you can use the Report Viewer to create standard reports or to create templates for your own
reports.
To be able to use Reporting, you first have to start the Create Reporting Database Wizard on the computer that
should be used as Reporting server. It will create the reporting database where data collected for reporting will be stored.
For Recognition reports, you have to add a Reporting module to all processing pipelines of your DOKuStar
Professional project. This module will write data to the reporting database that are needed for the standard reports
supplied by DOKuStar Professional. Start the Visual Designer, open your project and add the Reporting module to the
end of processing pipelines, but preceding the DispatchWriter module. Select the module, and in the Properties
view enter the computer name of the reporting server at the Server property.
For Validation reports, you have to configure Validation so that it will write statistics data to the Reporting database.
As soon as data have been collected in the reporting database, the Report Viewer permits to create some standard
reports.
DOKuStar Capture Suite Administrator's Guide Reporting • 111

Initializing Reporting
To be able to use Reporting, it must be initialized and a Reporting database must be created. To do this, call the Create
Reporting Database Wizard on the computer that will be used as Reporting server. You will find the wizard
under Tools in the program group:
Confirm the welcome screen with Next. The Service dialog appears:
The wizard starts the Reporting service and tries to connect to the service. The dialog will indicate the current state. As
soon as it has established a connection to the service, you can proceed with Next. The Server dialog is shown:
112 • Reporting DOKuStar Capture Suite Administrator's Guide

The wizard tries to establish a connection a DOKuStar instance as default. As soon as the connection is established,
you will be able to confirm with Next.
If you need to use another instance, e.g. if a former version of DOKuStar Professional was installed previously that used
an ART instance, establishing a connection will fail. In this case click on the button behind the SQL Server field. The
Set Database connection dialog appears:
Enter <servername>\<instancename>, e.g. .\ART for an ART instance on the local machine. As soon as
you confirm with OK, the wizard again tries to connect to the specified instance. As soon as a connection could be
established, you can confirm with Next.
If a reporting database already exists on the specified SQL instance, the following dialog will appear.

There can be only a single reporting database on an SQL instance. If you still want to create a new database, mark the
option and confirm with Next. Otherwise you can either cancel the wizard and work with the existing database, or go
back and choose another SQL instance.
The wizard is now ready to initialize Reporting. When you click Next, the Initialize Reporting dialog is shown and
the wizards indicates progress on this dialog widow:

If a reporting database already exists, it will be deleted as first step.
As second step, the wizard creates the reporting database and all needed reference data. This will take some time.
Then the wizard configures the Windows Firewall, and as last step it configures the reporting service and restarts it.
As soon as initialization is complete, you can confirm with Next. Reporting is now ready for use. Confirm the last
dialog with OK:

Report Viewer
Overview
To create reports, start the Report Viewer that you will find under Tools in the program group:
In the Report section, you will find three standard recognition reports, and – if the feature Administration has been
installed - a Validation report.
To create a report, select the desired report type.
All standard reports cover a specified date range. To modify start or end date, you can edit the date fields directly, or
click on the arrow symbol to show a calendar:
In addition, the standard recognition reports always include all processed documents of a specified category. The
Reporting module uses the project name as category. To select a category click on Load categories first. The
viewer then determines all categories that can be found in the reporting database and the Category field becomes
available. Open its drop-down menu and select a category.

Note: The Reporting module stores data locally, if the Reporting service is not available and tries to transfer stored
data regularly. If data seem to be missing, check whether the service DOKuStar Reporting 3.0 is started on the computer
used as Reporting server.
In the Description field you can enter a short description that will appear in the header of any report
Toolbar of the Report Viewer
Global Options
When you click this button, the Global Options dialog is shown:
With Load file you can load another image that will be shown in the header of reports.
Browsing
With theses buttons you can browse through the pages of a report stretching over several pages.
Zooming
Here you can enlarge or reduce the currently displayed report. With the drop-down menu you can select
predefined zoom factors. If you click on one of the last two buttons, you can enlarge or reduce the report by
clicking on it. To terminate a zoom mode, click on the button with the hand symbol.
Print all
Prints all pages of the currently displayed report.
Export
A drop-down menu permits to save the currently displayed report as PDF file, Excel sheet, as HTML page, as
rich text file, or as TIFF image.

Delete Data
When you click Delete Data, the Delete reporting data dialog opens and permits to remove old
reporting data from the Reporting database:
As default, data older than one year will be deleted when you click OK. From the drop-down menu you can
select another predefined range. When you select the last item Older than, the date field becomes available.
If you now click the arrow behind the date field, a calendar is shown where you can select another date. When
you confirm with OK, a dialog box will display the number of items that have been deleted. To close the
dialog, click Cancel.
Exit
Terminates the Report Viewer.
Changing the Reporting Database

The status bar of the Report Viewer shows the name of the current database file. To switch to another file, double-click
the database file name:
The Database Connection dialog opens:
Here you can switch to another Reporting database. Enter computername\instancename in the Server field.
When you changed the server, click Update to show the database files available at the specified SQL instance. Then
select the Reporting database from the drop-down menu of the Database field. With a click on Check
Connection you can test whether the specified server can be found.
Note: Make sure that the Windows users accessing the Reporting database need login and read access within the SQL
Server.

Classification Report
The Classification report shows, how much documents have been classified to the different document classes during
the specified date range. To show the properties of the report, select Classification Report in the Report section:
Specify the desired date range, click Load categories, open the drop-down menu of the Select category field,
select the desired category and then click Create Report. The report shows the number of documents that have been
classified to the different document classes as number of documents and as percentage. The following example shows
the classification report after all test images have been processed with the DOKuStar Capture Suite example application:

Document Hit Rate Report
The Document Hit Rate report shows, whether all specified fields could be found an each processed document
during the specified date range. If you mark the option Show field matrix, an additional table shows in detail which
fields were found on each document.
To show the properties of the report, select Document Hit Rate in the Report section:
Specify the desired data range, click Load categories, open the drop-down menu of the Select category field,
select the desired category, and then go to Select class and select a document class. The Select Fields section will
then show all available index fields of the specified class. If you don’t want to include some fields in the report, unmark
these fields and then click Create Report.
The following example shows the report for the Mileage class of the example application. It shows that not all fields
were found on the test documents:
With the option Show field matrix marked, the additional table shows the detailed results:
Note: Please take notice that table fields are not included in the Field Hit Rate report.

Field Hit Rate Report
The Field Hit Rate report shows, how many of the specified fields could be found on each document processed
during the specified date range as count value and as percentage. If you mark the option Show field matrix, an
additional table shows in detail which fields could be found on each document.
To show the properties of the report, select Field Hit Rate in the Report section:
The following example shows the report for the Mileage class of the example application. It shows that not all fields
were found on the test documents:

With the option Show field matrix marked, the additional table shows the detailed results:
Note: Please take notice that table fields are not included in the Field Hit Rate report.
Interaction Summary Report

The Interaction Summary report shows statistical data about user interaction in Validation for each field of the
documents of the specified job class. Besides the average number of mouse clicks and key strokes, average time the field
was selected, and average change rate are listed for all specified fields.
To be able to create a report, collecting of interaction statistics must be activated for Validation.
Take notice that the report is only available on machines where the feature Administration has been installed.
The report shows a line for each specified field. All columns show mean values for mouse clicks divided in SCE (Single
Click Entry) and other mouse clicks, number of key strokes and number of character key strokes, the mean time the field
was selected, and the mean number of changes for the respective field as percentage. Change rate and time spent on the
field are also shown graphically.
The report gives a rough overview about the activities of the Validation operators and thus also yields some information
about recognition quality. If a field as present on all documents, a low change rate indicates that the field could be read
correctly on most documents. High counter and time values may indicate that a field causes much work in Validation due
to bad results.

The following example shows the report for the Invoice class of an invoice processing application:

Activating Interaction Statistics
As default, Validation will not collect statistics data, and the Report Viewer will in this case indicate that no data are
available for an Interaction Summary report.
To activate data collecting, the Validation configuration file (<job_step-Name>.dfsval) in the configuration
folder:
DOKuStarDispatchData\config\<ProjektName>\<JobClassName>_Steps\<JobStepName>.dfsval
has to be modified:

<ValidationConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" UID="2a921496-3620-47ef-8e8c-410adb549103">
<ActivateAdminMode>true</ActivateAdminMode>
<ActivateIdisInfo>false</ActivateIdisInfo>
<MasterSchema>Recognition</MasterSchema>
<ValidationProjectFileName>MyInvoicesFlowProject\Invoices_Steps\Validation\Validation.vpj</Validation
ProjectFileName>
<BatchMode>DocumentBatch</BatchMode>
<WriteDataUnitBeforeValidation>false</WriteDataUnitBeforeValidation>
<WriteDataUnitAfterValidation>false</WriteDataUnitAfterValidation>
<WriteStatisticsAfterValidation>true</WriteStatisticsAfterValidation>
</ValidationConfig>
Statistics data will be collected if the tag WriteStatisticsAfterValidation is present and has the value true. As
default, the tag will have the value false. In projects created before installing Service Pack 1, the tag will be missing.
As default, Validation assumes that the Reporting Server has been created on the Flow Server. If you use another
computer as Reporting Server, you have to add a StatisticsServiceUrl tag to the configuration file
ServerConfig.dfc. In the following example, replace SERVERNAME with the computer name of the Reporting
Server:

<ServerConfig...>
...
<StatisticsServiceUrl>net.tcp:SERVERNAME:23050/StatService</StatisticsServiceUrl>
...
</ServerConfig>

Load Manager
Introduction
The DOKuStar Load Manager enables load balancing of DOKuStar Professional Runtime jobs in a cluster of multiple
computers and CPUs, i.e. it spreads the work between two or more computers and CPUs to maximize throughput and to
provide a scalable performance.
The load manager is a windows service and must be installed on every computer that participates to the cluster. There is
one load manager that is configured to control load balancing, this is called the master. The master receives job
requests from a client application, e.g. from the flow service of DOKuStar Capture Suite or from the SAP adapter in
Invoice Capture Center, and distributes these jobs over cluster nodes. A cluster node is the instance that processes
the job and is spawned as a discrete process. The cluster configuration is managed centrally at the master.
The other computers in the cluster acts as slaves, their load managers only wait for requests of the master, to start and
stop cluster nodes on that slave and to pass through the requests from the master to the cluster nodes.
When a client send its first job request and no cluster nodes are configured at the master, the load manager configures
automatically as many cluster nodes as CPUs the master machine has. Slave cluster nodes are not automatically
configured.
The load manager processes a job request by managing operations. The Load Manager keeps a list of processing and
pending operations and manages them until their execution has been completed or until the load manager is shut down.
DOKuStar Capture Suite Administrator's Guide Load Manager • 125

Dispatching jobs
When a client sends a job request, the load manager creates an operation and inserts it in a queue. The operation changes
its state to pending. A dispatch mechanism processes the queue and distributes the operations one after another to the
next free cluster node. The operation changes its state to processing.
Reducing Unnecessary Re-initialization

While distributing operations, the dispatch algorithm takes care to pick cluster nodes that are already initialized with the
appropriate profile (named container for initialization parameters). This will reduce unnecessary re-initialization and
improves performance. Profiles are automatically created by the client application when sending the first job request.
Exclusive Profiles
You may configure a cluster node to work exclusively on one or more specific profiles. The dispatch algorithm will then
distribute all operations for the specified profile exclusively to this cluster node. In addition operations with this profile
will be processed immediately even if they are queued in a late position. As an example, in DOKuStar Capture Suite it is
meaningful to configure a cluster node exclusively for processing of profiles for exporting. This ensures that once an
extraction job has finished the job will be exported immediately.
Failover
The load manager supervises the cluster nodes. It pings the cluster node process every minute. If the cluster node crashed
a new cluster node process is created automatically. The timeout for an operation processed by a cluster node is also
managed. If the time expires, the cluster node process is reset, i.e. it is killed and a new node is created while the
currently processing operation will fail. To avoid memory leaks, a reset is done anyway after the cluster node has
processed 200 (configurable) operations.
Monitoring
A monitoring tool (Load Manager Monitor) permits to configure the Load Manager, and to watch its activities.
This tool displays, among others, the status of all cluster nodes and operations.
Starting the Load Manager

The Load Manager is a Windows service and is started automatically after installation and at every system start. To start
or stop the Load Manager service, use the Windows Control Panel. In the Windows start menu, click on Settings
- Control Panel - Administrative Tools – Services. In the list of services you will find an entry with the
name DOKuStar Load Manager 3.0.
126 • Load Manager DOKuStar Capture Suite Administrator's Guide

Monitoring
The Load Manager Monitor provides a user interface for administration and monitoring of the Load Manager
activities. You will find it in the DOKuStar Capture Suite program group.
The Load Manager Monitor shows four tab pages:
Overview shows the workload graphically,
Cluster Nodes shows state and activity of the different cluster nodes,
Operations shows the current operations and their states,
History lists the previously terminated operations.
Overview Tab Page

The Overview tab page shows the activity of the complete cluster graphically:
On the left side you can see the percentage of cluster nodes that are currently working. On the right side the history of the
workload for the last few minutes is shown graphically.
The Nodes section shows the number of nodes that are online, offline, or suspended. A click on Show cluster
nodes details will activate the Cluster Nodes tab page.
The Operations Summary section shows the number or operations that are working, or pending, respectively. A
click on Show operation details will activate the Operations tab page.

Cluster Nodes Tab Page
The Cluster Nodes tab page shows detailed information about all configured cluster nodes
Column:
Column Description
State Startup Cluster node is starting up.

Ready Cluster node is ready for operation.
Processing Cluster node is executing an operation.
Suspended Cluster node is suspended, no operations will be dispatched to this node.
Offline Cluster node is off line e.g. slave PC is off or network is disturbed.
Error Cluster node has failed and will be restarted, this may take up to 2 minutes
Closing Cluster node is closing e.g. due to a reset or a changed configuration.
Name Cluster node name composed of computer name, service type, and instance number.
Profile Currently loaded profile.
Client Client that started the currently active operation.
Total Time Total active time of the cluster node since the load manager started.
Operations Number of processed operations since the load manager started.
To configure a cluster node, click on the cluster node line with the right mouse button. A context menu with the
following commands appears:

Command Description
Suspend Cluster Node Excludes the cluster node from load balancing. A currently active
operation will be completed before suspension takes effect.
Release Cluster Node Releases a suspended cluster node to rejoin the load balancing.
Lookup Cluster Node Updates the cluster node state (normally the Load Manager updates it once
per minute).
Reset Cluster Node Terminates the current instance of the cluster node and starts a new one.
Operations Tab Page

The Operations tab page shows detailed information about all operations that are waiting or just in progress:
Column Description
State Pending Operation waits for processing..

Processing Operation is being processed.
OK Operation has been completed successfully.
Error Operation has terminated with error(s).
Cluster Node Name of the cluster node that currently processes this operation.
Profile Profile used by the operation.
Client Client that started the currently active operation.
Started at Time when the Operation started.
To cancel an operation, click it with the right mouse button, and click on Cancel Operation in the appearing context
menu.

History Tab Page
The History tab page shows information about all operations that were processed since the Load Manager Monitor was
started:
To show detailed information about an operation, double-click on the respective line. The Trace Message dialog
opens and shows the corresponding trace data about the operation, e.g. error messages). To switch to the previous or next
operation in the list, use the arrows in the upper right corner:
The history is also stored as a file in the directory %ALLUSERSPROFILE%\Application Data\Open

Text\Trace\DOKuStar Load Manager\LM….log and may be viewed with a text editor or with the
DOKuStar Trace Viewer located in %CommonProgramFiles%\Open
Text\Tracing\TraceViewer.exe. One file is produced per day.
Please take notice that the Application Data folder is a hidden folder by default. Therefore you won’t see it in
the Windows Explorer if it is not configured to show hidden files and folders. The directory name depends on the
operating system language. E.g. on a German system the directory name is Anwendungsdaten.

Configuration
The Load Manager must be configured only on the master PC in the cluster.
To open the Configuration dialog, use the Configuration command of the Tools menu of the monitor:
In the explorer view on the left side yon can use the context menus of the different nodes, to add or delete computers or
to add or remove cluster nodes. If you select a node, its properties are shown in the right part of the dialog.
Configuring Cluster Nodes

To configure the cluster, create a computer node for each computer of your DOKuStar Professional cluster, using the
command Add Computer to Cluster in the context menu of the Cluster node:
The Computer dialog opens:
Enter the computer name and confirm with OK. A new computer node appears for the respective computer.

On each computer add at least one Runtime node. On a computer with several processors you should add nodes for
each processor, or processor core respectively. The context menu of the Runtime Nodes node permits to specify the
required number of Runtime nodes:
This command will leave exactly the specified number of nodes behind. E.g. if currently two nodes exist and you specify
1, the second node will be deleted.
For a computer with two processors or cores, the configuration should look as follows:
If your project contains pipelines with different DOKuStar Extraction projects, you could specify two Runtime nodes
for each processor. Otherwise the Load Manager would sometimes have to reload a project if needed.
The configuration permits to create up to 200 Runtime nodes on a single computer. With a high number of processing
nodes you will also need more RAM to be able to use them effectively or throughput will decrease because of increased
swapping. Each cluster node will require about 200 MB.
On the cluster master, the Load Manager will create Runtime nodes for all processors or processor cores
automatically, as soon as the first operation is started. Therefore you need to configure only the additional computers of
the cluster.
Note: In rare cases, if the option Run extraction using the load manager has been marked in the properties of
the Extraction module in the DOKuStar Professional project, you will have to create separate Extraction nodes. In
this case add an Extraction node for each Runtime node on each computer.

In order to achieve optimal load balancing, the following formulas should be used for each computer in the cluster
(including the master):
Number of DOKuStar Professional Number of processor cores * number of runtime profiles

runtime nodes ( = number of sitemaps, usually 1).
Number of Extraction nodes (only, if Number of processor cores * number of extraction profiles
option Run extraction using the (normally one; two, if a two-stage recognition is
load manager has been marked!) configured with classification in the first stage and
indexing in the second stage).
When a cluster node is selected, its properties are shown on the right side:
Property Description
Name Cannot be edited; comprised from the computer name, service type and instance number.
AgentUrl Cannot be edited. Specifies the URL of the agent service for this cluster node within the
cluster. To edit the computer name, select the parameter line and then click on the button at
the end of the line.
Description Only for logging purposes.
Exclusive Profiles Permits to restrict a cluster node to specified profiles (see below).
Priority Specifies the priority of the cluster node. The Load Manager will prefer cluster nodes with
higher priority.
If you click on the button at the end of the Exclusive Profiles property, the Choose Profiles dialog opens:

To restrict the cluster node to specific profiles, select the desired profiles and move them to the Selected Profiles
list by clicking on the right arrow button. Before any documents have been processed, the Available Profiles list will
normally be empty, because profiles are created automatically during processing. Therefore you will have to process
suitable documents, before you can use this feature. If the names of the profiles are already known, you can type them
into the field at the top of the dialog as comma-separated list.
Properties of the Cluster Node

When you select the Cluster node, its properties appear on the right side:
LookupInterval Specifies the time interval after which the Load Manager will check whether the cluster
node is still alive.
Profiles This property can be used to view the profiles. Select the property and click on the button
that appears at the end of the line to open Profile dialog.
Reset Cycle After the specified number of operations the cluster node will be reset automatically. This
can also be used to ensure that the project will be reloaded. This may be needed to activate
new versions of database files for an Extraction project-
Reset on failure If this property has the value True, the Load Manager will try to reset the cluster node in
case of failure.
Startup Time Specifies the maximum time the cluster node should need for start-up.

Profiles
For each Extraction project that has to be processed, the Load Manager will automatically create a new profile. To show
a list of all available profiles, select the Cluster node in the Configuration dialog, then select the Profiles
property and click on the button at the end of the property field:
The Profiles dialog opens and shows a list of all ´profiles. For the selected profile, properties are displayed:
On a production system, the profiles normally won’t require administration. If you work with many different projects on
a test system over some time, the number of profiles will increase steadily and you could decide to remove profiles that
belong to obsolete projects and are therefore no longer needed.

Name Arbitrary, unique name for referencing the profile.
Description Only for logging purposes.
Initialization Initialization data for the cluster node. To receive a dialog box, click on the button with the three dots.
Priority Profile priority (proportional to the given value, negative values are valid).
ServiceType Specifies the service type. To select the service type from a list, click on the button with the three dots.
Available in the current version:
DOKuStar.Cluster.Extraction DOKuStar Extraction
DOKuStar.Runtime.RuntimeProcessorModule DOKuStar Professional Runtime
The service type binds operations to cluster nodes. The Load Manager dispatches operations of this service
type to cluster nodes that can process this service type (see also ServiceType regarding cluster nodes).
Timeout Maximum runtime of an operation. If runtime exceeds this value, the operation will be cancelled.
Important Note: All file and folder names must be given as UNC names, because remote file access may be required
within a cluster node configuration.
The Load Manager configuration data are stored in the XML file DOKuStarLoadManager.config in the folder
Documents and Settings\All Users\Application Data\Captaris\DOKuStarLoadManager and contains:
• Configuration of the profiles
• Configuration of the cluster nodes
Error Documents
In the case of a DOKuStar Load Manager failure, please secure and provide the following information:
• Description of the error situation.
• All log files in the directory %ALLUSERSPROFILE%\Open Text\Trace and its subfolders.
• If possible, the documents (image files) causing the error.

Tracing
Overview
Several DOKuStar components write messages to trace files in the folder %ALLUSERSPROFILE%\Application
Data\Open Text\Trace and its subfolders. Please take notice that the folder Application Data is a hidden
folder. So the Windows Explorer will only show it, if you have marked the respective option in the Folder Options.
Each cluster node of the DOKuStar Load Manager writes trace data to a separate file in the subfolder DOKuStar
Load Manager. These trace files may be used for error analysis. You can open a trace file with a text editor or use
the viewer TraceViewer.exe that you will find under Tools in the DOKuStar Capture Suite program group. The
trace viewer permits to open all trace and log files, and to use filters to control which messages should be displayed.
Trace Root Path

You can change the default trace folder by specifying the desired path in the string value TraceRootPath under the
registry key HKLM\SOFTWARE\Open Text:
Afterwards you should restart the services.
DOKuStar Capture Suite Administrator's Guide Tracing • 137

Configuration
Trace messages have trace levels and belong to categories used to control the volume of the tracing output. Categories
are named entities with a hierarchical structure. Hierarchy levels are separated by dots. A trace level is an enumeration of
Fatal, Error, Warning, Info, Fine, Finer, Finest.
Usually all trace messages higher and equal to level Info are written to trace files. Although some programs like
DOKuStar Load Manager are preconfigured to write additional messages of some categories with level Fine.
You can configure tracing by creating a configuration file and specifying categories and trace levels. Configuration will
be reread on-the-fly when the configuration file changes; you don’t need to restart the load manager. The configuration
file has the following format:
<?xml version="1.0" encoding="utf-8" ?>

<trace>
<category name="DOKuStar.Runtime">
<level value="fine" />
</category>
<category name="DOKuStar.Flow">
<level value="finer" />
</category>
</trace>
You will find a more detailed description of tracing in the Tutorial "Generating and Configuring Traces" in the
DOKuStar Professional Developer's Guide.
The folder SampleTraceConfigFiles in the installation path contains some examples for trace configuration
files.
Trace Viewer
The Trace Viewer can be started from the DOKuStar Capture Suite program group.
It is used to show trace messages created by the DOKuStar Professional components and permits 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.
When you start the Trace Viewer, it will show a list of all trace files found on the local machine on the left side. The list
is grouped by the different components:
138 • Tracing DOKuStar Capture Suite Administrator's Guide

The header shows the path of the trace folder as a link. If you click on the link, the folder is opened in a Windows
Explorer.
As default, all trace files are listed. When you select Only errors, or Only errors and warnings from the drop-
down list of the Filter field, the list will only show trace files containing messages of the respective types.
When you double-click on a file in the list, the contents of the file will be shown on the right side:

With the toolbar buttons, you can control which messages should be displayed:
The first button permits to specify different filters, to search for strings, and to specify the message types that should be
displayed. The context menu of the list view permits to load a trace file, so save the current trace message to a file, and to
specify filters. For more information about the toolbar buttons and the context menu commands, refer to description of
the Output view of the Visual Designer in the DOKuStar Professional Developers Guide.
In the list view double click on a message to show the complete message and its details:
140 • Tracing DOKuStar Capture Suite Administrator's Guide

Trace File Location
The following table shows where the trace files and trace configuration files of the particular programs are located.
Program / Service Trace File / Trace Configuration File

Cluster Service Trace files
<TraceRoot>\DOKuStar$Cluster\DOKuStar.Runtime.DipService*.log
Trace config file

<TraceRoot>\DOKuStar.Runtime.DipService.traceconfig
Scheduler service Trace files
<TraceRoot>\DOKuStar$Scheduler\DOKuStar.Flow.SchedulerService*.log
Trace config file
<TraceRoot>\DOKuStar.Flow.SchedulerService.traceconfig
Clean-up service Trace files
<TraceRoot>\DOKuStar$CleanUp\DOKuStar.Flow.CleanUpService*.log
Trace config file
<TraceRoot>\DOKuStar.Flow.CleanUpService.traceconfig
DOKuStar Usually the Runtime and Extraction run within a cluster controlled by the Load Manager. There
Load Manager 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.
Trace files
<TraceRoot>\DOKuStar Load Manager\ DOKuStarLoadManager*.log
<TraceRoot>\DOKuStar Load Manager\ DOKuStar.Runtime.RuntimeProcessorModule*.log
<TraceRoot>\DOKuStar Load Manager\ DOKuStar.Runtime.Extraction*.log
Trace config file
<TraceRoot>\DOKuStarLoadManager.traceconfig
<TraceRoot>\DOKuStarClusterNode.traceconfig
Visual Designer When you run your DOKuStar Professional project within the visual designer in mode local,
trace files and trace config file are located as follows:
Trace files
<TraceRoot>\DOKuStarProfessional\DOKuStarIde*.log
Trace config file
<TraceRoot>\DOKuStarRuntime.traceconfig
Otherwise (in mode remote) the runtime is hosted in the Load Manager; see DOKuStar Load
Manager.
All services The windows event log is used to log creating, starting and stopping of the services.

Licensing of DOKuStar Products
Introduction
The products of the DOKuStar product family are protected by license files together with a Wibu box, i.e. a hardware
dongle. The DOKuStar License Manager controls use of DOKuStar products or components on a single computer or a
whole cluster of computers within a network.
This manual describes the licensing concept, the components, and provides information about DCOM configuration that
will be useful to locate the source of problems.
Licensing Concept
Licensing Components
To be able to use products of the DOKuStar family, you need a license file and a corresponding Wibu box (hardware
dongle).
The license file unlocks features and functions corresponding to the customers order. The Wibu box protects the license
file.
All products of the DOKuStar family install a license manager which you can configure to run as a local server or on a
remote server. The license manager checks the license information contained in the license file. If the license manager
detects an error (e.g. a counter is decreased to 0, no license is available for a requested feature or program, or the license
file doesn't correspond to the Wibu box), it will not grant a license and the respective component will report a licensing
error.
Important Note: The license manager creates a file LOGFILE.XML in the subfolder License Files of the all
users data folder (default path: Documents and Settings\All Users\Application Data\Captaris\DOKuStar License
Manager on an English language system). Never delete or modify this file or it may complicate installation of a new
license file during a license update, because without an existing LOGFILE.XML file the new license file must have the
same marker value than the Wibu box..
On the other hand, if you need to install a new dongle, you must delete the log file. The license manager will not permit
to install a new dongle as long as a log file for a different dongle is present.
DOKuStar Capture Suite Administrator's Guide Licensing of DOKuStar Products • 143

License Manager
The License Manager is used to control DOKuStar Professional, DOKuStar Extraction, DOKuStar ART, and DOKuStar
Validation. It is installed by all products under the common files folder (default path: Program Files\Common
Files\Captaris\DOKuStar License Manager on the system drive for an English version of
Windows). The license files will be installed in a subfolder of the all users data folder (default path: Documents and
Settings\All Users\Application Data\Captaris\DOKuStar License Manager\License Files on the system drive
for an English version of Windows).
The License Manager is a windows service and is started automatically, when a DOKuStar component requests a valid
license or when the command Install License File is called.
Some components, e.g. the Design Studio of DOKuStar Extraction, don’t request a license and their use will not start the
license manager.
Note: When you try to view license files you may get a warning like “To help protect your security,
Internet Explorer has restricted this file from showing active content that could access
your computer. Click here for options.” Please click for options and choose Allow Blocked Content.
144 • Licensing of DOKuStar Products DOKuStar Capture Suite Administrator's Guide

License File
The license file specifies the features purchased by the customer. A license item may allow you to start a certain program
or a specified number of instances of a program, it may allow you to use a special feature or option, or it may comprise a
counter that is decremented each time the respective feature is used.
E.g. for DOKuStar Extraction the license file will contain counters for documents with different numbers of index fields
and license items for options such as Address, FuzzyDb, Invoice, Table and Handprint.
The contents of the license file cannot be changed since it is protected by signature data.
While the respective DOKuStar product is running, counters in the license file will be decreased and the signature data
are updated. The License Manager synchronizes the counters in the license file and the contents of the Wibu box. If
counters are decreased a marker will be written into the Wibu box. Thus the license file and the Wibu box belong
together. Therefore an archived copy of a license file will become invalid if the respective DOKuStar product continues
processing with the original license file.
The licenses files are text files in XML format with a special name for each DOKuStar product, e.g. a license file for
DOKuStar Extraction will normally have the name DokuStar.xml. Don't change contents or name of a license file or
the respective DOKuStar product will not work any more!
The current counters contained in a license file can be displayed with the license file viewer, if your Internet Explorer
allows Java scripts. The license file viewer can be started using the command Show Licenses. You will find it in the
DOKuStar Capture Suite 3.0 program group.
Wibu Box
The Wibu box (dongle) releases the products. To run the Wibu box, the appropriate driver software must be installed.
Each DOKuStar product will install the Wibu drivers, if they are not found on your system, or ask you to replace them, if
an old version is found.
The power management of the BIOS setup must be switched off, otherwise errors may occur during access to the Wibu
box while the PC is in power-down mode.
If you use a serial dongle, the respective serial interface must be activated in the Wibu device driver: Under Start -
Settings click on Control Panel. Double-click on WIBU-KEY to open the WIBU-KEY dialog box. Go to the
Setup register. Select the desired COM interface in the list of interfaces and mark the box with the text Enabled
(port accessed by WIBU-KEY driver).
Please note that starting with version 5, the Wibu driver shows only some of the tabs per default. To be able to use the
Setup tab, click on the symbol in the upper left corner of the WIBU-KEY window and from the system menu choose
Advanced Mode. Then all tabs will be shown:
If you use a USB dongle it may be necessary to plug in the dongle after the Wibu device driver has been installed.
The installation will show a message box after Wibu driver installation that requests you to configure the dongle.
If you use a parallel dongle, you can ignore the installation message. For this type of interface no configuration is
required.

Network Installation of the License Manager
The License Manager is able to control several instances of DOKuStar products on different computers over a network.
In this case, one computer acts as a license server. This is the computer where the Wibu box is plugged in and where the
license files are installed. The License Manager is installed as a system service on all computers where DOKuStar
products are installed.
To specify whether the local computer or a remote server should act as license server, use the shortcut Specify
License Server in the DOKuStar Capture Suite 3.0 program group of the start menu.
The License Manager uses DCOM to submit licensing requests to the license server. Most DCOM configuration is done
automatically during installation. Only when running the license manager in a network the system administrator has to
perform some security settings, because DCOM for remote hosts is deactivated in Windows by default.
The chapter Trouble-Shooting contains a complete description of all DCOM configuration incl. security settings.
Moving the WIBU Box to Another PC

When you want to move the WIBU box to another computer, proceed as follows:
1. If the license manager is running, terminate it by calling Shutdown in the context menu of the license
manager icon in the system tray.
2. Install the DOKuStar products, or the license server respectively, on the new computer as described above.
When you are asked, whether you want to install the license file, answer with No.
3. Move the Wibu box to the new copmputer.
4. Move the contents of the License Files folder containing the license file(s) and the log file to the new
computer. For earlier versions of the License Manager, you will find it in the folder ODT-OCE\LicMan in
the common files folder (standard path on an English system: \Program Files\Common Files on
the system drive).
Important Note: If you use products of the DOKuStar product family with separate license files on the same computer,
you should move all license files to the new computer at the same time. If you only move one of the license files and
work with one of the products, you will not be able to work with the other products any more because the marker of the
WIBU box will not be synchronous with the license file that was not available during processing.
Evaluation Kit
The Evaluation Kit can be used for test and demonstration purposes. For easy use it has a special licensing:
The Evaluation Kit is license controlled by a special Evaluation Dongle. It doesn't need a license file.
Because there is no license file, the dongle can be moved to another computer at any time. But the dongle must always
be plugged in at the computer where you want to use the evaluation license. It can't be used across a network.
The Evaluation Kit counts the number of processed documents and checks an expiration date. When the document count
or the date expires, the Evaluation Kit can no longer be used.
To prevent being surprised by license expiration, a control program CheckEval.exe can be used, that is found in the
bin folder of the DOKuStar Extraction installation. If it is started without parameters, it shows the remaining documents
and the expiration date. If it is started with parameter -g, it shows an icon in the task bar, whose context menu permits to
terminate the program, and checks the dongle in regular intervals. If document count or remaining time fall below certain
threshold values, a warning message will appear. The thresholds can be specified as parameters. If the program is started
with -?, it shows a parameter description.

Separate Installation of a License File
If you want to install the license file separately or if you want to install a new one, please use the command Install
License File in the DOKuStar Capture Suite 3.0 program group.
If a license file already exists in the folder .\DOKuStar License Manager\License Files, it will be
renamed.
License Update
To update a license there are two ways:
1. The update includes both a new license file and a corresponding Wibu box. In this case delete the log file that
you will find in the license file folder. You can install the license file as described above and use the
corresponding Wibu box. Please send back the old Wibu box to Océ Document Technologies GmbH.
2. The update includes only a new license file. Install the new license file using the command Install License
File found in the DOKuStar Capture Suite 3.0 program folder. The license manager installs the new file
and synchronizes it with the Wibu box.
Warning: Never delete or modify the log file, the license manager creates in the folder License Files.
Synchronization of a new license will fail, if license file and Wibu box are not synchronous and no valid log file, created
by the license manager, exists.
On the other hand, if you want to switch to a new dongle and license file, you must delete the log file beforehand. The
License Manager will not allow to activate a dongle as long as a log file for a different dongle is present.

Trouble-Shooting
DCOM Configuration
If licensing does not work in a network installation, this is often caused by invalid security settings or other incorrect
DCOM configuration. The following sections describe the DCOM configuration in detail. In case of licensing problems
please check all the DCOM settings particularly security settings and correct them, if necessary.
The following sections describe the DCOM configuration on Windows XP SP2, Windows 2003 Server or Windows
Vista. On a Windows 2000 system, when you start DCOMCNFG, the Distributed COM Configuration
Properties window opens. If you select LicMan in the Applications list of the Applications register and click
the Properties button, the LicMan Properties window opens. This window shows the same registers and similar
options as described below.
License Server
The following settings are valid, if the system acts as a license server; this is when you chose local server during
installation.
Security Settings
The following security settings are necessary on systems with Windows XP SP2, Windows 2003 Server or Windows
Vista when the system acts as a license server because DCOM for remote hosts is deactivated by default.
Details about the DCOM security enhancements introduced with Service Pack 2 for Windows XP can be found on the
Internet under http://msdn.microsoft.com/en-us/library/ms679714(VS.85).aspx.
Start the system program DCOMCNFG, e.g. using start - Run. The Component Services window opens.
Click on Component Services and then open the nodes Computers and My Computer.
Note: On a Windows 2000 system, the following security settings are not available.
On the Component Services window now select My Computer:

Click on My Computer with the right mouse button and select Properties from the context menu. The My
Computer Properties window opens:
Click on Edit Limits. The Access Permission window opens. Here the list of group or user names should
contain the two items ANONYMOUS LOGON and Everyone and for both items the options Local Access and
Remote Access should both be marked:

If an item is missing, click the Add button and enter the name in the Select Users, Computers, or Groups
window. If an additional item is present, select it and press the Remove button to delete it. When the access
permissions look as shown above, click OK to close the window.
On the My Computer Properties window now also click Edit Limits under Launch and Activation
Permissions. The Launch Permission window opens. Here the list of group or user names should contain the
items Administrators(…) and Everyone and for both all four permissions options should be marked:
Close the Component Services window. DCOM configuration is now complete.

Other license server DCOM settings
The following DCOM settings usually are done automatically during installation. Please check these settings if licensing
does not work.
Start the system program DCOMCNFG, e.g. using Start - Run. The Component Services window opens.
Click on Component Services and then open the nodes Computers and MyComputer:
Now click on DCOM Config and in the right view select LicMan:
Click on LicMan with the right mouse button and from the context menu choose Properties. The LicMan
Properties window opens. On the General tab choose for Authentication Level the value (none):

On the Location tab select the option Run application on this computer:
On the Security tab, choose Customize under Launch and Activation Permissions and click the Edit
button:

The Launch Permission window opens. Here the items Everyone and SYSTEM must be present and for both
all four permission options must be marked:
If an item is missing, click the Add button. The Select Users, Computers, or Groups window opens. Enter
the respective name and click OK:
If the list of groups or user names contains an additional item, select it and press the Remove button to delete it. When
you have finished, click OK in order to close the Launch Permission window.
Now also choose customize under Access Permissions and click the Edit button:

The Access Permissions window opens. Again the items Everyone and SYSTEM should be present and for
both the options Local Access and Remote Access should be marked:

Now select the Identity tab and choose the option The System Account (services only):
Close the LicMan Properties window by clicking OK.
Note: If you use Work Groups (i.e. if you not use Domains) you have to configure a user account for each client on the
license server computer that has the same name and password as it is used on the respective client.

License Clients
The following settings are valid when the system uses a remote license server, i.e. when you chose Remote server
during installation
All license clients, i.e. the computers where a DOKuStar application should run but where the dongle and license files
are not present, must be configured as described here.
Start the program DCOMCNFG and open the LicMan Properties window as described in the previous section. On
the General tab again select the value (none) for Authentication Level.
On the Location tab mark the option Run application on the following computer and enter the computer
name of the license server into the field following the option:
Be sure, that the option Run application on this computer is not marked.
Click OK to close the LicMan Properties window.
On the Component Services window click on My Computer with the right mouse button and select
Properties from the context menu. The My Computers Properties dialog window opens. Select the Default
Properties register. Here the option Enable Distributed COM on this computer should be marked:

Note: On a Windows 2000 system, you will find this option on the Default Properties tab of the Distributed
COM Configuration Properties window.
Click OK to close the window. Close the Component Services window. DCOM configuration for a license client
is now complete.
Using License Manager with Firewalls

When you have an active firewall at the license server you must open two TCP ports and configure a static end point.
Choose a TCP port number greater then 5000, e.g. 5590. At the license server computer, open up the firewall to this port
(5590) and additionally to port 135 (for RPC initial calls).
Start the system program DCOMCFNG, e.g. using start – Run. The Component Services window opens.
Click on Component Services and then open the nodes Computers and My Computer. Now click on
DCOM Config and in the right view select LicMan. Click on LicMan with the right mouse button and from the
context menu choose Properties. The LicMan Properties window opens. On the Endpoints tab click the Add
button. In the following dialog select Use static endpoint and enter the TCP port number, e.g. 5590.

Shut down the LicMan service if it is running.
Microsoft Loopback Adapter

If the Microsoft Loopback Adapter is actually installed, please deactivate it. This tool is not part of Windows but you can
download it from Microsoft. It is only useful when you want to drive a client server application on a stand alone
machine, i.e. a PC or Notebook not connected to any network (LAN). But in real environments where the PC is
connected to a network it often causes problems.
Using different Windows Domains

It is not recommended to run the license server and the client in different windows domains. If you want to do it, you do
it at your own risk! May be the following approach is successful on Windows 2003 Server.
1. Create a local user at the license server. The user’s name and password must match with the user that runs the
client application (e.g. DOKuStar Validation) in the domain of the client PC.
2. Add the users to the group DCOM-User. This group is only available on Windows 2003 Server.

License Manager Command Line Reference
In some cases you want to call the license manager via command line, e.g. to automate installation of an update license
file or to reregister the license manager because of installation problems. Here is a reference of the command line
arguments:
LicMan.exe [argument]
Argument Description
/Service Register license manager as windows service
/UnregServer Un-register license manager
/Shutdown Shutdown license manager
/Location <host> Sets the execution location. <host> specifies the license server (enter localhost
to use the local host). If no host is specified, a dialog will pop up.
/Command install [<LicenseFile>] Installs a new license file. If no license file is specified, a dialog will come up where
you can browse to the file. This command copies the license file to the License
Files folder and updates the log file. A previously installed license file will be
saved to <LicenseFile>.n (e.g. dokustar.1). If an update license file
(special file type with update attribute) is installed there must already exist a
previously installed (original) license file. The throughput counters of the update
license file and the existing license file will be merged.
/Command charge <LicenseFile> This command charges the capacity counter of a specific product feature of the
<ProductFeature> <ChargeValue> license file.
<SystemNumber> <Date>
<Signature>
DOKuStar License Observer

The DOKuStar License Observer checks DOKuStar License Manager of the local host or a remote license server for
errors and controls whether the volume counters of each license are less than a specified threshold. The program informs
you by popping up a balloon box and writes a warning to the windows event log in the application section (source is
DOKuStar License Observer). Additionally you may configure the program to send an email.
Running the License Observer

Note: To be able to install License Observer, you need .NET Framework 2.0 or higher.
The program is part of the license server installation and is located at:
%CommonProgramFiles%\Captaris\DOKuStar License Manager\bin\DOKuStarLicenseObserver.exe.

It is meaningful to make the program start automatically when you log on to windows:
• Start Windows Explorer
• Go to the folder %HomePath%\Startmenü\Programs\Autostart
• Create a new link to:
%CommonProgramFiles%\Captaris\DOKuStar License Manager\bin\DOKuStarLicenseObserver.exe.
When you start the observer, an icon will appear in the system tray. The program polls the license manager using a
configurable interval. If the threshold is reached or if any other error occurs, e.g. the dongle is disconnected, a balloon
box is displayed in the system tray, describing one or several errors.
When you click on the balloon box, the DOKuStar Licensing dialog opens and shows license information. A red
symbol is shown at values that caused an error:

Configuration
To specify the license server location, under start – Programs go to the DOKuStar License Manager program
group and use the command Set License Manager Location.
In the appearing Set License Manager Location dialog, select Remote Server and specify the name of the
license server:
To modify the license observer options, right-click the icon in the system tray and in the context menu choose
Options. The dialog License Observer Options opens.
You can modify the poll interval and the threshold. As default, the observer will check the licenses every 30 minutes and
issue a warning, if less than 10000 documents are left in any license counter.
In the section Mail, you can specify an e-mail address the warning should be sent to. When you have specified an
address, you can send a test mail by clicking on Send a Test Mail to test the e-mail parameters.

Configuration of the Connection to the ACT Database
58
Configuration of the Connection to the ART Database
57
Index Configuration Techniques 50
Configurations 31
Configuring a Hot Spot of Type File System 104
Configuring a Hot Spot of Type FTP 105
Configuring a Hot Spot of Type Mail 106
Configuring a Hot Spot of Type SharePoint 107
A Configuring Cluster Nodes 131
Configuring Hot Spots 102
Activating Interaction Statistics 124 Configuring Polling Cycle and Project File 103
Activities and Jobs View 79 Configuring Reporting 25
Activities and Jobs view - Filtering and Sorting 82 Configuring Shortcuts 58
Activity Details Dialog 85 Configuring the Extraction Cluster 25
Adding a Further Extraction Cluster 50 Configuring Users and Rights 26
Adding a Further Extraction Cluster Node 50 Context Menu of Activities 83
Adding a New Shape to the System View 63 Context Menu of Jobs 84
Adding a Service to a System View 64 Context Menu of the Summaries View 77
Administering Hot Spots 108 Controlling Views 69
Administration 59 Controlling Windows 71
Administrator Settings 34 Creating a DOKUSTAR Instance Manually 51
Architecture 41, 43 Creating a New System View 61
ART and ACT Databases 36 Creating Hot Spots 102
ART and ACT Training 93 Creating the File FlowService.dcf 53
B D
Backup Data 97 Database Rights 45
Backups of the ACT Database 99 Databases 36
Backups of the ART Database 98 DCOM Configuration 148
Backups of the Dispatch Repository 96 Deleting Trace Files 92
Basic Configurations for a Distributed System 24 Dispatching jobs 126
Basic Configurations for a Full Installation 7 Document Hit Rate Report 120
Best Practice for Users and Groups 45 Documentation 28
Broken Jobs: Trouble Shooting 94 DOKuStar Capture Suite 28
DOKuStar Extraction 30
C DOKuStar License Observer 159
DOKuStar Professional 28
Changing the Account of a Capture Suite Windows DOKuStar Validation 29
Service 56
Changing the Reporting Database 118
Changing the Trace Folder 55 E
Changing the User Interface Language of Validation 58 Emergency User Concept 48
Checking the Services 8, 24 Encryption of Communication Channels 48
Classification Report 119 Encryption of the Repository 49
CleanUp Dialog 89 Error Documents 136
Cleanup Service Configuration File 34 Evaluation Kit 146
Cluster 42 Exclusive Profiles 126
Cluster Nodes Tab Page 128
Components of the Standard Configuration 31
Config Folder, ServerConfig.dfc, and ClientConfig.dfc F
31 Failover 126
Configuration 131, 138, 161 Field Hit Rate Report 121
Configuration Data 31 File Menu 67
DOKuStar Capture Suite Administrator's Guide Index • 163

Files and Databases 48 License Files 33
Files and Folders 47 License Manager 144
Flow Database 36 License Manager Command Line Reference 159
Flow Server and Extraction Cluster Node 1 License Server 148
Flow Server as Virtual Machine Hosted on ESX Server License Update 147
- Cold Standby 43 Licensing Components 143
Flow Server Configuration File 33 Licensing Concept 143
Flow Server on a Microsoft Cluster Using an Already Licensing of DOKuStar Products 143
Existing SQL Cluster 41 Load Manager 125
Full Installation 3 Configuration 131
Further Runtime Files 93 Introduction 125
Monitoring 127
H Load Manager Files 34
Logging of Configuration Data Changes 49
Help Menu 68 Logging of Security Events 49
History Tab Page 130
Hot Spot Files 34
M
Hot Spots
Administration 108 Menus 67
Configuration 102 Microsoft Loopback Adapter 158
Overview 101 Modifying a System View 63
Hot Spots - An Overview 101 Monitoring 126, 127
Monitoring Flow Database Size 92
I Monitoring Reporting Data 92
Monitoring Several Systems 66
Import Folders 35 Monitoring the Size of ART Database Files 93
Improving Security on the Validation Clients 49 Monitoring the System 92
Increasing the Number of Extraction Cluster Nodes 39 Moving the WIBU Box to Another PC 146
Increasing Throughput 39
Initializing Reporting 112
N
Installation of a Validation Client 20
Installation of an Extraction Cluster Node 15 Network Installation of the License Manager 146
Installation of the Flow Server 10 Network Requirements 2
Installation Overview 9
Installing 3 O
Installing the DOKuStar Capture Suite on a Distributed
System 9 Operations Tab Page 129
Installing the DOKuStar Capture Suite on a Single Options and Properties of the Clean-Up Service 90
Machine 3 Overview 31, 39, 40, 45, 59, 74, 96, 116, 137
Installing the License Files 7 Overview Tab Page 127
Installing the License Files and Configuring the License
Server 24 P
Installing Your DOKuStar Capture Suite Application 8,
26 Periodical Tasks 92
Interaction Summary Report 122 Prerequisites 42, 44
Introduction 69, 111, 125, 143 Products 42, 44
Profiles 135
Properties of the Cluster Node 134
J Providing High Availability 40
Job Class View 78
Job Details Dialog 86 R
Reducing Unnecessary Re-initialization 126
L Removing Items from a System View 65
License Clients 156 Removing the sa User after Installation 51
License File 145 Removing the sa User or Changing the Password 26
164 • Index DOKuStar Capture Suite Administrator's Guide

Removing the Software 100 Using a SQL Server on another Machine for the ACT
Replacing the SQL Server Express Edition 39 Database 54
Report Viewer 116 Using a SQL Server on another Machine for the ART
Reporting 111, 112 Database 53
Reporting Database 37 Using a SQL Server on another Machine for the Flow
Reporting Files 34 Database 52
Repository 34 Using a Validation Client for Several DCS systems 56
Restoring Data 97 Using another Configuration Location 54
Rights, Tasks, and Responsibilities 48 Using another Repository Location 54
Running an Additional Scheduler Service on another Using different Windows Domains 158
Machine 56 Using License Manager with Firewalls 157
Running the License Observer 159
Running the Scheduler Service (additionally) on V
another Machine 39
Running the Scheduler Service on another Machine 56 Validation Client 2
Runtime Files 34 Validation Report 122
View Menu 67
Views and Windows 69
S
Scheduler Dialog 88 W
Security 45
Separate Installation of a License File 147 Wibu Box 145
Sequence of Installation 44 Windows Menu 68
Sequence of Installation and Configuration 42 Working with Hot Spots 101
Services 37
Shapes View 73
SQL Server Instance DOKUSTAR 36
Starting the Load Manager 126
Starting the Services 97
Stopping Processing 96
Summaries View 74
System 44
System Requirements 1
System Window 61, 63, 66, 72
T
Temporary Files of DOKuStar Professional and
DOKuStar Extraction 35
Toolbar of the Activities and Jobs view 80
Toolbar of the Report Viewer 117
Toolbar of the Summaries View 75
Trace Configuration Files 34
Trace File Location 141
Trace folder 35
Trace Root Path 137
Trace Viewer 138
Tracing 137
Trouble-Shooting 148
U
Upgrading from Version 2.0 27
Using a Second DCS System 40
Using a Second Extraction Cluster 40
Using a Separate File Server 39
DOKuStar Capture Suite Administrator's Guide Index • 165

DCS AdministratorsGuide en

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

DCS AdministratorsGuide en

Uploaded by

Copyright:

Available Formats

DOKuStar Capture Suite

Copyright  Open Text Document Technologies GmbH

PostScript® is a trademark of Adobe Systems Incorporated.

PCL® is a trademark of Hewlett Packard Company.

Portions copyright  2003-2009 AllMyPapers.

DOKuStar Capture Suite Administrator's Guide Contents • iii

iv • Contents DOKuStar Capture Suite Administrator's Guide

Backups of the Dispatch Repository 96

Backups of the ART Database 98

Backups of the ACT Database 99

Removing the Software 100

Working with Hot Spots 101

DOKuStar Capture Suite Administrator's Guide Contents • v

Load Manager 125

vi • Contents DOKuStar Capture Suite Administrator's Guide

DOKuStar Capture Suite Administrator's Guide Contents • vii

Flow Server and Extraction Cluster Node

System 32 bit 64 bit

• .NET Framework 2.0 and 3.5

DOKuStar Capture Suite Administrator's Guide System Requirements • 1

System 32 bit 64 bit

• .NET Framework 2.0 and 3.5

2 • System Requirements DOKuStar Capture Suite Administrator's Guide

Installing the DOKuStar Capture Suite on a

DOKuStar Capture Suite Administrator's Guide Installing • 3

4 • Installing DOKuStar Capture Suite Administrator's Guide

When you click on Next, the license agreement is shown:

DOKuStar Capture Suite Administrator's Guide Installing • 5

6 • Installing DOKuStar Capture Suite Administrator's Guide

Confirm with Finish.

Basic Configurations for a Full Installation

DOKuStar Capture Suite Administrator's Guide Installing • 7

Installing Your DOKuStar Capture Suite Application

8 • Installing DOKuStar Capture Suite Administrator's Guide

DOKuStar Capture Suite Administrator's Guide Installing • 9

Installation of the Flow Server

10 • Installing DOKuStar Capture Suite Administrator's Guide

DOKuStar Capture Suite Administrator's Guide Installing • 11

When you click Next, the license agreement is shown:

12 • Installing DOKuStar Capture Suite Administrator's Guide

DOKuStar Capture Suite Administrator's Guide Installing • 13

14 • Installing DOKuStar Capture Suite Administrator's Guide

Installation of an Extraction Cluster Node

DOKuStar Capture Suite Administrator's Guide Installing • 15

When you click Next, the license agreement is shown:

16 • Installing DOKuStar Capture Suite Administrator's Guide

DOKuStar Capture Suite Administrator's Guide Installing • 17

18 • Installing DOKuStar Capture Suite Administrator's Guide

DOKuStar Capture Suite Administrator's Guide Installing • 19

20 • Installing DOKuStar Capture Suite Administrator's Guide

DOKuStar Capture Suite Administrator's Guide Installing • 21

22 • Installing DOKuStar Capture Suite Administrator's Guide

Confirm with Finish.

DOKuStar Capture Suite Administrator's Guide Installing • 23

Checking the Services

Service Flow Server Extraction Cluster Extraction Cluster Validation Client

24 • Installing DOKuStar Capture Suite Administrator's Guide

Configuring the Extraction Cluster

DOKuStar Capture Suite Administrator's Guide Installing • 25

Configuring Users and Rights

Installing Your DOKuStar Capture Suite Application

26 • Installing DOKuStar Capture Suite Administrator's Guide

DOKuStar Capture Suite Administrator's Guide Installing • 27