Sunteți pe pagina 1din 130

IBM Datacap

Version 9

System Administration Guide



SC27-6372-00
IBM Datacap
Version 9

System Administration Guide



SC27-6372-00
Note
Before using this information and the product it supports, read the information in “Notices” on page 113.

This edition applies to Version 8 Release 1 of Datacap (product number 5725-C15) and to all subsequent releases
and modifications until otherwise indicated in new editions.
© Copyright IBM Corporation 2014.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
ibm.com and related resources. . . . . v Using Datacap Desktop with your
How to send your comments . . . . . . . . . v Datacap applications . . . . . . . . 39
Contacting IBM . . . . . . . . . . . . . vi Creating and configuring a task to use with Datacap
Desktop . . . . . . . . . . . . . . . 39
Configuring Datacap databases . . . . 1 Using Datacap Desktop to run tasks . . . . . . 40
Configuring an application to use the database . . . 2 Using Datacap Desktop to scan hardcopy pages . . 41
Database security permissions . . . . . . . . 3 Setting up a barcode type as a document separator 42
Defining the database structure . . . . . . . . 4
Creating a single Oracle database for a Datacap FastDoc . . . . . . . . . . . . . . 45
application . . . . . . . . . . . . . . . 5 Getting started on FastDoc . . . . . . . . . 45
Moving the application files . . . . . . . . . 6 Starting FastDoc . . . . . . . . . . . . 46
Verifying the database connection . . . . . . . 7 Using an application created from a template . . 46
Advanced database settings for Datacap Server . . . 7 Creating an application in Application Wizard. . 47
Forms template configuration . . . . . . . 48
Administering your system . . . . . . 9 Setting up documents on the Forms template 48
Configuring access to IBM Datacap from mobile Setting up image enhancement on the Forms
devices . . . . . . . . . . . . . . . . 9 template . . . . . . . . . . . . . 49
Datacap web clients administration . . . . . . 10 Setting up fingerprints on the Forms template 49
Users, groups, and stations administration . . . 10 Setting up field recognition on the Forms
Workflows, jobs, and tasks administration . . . 11 template . . . . . . . . . . . . . 51
The Job Monitor and workflow administration 11 Setting up field validation on the Forms
Shortcuts administration . . . . . . . . . 12 template . . . . . . . . . . . . . 51
Batch queuing to specific users and stations . . 12 Summary of document configuration on the
Effects of application pool recycling on Datacap Forms template . . . . . . . . . . . 52
Web Client batches . . . . . . . . . . . 14 Learning template configuration . . . . . . 52
Creating a custom column in the Job Monitor . . 14 Setting up fields on the Learning template . . 53
Administering Datacap Navigator . . . . . . 15 Setting up image enhancement on the
Datacap Navigator user settings . . . . . 15 Learning template . . . . . . . . . . 53
Administration view . . . . . . . . . 15 Setting up field recognition on the Learning
Batch status (Job Monitor) . . . . . . . 15 template . . . . . . . . . . . . . 54
Image scans . . . . . . . . . . . . 16 Setting up field validation on the Learning
Batch verification . . . . . . . . . . 16 template . . . . . . . . . . . . . 54
Batch upload . . . . . . . . . . . . 16 Summary of document configuration on the
Page classification . . . . . . . . . . 17 Learning template . . . . . . . . . . 54
Batch processing (Task List) . . . . . . . 17 Configuring export options . . . . . . . . 55
Accessibility features of Datacap Navigator . . . 17 Format of the exported data file . . . . . 56
Keyboard shortcuts for Datacap Navigator . . 21 Confirming a successful export . . . . . . 56
Datacap Application Copy Tool. . . . . . . . 22 Application configuration on FastDoc . . . . . 56
Configure the connection strings . . . . . . 23 Preparing for document scanning and indexing 57
Datacap Application Copy Tool Command Line Setting up a scanner for FastDoc . . . . . . 58
Interface . . . . . . . . . . . . . . 25 Setting up batch profiles in Local mode . . . . 58
Application migration options . . . . . . 26 Setting up batch profiles in Datacap Server mode 60
Moving an application into a new Adding rulesets to a FastDoc workflow . . . . 60
environment . . . . . . . . . . . . 28 Configuring rulesets for the application . . . . 61
Updating an application in an existing Testing rulesets . . . . . . . . . . . . 63
environment . . . . . . . . . . . . 29 Defining an index field with keywords . . . . 64
Changing the database provider . . . . . 30 Defining index field validation by using a
Migrating a single database to another database . . . . . . . . . . . . . . 65
database provider . . . . . . . . . . 31 Using Click N Key to capture data . . . . . 65
Datacap Application Copy Tool User Interface . . 31 Document processing on FastDoc . . . . . . . 66
Monitoring system performance with IBM System Preparing paper documents for scanning . . . 66
Dashboard for Enterprise Content Management . . 32 Running FastDoc in Local mode . . . . . . 66
Shutting down Datacap for maintenance . . . . 37 Opening an existing batch . . . . . . . 67
Creating a batch with pre-scanned images . . 67
Creating a batch by using a scanner . . . . 68

© Copyright IBM Corp. 2014 iii


Indexing and verifying batches . . . . . . 69 Appendix E. Troubleshooting
Running FastDoc in Datacap Server mode . . . 70 Rulerunner . . . . . . . . . . . . . 95
Processing documents on the Forms template 70 First things to check . . . . . . . . . . . 95
Processing documents on the Learning Viewing Windows Event Viewer logs on Rulerunner
template . . . . . . . . . . . . . 72 server . . . . . . . . . . . . . . . . 95
Displaying a page or document. . . . . . . 73 Stopping the Rulerunner Service . . . . . . . 96
Deleting pages . . . . . . . . . . . . 73 Enabling Rulerunner processing logs . . . . . . 96
Starting the Rulerunner Service . . . . . . . . 97
FastDoc maintenance . . . . . . . . 75 Viewing Rulerunner processing logs . . . . . . 97
Purging finished batches . . . . . . . . . . 75
Deleting selected batches . . . . . . . . . . 75 Appendix F. Troubleshooting FastDoc 99
Viewing daily batch statistics . . . . . . . . 76 Barcode recognition is poor . . . . . . . . . 99
Determine the original file name of a pre-scanned Document type is not automatically assigned . . . 99
image . . . . . . . . . . . . . . . . 76 Scanner is not listed as an option . . . . . . . 99
Extra data included in captured data . . . . . 100
Maintaining fingerprints by using the Index data not picked up automatically in zoned
Fingerprint Maintenance Tool . . . . . 77 field . . . . . . . . . . . . . . . . 100
Starting the Fingerprint Maintenance Tool . . . . 77 Correcting export errors . . . . . . . . . . 100
Locating and deleting partial fingerprints . . . . 77 SharePoint upload returns file check-in error in
Deleting fingerprints . . . . . . . . . . . 77 Export_rrs.log. . . . . . . . . . . . . 101
Deleting fingerprints that are associated with a SharePoint upload returns a list not found error in
document type . . . . . . . . . . . . . 78 Export_rrs.log. . . . . . . . . . . . . 101
Exporting selected fingerprints . . . . . . . . 78 SharePoint upload returns a properties update
Adding selected fingerprints. . . . . . . . . 78 error in Export_rrs.log . . . . . . . . . . 101
Troubleshooting the Fingerprint Maintenance Tool 79
FMT Backup Directory . . . . . . . . . 79 Appendix G. Troubleshooting Datacap
FMT.Log . . . . . . . . . . . . . . 79 web services . . . . . . . . . . . 103
Appendix A. FastDoc keyboard Appendix H. Log files . . . . . . . . 105
shortcuts. . . . . . . . . . . . . . 81 Enabling logging for Datacap Desktop . . . . . 105
Enabling logging for FastDoc . . . . . . . . 106
Appendix B. Fingerprint Maintenance Enabling logging for Rulerunner Service . . . . 107
Tool reference . . . . . . . . . . . 83 Enabling logging for Datacap Server service . . . 108
Fingerprint Maintenance Tool configuration settings 83 Enabling logging for the Datacap Web Client . . . 108
Fingerprint Maintenance Tool buttons . . . . . 84 Enabling the Datacap Web Services log . . . . . 109
Fingerprint Maintenance Tool fields . . . . . . 84
Notices . . . . . . . . . . . . . . 113
Appendix C. Troubleshooting IBM Trademarks . . . . . . . . . . . . . . 115
Datacap . . . . . . . . . . . . . . 87 Privacy policy considerations . . . . . . . . 115
Searching knowledge bases . . . . . . . . . 89
Getting fixes from Fix Central . . . . . . . . 90 Index . . . . . . . . . . . . . . . 117
Contacting IBM Software Support . . . . . . . 90
Subscribing to Support updates. . . . . . . . 91

Appendix D. Troubleshooting Datacap


security and authentication . . . . . . 93
Automatic key import feature fails to apply the new
encryption keys . . . . . . . . . . . . . 93

iv IBM Datacap: System Administration Guide


ibm.com and related resources
Product support and documentation are available from ibm.com®.

Support and assistance

Product support is available on the Web. Click Support from the product Web site
at:
Datacap
http://www.ibm.com/support/entry/portal/Software/
Enterprise_Content_Management/Datacap_Taskmaster_Capture

Knowledge Center

You can view the product documentation on ibm.com. See Knowledge Center at
http://www.ibm.com/support/knowledgecenter/SSZRWV_9.0.0/.

PDF publications

You can view the PDF files online using the Adobe Acrobat Reader for your
operating system. If you do not have the Acrobat Reader installed, you can
download it from the Adobe Web site at http://www.adobe.com.

See the following PDF publications Web site:

Product Web site


Datacap http://www.ibm.com/support/
docview.wss?uid=swg27035774

How to send your comments


Your feedback is important in helping to provide the most accurate and highest
quality information.

You can use any of the following methods to provide comments:


v Add comments by using the Comments pane at the bottom of every topic in
Knowledge Center.
v Send your comments by clicking the Feedback link at the bottom of any topic in
Knowledge Center.
v Send your comments by using the online readers' comment form at
http://www.ibm.com/software/data/rcf/.
v Send your comments by e-mail to comments@us.ibm.com. Include the name of
the product, the version number of the product, and the name and publication
number of the information (if applicable). If you are commenting on specific
text, please include the location of the text (for example, a title, a table number,
or a page number).

© Copyright IBM Corp. 2014 v


Consumability survey

Tell us how you feel about the value of quality content by taking the Importance of
High Quality Technical Information survey at the following link:
http://www.ibm.com/survey/oid/wsb.dll/s/ag2c1. If you want to help IBM
make this product easier to install and use, take the Consumability Survey at the
following link: http://www.ibm.com/software/data/info/consumability-survey/.

Contacting IBM
To contact IBM customer service in the United States or Canada, call
1-800-IBM-SERV (1-800-426-7378).

To learn about available service options, call one of the following numbers:
v In the United States: 1-888-426-4343
v In Canada: 1-800-465-9600

For more information about how to contact IBM, see the Contact IBM Web site at
http://www.ibm.com/contact/us/.

vi IBM Datacap: System Administration Guide


Configuring Datacap databases
The Datacap applications can use DB2®, Microsoft SQL Server, or Oracle databases
to store workflow definitions, security parameters, processing information, and
fingerprints.

The sample applications and templates that are installed with Datacap use
Microsoft Access for their application databases. You can configure the following
Datacap application databases to use DB2, Microsoft SQL Server, or Oracle instead
of Microsoft Access.

The following information describes how to define the database structure, populate
the database, move the database, and configure the application to use the database.
This information does not describe how to do lookups or export to the database.
Administration database
Contains definitions of the workflows, jobs, and tasks in the application.
Also contains the security parameters for the users, user groups, stations,
and job-task shortcut icons in the application.
Engine database
Stores current and historical processing information for each batch of
documents and its contents.
Fingerprint database
Manages the fingerprints of the application if you are using matching
fingerprints to identify and align forms for the application.

Lookup and other application-specific databases that do database tasks for the
Datacap applications can also be configured to use DB2, Microsoft SQL Server, or
Oracle.

Prerequisites

Before you can configure a DB2, SQL Server, or Oracle database for a Datacap
application, you must have access to the database. A Database Administrator must
initially create each DB2, SQL Server, or Oracle database and grant appropriate
access rights.

For SQL Server, if you want to create an isolated test environment, you can use
Microsoft SQL Server Express®, which you download from the Microsoft website.

For Oracle, the Oracle client must be installed on any computer that communicates
directly with an Oracle database. At a minimum, the database must be installed on
the computer that is running the Datacap Server. The computers on which you run
the clients that connect to the Fingerprint database or Oracle, or run rules that
make SQL calls to any Oracle database, such as for lookups, require the Oracle
client installed. These clients include Datacap Desktop, Datacap FastDoc,
Rulerunner, and Datacap Web Client. When you are using the Application Copy
Tool, that computer must have the Oracle client that is installed and connectivity to
any source or destination Oracle database.

For DB2, the DB2 client must be installed on any computer that communicates
directly with a DB2 database. At a minimum, the database must be installed on the

© Copyright IBM Corp. 2014 1


computer that is running the Datacap Server. The computers on which you run the
clients that connect to the Fingerprint database or DB2, or run rules that make SQL
calls to any DB2 database, such as for lookups, require the DB2 client installed.
These clients include Datacap Desktop, Datacap FastDoc, Rulerunner, and Datacap
Web Client. When you are using the Application Copy Tool, that computer must
have the DB2 client that is installed and connectivity to any source or destination
DB2 database.

Configuring an application to use the database


You configure the Datacap application for a DB2, Microsoft SQL Server, or Oracle
database by using Datacap Application Manager to set the encrypted connection
strings that are stored in the application configuration (.app) file.

You use the Datacap Application Manager to configure the application to use the
database. Datacap Application Manager works well with separate Test and
Production environments because it stores the information that is specific to the
Datacap application environment such as database locations and physical paths.

In a Test and Production paradigm, the physical applications are identical. The
rules, workflows, page types, and other components, are identical, except for the
*.app file. The difference between the environments is what the Datacap
Application Manager stores. In the Test environment, the Datacap Application
Manager stores the Test environment details while the Production system has its
own unique environmental settings.

When you configure Datacap for a DB2, Microsoft SQL Server, or Oracle database,
you can put the Administration, Engine, and Fingerprint schemas for the same
application in a single database. You cannot put schemas for different applications
in the same database.

For Oracle, each computer that accesses the database must have the Oracle 32-bit
client software installed. A net service name must be created on that computer as
well.

For DB2, if the user ID that created the database tables is different from user ID
that is used in the connection string, you must also specify the user ID that created
the database tables as the schema. To specify the correct schema, use the user ID in
the connection string. Use CurrentSchema=user ID that created the tables.

To configure an application to use the database:


1. In the Start menu click IBM Datacap Services > Datacap Application
Manager.
2. Select a Datacap application. For example, select TravelDocs.
3. Click the Main tab.
4. In the Administration field, click Browse and select a database provider.
5. Enter the database authentication information and click OK.
6. In the Engine field, repeat the Administration database steps.
7. Close the Datacap Application Manager.
8. If you are using a Fingerprint or Lookup database, scroll down to the
Workflows section and repeat these steps for each database.
9. Configure Datacap Web Client for Oracle.

2 IBM Datacap: System Administration Guide


a. Open the C:\Datacap\tmweb.net\app.ini file on the Developer
workstations and the Datacap Web Client.
b. Locate the Oracle line in the TravelDocs section and verify Oracle=1.
10. Configure Datacap Desktop for Oracle.
a. Open the C:\Datacap\tmweb.net\app.ini file on the Developer
workstations and the Datacap Web Client.
b. Locate the Oracle line in the TravelDocs section and verify Oracle=1.
c. Copy the app.ini file to the C:\Datacap\DcDesktop folder on the Developer
and Datacap Desktop thick client workstations.
11. Configure Report Viewer to use Oracle. You run these steps only on the
computers that host RV2.
a. Back up the C:\Datacap\RV2\reports.xml file.
b. Copy the app.ini file to C:\Datacap\RV2.
c. Locate the Oracle line in the APT section and change it to read Oracle=2.
d. Save the change.

Database security permissions


Datacap users must have database permissions for DB2, Microsoft SQL Server, or
Oracle to create the database and its schema, initialize the data in the database,
and run daily operations on the database.

You set up database permissions for Datacap users by using the database-specific
tool and following the instructions that are provided with your database:
v For DB2, contains multiple tools that you can use to configure DB2 databases.
Select one of the following tools and log on as administrator:
– Datacap Studio: the Datacap application development tool
– DB2 Command Line Processor CLP: a command line equivalent to Oracle
SQLPlus
– DB2 Command Line Processor CLPlus: another command-line equivalents to
Oracle SQLPlus
v For SQL Server, start SQL Server Management Studio or SQL Server Enterprise
Manager and log on to the server as the administrator
v For Oracle, start the SQLPlus tool and log on to the SYS account as SYSDBA

Assign the appropriate permissions from the following table to the Datacap users
based on these tasks:
v Database administrators: create the database and its schema
v Datacap developers: initialize the data in the database
v Datacap Server: Run daily operations on the Administrator and Engine database
tables
v Rulerunner and Fingerprint Services: Run daily operations on the Fingerprint
database
v Datacap Web Client, Rulerunner, Datacap Desktop, and other thick clients: Run
daily operations on queries that are run by actions. The permissions are
application-specific and apply only to those queries that are run by actions.
These users usually need read and in some cases write permissions to the
Fingerprint database and any Lookup and Export databases that exist.

The following table lists the database permission and indicates which permissions
are required for each of the database tasks.

Configuring Datacap databases 3


Table 1. Required database permissions for SQL Server, Oracle, and DB2 database tasks
Create database and Initialize data in the
Database permission schema database Run daily operations
Create an index Required Not required Not required
Drop an index Required Not required Not required
Create a sequence Required Required Not required
Create and initialize Required Required Not required
columns
Drop a sequence Required Required Not required
Select a sequence Required Required Required
Create a table Required Not required Not required
Drop a table Required Not required Not required
Insert a table Required Required Required
Select a table Required Required Required
Update a table Required Required Required
Delete records from a Required Required Not required
table
Create a trigger Required Not required Not required
Create a view Required Not required Not required

Defining the database structure


SQL scripts define the structure of the Datacap application databases for DB2,
Microsoft SQL Server, or Oracle databases.

Use the SQL scripts that are installed as part of the Datacap installation to create
an empty database structure. You create this database structure for the Datacap
Administration, Engine, and Fingerprint databases.

To define the database structure:


1. Go to C:\Datacap\support\DBScript and select the scripts for the database you
want to create:

Option Description
DB2 DB2_Adm_Base.sql

DB2_Eng_Base.sql

DB2_FP_Base.sql
Microsoft SQL Server SQL_Adm_Base.sql

SQL_Eng_Base.sql

SQL_FP_Base.sql
Oracle Oracle_Adm_Base.sql

Oracle_Eng_Base.sql

Oracle_FP_Base.sql

4 IBM Datacap: System Administration Guide


2. For DB2, start the DB2 CLPPlus tool and log on as the owner of the database
schema.
3. For SQL Server, start SQL Server Management Studio or SQL Server Enterprise
Manager and log on to the server as the administrator.
4. For Oracle, start the SQLPlus tool and log on as the owner of the database
schema.
5. Create the database by following the instructions that are provided in the
Microsoft SQL Server or Oracle documentation that was provided with your
database.
6. Open the appropriate scripts in the tool and run them to define the structure of
the Datacap application databases.

Creating a single Oracle database for a Datacap application


You can create a single Oracle database for the Administration, Engine, and
Fingerprint databases in a Datacap application.

You must use an Oracle database to create a single user for the Datacap application
databases. Oracle is the only database type that is supported for storing all three of
the Datacap application databases in one database when you are writing to that
database.

You define the structure of the Datacap application databases by running SQL
scripts for the Administration, Engine, and Fingerprint database schema. You can
run SQL scripts for these Datacap application databases separately to create a SQL
Server or Oracle database for each of the application databases.

For Oracle databases, you can run the SQL scripts together to create 1 Oracle
database that contains the Administration, Engine, and Fingerprint database
schema. This procedure creates a single Oracle database user for all the Datacap
application databases.

To create a single Oracle user for Datacap databases:


1. Start the SQLPlus tool and log on to the SYS@net service name as SYSDBA. The
net service name is specific to each computer.
2. Run the following script to create the user:
CREATE USER APTOra3X
IDENTIFIED BY APTOra3X;

Grant resource to APTOra3X;


Grant DBA to APTOra3X;
Grant EXP_FULL_DATABASE to APTOra3X;

Attention: The user name APTOra3x is used as an example. You can choose a
more descriptive name such as CaptureInvoiceTM or AcmeCapture to identify the
function of this particular Oracle database.
3. Disconnect from the SYS account and log on to the user account that you
created with SQLPlus.
4. Go to C:\Datacap\support\DBScript and run the following Oracle scripts:
v Oracle_Adm_Base.sql
v Oracle_Eng_Base.sql
v Oracle_FP_Base.sql
5. Disconnect from the user account.

Configuring Datacap databases 5


6. Copy the data from the source database by using the Application Copy Tool.
7. Point the Administration, Engine, and Fingerprint database schemas to the
same location.
8. Configure the application to use the database by using the database user name
that you created here.
Related tasks:
“Configuring an application to use the database” on page 2

Moving the application files


You can use the Datacap Application wizard to copy a Microsoft Access based
application and move it to a folder on another computer.

The following steps are not required to use a DB2, Microsoft SQL Server, or Oracle
database. These steps describe how to copy an application, move it to another
environment, and update the appropriate paths. For example, when you want to
move an application between Test and Production systems and update the paths to
the fingerprints. You can also rename the application when you move it.

You use the Datacap Application Copy Tool copy and move the application and its
databases at the same time.

To move the application files:


1. Open Start > All Programs > IBM Datacap Developer Tools > Datacap
Studio.
2. Click Datacap application wizard.
3. At the Overview window, click Next.
4. Select Copy an existing RRS application and click Next.
5. Select the name of the application that you want to copy. For example, select
TravelDocs.
6. In the Root folder on target system field, click [...] and select the database
server where you want to copy the application. For example, select
C:\Datacap.
7. In the Datacap Web folder field, click [...] and select the folder on the Datacap
Client where the application is installed. For example, select
C:\Datacap\tmweb.net.
8. Select Rename Copy and type the name of the application in the New Name
field.
9. Click Next to collect the information to use to copy the application.
10. Click Finish to copy the application to the target database server.
11. Set the Oracle setting in the apps.ini.
a. Go to the Datacap\tmweb.net\apps.ini and copy the App_name section.
b. Rename the App_name section to match your new application name.
c. Locate the line Oracle in the App_name section.
d. Change this field to read Oracle=1 for DB2 or Oracle. For SQL Server, use
Oracle=0.
e. Locate the DateTimeSeparator line and change it to read
DateTimeSeparator=’.
f. Save your changes.

6 IBM Datacap: System Administration Guide


Verifying the database connection
After you configure the application for the database, verify the connection to the
DB2, Microsoft SQL Server or Oracle database works properly.

To verify the database connection:


1. In the Start menu click IBM Datacap Developer Tools > Datacap Studio. If
you can log in and run the application by using the Test tab, the
Administration and Engine databases are working properly.
2. Click the Zones tab to verify that the Fingerprint database is working.
3. In the Start menu click IBM Datacap Services > Datacap Application
Manager. Press Test connection in the Connection string dialog to see if the
databases are working properly.

Advanced database settings for Datacap Server


Datacap can use custom connection strings from which it can target any database
type that has a supported database provider.

Connection strings

The supported database providers for which you can use these connection strings
are Microsoft Access, DB2, Microsoft SQL Server, and Oracle. The old Datacap
format connection strings are still supported to provide compatibility with an
earlier version to your existing database connections.

The following examples describe OLEDB connection strings for each of the
supported database providers:
DB2 using Standard Authentication
"Provider=IBMDADB2;Data Source= database alias; UID=******; PWD=******;
CurrentSchema=db2admin;"
DB2 using Windows Authentication
N/A
Microsoft Access using Standard or Windows Authentication
"Provider=microsoft.jet.oledb.4.0;data source=C:\Datacap\MyApp\MyAppadm.mdb;
persist security info=false;"
SQL Server using Standard Authentication
"Provider=sqloledb;data source=myServerAddress;Initial Catalog= myDataBase;
User Id=myUsername;Password=myPassword;"
SQL Server using Windows Authentication
"Provider=sqloledb;data source=myServerAddress;Initial Catalog= myDataBase;
Integrated Security=SSPI;"
Oracle using Standard Authentication
Provider=OraOLEDB.Oracle;Data Source=MyOracleDB;User Id=myUsername;
Password=myPassword;
Oracle using Windows Authentication
Provider=OraOLEDB.Oracle;Data Source=MyOracleDB;OSAuthent=1;

Registry settings

Special cases in which database might act differently than usual are controlled by a
set of settings in the registry. Datacap uses these settings when database providers

Configuring Datacap databases 7


must use alternative logic implementations. Otherwise, Datacap uses the default
behavior. There are special settings for different database behavior that is not
default.

The following settings are in the InterThread section of TMS registry profile at
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Datacap\TMS\InterThread.
TO_DATE
Formats the date and time field values in TO_DATE format in SQL
statements for the providers. This example contains the default TO_DATE
setting for Oracle.
ORACLE;ODBCORACLE;MSORACLE;ODBCMSORACLE;OraOLEDB.Oracle;MSDAORA;IBMDADB2;DB2OLEDB

ROWNUM
Use this ROWNUM syntax instead of SELECT TOP in SQL statements for
these providers. This example contains the default ROWNUM setting for
Oracle.
ORACLE;ODBCORACLE;MSORACLE;ODBCMSORACLE;OraOLEDB.Oracle;MSDAORA;IBMDADB2;DB2OLEDB

#DATETIME#
Use date and time field values that are wrapped in a # sign-in SQL
statements for these providers. Some of the databases want the date and
time field values in # signs. This example contains the default
#DATETIME# setting for MS Access.
MSACCESS;ODBCMSACCESS;Microsoft.Jet.OLEDB.4.0;Microsoft.ACE.OLEDB.12.0

"FIELD NAME"
Use field names wrapped in quotes in SQL statements for these providers.
Some database types need quoted fields in SQL statements. This example
contains the default "FIELD NAME" setting for Oracle.
ORACLE;ODBCORACLE;MSORACLE;ODBCMSORACLE;OraOLEDB.Oracle;MSDAORA;IBMDADB2;DB2OLEDB

"AUDIT"
Use audit table references wrapped in quotes in SQL statements for these
providers. In some databases Audit is a system/internal/key word, so you
must wrap Audit in quotes to differentiate these databases. This example
contains the default "AUDIT" setting for Oracle.
ORACLE;ODBCORACLE;MSORACLE;ODBCMSORACLE;OraOLEDB.Oracle;MSDAORA

MOVE_BY_ONE
When you must move the cursor on a recordset more than one row, you
do it by moving by one row at the time in a loop. Some providers might
have issues trying to move several rows at once, so you must do this loop
procedure for them. This example contains the default MOVE_BY_ONE
setting for Oracle.
ORACLE;ODBCORACLE;MSORACLE;ODBCMSORACLE;OraOLEDB.Oracle;MSDAORA

SELECT_COUNT
Use the SQL syntax for SELECT COUNT instead of using ADO API
GetRecordCount because GetRecordCount does not work for some
databases. This example contains the default SELECT_COUNT setting for
Oracle.
ORACLE;ODBCORACLE;MSORACLE;ODBCMSORACLE;OraOLEDB.Oracle;MSDAORA

RECORD_FORWARD_ONLY
Open ADO recordsets by using the forward only setting. The default
setting is static bidirectional, but some databases have issues with static
bidirectional recordsets. This example contains the default
RECORD_FORWARD_ONLY setting for Oracle.
ORACLE;ODBCORACLE;MSORACLE;ODBCMSORACLE;OraOLEDB.Oracle;MSDAORA

8 IBM Datacap: System Administration Guide


Administering your system
Administering your Datacap system includes configuring access to Datacap from
mobile devices, setting group and user permissions, managing workflow tasks, and
configuring shortcuts in your web client. You can monitor system performance,
schedule your web client to recycle daily, manage FastDoc files, and maintain
fingerprints.

Configuring access to IBM Datacap from mobile devices


Datacap document capture is a feature of the IBM® Content Navigator mobile app.
You can use this feature in the mobile app to scan and process documents,
photographs, and other items.

Ensure that the IBM Content Navigator server is configured to enable access from
mobile devices.

Download and install the IBM Content Navigator mobile app for your device:
iOS Version 7.0 and later or 7.1 and later
IBM Content Navigator mobile app for iOS
Android Version 4.3 or 4.4
IBM Content Navigator mobile app for Android

To configure the Datacap feature in the IBM Content Navigator mobile app, you
must install and configure Datacap Web Services. Then, you set up a profile to be
used with IBM Content Navigator.

To enable access to IBM Datacap on a mobile device:


1. Configure Datacap Web Services and verify that the Datacap Web Services
service page is displayed from the server and from a client.
For IBM Datacap V8.1: Configure both Internet Information Services (IIS) and
Datacap Web Services.
2. In Datacap Web Client (V8.1) or Datacap Navigator (V9.0 or later), add or
modify a job in the workflow:
a. Create the first task and set the Mode to Batch creation.
b. Set Program to Mobile.
3. In Datacap Studio, define batch level fields for document properties to be
entered on the mobile device. Then, add rules as needed to process these input
document properties.
4. In your database, create custom columns for any custom batch information to
show in the batch monitor.
5. In Datacap Studio, add rules to set values for the custom columns.
6. In Datacap Studio, define the PageNames dictionary to list only specific page
types. You can skip this step to list all page types that are defined in the
application.
7. If you use a FastDoc application, change the rules to process page types that
are already set, not only Other, Main, and Trailing pages.
8. Start the mobile IBM Content Navigator app.
9. Configure a new Datacap connection in the mobile app:

© Copyright IBM Corp. 2014 9


a. Enter a name for the connection, such as Datacap.
b. Enter the Datacap Web Services URL, for example: http://
your_datacap_server:port/.
c. Enter the user name and password for the IBM Datacap application.
d. Select an application and a profile.
From the mobile app, if no profile is displayed, the IBM Datacap mobile job is
not configured, or Datacap Web Services are not properly configured. Ensure
that Datacap Web Services is properly configured and that the Datacap Web
Services service page is displayed from the server and from a client.
Related tasks:
“Creating a custom column in the Job Monitor” on page 14
Related information:
Installing Datacap Web Services
Taskmaster web services installation (V8.1.0)
Enabling ISAPI extensions for Taskmaster web services (V8.1.0)
Configuring access to IBM Content Navigator from mobile devices

Datacap web clients administration


In the Datacap Web Client and the Datacap Navigator web client you can add
users, groups, and stations. Workflows, jobs, and tasks can be added and
configured in these web clients. You can also configure and run shortcuts that are
mapped to one or more tasks.

In Datacap Navigator, you can use the Classify option to edit page types when
they are incorrectly identified. You can also modify the Datacap Navigator layout
and other options by changing the user settings.

In both the Datacap Navigator and Datacap Web Client Job Monitor, you can
monitor and manage all batches and jobs. You can also run tasks from the Job
Monitor.

Users, groups, and stations administration


You can assign privileges and permissions to users, groups, and stations to an
application by using the Datacap Web Client or Datacap Navigator web client.

In an environment with multiple Datacap servers, the privileges and permissions


assigned to users, groups, and stations for an application are effective only on the
Datacap server where the change is made. All Datacap Server Services that connect
to the application must be restarted. The server does not need to be restarted but
the server service must be restarted.

When Workflow changes are made, all clients should be stopped before hand and
then after the Workflow changes all servers recycled before clients are allowed to
connect.
v Add a user - You can add a user to your application and assign privileges and
permissions to the user. You can also add a user to a Datacap group. When you
add a user to a group, the user inherits the privileges and permissions of that
group.

10 IBM Datacap: System Administration Guide


v Add a group - You can add a group to your Datacap application and assign
privileges and permissions to the group. All users that are members of the group
inherit the privileges and permissions that are assigned to the group.
v Add a station - You can add a station to your Datacap application and assign
permissions to run specific job tasks from that station.
v Set virtual stations - You can allow multiple users to log in to a station by
setting the maximum number of virtual stations to greater than zero. When a
station ID is set up with a Maximum number of virtual stations that is greater
than zero, multiple users can log in to the station ID. When you set the
maximum number of virtual stations to zero, multiple users are denied
authorization to log in to that station.
When you set up virtual stations, Datacap assigns a unique substation identifier
to each login and allows multiple logins up to the Maximum number specified.
If a user's session times outs and the Maximum number of virtual stations is
greater than zero, the user can log in again without requiring support from the
system administrator. When the Maximum number of virtual stations is set to
zero or the maximum number of virtual stations is reached, the user's next
attempt to log in will fail. The system administrator must clear the virtual
stations for that station ID to allow the user to log in again.

Workflows, jobs, and tasks administration


You configure workflows, jobs, and tasks in the Datacap Web Client or Datacap
Navigator web client.
v Workflow - You can create a new workflow and configure the workflow details,
including the Name, Description, and Program name. A workflow contains jobs
and tasks.
v Job - You can create a new job and configure the job details, including the
Name, Description, and Priority. Examples of the different types of jobs are a
Main Job, FixUp Job, and Web Job. A job contains tasks, such as Upload, Verify,
and Export.
v Task - You can create a new task and configure the task details, including Name,
Description, Mode, Queue by, and Store. For more information about the
Queue by and Store options, see Batch queuing to specific users and stations. To
configure the task, select a Program value such as Rulerunner, Datacap
Desktop, or Multiple to use with the task. Complete the task configuration with
the Setup options, such as Batch Processing, Page Processing, Custom Web
Panels, Rulerunner, FastDoc, and other settings.
Related concepts:
“Batch queuing to specific users and stations” on page 12

The Job Monitor and workflow administration


Managing the workflow includes running batches, monitoring the job queue, and
configuring applications, all of which you can do from the Datacap Web Client or
the Datacap Navigator web client. You can monitor the status of batches and run
tasks from the Job Monitor.

During the data capture process, documents go through a workflow that consists
of several discrete tasks such as scan, upload, page identification, recognition,
validation, verification, and export. Datacap uses a queuing mechanism to move
batches of documents through the workflow.

In the Job Monitor, you can view the status of all batches. Each row in the Job
Monitor represents one batch. For each batch, you can see its current position in
the workflow. For example, a batch that completed the scan and upload tasks is
Administering your system 11
now ready for page identification. In this example, the Task is PageID and the
Status is Pending. A batch that completed page identification and is ready to go
through the stage that includes document creation, recognition, and validation. The
Task is Profile and the Status is Pending.

You can run a web-based task on a batch by clicking the QID number in the Job
Monitor. If the task is not enabled for your web client and is a Rulerunner or
Datacap Desktop task, it cannot be started from the Job Monitor. The QID is
displayed but it is not an executable link. Typically, an operator selects the
web-based task through the Run Shortcut option, such as Verify or Fixup, and
Datacap runs the first batch that is queued for that task. This design allows
multiple operators to work from the same job queue and Datacap delivers batches
to the operators on demand.

Some tasks do not require an operator. For example, page identification,


recognition, and validation are background tasks that run without operator
intervention. You can configure Rulerunner to run background tasks automatically.
Rulerunner monitors the job queue for batches that are pending for specific
background tasks. When a batch is ready, Rulerunner processes it automatically.

Shortcuts administration
You can configure shortcuts in the Datacap Web Client or Datacap Navigator to
run tasks, such as Upload, FixUp, and Verify. The Shortcuts in the web client are
mapped to one or more tasks in the workflow.

In the web client, you configure the shortcut details, including the shortcut Name,
Description, Mode, and Permissions. The Mode option determines the behavior of
Datacap when a user clicks the shortcut. The following are the Mode options.
v Prompt/Web select: Datacap opens the highest priority-pending job in the
queue.
v Auto: Same as Prompt/Web select.
v Manual: Datacap displays the job queue so that the operator can select a batch
that is pending or on hold.
v Manual for Hold: If there are batches on hold, Datacap displays the job queue
with the jobs that are on hold. If there are no jobs on hold, Datacap opens the
highest priority-pending batch in the queue.

Batch queuing to specific users and stations


You can set up a batch workflow task to allow a user or station to queue the next
task to another user or station. Many combinations of users and stations can be set
up in your web client to open a batch and queue the next task to another user or
station.

You can define the users and stations that can open and process a batch through a
task. Setting up queuing is optional. You must set up the Store field on a prior
task that is performed by the target user or station, so it is available for use by a
subsequent task. For example, if the goal is for the user who scans batches to
verify all of the batches that they scanned, then set up Store User ID on the scan
task and Queue by User on the verify task. Each time a task runs that is
configured to Store user or station information, any previously stored user or
station information for the batch is overwritten.

The Workflow tab provides you with the ability to change these settings. Changing
the settings does not affect batches that are already queued.

12 IBM Datacap: System Administration Guide


The task's Queue by field lets you identify the combination of user ID and station
ID that can open a batch that is queued for this task. The options for the Queue by
field are:
v None: Any user on any station can open the batch (default setting). If a batch is
assigned to a user or station in the Job Monitor, then the Queue by None setting
for that batch is overridden and only the assigned user or station can access the
batch.
v Station: Only the station that stored the batch can open the batch.
v User: Only the user that stored the batch can open the batch.
v Other Station: The station that stored the batch cannot open the batch.
v Other User: The user that stored the batch cannot open the batch.
v Station and User: Only the same station and the same user that stored the batch
can open the batch.
v Station and Other User: Only a different user on the station that stored the
batch can open the batch.
v User and Other Station: Only the same user on a different station can open the
batch.
v Other Station and Other User: Only a different user on a different station can
open the batch.

Ensure that the option you choose for the Store field provides the information that
is required by the task that occurs later in the workflow. The options for the Store
field are:
v None: No user ID or station ID is stored (default setting).
v Station ID: Stores the station ID with the batch.
v User ID: Stores the user ID with the batch.
v Station ID and User ID: Stores the station ID and the user ID with the batch.

Example 1

The following table illustrates a workflow that is composed of four tasks where the
Scan task can be run by any user on any station, and the batch returns to the user
who scanned it for verification.

Task Queue By Store


Task 1 Scan None User ID
Task 2 Background (PageID, None None
Recognition)
Task 3 Verify User None
Task 4 Export None None

Example 2

The following table illustrates a two-pass workflow that is comprised of five tasks
and each batch is verified twice. These settings ensure that when the first Verify
operator finishes with a batch, a different operator performs the second Verify task.

Task Queue By Store


Task 1 Scan None None

Administering your system 13


Task Queue By Store
Task 2 Profiler (PageID, None None
Recognition)
Task 3 Verify1 None User ID
Task 4 Verify2 Other User None
Task 5 Export None None

Effects of application pool recycling on Datacap Web Client


batches
The IIS application pool for Datacap Web Client must be scheduled to recycle daily
to ensure optimal system performance. If batches are processing when the
application pool is recycled, Datacap Web Client attempts to change the status of
the batches.

For optimal system performance, the Microsoft Internet Information Services (IIS)
Datacap Web Client application pool must be recycled regularly. When you create
the Datacap Web Client site, the Datacap Web Client Server Configuration tool
sets the tmweb.net AppPool application pool values to recycle daily at 03:00:00
AM. You can change the App Pool Recycle Schedule in the Datacap Web Client
Server Configuration tool.

If the application pool recycles while the Datacap Web Client users are processing
batches, the browser sessions are closed. Datacap Web Client attempts to change
the status of the batches to Hold.

Some batches might remain in a running state and can be identified and reset
manually in the Datacap Web Client Job Monitor. You can also create a custom
Datacap Maintenance Manager application to search for batches that require
intervention.

Creating a custom column in the Job Monitor


You can define a custom column in the Job Monitor by adding a column in a
Datacap Engine database table.

To create a custom column in the Job Monitor, you must add a column in the
tmBatch table of the Datacap Engine database. The column name must be preceded
by pb_, such as pb_allowed. Configure the data type for MSSQL as nvarchar, for
Oracle the data type is nvarchar2, and the data type for Access is text.

You can use Microsoft Access to define a custom column in a development


environment but Access is not supported for group filtering because it cannot
perform the necessary query for additive groups.
1. In the tmBatch table in the Datacap Engine database, add a column with the
name preceded by pb_, such as pb_allowed.
2. Save the table and restart the Datacap server.
3. For SQL only, you must re-create the JobMonitor view by following this
procedure.
a. Open the JMView view for design.
b. Delete each item that appears in the Alias column.
c. Press the Exclamation Mark icon.

14 IBM Datacap: System Administration Guide


d. Save the view.
e. Open the JobMonitor view for design.
f. Delete each item that appears in the Alias column.
g. Press the Exclamation Mark icon.
h. Save the view.

Administering Datacap Navigator


Access the Job Monitor, run tasks, add users and groups, and configure stations
and workflows in Datacap Navigator.

Datacap Navigator user settings


Configure the layout and behavior of Datacap Navigator by changing your user
settings. To change the user settings from any Datacap Navigator view, click the
user ID drop-down menu and select Change User Settings.

For example, you can configure the following layouts and behaviors:
v Specify the station ID that you want to log in to.
v Arrange the widgets for the scan task page.
v Automatically submit a batch after the upload task is completed.
v Automatically override a validation failure during verification.

Administration view
As an administrator, you can configure your application and the application’s
components, and set or modify user permissions and privileges by using the
Datacap Navigator Administration view.

To open the Administration view, click the Open Datacap Administration View
icon in the Datacap Navigator client.
Related concepts:
“Administering your system” on page 9
Related information:
Creating jobs and tasks for your workflow
Workflows, jobs, and tasks
Planning stations for your Datacap applications

Batch status (Job Monitor)


You can monitor or change the status of all batches and jobs and run tasks from
the Datacap Navigator Job Monitor page.

During the data capture process, documents go through a workflow that consists
of several discrete tasks such as scanning, upload, page identification, recognition,
validation, verification, and export. Datacap uses a queuing mechanism to move
batches of documents through the workflow.

You can run a task on a batch by clicking the batch in the Job Monitor page and
selecting one of the available actions. If the task is not enabled for Datacap
Navigator and is a Rulerunner or Datacap Desktop task, it cannot be started from
the Job Monitor page.

Administering your system 15


To find a batch more quickly, enter information from any column in the Batch
Filter field. For example, enter pending in the Batch Filter field to view only the
jobs with a pending status.

To customize the columns of the table, click the user ID drop-down menu and
select Change User Settings and click the Job Monitor tab.

Tip: Click Refresh to update the Job Monitor frequently because other operators
might be changing the status of batches or jobs.

Image scans
You can scan your source images and collect them into batches by using Datacap
Navigator. To open the scan view, click the scan shortcut in the Datacap Navigator
client.

The Source field displays the directory from which the source files are scanned.
You can change the source directory by clicking Browse and choosing a new
source directory.

If your application includes a Start Batch panel, click Start Batch Panel to enter
any data specific to the batch that you want to collect.

You can use Hold or Cancel to stop processing the batch. While holding the batch
leaves it available to the same user for later processing, cancelling will also delete
both the batch and all of its data from the system.

When you are finished scanning, submit the batch to complete the task.

Batch verification
You run the Verify task in Datacap Navigator to ensure that your data was
accurately captured and recognized by your application. In a production
environment, Datacap verification tasks are run manually to identify and correct
potential data problems before you upload the images to Datacap.

The Batch Structure pane shows the batch hierarchy. You can use the controls to
manually restructure, reorder, and check the integrity of the batch.

To see the details of a specific page, you can click an image to load that page's
fields in the Field Detail pane. When a field fails validation, it has a red
background, and you must correct the data before you can complete the batch.
When the recognition results for a field show a low confidence with a yellow
background, you can click to update the contents. Alternatively, you can click
outside of the field to change the background color to white without making any
changes.

In addition, you can highlight words or lines from the Fingerprint CCO file in the
images by clicking the CCO Words or CCO Lines icons.

Batch upload
After you run the Scan task to capture your batch, you run the Upload task to
upload the images to the Datacap server. While this is a task that is automated by
Rulerunner in a production environment, you can upload images manually in
Datacap Navigator.

16 IBM Datacap: System Administration Guide


To find a batch more quickly, enter information from any Task List column in the
Batch Filter field. For example, enter pending in the Batch Filter field to view only
the jobs with a pending status.

To customize the columns of the table, click the user ID drop-down menu and
select Change User Settings and click the Task List tab.

Tip: Click the Refresh button to update the Task List frequently because other
operators might be changing the status of batches or jobs.

Page classification
Document assembly is usually an automatic process that runs in the background.
However, in some cases the automatic assembly task does not correctly identify
page types. When page types are incorrectly identified, you can use Classify to
manually edit the type for each page and modify the batch structure.

You edit the page type and status of any page in the batch within the Batch
Structure pane of the Classify task. Double-click a page in the Image Viewer pane
to highlight that page in the Batch Structure. You can also use the Batch Structure
pane to modify the document hierarchy.

Batch processing (Task List)


You can monitor the status of batches and jobs for a specific task and run pending
jobs from the Datacap Navigator Task List page.

During the data capture process, documents go through a workflow that consists
of several discrete tasks such as scanning, upload, classification, and verification.
Datacap uses a queuing mechanism to move batches of documents through the
workflow.

You can run a task on a batch by clicking the batch in the Task List page and
selecting one of the available actions.

To find a batch more quickly, enter information from any Task List column in the
Batch Filter field. For example, enter pending in the Batch Filter field to view only
the jobs with a pending status.

To customize the columns of the table, click the user ID drop-down menu and
select Change User Settings and click the Task List tab.

Tip: Click the Refresh button to update the Task List frequently because other
operators might be changing the status of batches or jobs.

Accessibility features of Datacap Navigator


Datacap Navigator includes features that make it more accessible for people with
disabilities.

Important: The accessibility features are supported on Microsoft Windows


operating systems web browsers only.

Keyboard input and navigation

The following features are available for keyboard input and navigation:
Keyboard input
You can use the keyboard instead of a mouse to operate Datacap

Administering your system 17


Navigator. To use any button on the user interface, move to the button and
press the Enter key. To enter data, move to the input field, enter data, and
press Enter or press the Tab key to exit the field.
Keyboard focus
The position of the keyboard focus is outlined or highlighted, indicating
which area of the window is active and where your keystrokes will have
an effect.
Keyboard navigation
You can use the Tab key, Shift+Tab, and Arrow keys to move around the
major elements of a page, view, or specialized section. For certain elements,
such as tree views or the calendar date picker, you can also use the Home,
End, Page Up, and Page Down keys. Pressing Ctrl+Shift+Down Arrow on
the browse page navigates through the banner, the toolbar, the tree view,
and the list view.
You can use JAWS to skip sections of content by going to landmark regions
on the page. In JAWS, press Insert+Ctrl+; to open a dialog box that
displays the list of landmarks. Select a landmark to skip blocks of sections
and to go to that region. For example, select main from the list of
landmarks to go to the main content of the page. Alternatively, you can go
to the main content of the page by pressing Insert+F7 in JAWS to open a
dialog box that displays a list of the hidden links on a page. You can select
Skip to main content to go to the main content or select Skip to
navigation buttons to go to the left navigation buttons. Use the Tab key to
navigate the links, press Enter to select a link, and then press Tab to move
tab focus to the target area that is associated with the selected link.
Click focus and tab focus
To navigate efficiently using the keyboard, it is important to understand
the distinction between click focus and tab focus. If you only use the
mouse to navigate, tab focus is unimportant; however, tab focus is essential
to using keyboard shortcuts.
v Tab focus is indicated by the dotted square around an item. You can
change tab focus by using the tab and arrow keys, or by clicking on an
item with the mouse.
– When you navigate using the Tab key, you move the tab focus
sequentially from one item to the next, and the click focus does not
change. At the end of a section of the page, the Tab key moves to the
first item in the next section.
– When you use the arrow keys, you move the tab focus and the click
focus from one item to the next, within the same screen section.
v Click focus is indicated by the colored highlighting surrounding an item.
You can change click focus by clicking on an item with the mouse, by
using the arrow keys, or by moving the tab focus to an item and
pressing Enter.
When Datacap Navigator opens a new window, such as a specific action,
or displays a dialog box that displays warnings or errors, focus is set back
to the top of the page after closing the dialog box or window. Use
Ctrl+Shift+Down Arrow and Up Arrow or use the Tab key to get back to
your original focus location.
Silent installation
For an accessible version of the installation, you must use the silent
installation feature.

18 IBM Datacap: System Administration Guide


Keyboard shortcut keys

You can use the keyboard to access all of the functions of Datacap Navigator.

In general, keyboard access conforms to standard Microsoft Windows guidelines.

Keyboard access differs from standard Microsoft Windows guidelines in the


following ways:
Access keys, tabbing, and tables
Access keys are provided only for buttons and menu items. Press the Tab
key to reach all fields.
Press the Tab key to move the cursor into a table. Press the Tab key again
to move the cursor to the next cell in a table. To move out of the table to
the next field, hold down the Ctrl key and press Tab. When the cursor is in
a table, pressing Enter is not equivalent to clicking OK to close the
window; you must move out of the table first.
If you want to edit a cell in a table that contains a combo box, press F2,
use the Down or Up arrow key to move to an item, and press Enter to
select it.
Tabs and paging
Switch between tabs by using the Left and Right Arrow keys.
Switch to the first tab by using the Home key. You can navigate to the last
tab by using the End key.
Go to the next page by pressing the Ctrl key with Page Down, or pressing
Ctrl+Tab.
Go to the previous page by pressing the Ctrl key with Page Up, or
pressing Ctrl+Shift+Tab.
Combination boxes
Use the Up and Down Arrow keys to move to an item. Then, press Enter
to select it.
Menus
On the Windows operating system, open a menu for an item that has focus
by pressing Shift+F10.
Navigate menu items by using the Up Arrow and Down Arrow keys.
Then, press Enter or the spacebar key to activate a menu item or to open a
submenu.
Close a menu or submenu by pressing Esc or the Left Arrow key.
Tree views
Typing characters or pressing Backspace while in the tree does not select
an item.
If you have Java™ 2 Software Development Kit 1.4 on your system, you can
press a letter key and the next item in the tree that begins with that
character is selected.
You can navigate tree views by using the following keys:
Table 2. Tree view navigation
Action Key
Navigate into tree Tab

Administering your system 19


Table 2. Tree view navigation (continued)
Action Key
Navigate to the next sibling Up Arrow
Open a subtree Right Arrow
Close a subtree Left Arrow
Navigate to an open subtree Right Arrow
Navigate to parent node Left Arrow
Activate a tree item Enter
Navigate to first tree node Home
Navigate to last visible tree node End

List boxes, check boxes, and radio buttons


In a list box, press the Down Arrow and Up Arrow keys to browse an item
and press the Enter key to select an item. To select multiple sequential
items, hold down the Shift key while pressing the Down or Up Arrow key.
If you have Java 2 Software Development Kit 1.4 on your system, you can
press a letter key to select items within a list box, combination box, or
table.
In list boxes, you can select individual radio buttons by pressing the Tab
key and then the spacebar key or by using the access keys. Arrow keys do
not select radio buttons within a group.
Calendar date picker
Navigate through the date cells by using the Left, Right, Up, and Down
arrow keys.
Switch to the same day in the next month by using the Page Down key.
Switch to the same day in the previous month by using the Page Up key.
Switch to the same day in the next year by pressing Ctrl+Page Down.
Switch to the same day in the previous year by pressing Ctrl+Page Up.
Navigate to the first day in the month by using the Home key.
Navigate to the last day in the month by using the End key.
Press Enter to select a date.
Hover help
Use the Tab key to move to a field or item that has hover help. Then, press
Ctrl+F1 to invoke the hover help.

Navigating pop-up windows

At various times,Datacap Navigator displays information or error messages in a


pop-up window. This section explains how to navigate each type of window using
the keyboard, and other accessibility information.
Table 3. Keys necessary to navigate pop-up windows without a mouse
Pop-up window type Keyboard options
Information To close, press Esc.
Alert To close, tab to the available buttons in the
window.

20 IBM Datacap: System Administration Guide


Table 3. Keys necessary to navigate pop-up windows without a mouse (continued)
Pop-up window type Keyboard options
Error To view the full error message, tab to Error
output and press Enter. Then tab to the
error message. To close, press Esc.
Tip: In Virtual PC Cursor mode, the focus
resets to the top of the current page after the
pop-up windows is closed.
Input Type the requested information. To close, tab
to OK or Cancel, and press Enter.

Compatibility with assistive technologies

Datacap Navigator is compatible with the JAWS screen reader application. Datacap
Navigator has the properties that are required for JAWS to make on-screen
information available to visually impaired users.

Requirement: You must start the JAWS screen reader by using the java command
instead of the javaw command; if you start the screen reader with the javaw
command, the screen reader does not work properly.

Product documentation

Documentation for this product is available in accessible formats.

Documentation is available in an accessible HTML format. With the HTML format,


you can view documentation according to the display preferences set in your
browser. It also allows the use of screen readers and other assistive technologies.

Documentation is also available in PDF format.

Keyboard shortcuts for Datacap Navigator


You can use keyboard shortcuts to navigate and select user-interface controls in
Datacap Navigator for the scan, upload, classify, and verify tasks.
Table 4. Keyboard shortcuts for the Datacap Navigator scan task
Keyboard shortcut Function
Ctrl + 1 Submit
Ctrl + 2 Hold
Ctrl + 4 Cancel
Ctrl + U Move up a page in the batch structure
Ctrl + D Move down a page in the batch structure
Ctrl + F10 Delete a page in the batch structure
Ctrl + F11 Delete all pages in the batch structure

Table 5. Keyboard shortcuts for the Datacap Navigator upload task


Keyboard shortcut Function
Ctrl + 1 Submit
Ctrl + 2 Hold
Ctrl + 3 Abort

Administering your system 21


Table 6. Keyboard shortcuts for the Datacap Navigator classify task
Keyboard shortcut Function
Ctrl + 1 Submit
Ctrl + 2 Hold
Ctrl + 5 Go to the previous page in the batch structure
Ctrl + 6 Go to the next page in the batch structure
Ctrl + 7 Go to the previous error page in the batch structure
Ctrl + 8 Go to the next error page in the batch structure
Ctrl + 9 Show and switch the super variable in the image
viewer title
Ctrl + F1 Expand or collapse the node to show or hide the
child node in a batch structure
Ctrl + F2 Copy a page into the current document
Ctrl + F3 Split the document in the batch structure
Ctrl + Y Join the current document to the previous
document
Ctrl + Q Mark the page status to Deleted or Problem
Ctrl + , Move the page up in the batch structure
Ctrl + . Move the page down in the batch structure
Ctrl + F8 Join all documents with the first document
Ctrl + F9 Check the integrity of the batch structure

Table 7. Keyboard shortcuts for the Datacap Navigator verify task


Keyboard shortcut Function
Ctrl + 1 Submit
Ctrl + 2 Hold
Ctrl + 5 Go to the previous page in the batch structure
Ctrl + 6 Go to the next page in the batch structure
Ctrl + 7 Go to the previous error page in the batch structure
Ctrl + 8 Go to the next error page in the batch structure
Ctrl + 9 Run the rule to validate the current page
Alt + L Go to the next low confidence field

Datacap Application Copy Tool


The Datacap Application Copy Tool is a migration tool that you can use to copy
and move a Datacap application. For example, you can move the application from
a test environment to replace an existing application in a production environment.

Some Datacap applications use a settings.ini file that contains UNC paths and
connection strings. The Datacap Application Copy Tool does not include this file
when it copies the application files.

When you copy databases to another environment, the Engine database is usually
not copied. You copy the Administration database and either create a new Engine
database or reuse an existing Engine database schema.

22 IBM Datacap: System Administration Guide


When Datacap Application Copy Tool is used as a command-line interface, it is an
automated alternative to the Datacap Studio Application wizard to the run the
following tasks:
Move new data into an environment for the first time
Copies all of the application files and databases from a Datacap application
in one environment and moves them into a new application in another
environment. There are some files that are not copied, such as
settings.ini, batches, input directories, output directories, and
non-standard directories. You must verify and correct the connection string
to the new application.
Creates a new index for the Administration database in the new
application. For example, you can create the application in a development
environment and move its application files and databases into a test
environment for quality testing and verification. After the application is
tested and ready for use, you can then move the entire application into a
production environment.
To rename an existing application, you use the Application Wizard in
Datacap Studio.
Update data in an existing environment
Copies updated application files and databases to an existing environment.
The application in the existing environment is an older version of the
application that is being copied. This older version is updated to match the
application that you are copying. For example, you can change the
document hierarchy and rules in an existing application and copy the
updated application into another environment. You can move the entire
application or only the parts of the application that you updated.
You can use this option to migrate your applications up to a new
environment or to back to a previous environment.
Change the database provider on your system
Copies databases from an existing database provider and moves them to
another database provider. For example, you can move your Datacap
application databases from a Microsoft Access database in one environment
to a DB2 database in another environment. The two environments must
mirror each other to ensure the data that is passed between the database
providers is synchronized.
To change the database provider, you must clear the Copy application
files check box and manually enter the connection strings for the
destination database. You do not have to enter the target path and
application name. After the files are copied, you update the connections
strings for the application to use the new database in Application Manager.
Back up the data on your system
Copies all of the application files and databases to a single folder to create
a checkpoint or backup of your system.

Configure the connection strings


You use connection strings to copy and move Datacap applications to a database in
another environment. Connection strings contain the information that is needed by
the database provider to establish a connection between the application and the
database.

Administering your system 23


When you connect your application to a database, ADO uses a database provider
to make the connection to the database. The supported database providers for
which you can configure connection strings are Microsoft Access, Microsoft SQL
Server, Oracle, and DB2. The old Datacap format connection strings are still
supported to provide compatibility with an earlier version to your existing
database connections.

Database providers make the connection to a database in different ways so you


must write the connection string for the database provider that you want to use.
For example, the database provider needs the address of the database server to
connect to. You specify the address in the connection string to tell the database
provider where to connect.

If you do not specify connection strings for an existing application, the database
provider uses the connection strings that are currently configured on the
application.

The following examples describe OLEDB connection strings for each of the
supported database providers:
DB2 by using Standard Authentication
This example describes the primary database. The Data Source value is the
database alias name that is cataloged from the Database Server that is
installed on Datacap Server. The Hostname and Database values can be
empty.
"Provider=IBMDADB2;Data Source=dcdb141;UID=******;PWD=******;
CurrentSchema=db2admin;"
This example describes the secondary database, which already exists. The
Hostname value is the IP address of the remote Database Server. The
Database value is the name of the database that is installed on the
Database Server. The DataSource value can be empty.
"Provider=IBMDADB2;Hostname=9.112.232.141;Data Source=;Database=dcdbNUI;
Password=******;UserID=******;"
DB2 by using Windows Authentication
N/A
Microsoft Access by using Standard or Windows Authentication
"Provider=microsoft.jet.oledb.4.0;data source=C:\Datacap\MyApp\MyAppadm.mdb;
persist security info=false;"
SQL Server by using Standard Authentication
"Provider=sqloledb;data source=myServerAddress;Initial Catalog= myDataBase;
User Id=myUsername;Password=myPassword;"
SQL Server by using Windows Authentication
"Provider=sqloledb;data source=myServerAddress;Initial Catalog= myDataBase;
Integrated Security=SSPI;"
Oracle by using Standard Authentication
Provider=OraOLEDB.Oracle;Data Source=MyOracleDB;User Id=myUsername;
Password=myPassword;
Oracle by using Windows Authentication
Provider=OraOLEDB.Oracle;Data Source=MyOracleDB;OSAuthent=1;

24 IBM Datacap: System Administration Guide


Datacap Application Copy Tool Command Line Interface
By using the command line options for the Datacap Application Copy Tool, you
can specify the Datacap application that you want to copy and move that
application into another environment.

Command line syntax

The following Backus Normal Form (BNF) describes the command line syntax that
is used by the Datacap Application Copy Tool to copy and move applications and
databases.
<syntax> :=<source> <dest> [<app-status>*] [<copy-type>*] [<clear>*] [-s] [-i]
[-s] : = silent (use the Command Line Interface)
[-i] : = interactive (display the UI)
<source> :=-from [-an <app>] [-af <folder>] [-adb <DB>] [-fdb <DB>] [-edb <DB>] <app-type>
<dest> :=-to [-an <app>] [-af <folder>] [-adb <DB>] [-fdb <DB>] [-edb <DB>] <app-type>
<app-type> :=-how <online|datafile>
<app-status> :=-oapp <new|update>
<copy-type :=-copy <users|roles|workflow|rules|dco>
<clear> :=-clear <audit|debug|batches|stats|fpstats>

Commands

The Datacap Application Copy Tool uses the -from and -to parameters to specify
the source and destination applications.
-from
Specifies the source application that you want to copy
-to
Specifies the destination application that you want to create or update

These two parameters introduce specifications for source and destination, such as
the application name and database connections. For example, the following
command, with appropriate values entered for the italicized items, copies a source
application to the destination environment by using the online migration method.
DAppCopy -from -an Application -how online -to -an NewApplication
-af NewApplicationFolder -how online -oapp new

Command-line options

The following options apply to the source environment when they are preceded by
the -from parameter. These options apply to the destination environment when
they are preceded by the -to command.
an Application
The name of the application that you want to move
If the application exists, you can specify the Application name only. Omit the
Folder and DB parameters.
-af Folder
Following the -from parameter, the path of the folder in the source
environment from which you want to copy the application.
Following the -to parameter, the path of the folder in the destination
environment into which you want to move the application.
-adb DB
The connection string to the Administration database of the source or
destination application that you want to move. Use Microsoft OLEDB
Connection syntax in the connection string.

Administering your system 25


-edb DB
The connection string to the Engine database of the source or destination
application that you want to move. Use Microsoft OLEDB Connection syntax
in the connection string.
-fdb DB
The connection string to the Fingerprint database of the source or destination
application that you want to move. Use Microsoft OLEDB Connection syntax
in the connection string.
-how method
The method that you want to use to access the source or destination
application:
v online: clone the application from the source environment or copy it directly
to the destination environment.
v datafile: copy the files and databases of the application to portable data
files, or copy portable data files to files and databases in the destination
environment.
v backup: copy all of the application files and databases to a single folder to
create a backup for comparison purposes.

The following options do not apply to the source environment. They apply to the
destination environment when they are used with the -to parameter.
-keep users|roles|workflow
Preserves the users, roles, or workflow in the destination Administration
database. To preserve users, roles, and workflows in the destination
Administration database, use the -keep option three times. For example, enter
-keep users -keep roles -keep workflow.
-clear audit|batches|debug
v audit: Removes all records from the audit table in the destination
Administration database.
v batches: Removes all batches from the destination Engine database.
v debug: Removes all debug records from the destination Engine database.
To remove multiple items, repeat the -clear option for each item that you
want to remove. For example, enter -clear audit -clear batches -clear
debug.
-oapp new|update
The type of migration that you want to run:
v new: create a new application in the destination environment with the
application files and databases from the source environment.
v update: update an existing application in the destination environment with
the updated application files and databases from the source environment.

Application migration options


You can migrate applications and databases on a computer that has access to both
the source and target environments. You can also use multiple computers that each
have access to one of these environments.

The following migration options clone the application files and databases of an
existing application in the source environment and copy the application to a
specified location in the destination environment.
v Online: Runs a one-step process in which you use a computer that must have
access to both the source environment and the destination environment.

26 IBM Datacap: System Administration Guide


v Datafile: Runs a two-step process in which you use a computer with access to
the source environment to create portable data files. The data files contain the
application files and databases that you want to copy. You move the portable
data files to a computer with access to the destination environment. You run
Datacap Application Copy Tool on this computer to move the application files
and databases into the destination environment. If both computers can access the
portable data files, you do not have to physically move these files to the second
computer.

The following use case examples on different databases to show the options to use
for an Online migration and a Datafile migration.
Online migration
In this Microsoft SQL Server example, you clone a new APT application
from a database in the source environment and copy it to a specified
location in the destination environment. The computer must have access to
both environments.
DAppCopy -from -an APT -af C:\Datacap\APT
-adb "Provider=SQLOLEDB;Data Source=localhost;Initial Catalog=APTAdm;
Integrated Security=SSPI;"
-edb "Provider=SQLOLEDB;Data Source=localhost;Initial Catalog=APTEng;
Integrated Security=SSPI;"
-fdb "Provider=SQLOLEDB;Data Source=localhost;Initial Catalog=APTFP;
Integrated Security=SSPI;" -how online
-to -an APT -af C:\Datacap\APT
-adb "Provider=SQLOLEDB;Data Source=localhost;Initial Catalog=APTAdm;
Integrated Security=SSPI;"
-edb "Provider=SQLOLEDB;Data Source=localhost;Initial Catalog=APTEng;
Integrated Security=SSPI;"
-fdb "Provider=SQLOLEDB;Data Source=localhost; Initial Catalog=APTFP;
Integrated Security=SSPI;"
-how online -oapp new

Datafile migration
In this Microsoft Access example, you copy the TravelDocs application in
the source environment to portable data files on flash drive Z:
DAppCopy -from -an TravelDocs -af C:\Datacap\TravelDocs
-adb "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Datacap\TravelDocs\
TravelDocsAdm.mdb"
-edb "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Datacap\TravelDocs\
TravelDocs Eng.mdb"
-how online
-to -an PortApp -af Z:\PortApp
-adb "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=Z:\PortApp\DBs\
PortAdm.mdb"
-edb "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=Z:\PortApp\DBs\
PortEng.mdb"
-clear batches -how datafile -oapp new

You can simplify this datafile migration, for example:


DAppCopy -from -an TravelDocs -how online -to -af C:\temp\TravelDocsSnapshot
-how datafile

In this DB2 example, you copy the application from the portable data files
on flash drive Z: to a new TravelDocs application in the destination
environment.
DAppCopy -from -af c:\TravelDocsSnapshot -how datafile
-to -an TravelDocs2 -af \\SomeFolder\Datacap\TravelDocs
-adb "Provider=IBMDADB2;Hostname=DB2Instance;Database=TravelDocAdm;
Integrated Security=SSPI;"
-edb "Provider=IBMDADB2;Hostname=DB2Instance; Database=TravelDocEng;
Integrated Security=SSPI;"
-fdb "Provider=IBMDADB2; Hostname=DB2Instance;Database=TravelDocFP;
Integrated Security=SSPI;" -how online -oapp new

Administering your system 27


The Datacap Application Copy Tool creates a troubleshooting log file in
%temp%\dappcopy.log, where %temp%\ is a Windows shortcut to the TEMP
directory. For example, the TEMP directory might be C:\Users\USERNAME\
AppData\Local\.

Moving an application into a new environment


You can copy all of the application files and databases from a Datacap application
in one environment and move them into a new application in another
environment.

When Datacap Application Copy Tool creates a new application, the copy process
updates the environmental information in Datacap Application Manager (.app) for
known values. These values include the Administration, Engine, and Fingerprint
databases, and file paths that are in the application folder. Other environmental
values, such as encrypted values, export and lookup database connections, and file
paths that are not in the application folder, are emptied in the new application and
must be manually updated by using Datacap Application Manager.

You can create an application in a development environment and move its


application files and databases into a test environment for quality testing and
verification. After the application is tested and ready for use, you can then move
the entire application into a production environment.

When you move an application, the following files in the application folder are
copied:
v The dco.xsl and *.app files
v Folders with names that start with dco_
v Fingerprint files (optionally)

The Administration database contains workflows, users and groups, and


authorization information.

The Fingerprint folder and database can be excluded if Fingerprint learning is


enabled. If the destination environment has fewer fingerprints, you can use the
Fingerprint Maintenance Tool.

In the Administration database, the audit table and Engine database table are
cleared.

To move an application into a new environment:


1. At the prompt, type DAppCopy followed by these commands all on one line.
2. In the -from command, specify the following options for the source
environment.
a. -an: the name of the Datacap application database to copy.
b. -af: the path name of the folder from which to copy the Datacap
application.
c. -edb, -adb, -fdb: the connection strings that are used by the application
database.
d. -how: the migration option to use as -online or -datafile.
e. -oapp: the type of migration to run as new.
3. In the -to command, you specify the same options for the destination
environment.

28 IBM Datacap: System Administration Guide


Important:
For a new application in the destination environment that uses a non-Microsoft
Access database, you must specify the database provider in connection strings
for the application databases. If the database provider is not specified, the
databases are created in Microsoft Access.

In this example new TravelDocs applications are moved from the source
environment to the destination environment by using the online migration option.
Both environments are using the DB2 database provider.
DAppCopy -from -an TravelDocs -af C:\Datacap\TravelDocs
-adb "Provider=IBMDADB2;Data Source=localhost;Initial Catalog=TravelDocAdm;"
-edb "Provider=IBMDADB2;Data Source=localhost;Initial Catalog=TravelDocEng;"
-fdb "Provider=IBMDADB2;Data Source=localhost;Initial Catalog=TravelDocFP;"
-how online -oapp new
-to -an TravelDocs -af C:\Datacap\TravelDocs
-adb "Provider=IBMDADB2;Data Source=localhost;Initial Catalog=TravelDocAdm;"
-edb "Provider=IBMDADB2;Data Source=localhost;Initial Catalog=TravelDocEng;"
-fdb "Provider=IBMDADB2;Data Source=localhost; Initial Catalog=TravelDocFP;"
-how online -oapp new
Related reference:
“Datacap Application Copy Tool Command Line Interface” on page 25
“Application migration options” on page 26

Updating an application in an existing environment


You can update application files and databases move either the entire application
or the updates to an existing environment.

When Datacap Application Copy Tool updates an existing application, the


destination .app file is not changed. Any keys that are added to Datacap
Application Manager in the source application environment must be added to the
destination application environment.

When you update an existing application, you can copy the actors, roles, and
workflows that are associated with the application. The actors, roles, and
workflows must be the same for the source and destination applications. The copy
process might fail, if you copy only the workflows.

To move an application into a new environment:


1. At the prompt, type DAppCopy followed by these commands all on one line.
2. In the -from command, specify the following options for the source
environment.
a. -an: the name of the Datacap application database to copy.
b. -af: the path name of the folder from which to copy the Datacap
application.
c. -edb, -adb, -fdb: the connection strings that are used by the application
database.
d. -how: the migration option to use as online or datafile.
e. -oapp: the type of migration to run as update.
3. In the -to command, you specify the same options for the destination
environment.

In this example updated Medical Claims applications are moved from the source
environment to the destination environment by using the online migration option.
Both environments are using the DB2 database provider.

Administering your system 29


DAppCopy -from -an MClaims -af \\Development\Datacap\MClaims
-adb "Provider=IBMDADB2;Hostname=Devhost;Database=MClaimsAdm;"
-edb "Provider=IBMDADB2;Hostname=Devhost;Database=MClaimsEng;"
-fdb "Provider=IBMDADB2;Hostname=Devhost;Database=MClaimsFP;"
-how online
-to -an MClaims -af \\Production\Datacap\MClaims
-adb "Provider=IBMDADB2;Hostname=Prodhost;Database=MClaimsAdm;"
-edb "Provider=IBMDADB2;Hostname=Prodhost;Database=MClaimsEng;"
-fdb "Provider=IBMDADB2;Hostname=Prodhost;Database=MClaimsFP;"
-how online -oapp update
Related reference:
“Datacap Application Copy Tool Command Line Interface” on page 25
“Application migration options” on page 26

Changing the database provider


You copy the Datacap application databases that exist in a database provider and
move them to another database provider. For example, you can move application
databases from a Microsoft Access database in one environment to a DB2 database
in another environment.

For any database except Microsoft Access, the destination database must be
installed and able to run the scripts that create the database schema. When
updating an existing application, the updated application must be the same
application as the existing application. For example, you cannot update a
TravelDocs application with an Accounts Payable application.

To change the database provider:


1. At the prompt, type DAppCopy followed by these commands all on one line.
2. In the -from command, specify the following options for the source
environment.
a. -an: the name of the Datacap application database to copy. Skip this step if
you want to copy only the database and not the application files.
b. -af: the path name of the folder from which to copy the Datacap
application.
c. -edb, -adb, -fdb: The connection strings that are used by the application
database.
d. -how: the migration option to use as -online or -datafile.
3. In the -to command, specify the same options for the destination environment.
Use the connection strings for the new database provider.

In this example APT application databases are moved from Microsoft SQL Server
in the source environment to DB2 in the destination environment by using the
online migration option.
DAppCopy -from -an APT -af c:\Datacap\APTSQL
-adb "Provider=SQLOLEDB;Data Source=localhost;Initial Catalog=APTAdm;"
-edb "Provider=SQLOLEDB;Data Source=localhost;Initial Catalog=APTEng;"
-fdb "Provider=SQLOLEDB;Data Source=localhost;Initial Catalog=APTFP;"
-how online
-to -af C:\Datacap\APTDB2
-adb "Provider=IBMDADB2;Server=MyDB2:5000;Database=APTAdm;UID=myUserName;PWD=myPassword;"
-edb "Provider=IBMDADB2;Server=MyDB2:5000;Database=APTEng;UID=myUserName;PWD=myPassword;"
-fdb "Provider=IBMDADB2;Server=MyDB2:5000;Database=APTFP;UID=myUserName;PWD=myPassword;"
-how online
Related reference:
“Datacap Application Copy Tool Command Line Interface” on page 25
“Application migration options” on page 26

30 IBM Datacap: System Administration Guide


Migrating a single database to another database provider
You can copy a single Datacap application database and migrate to use another
database provider.

You can use the Datacap Application Copy Tool to run your existing Datacap
application databases on another database product. For example, you might be
running a Microsoft SQL Server database and you want to change to a DB2
database.

To migrate a database to another database provider, you specify only the source
and destination database information on the command line.

To migrate a database to another database provider:


1. At the prompt, type DAppCopy followed by these commands all on one line.
2. In the -from command, specify -edb, -adb, or -fdb and the connection
information for the source database.
3. In the -to command, you specify the same information for the destination
database.

In this example a Datacap Administration database is migrated from Microsoft


SQL Server to DB2.
DAppCopy -from -adb "Provider=SQLOLEDB;Data Source=localhost;Initial Catalog=APTAdm;"
-to -adb "Provider=IBMDADB2DB;Server=MyDB2:5000;Database=APTAdm;UID=myUserName;PWD=myPassword"

Datacap Application Copy Tool User Interface


You can use the Datacap Application Copy Tool User Interface to move your
Datacap applications and their databases into another environment.

To copy applications and databases on the Datacap Application Copy Tool User
Interface:
1. In the Start menu, click All Programs > IBM Datacap Developer Tools >
Datacape Application Copy Tool.
2. In the Copy from pane, specify the following information.
a. Select the location of the Datacap application and its databases.
b. Select the name of the application to move.
c. Enter the connection strings to the Administration and Fingerprint
application databases that you want to move. Use Microsoft OLEDB
Connection syntax in all of the connection strings.
3. In the Copy to pane, specify the following information if you are copying
application files:
a. Select the name of the application to move or create a new application
name.
b. Select the location where you want to copy the application.
c. Check Copy application files.
d. Check the items that you want to copy with the application files; Document
Hierarchy, Rules.
e. Check the existing data that you want to save on the destination
Administration database; Workflows, User and Groups.
f. Check Clear Audit table if you want to remove all of the existing records
from the audit table in the Administration database.
g. Enter the connection string to the destination Administration database. Use
Microsoft OLEDB Connection syntax in all of the connection strings. The
Administering your system 31
connection strings must contain login ID and password credentials. They
cannot contain the asterisks, which result from cutting and pasting a
connection string from Datacap Application Manager.
h. Check Fingerprints if you want to save the existing fingerprints in the
Fingerprint database.
i. Enter the connection string to the destination Fingerprint database. The
connection strings must contain login and password credentials.
j. Check Clear Engine Database if you want to remove the existing batches
from the Engine database.
k. Enter the connection string to the destination Engine database. The
connection strings must contain login and password credentials.
4. Click OK to copy the application files and databases from the source database
to the destination database.
5. Press Exit to shut down the Datacap Application Copy Tool.
Related concepts:
“Configure the connection strings” on page 23

Monitoring system performance with IBM System Dashboard for


Enterprise Content Management
You can monitor Datacap system performance through the IBM System Dashboard
for Enterprise Content Management.

You must download the dashboard software separately and install it in your
environment, along with a supported version of Java. You can then enable the
associated dashboard listener component that is installed automatically with
Datacap. Ensure that the dashboard product is not collocated on a computer with
the Datacap components that you want to monitor.

Tip: The System Dashboard for Datacap Version 9 provides a simple interface that
you can use to view events. The license for IBM System Dashboard is included
with all Datacap licenses. However, for additional functionality, you can purchase
IBM ECM System Monitor under a separate license.

The dashboard listeners that are installed with the Datacap software provide
counters to monitor client login activity, server requests, database actions, batch
tasks, and file access. You can monitor actions for the Datacap Server, Rulerunner,
and Datacap Web Client components.

By default, Datacap Server and Rulerunner are always available for dashboard
monitoring. Datacap Web Client is also installed to be available for system
monitoring, but you have the added ability to disable and re-enable the associated
listeners through a setting in the server.ini file.

Enabling dashboard listeners

To enable or disable dashboard listeners for monitoring Datacap events, enter a


value of 1 (enable) or 0 (disable) for the InformPCH parameter in the General
section of the install_path\datacap\tmweb.net\server.ini file. The server.ini
file is located on the affected Datacap Web Client server where you want system
activities monitored.

32 IBM Datacap: System Administration Guide


Datacap Server events

In the dashboard, you can monitor the Datacap Server events. All time-related
counters are in nanoseconds.

The dashboard outputs Datacap Server information in a hierarchical presentation.


For example:
Batches
Batches/Created
Batches/Created/Create time
Batches/Grabbed
Batches/Grabbed/Grab time
Batches/Released
Batches/Released/Release time
...

Table 8. Client actions for Datacap Server


Event Description
Connect A new client connected.
Login A client logged in.
Logoff A client logged off.
Disconnect A client disconnected.

Table 9. OLEDB database events for Datacap Server


Event Description
Open A new connection to a database was created
through OLEDB.
Time to open The time it took to create a database
connection through OLEDB.
Close A connection to a database through OLEDB
was closed.
Execute An execute of an SQL statement was done
through OLEDB, as in, any SQL statement
that includes SELECT.
Execute time The time it took for an execute of an SQL to
be done through OLEDB, as in, any SQL
statement other than SELECT.
Open recordset time The time it took to open a recordset through
OLEDB, as in, execute SELECT.

Table 10. ADO database events for Datacap Server


Event Description
Open A new connection to a database was created
through ADO.
Time to open The time it took to create a database
connection through ADO.
Close A connection to a database through ADO
was closed.
Execute An execute of an SQL statement was done
through ADO, as in, any SQL statement that
includes SELECT.

Administering your system 33


Table 10. ADO database events for Datacap Server (continued)
Event Description
Execute time The time it took for an execute of an SQL to
be done through ADO, as in, any SQL
statement other than SELECT.
Open recordset time The time it took to open a recordset through
ADO, as in, execute SELECT.
selectXML time The time it took to open a recordset through
ADO and return results in XML format.
atomic selectXML An atomic selectXML action was done
through ADO. This action creates a
connection to a database, executes a SELECT
SQL statement, formats the resulting
recordset in XML, and closes the connection
to the database.
atomic selectXML time The time it took to do an atomic selectXML
action through ADO.

Table 11. Batch events for Datacap Server


Event Description
Created A new batch was created.
Create time The time that was required to create a batch.
Grabbed A batch was grabbed by a client for
processing.
Released A batch was released by a client after
processing.

Table 12. Files events for Datacap Server


Event Description
Opened A file was opened for a client.
Closed A file was closed by a client.
IO A file system input/output was done on a
file that was requested by a client.
Time to open The time that was required to open a file for
a client.
Time to read The time that was required to read a file
contents for a client.
Time to write The time that was required to save data to a
file for a client.
Time to close The time that was required to close a file for
a client.

Rulerunner events

The Rulerunner events can also be monitored in the dashboard. All time-related
counters are in nanoseconds. Some of the event counters are fixed, and some are
dynamically created. Each configured thread creates a separate executable process
of Rulerunner (RRProcessor.exe), and each process has an associated dashboard
listener. Each listener has the same name, Rulerunner:, but with a unique ID

34 IBM Datacap: System Administration Guide


number appended to it, such as Rulerunner::49205. Every event begins with the
node Thread0. Two categorical nodes are always displayed: Applications and
General.

Important: Rulerunner threads are actually separate processes. The initial node
Thread0 is a historical artifact and can be ignored.

The dashboard outputsRulerunner information in a hierarchical presentation, for


example:
Thread0
Thread0/Applications
Thread0/Applications/1040EZ
Thread0/Applications/1040EZ/Query Application Service
Thread0/Applications/1040EZ/Query Application Service/Duration
Thread0/General
Thread0/General/No pending batches

Under the Applications node, a subnode is displayed for each application that is
configured, for example, TravelDocs, 1040EZ, or Datacap Accounts Payable (APT).
Under each application node is a Main Job and a Query Application Service
counter. Individual application-specific tasks are noted under the Main Job node.
Table 13. Application events for each Rulerunner process
Event Description
Applications A listener node under which all configured
applications are displayed.
application_name A listener node whose name is a configured
application, for example, TravelDocs.
Main Job The listener node under which typical
application-specific tasks are listed.
task_name A listener node whose name is a configured
task, for example, PageID, Profiler, and
Vscan.
Batch grabbed The number of batches that were grabbed by
an application for processing a task.
Batch released A listener node that represents the number
of batches that were released by an
application after processing a task.
batch_status A sublevel counter of Batch released, whose
name shows the status of each released
batch, for example, pending, aborted, hold,
offline.
Batch statistics updated The average time that was required to
update the statistics through a SQL request.
Running RRS The average time that was required for the
Rulerunner Service to complete its running
of rules.
Query Application Service A counter that contains the total number of
requests to Datacap Application Manager.
Under this node is an accumulator that
contains the average time spent to request
information from Datacap Application
Manager.

Administering your system 35


Table 14. General events for each Rulerunner process
Event Description
Disconnected All All Rulerunner threads disconnected.
Disconnected from TM server A Rulerunner thread has disconnected from
the Datacap server.
Logged off A Rulerunner user logged off.

Datacap Web Client events

In the dashboard, you can monitor the Datacap Web Client events. All time-related
counters are in nanoseconds.

The dashboard outputs Datacap Web Client information in a hierarchical


presentation, for example:
application/Hits//tmweb.net/Task/gstopb.aspx
application/Hits//tmweb.net/Task/uplbfcl.aspx
application/Hits//tmweb.net/Task/utility.asmx
application/Hits//tmweb.net/Task/vscancl.aspx
application/Hits//tmweb.net/buttons.aspx
application/Hits//tmweb.net/jmonitor.aspx
application/Hits//tmweb.net/wflow.aspx
Clients
Clients/application/TMLogin
Clients/application/TMLogoff
...

Table 15. Application events for Datacap Web Client


Event Description
Application The application that was run.
Bits The functions that were run and the time
spent for each.
Get Buttons The time that was required to present a URL
for the user interface to present the user
with list of buttons, shortcuts, or similar
elements.
Stop Batch The time that was required to stop a batch
process.
TMLogin A user action to log into Datacap Web
Client.
TMLogoff A user action to log out of Datacap Web
Client.
Tricky Select XML The time that was required to display
database information in the user interface by
using an internal database SQL select action,
for example, for data lookup.
Hits A designated number of bits that represents
a user request in the user interface, for
example, a request for a particular URL to
display.

36 IBM Datacap: System Administration Guide


Table 16. Client events for Datacap Web Client
Event Description
Clients A node that represents a set of Datacap Web
Client users.
Application The application that a user is running, for
example, Datacap Accounts Payable.
TMLogin The time that was required to log into
Datacap server.
TMLogoff The time that was required to log out of
Datacap server.
Session End The time that was required to end a Datacap
Web Client session.
Session Start The time that was required to start a
Datacap Web Client session.

Related information:
IBM FileNet P8 system overview
IBM System Dashboard for Enterprise Content Management Users Guide

Shutting down Datacap for maintenance


You must stop the Datacap software applications to perform system-wide
maintenance, back up your environment, install new Datacap software, or upgrade
or remove existing Datacap software.

Before you stop and restart Datacap, make a note of the Datacap software
components that are running on each machine. Whether you are running the
software on a single machine configuration or a Datacap network configuration,
you must stop and restart the Datacap software in the appropriate sequence.

To stop and restart Datacap software:


1. Shut down all of the Datacap client software, including Datacap Desktop,
Datacap Studio, FastDoc, Maintenance Manager, Datacap Web Client, Datacap
Navigator, the Datacap Web Client Upload Service, and the Rulerunner Service.
2. Shut down all of the web services such as Datacap Web Client, Report Viewer,
Fingerprint Service, and Datacap Web Services.
3. Shut down the Datacap Server service.
4. Stop the databases.
5. Perform these steps in reverse order to restart Datacap.
Related information:
AutoDelete batches with Datacap Mainentance Manager

Administering your system


Administering your Datacap system includes configuring access to Datacap from
mobile devices, setting group and user permissions, managing workflow tasks, and
configuring shortcuts in your web client. You can monitor system performance,
schedule your web client to recycle daily, manage FastDoc files, and maintain
fingerprints.

Administering your system 37


38 IBM Datacap: System Administration Guide
Using Datacap Desktop with your Datacap applications
After you successfully install Datacap 9.0, you can use Datacap Desktop to create
batches, identify pages, create documents, and export batches.

You can use Datacap Desktop to complete these tasks:


v VScan: This task is for a virtual scan that imports files from a specified location,
and is used mostly for demonstration purposes.
v PageID: Identifies the page type of a scanned image.
v Profiler: Creates documents from page types based on pre-defined criteria.
v Export: This task exports batches to a specified location.
v Fixup: This task requires user input to correct any errors or integrity issues that
a preceding task encounters. The batch does not continue to the next task until
the Fixup task is completed.
v Background: This task completes all tasks that do not require user intervention,
including PageID, Profiler, and Export, and automates the completion of
pending batches.

To use Datacap Desktop to complete a task, you must specify Datacap Desktop as
the program to use in the task’s setup dialog. You access the task’s setup dialog by
selecting the task on the Workflow page in your web client..

You can also create a new task, or modify an existing task, to use Datacap Desktop.

Creating and configuring a task to use with Datacap Desktop


The Datacap Studio application wizard creates a workflow that includes the Main
Job, a Fixup Job, and a Web Job. By default, the application wizard does not create
a scan task that you can use for scanning hardcopy pages. To scan pages and
create a batch with Datacap Desktop, you need to manually create a scan task.

If your 8.1 application was using DotEdit or DotScan, you must update the setup
information in Datacap Web Client to use Datacap Desktop. If you do not see the
setting options for Datacap Desktop, change the selected program, and then the
setting options for Datacap Desktop are automatically available.

If the program that you want to use is already selected, change to another
program, then select your original program, and press apply. For example, if your
program is Rulerunner, change the program to Multiple, then select Rulerunner
again and press Apply. The Datacap Desktop setup options are available.

The Main Job and the Web Job both contain sufficient tasks for processing a batch,
from batch creation to exporting the batch. However, you might need to create a
task that requires special handling, such as scanning hardcopy pages.

Follow this procedure to create a task to use with Datacap Desktop.


1. In your web client, log on to the application that requires a Datacap Desktop
task.
2. Select Workflow.
3. Select the job that contains the task, and click New.

© Copyright IBM Corp. 2014 39


Tip: You can modify an existing task to use Datacap Desktop by selecting the
existing task in the job, and specifying Datacap Desktop as the program to use.
See Step 6.
4. Enter a name for the new task, an appropriate description.
5. Select the values for these fields.
a. Mode: Select one of these values according to your requirements:
v Batch Creation: Select this mode for use with VScan or if you are creating
a task to scan hardcopy documents from Datacap Desktop.

Important: A job can contain only one Batch Creation task. If the job that
you are modifying already includes a batch creation task, you must
remove that task.
v Router: Select this mode if your new task routes the batch to a different
task or job when the criteria of a condition are met. One example of a
condition is a document integrity failure that requires a supervisor’s
intervention.
v Normal: This mode is for all other tasks that are not used for Batch
Creation or that do not require special handling.
b. Queue to: You can specify whether to queue the task to a user, a
workstation, or both. If queuing is not a requirement, select None.
c. Store: For reporting purposes, you can specify whether to save task
completion information that is based on a user, a workstation, or both. To
reduce processing time, you can select None.
6. For the Program under the Parameters section, select Datacap Desktop.
7. Click Create Setup, and then click Setup.
8. Specify the values for the fields, if necessary. The correct settings for Datacap
Desktop to call Rulerunner is for the key field to be Default and value field to
be dcDTlib.rulerunner:B. In most cases, you can accept the defaults, unless
you are creating a scan task.
a. If you are creating a scan task, add another Datacap Desktop panel set of
key and value fields. Enter the application name, such as TravelDocs, in the
key field and in the value field, enter either DotScanPanels.ISISScan for
ISIS scanners or DotScanPanels.TWAINScan for TWAIN scanners.
9. If necessary, select the new task and move it to the correct location in the job.

Important: A batch creation task must be the first task in a job.

Using Datacap Desktop to run tasks


You can use Datacap Desktop to run all of the default tasks that the Datacap
Studio application wizard generates.

Datacap applications include tasks that you can run from the Datacap Web Client
or Datacap Desktop. The client that you use to run a task depends on your
business requirements and environment.
1. Specify Datacap Desktop as the program to use in the task’s Setup dialog
window in the Datacap Web Client. (See “Creating and configuring a task to
use with Datacap Desktop” on page 39.)
2. Start Datacap Desktop. In the Start menu, select IBM Datacap Clients >
Datacap Desktop. Select the application for the task that you want to run, and
log on with an account that has sufficient rights to complete the task.
3. Select the task from the Shortcut menu and click Start.

40 IBM Datacap: System Administration Guide


Tip: If you do not see the task in the Shortcut menu, confirm that you
specified Datacap Desktop as the program to use in the task’s Setup dialog
window in the Datacap Web Client.
4. Complete the task in Datacap Desktop, according to your selection.
v VScan: This task is used for creating a batch by importing electronic files
from a specified location. After you start the VScan task in Datacap Desktop,
follow these steps.
a. In the Scan from field, browse to the location from which to import the
files.
b. Click Scan.
c. If necessary, arrange the batch by removing images or moving the images
up or down to change their order.
d. Click Done.

Important: To scan hardcopy pages from a scanner, you need to create a


scan task. See the topics “Creating and configuring a task to use with
Datacap Desktop” on page 39 and “Using Datacap Desktop to scan hardcopy
pages.”
v PageID: This task is an automated task that does not require user
intervention. Datacap Desktop applies the page type identification rules on a
batch and displays a completion message when the task is finished.
v Profiler: This task is an automated task that does not require user
intervention. In this task, Datacap Desktop applies rules to create documents
out of the pages, which are based on predefined criteria. Datacap Desktop
displays a completion message when the task is finished.
v Fixup: If an error or problem is encountered, then you must complete this
task before next task in the job begins. Datacap Desktop identifies the
problem document, page, field, or subfield in the batch, so that you can
make any corrections.
v Export: This task is an automated task that does not require user
intervention. Datacap Desktop exports a pending batch to a specified location
and displays a completion message when the task is finished.

Important: You must complete the Verify task, if it is included in the job,
before you can complete the Export task. The Verify task can be completed
only in the web client or Datacap Desktop, depending on how you
configured the Verify task.
v Background: This task runs all automated tasks consecutively, except VScan,
Fixup, and Verify.
5. You can confirm that the task is complete and that the next task is pending by
checking the Datacap Desktop Queue Monitor or the web client Job Monitor.

Using Datacap Desktop to scan hardcopy pages


You can use Datacap Desktop to scan hardcopy pages

Your scanner must be operational with the required scanner driver installed onto
your system and a scanning task must be created in the Datacap Web Client.

Follow this procedure to scan hardcopy pages with Datacap Desktop.


1. Load the pages that you want to scan into your scanner's feeder.

Using Datacap Desktop with your Datacap applications 41


2. Start the Datacap Desktop application. In the Start menu click IBM Datacap
Clients > Datacap Desktop. Select the application that contains the scanning
task, and log on with an account that has sufficient rights to complete a
scanning task.
3. Select Scan from the Shortcut menu, and click Start.
4. In Datacap Desktop click Select, if you are scanning documents from Datacap
Desktop for the first time or if you are changing your scanner.
5. After you select your scanner, click Configure, if you want to change your
scanner’s settings. The settings that you can modify are determined by the
scanner’s options and function.
6. After you modify the scanner settings, click OK.

Tip: Datacap Desktop provides the option for specifying the paper source and
the scanned image’s color mode, DPI resolution, brightness, and contrast.
7. Click Scan.
v Datacap Desktop arranges the thumbnails of the scanned images in the
Image View pane, which you can arrange by clicking Off, Vert, or Horz.

Tip: You can rotate an image by selecting the image in the Batch View pane
and clicking one of the rotation buttons in the center pane.
v The Batch View pane displays a list of scanned images in the current batch.
You can organize the scanned images by selecting an image and then
clicking the corresponding button to insert, replace, remove, move up or
down, join, or split the image or document.

Tip: The buttons in Datacap Desktop are enabled with tooltips that provide
information about the function of the button.
8. If necessary, you can place more pages into your scanner’s feeder and click
Scan to add images to the batch.
9. After you finish scanning, select an image in the Batch View pane. Datacap
Desktop displays the selected imaged in the Image View pane and assigns the
page type by selecting an option from the Type menu.
10. In the Status field, select either OK or Problem from the menu.

Important: Selecting the Problem value places the batch in a Pending status
and the batch does not proceed to the next task in the workflow until a Fixup
task is successfully completed.
11. After you finish organizing the batch and assigning page types and statuses,
click OK. Datacap Desktop displays a message that the batch is finished and
that you can proceed to the next batch.
12. You can confirm that the scan task is complete and that the next task is
pending by checking the Datacap Desktop Queue Monitor or the web client
Job Monitor.

Setting up a barcode type as a document separator


You can set up your Datacap Desktop scan task with a barcode type to be used as
a document separator with ISIS scanners.

To set up a barcode type as a document separator, you must complete three steps.
You must configure the Datacap Desktop scan task for document creation and set
the DCO type panel. Then, scan a page with the barcode that you want to use as a

42 IBM Datacap: System Administration Guide


document separator and identify the barcode name. The last step is to enter the
barcode name as the Barcode type in the Datacap Desktop scan task setup.
1. Configure the scan task in Datacap Web Client for documentation creation and
set the DCO type panel.
a. In Datacap Web Client, go to Administrator > Workflow and select the
VScan task.
b. Select Datacap Desktop from the Program menu.
c. Select Setup.
d. In Batch processing, select the Create document node check box.
e. In Datacap Desktop Bind DCO type to panel section, enter DCO_Type in the
key field and DLL.Panel in the value field
f. Add another Desktop panel set of key and value fields. Enter the application
name, such as TravelDocs, in the key field. Enter DotScanPanels.ISISScan in
the value field.
2. Scan a page with the barcode that you want to use as a document separator
and identify the barcode name.
a. Scan a page with the barcode that you want to use as a document separator.
Submit and close that batch.
b. In the batch folder, open the VScan.xml file and find the CodeNameX, such as
Code39.
3. In the Datacap Web Client, set up the Datacap Desktop scan task with the
Barcode type.
a. In Datacap Web Client, go to Administrator > Workflow and select the
VScan task
b. In the Barcode type field, enter the barcode name, such as Code39, that you
identified in the VScan.xml file
4. Save this Datacap Desktop scan task setup.

Using Datacap Desktop with your Datacap applications 43


44 IBM Datacap: System Administration Guide
FastDoc
You can create applications on FastDoc to scan, index, and manually run
background tasks on documents in a stand-alone environment or as a client to
Datacap.

In Local mode, you can use FastDoc for rapid application development with the
Datacap application as a starting point to quickly create new Datacap applications
without using Datacap Studio.

In Datacap Server mode, FastDoc runs as a client that scans, auto indexes, and
uploads batches of documents to Datacap Server. FastDoc is extended to take
advantage of Datacap Studio, Application Manager, and other Datacap features.

In Datacap Server mode, you can create an application and setup document
hierarchy items such as batches, documents, pages, and fields for that application.
You can configure compiled rulesets for the document hierarchy items to run
functions like import, page identification, image enhancement, fingerprint
matching, and export on the application. The compiled rulesets support inheritance
and automatic binding to the document hierarchy items.

Compiled rulesets are self contained application building blocks that you can
assemble into an application and configure by using FastDoc or Datacap Studio.
These rulesets reduce the expertise and complexity that is needed to create
applications by standardizing how core functions are implemented. They also
make applications more consistent and easier to understand and support.

Some of the common Datacap features that are not implemented in FastDoc
include.
v XBatchFields
v Line items
v Raising task conditions
v Alternative task profiles
v SELECT and Lookup DCO properties

To prepare your environment for FastDoc, back up existing applications and


configure FastDoc for the mode in which you want to run it. Then, you can set up
new documents and run them on FastDoc.

In Datacap Server mode, FastDoc can use the Datacap Server to further develop
the application by using Datacap Studio and Application Manager.

Getting started on FastDoc


The first time that you run FastDoc, you must create a Datacap application and
add documents, pages, and fields to it.

After you create the application, you configure settings and rulesets for the
documents, pages, and fields that you added. You can then configure import and
export rules at the batch level of the application.

© Copyright IBM Corp. 2014 45


Starting FastDoc
When FastDoc is installed, program shortcuts for both Administrators and
Operators are created on your Windows Start menu. Select the shortcut that is
appropriate for you.

If you are using a scanner, start your scanner before you start FastDoc.

You can run FastDoc in the following modes:


v Local mode as a stand-alone client that scans, manually indexes, and uploads
batches to repositories and files without using Datacap Server or other Datacap
components.
v Datacap Server mode as a client for Datacap applications that scans, auto
indexes, and uploads batches to the Datacap Server.
v Local and Datacap Server mode to run batches locally and upload them to
Datacap server in the background.

To start the FastDoc client:


1. From the Windows Start menu, select one of the following options.
a. Operators, select All Programs > IBM Datacap Clients > Datacap FastDoc.
b. Administrators, select All Programs > IBM Datacap Developer Tools >
Datacap FastDoc (Admin).
2. For Local mode, select Local and click Login.
3. For Datacap Server mode, log in to Datacap Server.
a. Select the Datacap application that you want to run in FastDoc.
b. Enter a valid user ID and Password for the workstation.
c. Enter the ID of the workstation.
d. Click Login.
4. If you try to exit after you start FastDoc, your batch is put on hold before
exiting. If FastDoc is processing a batch when you try to exit, FastDoc
completes this processing before you can exit.

Using an application created from a template


When you log in to Forms or Learning in FastDoc, you use applications that were
created by the Forms or Learning template. In this case, you do not have to use the
Application Wizard.

You can configure the Datacap application that you are using to scan, index, and
export batches of documents to repositories, file systems, and Datacap Server.

To use an application that is created from a template:


1. Start FastDoc in Datacap Server mode.
2. At the Login screen, select the application that you want to use.
a. Click Forms to use the application for structured images. When you know
the types of data that you want to capture and where that data is on each
image, select the Forms application. For example, a 1040EZ tax form and
the types of data on the form, such as name and address, are in the same
location on every 1040EZ form. The Forms application sets up a workflow
that you can match against your fingerprints.
b. Click Learning to use the application for unstructured images. When you
know the types of data that you want to capture but you do not know
where that data is contained in the image because the location of the data is

46 IBM Datacap: System Administration Guide


different on each image, select the Learning application. For example, if you
want to capture the date, amount, and tax for expenses from different
hotels, the receipt images from each hotel are unique. The location of the
data that you want to capture differs for each hotel receipt image so the
data cannot be identified with Datacap fingerprints. The Learning
application template sets up a workflow where you can add rules, such as
Locate rules, for Datacap to learn the different hotel receipt formats as they
are encountered.
3. Repeat these steps for both templates if they are needed.
Related tasks:
“Creating an application in Application Wizard”

Creating an application in Application Wizard


You can use the Application Wizard in FastDoc to create a Datacap application.
This method is an alternative to using an application that was created by the
Forms or Learning template.

You can configure the Datacap application that you create to scan, index, and
export batches of documents to repositories, file systems, and Datacap Server.

To create an application in Application Wizard:


1. Start FastDoc in Local mode.
2. At the FastDoc main window, click Application Wizard.
3. On the Overview window, click Next.
4. Select Create a new RRS application or Create a new CMIS based
application and click Next.
5. Enter a name for the application and select an application template.
a. SelectFormTemplate to use the application for structured images. When
you know the types of data that you want to capture and where that data
is on each image, select the Form application. For example, a 1040EZ tax
form and the types of data on the form, such as name and address, are in
the same location on every 1040EZ form. The Form application sets up a
workflow that you can match against your fingerprints.
b. Select LearningTemplate to use the application for unstructured images.
When you know the types of data that you want to capture but you do
not know where that data is contained in the image because the location of
the data is different on each image, select the Learning application. For
example, if you want to capture the date, amount, and tax for expenses
from different hotels, the receipt images from each hotel are unique. The
location of the data that you want to capture differs for each hotel receipt
image so the data cannot be identified with Datacap fingerprints. The
Learning application template sets up a workflow where you can add
rules, such as Locate rules, for Datacap to learn the different hotel receipt
formats as they are encountered.
6. Click Next.
7. Enter the CMIS connection information if you selected Create a new CMIS
based application.
8. At the Document hierarchy window, click Next.
9. At the Add sample images window, click + and add the images that you want
to process to the C:\Datacap\appname\Images\Input directory.
10. Click Finish to begin the creation process.

FastDoc 47
11. Check Connect to application when wizard exits to create the application.
12. Click Close to close the Application Wizard.
13. Repeat these steps for both templates if they are needed.
14. Click Local and select Logout to exit Local mode.
Related tasks:
“Using an application created from a template” on page 46

Forms template configuration


Use the Forms template to pre-configure the application to process forms on which
you know the types of data that you want to capture and where that data is on
each image.

Complete the following tasks to configure the Forms template.


1. Add the document types, page types, and field types that are needed to
replicate the form that you want to capture.
2. Set up your fingerprints and zone the fields on the pages.
3. Set up data recognition on each field by using the Recognize Pages and Fields
rule set.
4. Set up validation characteristics on each field by using the Validate Fields
ruleset.
5. Configure how and to which repository you want to export your documents by
using one of the Export rulesets.

Setting up documents on the Forms template


When you use the Forms template, you must set up the document types, page
types, and field types that are needed to replicate the form that you want to
capture. The next time that the document is scanned, FastDoc recognizes the
document, and automatically populates data in the fields that you set up.

To set up documents on the Forms template:


1. Start FastDoc in Datacap Server mode.
2. Login to the Forms template.
3. On the Datacap window, click the Configure workflow icon and select the job
that you want to run.
v DemoSingleTIFFs
v DemoMultiFormat
v Web Job
4. Click the Configure documents, pages, and fields icon.
5. In the Batch Structure pane, select the Batch name, such as Forms, and click
Add Document. The Batch name is the same as the application name.
a. Enter a unique name for the Document Type. For example, Tax Form.
b. Check Enable for Use rulesets from and select Document.
c. Click Add.
d. Add the remaining documents that you want to include in this batch.
e. Click Save.
6. Select a new document and click Add Page.
a. Select Create New to create a new page type and enter a page name. For
example, Main_Page.
b. Check Enable for Use rulesets from and select Page.

48 IBM Datacap: System Administration Guide


c. Select Use Existing if you want to use a page type that is already defined.
d. Click Add.
e. Add the remaining pages that you want to include in the document. For
example, Trailing_Page.
f. Click the Settings tab for each page and configure how many of the page
type can be in the document and how to position the page type in the
document. If you set Maximim to 0, there is no limit on the number of page
types in the document. Setting Maximim and Minimim to 0 allows the page
to be present or not with no restrictions.
g. Click Save.
7. Select a new page and click Add Field.
a. Select Create New to create a new field type and enter a field name. For
example, Last Name.
b. Select Use Existing if you want to use a field type that is already defined.
c. Click Add.
d. Add the remaining fields that you want to include on the page of the
document.
e. Click the Settings tab for each field and configure the field settings by
using the hover help text for each field as a guide.
f. Click Save.
Related tasks:
“Configuring rulesets for the application” on page 61
“Testing rulesets” on page 63

Setting up image enhancement on the Forms template


You configure image enhancement at the page level on the Forms Template to
remove lines, shading, misalignment, and other imperfections that can interfere
with the recognition process.

To setup image enhancement on the Forms template:


1. Start FastDoc in Datacap Server mode.
2. Log in to the Forms template.
3. On the Datacap window, click the Configure workflow icon and select the job
that you want to run.
4. Click the Configure documents, pages, and fields icon.
5. Select the page in the Batch Structure pane and click the Ruleset tab.
6. Select the Image Enhancement ruleset.
7. Click Open image file and select the image.
8. Select the enhancement options that you want to run to clean up the image.
These options are run when you process the image at run time.
9. Run these steps on every page for which you want to run image enhancement.

Setting up fingerprints on the Forms template


You set up fingerprints on the Forms template that correspond to the field layout
of the forms that you want to process.

You can assign the fingerprints that you create to fingerprint classes to differentiate
the forms that you receive from various sources. Fingerprint classes can be used to
group fingerprints based on the source of the form.

FastDoc 49
When a zone for a field is created in the wrong place or is the wrong size, the
index data for that field is not picked up automatically in the verification task.

To create fingerprints on the Forms template:


1. Start FastDoc in Datacap Server mode.
2. On the Datacap window, click the Configure documents, pages, and fields
icon.
3. In the Batch Structure pane, select the document for which you want to create
fingerprints and click the Fingerprints tab.
4. In the Fingerprint Class field, select the fingerprint class that you want to
associate the fingerprints with. A list of the fingerprints that are assigned to the
fingerprint class is displayed in the Fingerprint field.
a. Click Add to create a new fingerprint class. Enter the name of the
fingerprint class and click Add. You can name the class to correspond with
the name of the client who sent the form to you.
b. Select a fingerprint class and click Delete to delete a fingerprint class.
c. Select a fingerprint and click Rename to change the name of an existing
fingerprint class.
d. Click Reload to refresh the list of fingerprint classes.
5. In the Fingerprint field, add the fingerprints to the fingerprint class.
a. Click Add and go to the folder that contains the fingerprint file. For
example, C:\Datacap\APT\Images\Input.
b. Select the fingerprint file and click Open. The fingerprint is added to the list
of fingerprints that are assigned to the fingerprint class.
c. Click a fingerprint to display the fingerprint image on the Image tab. The
image is displayed with boxes for the existing zones.
d. Double-click a fingerprint to use Click N Key to capture text on the image.
e. Click Zoom In or Zoom Out to enlarge or reduce the size of the fingerprint
image.
f. Select a fingerprint and click Delete to delete a fingerprint.
g. Select a fingerprint and click Change class to to associate the fingerprint
with another fingerprint class.
h. Select a fingerprint and click Change page type to to associate the
fingerprint with another page type.
6. Create fingerprint zones for the fields on the fingerprint file. If you want to
draw zones on fields that contain zones, you must draw the smaller zones first.
Then, you draw the zones in the parent fields that contain the smaller zones.
a. Select the field in the Batch Structure pane.
b. Click Zones on the Image tab.
c. Click the field on the image and drag the cursor to draw the zone. The
Position field displays the coordinates of the fingerprint zone.
d. Click the edge of the zone and drag the straight arrow icon to resize the
zone.
e. Click the zone and drag the crossed arrows icon to move the zone.
f. Set the page type for the fingerprint.
g. Highlight a fingerprint zone and click Clear Zone to delete fingerprint zone
positions.
h. Click Words on the Image tab to highlight or hide the word boundaries that
are recognized are part of the CCO text.

50 IBM Datacap: System Administration Guide


i. Click Lines on the Image tab to display all of the CCO lines on the
fingerprint.
j. Click the Text tab to display the recognized text.

Attention: You can update field zones from the Test tab while you are testing
the rulesets and the images.
7. If the wrong fingerprint was matched and you want to keep the existing
fingerprint, select Add to create a new fingerprint and retain the existing
fingerprint.
8. If the format of the form was changed since the fingerprint was created and the
correct fingerprint was matched, select Delete to remove the existing
fingerprint. Then, click Add to create a fingerprint with the new format to
replace the one that you deleted.
9. If the fingerprint was created because the image did not match a fingerprint,
Add is selected. You do not have to anything else.

Setting up field recognition on the Forms template


You configure recognition on the field level of the Forms template to locate the
fields that you want to capture and convert those fields into character-based data.

To set up field recognition on the Forms template:


1. Start FastDoc in Datacap Server mode.
2. Log in to the Forms template.
3. On the Datacap window, click the Configure workflow icon and select the job
that you want to run.
4. Click the Configure documents, pages, and fields icon.
5. Select the field in the Batch Structure pane and click the Ruleset tab.
6. Select the Recognize Pages and Fields ruleset.
7. Check the Read Zones field.
8. Select the recognition options that you want to run by using the hover text help
as a guide. These options are run when you process the image at run time.
9. Run these steps on every field for which you want to run recognition.

Setting up field validation on the Forms template


You configure validation on the field level of the Forms template to determines
whether the captured data complies with the data integrity rules that are defined
in your business requirements.

To set up field validation on the Forms template:


1. Start FastDoc in Datacap Server mode.
2. Log in to the Forms template.
3. On the Datacap window, click the Configure workflow icon and select the job
that you want to run.
4. Click the Configure documents, pages, and fields icon.
5. Select the field in the Batch Structure pane and click the Ruleset tab.
6. Select the Validate Fields ruleset.
7. Check Validate this field.
8. Configure the validation options that you want to run by using the hover text
help as a guide. These options are run when you process the image at run time.
9. Run these steps on every field for which you want to run validation.

FastDoc 51
Summary of document configuration on the Forms template
You must configure rulesets on the Forms template to recognize the data that is
read from fingerprint zones and validate the captured values of that data.

Complete the following instructions to use the Profiler task to pre-configure the
application for the forms that you want to process.

Attention: The settings in the Forms template are preset, so changing them might
create issues when you run the Export task. To ensure that no issues were
introduced, after you change the template, use the Test tab and make any required
corrections.

To configure documents on the Forms template:


1. Start FastDoc in Datacap Server mode.
2. Click Configure workflow and select the job on which you want to run the
application.
v DemoSingleTIFFS
v DemoMultiFormat
v Web Job
3. Click Configure documents, pages, and fields and select the page on which
you want to clean up imperfections.
4. Click the Ruleset tab.
5. Select the Image Enhancment ruleset and select the operations that you want
to run. For example, you can remove lines, punch holes, and dot shading.
6. At the field level, select the Recognize Page and Fields ruleset and select Read
Field.
a. Configure the settings to coincide with the recognition type properties that
are set up for the fingerprint in Datacap Studio.
b. Click Save.
7. At the field level, select the Validate Fields ruleset and select Validate this
field.
a. Select Common to set up validation characteristics for the captured values
of the field.
b. Configure the validation settings for length, value content, date, currency,
and lookup.
c. Click Save.

Configure the Export options for the documents.


Related tasks:
“Configuring export options” on page 55

Learning template configuration


You can configure the learning template to process forms on which you know the
types of data that you want to capture. But you do not know where that data is
contained in the image because the location of the data is different on each image.

The Learning template uses generic document types, page types, and field types
that are provided with the template. You do not have to set up fingerprints for this
template.

Complete the following tasks to configure the Learning template.

52 IBM Datacap: System Administration Guide


1. Add the field types, in addition to the ones that are provided in the template,
that you want to capture.
2. Configure the Populate Fields by Using Keywords ruleset to find words that
identify the position of metadata on a page, such as Date, Order Number, and
Total.
3. Set up validation characteristics on each field by using the Validate Fields
ruleset.
4. Configure how and to which repository you want to export your documents by
using one of the Export rulesets.

Setting up fields on the Learning template


The Learning template uses generic document types, page types, and field types
that are provided with the template. You can add other files types that you want to
capture to the template.

To set up documents on the Forms template:


1. Start FastDoc in Datacap Server mode.
2. On the Datacap window, click the Configure documents, pages, and fields
icon.
3. Select the page to which you want to add a field and click Add Field.
a. Select Create New to create a new field type and enter a field name. For
example, Last Name.
b. Select Use Existing if you want to use a field type that is already defined.
c. Click Add.
d. Add the remaining fields that you want to include on the page.
e. Click Settings and configure the field settings by using the hover help text
for each field as a guide.
f. Click Save.
Related tasks:
“Configuring rulesets for the application” on page 61
“Testing rulesets” on page 63

Setting up image enhancement on the Learning template


You configure image enhancement at the page level on the Learning Template to
remove lines, shading, misalignment, and other imperfections that can interfere
with the recognition process.

To setup image enhancement on the Learning template:


1. Start FastDoc in Datacap Server mode.
2. Log in to the Learning template.
3. On the Datacap window, click the Configure workflow icon and select the job
that you want to run.
4. Click the Configure documents, pages, and fields icon.
5. Select the page in the Batch Structure pane and click the Ruleset tab.
6. Select the Image Enhancement ruleset.
7. Click Open an image file and select the image.
8. Select the enhancement options that you want to run to clean up the image.
These options are run when you process the image at run time.
9. Run these steps on every page for which you want to run image enhancement.

FastDoc 53
Setting up field recognition on the Learning template
You configure recognition on the field level of the Learning template to locate the
fields that you want to capture and convert those fields into character-based data.

To set up field recognition on the Learning template:


1. Start FastDoc in Datacap Server mode.
2. Log in to the Learning template.
3. On the Datacap window, click the Configure workflow icon and select the job
that you want to run.
4. Click the Configure documents, pages, and fields icon.
5. Select the field in the Batch Structure pane and click the Ruleset tab.
6. Select the Populate Fields Using Keywords ruleset.
7. Check the Read Zones field.
8. Select the recognition options that you want to run by using the hover text help
as a guide. These options are run when you process the image at run time.
9. Run these steps on every field for which you want to run recognition.

Setting up field validation on the Learning template


You configure validation on the field level of the Learning template to determine
whether the captured data complies with the data integrity rules that are defined
in your business requirements.

To set up field validation on the Learning template:


1. Start Datacap Studio and log in to the Learning template.
2. On the Document hierarchy tab, open the Learning tree and select the field
that you want to configure for validation.
3. On the Rulesets tab, open the Learning tree.
4. Select the Validate Fields ruleset.
5. On the Properties tab, click Settings.
6. Check Validate this field.
7. Configure the validation options that you want to run by using the hover text
help as a guide. These options are run when you process the image at run time.
8. Run these steps on every field for which you want to run validation.

Summary of document configuration on the Learning template


You configure page identification on the Learning template to be able to capture
data that is found in different locations on each image.

To configure documents on the Learning template:


1. Start FastDoc in Datacap Server mode.
2. Click Configure workflow and select the job on which you want to run
FastDoc.
v DemoSingleTIFFS
v DemoWebScan
v DemoMultiFormat
v FlexIDSingleTIFFs
v FlexIDMultiFormat
v FlexIDWebScan

54 IBM Datacap: System Administration Guide


3. Click Configure documents, pages, and fields and select the page on which
you want to clean up imperfections.
4. Click the Ruleset tab.
5. Select the Image Enhancment ruleset and select the operations that you want
to run. For example, you can remove lines, punch holes, and dot shading.
6. At the batch level, select the Populate Fields Using Keywords ruleset and
select Read zones prior to Locate.
7. Set up the Locate actions in Datacap Studio to run a keyword search for the
data that you want to capture. For example, social security number, invoice
number, date.
8. Configure the Validate Fields ruleset in Datacap Studio.

Configure the Export options for the documents.


Related tasks:
“Configuring export options”

Configuring export options


The Export task in the workflow for your job contains an Export ruleset that
exports documents to a file system. You can add rulesets to export documents to
the IBM Content Manager and IBM FileNet® Content Manager repositories for
storage.

You can add the Export to IBM Content Manager or the Export to IBM FileNet
Content Manager ruleset to the Export task in your job. Then, you configure these
rulesets on the batch, document, and field levels of the batch structure.

To configure rulesets to export documents:


1. Start FastDoc in Datacap Server mode.
2. At the Datacap FastDoc screen, click the Configure workflow icon.
3. Add the wanted Export ruleset to the Export task.
a. In the Jobs pane, select the job for which you want to add a ruleset.
b. In the Rulesets pane, select the ruleset and drag it to the header of the
Export task in the job. For example, select Export to FileNet Content
Manager and drag it to the Export header.
c. Right-click and select Remove to delete the existing Export ruleset from the
task.
4. Configure the Export ruleset at the batch, document, or field level.
a. In the Configure Documents and Pages pane, select the batch structure
level at which you want to run the ruleset. You configure the connection
settings to the repository at the batch level.
b. Click the Ruleset tab and select the Export ruleset to display its settings.
The export settings that apply to the selected batch structure level are
displayed.
c. Configure the ruleset settings by using the hover help text as a guide.
d. Click Save.
5. Configure the Export ruleset to use CMIS to access the IBM FileNet Content
Manager repository. The CMIS settings must be configured in Application
Wizard.
6. At the batch level, click the Ruleset tab and select Export to FileNet Content
Manager.

FastDoc 55
a. Enter the URL for the CMIS server.
b. Enter a valid CMIS user ID and password.
c. Set up the remaining parameters for the IBM FileNet Content Manager
repository.
d. Click Save.
7. Configure the document and field level the same way that you would for IBM
FileNet Content Manager.
Related tasks:
“Summary of document configuration on the Forms template” on page 52
“Summary of document configuration on the Learning template” on page 54

Format of the exported data file


You can use FastDoc to export documents. FastDoc exports the document image
file and its associated data file to the folder that you specified. These files share a
name, but have different file extensions.

FastDoc supports two export formats for the data file: Character Delimited Value
and XML. The exported data file defaults to Character Delimited Value with a file
extension of CSV.

For both formats, you can include or exclude the following information from the
export file.
v Document type
v Full path to the document image file
v File name of the document image file

Confirming a successful export


After indexing and verification tasks are completed for a batch, FastDoc exports
the images and index data. The exported information goes to the location that is
specified in the Export ruleset.

If there were problems during the export, a warning message is generated. Details
about the problem can be found in the log files in the C:\Datacap\FastDoc\
batches\<appname> folder..
v
v For export to IBM FileNet Content Manager, go to the appropriate Object Store
to view the images and index entries.
v For export to IBM Content Manager, go to the specified folder on Content
Manager to view the images and index entries.
v For export to a network folder, go to the appropriate location on your network.
View the images and text or XML files that contain the index entries.

Application configuration on FastDoc


You can configure your application for FastDoc by setting up batch profiles and
adding rulesets to the FastDoc workflow.

Configuring your application for FastDoc also involves document planning,


scanner setup, ruleset configuration, and index field definition.

56 IBM Datacap: System Administration Guide


Preparing for document scanning and indexing
If you know which types of documents you want to process, you can accurately
capture the most useful index data from those documents. These optional steps
help you plan your document scanning, indexing, and storage.

To prepare for document scanning and indexing:


1. Identify and gather samples of the documents that you want to scan, index,
and store by using FastDoc. You can use the Forms Template application for
documents that you created and your customers send back to you, like contract
paperwork for your services or tax forms. You can use the Learning Template
for documents that are created by other users. For example, invoices from
different vendors for items that you purchased, confirmations of shipments, or
car rental contracts.
2. Group these documents into types and assign a unique Document Type name to
each group.
3. For each group of documents or Document Type:
a. Look at the variations and identify the types of index data in the index
fields that you want to capture for each group.
b. Identify the name that you want the Operator to see for each field.
c. Determine the sequence in which you want the fields to display on the
Verify pane during indexing. This sequence is also the sequence in which
the values appear in the exported data file.
d. Decide whether you want to export the index values to a data file. You use
a character delimited value or XML format.
4. For each Index field:
a. Identify whether you want the data to be located by using a zone. For each
unique image, the data is always in the same general location. The customer
address is in the same place on your order form. If the data is located by
using a list of keywords that match the field label on the image, the invoice
number can be located by using the string or INVOICE NUMBERInvoice#
b. Note the data characteristics of the values that you are capturing. For
example, letters, numbers, contains punctuation, date, minimum and
maximum number of characters.
c. Identify whether you want to validate the data that you are capturing. If so,
identify the types of validations you want to do for each index field. Such
as required/optional, value must exist in an external database, data
characteristics must match.
d. Identify whether you want to use data in an external database to populate
more index fields. For example, use the customer number from the order
form to retrieve the postal code of the customer.
5. Identify the format (TIFF or PDF) to use for the exported documents and where
you want to store the output. When you export documents to the following
repositories or file.
v IBM FileNet Content Manager: you need the URL, user ID, and Password of
the Content Manager site and the Object Store into which you want to
upload the documents. You must know the Document Class to which to map
the exported document.
v IBM Content Manager: you need the server name, user ID, and Password of
the IBM Content Manager site and the name of the folder into which you
want to upload the documents.

FastDoc 57
v File: determine the network folder, local drive, mapped drive, or UNC path
information and the folder name you want to use. The Windows user ID of
the FastDoc Operator or Administrator must have network permissions to
write to this target folder.
Related tasks:
“Setting up a scanner for FastDoc”

Setting up a scanner for FastDoc


You can attach a scanner to your FastDoc computer and scan your paper
documents. FastDoc can process documents that are scanned on TWAIN or ISIS
scanners, and image files of documents that were previously scanned or faxed.

To get started without attaching a scanner, you can use the sample pre-scanned
images that are provided with FastDoc.

FastDoc uses the top third of the first page of each document to identify that
document. The scanner settings must match the actual size of the paper that is
being scanned. For example, when you scan letter-sized pages, ensure that the
scanner is set up for letter-sized paper and not legal-sized paper.

To set up a scanner for FastDoc:


1. Follow the instructions of the scanner manufacturer to attach the scanner,
install, and configure the scanner software and driver software.
2. Make sure you can scan successfully by using the scanner and any TWAIN or
ISIS driver-based image capture software product. If you cannot scan
documents outside of FastDoc, you cannot scan documents when you are using
FastDoc.
3. Set your scanning resolution setting that is based on your unit of measure:
v For inches, a scanning resolution of 200 is suggested
v For centimeters, a scanning resolution of 78 is suggested

Tip:

When you start scanning documents, it is best to use the same scanning
resolution for all documents. Do not change the resolution unless you must to
improve your recognition results.
4. Start FastDoc.
Related tasks:
“Creating a batch by using a scanner” on page 68

Setting up batch profiles in Local mode


You can create custom batch profiles on FastDoc in Local mode to configure the
workflow tasks for your jobs.

When you create a batch profile, you specify the profile name, type, and
description. You also format rules for the folders, documents, and pages in the
batch. You then create tasks for the batch profile and map them to the application,
workflow, and task profile where you want to run them. FastDoc provides a batch
profile that you can use as an example when you create your customized batch
profiles.

58 IBM Datacap: System Administration Guide


The Administrator creates the batch profile and configures the tasks to run for the
profile. Then, you can select the batch profile by name on the main Datacap
window.

To set up a batch profile in Local mode:


1. Start FastDoc in Local mode.
2. Click Configure local profile at the Datacap window.
3. Click Add to display the New Profile tab on the Batch Profiles window.
4. In the Batch Profile Name field, type the name of the batch profile. The batch
profile name is displayed on a New Profile tab.
5. In the Type and Description fields, enter more information to further identify
the batch profile.
6. Use the following information in format ID fields to create batch folders,
documents, and pages.
v Batch ID Format: the year, month, day, hour, minute, result size, and
computer name
v Document ID Format: the batch ID and document number
v Page ID Format: the page number within the document
7. Create a Scan task for the batch profile.
a. Click New Task to create tasks for the batch profile.
b. Type the name of the Scan task in the Task Name field. For example, you
might use a name like Scan Tax Forms.
c. In the Task Options section, select a scan option from the list, such as Disk
Scan, ISIS Scan, or TWAIN Scan.
d. In the Application field, select the application to run the task. The
Workflow field is filled with the application name.
e. In the Task Profile field, select the ruleset to run on the task. For example,
for a Disk Scan you can run Scan From Disk <Single TIFFS> or Scan
From Disk <Multi Format>.
8. Create a PageID task for the batch profile. This task is used by the Forms
template only.
a. Click + to create another task for the batch profile.
b. Type the name of the PageID task in the Task Name field.
c. In the Task Options section, select Rulerunner. The application name is
displayed in the Application and Workflow fields.
d. In the Task Profile field, select PageID.
9. Create a Profiler task for the batch profile.
a. Click + to create another task for the batch profile.
b. Type the name of the Profiler task in the Task Name field.
c. In the Task Options section, select Rulerunner. The application name is
displayed in the Application and Workflow fields.
d. In the Task Profile field, select Profiler.
10. Create a Verify task for the batch profile.
a. Click + to create another task for the batch profile.
b. Type the name of the Verify task in the Task Name field.
c. In the Task Options section, select Verify. The application name is
displayed in the Application and Workflow fields.
d. In the Task Profile field, select Verify.

FastDoc 59
11. Create an Export task for the batch profile.
a. Click + to create another task for the batch profile.
b. Type the name of the Export task in the Task Name field.
c. In the Task Options section, select Rulerunner. The application name is
displayed in the Application and Workflow fields.
d. In the Task Profile field, select Export.
12. Click Save to save the batch profile and its tasks. You run the batch profile
from the Batch Profile window.
13. Click Remove to delete the batch profile. The tab for the batch profile is
removed from the Batch Profile and the Select a Batch windows.
Related tasks:
“Creating a batch with pre-scanned images” on page 67
“Creating a batch by using a scanner” on page 68

Setting up batch profiles in Datacap Server mode


Batch profiles are not needed in Datacap Server mode because you configure these
tasks in Datacap Web Client when FastDoc is connected to the Datacap Server.

You use the Datacap Web Client Administrator or Datacap Navigator to configure
your applications to run on the FastDoc client in Datacap Server mode.

To set up batch profiles in Datacap Server mode:


1. Start FastDoc in Datacap Server mode.
2. Open Internet Explorer, and enter the IP address of the Datacap Web Client or
Datacap Navigator followed by the alias for the website. For example, enter
http://127.0.0.7/tmweb.net or http://WebServerName/tmweb.net.
3. Click the Administrator tab and select Workflow.
4. Click the name of your application to expand the tree.
5. Select the Job for which you want to add a workflow tasks and click New.
6. Enter a name for the task. For example, enter Scan, Profiler, Verify, or Export.
7. Click Create Setup and specify the values for the task.
8. Click OK.
9. Repeat these steps for all of the tasks that you want to add.
Related tasks:
“Creating a batch with pre-scanned images” on page 67
“Creating a batch by using a scanner” on page 68

Adding rulesets to a FastDoc workflow


You can add rulesets to the tasks in the workflow and run them on the applicable
levels of the batch structure.

FastDoc does not automatically add a reference to a ruleset in the


\rrs\collection.xml file. If a reference is needed, it must be done outside of
FastDoc. FastDoc loads rulesets from the \rrs folder whether they are in the
\rrs\collection.xml file or not.

When a ruleset that is not in \rrs\collection.xml or \rules\collection.xml is


added to a task in FastDoc, the *.rul (.dll) and *.rul.config files are copied to
the \rules folder. A reference is added to the \rules\collection.xml file.

60 IBM Datacap: System Administration Guide


First, you add the rulesets to the tasks in your workflow. Then, you configure the
rulesets to run on the tasks at the batch, document, page, or field level of your
batch structure.

To add rulesets to a FastDoc workflow:


1. Start FastDoc in Datacap Server mode.
2. At the Datacap FastDoc screen, click the Configure workflow icon.
3. Add the ruleset to a task:
a. In the Jobs pane, select the job for which you want to run a ruleset.
b. In the Rulesets pane, select the ruleset and drag it to the header of the task
in the workflow. For example, select Export to IBM Content Manager and
drag it to the Export header.
c. Right-click and select Remove to delete a ruleset from a task.
4. Configure the batch structure item to run the ruleset:
a. Double-click the ruleset in the workflow task to display the ruleset settings
in the Configure Documents and Pages window. Some rulesets cannot be
configured in FastDoc. If the ruleset settings screen does not display, you
must configure the ruleset in Datacap Studio.
b. Select the batch structure level at which you want to run the ruleset. For
example, select Document to run the ruleset at the document level. A
message displays if the ruleset cannot be run at the selected batch structure
level. This message also indicates at which level this ruleset can be run.
c. Configure ruleset settings for the batch structure item. Hover help text is
provided in each field to assist you.
d. Click Save.
Related tasks:
“Configuring rulesets for the application”
“Testing rulesets” on page 63

Configuring rulesets for the application


After you set up the documents and fields to process, you can configure the
rulesets to run on the application that is based on the template that you are using.

You configure rulesets to run on the batches, documents, pages, and fields that are
in the application in Datacap Server mode.

To configure rulesets on documents:


1. Start FastDoc in Datacap Server mode.
2. On the Datacap window, click the Configure workflow icon.
3. Select the job that you want to run and click the Configure documents, pages,
and fields icon.
4. In the Batch Structure pane, select the name of the application and click the
Rulesets tab.
5. Configure the following rulesets for the appropriate batch structure level in the
application:

FastDoc 61
Table 17. Rulesets to configure for the Forms and Learning applications
Application Batch Structure Level Ruleset
Forms Batch Identify Pages to identify
non-classified pages in the
document.

Convert Images to convert


the electronic images to a
TIFF file format.

Create Documents to
arrange page files into
documents.
Document There are no ruleset settings
for this level.
Page Image Enhancement to clean
up imperfections in the
scanned image.

Recognize Pages and Fields


to run recognition steps task
on pages.
Field Recognize Pages and Fields
to run recognition steps on
fields.

Validate Fields to determine


whether the captured data
conforms to the specified
business rules.
Learning Batch Populate Fields By Using
Keywords to define
keywords that can locate the
index value by using a field
label.

Convert Images to convert


the electronic images to a
TIFF file format.

Export to FileNet Content


Manager to configure the
connection to the FileNet
Content Manager repository.
You can configure the
application for any one of
the supported Export
rulesets.

62 IBM Datacap: System Administration Guide


Table 17. Rulesets to configure for the Forms and Learning applications (continued)
Application Batch Structure Level Ruleset
Document Populate Fields By Using
Keywords to define
keywords that can locate the
index value by using a field
label.

Export to FileNet Content


Manager to configure the
connection to the FileNet
Content Manager repository.
You can configure the
application for any one of
the supported Export
rulesets.
Page Image Enhancement to clean
up imperfections in the
scanned image.
Field Populate Fields By Using
Keywords to define
keywords that can locate the
index value by using a field
label.

Export to FileNet Content


Manager to configure the
connection to the FileNet
Content Manager repository.
You can configure the
application for any one of
the supported Export
rulesets.

6. Use the Test tab to confirm that the processing is working correctly and make
corrections as needed.
7. Start processing real documents.
Related tasks:
“Adding rulesets to a FastDoc workflow” on page 60
“Testing rulesets”

Testing rulesets
You can test the rulesets that you applied to your documents, pages, and fields
and make the appropriate changes before you process batches.

You use this feature to test your rulesets by using a temporary batch.

To test rulesets:
1. Start FastDoc in Datacap Server mode.
2. In the Batch Structure tree, select the batch item that you want to configure and
click the Ruleset tab.
3. Select the ruleset, configure it for the batch item, and click Save.
4. In the Test pane, click Add File. You must add a file to test. If you do not add
a file, FastDoc cannot test most of the rulesets. However, some rulesets might
be tested anyway.
FastDoc 63
a. Go to the C:\Datacap\appname\images\Input folder and select the first page
that you want to test.
b. Continue to add the pages that you want to test one page at a time. The
files are put into a temporary folder for the batch. A Page ID and Page Type
is assigned to each of the pages.
c. Click the Arrow buttons to select the page that you want to test. The image
of the selected page is displayed next to the Test pane.
5. Select a task profile and click Test to test all of the rulesets in the task profile.
You do not have to test all of the ruleset in the task profile. You can run the
rulesets in sequence to get to the ruleset that you want to test. Click the
rulesets that run after the ruleset that you want to test to remove them from
the test.
a. Look at the Status field for the test results. Fail means that the validations
that were run on some of the fields failed.
b. Click each of the fields in the Batch Structure tree to find the fields that
failed validation. The validation error is displayed in the Message field.
c. Enter the correct field information in the Value field.
d. Select the task profile and click Test to retest the corrected rulesets until the
Status field displays Pass.
6. Click Reset to delete the files from the temporary batch folder and start over.
Related tasks:
“Adding rulesets to a FastDoc workflow” on page 60
“Configuring rulesets for the application” on page 61
“Setting up documents on the Forms template” on page 48
“Setting up fields on the Learning template” on page 53

Defining an index field with keywords


Keywords can locate an index value by using a field label that might vary when
the index value is always in the same location relative to the field label. You can
define multiple keywords for each index field. You can also define each keyword
as either a string or a regular expression.

When you define both a zone and keywords for a field, FastDoc attempts to locate
the index value by using the zone first. If the value is found by using the zone, the
keyword criteria is ignored. If no value is found by using the zone, FastDoc then
attempts to locate the index value by using the list of keywords.

To define an index field with keywords:


1. Start FastDoc in Datacap Server mode.
2. On the Datacap window, click the Configure documents, pages, and fields
icon.
3. In the Batch Structure pane, select the field that you want to define with
keywords.
4. Click the Ruleset tab and select Populate Fields Using Keywords.
5. Click Add Term and enter the keyword or regular expression to use to define
the field.
6. Select whether to locate the first occurrence of the keyword or the last
occurrence of the keyword.
7. Click Add Locate Movement and select the direction in which to search for the
keyword.

64 IBM Datacap: System Administration Guide


8. Specify how to group the words that you want to use in the found file.
9. Click Save.
Related tasks:
“Indexing and verifying batches” on page 69

Defining index field validation by using a database


You can validate a captured index value by using a column in an external
database. You can also populate an index field by using a value that is retrieved
from a database.

To define index field validation or population by using a database:


1. Start FastDoc in Datacap Server mode.
2. On the Datacap window, click the Configure documents, pages, and fields
icon.
3. In the Batch Structure pane, select the field that you want to validate by
using a database.
4. Click the Ruleset tab and select the Validate Fields ruleset.
5. Select the check box for the Lookup section.
6. In the Database field, enter a connection string that can connect FastDoc to
your external database. Based on the type of database and the driver that you
are using, you might also need to set up a System DSN.
7. Enter an SQL statement that determines whether only validation is done, or
whether a value from a different database column is returned.
8. Enter a comma and True after the SQL statement to populate the index field
with the result.
9. Click the Populate Field check box.
10. Click Save.
Related tasks:
“Indexing and verifying batches” on page 69

Using Click N Key to capture data


Use the Click N Key feature to select the index data in the Verify pane that you
want to capture.

There are two ways to capture data from the image.

To use Click N Key to capture data:


1. Click in the Index field in the Verify pane.
2. Perform one of the following steps:
v Click the data on the image. The selected data displays in the Index field.
v Click and drag the mouse on the image to outline the data you want to
capture. Release the mouse to make the zone visible on the image. If you
drew the zone around recognized data, the data displays in the Index field.
3. For the second option, if the data does not display in the Index field, repeat the
step but outline a larger area around the data.
4. If the data still does not display, the Perform Full Page Recognition setting is
turned off for this batch.
a. Put the batch on hold and delete the batch.

FastDoc 65
b. Reprocess the batch, click Scan Settings, and ensure that Perform Full Page
Recognition is enabled.
5. Repeat the capture data from image steps.
Related tasks:
“Indexing and verifying batches” on page 69

Document processing on FastDoc


FastDoc automates the capture of index data from computer or manually printed
documents, which eliminates manual data entry. You can create batches of
documents, run indexing and verification tasks, and export the index data and
document content to a storage location.

Preparing paper documents for scanning


FastDoc requires little preparation for paper documents, but processing documents
runs smoother if you check a few simple things.

To prepare paper documents for processing:


1. Ensure that all of the documents in the batch can be separated the same way:
a. Insert patch code separator pages for all documents in a batch when you
want FastDoc to automatically separate documents for you at the separator
pages.
b. Print and use copies of the Separator.PDF file that is provided in the
C:\Datacap\<appname>\Images\Input folder. The FastDoc patch code
separator page is not exported when the document is exported.
c. Use the Pages per Document field to automatically separate documents
when all of the documents have the same number of pages.
d. Manually identify the first page of each document in the batch.
2. Ensure that you have all pages of all documents in the correct page number
sequence.
3. Ensure that your pages do not jam in the scanner, smooth all pages, and
remove all staples and paper clips.

Running FastDoc in Local mode


In Local Mode, FastDoc runs as a stand-alone client that scans, manually indexes,
and uploads batches without using Datacap ServerDatacap server.

In Local mode, you can configure applications by creating custom profiles to run
tasks for batches of documents and images.

If you are using a scanner, start your scanner before you log in to FastDoc.

To run FastDoc in Local mode:


1. Start FastDoc, select Local and click Login.
2. Click Send Forms to Datacap to run create batch profiles in Local mode and
upload them to Datacap Server in the background.
3. In the Add Batch field, select the application for which you want to create a
new batch.
4. In the Existing Batch field, double-click the batch that you want access.
5. Select the batches that you completed and click Purge Finished Batches to
remove them.

66 IBM Datacap: System Administration Guide


6. Select the batches that you no longer want to process and click Delete Selected
Batches to remove them.
7. If you try to exit after you start FastDoc, your batch is put on hold before
exiting. If FastDoc is processing a batch when you try to exit, FastDoc
completes this processing before you can exit.

Opening an existing batch


You can put batch processing on hold when you do not have the time or the
information to complete it. When you are ready to continue, you can open the
batch that you put on hold and work on it.

To open an existing batch:


1. Start FastDoc in Local mode. The Datacap window opens with the count of
Active Batches and Finished Batches.
2. If the batch you want to open is displayed, double-click the batch to open it.
3. If the batch you want to open is not displayed, click Ellipsis until the batch
appears, then double-click the batch to open it.
4. If you are an Operator, you can do the following steps.
a. At the Scan pane, create a batch by using a scanner or pre-scanned images.
b. At the Verify pane, if you want to complete indexing and verification of the
batch, continue with the appropriate step in the indexing and verification
process.
5. If you are an Administrator, you can do the following steps.
a. At the Scan pane, create a batch by using a scanner or pre-scanned images.
b. Open the Verify pane and set up a document type and its index fields.
Related tasks:
“Setting up batch profiles in Local mode” on page 58
“Setting up batch profiles in Datacap Server mode” on page 60
“Creating a batch with pre-scanned images”
“Creating a batch by using a scanner” on page 68

Creating a batch with pre-scanned images


You can run the FastDoc Disk Scan option to create a batch of image files that are
stored in a location that is accessible from your computer.

FastDoc can process pre-scanned image files with the following file extensions:
v bmp
v Jpg, jpeg
v Pdf (single and multi-page files)
v png
v Tif, tiff (single and multi-page files)

To create a new batch with pre-scanned images:


1. Start FastDoc in Local mode.
2. Click the Batch Profile that you want to run. The FastDoc main window
displays the Scan pane.
3. If the Disk Scan pane is not displayed, click View and select Disk Scan.
4. Click Scan. The Select the images to add to the batch window opens.

FastDoc 67
5. Go to the folder that contains the images you want to process and select the
images to process. The default location for the sample images is
C:\Datacap\appname\Images\Input.
6. Click Open. The images are downloaded into FastDoc and thumbnails of each
image are displayed in the Image Stream pane.
7. Repeat the scanning procedure to include more images in this batch. Ensure
you downloaded all of the pages of each multi-page document. You can use
the Control Bar to display a specific page or document to delete one or more
images, and sequence pages.
8. To put the batch on hold, click  next to Submit and select Hold.
9. To cancel processing the batch, click  next to Submit and select Cancel.
10. Click Submit to run recognition processing.
11. Click U to validate this document and go to the next document and make any
needed corrections. After the Validation task is completed, Rulerunner runs
the Export ruleset that you configured for this Batch Profile.
Related tasks:
“Indexing and verifying batches” on page 69

Creating a batch by using a scanner


You can run the FastDoc TWAIN Scan or ISIS Scan option to create a batch of
documents from the image files that you scanned.

The instructions for using a scanner to download documents into FastDoc are
different from using pre-scanned images.

To create a batch by using a scanner:


1. Prepare your paper documents for scanning.
2. Ensure that your scanner is started.
3. Start FastDoc in Local mode.
4. Click the Batch Profile that you want to run. The FastDoc main window
displays the Scan pane.
5. Click View and select TWAIN Scan, or ISIS Scan. The pane for the selected
diver is displayed.
6. Click Source to display a list of available scanners. If your scanner does not
appear, the driver of the scanner was not installed properly.
a. Close FastDoc and follow the instructions of the scanner manufacturer to
install or reinstall the driver of the scanner.
b. Restart FastDoc.
c. Return to Source and select the driver.
7. Click Options for TWAIN Scan or Advanced for ISIS Scan and select the
appropriate settings.
a. Click Duplex to scan both sides of each page.
b. Click Landscape when your scanner is feeding paper in landscape
orientation.
c. Select the appropriate image format options for the Mode that you
selected.

Attention:
For Kodak scanners, if the two-sided option is selected on the Kodak scanner,
your images are scanned in duplex mode regardless of the Duplex setting on
FastDoc. If the one sided scan option is selected on the scanner, you can set

68 IBM Datacap: System Administration Guide


duplex mode. Click Duplex on FastDoc or do nothing and scan the images in
one sided mode.
8. Click OK.
9. Ensure that the Resolution setting is set to the scanning resolution (200 dpi or
78 DPCM). The current setting is displayed beneath the dial. Click above the
dial, and move your cursor horizontally over the dial to change the setting.
10. Change the settings for brightness and contrast you do not want the default
settings. Click above the dial, and move your cursor horizontally over the top
of the dial to change the setting.
11. Load your pages into the scanner and click Scan. Messages display as
scanning begins. The scanned image of the first page is displayed in the
Active Image pane. Thumbnails of each of the scanned pages appear in the
Image Stream pane. You can use the Control Bar to display a specific page or
document to delete one or more images, and sequence pages.
12. To put the batch on hold, click  next to Submit and select Hold.
13. To cancel the batch, click  next to Submit and select Cancel.
14. Click Submit to run recognition processing.
15. Click U to validate this document and go to the next document and make any
needed corrections. After the Validation task is completed, Rulerunner runs
the Export ruleset that you configured for this Batch Profile.
Related tasks:
“Preparing paper documents for scanning” on page 66
“Indexing and verifying batches”

Indexing and verifying batches


After the FastDoc Recognition task is run, review the results in the Verify pane
and make corrections where needed.

When FastDoc completes the Recognize task, the FastDoc window is displayed
with the Verify pane, the Active Image pane, and the Control Bar.

Each Verify pane looks and behaves differently depending on the fields and the
types of validation that the administrator defined for the Document Type. The
pane displays fields that might contain captured data. Fields with low confidence
recognition are displayed in yellow. The fields that failed validation rules are
displayed in pink.

To index and verify your batch:


1. When the Document type selected by FastDoc is incorrect, you can change it.
2. When the low confidence data is correct, tab out of the field.
3. Make corrections to fields that contain incorrect low confidence data or failed
validations by using any of these methods or tools:
v You can include missing data or replace problem index values by using the
Click N Key.
v You can also type in the correct values.
4. Display any image in the batch, change the image size, or change the batch by
using any of these methods or tools:
a. Select the image that you want to display by clicking it in the Active Image
pane.
b. Use the buttons on the Control Bar to display a specific page or document,
or use the other buttons to delete one or more images, and sequence pages.

FastDoc 69
c. Use keyboard shortcuts to move focus among the various panes, panes, and
manipulate the image.
5. Click Next Problem to rerun validations and display the next image that failed
validations.
6. If an error message is displayed that indicates that a validation failed, the field
value must be corrected before you can continue to the next document. Click
OK, correct the error, and repeat the previous step.
7. At the end of the batch, if the document or page count you entered when you
created the batch:
v Does not match the actual number of documents or pages that are being
processed, a warning is displayed. This issue usually happens because you
deleted one or more documents or pages. Click Yes to continue.
v Matches the number of batches that are being processed, a message is
displayed indicating there are no more problems.
8. Click OK. FastDoc exports the images and index values for the batch and
displays the Datacap window where you can create another new batch.
Related tasks:
“Defining an index field with keywords” on page 64
“Defining index field validation by using a database” on page 65
“Using Click N Key to capture data” on page 65

Running FastDoc in Datacap Server mode


You can run the FastDoc as a client to Datacap Server to scan, index, verify, and
upload documents to Datacap Server. In Datacap Server mode, you can use
Datacap Studio and Application Manager for more application development.

In Datacap Server mode, you use the Datacap Web Client Administrator or
Datacap Navigator to configure the tasks on your applications that are run on the
FastDoc client.

To run FastDoc in Datacap mode:


1. Start FastDoc and select Datacap Server on the Welcome to Datacap window.
a. Select the Datacap application.
b. Type a valid user ID and Password for the workstation.
c. Type the ID of the workstation.
d. Click Login.
2. Click the task shortcuts for the selected application.

Processing documents on the Forms template


To process documents on the Forms template, you run the appropriate rulesets in
the VScan, PageID, Profiler, and Export task profiles.

The following instructions describe how to process images for the


DemoSingleTIFFs job on the Forms template. The additional rulesets that are run
for the DemoMultiFormat job are noted in the instructions.

Rulesets that do not display an ellipse next to their name in the Workflow Editor
must be configured in Datacap Studio by using actions.

To process documents on the Forms template:


1. Start FastDoc in Datacap Server mode.

70 IBM Datacap: System Administration Guide


2. Log in to the Forms application.
3. Click the VScan shortcut. This task runs a disk scan on the image files that are
stored in the C:\Datacap\appname\images\input.
a. Select the Job that you want to run. The VScan ruleset is run and FastDoc
returns to the Shortcuts screen.
b. For the DemoMultiFormat job, the Convert Images and
DeleteSourceImages rulesets are run.
4. Click the PageID shortcut. This task sets up the form by determining what the
form is and where it came from through the fingerprint.
a. Runs the Image Enhancement ruleset to clean up the imperfections in the
image.
b. Runs the Identify Pages ruleset at the batch level to run recognition on the
image. The Fingerprinting recognition option is selected by default. If you
select another option, you might have to redefine the zones on the page.
c. Runs the Document Integrity ruleset to check the batch structure. If the
page type or the document type is not recognized, the Routing step opens
the Fixup Job.
5. Click the Fixup shortcut to resolve recognition issues with the page type ID or
the document type.
a. Select the job that you want to fix. FastDoc displays the Verify screen for
that job.
b. Click Document and select the document type to use.
c. Click the inverted triangle next to Document and select the page type to
use.
d. Click Submit.
e. Returns to the PageID task profile and reruns each page until every page is
ready for the Profiler task profile.
Attention: FastDoc uses the Verify screen to run Fixup. You can use
Datacap Desktop to run full Fixup functionality.
6. Click the Profiler shortcut.
a. Runs the Read Zone ruleset to get the coordinates of the fields from the
Forms template and read the zones.
b. Runs the Recognize Pages and Fields ruleset to add the fields to the page
that you want to recognize.
c. Uses the recognition method that you specified. For example, page
recognition in the zone, hand print in zone, barcode in zone.
d. Runs the Validate Fields ruleset that sets up the conditions that must be
met to validate the data in each field. The data in every field must meet
these conditions.
e. Runs the Routing ruleset that marks the pages as passed, low confidence,
and so on. The forms that pass validation are routed directly to the Export
task. The other forms go into a Verify Export job where they are corrected.
7. Click the Export shortcut to run the ruleset that you configured for this job.
a. Runs the Export ruleset to write the file to a specified location on the disk.
b. Runs the Export to FileNet Content Manager ruleset to store the file in the
IBM FileNet Content Manager repository.
c. Runs the Export to IBM Content Manager ruleset to store the file in the
IBM Content Manager repository.

FastDoc 71
Processing documents on the Learning template
To process documents on the Forms template, you run the appropriate rulesets in
the VScan, Profiler, Verify, and Export task profiles.

Processing images for the DemoSingleTIFFs job is the same for the Forms and the
Learning template. The following instructions describe how to process images for
the DemoMultiFormat job on the Learning template.

Rulesets that do not display an ellipse next to their name in the Workflow Editor
are configured in Datacap Studio by using actions.

To process documents on the Learning template:


1. Start FastDoc in Datacap Server mode.
2. Log in to the Learning application.
3. Click the VScan shortcut. This task runs a disk scan on the image files that are
stored in the C:\Datacap\appname\images\input.
a. Select the DemoMultiFormat job.
b. Runs the Import, Convert Images, and DeleteSourceImages rulesets.
FastDoc returns to the Shortcuts screen.
4. Click the Profiler shortcut. This task sets up the form by determining where
the data that you want to process is on the image.
a. Runs the Managed Rotatation ruleset to enable rotation of the image.
b. Runs the Image Enhancement ruleset to clean up the imperfections in the
image. Select Auto Rotate to enable the Managed Rotatation ruleset.
c. Runs the PageID ruleset to identify the path on which the document came
in and create the document structure. If the path is the same as another
document, assumes that it is the same document type.
d. Puts all of the data on the Main_Page document type and treats every
image as its own document. When the ruleset gets to a Separator sheet, it
treats the next page as Main_Page. The page after that is treated as a
Trailing_Page.
e. Runs the Recognize ruleset to identify the page types as Main_Page and
Trailing_Page.
f. Inserts a Doc_Separator page in front of the Trailing_Pages.
g. Inserts an Attactment_Separator page in front of the attachments.
Recognition is not run on the attachments.
h. Runs the Fingerprint ruleset to build a fingerprint with a fingerprint ID for
each document type.
i. Runs the Locate ruleset to search CCO for data, such as Social Security
Number, Invoice Number, Date.
j. Runs the Lookup ruleset to take the fingerprint ID and find the fingerprint
class for it.
k. Runs the Validate ruleset on the fields to validate the data in every field
and make corrections where needed.
l. Runs the Routing ruleset to route the forms that passed validation to the
Export task.
5. Click the Verify shortcut.
a. Runs the Validate ruleset on the form to remember the field information
and automatically run it the next time that it is recognized.
6. Click the Export shortcut to run the ruleset that you configured for this job.

72 IBM Datacap: System Administration Guide


a. Runs the SetStatuses ruleset to set up the exporting status of the document.
b. Runs the PreExport ruleset to use the specified export settings for the
document.
c. Runs the Export ruleset to write the file to a specified location on the disk.
d. Runs the Export to FileNet Content Manager ruleset to store the file in the
IBM FileNet Content Manager repository.
e. Runs the Export to IBM Content Manager ruleset to store the file in the
IBM Content Manager repository.
f. Runs the ProcessExceptions ruleset to handle exceptions to regular
processing. For example, what to do with rescans and unwanted documents.

Displaying a page or document


You can manage the pages in an FastDoc document by using the icons in the
Control Panel.

To organize the pages in your document:


1. Click <Go to previous or Go to next>to move from page to page.
2. Click |<first or last>|to display the first or last page in the document.
3. Select the thumbnail of the page or document or right-click Page or Document
and enter the number of the page or document you want to view.

Deleting pages
You can delete pages from your FastDoc batch from the Image Stream pane.

If you delete all of the pages from a batch and click Next Problem, the message
cannot continue without pages. Place batch on hold to delete it. is
displayed. Click OK, then click Hold.
1. Use the following procedures to delete pages from the batch:
2. Select the page that you want to delete and click X to delete the current page.
3. Select the first page that you want to delete and click X> to delete that page
and all of the pages to the end of the batch.
4. Click <X> to delete all of the pages in the batch.

FastDoc 73
74 IBM Datacap: System Administration Guide
FastDoc maintenance
FastDoc provides maintenance features that manage the input files, folders, and
files that are associated with completed and unfinished batches that can
accumulate over time.

To prevent input files from accumulating, use the Delete Images setting on the
Scan Settings panel to delete the original input files automatically from disk after
image recognition is done.

To remove folders and files that are associated with completed and unfinished
batches, FastDoc provides two functions that free up disk space.
v Purge finished batches
v Delete selected batch

In addition, FastDoc provides statistics about the processing that was done each
day.

Purging finished batches


Files that contain processing information that is associated with exported batches
accumulate in your FastDoc Batches folder. When a batch is exported successfully
and the processing files are no longer needed, you can purge them.

Purging files does not affect the exported image or TXT files and purging
periodically is a good idea to free up disk space.

To purge finished batches:


1. Start FastDoc.
2. In the Select a Batch window, with a count of the open and finished existing
batches.
3. Click Purge finished batches. A message box displays the number of batches
that are purged and you are asked to confirm this action.
4. Click Yes. A message box confirms the number of batches that were purged.
5. Click OK to close the message box. The batch folders were purged.

Deleting selected batches


Unfinished batches can accumulate in your FastDoc Batches folder. If you are not
going to complete the processing of an unfinished batch, you can delete the batch
to free up disk space.

To delete selected batches:


1. Start FastDoc.
2. On the Select a Batch window, select the batch that you want to delete.
3. Click Delete selected batch. A message box displays the batch number of the
batch you selected and you are prompted to confirm the deletion.
4. Click Yes. The message box closes and the batch is no longer displayed on the
Select a Batch window.

© Copyright IBM Corp. 2014 75


Viewing daily batch statistics
FastDoc creates an XML file every day that contains daily batch statistics for
completed Scan processes and the Export processes. The file name is the processing
date in the format MM_DD_YYYY.xml.

To view the daily statistics:


1. Start Microsoft Excel and select File > Open.
2. In Datacap mode, the daily statistics are stored in the Engine database.
3. In Local mode, go to the C:\Datacap\FastDoc\statistics folder and open the
XML file as an XML list.
4. Review the information in the following columns.

Column Heading Description


id Batch ID
batch_created Batch creation date/time stamp
scan_user User ID and domain of the user who is
running the scan process
scan_station Name of computer on which scan was run
documents_scanned Number of documents scanned
pages_scanned Number of pages scanned
batch_exported Date/time stamp of export
verify_user User ID and domain of the user who is
running verify process
verify_station Name of computer on which verify was run
documents_exported Number of documents exported
pages_exported Number of pages exported

Determine the original file name of a pre-scanned image


When you process pre-scanned images that are produced on a system outside of
FastDoc. You might need to know the FastDoc file name and the file name that is
given to the image by the originating system.

Both the FastDoc file name and the original file name for each pre-scanned image
are stored in the Scan.xml, Recognize.xml, Verify.xml and Export.xml files. These
files are found in each batch folder. If there are multiple images in a batch, the
names of all the images in the batch are found in these XML files.
v The original file name for each pre-scanned image is stored in the
IMAGEORIGIN element.
v The FastDoc file name for each image is stored in the IMAGEFILE element.

76 IBM Datacap: System Administration Guide


Maintaining fingerprints by using the Fingerprint Maintenance
Tool
Use the Fingerprint Maintenance Tool (FMT) to manage your fingerprints and
synchronize information between the Fingerprint database, the Document
Hierarchy, and Fingerprint XML data files.

Important: Before you start the Fingerprint Maintenance Tool, confirm that all
Datacap clients are stopped.

If you attempt to start the Fingerprint Maintenance Tool and the DCO file is locked
by another process, Datacap displays an error message. For example, when a
developer is modifying the document hierarchy in Datacap Studio, the DCO file is
locked and you cannot use the Fingerprint Maintenance Tool.
Related reference:
Appendix B, “Fingerprint Maintenance Tool reference,” on page 83

Starting the Fingerprint Maintenance Tool


Start the Fingerprint Maintenance Tool on the Datacap server where the application
files are located.

The first time the Fingerprint Maintenance Tool is run, a message is displayed
indicating a backup directory is created.

To start the Fingerprint Maintenance Tool:


1. Open Windows Explorer and navigate to the Datacap\Application\
dco_Application folder. For example, go to Datacap\APT\dco_APT.
2. Double-click Fingerprint Maintenance Tool.exe. The Fingerprint Maintenance
Tool window opens.

Locating and deleting partial fingerprints


Partial fingerprints that are associated with documents that are not processed
accumulate over time and must be deleted.

To locate and delete partial fingerprints:


1. Start the Fingerprint Maintenance Tool.
2. Click Find Problems to locate existing problems.
3. When entries with X are displayed, click Select All, then click Delete Selected.
The partial fingerprints are deleted.
4. Close the Fingerprint Maintenance Tool.

Deleting fingerprints
You can use the Fingerprint Maintenance Tool to delete unwanted fingerprints
from the system. You must know the Fingerprint ID.

To delete a fingerprint:
1. Start the Fingerprint Maintenance Tool.

© Copyright IBM Corp. 2014 77


2. Click the Show Statisticsbutton to display information about all existing
fingerprints.
3. Select the ID of the fingerprint that you want to delete.
4. Click the Delete Selected button.

Deleting fingerprints that are associated with a document type


In FastDoc, fingerprints are saved by host name, where the host name is the same
as the document type name. You must know the document type name before you
run this procedure.

To delete all fingerprints that are associated with a document type:


1. Start the Fingerprint Maintenance Tool for the application. For example, select
Start > IBM Datacap Developer Tools > Datacap Accounts Payable
Fingerprint Maintenance Tool.
2. Click Show Statistics to display information about all existing fingerprints.
3. Click the Host Name column heading to sort the list by host name.
4. Highlight the records where host name is equal to the document type.
5. Click Delete Selected.

Exporting selected fingerprints


When you want to move fingerprints from one application environment to another,
such as from Test to Production, you must first export the fingerprints from the
source Fingerprint database. You then import, or add, those fingerprints to the
target Fingerprint database.
1. Start the Fingerprint Maintenance Tool that is associated with the source
application environment.
2. Click the Show Statistics button to display information about the existing
fingerprints.
3. Highlight the fingerprints that you want to export.
4. Click the Export Selected button. The Enter Identification Prefix window opens.
5. Enter 2 alphabetic characters. These characters become the first 2 characters
of the exported fingerprint-related files. Then, click OK. The window closes
and the exported files are placed in the application's \fingerprint\Fingerprint
Export folder.
6. For instructions on adding these exported fingerprints to the target application
environment, see “Adding selected fingerprints.”

Adding selected fingerprints


To move fingerprints from one application environment to another, such as from
Test to Production, after you export the fingerprints from the source Fingerprint
database. You then import, or add, those fingerprints to the target Fingerprint
database.
1. Using Windows Explorer, copy the exported fingerprint-related files (TIFF,
CCO, XML) from the source application's \fingerprint\Fingerprint Export
folder to the target application environment's \fingerprint folder.
2. Start the Fingerprint Maintenance Tool that is associated with the target
application environment.
3. Click the Find FPXML Files button to locate fingerprints that are not in the
target application environment's Fingerprint database.

78 IBM Datacap: System Administration Guide


4. When one or more entries are displayed, click the Select All button, then click
the Add Selected button. The fingerprints are added to the target application
environment's Fingerprint database.
5. Close the Fingerprint Maintenance Tool.

Troubleshooting the Fingerprint Maintenance Tool


This section contains information on resources that might help you to troubleshoot
the Fingerprint Maintenance Tool.

FMT Backup Directory


This folder is found in the application's dco_ directory. The folder contains the
FMT.Log and backup copies of the SetupDCO file that are created when you run the
Fingerprint Maintenance Tool.

FMT.Log
This log contains processing details that identify the changes that are made and
attempted by the Fingerprint Maintenance Tool.

Maintaining fingerprints by using the Fingerprint Maintenance Tool 79


80 IBM Datacap: System Administration Guide
Appendix A. FastDoc keyboard shortcuts
FastDoc provides keyboard navigation to make it more accessible to users with
limited dexterity, low vision, or other disabilities.

You can use the keyboard to navigate through FastDoc without using a mouse. Use
the following table to determine which keys to use. The keys that you use affect
the item that currently has focus. Focus is indicated by a dotted line around the
item.

To Do This Do This
Assign the focus to the Active Image pane CTRL+I
Assign the focus to the Active Stream pane CTRL+D
Autofit the active image horizontally and CTRL+1
vertically
Autofit the active image horizontally CTRL+2
Autofit the active image vertically CTRL+3
Clear the current field CTRL+Z
Click N Key to capture data from image Click in the index field in the Verify pane,
then click and drag the mouse on the image
to draw a new zone. The zone can be empty
or it can contain data.
Finish the current task and go to the next CTRL+K
available task
CTRL+T
Go to next Low Confidence or error field ALT+L
Make the current page a trailing page ALT+CTRL+PgDn
Make the current page the first page of a ALT+CTRL+PgUp
document
Move the image down SHIFT+ALT+Numeric Keypad 8
Move the image to the left SHIFT+ALT+Numeric Keypad 6
Move the image to the right SHIFT+ALT+Numeric Keypad 4
Move the image up SHIFT+ALT+Numeric Keypad 2
Move the image or pan to the left or right Click and drag with right mouse button

ALT+Right or Left arrows

ALT+Click and drag with left mouse button


Move the image or pan up or down Click and drag with right mouse button

ALT+Up or Downarrows

ALT+Click and drag with left mouse button


Go to the next image PgDn
Go to the previous image PgUp
Place the focus in the Document Type list ALT+G

© Copyright IBM Corp. 2014 81


To Do This Do This
Quit the current task and put the batch on CTRL+Q
hold
CTRL+S
Run validations ALT+V
Run validations and display next problem CTRL+F
document
Toggle between Zoom 100% and Autofit both CTRL+0
horizontally and vertically
CTRL+Double-click left mouse button on
image

Click middle mouse button


Toggle the current image as the first page of ALT+D
the document or as a trailing page
Zoom 100% (view actual size) CTRL+~
Zoom in to expand the image expands Double-click image with left mouse button

CTRL+I then pull mouse wheel toward you

CTRL+Home

CTRL+I then CTRL+Up arrow

CTRL+ "+/=" key

CTRL+Plus
Zoom out to shrink the image shrinks Double-click image with left mouse button

CTRL+I then push mouse wheel away from


you

CTRL+End

CTRL+I then CTRL+Down arrow

CTRL+"_/-" key

CTRL+Minus

82 IBM Datacap: System Administration Guide


Appendix B. Fingerprint Maintenance Tool reference
Use the Fingerprint Maintenance Tool (FMT) to manage your fingerprints and
synchronize information between the Fingerprint database, the Document
Hierarchy, and Fingerprint XML data files.
Related tasks:
“Maintaining fingerprints by using the Fingerprint Maintenance Tool” on page 77

Fingerprint Maintenance Tool configuration settings


The Settings.ini file that is installed with the APT application in the
C:\Datacap\APT\dco_APT folder contains information that is required by the
Fingerprint Maintenance Tool.

Database Section

Contains the connection strings to one or more databases that are used by the
Fingerprint Maintenance Tool.
FingerprintDatabase Setting
Defines the connection string to the Fingerprint database used by the
Fingerprint Maintenance Tool. For example:
FingerprintDatabase=Provider=Microsoft.Jet.OLEDB.4.0;
Data Source=C:\Datacap\apt\process\APTFingerprint.mdb;
Persist Security Info=False

Paths Section

Contains path information that is required by the Fingerprint Maintenance Tool.


FingerprintDirectory Setting
Defines the path to the application's folder that contains the application's
fingerprint files (TIFF, CCO, or Fingerprint XML files). For example:
FingerprintDirectory=c:\datacap\apt\Fingerprint
FingerprintBackupDirectory Setting
Defines the path to the folder that contains backup copies of the
Fingerprint XML files that are made when fingerprints are added to an
application. If this folder does not exist, it is created when the Fingerprint
Maintenance executable is started. For example:
FingerprintBackupDirectory=c:\datacap\apt\Fingerprint Backup
SetupDCO Setting
Defines the path to the application's Setup DCO file. For example:
SetupDCO=c:\datacap\apt\dco_APT\APT.xml

FMT Section

Contains the SQL query that is used by the Fingerprint Maintenance Tool. For
example:
[FMT]
FilteredSummary=Select Template.tp_TemplateID,Template.tp_DateAdded,
Template.tp_HitCount,Template.tp_LastHit,Host.hs_RefName FROM Template,
Host WHERE host.hs_HostID = Template.tp_HostID

© Copyright IBM Corp. 2014 83


Fingerprint Maintenance Tool buttons
Use the following Fingerprint Maintenance Tool buttons to view, modify, and
search for fingerprints.
Add Selected
Adds the selected fingerprints to the application's Fingerprint database and
setup DCO, and copies the associated TIFF and CCO files into the
application's Fingerprint folder.
Delete Selected
Deletes the selected fingerprint, including the TIFF, CCO, and fingerprint
XML files, and the associated entry in the Fingerprint database.
Export Selected
Exports copies of the selected fingerprints, including the TIFF, CCO, and
fingerprint XML files, to the application's \fingerprint\Fingerprint
Export folder.
Find FPXML Files
Finds any fingerprint XML files that are in the application's \fingerprint
folder.
Find Problems
Displays all fingerprints for which one or more components are missing
from the Fingerprint Directory, such as the TIFF, CCO, or fingerprint XML
files, or when the entry for the fingerprint in the application's Fingerprint
database is missing.
Select All
Selects all displayed fingerprints.
Show Statistics
Displays all existing fingerprints and statistics that are related to each.

Fingerprint Maintenance Tool fields


List and description of the fields that you use for maintaining fingerprints.
Fingerprints are used both for page identification and for specifying recognition
zones.
Backup Directory
Displays the full path to the folder that contains backup copies of the
fingerprint XML files that are made when fingerprints are added to an
application. If this folder does not exist, it is created when the Fingerprint
Maintenance executable is started.
CCO An X in this column indicates that the CCO file associated with this
fingerprint is missing from the application's Fingerprint Directory.
Database
An X in this column indicates that the entry that is associated with this
fingerprint is missing from the application's Fingerprint database.
Date Added
Displays the date that the fingerprint was either created in or added to this
application from another.
Document Hierarchy
Displays the full path and file name of the application's Setup DCO.

84 IBM Datacap: System Administration Guide


Fingerprint
Displays the fingerprint's Fingerprint ID.
Fingerprint Database
Displays the connection string information that is related to the
application's Fingerprint database.
Fingerprint Directory
Displays the full path to the directory in which the fingerprint-related files
(TIFF, CCO, XML) are stored.
FPXML
An X in this column indicates that the XML file associated with this
fingerprint is missing from the Fingerprint Directory.
Hits/Month
This field is an estimate of how many times per month the fingerprint is
matched. This estimate is based on the age of the fingerprint and the
number of times the fingerprint was matched to date. This estimate is
calculated by first calculating the age of the fingerprint (in months) by the
number of times it was matched.
For example, if a fingerprint is one month old (30 days) and was matched
one time, the Hits/Month value is 1.0000. If the fingerprint is two months
old (60 days) and was matched one time, the Hits/Month value is 0.5000.
HostName
The HostName is the Document Type assigned to the document associated
with this fingerprint.
Last Hit
Displays the date on which the fingerprint was last matched.
Setup DCO
An X indicates that the Setup DCO is missing.
Status The Status field indicates the status of the Fingerprint Maintenance Tool.
The status is listed as Done, missing (denoted with an X), or Testing.
TIFF An X in this column indicates the TIF file that is associated with this
fingerprint is missing from the Fingerprint Directory.
Total Hits
Indicates the number of times the fingerprint was matched since it was
created.

Appendix B. Fingerprint Maintenance Tool reference 85


86 IBM Datacap: System Administration Guide
Appendix C. Troubleshooting IBM Datacap
Troubleshooting is a systematic approach to solving a problem. The goal of
troubleshooting is to determine why something does not work as expected and
how to resolve the problem. You can search live, Web-based support resources by
using the Web search form under Searching knowledge bases in the left navigation
pane.

The first step in the troubleshooting process is to describe the problem completely.
Problem descriptions help you and the IBM Support representative know where to
start to find the cause of the problem. This step includes asking yourself basic
questions:
v What are the symptoms of the problem?
v Where does the problem occur?
v When does the problem occur?
v Under which conditions does the problem occur?
v Can the problem be reproduced?

The answers to these questions typically lead to a good description of the problem,
which can then lead you a problem resolution.

What are the symptoms of the problem?

When starting to describe a problem, the most obvious question is “What is the
problem?” This question might seem straightforward; however, you can break it
down into several focused questions that create a more descriptive picture of the
problem. These questions can include:
v Who, or what, is reporting the problem?
v What are the error codes and messages?
v How does the system fail? For example, is it a loop, hang, crash, performance
degradation, or incorrect result?

Where does the problem occur?

Determining where the problem originates is not always easy, but it is one of the
most important steps in resolving a problem. Many layers of technology can exist
between the reporting and failing components. Networks, disks, and drivers are
only a few of the components to consider when you are investigating problems.

The following questions help you to focus on where the problem occurs to isolate
the problem layer:
v Is the problem specific to one platform or operating system, or is it common
across multiple platforms or operating systems?
v Is the current environment and configuration supported?

If one layer reports the problem, the problem does not necessarily originate in that
layer. Part of identifying where a problem originates is understanding the
environment in which it exists. Take some time to completely describe the problem
environment, including the operating system and version, all corresponding
software and versions, and hardware information. Confirm that you are running

© Copyright IBM Corp. 2014 87


within an environment that is a supported configuration; many problems can be
traced back to incompatible levels of software that are not intended to run together
or have not been fully tested together.

When does the problem occur?

Develop a detailed timeline of events leading up to a failure, especially for those


cases that are one-time occurrences. You can most easily develop a timeline by
working backward: Start at the time an error was reported (as precisely as possible,
even down to the millisecond), and work backward through the available logs and
information. Typically, you need to look only as far as the first suspicious event
that you find in a diagnostic log.

To develop a detailed timeline of events, answer these questions:


v Does the problem happen only at a certain time of day or night?
v How often does the problem happen?
v What sequence of events leads up to the time that the problem is reported?
v Does the problem happen after an environment change, such as upgrading or
installing software or hardware?

Responding to these types of questions can give you a frame of reference in which
to investigate the problem.

Under which conditions does the problem occur?

Knowing which systems and applications are running at the time that a problem
occurs is an important part of troubleshooting. These questions about your
environment can help you to identify the root cause of the problem:
v Does the problem always occur when the same task is being performed?
v Does a certain sequence of events need to occur for the problem to surface?
v Do any other applications fail at the same time?

Answering these types of questions can help you explain the environment in
which the problem occurs and correlate any dependencies. Remember that just
because multiple problems might have occurred around the same time, the
problems are not necessarily related.

Can the problem be reproduced?

From a troubleshooting standpoint, the ideal problem is one that can be


reproduced. Typically, when a problem can be reproduced you have a larger set of
tools or procedures at your disposal to help you investigate. Consequently,
problems that you can reproduce are often easier to debug and solve. However,
problems that you can reproduce can have a disadvantage: If the problem is of
significant business impact, you do not want it to recur. If possible, re-create the
problem in a test or development environment, which typically offers you more
flexibility and control during your investigation.
v Can the problem be re-created on a test system?
v Are multiple users or applications encountering the same type of problem?
v Can the problem be re-created by running a single command, a set of
commands, or a particular application?

88 IBM Datacap: System Administration Guide


Searching knowledge bases
You can often find solutions to problems by searching IBM knowledge bases. You
can optimize your results by using available resources, support tools, and search
methods.

IBM provides extensive documentation within Knowledge Center. You can find
useful information by searching Knowledge Center, but sometimes you need to
look beyond Knowledge Center to answer your questions or resolve problems.

To search knowledge bases for information that you need, use one or more of the
following approaches:
v Search for content by using the IBM Support Assistant (ISA). ISA is a no-charge
software serviceability workbench that helps you answer questions and resolve
problems with some IBM software products. You can find instructions for
downloading and installing ISA on the ISA website (www.ibm.com/software/
support/isa/). Some IBM products have not fully implemented support for ISA.
v Find the content that you need by using the IBM Support Portal:
http://www.ibm.com/supportportal (www.ibm.com/supportportal).
The IBM Support Portal is a unified, centralized view of all technical support
tools and information for all IBM systems, software, and services. The IBM
Support Portal lets you access the IBM electronic support portfolio from one
place. You can tailor the pages to focus on the information and resources that
you need for problem prevention and faster problem resolution. Familiarize
yourself with the IBM Support Portal by viewing the demo videos
(https://www.ibm.com/blogs/SPNA/entry/the_ibm_support_portal_videos)
about this tool. These videos introduce you to the IBM Support Portal, explore
troubleshooting and other resources, and demonstrate how you can tailor the
page by moving, adding, and deleting portlets.
v To search multiple Internet resources for your product, expand Searching
knowledge bases in the navigation frame to the left and select Web search. From
this topic, you can conduct a Google search or search within IBM
developerWorks®. You can also link directly to the support portal for this
product where you can search a variety of resources including:
– IBM technotes
– IBM downloads
– IBM Redbooks®
v Search for content by using the IBM masthead search. You can use the IBM
masthead search by typing your search string into the Search field at the top of
any ibm.com page.
v Search for content by using any external search engine, such as Google, Yahoo,
or Bing. If you use an external search engine, your results are more likely to
include information that is outside the ibm.com domain. However, sometimes
you can find useful problem-solving information about IBM products in
newsgroups, forums, and blogs that are not on ibm.com.

Tip: Include “IBM” and the name of the product in your search if you are
looking for information about an IBM product.
Related tasks:
“Contacting IBM Software Support” on page 90

Appendix C. Troubleshooting IBM Datacap 89


Getting fixes from Fix Central
You can use Fix Central to find the fixes that are recommended by IBM Support
for a variety of products. With Fix Central, you can search, select, order, and
download fixes for your system with a choice of delivery options.

To find and install fixes:


1. Go to Fix Central (www.ibm.com/support/fixcentral) to download the
installation program for product fixes. Fix Central provides download,
installation, and configuration instructions for the installation program.
2. Select Enterprise Content Management as your product group, then select your
product, version and platform, and click Continue.
3. Browse or search for fixes based on criteria such as (Authorized Program
Analysis Report) APAR number or fix ID, or just request a list of recommended
fixes.
4. If you have already registered for My support, sign in and skip to the next
step. If you have not registered, click Register now. Complete the registration
form using your email address as your IBM ID and click Submit.
5. Select and download the fix using your preferred download method. When
downloading the file, ensure that the name of the maintenance file is not
changed. This change might be intentional, or it might be an inadvertent
change that is caused by certain web browsers or download utilities.
6. Apply the fix.
7. Optional: Subscribe to receive weekly email notifications about fixes and other
IBM Support updates.
Related tasks:
“Subscribing to Support updates” on page 91

Contacting IBM Software Support


IBM Software Support provides assistance with product defects, answering FAQs,
and performing rediscovery.

After trying to find your answer or solution by using other self-help options such
as technotes, you can contact IBM Software Support. Before you contact IBM
Software Support, your company must have an active IBM software subscription
and support contract, and you must be authorized to submit problems to IBM. The
type of software subscription and support contract that you need depends on the
type of product you have. For information about the types of available support, see
the Support portfolio topic in the Software Support Handbook.

Complete the following steps to contact IBM Software Support with a problem:
1. Define the problem, gather background information, and determine the severity
of the problem. To determine the severity level, you need to understand and
assess the business impact of the problem you are reporting. Use the following
criteria:

Severity Business impact


1 Critical business impact: You are unable to use the program, resulting in
a critical impact on operations. This condition requires an immediate
solution.
2 Significant business impact: The program is usable but is severely
limited.

90 IBM Datacap: System Administration Guide


Severity Business impact
3 Some business impact: The program is usable with less significant
features (not critical to operations) unavailable.
4 Minimal business impact: The problem causes little impact on
operations, or a reasonable circumvention to the problem has been
implemented.

For more information, including examples of each severity level, see the
“Getting IBM support” topic in the IBM Software Support Handbook.
2. Gather diagnostic information. Use the Web search form (under
Troubleshooting and support > Searching knowledge bases in the navigation
pane of this Knowledge Center) to search for the keyword mustgather to see
whether there are specific files or other diagnostic information to gather.
For example:
v What software versions were you running when the problem occurred?
v Do you have logs, traces, and messages that are related to the problem
symptoms? IBM Software Support is likely to ask for this information.
v Can the problem be re-created? If so, what steps led to the failure?
v Have any changes been made to the system (for example, hardware,
operating system, networking software, and so on)?
v Are you currently using a workaround for this problem? If so, please be
prepared to explain it when you report the problem.
3. Submit the problem to IBM Support.
IBM Support Assistant (ISA)
Go to the Software support site to use the IBM Support Assistant
(www.ibm.com/software/support/isa/).
Online
Go to the IBM Support Portal (www.ibm.com/software/support/). You
can open, update, and view all your Service Requests from the Service
Request portlet on the Service Request page.
Phone For the phone number to call in your country, see the Directory of
worldwide contacts web page (www.ibm.com/planetwide/).

If the problem that you submit is for a software defect or for missing or inaccurate
documentation, IBM Support creates an Authorized Program Analysis Report
(APAR). The APAR describes the problem in detail. Whenever possible, IBM
Support provides a workaround that you can implement until the APAR is
resolved and a fix is delivered. IBM publishes resolved APARs on the IBM Support
website daily, so that other users who experience the same problem can benefit
from the same resolution.
Related tasks:
“Searching knowledge bases” on page 89
Related information:
IBM Software Support Handbook

Subscribing to Support updates


To stay informed of important information about the IBM products that you use,
you can subscribe to updates.

Appendix C. Troubleshooting IBM Datacap 91


By subscribing to receive updates, you can receive important technical information
and updates for specific Support tools and resources. You can subscribe to updates
by using one of two approaches:
RSS feeds and social media subscriptions
For general information about RSS, including steps for getting started and
a list of RSS-enabled IBM web pages, visit the IBM Software Support RSS
feeds site.
My Notifications
With My Notifications, you can subscribe to Support updates for any IBM
product. You can specify that you want to receive daily or weekly email
announcements. You can specify what type of information you want to
receive (such as publications, hints and tips, product flashes (also known
as alerts), downloads, and drivers). My Notifications enables you to
customize and categorize the products about which you want to be
informed and the delivery methods that best suit your needs.

To subscribe to Support updates:


1. Go to the IBM Support Portal and click Sign in to create, manage, or view
your subscriptions in the Notifications pane.
2. If you have already registered for My support, sign in and skip to the next
step. If you have not registered, click Register now. Complete the registration
form using your email address as your IBM ID and click Submit.
3. Identify what and how you want to receive updates.
a. Click the Subscribe tab.
b. Click Information Management or another software brand or type of
hardware.
c. Select one or more products by name, for example, Content Manager
Enterprise Edition or FileNet Content Manager, and click Continue.
d. Select your preferences for how to receive updates, whether by e-mail,
online in a designated folder, or as an RSS or Atom feed.
e. Select the types of documentation updates you want to receive, for example,
new information about product downloads and discussion group
comments.
f. Click Submit.

Until you modify your RSS feeds and My Notifications preferences, you receive
notifications of updates that you have requested. You can modify your preferences
when needed (for example, if you stop using one product and begin using another
product).
Related tasks:
“Getting fixes from Fix Central” on page 90
Related information:
What is RSS?
IBM Software Support RSS feeds
Subscribe to My Notifications support content updates
My notifications for IBM Software support
My notifications for IBM Support overview

92 IBM Datacap: System Administration Guide


Appendix D. Troubleshooting Datacap security and
authentication
You might encounter problems when you start the Datacap system or log on to a
component. For example, in a client/server environment, you might see a problem
with the automatic encryption key import feature.

Automatic key import feature fails to apply the new encryption keys
In a client/server environment, the latest encryption keys must be applied when
you start a Datacap component. If encryption keys are not applied, you receive
authentication errors.

Symptoms
In a client/server environment, when an Datacap component is started on a client
computer for the first time, the component cannot communicate with the Datacap
server. Authentication errors result.

Causes
This problem can occur when the automatic key import feature fails to apply the
new encryption keys as expected when you start the component. This issue
impedes communication between the client computer and the Datacap server.

Resolving the problem


Ensure that you imported the latest keys from the Datacap server keystore by
using the documented procedure in Importing encryption keys to IBM Datacap
computers. Restart the Datacap component. If communication problems still persist,
import the keys manually.

To import the keys manually, copy the dcskey.exe file from the Datacap server to
the client computer. Then, run the dcskey.exe i command from the Microsoft
Windows desktop, either from the Start > Run command or from a command
prompt.
Related information
Importing encryption keys to Datacap computers

© Copyright IBM Corp. 2014 93


94 IBM Datacap: System Administration Guide
Appendix E. Troubleshooting Rulerunner
You might need to troubleshoot problems when you use Rulerunner to
automatically process background tasks when batches are pending.

You run these steps to troubleshoot Rulerunner.

First things to check


When you troubleshoot the Rulerunner Service, you can complete some tasks to
ensure that your system is set up correctly. For example, ensure the correct version
of Datacap is installed on all computers. The tasks also include running a batch
manually, and checking the Windows Event View logs on the Rulerunner server.

Make sure that Datacap 9.0 or later is installed on all of the computers in your
system.

Ensure that you can run a batch manually by using a Datacap client on a
workstation or from a browser. If you cannot manually run batches through the
tasks that Rulerunner is to process, your application setup needs to be corrected.
Review your installation and configuration of the application and review the
installation and configuration topics to troubleshoot your setup.

If you can run a batch manually, through the tasks that Rulerunner is configured to
process. And your application is set up properly. And you need to doRulerunner
specific troubleshooting. Follow the instructions in Viewing Windows Event Viewer
logs on Rulerunner server to stop Rulerunner, enable logging, restart Rulerunner,
and check the log files for errors.

If Rulerunner starts then stops immediately and the log files indicate that
Rulerunner cannot connect to the Datacap Server Service:
v If a firewall is enabled on the Server hosting the Datacap Server Service, ensure
that TCP/IP port 2402 was opened.
v When you use Windows Authentication, check with your system administrator
to make sure that you selected the correct Windows Authentication template in
the Datacap Server Manager.

Viewing Windows Event Viewer logs on Rulerunner server


You can open the Windows Event Viewer and view the Application and System
Logs on the Rulerunner server that hosts the Rulerunner Service. The Rulerunner
server must be running on Windows.

To view Windows Event Viewer logs on Rulerunner server:


1. On the Rulerunner server, in the Start menu click Control Panel >
Administrative Tools > Event Viewer > Windows Logs > Application.
2. Select Action > Refresh to ensure that you are seeing all recent messages.
3. Locate the first or last event from the most recent Rulerunner Service run and
double-click the entry to view the properties of the event.
Ignore the message:

© Copyright IBM Corp. 2014 95


The description for Event ID ( 0 ) in Source... cannot be found...
The following information is part of the event:

The information that follows this text is relevant.


The first event reads:
Service Started

Subsequent events indicate that the individual threads have each started. There
are three initialization attempts with intervals of 2, 4 and 8 seconds apart and
errors are logged if they occur.
Any warning or error events indicate a problem, the first warning, or error is
typically the most significant.
4. Select System. Entries for individual events are displayed in the details pane.
5. Double-click an entry to view the properties of the event. Messages indicate
that the Rulerunner Service was able to log on.
Any warning or error events indicate a problem, the first warning, or error is
typically the most significant.

Stopping the Rulerunner Service


You must stop the Rulerunner Service to do system maintenance and back up your
environment. Also, to upgrade or remove Datacap software, or clear the
Rulerunner Service service memory.

If you try to stop the Rulerunner Service service while it is processing job tasks,
the service completes its current work before it shuts down.

To stop the Rulerunner Service:


1. On the Rulerunner server, in the Start menu select IBM Datacap Services >
Datacap Rulerunner Manager. If the User Account Control window opens,
click Yes.
2. If the Status is Stopped, close the Rulerunner Manager window.
3. If the Status is Running, click Stop.

Enabling Rulerunner processing logs


Rulerunner processing logs can be created on the Rulerunner server that hosts
Rulerunner. Task-specific logs can be created on the Server that hosts Datacap and
the application files.

You must have 10 GB or more of disk space on each server for storing these logs.
Remember to change the level of detail that is written to the logs or to turn them
off when you no longer need them.

To enable Rulerunner processing logs:


1. On Rulerunner server, in the Start menu click IBM Datacap Services >
Rulerunner Manager.
2. If the Status displayed for the Rulerunner Service is Running, click Stop.
3. Click the Rulerunner Login tab.
4. Select the Windows Authentication option, and click Connect.
5. Click the Logging tab.

96 IBM Datacap: System Administration Guide


6. On the Rulerunner Log tab, move the Application Event Log level slider to
Serious and critical.
7. On the Rulerunner Log tab, move the Thread Log level slider to All, then
click Save.
8. Ensure that the Output to folder option is selected. Change or make a note of
the path in the Output to field. This path is where the logs are created and
you need this information later.
9. Change other options as wanted, then click Save.
10. Click the RSS Log tab, move the sliders to All for Level of detail written to
the RRS logs slider and the Severity level of messages logged.
11. Select the Batch Log option. Change other options as wanted, then click Save.
12. Click the Rulerunner Login tab.
13. Click Disconnect.

Important: Complete the following steps to ensure that the Rulerunner


authentication credentials are set properly.
14. When you are using:
v Windows Authentication - Select the Windows Authentication option.
v Datacap Authentication - Select the Datacap Authentication option, enter the
user ID and Password that is used by Rulerunner, the name of the
Rulerunner server as the Station ID.
15. Click Save.
16. Close the Rulerunner Manager window.

Starting the Rulerunner Service


After you set up or change the Rulerunner Service, go to the Rulerunner Manager
and start the Rulerunner service.

Follow this procedure to start the Rulerunner Service.


1. Go to Start > IBM Datacap Services > Datacap Rulerunner Manager. If the
User Account Control window opens, click Yes.
2. If the Status is Stopped, click Start. The Status changes to Running.
3. Close the Rulerunner Manager window.

Viewing Rulerunner processing logs


The Rulerunner processing logs provide information to help identify the cause of
error conditions. The error conditions might include Datacap server connection
failures, inconsistent domain account group names for authentication, or incorrect
database path structures in the Application Manager.

When you enable logging and restart Rulerunner, Rulerunner processes batches
and writes the processing information to the logs. You can view the various
Rulerunner logs to get this information.

To view Rulerunner processing logs:


1. On the Rulerunner server, start Windows Explorer, open the folder in which the
logs were created. The default is C:\Datacap\. The folder is defined by
Rulerunner Manager. Click the Logging - Rulerunner Log tab and select
Output to folder.

Appendix E. Troubleshooting Rulerunner 97


2. Open the Rulerunner.log file in a text editor such as Notepad and look for
errors.
3. Open the Rulerunner thread log files in a text editor. Look for the messages
that begin with EstablishConnection. A successful log would be similar to this
example:
EstablishConnection: Connecting to application [APT].
EstablishConnection: GetServer returned [127.0.0.1].
EstablishConnection: Connecting to TM Server [127.0.0.1:2402].
EstablishConnection: Connecting to Admin DB
[PROVIDER=MSACCESS;DSN=C:\Datacap\APT\APTAdm.mdb;].
EstablishConnection: Connecting to Engine DB
[PROVIDER=MSACCESS;DSN=C:\Datacap\APT\APTEng.mdb;].
EstablishConnection: TM Login [admin station=1].
EstablishConnection: Login successful.
4. Error conditions can include one or more of the following examples:
v If you are connecting to the Datacap Server fails, then the Datacap Server
Service is not responsive or a network failure occurred.
v If you are connecting to the Admin or Engine database of the application
fails, use the Datacap Application Manager. To ensure that the paths to the
databases are correct.
v If Rulerunner fails to log in to the Datacap Server, do the following steps.
– Ensure that the Rulerunner Service is set up properly by reviewing the
Rulerunner related instructions.
– Ensure that the Rulerunner domain account was added to the correct
security group. And, in your Datacap application, a matching group is set
up with a name that ends in the complete domain name (for example,
XYZ.com, not XYZ).
5. On the Server, start Windows Explorer, go to and open the batches folder of the
application. The default folder is C:\Datacap\Application\Batches.
6. Open the taskname_rrs.log in a text editor and look for errors. For example,
open pageid_rrs.log or recognize_rrs.log.
During processing, when Rulerunner fails to run a batch from a particular
application, there is a delay interval before the next attempt.Rulerunner doubles
the delay each time 2 - 64 seconds.

98 IBM Datacap: System Administration Guide


Appendix F. Troubleshooting FastDoc
You might need to troubleshoot problems when you use FastDoc to scan, process,
verify, and export documents.

Some of the common issues that might require troubleshooting include these
issues:
v FastDoc client issues like poor barcode recognition, documents types are not
assigned, and scanners are not displayed.
v FastDoc application issues such as extra data is found in captured data and
index data is not picked up in a zoned field.
v FastDoc client export issues that include errors during the export and SharePoint
Connector upload errors from the Export_rrs.log file.

Barcode recognition is poor


FastDoc is set up to capture the value of any type of barcode. If you cannot
capture barcode values, the barcodes might be blurred or somehow damaged.

When barcode recognition is poor, you can use the Resolution dial on the TWAIN
Scan or ISIS Scan panel to increase the resolution before you begin scanning the
documents. Then, during the Verify process, you redraw the zone around the
barcode.

Attention: When you scan an image with a different DPI, you must create a new
fingerprint. If the barcode type is set to Any, change it to the barcode type that is
used.

You can also reprint the barcodes and apply them to the problem pages or enter
the barcode values manually.

Document type is not automatically assigned


FastDoc does not automatically assign a document type to a document that was set
up by your Administrator. There is something wrong with the fingerprint of that
document.

When you click Fingerprint, the fingerprint ID number is displayed with Add and
Delete options. If the fingerprint is new, zone the fields to save the positions to the
new fingerprint. The new fingerprint is recognized the next time that you run the
task. If the wrong type is matched, click Fingerprint and click New to force the
creation of a new fingerprint. Optionally, you can click Delete to remove the
fingerprint that was matched if it is no longer used.

Scanner is not listed as an option


When you try to select a scanner from the TWAIN Scan Source list, your scanner is
not listed as an available option.

Use the scanner manufacturer instructions and driver software to ensure that your
scanner and scanner driver are installed correctly and that you can use the scanner
to scan documents successfully outside of FastDoc.

© Copyright IBM Corp. 2014 99


Extra data included in captured data
A zone for a field on a particular document is created incorrectly, such as with the
wrong location or the wrong size. Unwanted data can be included in the field
during document processing. For example, the field label or data from the previous
line or the next line might be included in the field.

To correct this problem, click Fingerprint to see the Fingerprint ID of the


document. On the Fingerprint dialog, click Delete to remove the fingerprint. Then,
rescan the document, reassign the Document Type to the document, and re-create
the zones so that unwanted data is not captured.

Index data not picked up automatically in zoned field


A zone for a field on a particular document is created incorrectly, such as in the
wrong location or the wrong size. The index data for the field is not automatically
picked up.

To correct this problem, click Fingerprint to see the Fingerprint ID of the


document. On the Fingerprint dialog, click Delete to remove the fingerprint. Then,
rescan the document, reassign the Document Type to the document, and re-create
the zones so that the index data is correctly included.

Correcting export errors


An error message displays when you export images from FastDoc.

The following error message displays during export:


There was a problem exporting batchXYZ.
Some documents may not have been exported.
Check your settings.

You must ensure that your export settings are set up correctly and look in the
Export_rrs.log file of the batch to find any problems.

To correct export settings:


1. Open FastDoc as Administrator, scan a sample of the Document Type that you
are having problems with, and click Next Task.
2. After Recognize completes and the Verify panel is displayed with the image
displayed in the Active Image pane, click Document Type Settings and ensure
that your export settings are correctly set up.
3. Open the batch folder and the Export_rrs.log file, and search for lines that
contain the words error or abort. The surrounding lines contain information
about the error condition.
4. When you export to SharePoint, see the following topics when the error is
related to uploading to SharePoint:
v SharePoint upload results in Could not check in file error in export_rrs.log
v SharePoint upload results in Could not find list error in export_rrs.log
v SharePoint upload results in Could not update properties error in
export_rrs.log
5. When you export to IBM FileNet Content Manager, verify the following export
settings, make corrections where needed, and rerun the export.
v The URL of the Content Manager into which you want to export documents

100 IBM Datacap: System Administration Guide


v The Object Store and Document Class on the Content Manager
v The folder on the Content Manager where you want to store the documents

SharePoint upload returns file check-in error in Export_rrs.log


The required columns in a SharePoint library do not include default values.
FastDoc can upload the first document in the batch and update the properties for
that document. But FastDoc cannot complete the SharePoint check-in process for
the first document.

This problem results in a checked-out SharePoint document that only the FastDoc
user can see. Other SharePoint users cannot see the document.

In addition, FastDoc is unable to continue processing the remaining documents


from the same batch. Those documents were not uploaded to SharePoint at all.

When you get this error, ask your SharePoint Administrator to edit the Document
Library Settings for each required column. Add a default value for each, for
example, No Value Available. Then, delete the document that was uploaded but
not checked in.

After the SharePoint Administrator changes Document Library Settings for each
required column, reprocess the entire batch of documents by using the FastDoc
Client.

SharePoint upload returns a list not found error in Export_rrs.log


The SharePoint Administrator who created a library, then later changed the name
that is displayed to users. You used the display name when you set up your export
to SharePoint Document Type Settings, the upload to SharePoint fails.

The SharePoint site URL must reflect the original name, not the name that is
displayed to users. Obtain the original name from your SharePoint Administrator
and change the URL in FastDoc.

SharePoint upload returns a properties update error in Export_rrs.log


The characteristics of the index values passed by FastDoc to SharePoint must
match the characteristics of the SharePoint columns.

If the index values are not set up properly in FastDoc, they are rejected by
SharePoint. The Could not update Properties error can occur for a number of
reasons, and the error message provides information for the error. For example, if
you passed an index value to a SharePoint Date column without identifying it as a
Date in FastDoc.
Error code: ’0x8102001c’ Invalid date/time value
A date/time field contains invalid data.
Please check the value and try again.

Appendix F. Troubleshooting FastDoc 101


102 IBM Datacap: System Administration Guide
Appendix G. Troubleshooting Datacap web services
If the file upload fails on large files or the PUT request method endpoints are not
working, you can check to ensure that your configurations are correct.

The file upload fails for SetFile or UploadFile

If the file upload fails on large files when you are using the POST methods
SetFile or UploadFile, check that maxAllowedContentLength and maxRequestLength
are configured correctly. You can adjust the value of the maxAllowedContentLength
and maxRequestLength settings in the web.config file. The maximum size message
that can be uploaded depends on your web server, proxy server, and client.

The PUT request method GrabBatch, ReleaseBatch, or


SetPageFileName does not work

If the PUT request method GrabBatch, ReleaseBatch, or SetPageFileName is not


working, ensure that the WebDAV Publishing role service is not installed and that
the PUT request method is allowed. The WebDAV Publishing role service
prevents the Datacap Web Services PUT method from functioning. You can verify in
the Server Manager that the WebDAV Publishing role service is not installed.
v In the Start menu on the web server, select IBM Datacap Services > Datacap
Server Manager.
v In the Server Manager hierarchy pane, expand Roles and select Web Server
(IIS).
v In the Web Server (IIS) pane, expand Role Services. Under Common HTTP
Features, ensure that the WebDAV Publishing role service is not installed.
Related information:
Verifying that IIS components are installed
Datacap Web Services REST API methods

© Copyright IBM Corp. 2014 103


104 IBM Datacap: System Administration Guide
Appendix H. Log files
To obtain adequate logging information for troubleshooting purposes, you must
enable logging for the client and for the Rulerunner Service.

Adequate logging includes information about a client, such as Datacap Desktop


and the Rulerunner Service, which applies rules to an action that a task requires.
Maximum logging can be enabled all of the time for a test or development system.
However, because maximum logging negatively impacts system performance, you
can set the logging to the minimum level on a production server.
Related information:
Set Rulerunner logging by application and task

Enabling logging for Datacap Desktop


To enable logging for Datacap Desktop, you must edit the dcDesktop.exe.config
file and enable logging for Rulerunner Service. To confirm that logging is
functional, complete an action in Datacap Desktop and review the Rulerunner
Service RRS.log file and the dcdesktop.log file.

Although there are different levels of logging, these steps enable maximum logging
to troubleshoot Datacap Desktop when problems occur.

To enable logging for Datacap Desktop:


1. Enable executable file logging.
a. Go to the \Datacap\DcDesktop folder and open the dcDesktop.exe.config
file.
b. In the User Settings section, enter these values.
v WriteLog = True
v LogSeverity = 5
v LogPath = dcdesktop.log
v LogOverwrite = True
v LogFlushBuffer = True
v LogShowTime = True
c. Save the file.
2. Enable Rulerunner Service logging.
a. Start Datacap Web Client and log in to the application that is to be run, and
select the Administrator tab.
b. Expand the Workflow, highlight the task for which logging is needed, and
click Setup.
c. In the Rulerunner Service log settings section, under Rulerunner settings,
set the Rulerunner service log field to 5 and select the Flush Buffer check
box.

Note: Selecting the Flush Buffer option slows down the process because
every line that is logged is written to the log file on disk, instead of being
buffered in memory.
d. Scroll to the end of Webpage Dialog and click Save.

© Copyright IBM Corp. 2014 105


3. Start Datacap Desktop and start a task for which logging information is
needed. Two log files are generated:
v The X_rrs.log, where X is the name of the task. The file is in the batch
folder of the application (for example, C:\datacap\TravelDocs\batches\
20130924.00001\pageid_rrs.log), and contains information about actions that
are completed by the Rulerunner engine.
v The dcdesktop.log.Y file, where Y is the log sequence number. This file is in
the \Users\username\AppData\Local\IBM\IBM Datacap\9.0.0.0 folder, and
contains information about the Datacap Desktop executable file.

Disable Datacap Desktop Rulerunner logging by setting WriteLog = False in the


dcDesktop.exe.config file. You cannot completely disable the Datacap Desktop
executable file logging, but you can create minimum logging by setting
Rulerunner service log, Batch log, and Action log level to 0. Be sure to clear the
Flush Buffer check box to avoid reduced performance.

Enabling logging for FastDoc


To enable logging for FastDoc, you must edit the FastDoc.exe.config file and
enable logging for Rulerunner Service. To confirm that logging is functional,
complete an action in FastDoc and review the RRS.log file and the FastDoc.log
file.

Although there are different levels of logging, these steps enable maximum logging
to troubleshoot FastDoc when problems occur.

To enable logging forFastDoc:


1. Enable executable file logging.
a. Go to the \Datacap\FastDoc folder and open the FastDoc.exe.config file.
b. In the User Settings section, set Log = True and save the file.
2. If you are running FastDoc in Local Mode, enable logging for the Rulerunner
Service by completing these steps.
a. Go to the \Datacap\FastDoc folder and open the BatchProfiles.xml file.
b. Locate the rrslog tag that is specific to the task for which logging is needed
and set ServiceLog=”5”.
c. Save the BatchProfiles.xml file.
3. If you are running FastDoc in Datacap Mode, enable logging for the Rulerunner
Service by completing these steps.
a. In the Rulerunner Service log settings for the workflow task in your web
client administration panel, set the Rulerunner service log field to 5 and
select the Flush Buffer check box.

Note: Selecting the Flush Buffer option slows down the process because
every line that is logged is written to the log file on disk, instead of being
buffered in memory.
4. Start FastDoc and start a task for which logging information is needed. Two log
files are generated:
v The X_rrs.log, where X is the name of the task. The file is in the batch
folder of the application (for example, C:\datacap\TravelDocs\batches\
20130924.00001\pageid_rrs.log), and contains information about actions that
are completed by the Rulerunner engine.

106 IBM Datacap: System Administration Guide


v The FastDoc.log. This file is in the \Users\username\AppData\Local\IBM\IBM
Datacap\9.0.0.xx folder, and contains information about the FastDoc
executable file.

Disable the FastDoc executable file logging by setting Log = False in the
FastDoc.exe.config file. You cannot completely disable the FastDoc Rulerunner
logging, but you can create minimum logging by setting Rulerunner service log,
Batch log, and Action log level to 0. Be sure to clear the Flush Buffer check box to
avoid reduced performance.

Enabling logging for Rulerunner Service


To enable logging for Rulerunner Service, you must configure the logging options
in Rulerunner Manager. To confirm that logging is functional, complete a task
where rules are applied, and review the rulerunner.log file,
therulerunner_thread_atm.log file, and the task_rrs.log file.

Although there are different levels of logging, these steps enable maximum logging
to troubleshoot Rulerunner Service when problems occur.

To enable logging for Rulerunner Service:


1. Start Rulerunner Manager.
2. Click the Rulerunner Login tab.
3. Enter the login information, as needed, and click Connect.
4. Click the Logging tab, and then select Quick Log at the end of the page.
5. Move the slider to Debug.
6. Click Save.
7. On the Rulerunner Login tab, click Disconnect, and exit from Rulerunner
Manager.
8. Complete a task for which logging information is needed. These log files are
generated:
v The RulerunnerX.log, where X is the thread. The default location of the file
is C:\datacap, and contains general logging information for the Rulerunner
process.
v The Rulerunner_thread_X_atmY.log, where X is the name of the task and Y is
the log sequence number. The default location of the file is C:\datacap, and
contains detailed logging information for the Rulerunner process.
v The Z_rrs.log, where Z is the name of the task. The file is in the batch folder
of the application (for example, C:\datacap\TravelDocs\batches\
20130924.00001\pageid_rrs.log), and contains information about actions that
are completed by the Rulerunner engine.

Tip: You do not need to restart the Rulerunner Service after you save the
logging configuration settings. The service automatically retrieves the
changes after all of the pending tasks are completed. However, you can
restart the service to immediately implement the changes.

The Rulerunner Service uses managed logging for all of the log files except
the rrs log file. When the log files are full, Rulerunner deletes the oldest file
and creates a new file. Managed logging provides the option of keeping
logging enabled without using excessive hard disk space.

Appendix H. Log files 107


Enabling logging for Datacap Server service
To enable logging for Datacap Server service, you must configure the logging
options in the Datacap Server Manager. To confirm that logging is functional,
complete a task in a workflow and review the tms.log file.

Although there are different levels of logging, these steps enable maximum logging
to troubleshoot Datacap Server service when problems occur.

To enable logging for Datacap Server service:


1. Start Datacap Server Manager.
2. Click the Logging tab, and then click the Datacap log tab.
3. Move the slider to All and select the Output to file check box.
4. Click Save and exit from Datacap Server Manager.
5. Complete a task in a workflow for which logging information is needed.
Datacap Server Manager generates 1 - 5 log files with the name tms.log.X.log,
where X is the log number. The location of the log files is in the Datacap
installation directory. (The default is C:\datacap.)

Tip: You do not need to restart the Datacap Server service after you save the
logging configuration settings. The service automatically retrieves the changes
after a few seconds.

The Datacap Server service uses managed logging. After the log files are full,
Datacap deletes the oldest file and creates a new file. Managed logging
provides the option of keeping logging enabled without using excessive hard
disk space.

Enabling logging for the Datacap Web Client


To enable logging for Datacap Web Client, you must edit the server.ini file. To
confirm that logging is functional, complete a task in Datacap Web Client and
review the tmweb.log file and the pacuerr.log file.

Although there are different levels of logging, these steps enable maximum logging
to troubleshoot Datacap Web Client when problems occur.

To enable logging for Datacap Web Client:


1. Go to the \Datacap\tmweb.net folder and open the server.ini file.
2. In the [General] section, set WriteLog = 1.
3. In the [Log] section, enter these values.
v Path = C:\Datacap\TaskRun\tmweb.log (or other valid path and file name).
v Overwrite = 1
v ShowTime = 1
v FlushBuffer = 1
4. Save the server.ini file.
5. Restart IIS.
6. Start Datacap Web Client, log in to the application for which logging
information is required, and complete a task in a workflow. Two log files are
generated.

108 IBM Datacap: System Administration Guide


v tmweb.log.X.log, where X is the log sequence number. The file is in the
C:\Datacap\TaskRun folder, or the folder that was specified in the Path
configuration setting.
v Datacap Web Client also contains an error log that is always enabled. If the
web page itself encounters an error and times out, Datacap generates a file
that is called pacuerr.log, which is in the C:\Datacap\tmweb.net\App_Data
folder.

Disable Datacap Web Client logging by setting WriteLog = 0 in the server.ini file
and restarting IIS.

Enabling the Datacap Web Services log


When you enable logging for Datacap Web Services in the c:\Datacap\wtm\
web.config file, the wTM and aTM logs are created.

Enable logging for Datacap Web Services.


1. Navigate to the c:\Datacap\wtm folder and open the web.config file.
2. In the <IBM.Datacap.Web.Properties.Settings> section, set logEnable to True.
Enter the other settings values, including the logPath and the logSeverity
settings. You can control the level of detail that is written to the log by entering
one of the following values in the logSeverity setting.
0 - No messages are logged
1-3 - Logs warnings and exceptions
4-6 - Logs information, warnings, and exceptions
7-9 - Logs the maximum amount of detail
<setting name="logSeverity" serializeAs="String">
<value>4</value>
</setting>
<setting name="logOverwrite" serializeAs="String">
<value>False</value>
</setting>
<setting name="logPath" serializeAs="String">
<value>c:\</value>
</setting>
<setting name="logTime" serializeAs="String">
<value>True</value>
</setting>
<setting name="logFlushBuffer" serializeAs="String">
<value>True</value>
</setting>
<setting name="logEnable" serializeAs="String">
<value>True</value>
</setting>

Appendix H. Log files 109


110 IBM Datacap: System Administration Guide
Appendix I. Troubleshooting and support
When you experience problems, you might need to perform troubleshooting tasks
to determine the corrective action to take.

© Copyright IBM Corp. 2014 111


112 IBM Datacap: System Administration Guide
Notices
This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing


IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property Licensing


Legal and Intellectual Property Law
IBM Japan Ltd.
1623-14, Shimotsuruma, Yamato-shi
Kanagawa 242-8502 Japan

The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or
implied warranties in certain transactions, therefore, this statement may not apply
to you.

This information could include technical inaccuracies or typographical errors.


Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.

© Copyright IBM Corp. 2014 113


IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:

IBM Corporation
J46A/G4
555 Bailey Avenue
San Jose, CA 95141-1003
U.S.A.

Such information may be available, subject to appropriate terms and conditions,


including in some cases, payment of a fee.

The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.

This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.

Any performance data contained herein was determined in a controlled


environment. Therefore, the results obtained in other operating environments may
vary significantly. Some measurements may have been made on development-level
systems and there is no guarantee that these measurements will be the same on
generally available systems. Furthermore, some measurements may have been
estimated through extrapolation. Actual results may vary. Users of this document
should verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers of


those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.

All statements regarding IBM's future direction or intent are subject to change or
withdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which


illustrate programming techniques on various operating platforms. You may copy,

114 IBM Datacap: System Administration Guide


modify, and distribute these sample programs in any form without payment to
IBM, for the purposes of developing, using, marketing or distributing application
programs conforming to the application programming interface for the operating
platform for which the sample programs are written. These examples have not
been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or
imply reliability, serviceability, or function of these programs.

Trademarks
The following terms are trademarks of the International Business Machines
Corporation in the United States, other countries, or both: http://www.ibm.com/
legal/copytrade.shtml

Microsoft, Windows, Windows NT, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.

Java and all Java-based trademarks and logos are trademarks or registered
trademarks of Oracle and/or its affiliates.

Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered
trademarks or trademarks of Adobe Systems Incorporated in the United States,
and/or other countries.

Linux is a registered trademark of Linus Torvalds in the United States, other


countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other
countries.

Other product and service names might be trademarks of IBM or other companies.

Privacy policy considerations


IBM Software products, including software as a service solutions, (“Software
Offerings”) may use cookies or other technologies to collect product usage
information, to help improve the end user experience, to tailor interactions with
the end user or for other purposes. In many cases no personally identifiable
information is collected by the Software Offerings. Some of our Software Offerings
can help enable you to collect personally identifiable information. If this Software
Offering uses cookies to collect personally identifiable information, specific
information about this offering’s use of cookies is set forth below.

The Software Offering uses session and persistent cookies that collect each user's
user name, for purposes of session management, enhanced user usability, single
sign-on configuration. Session cookies cannot be disabled. Persistent cookies can be
disabled, but disabling them will also eliminate the functionality they enable.

If the configurations deployed for this Software Offering provide you as customer
the ability to collect personally identifiable information from end users via cookies
and other technologies, you should seek your own legal advice about any laws
applicable to such data collection, including any requirements for notice and
consent.

For more information about the use of various technologies, including cookies, for
these purposes, See IBM’s Privacy Policy at http://www.ibm.com/privacy and
IBM’s Online Privacy Statement at http://www.ibm.com/privacy/details the

Notices 115
section entitled “Cookies, Web Beacons and Other Technologies” and the “IBM
Software Products and Software-as-a-Service Privacy Statement” at
http://www.ibm.com/software/info/product-privacy.

116 IBM Datacap: System Administration Guide


Index
A batches
creating on FastDoc
databases (continued)
configuring
accessibility with a scanner 68 DB2 1
documentation 17 with pre-scanned images 67 Oracle 1
keyboard shortcuts 17 indexing on FastDoc 69 SQL Server 1
screen readers, compatible 17 monitoring 15, 17 creating 4
administration opening on FastDoc 67 creating a single Oracle user 5
Datacap Navigator 15 status 15, 17 Datacap Application Copy Tool 22
Administration verifying on FastDoc 69 migrating 25, 31
Datacap Navigator 10 migrating to a new provider 31
Datacap Web Client 10 migration options 26
AdministrationDatacap Fingerprint
Maintenance Tool C moving 22
moving to a new environment 28, 31
Datacap Navigator 9, 39 Classify
security permissions 3
Datacap Web Client 9, 39 Datacap Navigator 17
updating in existing
FastDoc management 9, 39 cleaning images 49, 53
environments 29
Mobile access 9, 39 command line options
upgrading 22, 25, 31
Web client recycle schedule 9, 39 cloning applications 25
user interface 31
application configuration migrating applications 25
databasesDatacap Application Copy Tool
FastDoc 45 updating applications 25
connection strings 24
Datacap Server mode 60 configuration
Datacap
application files mobile 9
restarting 37
moving 6 configuration databases
stopping 37
renaming 6 DB2 1
Datacap Application Copy Tool
applications Oracle databases 1
changing database providers 30
command line options 25 SQL Server databases 1
command line interface 25
configuring databases configure
connection strings 24
DB2 2 Fingerprint Maintenance Tool 83
migrating databases 31
Oracle 2 connection strings
moving applications 22, 28
SQL Server 2 advanced settings 7
moving databases 22
connection strings 24 database 7
updating applications 22, 29
Datacap create databases
updating databases 22
creating 46, 47 DB2 4
user interface 31
from a template 46 Oracle 4
Datacap applications
in Application Wizard 47 Oracle users 5
creating
Datacap Application Copy Tool 22 SQL Server 4
from a template 46
migrating 24, 25, 31 create task 39
in Application Wizard 47
migration options 26 Creating a custom column
Datacap Desktop 39, 42
moving 22 Job Monitor 14
Configuring applications to use 39
moving to a new environment 28 Enable logging for
updating in an existing troubleshooting 105
environment 29 D Run tasks 40
upgrading 22, 24, 25, 31 daily statistics Scanning hardcopy pages 41
user interface 31 viewing on FastDoc 76 Datacap Navigator
authentication database administration 15
troubleshooting 93 advanced settings 7 Administration 10
automatic updates for fixes 89 connection strings 7 Classify 17
database connections Configure groups and users 9, 39
testing 7 Configure shortcuts 9, 39
B verifying 7 Job Monitor 9, 15, 39
batch maintenance database providers Keyboard shortcuts 21
FastDoc 75 changing in Datacap Application Manage workflow tasks 9, 39
batch processing Copy Tool 30 Recycle schedule 9, 39
IIS application pool recycle 14 database security permissions Scan 16
batch profile configuration assigning 3 Shortcuts administration 12
FastDoc database structures Task List 17
Local mode 58 creating a single Oracle user 5 Upload 17
Batch queuing to users and stations defining 4 user settings 15
Datacap Navigator 12 databases Users, groups, stations
Datacap Web Client 12 changing database providers 30 administration 10
command line options 25

© Copyright IBM Corp. 2014 117


Datacap Navigator (continued)
Workflows, jobs, and tasks
E FastDoc (continued)
running 45
administration 11 Enable logging for troubleshooting running in Datacap Server mode 70
Datacap Server Datacap Desktop 105 running in Local mode 66
advanced database settings 7 Datacap Server service 108 scanning pre-scanned images 76
Datacap Server mode Datacap Web Client 108 setting up a scanner 58
FastDoc 45 Datacap Web Services 109 setting up documents 48, 56
configuring applications 45, 60 FastDoc 106 setting up fields 53
configuring rulesets 60 Rulerunner Service 107 starting up 46
runningFastDoc 70 encryption keys testing settings 63
starting up FastDoc 46 troubleshooting import failure 93 troubleshooting 99
Datacap Server service export ruleset configuration barcode recognition is poor 99
Enable logging for FastDoc 55 document type is not automatically
troubleshooting 108 Export to Folderdata file format 56 assigned 99
Datacap Web Client exported data file 56 error during export 100
Administration 10 extra data included in captured
Batch queuing to users and data 100
stations 12 F index data not picked up in zoned
Configure groups and users 9, 39 FastDoc field 100
Configure shortcuts 9, 39 backing up applications 45 scanner is not listed 99
Datacap Navigator 11 capturing index data 65 SharePoint upload 101
Enable logging for configuring 54 using Click N Key 65
troubleshooting 108 configuring documents 52 using the Forms template 48, 52
Job Monitor 9, 11, 39 configuring export rulesets 55 using the Learning template 53, 54
Manage workflow tasks 9, 39 configuring rulesets 61 verifying batches 69
Recycle schedule 9, 39 confirming exports 56 FastDoc viewing daily statistics 76
Shortcuts administration 12 creating batches fields
Users, groups, stations with a scanner 68 setting up on a Learning template 53
administration 10 with pre-scanned images 67 file maintenance
Workflows, jobs, and tasks creating fingerprints 49 FastDoc 75
administration 11 Datacap Server mode 45, 46 Fingerprint Maintenance Tool
Datacap web services configuring applications 45, 60 adding fingerprints 78
Troubleshooting configuring rulesets 60 buttons 84
GrabBatch 103 defining index field populations configuration 83
ReleaseBatch 103 using a database 65 deleting fingerprints 77
SetFile 103 defining index field validations associated with document
SetPageFileName 103 using a database 65 types 78
UploadFile 103 defining index fields deleting partial fingerprints 77
Datacap Web Services using keywords 64 exporting fingerprints 78
Enable logging for deleting batches 75 fields 84
troubleshooting 109 deleting fingerprints 49 maintaining fingerprints 77
DB2 databases deleting pages 73 reference 83
configuring 1 determining file names 76 Settings.ini 83
configuring applications for 2 displaying documents 73 starting 77
creating 4 Enable logging for troubleshooting 79
security permissions 3 troubleshooting 106 backup directory 79
testing the connection 7 exported data file format 56 FMT.log file 79
define exporting images 56 using 77
database structures 4 Forms template configuration 48 fingerprints
Oracle single users 5 indexing batches 69 adding 78
document indexing keyboard shortcuts 81 creating on FastDoc 49, 63
preparing for FastDoc 57 Learning template configuration 52 deleting 77
document processing Local mode 45, 46 deleting on FastDoc 49
Forms template 70 configuring applications 45 exporting 78
document scanning setting up batch profiles 58 maintaining 77
preparing for FastDoc 57 maintaining files 75 starting the Fingerprint Maintenance
document settings opening batches 67 Tool 77
testing 63 organizing pages in a document 73 storing 77
documents preparing 45 synchronizing 77
configuring on FastDoc 52, 54 preparing documents for Fix Central
configuring rulesets on FastDoc 61 scanning 66 getting fixes with 90
configuring rulesets onFastDoc 61 preparing for fixes
preparing for scanning 66 indexing 57 getting
processing on FastDoc 66 scanning 57 Fix Central 90
processing on the Learning template processing documents 66 Forms template
with pre-scanned images 72 purging batches 75 cleaning images 49
setting up on FastDoc 48, 56 rapid application development 45

118 IBM Datacap: System Administration Guide


Forms template (continued)
configuring documents on
Keyboard shortcuts
Datacap Navigator 21
R
FastDoc 52 knowledge bases rapid application development
configuring on FastDoc 48 searching for troubleshooting FastDoc 45
processing documents 70 solutions 89 recognition
setting up documents on FastDoc 48 setting up on the Forms template 51
setting up field recognition 51 setting up on the Learning
template 54
setting up field validation 51 L reference
Learning template Fingerprint Maintenance Tool 83
cleaning images 53 RSS feeds
I configuring on FastDoc 52 troubleshooting 92
IBM Software Support configuringFastDoc 54 Rulerunner
contacting 90 processing documents 72 troubleshooting 95
IBM Support setting up field recognition 54 enabling Rulerunner processing
troubleshooting setting up field validation 54 logging 96
subscribing for updates 92 setting up fields on FastDoc 53 first things to check 95
IBM Support Assistant (ISA) 89 Local mode starting the Rulerunner
IBM System Dashboard for Enterprise FastDoc 45 Service 97
Content Management 32 configuring applications 45 stopping the Rulerunner
IIS application pool recycle setting up batch profiles 58 Service 96
batch processing 14 runningFastDoc 66 viewing Windows Event Viewer
Datacap Web Client 14 starting up FastDoc 46 logs 95
image enhancement log files 105 viewingRulerunner processing
cleaning images 49, 53 logs 97
running on the Forms template 49 Rulerunner Service
running on the Learning template 53
image exports
M Enable logging for
migration troubleshooting 107
confirming 56 ruleset configuration
applications 24
images FastDoc
databases 24
confirming exports 56 Datacap Server mode 60
migration options
import Run tasks
applications 26
encryption keys 93 Datacap Desktop 40
databases 26
troubleshooting 93
mobile
index data
configuring 9
capturing on FastDoc 65
confirming exports 56
move S
applications 22 Scan
using Click N Key 65
databases 22 Datacap Navigator 16
index data exports
confirming 56 scan task 39
index field populations scanner setup
defining with a database 65 N FastDoc 58
index field validations navigating 81 Scanning hardcopy pages
defining with a database 65 Datacap Desktop 41
index fields scans
verify task 16
configuring rulesets on FastDoc 61
defining
O verifying 16
Oracle databases security
using keywords 64
configuring 1 troubleshooting 93
ISIS scanner
configuring applications for 2 troubleshooting encryption failure 93
Set document separator 42
creating 4 security permissions
ISIS scanner setup
creating single users 5 databases
FastDoc 58
security permissions 3 DB2 3
testing the connection 7 Oracle 3
SQL Server 3
J session timeout
Job Monitor
Creating a custom column 14
P adjusting 17
page management Set document separator
Datacap Navigator 11, 15 ISIS scanner 42
on FastDoc 73
Datacap Web Client 11 settings
partial fingerprints
deleting 77 Datacap Navigator 15
passwords Settings.ini 83
K troubleshooting encryption failure 93 Shortcuts administration
keyboard problem determination Datacap Navigator 12
shortcuts 17 searching knowledge bases 89 Datacap Web Client 12
keyboard shortcuts SQL Server databases
FastDoc 81 configuring 1
configuring applications for 2

Index 119
SQL Server databases (continued) Troubleshooting (continued)
creating 4 Enable logging (continued)
security permissions 3 Datacap Web Client 108
testing the connection 7 Datacap Web Services 109
support 113 FastDoc 106
support tools Rulerunner Service 107
IBM Support Assistant (ISA) 89 TWAIN scanner setup
system performance FastDoc 58
monitoring 32

U
T update
task applications 22, 24
configuring 39 databases 22, 24
creating 39 updates
Task List subscribing
Datacap Navigator 17 troubleshooting 92
test Upload
database connections 7 Datacap Navigator 17
troubleshooting 113 user interface
authentication 93 cloning applications 31
contacting IBM Software Support 90 migrating applications 31
encryption failure 93 updating applications 31
encryption keys 93 user settings
FastDoc 99 Datacap Navigator 15
barcode recognition is poor 99
document type is not automatically
assigned 99
error during export 100
V
validation
extra data included in captured
setting up on the Forms template 51
data 100
setting up on the Learning
index data not picked up in zoned
template 54
field 100
verification
scanner is not listed 99
scans 16
SharePoint upload 101
verify
Fingerprint Maintenance Tool 79
database connections 7
backup directory 79
FMT.log file 79
getting fixes
Fix Central 90 W
import failure 93 Workflow administration
log files 105 Datacap Navigator 11
Rulerunner 95 Datacap Web Client 11
enabling Rulerunner processing Workflow, jobs, and tasks administration
logging 96 Datacap Navigator 11
first things to check 95 Workflows, jobs, and tasks administration
starting the Rulerunner Datacap Web Client 11
Service 97
stopping the Rulerunner
Service 96
viewing Windows Event Viewer
logs 95
viewingRulerunner processing
logs 97
searching knowledge bases 89
security 93
subscribing to support 92
Troubleshooting
Datacap Web Services
GrabBatch 103
ReleaseBatch 103
SetFile 103
SetPageFileName 103
UploadFile 103
Enable logging
Datacap Desktop 105
Datacap Server service 108

120 IBM Datacap: System Administration Guide




Product Number: 5725-C15

SC27-6372-00

S-ar putea să vă placă și