INDICIUS 6.1 6.
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.
Contents How to Use This Guide ..........................................................................................................vii Introduction .......................................................................................................................... vii Related Documentation ...................................................................................................... viii User's Guide (.pdf) ................................................................................
Compatibility with other Kofax Products ........................................................................... 7 Introduction ...................................................................................................................... 7 Kofax Capture Features .................................................................................................. 7 Supported Features ..................................................................................................
Installing a Single Windows Service ................................................................... 26 Installing Multiple Windows Services ................................................................ 32 Uninstalling a Windows Service .......................................................................... 33 Viewing the Installed Service ............................................................................... 34 Basic Service Events .........................................................
vi Installation Guide
How to Use This 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.
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 (.
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.
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.
Chapter 1 Overview 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: The main INDICIUS installation, including all modules except Document Review, and all tools except Transformation Studio. Document Review installation. Transformation Studio installation. These options can be selected from the main installation screen.
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).
Chapter 2 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 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 .
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.
System Requirements Each Recognition process will maximize processor usage when running. It is therefore recommended that no more than one Recognition process be run on each processor core. 2GB RAM is recommended for each Recognition process. If text classification and advanced document separation are being used, the memory requirements will increase depending on the size of the classifiers and separators.
Chapter 2 Error/Status Messages The location of some error/debug files is different on Windows Vista, because it is not possible to write to the Program Files folder at runtime. Correction If there is a runtime error with stack trace, it will be logged to: C:\Users\\AppData\Local\VirtualStore\Program Files\INDICIUS\binnt\error.log.
System Requirements Compatibility with other Kofax Products Introduction All aspects of the integration between INDICIUS 6.1 and Kofax Capture have been extensively tested. Most INDICIUS features have been demonstrated to work correctly with the Kofax Capture features, however not all the features are supported. Kofax Capture Features Supported Features Microsoft Vista Support All INDICIUS modules are supported for use on the Microsoft Windows Vista operating system. See Error! Reference source not found.
Chapter 2 Load Balancing INDICIUS modules can be used within Kofax Capture installations using Load Balancing. Scanner Management This feature does not affect INDICIUS functionality. Multiple Workflow Agents Multiple workflow agents can be used within the same batch class as INDICIUS modules. Any batches routed by these agents will be processed in the normal way by the INDICIUS modules. .NET Scripting Kofax Capture modules using scripts written in the .
System Requirements Kofax Capture modules which support this feature can still be used within the same batch class as INDICIUS modules. Enable/Disable Menu and Toolbar Buttons The menu and toolbar items in INDICIUS modules will be displayed independently of the current User Profile. Kofax Capture modules which support this feature can still be used within the same batch class as INDICIUS modules.
Chapter 2 eDocuments INDICIUS supports the presence of eDocument files within a batch. Currently Adobe PDFs, text files and email bodies can be viewed and processed. Any documents of an unsupported file format will be processed with the batch. However, Recognition will not extract any content and the documents will not be viewable in the keying modules. Index data stored on the documents will be maintained.
System Requirements High Availability Installations INDICIUS is certified as a high availability solution and supports the high availability features of Kofax Capture. In order to use INDICIUS in this environment, the “Store batches in SQL Server” option must be disabled. For more information refer to User Tracking Statistics INDICIUS modules are not supported for use with Kofax Capture user tracking statistics. The INDICIUS modules generate their own statistics which are viewed in the Stats Reporter tool.
Chapter 2 INDICIUS does not output data to the database until the batch is closed, this option provides no benefit to the INDICIUS part of a solution. Important Batches do not need to be stored in an SQL Server database to make a system highly available. For more information refer to User Tracking Statistics INDICIUS modules are not supported for use with Kofax Capture user tracking statistics. The INDICIUS modules generate their own statistics which are viewed in the Stats Reporter tool.
System Requirements Support for High Availability Features INDICIUS is certified as a high availability solution. INDICIUS supports the high availability features which were introduced in Ascent Capture 7.0; further details are described below: Automatic Batch Recovery/Rollback INDICIUS only supports batch rollback, not batch recovery. This means that the batch is restored to the state it was in at the start of the session; data read or keyed in the failed session is not recovered.
Chapter 2 If you experience any error messages while processing batches, immediately contact your systems administrator. If possible, try to record information about the batch you were processing, which document the error occurred on, what action you were performing at the time of the error and, if possible, the full text of the error messages seen. Systems Administrator Monitor Kofax Capture Batch Manager periodically to check for batches sent to Error/Quality Control.
Chapter 3 Licensing Introduction INDICIUS is licensed using the Kofax Capture license hardware key. The Kofax Capture license hardware key controls: The number of stations of each module that can be run simultaneously. Any optional features for each module. The page throughput of Recognition and Scripted Export. For information on how to use, query and troubleshoot Kofax Capture license hardware keys, refer to the Kofax Capture documentation.
Chapter 3 Kofax Capture Evaluation Licenses When licensed INDICIUS applications run they will check for the presence of a Kofax Capture Product Suite evaluation license. If this is present, the normal INDICIUS license features are not required. The applications will run with unlimited stations and volume as long as the Kofax Capture Product Suite evaluation license has not expired.
Chapter 4 Installation Introduction This chapter provides instructions for installing INDICIUS using the installation wizard (standard installation). To install INDICIUS the following items are required: 1 A computer satisfying the System Requirements. 2 An INDICIUS installation CD. 3 A Kofax Capture license hardware key with INDICIUS features enabled. Note Kofax Capture must be pre-installed and licensed. INDICIUS is installed to its own program folder.
Chapter 4 Installing INDICIUS Standard Installation To install INDICIUS 1 Place the INDICIUS installation CD into the CD-ROM drive. The main installation screen will display. 2 Select INDICIUS and follow the on-screen instructions. 3 To install Document Review, select INDICIUS Document Review and follow the on-screen instructions. 4 To install Transformation Studio, select Transformation Studio and follow the on-screen instructions.
Installation Creating Additional Instances of INDICIUS Modules Additional instances of INDICIUS modules are created by registering them with Kofax Capture. Note This functionality is currently limited to the Recognition module. For more information on configuring instances of Recognition, refer to the INDICIUS Help under Module Integration – Multiple Instances of Modules. Upgrade Instructions 6.0 or 5.5.1 to 6.1 To upgrade your INDICIUS installation from version 5.5.1 to 6.
Chapter 4 5.5.0 to 6.1 To upgrade your INDICIUS installation from version 5.5.0 to 6.1 1 If you have Recognition or Scripted Export installed as Windows services, stop the services. 2 Uninstall the previous version using the Add or Remove Programs feature in Control Panel. Note Any files that have been modified since installation (for example configuration files) will not be uninstalled. a If ModelBuilder has previously been installed, use Add or Remove Programs to uninstall ModelBuilder Version 5.5.
Installation b If Document Review has previously been installed, use Add or Remove Programs to uninstall INDICIUS Document Review Version 5.1.x. c Use Add or Remove Programs to uninstall INDICIUS Version 5.1.x. 3 Run the 6.1 installation according to the instructions in Standard Installation. 4 Refer to the following topics in the Release Notes (.pdf) for information on changes that may impact your solution. 5 Changes in 5.5 Changes in 6.
Chapter 4 4 Refer to the following topics in the Release Notes (.pdf) for information on changes that may impact your solution. 5 Changes in 5.1 Changes in 5.5 Changes in 6.1 If you have Recognition or Scripted Export installed as Windows services, restart the services. 4.x.x to 6.1 To upgrade your INDICIUS installation from version 4.x.x to 6.1 1 If you have Recognition or Scripted Export installed as Windows services, stop the services.
Installation Installation Configuration Introduction Installation configuration is an optional part of the installation process. It is required only if modules are to be installed as Windows Services or set up to perform special functions when opened as dedicated applications. Installation configuration requires you to specify command line parameters.
Chapter 4 Table 3-3. Application File Names Module Application Name Recognition ka_iform.exe Document Review ka_document review.exe Correction ka_correct.exe Completion ka_kfi.exe Verification ka_verify.exe Scripted Export ka_scriptex.exe Command Line Parameters Note The INDICIUS Help lists the full set of command line parameters which you can use to modify the start-up behavior of the INDICIUS modules. None of these parameters are mandatory.
Installation -autostart For example, to configure Completion to automatically start processing available batches: ka_kfi.exe -autostart 2 Click OK. Note Setting a Computer to Auto-Logon: When a Windows computer starts, it requires a user to log on. This can be a problem where it is desirable for a machine to start running the Recognition or Scripted Export modules automatically on start-up, without user intervention.
Chapter 4 Windows Services This section provides information required to install, maintain and configure Recognition and Scripted Export as Windows services. Installing a Single Windows Service The INDICIUS installation includes all required files but does not automatically install any modules as services. Installing Recognition or Scripted Export as a service requires a manual installation step. You install the Windows service manually at the command prompt using several command line parameters.
Installation Table 3-5. Windows Service Installation Command Line Parameters Parameter Required Description -depends Recommended Specifies dependencies on other services that must be started prior to the one being installed. -account Recommended Specifies the Windows account name for a user account which has access to all the network resources that will be required by the service. To be used with Windows password.
Chapter 4 Table 3-5. Windows Service Installation Command Line Parameters Parameter Required Description -trace No Specifies the level of logging to the Windows application event log. The default trace level (which should always be used in production) is “0”.
Installation password parameters should be used to specify login details for an account that has the required network access. Note It may sometimes be necessary to include the domain along with the username. In this case specify the account name using the following syntax: -account \ For example, -account MyDomain\MyAccountName When specifying a local account, use the syntax: -account .\ For example, -account .
Chapter 4 To install an additional instance of Recognition as a Windows service 1 Open a command prompt and enter the installation instructions in the following format: ka_iform.exe -install -account \ -password -depends -servicename displayname -i For example, ka_iform.
Installation Note The service name and display name parameters are optional. If omitted the service will be named “INDICIUSScriptedExport_Ascent” with display name “INDICIUS Scripted Export for Ascent”. Specify the command line parameters appropriately to ensure all Scripted Export services installed on a multi-processor machine have unique names. Installation Using the Optional Parameters This section includes examples which use the optional command line parameters.
Chapter 4 ka_iform.exe -install -account \ -password -depends -start auto For example, ka_iform.exe -install -account MyDomain\MyAccountName –password MyPassword -depends lanmanworkstation -start auto 2 Press Enter to run the command. A message box will display the success of the installation. Note After the service has been installed the start method can be changed from the Services window in Control Panel.
Installation Uninstalling a Windows Service Important A service should be stopped before it is uninstalled. You can uninstall a service manually from the command prompt. To uninstall a Recognition Windows service 1 Open a command prompt and enter the following instruction: ka_iform.exe -uninstall 2 Press Enter to run the command. A message box will display the success of the uninstall.
Chapter 4 Viewing the Installed Service To view the installed service 1 Open the Services window, accessed from the Administrative Tools section of Windows Control Panel (Start – Settings – Control Panel). The service will be displayed in the list. 2 Check the details (double click the service to see additional information including the dependencies of the service). 3 Select File | Exit to close the Services window.
Installation Once started the INDICIUS Recognition service and the INDICIUS Scripted Export service will pick up and process document batches in exactly the same fashion as they would if the respective applications were left in ”Wait for any task” mode. Error Logging All errors encountered during processing or start-up are logged to the Windows Application Event Log.
Chapter 4 Setting up the Service to use Remote Configuration Files Windows Services cannot access files stored on mapped network drives. When setting up a service, the paths to its configuration files (as specified in its setup dialog in Kofax Capture) should not reference mapped drives. If the configuration files exist on another computer on the network, reference the files using UNC paths, for example: \\server\config\demo.
