Documente Academic
Documente Profesional
Documente Cultură
Version 9
SC27-6372-00
IBM Datacap
Version 9
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
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.
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/.
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
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.
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.
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.
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
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.
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.
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.
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
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
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
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.
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.
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.
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.
The following features are available for keyboard input and navigation:
Keyboard input
You can use the keyboard instead of a mouse to operate Datacap
You can use the keyboard to access all of the functions of Datacap Navigator.
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
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.
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;
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.
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.
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.
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
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
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.
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)
In the Administration database, the audit table and Engine database table are
cleared.
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
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.
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.
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.
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
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 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
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.
In the dashboard, you can monitor the Datacap Server events. All time-related
counters are in nanoseconds.
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
Important: Rulerunner threads are actually separate processes. The initial node
Thread0 is a historical artifact and can be ignored.
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.
In the dashboard, you can monitor the Datacap Web Client events. All time-related
counters are in nanoseconds.
Related information:
IBM FileNet P8 system overview
IBM System Dashboard for Enterprise Content Management Users Guide
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 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.
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.
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.
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.
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.
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.
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.
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
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
In Datacap Server mode, FastDoc can use the Datacap Server to further develop
the application by using Datacap Studio and Application Manager.
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.
If you are using a scanner, start your scanner before you start FastDoc.
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.
You can configure the Datacap application that you create to scan, index, and
export batches of documents to repositories, file systems, and Datacap Server.
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
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.
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.
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.
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.
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.
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.
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
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
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.
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”
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.
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
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.
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
You use the Datacap Web Client Administrator or Datacap Navigator to configure
your applications to run on the FastDoc client in Datacap Server mode.
You configure rulesets to run on the batches, documents, pages, and fields that are
in the application in Datacap Server mode.
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.
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.
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
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.
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
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.
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)
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
The instructions for using a scanner to download documents into FastDoc are
different from using pre-scanned images.
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
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.
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
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.
Rulesets that do not display an ellipse next to their name in the Workflow Editor
must be configured in Datacap Studio by using actions.
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.
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 files does not affect the exported image or TXT files and purging
periodically is a good idea to free up disk space.
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.
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
The first time the Fingerprint Maintenance Tool is run, a message is displayed
indicating a backup directory is created.
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.
FMT.Log
This log contains processing details that identify the changes that are made and
attempted by the Fingerprint Maintenance Tool.
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+Up or Downarrows
CTRL+Home
CTRL+Plus
Zoom out to shrink the image shrinks Double-click image with left mouse button
CTRL+End
CTRL+"_/-" key
CTRL+Minus
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
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
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.
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?
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
Responding to these types of questions can give you a frame of reference in which
to investigate the problem.
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.
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
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:
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
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
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.
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
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
This problem results in a checked-out SharePoint document that only the FastDoc
user can see. Other SharePoint users cannot see the document.
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.
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.
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.
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.
Although there are different levels of logging, these steps enable maximum logging
to troubleshoot Datacap Desktop when problems occur.
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.
Although there are different levels of logging, these steps enable maximum logging
to troubleshoot FastDoc when problems occur.
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.
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.
Although there are different levels of logging, these steps enable maximum logging
to troubleshoot Rulerunner Service when problems occur.
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.
Although there are different levels of logging, these steps enable maximum logging
to troubleshoot Datacap Server service when problems occur.
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.
Although there are different levels of logging, these steps enable maximum logging
to troubleshoot Datacap Web Client when problems occur.
Disable Datacap Web Client logging by setting WriteLog = 0 in the server.ini file
and restarting IIS.
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:
For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:
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.
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.
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.
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.
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:
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.
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.
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.
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
SC27-6372-00