Kofax INDICIUS 6.1 User Manual
INDICIUS 6.
INDICIUS 6.INDICIUS 6.
INDICIUS 6.
1111
Capture
CaptureCapture
Capture
for K
for Kofax
for Kfor K
ofax
ofaxofax
Installation Guide
March 06, 2012
2006-2011 Kofax, Inc., 16245 Laguna Canyon Road, Irvine, California 92618, U.S.A.
All rights reserved. Portions, copyright 1997-2006 Kofax Development UK Ltd. All
Rights Reserved. Use is subject to license terms.
Third-party software is copyrighted and licensed from Kofax’s suppliers.
This product is protected by U.S. Patent No. 5,159,667.
THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE
SECRETS OF KOFAX, INC. USE, DISCLOSURE OR REPRODUCTION IS
PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF
KOFAX, INC.
Kofax, the Kofax logo, INDICIUS, Ascent Capture, Kofax Capture, VirtualReScan, the
“VRS VirtualReScan” logo, and VRS are trademarks or registered trademarks of
Kofax, Inc. in the U.S. and other countries. All other trademarks are the trademarks
or registered trademarks of their respective owners.
U.S. Government Rights Commercial software. Government users are subject to the
Kofax, Inc. standard license agreement and applicable provisions of the FAR and its
supplements.
You agree that you do not intend to and will not, directly or indirectly, export or
transmit the Software or related documentation and technical data to any country to
which such export or transmission is restricted by any applicable U.S. regulation or
statute, without the prior written consent, if required, of the Bureau of Export
Administration of the U.S. Department of Commerce, or such other governmental
entity as may have jurisdiction over such export or transmission. You represent and
warrant that you are not located in, under the control of, or a national or resident of
any such country.
DOCUMENTATION IS PROVIDED “AS IS” AND ALL EXPRESS OR IMPLIED
CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY
IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE
EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.
Contents
How to Use This Guide .......................................................................................................... vii
Introduction .......................................................................................................................... vii
Related Documentation ...................................................................................................... viii
User's Guide (.pdf) ....................................................................................................... viii
Getting Started Guides ................................................................................................ viii
Getting Started (Fixed-Form) (.pdf) .................................................................... viii
Getting Started Guide (Free-Form) (.pdf) ............................................................ ix
Getting Started Guide (Classification and Separation) (.pdf) ........................... ix
INDICIUS Help ............................................................................................................... x
Visual Basic Scripting Help (.chm) ............................................................................... x
Overview ................................................................................................................................... 1
Introduction ............................................................................................................................ 1
How is INDICIUS Installed? ................................................................................................. 1
Completing Setup of a Solution ............................................................................................ 2
System Requirements ............................................................................................................. 3
Introduction ............................................................................................................................ 3
Hardware/Software Requirements ..................................................................................... 3
All Computers ................................................................................................................. 3
Multi-Core Processors for INDICIUS Recognition .............................................. 3
Development/Demonstration Computers .................................................................. 4
Production Unattended Computers: Recognition, Scripted Export ......................... 4
Production Attended Computers: Document Review, Correction, Completion,
Verification, Stats Reporter ............................................................................................ 5
User Account Control .............................................................................................. 5
Error/Status Messages ............................................................................................ 6
Installation Guide
iii
Compatibility with other Kofax Products ........................................................................... 7
Introduction ...................................................................................................................... 7
Kofax Capture Features .................................................................................................. 7
Supported Features .................................................................................................. 7
Unsupported Features ........................................................................................... 11
Support for High Availability Features ...................................................................... 13
Automatic Batch Recovery/Rollback .................................................................. 13
Backup License Servers .......................................................................................... 13
Database and File System Retries ......................................................................... 13
Enhanced SQL Server Support ............................................................................. 13
Operating INDICIUS in High Availability Environments ................................ 13
File/Folder Access Requirements ....................................................................................... 14
Licensing ................................................................................................................................ 15
Introduction ........................................................................................................................... 15
Licensed Applications .......................................................................................................... 15
Kofax Capture Evaluation Licenses .................................................................................... 16
Kofax Capture Temporary Licenses ................................................................................... 16
Installation .............................................................................................................................. 17
Introduction ........................................................................................................................... 17
Installing INDICIUS ............................................................................................................. 18
Standard Installation ..................................................................................................... 18
Custom Module Registration ....................................................................................... 18
Creating Additional Instances of INDICIUS Modules .................................................... 19
Upgrade Instructions ............................................................................................................ 19
6.0 or 5.5.1 to 6.1 ............................................................................................................. 19
5.5.0 to 6.1 ........................................................................................................................ 20
5.1.x to 6.1 ........................................................................................................................ 20
5.0.x to 6.1 ........................................................................................................................ 21
4.x.x to 6.1 ........................................................................................................................ 22
Installation Configuration .................................................................................................... 23
Introduction .................................................................................................................... 23
Dedicated Applications ................................................................................................. 23
Editing a Shortcut ................................................................................................... 23
Command Line Parameters ................................................................................... 24
Windows Services .......................................................................................................... 26
iv
Installation Guide
Installing a Single Windows Service ................................................................... 26
Installing Multiple Windows Services ................................................................ 32
Uninstalling a Windows Service .......................................................................... 33
Viewing the Installed Service ............................................................................... 34
Basic Service Events ............................................................................................... 34
Starting the Service ................................................................................................ 34
Error Logging ......................................................................................................... 35
Shutdown ................................................................................................................ 35
Networked Resources ............................................................................................ 35
Setting up the Service to use Remote Configuration Files................................ 36
Tracking the Service Status ................................................................................... 36
Installation Guide
v
vi
Installation Guide
Introduction
This guide contains information about installing INDICIUS. It details the system and
licensing requirements, and provides tutorial information for both installing the
software and specifying settings that affect the way the modules run.
This guide assumes that you have a thorough understanding of Windows standards,
applications, and interfaces. It also assumes that you are familiar with Kofax Capture
and have a general understanding of INDICIUS (for example, having read one of the
Getting Started Guides).
How to Use This Guide
This guide is written for those installing INDICIUS, either on a development
computer (where a solution is configured or tested) or on a production computer.
This guide does not cover the steps after installation: configuration of INDICIUS for a
specific solution (or set of documents) or the administration of a solution. For
information on these refer to the INDICIUS Help.
If you are installing INDICIUS for the first time, you should first read the Overview
chapter to gain an overall understanding of INDICIUS and the installation process.
Next read the System Requirements and Licensing chapters to ensure your system
meets the required specification and familiarize yourself with the features provided
by your license.
Finally, follow the instructions in the Installation chapter to install the required
features and set up the applications. If you need to modify your current installation,
you should search the guide or use the contents table to find the information you
require and jump directly to that section.
Installation Guide
vii
Related Documentation
The following documentation is included with INDICIUS.
Each PDF guide can be opened by clicking Start on the taskbar to display the menu
and selecting All Programs | INDICIUS | Documentation.
The INDICIUS Help can be opened from the same menu, but can also be opened from
the Help menu within the tools. Pressing F1 within Definer and Script Editor will
open the topic for the feature being used.
User's Guide (.pdf)
The User's Guide (.pdf) is written for keyboard operators (keyers) who will be using
the attended modules on a production computer, and for those using all of the
modules on a development computer.
The guide explains:
What each INDICIUS module is used for
How to operate each module
Getting Started Guides
These guides are written for people who need an introduction to INDICIUS. The
guides are useful as a starting point for those who will be configuring or
administering INDICIUS, or those using the keying modules. The guides are self
contained, however each focuses on configuring a different document processing
solution.
Getting Started (Fixed-Form) (.pdf)
The Getting Started Guide (Fixed-Form) (.pdf) focuses on configuring a solution to
extract data from fixed-form (structured) documents.
The guide explains:
How to extract data from single page documents of a known document type,
using the installed Order Forms example
How the tools, concepts and configuration files relate to the setup in Kofax
Capture
viii
Installation Guide
How to replicate the Order Forms configuration by following detailed
procedures
Getting Started Guide (Free-Form) (.pdf)
The Getting Started Guide (Free-Form) (.pdf) focuses on configuring a solution to extract
data from free-form (semi-structured or unstructured) documents.
The guide explains:
How to extract data from single page documents of a known document type,
using the installed Solicitors Letters example
How the tools, concepts and configuration files relate to the setup in Kofax
Capture
How to replicate the Solicitors Letters configuration by following detailed
procedures
Getting Started Guide (Classification and Separation) (.pdf)
The Getting Started Guide (Classification and Separation) (.pdf) focuses on configuring a
solution to establish document boundaries and classify documents of variable type
and/or length.
The guide explains:
The concept of classification, and how knowledge of the document type
Methods for classifying documents using data on those documents (when
Methods for separating a stream of pages into documents using data on those
How to classify and separate various documents (fixed-form and free-form),
How to use the powerful Transformation Studio tool for document set
How to replicate the Mortgage Applications configuration by following
Installation Guide
enables conditional extraction of data
document boundaries have been established prior to INDICIUS)
pages (when document boundaries have not been established prior to
INDICIUS)
using the installed Mortgage Applications example
management and configuration of solutions
detailed procedures
ix
INDICIUS Help
The INDICIUS Help is written for those configuring a solution and for system
administrators, and assumes those reading it have read the Getting Started Guides or
attended an INDICIUS training course. This assumption is made so that the
INDICIUS Help can provide the most accurate and detailed information across every
aspect of the product.
The INDICIUS Help explains:
How to configure the INDICIUS modules to process a document set
How to use the module setup dialogs to assign a configuration to a batch class
The integration of INDICIUS within the Kofax Capture platform
How to set up and monitor an efficient production environment
The INDICIUS Help also contains a reference section which includes:
Definition file parameters used by the Recognition and Correction modules
Script objects, hooks, methods and properties used by all of the modules
(Administration Help)
Visual Basic Scripting Help (.chm)
The Visual Basic Scripting Help (.chm) is provided for further information on VB
scripting.
x
Installation Guide
Introduction
This chapter provides a summary of the installation process.
How is INDICIUS Installed?
INDICIUS is installed using the INDICIUS installation CD, after installing Kofax
Capture.
The installation is in three parts:
Chapter 1
Overview
The main INDICIUS installation, including all modules except Document
Document Review installation.
Transformation Studio installation.
These options can be selected from the main installation screen.
After installation, INDICIUS modules may be run from Kofax Capture Batch
Manager, or configured to run on a computer dedicated to that module:
Recognition, Document Review, Correction, Completion, Verification and
Recognition and Scripted Export may be installed and run automatically as
Additional options are available to automate processing.
Installation Guide
Review, and all tools except Transformation Studio.
Scripted Export may be run as dedicated applications.
Windows services.
Note Services must be installed in a separate installation step.
1
Chapter 1
Completing Setup of a Solution
In order to start running the installed INDICIUS modules in a solution, they must be
configured to process your document set.
If you have installed INDICIUS on a development computer, the INDICIUS
modules are ready for configuration using the INDICIUS tools.
If you have installed INDICIUS on a production computer, you will need to
deploy a configuration (typically created during a development step).
Note For information on configuring a solution refer to the INDICIUS Help.
2
Installation Guide
System Requirements
Introduction
This section summarizes the system requirements for INDICIUS.
Information about supported operating systems and other INDICIUS requirements is
available on the Kofax Support Web pages at www.kofax.com.
Hardware/Software Requirements
Chapter 2
All Computers
The following are required to run INDICIUS. During the INDICIUS installation you
will be warned if any of these components are missing.
Microsoft Scripting 5.6
MDAC 2.5
Internet Explorer 5.5 or greater
.NET Framework 2.0
Note INDICIUS is not supported on computers running with large fonts or DPI
settings other than 96 DPI.
Multi-Core Processors for INDICIUS Recognition
It is possible to run multiple INDICIUS Recognition processes at the same time on
one computer. Each process of Recognition requires a separate processor core, for
example, a computer with a dual-core processor can run two Recognition processes
simultaneously.
Installation Guide
3
Chapter 2
See Windows Services for more information on setting up multiple Recognition
Windows services and dedicated applications.
Development/Demonstration Computers
Minimum single processor 2.4 GHz Pentium IV or equivalent
1GB RAM (2GB RAM strongly recommended when building text classifiers
using Transformation Studio)
1024x768x16-bit color graphics resolution (1280x1024 or greater
recommended)
Minimum 1GB free disk space
Kofax Capture installed (standalone or client)
A supported operating system
Note Dual monitors are recommended when configuring INDICIUS using
Transformation Studio.
If you wish to evaluate, demonstrate or test INDICIUS there is nothing to prevent
you from installing it on a slower machine. The modules will still run and function
but at a slower speed.
It is possible to build text classifiers on computers with less than the 2GB RAM. If
“out of memory” problems are encountered during classifier building then the
memory should be increased to 2GB. This memory requirement for classifier
building is due to the size of the training document set. It is therefore expected that
this will be a requirement when building full text classifiers for production, but not
necessarily when creating smaller classifiers, for example for demonstrations.
Production Unattended Computers: Recognition, Scripted Export
Minimum single processor 3Ghz Pentium IV or equivalent
2GB RAM for each Recognition process
800x600x16-bit color graphics resolution
Minimum 1GB free disk space
Kofax Capture installed (standalone or client)
A supported operating system
Note Dual monitors are not supported for use on production computers.
4
Installation Guide
Loading...