KAnalytics

Kofax Analytics for
Capture
1.2.0
Administrator's Guide
2015-02-27
© 2015 Kofax, 15211 Laguna Canyon Road, Irvine, California 92618, U.S.A. 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. 6,370,277.
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, and the Kofax product names stated herein 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
Preface .................................................................................................................................................................................... 7
Related Documentation .................................................................................................................................................. 7
Training ............................................................................................................................................................................. 7
Getting Help for Kofax Products ................................................................................................................................. 7
Introduction ...........................................................................................................................................................................9
Dashboard Overview ......................................................................................................................................................9
Operations Views ....................................................................................................................................................... 9
Batches & Docs Views ............................................................................................................................................... 9
Labor Views .................................................................................................................................................................9
Quality Views ............................................................................................................................................................10
System Requirements ........................................................................................................................................................ 11
Hardware ........................................................................................................................................................................ 11
Deployment Scenarios ............................................................................................................................................. 11
Event Listener Server ...............................................................................................................................................12
Insight Server ............................................................................................................................................................ 13
Database Servers .......................................................................................................................................................13
Software Prerequisites .................................................................................................................................................. 14
IIS Web Server .......................................................................................................................................................... 14
Metadata Repository .....................................................................................................................................................16
Database Driver ........................................................................................................................................................ 16
Oracle ..........................................................................................................................................................................17
Dashboard Clients .........................................................................................................................................................18
Windows Authentication ............................................................................................................................................. 18
Configuring Insight for Windows Authentication ..............................................................................................19
Installing Kofax Analytics for Capture .......................................................................................................................... 21
SSL ....................................................................................................................................................................................21
Databases ........................................................................................................................................................................ 21
Creating the Staging Database ....................................................................................................................................22
Installing Kofax Altosoft Insight ................................................................................................................................ 22
Configuring the Database ....................................................................................................................................... 23
Activating the License ............................................................................................................................................. 25
Configuring Your Project ........................................................................................................................................ 26
Installing the Event Listener ....................................................................................................................................... 28
Installing the Kofax Capture Event Sender .............................................................................................................. 31
Customization Deployment .................................................................................................................................... 31
Configuring the Event Sender ................................................................................................................................31
Kofax Analytics for Capture Administrator's Guide 3

Contents
Upgrading to Kofax Analytics for Capture 1.2.0 ..................................................................................................... 33

Getting Started ...............................................................................................................................................................36
Altosoft Insight Administration ...................................................................................................................................... 39
Managing Users and Roles ..........................................................................................................................................39
Creating Users ...........................................................................................................................................................39
Creating Roles ........................................................................................................................................................... 40
Assigning Users to a Role .......................................................................................................................................41
Defining Access Rights ............................................................................................................................................41
Updating Connections and Data Filters ....................................................................................................................41
Connections Tab ....................................................................................................................................................... 42
Filters Tab .................................................................................................................................................................. 42
Importing and Exporting a Project ............................................................................................................................ 46
Importing a Project .................................................................................................................................................. 46
Exporting a Project ...................................................................................................................................................47
Using Kofax Analytics for Capture ................................................................................................................................ 49
Viewer ............................................................................................................................................................................. 49
Opening the Viewer .................................................................................................................................................49
Selecting a Language ............................................................................................................................................... 50
Viewer Screen Layout and Navigation .................................................................................................................51
Using the Viewer ......................................................................................................................................................52
Exporting to Excel .................................................................................................................................................... 53
Kofax Analytics for Capture Views ........................................................................................................................... 53
Global Filters ............................................................................................................................................................. 53
Automatic, Unattended Modules .......................................................................................................................... 54
Sessions .......................................................................................................................................................................54
Operations Views ..................................................................................................................................................... 54
Batches & Docs Views ............................................................................................................................................. 64
Labor Views ...............................................................................................................................................................69
Quality Views ............................................................................................................................................................75
Kofax Analytics for Capture Admin ..........................................................................................................................84
Filtering Data ............................................................................................................................................................ 84
Processing Data .........................................................................................................................................................84
Setting Up Alerts ...................................................................................................................................................... 87
Viewing Station Information .................................................................................................................................. 89
Reports ............................................................................................................................................................................ 90
Classification and Recognition Reports ................................................................................................................ 90
Workflow Management ...........................................................................................................................................91
Dashboard Designer .......................................................................................................................................................... 93
Accessing the Dashboard Designer ............................................................................................................................93
Adding a New View ................................................................................................................................................93
4 Kofax Analytics for Capture Administrator's Guide

Contents
Copying an Existing View ...................................................................................................................................... 94

Records and Metrics ..................................................................................................................................................... 94
Sharing Your Dashboard Views with the Public .....................................................................................................98
Configuration File .............................................................................................................................................................. 99
Event Listener Failover and High Availability ...................................................................................................... 102
Disaster Recovery .............................................................................................................................................................103
Insight 5 Environment ................................................................................................................................................103
Installation Configurations ........................................................................................................................................ 103
Disaster Recovery Guidelines ................................................................................................................................... 104
Performance Considerations .................................................................................................................................105
Reactivating Plans After a Failure .......................................................................................................................105
Index ...................................................................................................................................................................................107

Contents

Preface
This guide includes instructions for installing and using Kofax Analytics for Capture. Read
this guide completely before using the software. The guide is written with the assumption
that you have a basic understanding of Kofax Capture and Kofax Transformation Modules.
Related Documentation
In addition to this guide, Kofax Analytics for Capture documentation set includes the
following:
▪ Kofax Analytics for Capture Release Notes: Contains late-breaking product information not
included in this guide. You can download the release notes from the Kofax website at
www.kofax.com.
▪ Altosoft Insight Documentation: After completing the installation procedure in this guide,
you can access a set of guides related to Altosoft Insight. These guides are available in the
Documentation folder within your Insight installation.
Training
Kofax offers computer-based training to help you make the most of your Kofax Analytics for
Capture solution. Visit the Kofax website at www.kofax.com for details.
Getting Help for Kofax Products

Kofax regularly updates the Kofax Support site with the latest information about Kofax
products.
To access some resources, you must have a valid Support Agreement with an authorized
Kofax Reseller/Partner or with Kofax directly.
Use the tools that Kofax provides for researching and identifying issues. For example, use
the Kofax support site to search for answers and messages, keywords, and product issues. To
access the Kofax Support page, go to www.kofax.com.
The Kofax support page provides:

▪ Product information and release news.
Click a product family, select a product, and select a version number.
▪ Downloadable product documentation.
Click a product family, select a product, and click Documentation.
▪ Access to product knowledge bases.
Click Knowledge Base.
▪ Access to the Kofax Customer Portal (for eligible customers).
Click Account Management and log in.

Preface
▪ Access to support tools.

Click Tools and select the tool to use.
▪ Information about the support commitment for Kofax products.
Click Support Details and select Kofax Support Commitment.
Use these tools to find answers to questions that you have, to learn about new functionality,
and to research possible solutions to current issues.
Note To optimize your use of the support portal, go to the Kofax Customer Portal login
page and click the link to open the Guide to the Kofax Support Portal. This guide describes
how to access the support site, what to do before contacting the support team, how to open
a new case or view an open case, and what information to collect before opening a case.

Chapter 1
Introduction
Kofax Analytics for Capture is an extension of Kofax Capture and Kofax Transformation
Modules that produces a graphical business intelligence dashboard based on near real-time
data collected during the batch processing workflow.
Use the dashboard to display standard or custom views based on data stored within the
Kofax Analytics for Capture database. Select from the comprehensive set of view types
provided with the product, or use the Dashboard Designer to create custom views based on
the predefined components.
Important Kofax Analytics for Capture views are based on values from predefined Kofax
records and metrics. When using the Dashboard Designer to add custom views, do not
modify the predefined views, records, or metrics that come with the product. You can make
a copy of existing views and then customize the settings.
Dashboard Overview
The Kofax Analytics for Capture dashboard (also called the “Viewer”) consists of several
predefined interactive views.
Operations Views
▪ Overview
▪ Breakdowns
▪ Trending and Stats
▪ Process Latency
Batches & Docs Views

▪ Batch Search
▪ Doc Search
▪ Deleted Batches and Pages
▪ Error Batches
▪ Rejections
Labor Views
▪ Operator Time
▪ Labor Costs
▪ Session Time
▪ Sessions Over Time

Introduction
▪ Operator Performance
▪ Operator Benchmark
Quality Views
▪ Classification
▪ Classification Chart
▪ Extraction
▪ Extraction Chart
▪ Separations
▪ No Touch Processing
▪ Field Extraction Benchmark

Chapter 2
System Requirements
Most software requirements for Kofax Analytics for Capture, including the supported
versions of Kofax Capture and Kofax Transformation Modules, are listed on the Cross
Product Compatibility Matrix on the Kofax website at www.kofax.com. The matrix is updated
regularly, and we recommend that you review it carefully before installing your product.
This chapter is intended to supplement the Cross Product Compatibility Matrix and to offer
information about hardware requirements and other prerequisites.
Hardware
The Kofax Analytics for Capture hardware requirements vary, depending on the specifics of
your deployment. Each server should have sufficient power and resource levels to support
the anticipated load on the applications that are running.
Deployment Scenarios
You can install the Workflow Agent, Event Listener, and Insight Server on the same computer
or on different computers. One Workflow Agent can send to one or more Event Listeners.
One Workflow Agent is deployed for each Kofax Capture site. A Workflow Agent can send to
one or more Event Listeners via a load balancer.
This section describes two typical deployment scenarios:

▪ Distributed
▪ Standalone
Distributed Scenario
You can deploy Kofax Analytics for Capture in a distributed environment for use with Kofax
Capture Network Server (KCNS) central and remote sites.


System Requirements
Standalone Scenario
In this scenario, the Workflow Agent resides on the Kofax Capture server and sends data
to a single Event Listener installed on the same computer (along with Kofax Capture). This
configuration, which does not offer load balancing or failover mechanisms, can be used for
testing or demonstration purposes.
Event Listener Server

The Kofax Analytics for Capture Event Listener receives transactional data from the Kofax
Analytics for Capture Workflow Agent for every module processed in the Kofax Capture
workflow.
For performance and High Availability purposes, multiple Event Listeners should be
configured on multiple servers. Multiple instances of the Event Listener on the same
workstation are not supported.
For failover purposes, each Event Listener must be sized to handle the entire backlog of live
batches if necessary. This provides for the unlikely event that all Event Listeners fail, except
for a single instance. The single Event Listener must have sufficient memory to load the entire
backlog of batches.

System Requirements
We recommend that you host each Event Listener on a quad core server with a minimum
of 2.7 GHz clock speed and 8 GB RAM. Each Event Listener can utilize not more than one
core for processing and writing session data to the Insight database. Each Event Listener can
utilize the rest of the CPU with no limits for accepting connections and saving the received
messages to the staging database.
The size of the backlog for live batches in the system must be monitored. As the backlog
grows, more memory is utilized on the Event Listeners. An undersized system can run out
of memory if the backlog of live batches grows unchecked, resulting in all memory being
consumed. Event Listener servers must be sized to ensure they can handle increases in the
backlog of live batches during peak usage. If a backlog is growing consistently, the number of
Event Listener servers must be scaled to ensure successful processing of live batches.
As a point of reference, two Event Listeners (each on a 2.7 GHz quad core server) typically
support the following workload:
▪ 200 batches per minute
▪ 6 Kofax Analytics for Capture sessions per batch, with one session per module
▪ 11 documents per batch
▪ 40 fields per document
The preceding guidelines are based on a batch class workflow that includes the following
modules: Scan, KTM Server, KTM Document Review, KTM Server 2, KTM Validation, and
Export.
Each Event Listener must be installed on a server where IIS is installed as outlined in IIS Web
Server.
Insight Server
The Altosoft Insight software runs on a 64-bit based server with a minimum 2.7 GHz quad
core clock speed, or better.
We recommend that you install Insight on a server that differs from your database or other
servers. If the Insight server is installed on the same server as your database server or other
Kofax servers, it may impact production throughput. The resource requirements for the
Insight server must be considered along with the requirements defined by the database
vendor for Insight-related operations.
Database Servers
This section includes guidelines for the Data and Staging database servers. We recommend a
separate server for each.
Data Database Server

Depending on your environment, the requirements for the Data database server may vary.
As a point of reference, the Data database is typically hosted on a high-performing server,

with each core at 2.7 GHz. The number of cores may vary, depending on your batch
processing workload. In a distributed environment, the Data database may use about 60% of
the CPU resources while sending data to four Event Listeners.

System Requirements
Staging Database Server

As a point of reference, the Staging database is typically hosted on a quad core server, with
each core at 2.7 GHz. The Staging database may use about 30% of the CPU resources.
Data Compression
Use of database server data compression capabilities (such as SQL Server 2012 Enterprise)
must be factored into the overall CPU load calculations when shared server configurations
are deployed.
Software Prerequisites
Most software requirements for Kofax Analytics for Capture, including the supported
versions of Kofax Capture and Kofax Transformation Modules, are listed on the Cross
Product Compatibility Matrix on the Kofax website at www.kofax.com. The matrix is updated
regularly, and we recommend that you review it carefully to ensure success with your
product.
Also, the following software should be in place before you proceed with the installation.
▪ Runtime Framework: .NET 4.5.1 or later
▪ IIS: Version 7 or later
IIS Web Server

Internet Information Server (IIS) must be enabled and configured. While IIS is provided with
all Windows servers, it is not installed by default; you must ensure that the installation is
complete.
Important When you configure Insight on IIS, the application pool (default or custom)
must be .NET v4.5 (Windows Server 2012) or .NET v4.0 (Windows Server 2008).
When using a custom application pool, you must have a dedicated application pool that
contains the DataFileProcessorService with the LocalSystem identity. If you use an Active
Directory account for an application pool, it must have the same level of permissions as the
NetworkService and LocalSystem identities.
Configuring IIS
If you use the default configuration for IIS, Internal Server Error messages may appear during
the product installation process. You can prevent the errors by configuring IIS according to
the steps provided here. Also, review the list of IIS settings that should be selected.
1 Using Control Panel, navigate to Administrative Tools > Server Manager.
2 In Server Manager, under Features Summary, click Add Features.
3 In the Add Features window, under .NET Framework Features, select the most
current .NET Framework version.
4 In the Add Features window, under .NET Framework <version> Features-WCF
Activation, select HTTP Activation.
5 Click Next.

System Requirements
6 In Server Manager, under Roles Summary, click Web Server (IIS).

7 In the Web Server (IIS) management window, click Add Role Services.
8 In the Add Role Services window, expand Web Server and Application Development.
9 Select ASP.NET and click Next to start the installation.
IIS Settings
This section lists the Internet Information Services (IIS) settings to select for IIS 8 and IIS 7.
IIS 8 Settings
Kofax Analytics for Capture works with the default settings for IIS 8, as listed here. After you
install Kofax Analytics for Capture, some additional IIS 8 settings are added, and they are
listed with an asterisk.
Common HTTP Features:

▪ Static Content
▪ Default Document
▪ Directory Browsing
▪ HTTP Errors
Security
▪ Request Filtering
Health and Diagnostics

▪ HTTP Logging
Performance
▪ Static Content Compression
Management Tools
▪ IIS Management Console
Application Development
▪ .NET Extensibility 4.5*
▪ ASP.NET 4.5*
▪ API Extensions*
▪ API Filters*
WCF Services
▪ HTTP Activation*
IIS 7 Settings
When using Kofax Analytics for Capture with IIS 7, select the settings listed here.
Common HTTP Features:

▪ Default Document
▪ HTTP Redirection
▪ Static Content

System Requirements
Application Development:
▪ .NET Extensibility
▪ ASP.NET
▪ ISAPI Extensions
▪ ISAPI Filters
Security
▪ Basic Authentication
▪ Client Certificate Mapping Authentication
▪ IIS Client Certificate Mapping Authentication
▪ URL Authorization
▪ Windows Authentication
Performance
▪ Static Content Compression
▪ Dynamic Content Compression
Management Tools
▪ IIS Management Console
▪ IIS Management Scripts and Tools
▪ Management Service
Under WCF Services for the .NET 4.5 Framework

▪ HTTP Activation (must be selected for Windows 8, Windows Server 2012, or later)
Metadata Repository
Kofax Analytics for Capture stores metadata and calculated key performance indicators in
Microsoft SQL Server or in Oracle. The server used for storage can be a separate server or
a new database on any existing server for which you have specific database owner (DBO)
privileges.
If you wish to use a separate server, install it prior to installing Kofax Analytics for Capture.
For SQL databases, ensure you have installed Microsoft SQL Server Studio or Studio Express.
Note If you are not using an enterprise level database management system, you can install
SQL Server Express Edition, which is available here:
http://www.microsoft.com/en-us/sqlserver/editions/2012-editions/express.aspx
Database Driver
Kofax Analytics for Capture must have access to the data you want to analyze. If the database
is accessed over a network connection, you must also verify the necessary security/firewall
settings and the availability of the necessary drivers for the target databases.

System Requirements
Oracle
If you plan to use Oracle, you must create an empty schema for each database (staging,
metadata, data, and admin) before installing Kofax Analytics for Capture.
Create an empty schema where you want to store Kofax Analytics for Capture information.
The user name provided when you install Kofax Analytics for Capture must have the schema
set as the default schema for that user. The user must also have user rights to create objects in
that schema.
Database Client Software Requirements

Kofax Analytics for Capture requires the use of Microsoft .NET data providers for Oracle
database management systems. The Microsoft .NET data providers for Oracle are installed
by the client software on each workstation. The supported version of the client software is
ODP.NET with 64-bit ODAC 11.2 Release 5 (11.2.0.3.20) or later, which can be used to connect
to a lower version of the Oracle database.
Unicode
To ensure full support for multi-byte character sets, verify that the AL32UTF8 character set
for Unicode is selected when you configure Oracle.
Tablespace Creation
A dedicated Oracle tablespace for Kofax Analytics for Capture database objects is
recommended, but not required. If you create a dedicated tablespace, identify it as the default
tablespace for the Kofax Analytics for Capture user. Additionally, the Kofax Analytics for
Capture user needs adequate quota on the tablespace to maintain the application schema.
Kofax Analytics for Capture does not support separation of object types into separate
tablespaces. All Kofax Analytics for Capture application objects are stored in a single
tablespace. The separation of tables and indexes may be included in a future release.
Note Be sure that your tablespace configuration complies with best practices for Oracle. See
the Oracle website for more information.
Tablespace Usage Information

The following sizing information is intended as a guideline for preparing your database to
hold Kofax Analytics for Capture data.
Sample create tablespace statement:

create tablespace <tablespace name>
datafile '<tablespace file name and path>'
size <size>;
Because your installation will gather and store user tracking information, be sure to allow
sufficient space for statistical tables.
Creating User Privileges

To use Kofax Analytics for Capture with an Oracle database, the application owner must
already exist in the database. This user requires certain privileges to ensure that Kofax

System Requirements
Analytics for Capture is installed properly and operates successfully after installation. After
installation, Kofax Analytics for Capture uses this database user account to connect to the
database for all subsequent database-related operations.
1 Verify that the user has database level authentication.
2 Verify that the user has quota on the appropriate tablespace for the Kofax Analytics for
Capture data.
3 Verify that the user has the Kofax Analytics for Capture data tablespace identified as the
default tablespace.
4 Verify that the user has the following system privileges to install and use Kofax Analytics
for Capture:
▪ CONNECT: System role that enables the Kofax Analytics for Capture database user to
create a connection to the Oracle database.
▪ CREATE TABLE: Allows creation of all Kofax Analytics for Capture tables and
supporting objects, including indexes and Large Object (LOB) types.
▪ CREATE SEQUENCE: Allows creation of all sequences needed by Kofax Analytics for
Capture.
▪ CREATE PROCEDURE: Allows the database user to create all procedures and
functions needed by Kofax Analytics for Capture.
▪ CREATE VIEW: Allows the user to create the views on top of the Kofax Analytics for
Capture tables.
Sample create user and grant statement:

CREATE USER <username>
IDENTIFIED BY <password>
DEFAULT TABLESPACE <tablespacename>
QUOTA UNLIMITED ON <tablespacename>;
/
grant CONNECT, CREATE TABLE, CREATE VIEW, CREATE SEQUENCE, CREATE PROCEDURE
to <user name>;
/
Dashboard Clients
Computers that run the Kofax Analytics for Capture Dashboard in either Designer or Viewer
mode require a web browser, access to the computer running the IIS instance hosting the
dashboard, and HTML 5. The minimum configuration for these computers is Windows 7 with
4 GB RAM and a microprocessor with a clock speed of at least 2 GHz.
Windows Authentication
If you are using Windows user authentication, access to all Kofax Analytics for Capture
databases must be given to the following:
1 User account used to perform the Kofax Analytics for Capture installation
2 Account/identity for the IIS application pool
3 Account/identity for the Insight Scheduler service

System Requirements
Configuring Insight for Windows Authentication

Use the procedure in this section to configure Altosoft Insight for Windows Authentication.
Before configuring Insight, select Windows authentication in IIS for the web application
(default website).

1 Navigate to Altosoft > Administration > Admin.
2 In the navigation panel, click Authentication.
3 Click the Authentication Method tab and select the following:
a User properties are obtained from the environment: Windows
b And then user roles and access rights are determined by comparing these values to:
Fixed values
4 User identifier: Specify a way to get the user's ID. The ID should be constant for a specific
user's login. Usually, it is a session property (Identity) that looks to the Active Directory
domain and user name.
a In the navigation panel, click User mapping.
b On the User Mapping tab for User Identifier (UID), set the “Session property” to
Identity.
5 Set session properties for User Name and Email.
a On the User Mapping tab for User Name, set the “Session property” to FullName.
User Name is the display name of a user account. Usually, it is one of the Active
Directory properties, such as Identity, name, FullName, displayName or another
convenient property. Your Domain Admin can provide all available Active Directory
properties.
b On the User Mapping tab for Email, set the “Session property” to EmailAddress.
Email is the email address of the user account. It is used for self-subscriptions only.
Usually, it is the Active Directory property mail or EmailAddress. Your Domain Admin
can provide you with all available Active Directory properties.

System Requirements
Mapping Roles
Roles define a set of predefined Admin settings such as the theme, date format, etc. Also,
roles define specific access rights to projects and dashboard views. It's necessary to describe
mapping rules for each role. Usually, the Active Directory property memberOf is used. In
the sample illustration, users with the Active Directory property memberOf including the
managersADGroup are assigned to the Managers role. Your Domain Admin can provide you
with all available Active Directory properties.
Each row in the mapping grid uses the AND operand. If multiple roles on the Roles list match
conditions for a user account, the access rights are merged from all matching roles, while
other settings (such as the theme or date format) are assigned by the top matching role on the
list.


Chapter 3
Installing Kofax Analytics for Capture
Follow the instructions in this chapter to perform a new Kofax Analytics for Capture 1.2.0
installation. The installation includes setup and runtime components. For instructions on
upgrading your Kofax Analytics for Capture 1.1 or 1.1.1 installation, see Upgrading to Kofax
Analytics for Capture 1.2.0.
Your product includes the files you need to successfully install the required Kofax Analytics
for Capture components. See the following table.
Component Required File

Altosoft Insight KofaxInsightSetup_5.1.1.0.0.978_x64.msi
Predefined Project KAFC12.zip
Event Listener KFXWebAgentSetup.exe
Event Sender (Workflow Agent) KofaxCaptureEventSender.msi
SSL
If you initially perform the Kofax Analytics for Capture installation without SSL, you can
switch to SSL later. You can switch to SSL by reinstalling both Altosoft Insight (with the "Use
Existing Database" option) and the Event Listener.
Databases
Use a new or existing database management system instance to create the following databases
for use with Kofax Analytics for Capture:
▪ Staging: Receives data from the Event Listener each time processing is finished for a Kofax
Capture module (except Export). You must manually create an empty Staging database
before starting the product installation. Assign a name such as kafc_staging.
▪ Metadata: Stores configuration information such as metric definitions and calculation logic.
Assign a name such as kafc_meta.
▪ Data: Stores the processed records and metrics. You can assign any name, such as
kafc_data.
▪ Admin: Stores Insight administrative data related to users, roles, filtering, alerts, logs, and
more. Assign a name such as kafc_admin.
Note We recommend that you use a consistent naming convention for each database, such
as kafc_staging, kafc_meta, kafc_data, and kafc_admin.

Although the installation procedure in this guide assumes that you are using SQL Server
databases, Oracle is also supported.
▪ SQL Server: The staging database must be created before you start the product installation;
you can have the installer create or initialize the other databases.
You must have a database account with sufficient rights to create the required databases,
and to create and modify database tables. Otherwise, you must first create databases prior
to installing the product. In the latter scenario, you define a user with database ownership
rights and then manually create the databases and individually assign ownership rights to
each one.
▪ Oracle: All database schemas must already be in place before you proceed with the product
installation. See Oracle.
Creating the Staging Database

You must manually create an empty staging database before proceeding with the installation
process. As mentioned in Databases, we recommend that you establish a consistent naming
convention for each database, including the staging database.
Example: kafc_staging
The staging database tables are created automatically the first time the web agent (Event
Listener) receives data from the Workflow Agent (Event Sender). The Event Listener places
the Kofax Capture data in the staging database, and processes it for use by Kofax Analytics
for Capture. Data is placed in the staging database each time that processing is finished for a
Kofax Capture module (except Export).
Installing Kofax Altosoft Insight

Use the procedure in this section to install Kofax Altosoft Insight.
1 Install the version of Altosoft Insight provided in your Kofax Analytics for Capture 1.2.0
product installation files by running KofaxInsightSetup_5.1.1.0.0.978_x64.msi.
2 When the Altosoft Insight Setup Wizard welcome screen appears, click Next.
3 Review and accept the license agreement terms, and click Next.
4 On the next screen, select Full environment and click Next.
5 On the “Custom setup” screen, accept the default selections. Optionally, use Browse to
navigate to another location for your installation, and then click Next.
6 Click Install to start the installation.
7 When notified that the installation is complete, click Finish to exit.
When the Altosoft Insight Installation Manager appears, proceed to Configuring the
Database.

Configuring the Database

Use the Altosoft Insight Installation Manager to configure databases for use with Kofax
Analytics for Capture. You will need the authentication credentials for your Kofax Capture
database and Kofax Analytics for Capture databases.
1 Verify that the Insight Installation Manager is set to launch after completing the
procedure in Installing Kofax Altosoft Insight.
If not, navigate to Altosoft > Administration > Installation Manager.
Installation Manager - Insight Engine Database Configuration Screen
Important You must have a database account with sufficient rights to create the
Insight admin database. If the admin database already exists, database ownership
permissions are sufficient.
2 Under Insight Engine Database Configuration, enter the connection type, server
name, and authentication credentials to use for the Kofax Analytics for Capture admin
database.
3 Select Create/Initialize Database, enter the name of your administration database (such
as kafc_admin), and click Next.
The Insight Engine IIS Application Pool Settings screen appears.

Installation Manager - IIS Application Pool Settings Screen
4 On the Insight Engine IIS Application Pool Settings screen, update the settings as
necessary and click Next. Do not leave the entries blank in the Application Pool section.
Note The recommended Application Pool is .NET v4.5 (Windows Server 2012) or .NET
v4.0 (Windows Server 2008). You can also type a name for an application pool that
does not yet exist; in this case, Kofax Analytics for Capture creates the application pool
automatically during the installation. For more information about creating a custom
application pool, see IIS Web Server.
The Installation Details screen appears.

5 On the Installation Details screen, review the Administration database and IIS settings.
If necessary, click Previous to change a setting; otherwise, click Next to proceed with the
component installation.
As components are installed, the progress appears on the screen.
6 When notified that the installation is finished, click Next, and then click Administration
Tool. Proceed to Activating Your License.
Post-Installation Results
After you complete the Kofax Altosoft installation, a new program folder appears on your
desktop, similar to the illustration.

Here is a summary of the items in the Altosoft program folder:

▪ Data Load: Tool for running plans that collect data from your Kofax Capture installation
for use in Kofax Analytics for Capture dashboard views
▪ Documentation: Folder that contains Altosoft Insight documentation in PDF format
▪ Studio: Tool for managing project metadata and designing custom views; requires an
appropriate license.
▪ Viewer: Supports a standard display of dashboard views in your browser
▪ Administration
▪ Admin: Altosoft Insight administration tool
▪ Import-Export Tool: Tool for importing or exporting Insight project settings related to
views, records, and metrics
▪ Installation Manager: Wizard that walks you through configuration of your database
▪ Themes and Formats: Tool for applying a theme that affects the color scheme and
appearance of different dashboard components; also includes settings for updating date
and time formats that appear on the dashboard.
Activating the License

Use this procedure to activate the product license provided to you at the time of product
purchase.
2 On the lefthand panel, click License manager.
3 In the Licenses section, click Click here to add new data.
The “Add new license” window appears.
4 Select Add new license from file and click OK.

The Choose file to Upload window appears.
5 Navigate to the location where you saved the license file provided by Kofax at the time of
product purchase.
6 Select the license file and click Open.
The license is activated.
7 On the toolbar, click Logout to close the License Manager.
8 Log out of Insight Admin.
9 Proceed to Configuring Your Project.

Configuring Your Project

Use this procedure to start Insight Admin to import KAFC12.zip, a project that contains built-
in views, records, and metrics for Kofax Analytics for Capture.
2 Enter the login credentials for the Administrator.
3 In the navigation panel, click Authentication.
4 Set the Authentication Method to User's logins and passwords are defined within
Insight platform. Users are explicitly linked to roles.
If you are using Windows Authentication, apply additional settings. See Configuring
Insight for Windows Authentication.

5 After setting the Authentication Method, click Save.
6 In the navigation panel, click Projects, and then right-click and select New.
The New Project window appears.
7 Type KAFC12 as the project name and click OK.



The Create New Project [KAFC12] window appears.
8 Click the Import from file tab, and then click Select file.
The Choose File to Upload window appears.
9 Navigate to your product installation files, select KAFC12.zip, and click Open.
10 Set the database connection information for the Meta and Data databases.
Tip If the server details are nearly the same for the Meta and Data databases, select
Same as the meta database to copy the entries from the Meta section into the Data
section. After the entries are copied, be sure to update the database name in the Data
section.
11 If the databases already exist, you can click Connect to test each one.
The circular indicator turns green if the connection is successful.
12 Skip the Staging DB section, and then click OK to import the project.
13 When prompted to confirm database creation, click Yes.
An indicator appears on the screen while the project import is in progress.
The built-in views, records, and metrics for Kofax Analytics for Capture 1.2.0 are added
to your installation.
14 When the import is complete, two messages appear.
▪ Click OK to clear the message confirming successful data import.
▪ Click Yes when prompted to refresh the page.
15 On the toolbar at the top of the screen, click Data Loader and enter login credentials.
a Click the Execution plans tab.
b On the list of plans, in the row for KAFC 12 - Activation Plan, click Load.
c On the Execution Plans list in the left panel, select both Activation Plan and One
Time Plan.
d In the “Date range” group, select Beginning of times to Current time, and click Load
data to initiate data collection from your Kofax Capture installation.



16 Exit the Data Loader and proceed to Installing the Event Listener.
Installing the Event Listener

Use this procedure to install the Event Listener Web service, which receives data from the
Event Sender (Kofax Workflow Agent) and the Kofax Capture database and then places it in
the Kofax Analytics for Capture Data database.
The Event Listener, which you can install on any computer with IIS, does not need to be on
the same workstation as other Kofax Analytics for Capture components. The Event Listener
uses port 80 or the port the administrator configures for the IIS web site.
Each Kofax Capture station that processes data, including remote sites, must have access to
the Event Listener, which is hosted on IIS and optionally secured with SSL. You can configure
the Event Listener web service for anonymous access.
Set the credentials for the Event Listener to be used by the Workflow Agent when it is
connected. The same credentials must be configured in the Kofax Capture Administration
module to ensure that the Workflow Agent connection is successful.
If you need to change the credentials, reinstall the Event Listener. During installation, you
also specify credentials to the staging, Insight data, and Kofax Capture databases. The staging
database must exist prior to the Event Listener installation, during which the database tables
are created.
You can configure multiple instances of the Event Listener to run simultaneously on separate
servers. If one instance of the Listener service stops working, the other active instances are
available to take over the work from the failed instance. Multiple instances of the Event
Listener on the same workstation are not supported.
Note The Event Listener time zone is determined by the time zone for the Insight data
database. To ensure the integrity of data on the dashboard, do not change the time zone for
the Insight data database after you start using Kofax Analytics for Capture.
1 In the root folder containing your product files, locate and run KFXWebAgentSetup.exe.
The Kofax Web Agent installer opens to the Directory tab.



2 On the Directory tab, click Browse to navigate to the folder where you want to install the
Event Listener, or enter the path and click Next.
The Connectivity tab appears.

3 On the Connectivity tab, enter the protocol and port for the IIS web site, along with the
credentials required to communicate with the Workflow Agent, and then click Next.
You enter the same credentials on the Analytics tab in the Kofax Capture Administration
module.
The Databases tab appears.

4 On the Databases tab, the required entries may vary, depending on the database type
(SQL Server or Oracle).
Note For Oracle databases, you cannot use this tab to test connections.
Do the following:
a In the Staging Database group, enter the authentication information required to
connect to your staging database, and click Test to verify the connection.
b In the Staging Database group, click Copy.
c In the Insight Data Database and Kofax Capture Database groups, click Paste. As
applicable, update the pasted entries (such as the database names) and test the
connections.
d In a KCNS environment with alternate central sites, the Listener must be configured
for the primary central site and all alternate central sites. In the Kofax Capture
Database group, click Add to provide the required information for additional Kofax
Capture databases at alternate central sites.

Note Verify that the version is consistent for each Kofax Capture database
connection that you specify. The use of multiple Kofax Capture versions within the
same installation is not supported. Once the Kofax Analytics for Capture installation
is finished, you can verify Kofax Capture versions for each central and remote site
by checking the Station Information section on the Admin tab in the Viewer.
5 On the Databases tab, click Install to proceed with the installation.

6 When the completion message appears, click OK to close the installer.
7 Proceed to Installing the Kofax Capture Event Sender.
Installing the Kofax Capture Event Sender

After installing the Event Listener, install the Kofax Capture Event Sender (or Workflow
Agent) on every workstation at the central and remote sites. The Event Sender is the
mechanism used to collect data from your Kofax Capture installation and send it to the Event
Listener.
1 Double-click KofaxCaptureEventSender.msi.
The Workflow Agent Installation wizard appears.
2 Click Next to start the installation.
The license agreement window appears.
3 Review the license agreement, accept the terms, and click Next.
4 Click Install.
The files are installed to your Kofax Capture Bin folder. You cannot change the
destination.
5 When the installation is complete, click Finish to close the wizard.
Customization Deployment
When run on a Kofax Capture server installation, the following folder is created:
[ServerFiles]\Customization Deployment\KofaxAnalyticsForCaptureWorkflowAgent
Note If you are using the customization deployment service, the Event Sender is added to
the deployment configuration and deployed according to the schedule.
Configuring the Event Sender

Once you successfully install the Event Sender, an Analytics tab is added to the Kofax
Capture Administration module.

Administration Module - Analytics Tab
Use the Analytics tab to configure the Event Sender (or Workflow Agent). Then add the
Workflow Agent to the batch class workflow.
1 Start the Administration module.
2 On the Tools tab, in Users & Groups, verify that Tracking is selected.
Important Unless user tracking is selected, session data is not accurately represented
in your Kofax Analytics for Capture dashboard views.
3 Click the Analytics tab.

4 In the Menu Items group, click Configure URL.
The Kofax Analytics for Capture window appears.
5 In the URL field, enter the host name or IP address of the computer where the Event
Listener is running.
Note Be sure to replace the default URL (localhost) with the IP address or host name
of the computer where the Event Listener is running. Otherwise, the web agent cannot
receive session data from remote sites.
Also, although a warning is not issued if you publish the batch class without entering
the URL, the URL is required.
6 In the Event Listener Credentials group, enter the User ID and password for the Event
Listener. These entries, which are required, are the same credentials used for installing
and configuring the Event Listener.
7 Click Test Connection to verify that the user credentials are valid.
If necessary, update the credentials and retry the Test Connection.
8 In the Error Handling group, select your preference for handling errors that occur while
sending session data to the Event Listener if Export is the next module in the batch
processing workflow:
▪ If you select Send batch to Quality Control on error before Export: If Export is the
next module in the batch processing workflow, batches are routed to Quality Control
after 10 failed attempts to send session data to the Event Listener.
▪ If you do not select the check box: If Export is the next module in the batch processing
workflow, after 10 failed attempts to send session data to the Event Listener, the batch
is routed to the Export module and the cached session data is lost upon batch export.
In this case, the batch processing workflow is not affected.

Note To manage error handling, you can also use the configuration file located here:
[Kofax Capture Server]\CaptureSV\Config\KA4CConfig.xml
For details, see Configuration File.
In a High Availability environment, you can use the configuration file to manage
failover if any instance of the Event Listener stops working. We recommend using
<RetryAllModules> to configure retry attempts for any module in the batch processing
workflow, in combination with <RetrySecondsWebService>. For a detailed explanation,
see Event Listener Failover and High Availability.
9 Click OK.
Important The Kofax Analytics for Capture settings do not go into effect at remote
sites until you publish the batch class and perform RSA synchronization.
10 On the Batch Class Properties window, on the Workflow Agents tab, add the Kofax
Analytics for Capture Workflow Agent to your batch class, and click OK.
If you have multiple Workflow Agents, the Kofax Analytics for Capture Workflow
agent should be last on the list of Selected Workflow Agents, so that the data reflects any
changes made by other Workflow Agents.
The Workflow Agent AEX file is configured so that “Skip if cannot load” is set to No. As
a result, for any workstations where the Workflow Agent is not installed, batches are sent
to Quality Control.
Important If the Workflow Agent is not added to a published batch class, any
applicable data is not included on the dashboard views in Kofax Analytics for Capture.
11 If you are using Kofax Analytics for Capture with Kofax Transformation Modules, you
must do the following to ensure that the statistical data appears in your dashboard views
as expected:
Use the Kofax Transformation Modules Synchronization Tool to synchronize the project
with the Kofax Capture document class that contains the Classification Result field, and
any other Kofax Transformation Modules fields that you expect to see in Kofax Analytics
for Capture views.
Important If this step is not completed, Kofax Transformation Modules statistical data
is not included on the dashboard views in Kofax Analytics for Capture.
12 Publish the batch class.
Upgrading to Kofax Analytics for Capture 1.2.0

If you are currently working with Kofax Analytics for Capture 1.1 or 1.1.1 and wish to
preserve your existing statistical data, follow the procedures in this section to upgrade to
version 1.2.0.

To complete the upgrade successfully, you will need the authentication credentials for your
Kofax Capture database and Kofax Analytics for Capture databases. Also, you must be the
DBO of the Kofax Analytics for Capture databases; otherwise the upgrade process will fail.
1 If export or deletion is pending for any Kofax Capture batches, process them before you
start the upgrade.
Note If you export or delete these batches immediately after the upgrade, they may
remain on the dashboard as active batches for a period of time. Because the Workflow
Agent does not run when batches are exported or deleted, their actual status is not
reported to the Event Listener. In this situation, the status is typically refreshed by the
system within a week of the export or deletion.
2 On the Admin tab in the Kofax Analytics for Capture Viewer, click Data Processing to
manually update dashboard metrics, which ensures that all data is processed before you
start the upgrade. For detailed instructions, see Updating Dashboard Metrics Manually.
3 Perform a full backup of your Admin, Meta, and Data databases.
4 Uninstall the following Kofax Analytics for Capture 1.1 or 1.1.1 components:
▪ Altosoft Insight
Be sure to complete this step; otherwise, the HTML5 viewer will not be available after
the upgrade.
Note Before proceeding, make a note of your Insight Administration settings (users
and roles, connection strings, batch class and site filters, alerts, and others). Some
settings, such as batch class or site filters, may need to be reset after you install the
new version of Insight.
▪ Kofax Web Agent (Event Listener)

Make a note of any custom Web.config or IIS settings, which should be verified after
you upgrade to the new Event Listener.
▪ Workflow Agent (Event Sender)
Note If your installation includes a large number of workstations, you may decide
to perform the Workflow Agent upgrade in phases. For example, you might leave
the previous version (1.1 or 1.1.1) of the Workflow Agent in place temporarily on
some workstations while you are upgrading the others. For workstations where the
previous version of the Workflow Agent is still in use, the significant performance
improvements offered by the upgrade will not be available. Also, if the Secure Fields
feature is used, the secure field data will be sent as plain text.
5 Install the version of Altosoft Insight provided in your Kofax Analytics for Capture 1.2.0
product installation files. Follow the procedure in Installing Kofax Altosoft Insight.
Before proceeding with this step, you must contact Kofax Sales Support to obtain the
new product license required by Altosoft Insight 5.1.1. You cannot upgrade successfully
without the new license.
6 Configure the database. Follow the procedure in Configuring the Database, except for the
following:
a On the Insight Engine Database Configuration screen, select Use Existing Database
(instead of Create/Initialize Database).
b When notified that the component installation is finished successfully, click Next.

c On the Installation Completed screen, click Administration Tool.

7 On the Insight Administrator login screen, enter the login credentials for the
administrator user and click Login. By default, the user name is Administrator and the
password is password.
The Insight Admin tool appears.
8 Activate the product license for Kofax Analytics for Capture version 1.2. For instructions,
see Activating the License.
9 After completing the license activation, log out of Insight Admin and then log in again.
10 In the Insight Admin navigation panel, select Projects.
11 Select the existing project name (such as KAFC111) in the lefthand panel, and in the
Name field on the right, change the project name by typing KAFC12 and clicking Save.
You are prompted to upgrade your database.
12 Click Yes to proceed with the database upgrade.
A confirmation prompt appears.
13 Click Yes to proceed.
14 When the database upgrade is finished, click Change on the Connection Option screen.
a Click the Import from file tab, and then click Select file.
The Choose File to Upload window appears.
b Navigate to your product installation files, select KAFC12.zip, and click Open.
c On the Change The Project window, click OK to start the import process.
15 When prompted to confirm database creation, click Yes.
An indicator appears on the screen while the project import is in progress.
The built-in views, records, and metrics for Kofax Analytics for Capture 1.2.0 are added
to your installation.
16 When the import is complete, two messages appear.
▪ Click OK to clear the message confirming successful data import.
▪ Click Yes when prompted to refresh the page.
17 In the navigation panel, click Authentication, and set the Authentication Method to
User's logins and passwords are defined within Insight platform. Users are explicitly
linked to roles.
If you are using Windows Authentication, apply additional settings. See Configuring
Insight for Windows Authentication.
18 After selecting the Authentication Method, click Save.
19 In the navigation panel, click and expand Roles, and verify that your preferences were
retained for each role on the list. If necessary, update the settings.
20 On the toolbar at the top of the screen, click Data Loader and enter login credentials.
a Click the Execution plans tab.
b On the list of plans, in the row for KAFC 12 - Activation Plan, click Load.
c On the Execution Plans list in the left panel, select both Activation Plan and One
Time Plan.

d In the “Date range” group, select Beginning of times to Current time, and click Load
data to initiate data collection from your Kofax Capture installation.

e On the Execution Plans list in the left panel, select Operational Data.
f In the “Date range” group, select a date range that applies to your existing data, and
click Load data.
g Exit the Data Loader.
21 Install the Kofax Web Agent (Event Listener) included in your Kofax Analytics for
Capture 1.2.0 product installation files. See Installing the Event Listener.
Note If the authentication credentials have changed for the Workflow Agent, each
affected batch class must be updated and republished.
22 Install the Event Sender (Workflow Agent) provided in your Kofax Analytics for Capture
1.2.0 product installation files. See Installing the Kofax Capture Event Sender.
It is not mandatory to upgrade the Event Sender; the Event Listener for version 1.2 works
with the Event Sender for versions 1.1, 1.1.1, or 1.2. However, on workstations where the
Event Sender for version 1.1 remains in use, the significant performance improvements
offered by the upgrade will not be available. In this situation, if the Secure Fields feature
is used, the secure field data will be sent as plain text.
As another option, if your installation includes a large number of workstations, you may
decide to perform the Workflow Agent upgrade in phases. For example, you might leave
the previous version of the Workflow Agent in place temporarily on some workstations
while you are upgrading the others.
Getting Started
After installing all Kofax Analytics for Capture components, perform these basic
configuration tasks before proceeding to work with your dashboard views.
1 Use Altosoft Insight Administration to do the following:
a Configure users and roles, and then assign access rights. See Managing Users and
Roles.

b Optionally, define filter queries to ensure that the same level of user access to batch
class and site data in Kofax Capture is applied to the data in Kofax Analytics for
Capture views. See Updating Connections and Data Filters.
2 Open the Kofax Analytics for Capture Viewer in your browser. See Opening the Viewer
3 Use the Kofax Analytics for Capture Admin tab to set preferences for filtering secure
data, setting alerts, viewing details about workstations, and more. See Kofax Analytics
for Capture Admin. The Admin tab is available only to users who are assigned to an
administrator role.
4 Use the predefined views to analyze real-time data collected from your Kofax Capture
and Kofax Transformation Modules installation. For information about individual views,
see Kofax Analytics for Capture Views.


Chapter 4
Altosoft Insight Administration
This chapter gives you information about Altosoft Insight Administration settings that affect
your Kofax Analytics for Capture installation. You need to set up users, roles, connections,
filters and other settings to ensure that your Kofax Analytics for Capture Views produce the
expected results.
Note To access the Insight Administration settings, navigate to Altosoft > Administration
> Admin. If prompted, enter your Insight Administration password (default is password).
Before working with Kofax Analytics for Capture views, use the Insight Administration
settings to do the following:
1 Configure users and roles. See Managing Users and Roles.
2 Define a valid connection to your Kofax Capture database. See Connections Tab.
3 Define filter queries to ensure that the same level of user access to batch class and site
data in Kofax Capture is applied to the data in Kofax Analytics for Capture. See Filters
Tab.
For more information about using Insight Admin tool, see the Altosoft Insight 5.1 - Admin
Guide.pdf, which is available here:
\\Program Files\Altosoft\Insight 5.1.0\Documentation
Managing Users and Roles

Kofax Analytics for Capture uses a combination of Users and Roles to manage access to
projects and views.
▪ Users: Assign a unique identifier and password to each user, who represents either an
individual or a group of individuals.
▪ Roles: Use roles to manage access rights to different metrics, records, and views. For
example, if multiple users have access to the same subset of views containing client
portfolio information and overall asset performance, you can create and assign users to a
Portfolio Manager Role. User access is limited to the set of views assigned within a project
based on role settings.
Important Roles can provide access to different views, metrics, and records. You can assign
a user to multiple roles. If you assign a user to multiple roles with varying access rights, the
access rights for the first role on the list are applied.
Creating Users
Use Altosoft Insight Admin to set up one or more users and assign one or more roles. You can
also view or edit the settings for an existing user.

The following default users are provided with the product:

▪ Administrator: Allows access to the Kofax Analytics for Capture Admin tab, along with full
access to Altosoft Insight Admin and Altosoft Insight Studio. Assigned to the kafc admin
role.
▪ kafc: Allows access to Kofax Analytics for Capture dashboard views but restricts access to
the Admin tab. Does not have access to Altosoft Insight administrator functions, Studio, or
Data Loader (Data Load Manager). Assigned to the kafc role.
▪ kafcadmin: Allows access to the Kofax Analytics for Capture Admin tab, along with access
to Altosoft Insight Data Loader. Assigned to the kafc admin role.
Note If you are using Active Directory or HTTP authentication, you are not required to
define an Insight user for each dashboard user.
1 Start Altosoft Insight.

2 On the navigation panel, click Users.
3 Right-click and then click New.
The New User window appears.
4 Enter a name for the user such as Operator, and then click OK.
5 Enter a login ID, user name, email address, and password.
6 Select one or more roles to associate with the user.
7 Click Save.
Creating Roles
Set up one or more roles to associate with a user or group of users.
The following Kofax Analytics for Capture roles are provided with the product:
▪ kafc admin role: Has access to administrator and other functions for Kofax Analytics for
Capture, Altosoft Insight Data Loader, and Altosoft Insight Studio. You cannot assign
additional users to this role.
▪ kafc role: Does not have access to administrator functions.
Roles can provide access to different views, metrics, and records. You can assign a user to
multiple roles. If you assign a user to multiple roles that have varying access rights, the access
rights for the first role on the list are applied.
1 Start Altosoft Insight.
2 On the navigation panel, click Roles.
3 Right-click, and then click New.
The New Role window appears.
4 Enter a name for the role such as Manager, and then click OK.
5 In the Name field, enter the name for the role.
6 Select a theme from the list to define the visual style and appearance of the dashboard to
apply while the role is active.

Note By default, views included with Kofax Analytics for Capture use the Kofax
theme.
7 Select the rights that are available while the role is active.
8 Click Save.
Assigning Users to a Role

Use this procedure to assign a user to a role.
1 Start Altosoft Admin.
2 In the navigation panel, click and expand Users.
3 Select a user name to assign to a role.
4 In the Roles section, select each role to associate with the selected user.
5 On the toolbar, click Save.
Defining Access Rights

Assign access rights based on a user's role. For each role, you can assign access rights for
individual views and reports associated with a project.
1 Start Altosoft Admin.
2 In the navigation panel, click and expand Roles.
3 On the list of roles, select the role to define rights for.
4 Click the View rights tab.
5 Select the KAFC12 project and expand the list of Views.
6 Select each view that should be available to the selected role.
7 Verify that Main is set as the default view for the role. (Do not use the first instance of
Main on the list; use the second instance, which appears under Language.)
▪ If Main is set as the default view for the role, the PC monitor icon appears next to its
name.
▪ If Main is not set as the default view for the role, click PC default at the bottom of the
screen.
The monitor icon appears next to the Main view.
Tip If the “PC default” button is not available when you click it, you may need to
collapse and expand the list of views to enable the button.
8 Click Save.
Updating Connections and Data Filters

When user authentication is enabled in Altosoft Insight, be sure to follow the procedures
in this section to ensure that data appears on the dashboard as expected. You can define

filter queries to ensure that the same level of user access to batch class and site data in Kofax
Capture is applied to the data displayed in Kofax Analytics for Capture views.
Use Altosoft Insight Administration to update settings on the Connections and Filters tabs.
Connections Tab
When authentication is enabled in Altosoft Insight, you must ensure that the settings on the
Connections tab are valid for your Kofax Capture database. The proper settings also ensure
that filtering works correctly.
1 Navigate to Altosoft > Admin > Administration.
Altosoft Insight Administration is started.
2 On the navigation panel, click and expand Connections.
3 On the Connections tab, in the left panel, verify that KC Connection is selected.
4 In the Connection Option group, complete the entries as applicable to your Kofax
Capture database type.
Note If you installed Kofax Capture with the Standard database, use the values
specified here:
▪ Server name (based on the installed version of Kofax Capture):
Kofax Capture 10.1: <machinename>\KOFAXCAPTURE
Kofax Capture 10.0: <machinename>\KOFAXCAP2008R2
Kofax Capture 9.0.3: <machinename>\ASCENTCAPTURE
where <machinename> is the name of the computer where the Kofax Capture server
is installed
▪ Database name: ACSystem
▪ User: KPSG
▪ Password: Pr0fS3rv
The specified user has read-only access to all Kofax Capture database tables.
5 Click Save.
Filters Tab
By default, all users can view data for all batch classes (even if the users don't have access to
the batch classes in Kofax Capture) and all sites. Use the Filters tab to manage user access to
data, based on batch class and site filters.
Setting Batch Class Filter Queries

Use the following procedure to ensure that the same batch class restrictions configured in
Kofax Capture are applied to the data that users see in Kofax Analytics for Capture.
1 Navigate to Altosoft > Admin > Administration.
2 On the menu, click Filters.
3 On the Filters tab, in the left panel, select Batch Class.

4 Verify that Kofax Capture DB is the Source selection.

5 Click in the filter query window.
6 Enter one of the following queries, based on your database type (Oracle or SQL Server)
and user type (Insight or Windows).
Oracle Batch Class query for Insight users:
SELECT RightTablePrimaryKey
FROM Relationships
WHERE RightTableType = 3
AND ProfilePrimaryKey IN (
SELECT Users.ProfilePrimaryKey
FROM Users
LEFT OUTER JOIN DOMAIN ON Users.DomainID = DOMAIN.DomainID WHERE (DOMAIN.Name =
SUBSTR('<Login>', 0, INSTR(N'\', '<Login>')) OR
INSTR(N'\', '<Login>')=0) AND Users.UserID = SUBSTR('<Login>',
INSTR(N'\', '<Login>')+1, LENGTH('<Login>') - INSTR(N'\',
'<Login>')) UNION SELECT GroupProfilePrimaryKey FROM User_Group JOIN
Users On User_Group.UserProfilePrimaryKey = Users.ProfilePrimaryKey LEFT
OUTER
JOIN Domain ON Users.DomainID = Domain.DomainID WHERE (Domain.Name =
SUBSTR('<Login>', 0, INSTR(N'\', '<Login>')) OR INSTR(N'\',
'<Login>')=0) AND Users.UserID = SUBSTR('<Login>', INSTR(N'\',
'<Login>')+1, LENGTH('<Login>') - INSTR(N'\', '<Login>')))
AND 1 =
(SELECT EnableUserProfiles
FROM KGlobal)
UNION
SELECT Name
FROM BatchDef
WHERE PublishedBatchDefID=0
AND 0 =
FROM KGlobal)
Oracle Batch Class query for Windows users:

FROM Relationships
AND ProfilePrimaryKey IN
(SELECT GroupProfilePrimaryKey
FROM User_Group
JOIN Users ON User_Group.UserProfilePrimaryKey = Users.ProfilePrimaryKey
LEFT OUTER JOIN DOMAIN ON Users.DomainID = DOMAIN.DomainID
WHERE Users.UserID = CASE LENGTH('<displayName>') WHEN 0 THEN
SUBSTR('<FullName>', INSTR('\','<FullName>')+1, LENGTH('<FullName>') - INSTR('\',
'<FullName>'))
ELSE SUBSTR('<displayName>',
INSTR('\','<displayName>')+1, LENGTH('<displayName>') - INSTR('\',
'<displayName>'))
END
) AND 1 = (SELECT EnableUserProfiles FROM KGlobal)
UNION
FROM Relationships
WHERE RightTableType = 3 AND ProfilePrimaryKey IN
(
FROM Users LEFT OUTER JOIN Domain ON Users.DomainID = Domain.DomainID
WHERE (Domain.Name = SUBSTR('<IDENTITY>', 0, INSTR('\', '<IDENTITY>')) OR
INSTR('\', '<IDENTITY>')=0)
AND Users.UserID = SUBSTR('<IDENTITY>',INSTR('\',
'<IDENTITY>')+1, LENGTH('<IDENTITY>') - INSTR('\', '<IDENTITY>')
)
UNION
SELECT GroupProfilePrimaryKey
FROM User_Group JOIN Users On User_Group.UserProfilePrimaryKey =
Users.ProfilePrimaryKey
LEFT OUTER JOIN Domain ON Users.DomainID = Domain.DomainID
WHERE (Domain.Name = SUBSTR('<IDENTITY>', 0, INSTR('\', '<IDENTITY>')) OR
INSTR('\', '<IDENTITY>')=0)
AND Users.UserID = SUBSTR('<IDENTITY>',
INSTR('\','<IDENTITY>')+1, LENGTH('<IDENTITY>') - INSTR('\', '<IDENTITY>')))

AND 1 =
FROM KGlobal)
UNION
SELECT Name
FROM BatchDef
AND 0 =
FROM KGlobal)
SQL Server Batch Class query for Insight users:

FROM Relationships
AND ProfilePrimaryKey IN(
FROM Users
LEFT OUTER JOIN DOMAIN ON Users.DomainID = DOMAIN.DomainID WHERE (DOMAIN.Name =
SUBSTRING('<Login>', 0, CHARINDEX(N'\', '<Login>'))
OR CHARINDEX(N'\', '<Login>')=0) AND Users.UserID =
SUBSTRING('<Login>', CHARINDEX(N'\', '<Login>')+1,
LEN('<Login>') - CHARINDEX(N'\', '<Login>')) UNION SELECT
GroupProfilePrimaryKey FROM User_Group JOIN Users On
User_Group.UserProfilePrimaryKey = Users.ProfilePrimaryKey LEFT OUTER JOIN
Domain ON Users.DomainID = Domain.DomainID WHERE (Domain.Name =
SUBSTRING('<Login>', 0, CHARINDEX(N'\', '<Login>')) OR
CHARINDEX(N'\', '<Login>')=0) AND Users.UserID =
SUBSTRING('<Login>', CHARINDEX(N'\', '<Login>')+1,
LEN('<Login>') - CHARINDEX(N'\', '<Login>')))
AND 1 =
FROM KGlobal)
UNION
SELECT Name
FROM BatchDef
AND 0 =
FROM KGlobal)
SQL Server Batch Class query for Windows users:

FROM Relationships
AND ProfilePrimaryKey IN
(SELECT GroupProfilePrimaryKey
FROM User_Group
JOIN Users ON User_Group.UserProfilePrimaryKey = Users.ProfilePrimaryKey
LEFT OUTER JOIN DOMAIN ON Users.DomainID = DOMAIN.DomainID
WHERE Users.UserID = CASE LEN('<displayName>') WHEN 0 THEN
SUBSTRING('<FullName>', CHARINDEX(N'\','<FullName>')+1, LEN('<FullName>') -
CHARINDEX(N'\',
'<FullName>'))
ELSE SUBSTRING('<displayName>',
CHARINDEX(N'\','<displayName>')+1, LEN('<displayName>') - CHARINDEX(N'\',
'<displayName>'))
END
) AND 1 = (SELECT EnableUserProfiles FROM KGlobal)
UNION
FROM Relationships
WHERE RightTableType = 3 AND ProfilePrimaryKey IN
(
FROM Users LEFT OUTER JOIN Domain ON Users.DomainID = Domain.DomainID
WHERE (Domain.Name = SUBSTRING('<IDENTITY>', 0, CHARINDEX(N'\',
'<IDENTITY>')) OR CHARINDEX(N'\', '<IDENTITY>')=0)
AND Users.UserID = SUBSTRING('<IDENTITY>',CHARINDEX(N'\',
'<IDENTITY>')+1, LEN('<IDENTITY>') - CHARINDEX(N'\', '<IDENTITY>')
)
UNION

SELECT GroupProfilePrimaryKey
FROM User_Group JOIN Users On User_Group.UserProfilePrimaryKey =
Users.ProfilePrimaryKey
LEFT OUTER JOIN Domain ON Users.DomainID = Domain.DomainID
WHERE (Domain.Name = SUBSTRING('<IDENTITY>', 0, CHARINDEX(N'\',
'<IDENTITY>')) OR CHARINDEX(N'\', '<IDENTITY>')=0)
AND Users.UserID = SUBSTRING('<IDENTITY>',
CHARINDEX(N'\','<IDENTITY>')+1, LEN('<IDENTITY>') - CHARINDEX(N'\',
'<IDENTITY>')))
AND 1 =
FROM KGlobal)
UNION
SELECT Name
FROM BatchDef
AND 0 =
FROM KGlobal)
Note If you have linked groups rather than users, and the user is not logged in to
Kofax Capture, the filtering does not allow the user to see anything. To work around
this issue, assign the batch class rights explicitly to the user rather than the group. Also,
in a Kofax Capture Network Server environment, the user should log in to the central
site, rather than a remote site.
7 Click Save.
Setting Site Filter Queries

Use a site filter query to specify which users can view data from certain sites.
For very simple cases, you might be able to use one of the following basic samples with minor
modifications. More likely, you will need to create a table of users and the sites they have
access to, and then specify a query to select from that table.
The query should return rows containing the name of each site that the user has access to.
The user name is replaced in the query with the text <Login> for Insight users, or the text
<Identity> for Windows users.
In the samples, a user named SampleRestricted does not have access to the central site (the
central site name is selected from the DatabaseVars table), and only has access to remote sites
with names that start with Restricted Site (remote site names are selected from the AcisCSite
table). All other users have access to both the central site and all remote sites.
Both sample site queries work for Oracle or SQL Server.
Sample Site query for Insight users:

SELECT SiteName
FROM DatabaseVars
AND '<Login>' <> 'SampleRestricted'
UNION
SELECT SiteName
FROM AcisCSite
WHERE '<Login>' <> 'SampleRestricted'
OR ('<Login>' = 'SampleRestricted'
AND SiteName LIKE 'Restricted Site
%')
Sample Site query for Windows users:

SELECT SiteName
FROM DatabaseVars

AND '<Identity>' <> 'SampleRestricted'
UNION
SELECT SiteName
FROM AcisCSite
WHERE '<Identity>' <> 'SampleRestricted'
OR ('<Identity>' = 'SampleRestricted'
AND SiteName LIKE 'Restricted Site
%')

2 On the navigation panel, click and expand Filters.
3 Select Site.
4 Verify that Kofax Capture DB (or other Kofax Capture connection string name) is the
Source selection.
5 Click in the filter query window and enter a site query for Insight or Windows users, as
applicable. Refer to the preceding sample queries as necessary.
6 Click Save.
Importing and Exporting a Project

An Insight project is saved in two databases: the project meta database and the project data
database. By convention, they are named as <project_name>_ meta and <project_name>_
data, such as kafc_meta and kafc_data. The meta database contains the project definitions such
as the data source, records, metric, views (dashboard) and all Insight documents (objects). The
data database stores the data in the project. These databases are stored in the main Insight
Admin database.
Use the Import/Export utility to back up (export) or restore (import) a database. This is useful
when you want to move a project across different databases. Although you can use a third-
party DBA backup and restore tool for this purpose, this Import/Export utility tool gives
you the ability to move the Insight database from one version of SQL to another, or from one
DBMS to another.
Importing a Project
Use this procedure to import a project.
Note To import successfully, you must be a user with database ownership (DBO) rights for
the Meta and Data databases.
1 Select Altosoft > Administration > Import-Export Tool.

2 Enter the login credentials.
The Import/Export screen appears.
3 Select Import.
4 Select the folder to import (restore) the meta database from, or click the ellipsis (...) to
navigate to the folder. The folder should contain a previously exported project meta
database, such as:
C:\Data\KAFC_Project_Meta\

5 Provide the connection parameters to the database to import the data into, such as
new_kafc_meta.
6 Click Connect.
7 Click Import.
The meta database tables are imported to the specified database.
8 Repeat the same procedure for the data database, and be sure to select the folder for the
exported data database, such as:
C:\Data\KAFC_Project_Data\
9 Click Test Connection.
Configure Insight to Use New Project Database Location

If you import the project database to a different location, you need to configure Insight to use
the updated location. The process involves changing the data source connection strings to the
new location.
1 Select Altosoft > Administration > Admin.
2 In the navigation panel under Projects, select the KAFC project and click Change.
3 Enter the new connection strings for the project data database and meta database.
4 Click OK.
Exporting a Project
1 Select Altosoft > Administration > Import-Export Tool.
2 Enter the login credentials.
The Import/Export screen appears.
3 Select Export.
4 Select a folder to export (back up) the database to, or click the ellipsis (...) to navigate to a
folder. Select an empty folder on the server/computer, such as:
C:\Data\KAFC_Project_Meta\
5 Provide the connection parameters to the meta database, such as kafc_meta.

6 Click Connect.
7 Click Import.
The meta database tables are exported to the specified folder.
8 Repeat the same procedure for the data database, such as kafc_data. Be sure to select a
different empty folder, such as:
C:\Data\KAFC_Project_Data\


Chapter 5
Using Kofax Analytics for Capture
With Kofax Analytics for Capture, you can generate data analytics and then display the data
in an interactive dashboard through the Viewer.
The Kofax Analytics for Capture dashboard consists of several views. Each view has
graphical elements and other components to retrieve, analyze, and report on data in your
Kofax Capture and Kofax Transformation Modules databases. Several views configured to
analyze your Kofax Capture and Kofax Transformation Modules data are included in your
installation.
The Dashboard Designer is a browser-based design tool used to customize the appearance
of the views. This tool offers many components to help you build an effective and
comprehensive review of your installation.
Viewer
Use the Viewer to display the dashboard views included in your Kofax Analytics for
Capture installation. These views include a variety of visual and analytical representations
of data using charts, grids, pivot tables, and reports. System administrators, business
process managers, and other stakeholders use this interface to gain visibility into analytical
information.
You can display data in standard or custom views generated from data stored within the
Kofax Analytics for Capture database. You extract information from the Kofax Capture User
Tracking tables based on your Kofax Capture installation or external databases.
You can create new views in the Dashboard Designer. You can also customize a view by
copying a view supplied with your Kofax Analytics for Capture installation and saving it
with a new name. See Dashboard Designer for more information.
Important The views provided with Kofax Analytics for Capture are based on values
that come from predefined Kofax records and metrics. When adding custom views, do
not modify the predefined views, records, or metrics that come with the product. Instead,
copy a predefined view, save it with a different name, and then modify the components as
necessary.
Opening the Viewer

To open the Viewer, follow the procedure in this section.
By default, the Viewer displays in the language selected in the Region and Language settings
for your operating system. To select another language, see Selecting a Language.

Note The recommended monitor resolution is 1280x1024.
1 Do one of the following to open the Viewer:

▪ Navigate to All Programs > Altosoft > Viewer.
▪ Open a web browser and enter the following URL:
http://<server>/Insight/View/
where <server> is the name of your server
Be sure to verify that the website's binding host name is set to blank or localhost in
your IIS settings. Otherwise, a login error may occur.
A login window appears.
2 Enter valid login credentials and click Login.
To ensure proper viewing, verify the proper Authentication Method setting in Insight
Admin. The “No authentication” setting is not supported and may produce errors or
unexpected results in the browser window. For details, see Configuring Your Project.
Also, if Main is not selected as the default view for the role associated with the user who
is logging in, the following error may appear:
You can specify view name parameter in Admin Tool
Resolve the issue by setting Main as the default view, as described in Defining Access
Rights.
Selecting a Language
When you install Kofax Analytics for Capture, the dashboard views display in the language
specified in the Region and Language settings (including the format for delimiters, decimal
points, and names of the days of the week and the months) for the operating system. You can
use the language selector in the Viewer to switch to any of the supported languages:
▪ Brazilian Portuguese
▪ Czech
▪ English
▪ French
▪ German
▪ Italian
▪ Japanese
▪ Polish
▪ Russian
▪ Simplified Chinese
▪ Spanish
▪ Swedish
1 In the Viewer, click the Language button.
A list of languages appears.
2 On the list, click the language in which to display the dashboard views.
The dashboard is refreshed, and the Operations - Overview appears in the selected
language.

Updating the Date and Time Format

When dates and times are displayed, the dashboard views use the format associated with the
selected language. To apply another date and time format, use the Altosoft Theme Manager
(do not use the Region and Language settings for the operating system).
1 On your desktop, navigate to Altosoft > Administration > Themes and Formats.
2 In the Theme Manager navigation panel, click Date formats and then select a language.
a Select the name and locale associated with the selected language.
b Select the first day of the week for the selected locale.
c In the Named Formats section, click the arrow to expand the list of date and time
formats.
d Select a format; if necessary, right-click and select Edit to update any format.
e Optionally click the arrow in the Breakdown section to view sample formats in more
detail. You can right-click and select Edit to update any format.
3 On the toolbar, click Save.
Viewer Screen Layout and Navigation

Viewer

Toolbar Menu
Use the menu to access views and administrator features, including Operations, Batches
& Docs, Labor, Quality, and Admin. Use additional user-level items to bookmark frequently
used views, view version information, and log out.
User Input
Use the navigation ribbon to select user input options such as the date range and Batch
Class. Use Reset Filters to return the data selection to the default settings. Use Language
to display the dashboard in another language.
Chart and Grid Footers

Additional options are available on some charts and grids. Features may include Filter and
reset options, Export to Excel, or text wrap settings. Footers may also include chart or grid
specific summary data such as row quantity.
Context Menus and Chart Options

Right-click a chart or grid to access more options such as Reset, Pivot, Zoom in, View,
and Metric grid format. The options vary, based on the chart type or area where you right-
click.
Double-click a chart to change the breakdown. For example, change the data view of a
pie chart from Batch Class to Days of the Week or Module Name. Options vary, based on
chart type.
Using the Viewer

While working with the Viewer, you can do the following:
▪ Click any batch to drill down to batch activity details.
▪ Double-click a table line to zoom on a table detail.
▪ Manipulate and interact with any component on the dashboard.
▪ Hover over a chart element such as a bar in a bar chart, or a segment in a pie chart to view
details such as session time, quantity, modified date, and percentages.
Adjusting the Refresh Interval

Some components in the Viewer are visually refreshed automatically at regular intervals.
When the refresh occurs, any expandable components are automatically collapsed.
You can use Altosoft Insight Studio to turn off auto refresh for a given component, or to
reduce the auto refresh frequency for a component. Each component has its own Refresh
Interval property, which is ignored by default because a 60-second minimum Refresh Interval
is applied.
1 Start Altosoft Insight Studio.
2 On the navigation panel, click and expand Views.
3 On the Views list, select a view that contains an expandable component.
The grid for the selected view appears.
4 Select the expandable component.
5 On the Property panel, in the Other section, click the ellipsis next to the Refresh Interval
property.
The Edit Date Time Interval window appears.

6 Do one of the following:

▪ To turn off auto refresh for the selected component, verify that the Interval value is set
to 00:00:00, and click OK.
▪ To reduce the auto refresh frequency for the selected component, set the Interval to a
value higher than 60 seconds, and click OK. The format is hh:mm:ss.
7 Click Save.
Exporting to Excel
On any grid with Export to Excel functionality, you can set preferences for exporting the
content of the grid to Microsoft Excel.
1 On a grid with Export to Excel enabled, select Export to Excel.
The Export to Excel window appears.
2 Select an Export content option:
▪ Current page and top drill down
▪ All pages of a grid. top drill down level. Could take some time.
▪ All pages of a grid, all drill down levels. Could take much longer.
3 Select an Export format option:
▪ Unformatted XML file, readable by Excel
▪ Formatted Excel file
▪ Unformatted CSV file
▪ Unformatted TSV file
4 Optionally select Enabled to use a flat export, which retains granular details for drill
down or expandable data.
5 Click OK and when prompted, save or open the .xml file.
Kofax Analytics for Capture Views

This section gives information about each view provided in your Kofax Analytics for Capture
installation.
▪ Operations Views
▪ Batches & Docs Views
▪ Labor Views
▪ Quality Views
Operations views show data in real time, while other views show near real-time or historical
data stored in your database. The primary data source and date refresh frequency are listed
for each view.
Global Filters
Unless stated otherwise in other sections, the data displayed in the Viewer is affected by the
following filters:
▪ Batch class filter query, if applicable. See Setting Batch Class Filter Queries.
▪ Site filter, if applicable. See Setting Site Filter Queries.

▪ Date range and batch class display filters at the top of the Viewer.
Date Range Filter

Use the “Select time interval” or calendar button at the top of the Viewer to open a calendar
used to specify a date range for filtering data. You can click "No filter" on the calendar to
remove date range filtering. When "No filter" is active, data for the past three months from the
current date is displayed by default.
Batch Class Filter

Use the Batch Class list at the top of the Viewer to filter data based on batch class. Select
individual batch classes from the list, or use the All/Clear button to select or clear the entire
list.
Automatic, Unattended Modules

Views such as No Touch Processing, Field Extraction Benchmark, and others provide
information about the number of manual changes made by an operator. Keep in mind that
operator statistics are not gathered for the following unattended modules, where batches are
processed automatically without operator intervention:
▪ OCR Full Text
▪ PDF Generator
▪ Recognition Server
▪ KTM Server
▪ KTM Server 2
▪ CMSplit custom module
▪ Any custom module that includes the Form Identification or Automatic Index function
Sessions
Several Kofax Analytics for Capture views include statistics related to sessions. A “session”
refers to interaction between a batch and a Kofax Capture module such as Scan, Validation,
Verification, or other.
Operations Views
The Operations views include the following:
▪ Overview
▪ Breakdowns
▪ Trending and Stats
▪ Process Latency
Overview
The Overview data is based on the batches that are currently being processed through the
Kofax Capture workflow. Use the Overview to analyze near real-time data by Module or by
Operators. You can also view, per processing queue, the number of batches in the system for
the selected time period. Click a row in a table to work interactively with the data. By double-
clicking an item in the Batches by Module list, you can drill down to view a Batch Overview
screen with batch detail or historical detail.

The Overview does not include data for exported batches. Although the date range filter is
ignored for this view. all charts except Current Operators and Services are affected by the
“Created less than: N days” filter, which excludes data for batches older than the specified
number of days.
At the top of the view, a count is given for the number of batches, documents, and pages in
the current batch queue. These values are based on the following metrics: Current Queue,
Current Queue Doc Count, and Current Queue Page Count.
In a Kofax Capture Network Server environment, ensure data accuracy by closing modules
at the remote sites before performing Remote Site Synchronization to refresh the data at
the central site. Otherwise, closed modules may be reported inaccurately as Open on the
Operations views.


View / Chart / Filter Description Updates

Batches by Module Displays the number of batches in Data refresh in real time
the system and the maximum queue and visual refresh every 60
time (total time spent by a batch in seconds
the queue, including wait time and
actual processing time).
Displays the Current Queue and
Waiting Time in Queue metrics by
module name, which is contained
in the NextQueue property of the
most recent session for the batch.
Current Queue is a batch count.
Waiting Time in Queue displays a
maximum time that passed for any
batch currently in that module since
the last session for that batch was
processed.
Batches by Module Drill Down: Displays batches currently in Data refresh in real time
Details for Module: Batch Detail the system by module; the list is and visual refresh every 60
based on batches with the same seconds
NextQueue value.
When a batch is selected, the
batch history appears with all of its
sessions in the bottom grid.
Batches by Module Drill Down Displays history of selected batch Data refresh in real time
- Details for Module: Current and visual refresh every 60
Batch History seconds
Current Operators and Services Displays a list of logged-in operators Data refresh in real time. In
and the Kofax modules they are a Kofax Capture Network
using. Server environment,
Displays records from the data refresh may vary,
STATSMODULELAUNCH table, depending on remote site
where ENDTIME is null and synchronization frequency.
ORPHANED is 0. Offers ability to
drill down into Site, Station and
Operator.
To display the data successfully,
you must enable the User Tracking
feature in Kofax Capture.
Historic Queue Displays the history of the current Hourly
batch queue size, hour by hour.
Includes the queue processing
length in seconds, gives data over
time about the number of batches
processed by each module, and
presents queue trends.
Batches by Batch Class Displays the number of batches in Data refresh in real time
the system sorted by batch class and visual refresh every 60
seconds

Batch Overview
When selecting an individual batch on the Operations - Overview and other views, you
can view a Batch Overview summary that offers an expanded set of details for the batch,
including batch events. The following table lists the batch events that may appear on the
Batch Overview.
Note In attended modules, a “Field value is changed” event may occur, even if user
interaction is not involved. If a field value is populated by a script, a bar code, or as the
result of the default value being applied, a “Field value is changed” event occurs.
Batch Events
Event Name Event Name Event Name

Batch has timed out Batch priority is changed Document is unrejected
Batch is created Document form type is changed Field value is changed
Batch is deleted Document is classified Page is deleted
Batch is rejected Document is deleted Page is rejected
Batch is released Document is exported Page is separated
(event includes loose pages
moved into a document)
Batch is split Document is re-classified Page is unrejected
Batch is unrejected Document is rejected


Total Batch Time Total time elapsed from batch creation Data refresh in real time
until now. and visual refresh every
60 seconds
Total Session Time Sum of the time from start to finish for Data refresh in real time
each session in all the batch sessions. and visual refresh every
60 seconds
History In a separate window, opens a list
of queues where the selected batch
has been processed. The History
also includes error message text, if
applicable.
Documents Current list of documents in the Data refresh in real time
batch; listed by Id and Type, which and visual refresh every
correspond to Label and Document 60 seconds
Type, respectively.
Last State of the Batch Most recent batch state. Data refresh in real time
and visual refresh every
60 seconds
Batch Events List of events related to the batch, Data refresh in real time
including documents, pages, and fields. and visual refresh every
60 seconds
Batch Events - Name Name of the batch, document label, or Data refresh in real time
page ID, respectively. and visual refresh every
60 seconds
Batch Events - Old Value Lists the name of the parent batch (if Data refresh in real time
current batch was created as a result of and visual refresh every
a batch split), previous document type if 60 seconds
the document was reclassified, previous
field value if the field was changed; also
lists the previous document label or lists
"loose" if the page was never assigned
to a document and an index of the page
in the document or in the batch is not
currently assigned to the document.
Batch Events - New Value Lists the name of the child batch Data refresh in real time
(if a batch split event exists for the and visual refresh every
parent batch), new document type 60 seconds
if the document was classified or
reclassified, current field value if
a field was changed; also lists the
previous document label or lists "loose"
if the page was never assigned to a
document and an index of the page
in the document or in the batch is not
currently assigned to the document.
History
When you select a batch on the Batch Overview and click the History button, the History
details are displayed in a separate window. The History includes a list of queues where the
selected batch has been processed, along with error message text, if applicable.

Breakdowns
Use the Breakdowns view to perform in-depth analysis of the Overview data, based on a
range of criteria. The data applies to batches that are currently in the system and excludes
exported data.
Each chart on the Breakdowns view displays the Current Queue metric as a batch count split
by corresponding dimensions: Origin, Status, Priority and Batch Class.
Although the date range filter is ignored for this view. all charts are affected by the “Created
less than N days” filter, which excludes data for batches older than the specified number of
days.
Note The data on the Breakdowns view reflects the “Created less than: N days” filter on the
Operations-Overview. This is expected to change in a future release.


By Origin Displays the number of batches Data refresh in real time
created per workstation and visual refresh every 60
seconds
By Priority Displays the number of batches Data refresh in real time
sorted by priority and visual refresh every 60
seconds
By Status Displays the number of batches Data refresh in real time
sorted by state and visual refresh every 60
seconds
By Batch Class Displays the number of batches Data refresh in real time
sorted by batch class and visual refresh every 60
seconds
Trending and Stats

Use the Trending and Status view to analyze business operations by day of the week,
or hourly for a specific day of the week. You can see operations trends based on volume
increase, the number of batches by module, or by day. You can refine views to see data series,
batch class, or the hour of the day.



Average Queue by Module Displays the average hourly queue Hourly
size day by day per module.
Queue Time by Module Displays the average queue time by Hourly
module, in seconds.
Based on the Waiting Time in
Queue Historic metric, which uses
the same WaitingSeconds session
property as the Latency record/
metric and displays its total historic
value by module.
This chart provides queue
times only for batches that have
completed processing; batches still
waiting to be processed in a queue
are not included in the chart. To
view the total time spent by a batch
in the queue, including wait time
and actual processing time, see the
Batches by Module chart.
Batches by Day of Week Displays a count pf processed Hourly
batches sorted by the day of the
week they were created. The
maximum number of bars is 7,
regardless of the selected date
range.


Batches by Hour of Day Displays a count pf processed Hourly
batches sorted by the hour of
the day they were created. The
maximum number of bars is 24,
regardless of the selected date
range.
Process Latency
Use the Process Latency view to examine overall system efficiency to identify inactivity or
delays as batches are processed through the Kofax Capture workflow. The Process Latency
view displays the minimum, maximum, and processing time for each module. A higher
processing queue time indicates batches that are waiting to be processed.
Note The Process Latency view includes information from all processing modules,
including Batch Manager.
For example, you can use the Process Latency view to detect a batch that becomes idle
(stalled while awaiting processing) at a certain queue. The view lists the number of pages and
documents in a batch during each step in the workflow.
You can use Process Latency information to determine if improvements are necessary to
address process slowdowns that prevent batch completion within quoted service levels.
The view has two components: a Latency Histogram bar chart that displays a metric with
the same name and a Latency grid that shows a record with the same name. The view has an
additional Module filter that affects both of the preceding components.



Latency Displays record latency for Data refresh in real time
any session with a non-null and visual refresh every 60
WaitingSeconds property. seconds
WaitingSeconds is the number of
seconds passed since the moment
the previous session completed
to the moment when this session
started. The WaitingSeconds
property is only populated if this
session has an Operator property
populated.
Latency Details Expand record grid to display Data refresh in real time
queue times for specific batches. and visual refresh every 60
You can display details for the seconds
selected record by station or batch
names. You can also use the Batch
Overview to view the batch history.


Latency Histogram Same as the Latency description, Data refresh in real time
with the addition of a Bucket and visual refresh every 60
dimension, which is an integer seconds
calculated by the following
formula: WaitingSeconds /
LatencyParameter. The Bucket
dimension is used to classify all
the WaitingSeconds values in the
data set into several groups (which
are displayed as the bars in the
corresponding bar chart component).
LatencyParameter is a variable with
a value from 1 to 200 (default is 20).
This variable value is displayed and
controlled by the Time slider control
near the top of the view.
Time Chunks Updates the number of seconds per Data refresh in real time
interval. and visual refresh every 60
seconds
Module Filters information by module. Data refresh in real time
and visual refresh every 60
seconds
Batches & Docs Views

Use Batches & Docs views to search for information related to processed batches based on
batch properties. Select a batch to view the batch overview panel. Primary data source and
date refresh frequency is listed for each view.
The Batches and Docs views include the following searches:

▪ Batch Search
▪ Doc Search
▪ Deleted Batches and Pages
▪ Error Batches
▪ Rejections
Batch Search
Use the Batch Search to look for information about processed batches. You can provide batch
properties in the search criteria and click on the results to view details. If you select a batch on
the Search Results list, an overview appears.



Search Batch by Properties Search batches based on properties; Data refresh in real time
includes historical data for all and visual refresh every 60
processed batches seconds
Search Results Lists search results; includes Data refresh in real time
historical data for all processed and visual refresh every 60
batches seconds
Doc Search
Use Doc Search to find information about processed documents. You can provide field values
and see the results by clicking on a set. Selecting a document displays the batch overview
panel.
Note When searching for documents by field values, the search results currently do not
indicate the batch fields. For example, the results do not clearly distinguish folder class
fields from other batch fields.
Also, note that the search results include all field types, not just document fields.


Search Documents by Field Search documents based on field Data refresh in real time
Values values; includes historical data for all and visual refresh every 60
processed batches seconds
Search Results Lists search results; includes Data refresh in real time
historical data for all processed and visual refresh every 60
batches seconds
Deleted Batches and Pages

Use this view to see all batches and pages that have been deleted from the system. You can
also view detail about deleted pages related to a selected batch.


Note This view shows the last module where the batches and pages existed, rather than the
module where the deletion occurred.

Deleted Batches Displays deleted batches; includes Data refresh in real time
data for all processed documents and visual refresh every
60 seconds
Deleted Page Displays deleted pages; includes data Data refresh in real time
for all processed documents and visual refresh every
60 seconds
Error Batches
Use this view to display information about batches that are currently in the system in an error
state.



Current Errors Displays error batches that are Data refresh in real time
currently in the system. and visual refresh every
60 seconds
Top 5 Reasons for Rejections Displays the number of batch errors Hourly
Historically sorted by reason over time.
Batch Rejections Trend Displays the number of batch errors Hourly
over time.
Rejections
Use the Rejections view to get details related to batches, documents, or pages that are rejected
during processing. This view shows which items are rejected, along with other details such as
the date and time, the operator, the queue, and the reason for rejection.
The view includes an aggregate of the total number of rejected batches and a pie chart that
illustrates the rejection reasons. You can drill down to see a detailed list of rejected documents
sorted in chronological order and grouped by batch.
The data is updated as batches become unrejected.



Rejections Displays a count of the number Hourly
of rejections grouped by batches,
documents, and pages
Rejections Chart Displays chart showing rejections Hourly
breakdown per day
Batches Displays the rejected batches, including Data refresh in real time
error message and visual refresh every
60 seconds
Documents Displays rejected documents, including Data refresh in real time
the document number and error and visual refresh every
message 60 seconds
Pages Displays rejected pages, including the Data refresh in real time
page ID and error message and visual refresh every
60 seconds
Labor Views
Use Labor views to analyze how labor and cost impact your operation. The Labor views
include the following:
▪ Operator Time
▪ Labor Costs
▪ Session Time

▪ Sessions Over Time

▪ Operator Performance
▪ Operator Benchmark
Note In a Kofax Capture Network Server environment, consider the following as you view
session start and end times. When a batch is downloaded from the central site to the remote
site, the actual session start time and user data are not available; therefore, the end time of
the previous session is used as the start time, and the user data is blank.
Operator Time
Use this view to analyze how labor and cost impact your operation. You can see where
operators spend their time and what they are working on. Look at a breakdown of operator
time and look at the different work types performed. You can also see how operator time
breaks down by module.
You have a variety of ways to look at the amount of time a particular user spends within a
particular session.


Session Time by User Displays the number of hours each Data refresh in real time
operator spends working on each and visual refresh every
batch, grouped by operator 60 seconds
Session Time by Module Displays the number of hours each Data refresh in real time
operator spends working on each and visual refresh every
batch, grouped by module 60 seconds


Top 5 Operators Displays the 5 operators who spend Data refresh in real time
the most time processing batches, on a and visual refresh every
per-hour basis 60 seconds
User Session Time - last 10 Displays the total number of hours per Data refresh in real time
days day during the last 10 days working and visual refresh every
on batches in the system, sorted by 60 seconds
module
Labor Costs
Use this view to define a cost per module to analyze real-time calculations over the entire
operation. Enter average values in the grid to derive an overall labor cost. Additional
charts show labor cost breakdown by module and operator. You can also view labor cost
comparisons of your top five operators.
The information, which is stored for the entire system, is not restricted; the data is provided
for all processed documents.


Define Module Costs per Hour Can be edited to reflect hourly costs per Data refresh in real time
module; instantly updates other charts on and visual refresh every
the page. 60 seconds
Costs by Module Displays costs per module relative to all Data refresh in real time
other modules. and visual refresh every
60 seconds


Costs by Operator Displays the top 5 operators sorted by Data refresh in real time
cost and visual refresh every
60 seconds
Costs per Operator Displays all operators with associated Data refresh in real time
costs and visual refresh every
60 seconds
Session Time
Use this view to analyze the average amount of time (expressed in seconds) used per session
for overall processing. Enter the target time you expect a module to take, and then compare it
to the amount of time that performs over time based on your assumptions.


Total by Operator Total time used per session per Data refresh in real time
Operator; includes data for all and visual refresh every
processed documents 60 seconds
Average by Operator Average time used per session Hourly
per Operator; includes data for all
processed documents
Total by Batch Class Total time used per session per batch Data refresh in real time
class; includes data for all processed and visual refresh every
documents 60 seconds


Average by Batch Class Average time used per session per Hourly
batch class; includes data for all
processed documents
Sessions Over Time

Use the Sessions Over Time view to analyze the amount of time (expressed in seconds)
operations take per batch class and per module on a historic basis. Enter the target time you
expect a module batch class to take, and then compare it to the amount of time that performs
over time based on those assumptions. You can identify which modules take longer than
expected to process, and analyze overall operator efficiency.


Set Target Time in Seconds Sets target times per batch class and per Hourly
module; includes data for all processed
documents
Top 5 Users by Sessions over Displays the 5 users who most often Hourly
Target Time exceeded the target processing
time; includes data for all processed
documents
User Session over Target Displays details about the actual vs. Hourly
target processing time; includes data for
all processed documents

Operator Performance
Use this view to analyze operator performance such as Batch Review Time and Page Review
Time, representing the time spent in Kofax Transformation Modules Document Review. The
change ratio time is calculated as a ratio of the number of fields changed by the operator, and
the average number of extractions by all operators. If the value is greater than 1, the operator
performs better than average. If the value is less than 1, the operator performance is below
average.


Operator Performance Displays batch time and page time plus Hourly
change ratio to average. Compares
the number of fields the operator had
to change to the average number of
changed fields for the document. Helps
to identify operators whose results differ
from the average; as a result, you can
evaluate whether a valid issue is causing
the discrepancy.
Operator Benchmark
Use this view to compare the average session time for a selected operator to the average
session time for all operators.



Operator Displays the session time for all Hourly
operators; includes data for all
processed documents
Average Session Time Compares the average session time Hourly
for the selected operator the average
for all operators; includes data for all
processed documents
Batch Events Select a specific batch event to display in Data refresh in real time
the Batch Overview; includes data for all and visual refresh every
processed documents 60 seconds
Quality Views
The Quality views consist of the following:
▪ Classification
▪ Classification Chart
▪ Extraction
▪ Extraction Chart
▪ Separations
▪ No Touch Processing
▪ Field Extraction Benchmark

Excluding Deleted Batches from Views
Several of the Quality views include data related to deleted batches. If you prefer to exclude
data for deleted batches, do the following:
1 In Dashboard Designer, open one of the extraction or classification views from the
Quality subfolder.
2 Right-click the view components and select Data on the context menu to identify the
metrics and records associated with the view.
3 Drop a filter component on the view, and when the property wizard appears, select
Metric or Record.
4 Select the HasBeenDeleted dimension on the Dimension list.
5 Click Next to advance to the Display Options tab of the filter property wizard.
6 In the Default Value section, select “Specific value” and assign a value of 0 to it.
7 Click OK to save the settings and exit the property wizard.
8 Right-click the filter and select Actions to open the Actions window.
9 Click the Outgoing Actions tab and verify that “Apply scope to the components of
group” is set to “Current view (global, local).”
10 Close the view and save the changes.
Classification
Use the Classification view to display different document types, processing confidence, and
manually reclassified documents. This view gives the ratio of reclassified documents to all
documents.



Doc Class Statistics Displays the change ratio for documents, Data refresh in real time
including the count, confidence and the and visual refresh every
number of changes; includes data for all 60 seconds
processed documents
Doc Class Statistics - Doc Displays the number of reclassifications Data refresh in real time
Details per document class, including the Date, and visual refresh every
Batch Name, Doc number, Initial Type, 60 seconds
Final type, confidence, Outcome and
Operator. Includes data for all processed
documents
Classified Type Changes Displays the number of classification Data refresh in real time
changes. Offers drill-down by day and visual refresh every
of the week or by operator to get 60 seconds
additional detail. You can determine if
reclassifications typically occur on a
certain day or a certain operator. Includes
data for all processed documents
Doc Reclassification matrix Lists the number of reclassifications by Data refresh in real time
document type. The column lists the and visual refresh every
initial classification and the row lists the 60 seconds
final classification; includes data for all
processed documents.
Classification Chart
Use the Classification chart to display the change ratio and confidence for a document class.



Doc class by Change Ratio and Displays the confidence and change ratio Data refresh in real
Confidence for a document class; the X axis lists the time and visual
confidence and the Y axis list the change refresh every 60
ratio. seconds
Extraction
Use the Extraction view to display field level information sorted by document class or
document type. This view includes field level details for both Kofax Transformation Modules
extraction and Kofax Capture recognition.
Note The same field name (such as FirstName or SSN) may be used by different document
types. Be sure to filter the results by document type to ensure that the results are accurate.


Extraction - by Doc Type Displays field statistics, including the change Hourly
ratio, for field level data associated with the
selected document type.
Fields Changed - Field Statistics Displays a list of all fields for the selected Hourly
document type. Click any line to drill down
to details such as document number, OCR
confidence, original value and new, validated
value. You can also drill down on a document
number to display details such as field name,
value, or tables and rows for invoice line
items.
Extraction Chart
Use the Extraction Chart to display fields by document type, field confidence, and change
ratio. A well-tuned installation would reflect a high OCR confidence percentage with minimal
changes (bubbles that appear in the lower right corner of the chart).
The x-axis corresponds to field confidence (or OCR confidence), and the y-axis is the change
ratio.


Separations
Use the Separations view to get a quick snapshot of page separations related to classification
corrections or reclassifications (initial separation is not included). Use this view to identify
emerging patterns in the data.
Note The Page Separations view is updated to reflect data after processing for a module is
complete. If you access the Page Separations view while processing is still underway, the
data may not yet be reflected in the Page Separations view.


Page Separation - Color cell Displays the page separation volume by type Data refresh in real
chart and indicates source and destination type time and visual
distribution by color density. refresh every 60
seconds
Page Separation - Grid Displays itemized instances of page Data refresh in real
separation. You can select an instance to time and visual
display the associated batch overview. refresh every 60
seconds
No Touch Processing
Use the No Touch Processing view to display the ratio of items processed without manual
corrections relative to the total number of documents processed. Use this information to
analyze the efficiencies of No Touch Processing within your organization.



No Touch Ratio Displays the no touch ratio per document Data refresh in real
type time and visual
refresh every 60
seconds
Document Processing Displays the No Touch Processing details for Data refresh in real
all changes, per document type time and visual
refresh every 60
seconds
Field Extraction Benchmark

Use the Field Extraction Benchmark view to examine overall user productivity with the
system. The view includes key metrics for operator activity related to field validation.
Based on this view, you can determine how many fields were accurately detected by the
system, along with the number of fields that required a change by the validation operator.
Kofax Capture determines field validity based on thresholds for OCR confidence. Kofax
Transformation Modules determines field validity based on validation rules or locator
confidence values that execute in KTM Server.
You can filter this view by batch class or document class. By default, fields for all batch classes
and document classes are included. If you click a field in the grid, it is reflected in the pie
chart display.


Field Extraction Benchmark - Displays field validation accuracy expressed Hourly
Grid as a percentage, on a per-field basis.
Field Extraction Benchmark - Displays field validation accuracy expressed Hourly
Color pie chart as a field count.
Total Documents counter Displays the total number of documents Data refresh in real
represented in the view. time and visual
refresh every 60
seconds
1
Correct and Valid (true positive) Field is correct and detected as valid by the Hourly
system. Field requires no adjustments by
validation operator during processing (no
touch).
Correct but Invalid (false Field is correct yet detected as invalid by Hourly
negative) the system. Operator must press Enter to
confirm the validity of the field.
2
Incorrect and Invalid (true Field is incorrect and detected as invalid by Hourly
negative) the system. Operator is prompted to perform
data entry or make corrections that occur
as a result of OCR or database errors, or
untrained documents.


Incorrect but Valid (false Field is incorrect yet detected as valid by Hourly
positive) the system. If the operator does not make
corrections, inaccurate data remains in the
system.
1
Correct: No changes were made to the field value
2
Incorrect: Field value was changed manually by the validation operator
Kofax Analytics for Capture Admin

Use the Admin tab to manage the information that appears in your views, configure alerts,
and review the status of each workstation in your installation. This tab is available to any user
assigned to an administrator role in Altosoft Insight.
The Admin tab includes the following capabilities:

▪ Filtering
▪ Processing data
▪ Setting up alerts
▪ Viewing station information
Filtering Data
You can set up filters to manage the data that appears in Views. For example, you can set up a
filter to exclude confidential information such as bank account numbers or personal data.
The FieldDictionary list on the Admin tab includes fields for all documents. If you apply
security to any field on the list, the value is masked with asterisks when it appears in a view
(the field label appears in the view as usual). The FieldDictionary list is updated nightly
When you secure a field, it goes into effect the next time that Kofax Capture session data is
processed by the Event Listener. Any previously processed session data is unaffected.
1 On the toolbar, click Admin.
2 Optionally, select the date range and batch class associated with the fields to be excluded
from views.
3 On the Secure Fields list, in the FieldName column, locate a field (such as Birth Date) to
exclude.
4 For the selected field, in the MakeSecure column, select True.
Fields set to True are restricted, and they do not appear in the views. Fields set to False
are not restricted.
5 Repeat the process for each field to be excluded from views.
Processing Data
In a typical installation, updates to the dashboard run automatically at regular intervals. If
special circumstances arise, you can use the Data Processing settings to manually execute
plans that accelerate updates to the dashboard without waiting for the regularly scheduled
processes to run.

You can also use the Data Processing settings to remove data from the Insight data database.
Updating Dashboard Metrics Manually

Operational metrics, which affect the data on the Overview and Breakdowns views on the
Operations tab, are updated automatically in real time. Quality metrics, which affect the data
for other views, are updated hourly. Use the Data Processing settings to manually update
metrics outside the regularly scheduled intervals. Once you complete a manual update, the
next update occurs during the next regularly scheduled interval.
To ensure accuracy, you should wait at least 1 minute after closing a batch to manually
update the metrics. For example, if you run the Quality Metrics immediately after closing a
batch, the views may not be refreshed as expected. For best results, wait up to 1 minute after
closing a batch to update the metrics.
1 On the dashboard, click Admin.
2 Click Data Processing.
The Data Processing window appears.
▪ To ensure that the Labor views accurately reflect the status of your installation, click
Load Initialization Data. Use this setting after you change the batch processing
workflow, or after you install Kofax Analytics for Capture.
▪ To run a manual update to Quality metrics, click Load Quality Metric Data Now.
This update is the equivalent of the Operational Data plan, which is available from the
Altosoft Data Loader.
4 When prompted to proceed with the manual update process, click OK.
Running Plans
Data update plans are run hourly, one at a time. While a plan is running, other plans are
prevented from running at the same time. As soon as a plan is finished, another plan can run.
Most often, the plans run automatically and you do not need to monitor their status. If special
circumstances arise, you can use the Data Processing settings to verify the status of plans, and
then manually activate or deactivate them.
1 In the Viewer, click Admin.
2 Click Data Processing.
3 Click Check and then look at the System Status indicator to verify the status of the plans.
▪ If plans are activated and no plan is currently running, the System Status indicator is
green.
▪ If a plan is currently running, the System Status indicator is yellow.
▪ If plans are deactivated, the System Status indicator is red.
4 Depending on the situation, you can do one of the following:
▪ Click Deactivate to stop all plans from running. This action may be appropriate in a
special circumstance where you decide to stop all data processing for a period of time.
▪ Click Activate to resume plan processing at the regularly scheduled intervals,
following a period of plan deactivation.
5 Click Check again to verify the status of the plans.

Removing Data
Use this procedure to remove data from the Insight data database. You can remove data for a
specific date range, remove all data, or remove data that is older than a certain date.
2 Click the Data Processing button.
▪ To delete data for a certain time frame, click the calendar button to set the starting and
ending date and time, click OK, and then click Delete Data for.
▪ To delete all data, click Delete All Data.
4 When prompted to proceed with the data deletion process, click OK.
Deleting Field Data
Field data for the HistoryOfFields table is retained indefinitely unless it is deleted. In a high-
volume processing environment, the number of field data records may increase significantly
over a period of time and potentially become unmanageable. To avoid this issue, you can
delete field data that is older than a certain number of days.
You have two options for deleting field data:

▪ Use the Data Processing settings on the Admin tab to perform a one-time operation that
removes field data older than the number of days you specify.
▪ Use the Altosoft Insight Data Loader to schedule the Delete Old Fields plan to run on a
recurring basis.
Deleting Field Data Manually
Use this procedure to perform a one-time operation that removes field data older than the
number of days you specify.
2 Click the Data Processing button.
3 To delete field data older than a certain number of days, enter the number in the Days
field. The minimum number of days is 30. If you enter fewer than 30 days, the value is
ignored and the default of 30 days is applied.
Using the default value of 30 days, any field data that is 31 days or older is deleted. The
calculation is based on the date a record is received by the Event Listener.
4 Click Delete Fields Older Than. When prompted to proceed with the data deletion
process, click OK.
5 Close the Data Processing window.
Deleting Field Data on a Recurring Basis
Use this procedure to schedule the Delete Old Fields plan to run on a recurring basis.
1 Data older than the number of specified days is deleted when the Delete Old Fields plan
is run. Specify the number of days as described in Deleting Field Data Manually.

2 Start the Altosoft Insight Data Loader.

3 Click the Execution plans tab.
4 On the list of plans, in the row for KAFC 12 - Delete Old Fields, click the ellipsis next to
Manual.
The “Scheduling options” window appears.
5 Select the frequency for running the Delete Old Fields plan, and click OK.
Setting Up Alerts
On the Admin tab, you can set up and manage email notifications to be sent automatically
if certain conditions occur. For example, if Service Level Agreements are not met because
processing takes longer than expected, you can set up a notification alert to send to a list of
email recipients.
You specify which metrics or records to monitor, such as User Session Over Target, History of
Batch (WaitingSeconds field), or Waiting Time in Queue for batches not yet in the queue, or
other.
Setting up alerts is a two-part process:

▪ Setting up the email server
▪ Defining the alert conditions and recipients
Setting Up the Email Server

Use Altosoft Insight to configure the email server for sending notification alerts via email.
1 Start Altosoft Insight Admin.
2 In the navigation panel, click Options, and then go to the E-mail Settings section.
3 Select the Enable SSL check box if security is enabled with an SSL certificate.
4 Select the Use authentication check box if your email server requires authentication for
sending email messages.
5 Select the Send E-Mail at alert check box to send an email when the alert conditions are
met.
6 Enter the server name and port used for outgoing email, along with the user name and
password for the sender.
7 In “Administrator e-mail,” enter the email address that should be used for the sender. If
alert recipients reply to an email message, replies will be sent to the Administrator email
address.
8 In License notification e-mail, optionally enter the email address for the person who
should be notified if the number of Altosoft Insight users exceeds the number specified in
the product license.
9 In Viewer URL, type the web address for the viewer.
10 Click “Send test” to verify that the email settings are valid.
The “Send test email” window appears.
11 In the E-mail field, type an email address where the test message should be sent, and
click Send test.
If the test is successful, the intended recipient receives the test message.

12 Click Save.
13 In the navigation panel, click Distribution.
14 In the “Alerts distribution options” section, do the following:
▪ Set the time interval that determines how often alerts are distributed
▪ Select the KAFC12 check box to ensure that alerts are associated with the current
Kofax Analytics for Capture project.
15 When prompted to do so, restart IIS.
16 Click Save.
Defining Alert Conditions and Recipients

Use the Admin tab in the Viewer to set up record or metric alerts.
1 On the Viewer menu, click the Admin tab.
2 In the Alert Settings group, click one of the following.
▪ New metric alert: Use this setting to associate an alert with a metric.
▪ New record alert: Use this setting to associate an alert with a record.
The alert window appears.
Note If necessary, see Records and Metrics to determine if you need a record alert or a
metric alert.
3 In the alert window, click the Alert Properties tab.

a Title: Type the title to use as the subject of the email notification, such as Batch Export
is Late.
b Severity: Assign a severity to indicate how serious the issue is.
c Description: Enter an optional description.
d Check for alerts every: Enter settings to indicate how often and when the existence of
the conditions should be checked.
Note To ensure that the alert is sent successfully, we recommend that you set
“Check for alerts every” to 1 hour, starting from a 30-minute interval such as 12:30
AM; and then select the “Check backward” check box and set it to at least 2 hours.
4 Click the Condition tab.

For Record Alerts:
a Use the Record list to select the record to monitor.
The Parameter list is refreshed.
b Select “Send record data by e-mail” to include the information in the notification
message.
c Select a parameter, click in the Condition column, and select an operator, such as
WaitingSeconds and =.
d Select a value to monitor, such as 360.
For Metric Alerts:
a Use the Metric list to select the metric to monitor, such as Waiting Time in Queue.

b On the Interval list, select the interval to compare to, including a previous interval.
c On the “Broken by” list, you can select a dimension to break down or refine the data
further.
d Select an operator and margin, such as more than 80 percent.
e In the Comparison section, indicate whether the metric should be compared to a fixed
value, another metric, or the same metric from a different time period.
5 Click the “Do not send” tab.
Use the settings on this tab to define situations in which the alert is not sent, even though
the requirements for the alert are met. For example, you may decide not to issue an alert
in the following situations:
▪ The same alert was previously issued within a recent time period that you specify
▪ The same alert was previously issued and is still unresolved
▪ The same alert was previously issued
Note The meaning of “same” is important. For a Metric alert, the “same” alert is
defined against the same metrics and the same value in the “Broken by” field. For a
Record alert, the “same” alert is based on the same record with the same Parameters
selected.
6 Click the Delivery tab.

a In the “Deliver alert message to” section, list the roles and email addresses for the
intended recipients.
b In the “Alert message escalation” section, list the roles and email addresses for
recipients to notify if the situation is not resolved within a certain time frame, which
you define.
7 Click OK.
The new alert is added to the Alerts list on the Admin tab.
Viewing Station Information

On the Admin tab, you can view a listing of all workstations in your installation. For each
workstation, the list gives the station ID, site name, and version numbers for Kofax Capture,
Kofax Transformation Modules, and the Workflow Agent.
Based on this information, an administrator can easily identify workstations that may require
updates to support the current Kofax Analytics for Capture features.
2 In the Station Information group, review the following details for each workstation:
▪ StationId: Lists the ID associated with the workstation.
▪ Site: Lists the site ID for the workstation location.
▪ KCVersion: Lists the currently installed version of Kofax Capture.
▪ KTMVersion: Lists the currently installed version of Kofax Transformation Modules.
▪ WFAVersion: Lists the currently installed version of the Workflow Agent (or Event
Sender).

Reports
This section gives information about the reports that are available in Kofax Analytics for
Capture.
Classification and Recognition Reports

This section describes Classification and Recognition report types.
Classification versus Review

This report provides visibility to the classified document type assigned to each image in
Kofax Transformation Modules, versus the document type assigned after review. Each
image in the batch includes the system-assigned classification confidence score and the top
classification threshold setting for the corresponding document type.
Data Source Updates

Kofax Transformation Modules-only Real Time
BatchClassification/DocClassification and BatchReview/DocReview
Reclassified Document Types

This report provides visibility to the most common document types requiring reviewer
reclassification in Kofax Transformation Modules. The report also shows the incorrect
document types assigned by the system for each reclassified document type in descending
rank order. The report helps identify document types that may need a sample image set
change.
Data Source Updates

Kofax Transformation Modules-only Real Time
BatchClassification/DocClassification and BatchReview/DocReview
Field Accuracy
This report provides a summary of field level and character level accuracy per batch during
a given date/time period. The field or character level recognition accuracy is measured
by comparing the number of fields or characters that are confidently recognized to the
total number of fields or characters recognized. The field or character level validation (or
completion) accuracy is measured by comparing the number of fields or characters changed
during validation (or completion) to the total numbers of fields or characters recognized and
validated (or completed). The report assumes that any manual changes to the recognized
fields are correct.
Note This report considers the number of changed fields, rather than the number of times
a particular field is changed. For example, if the same field is changed in two separate
modules, it is reported as one changed field. Also, the number of changed characters for a
field is reported only for the module where the most recent changes occurred; the number
of changed characters is not cumulative for all modules.

Data Source Updates

ScalarField and MultivalueField Hourly
Field Confidence
This report provides a summary of field level confidence, based on the results of the
Recognition module. The results are summarized per batch class, form type and overall for a
particular index field.
Data Source Updates

ScalarField and MultivalueField joined to Batch, Document, and Hourly
BatchRecognition
Workflow Management
This section describes the report on the Workflow Management reports menu.
Operator Productivity Summary

This report provides a quick overview of the number of batches and documents an operator
processes in a given date/time period as well as the time the operator spends processing
batches and documents in the same period. This report is the high level summary of the other
operator productivity reports.
Data Source Updates

UserBatchModuleInfo, UserSessionDocsPagesTotal Hourly


Chapter 6
Dashboard Designer
The Dashboard Designer is a browser-based design tool used to create custom views. This
tool offers many components to help you build an effective and comprehensive review of
your Viewer system. Use the Dashboard Designer to:
▪ Reuse and combine dashboard components to display content in a variety of views.
▪ Filter, aggregate or animate charts and grids to respond to data displayed in other charts.
▪ Customize templates to create specific user interactions and reports.
Important The views provided with Kofax Analytics for Capture are based on values
that come from predefined Kofax records and metrics. When designing custom views, do
not modify the predefined views, records, or metrics that come with the product. Instead,
copy a predefined view, save it with a different name, and then modify the components
as necessary.
For detailed information about the Dashboard Designer features, use the Altosoft Insight 5.1 -
Dashboard Guide.pdf, located in the Documentation folder where Altosoft Insight is installed.
Accessing the Dashboard Designer

You access Dashboard Designer by starting Altosoft Studio.
1 To access Dashboard Designer, do one of the following:
▪ Navigate to Altosoft > Studio.
▪ In a browser, enter the following URL:
http://localhost/Insight/Studio
Be sure to verify that the website's binding host name is set to blank or localhost in your
IIS settings. Otherwise, a login error may occur.
2 Enter the login credentials for Altosoft Studio. Use the Altosoft Insight Administration
settings to define settings such as user passwords.
Note If you are logging in for the first time, the default log in is Administrator. The
default password is password. See Managing Users and Roles for more information.
Adding a New View

Use this procedure to create a new, empty view.
1 After starting Altosoft Studio, go to the Guide panel and select item 5, Design
dashboards > Add new view.
The New View window appears.
2 Assign a name to the new view and click OK.

Dashboard Designer
The new view appears on the canvas.

3 Use the Dashboard Designer to design the view based on Kofax records and metrics.
For detailed information about working with Dashboard Designer, use the Altosoft
Insight 5.1 - Dashboard Guide.pdf, located in the Documentation folder where Altosoft
Insight is installed.
Copying an Existing View

Use this procedure to add a view based on a view that already exists. This procedure is useful
for creating views based on the predefined, built-in Kofax Analytics for Capture views, which
cannot be edited.
1 In Altosoft Studio, in the navigation panel, click and expand Views.
2 Right-click the name of the view to copy, and then select Copy.
3 In the navigation panel on the Views list, click the location where you want the new view
to appear, and then right-click and select Paste.
The New View Window appears.
4 Assign a name to the new view and click OK.
The new view appears on the canvas.
5 Use the Dashboard Designer to update the newly created view.
For detailed information about working with Dashboard Designer, use the Altosoft
Insight 5.1 - Dashboard Guide.pdf, located in the Documentation folder where Altosoft
Insight is installed.
Records and Metrics

The predefined views provided with Kofax Analytics for Capture are based on values that
come from Kofax records and metrics described in this section. You can use the same records
and metrics to create custom views.
When adding custom views, do not modify the predefined views, records, or metrics that
come with the product. Instead, copy a predefined view, save it with a different name, and
then modify the components as necessary.
Metrics are aggregations of records usually in the form of a count, sum, or average.
Main Data Records
Record Description
History of Batch Contains one record per each session in which a
batch was involved.
History of Document Contains one record per session in which a
document was changed and always the final
session.
History of Field Contains one record per session in which a field
was changed and always the final session.
History of Page Contains one record per session in which a page
was changed and always the final session.

Dashboard Designer
Record Description
Last Version of Batch State of a batch after the last known session.
Last Version of Document State of a document after the last known session.
Last Version of Page State of a page after the last known session.
Special Event Records
Record Description
Deleted Page Contains one record for each deleted page.
Additional Records
Record Description
Module Operator Contains operator for the currently opened
module.
Module Cost Contains record of hourly costs per module.
Module Target Time Contains record per combination of batch class
and module defining the target time.
User Session over Target Lists sessions that exceeded target processing
time, per module.
Station Info Lists in real time all sites and workstations within
the Kofax Analytics for Capture installation,
including the station ID, site name, and version
numbers for Kofax Capture, Kofax Transformation
Modules, and the Workflow Agent.
Operation Metrics
Metric Description
Avg Min Max Session Time Lists the average, minimum, and maximum
session time.
Avg Time per Page Lists the average session time per page.
Avg Time per Document Lists the average session time per document.
Batch Next Queue Count Lists a count of sessions by Next Queue (mapped
to the Module dimension of the metric) that are in
the Ready state.
Count of Batch Rejections Lists the number of batch rejections.
Count of Batches Created Lists the number of created batches.
Count of Document Rejections Lists the number of document rejections.
Count of Documents Sessions Lists the number of documents through all
sessions.
Count of Page Rejections Lists the number of page rejections.

Dashboard Designer
Metric Description
Count of User Sessions over Target Lists the number of user sessions in which the
Processing Time exceeds the standard processing
time for a module (if defined).
Distinct Batches Number of distinct batches in a given set of
sessions.
Distinct Modules Number of distinct modules in a given set of
sessions.
Latency Histogram Lists (in seconds) the time period between start of
a session processed by an Operator and an end
of a previous session.
Module Operator Count Lists a count of Module Operator records.
Module Total Costs Cost of module processing, calculated by
multiplication of hours of total processing of
batches in a given module by the standard hourly
cost for the module specified by user (default
value is 20).
Processing Time per Batch Lists the Session Time divided by the number of
distinct batches.
Processing Time per Module Lists the Session Time divided by the number of
distinct modules.
Session Time Lists the total time of all sessions.
Session Time in Hours Lists the value of the Session Time (in seconds)
divided by 3600.
Total Batch Time Lists the total batch time from creation to export,
including batches that did not finish processing.
Classification Metrics
Metric Description
Avg Doc Confidence Lists the average document confidence.
Count of Classifications 2 Lists the number of classifications.
Count of Documents Lists the number of distinct documents.
Count of Finished Documents Lists the number of finished documents.
Count of Finished Field Documents Lists the count of distinct documents using a
specific field.
Count of Processed Documents Lists the number of processed documents that
included at least one change.
Count of Reclassifications Lists the number of reclassifications.
Count of ReOrClassifications Lists the number of classifications and the number
of reclassifications.
Doc Classification Ratio Lists the ratio of fields changed by an operator to
the number of all fields.
Doc No Change Ratio Lists the ratio of all distinct documents to the
number of documents that do not have any fields
changed.
Docs Untouched Ratio Lists the number of fields in completed batches.

Dashboard Designer
Queue Metrics
Metric Description
Current Queue Lists the number of batches currently in the
queue.
Current Queue Doc Count Lists the number of documents currently in the
queue.
Current Queue Page Count Lists the number of pages currently in the queue.
Historic Queue Hourly count of batches in the queue.
Hourly Queue Lists the number of batches in the queue per
module at the end of each hour.
Waiting Time in Queue Lists the waiting time for batches currently in the
queue.
Waiting Time in Queue Historic Lists the maximum time a batch spent in a queue
waiting for a module.
Recognition Metrics
Metric Description
Avg Field Confidence Lists the average field confidence.
Change Fields Ratio for Operator Lists the ratio of fields changed by a certain
Operator to the number of all field changes.
Changed Field Changed Characters Lists the number of characters that changed in a
particular field. Reserved for future use.
Changed Field Total Characters Lists the number of characters in a changed field.
Reserved for future use.
Count of Fields Processed Lists the number of fields changed by an operator.
Field Change Ratio Lists the ratio of fields changed by an operator to
the number of all fields.
Fields Finished Lists the number of fields finished in the
completed batches.
Fields Finished Changed Lists the number of finished fields that were
manually changed.
Fields Finished ChChars Lists the number of finished fields with characters
that changed.
Fields Finished ChFldChars Lists the number of characters for the changed,
finished fields.
Fields Finished Confidence Lists the average confidence for the finished
fields.
Fields Finished Recognized Lists the average confidence for the finished fields
that were recognized (the value of the field was
changed by an automatic module).
Fields Finished Validated Lists the count of finished fields that were
validated (by passing one of the validation
modules).

Dashboard Designer
Metric Description
Finished Field Changed Ratio Lists the ratio of changed fields to the number of
all fields, including those in deleted and exported
batches.
Sharing Your Dashboard Views with the Public

Each component or View has a unique URL address. You can share the URL with external
parties.
To retrieve the URL of a Component, right-click the component (including View Holder) and
select Get link.
To retrieve the URL of a View, right-click the name of the View listed in the navigation panel
and select Get link.
Views have two URL addresses, as follows:

▪ URL with an Open In Viewer button: Use this URL to display a View in a new browser
window.
▪ URL to the SharePoint address with a Copy button: Use this URL to distribute to others
using SharePoint.
Note Accessing a View directly via a URL does not bypass security. Users are authenticated
as if they accessed the View via the standard URL for Insight Viewer.

Appendix A
Configuration File
This appendix gives information about the elements in the Kofax Analytics for Capture
configuration file, KA4CConfig.xml, which is located here:
[Kofax Capture Server]\CaptureSV\Config\KA4CConfig.xml
Unless noted otherwise in the following table, changes to settings in KC4CConfig.xml do not
go into effect until a batch class is published.
For information about using KA4CConfig.xml to configure the Event Listener in a High
Availability environment, see Event Listener Failover and High Availability.
KA4CConfig.xml
Element Description
BasicAuthentication Not in use.
BasicAuthenticationPassword Not in use.
BasicAuthenticationUser Not in use.
DebugLogging true = On
false = Off (Default)
When On, logs debugging information to the
Workflow Agent log file, which is typically available
here:
c:\ProgramData\Kofax\CaptureSV\logs
\Kofax Analytics\machinename_yymm.txt
The log file size is not limited.
If you update the DebugLogging value, it takes
effect immediately. The value is case-sensitive
and must be lowercase.
DisableSendingFromRemoteSite true = On
When Off, sends data directly from the remote site
to the Event Listener. This setting is useful if you
expect to split batches at remote sites.
When On, sends event data only at the central
site. If you have an occasionally connected or
low bandwidth environment, this setting prevents
additional connections from remote sites. This
setting is also appropriate if you intend to run
Kofax Capture Network Server in offline mode.
The value is case-sensitive and must be
lowercase.

Configuration File
Element Description
RetryAllModules true = On
false = Off (Default): Attempts to send session
data to the Event Listener are retried only for
the module that precedes Export in the batch
processing workflow.
When On, failed attempts to send session data to
the Event Listener are retried for any module in
the batch processing workflow.
In a High Availability environment, this value
should be set to “true” (or On).
lowercase.
MaxRetriesFileContention 10 = Default
Maximum number of retries made to create the
log file. Once the maximum is reached and the
number of retry seconds has elapsed without
success, an exception occurs and the batch is
sent to Quality Control.
RetrySecondsFileSystem 0 = Default
Expressed in seconds, this value is the total
amount of time spent in attempting to write to the
log file. If contention is high, such as in a busy
system with <DebugLogging> enabled, it may be
useful to set a non-zero value.
If both <MaxRetriesFileContention> and
<RetrySecondsFileSystem> are set to non-zero
values, retries continue until the maximum number
of retries is attempted and the number of retry
seconds has elapsed.

Configuration File
Element Description
MaxRetriesWebService 10 = Default
General description:
Maximum number of retries made by the Workflow
Agent to send session data to the Event Listener
when Export is the next module in the batch
processing workflow. Once the maximum is
reached and the number of retry seconds has
elapsed without success, the exception handling
is determined by the <SendBatchToQCOnError>
element, which is the same as the setting
configured on the Analytics tab in the Kofax
Capture Administration module. For details, see
Configuring the Event Sender.
If Export is not the next module in the batch
processing workflow, only one attempt is made to
send the session data; after one failed attempt,
the data is stored in the batch custom storage
string and sent later to the Event Listener.
When <RetryAllModules> is set to true (or On),
this description applies:
Maximum number of retries made by the Workflow
Agent to send session data to the Event Listener
for any module in the batch processing workflow.
Once the maximum is reached and the
number of retry seconds has elapsed without
success, the data is cached internally in
custom storage strings. If Export is the next
module in the batch processing workflow, the
<SendBatchToQCOnError> value is used to
determine if the batch is routed to Quality Control.
RetrySecondsWebService 0 = Default
In a High Availability environment, this value
(expressed in seconds) should exceed the
expected length of time for failover to occur.
If both <MaxRetriesWebService> and
<RetrySecondsWebService> are set, retries
continue until the maximum number of retries is
attempted and the number of retry seconds has
elapsed.
Password Encrypted password for user who is accessing the
Event Listener.
RequestTimeoutSeconds Maximum time interval (expressed in seconds)
that a connection can remain inactive without
being dropped if no data is received from the
application; or, the maximum time interval for a
write operation to complete without raising an
exception.
ServicePath Web application path for the Event Listener.

Configuration File
Element Description
SendBatchToQCOnError true = On
When On, if Export is the next module in the
batch processing workflow, batches are routed
to Quality Control after all retries fail to send
session data to the Event Listener, as determined
by the values for <MaxRetriesWebService> and
<RetrySecondsWebService>.
When Off, if Export is the next module in the
batch processing workflow, after all retries fail
to send session data to the Event Listener, the
batch is routed to the Export module and the
cached session data is lost upon batch export.
In this case, the batch processing workflow is
not affected. The number of retries is determined
by the values for <MaxRetriesWebService> and
<RetrySecondsWebService>.
The default setting (false) is the same as not
selecting the “Send batch to Quality Control on
error before Export” check box on the Analytics
tab in the Kofax Capture Administration module.
lowercase.
Url URL for the server hosting the Event Listener web
application.
Username Username for accessing the Event Listener.
Event Listener Failover and High Availability

When an installation includes multiple instances of the Event Listener and one instance
stops working, the other active instances are available to take over the work from the failed
Listener. In this situation, a short delay occurs before the other active instances take over.
During the delay, the Workflow Agents attempt to send session data as each batch is routed
to the next queue. Once all retries fail, the session data is cached internally in custom storage
strings. As a result, many custom storage strings can potentially be created. To avoid
this situation, you can configure retries that apply to any module in the batch processing
workflow, along with the amount of time to elapse for all retries. (By default, retries are
attempted only for the module that precedes Export in the batch processing workflow.)
The amount of time spent on retries should exceed the time required for the active instances
of the Event Listener to take over when one instance stops working. You can use the
following elements to configure the retries:
▪ RetryAllModules
▪ RetrySecondsWebService
▪ RetrySecondsFileSystem
See the table in the preceding section for a description of these and other elements in
KA4CConfig.xml.

Appendix B
Disaster Recovery
Use the guidelines in this appendix to ensure that your Insight 5 environment for Kofax
Analytics for Capture is configured to support Disaster Recovery.
Insight 5 Environment
The Insight 5 environment consists of:
▪ Set of web applications running under IIS
▪ Windows Service “Insight Scheduler” used for initiating the data load process into Metrics
Mart
▪ Optional set of Windows services or “Insight node” used for in-memory data processing
▪ Set of databases (an administrative database and two databases per project) located on the
same or different DBMS servers
▪ Listener service running under IIS
Note There are no client components to be installed with Insight 5, as users access Insight
via an HTML5 supported browser.
Insight 5 Environment for Kofax Analytics for Capture
Installation Configurations
The DBMS can be installed on the same server as the Insight Server components or on a
separate server. Also A, B, C and D can be installed on the same server or on separate servers.
The Insight 5 installer provides three options:

Disaster Recovery
1 Full Environment: Installs A, B and C on the same server.

2 Insight Scheduler: Installs only Insight Scheduler (B)
3 Node Services: Installs only the Node Services (C)
For Kofax Analytics for Capture, a separate installer is also provided for:
1 Listener Service: A Web Service (E) that can be installed on any IIS server. The Listener
service is independent of the Insight Web applications.
An important consideration for Disaster Recovery configurations is that the Insight Scheduler
is the only component that actually writes data into Metrics Mart. Other components only
read data from Metrics Mart. As a result, only one active Insight Scheduler service per project
is required.
Disaster Recovery Guidelines

You can implement the Disaster Recovery mechanism using an Active/Passive setup with a
clustered database.
You must install two Insight environments: one Active and one Passive. Both must be
connected to the same databases.
Important The Insight Scheduler Service in the Passive environment must be disabled.
Only one Scheduler Service should be running at any given time.
Set the router to route all incoming requests to the Active environment. If the Active
environment becomes unavailable, switch the router to the Passive environment, where
you also enable the Scheduler Service. Also, verify that the Scheduler Service on the failed
environment is no longer running.
Note When installing the same project in multiple environments, make sure the
property "Scheduler host" in each project copy points to the Scheduler Service for its own
environment. The default option is localhost, which is appropriate if the Scheduler Service
and web applications are installed on the same server.

Disaster Recovery
Performance Considerations
The overall performance of the Insight environment is largely determined by the performance
of the DBMS. Contact your database administrator for DBMS for information about resource
allocation, clustering options, and custom database indexing.
Reactivating Plans After a Failure

Although minimal intervention is required when operations resume after a failure, you may
need to manually restart data update plans if they become deactivated.
To confirm whether data update plans need to be reactivated, use the Data Processing - Check
setting on the Admin tab to check the status:
▪ If the System Status indicator is red, all plans are deactivated. Click Activate to resume
plan processing at the regularly scheduled intervals.
▪ If the System Status indicator is green or yellow, no action is necessary. See Running Plans.

Disaster Recovery

Index
A E
access rights, 41 error handling, 31
Admin tab, Event Listener,
Kofax Analytics for Capture, 84 installing, 28
alerts, 87 server, 12
Altosoft Insight, Event Sender,
administration, 39 configuring, 31
documentation, 7 installing, 31
installing, 22 export to Excel, 53
server, 13
F
B
failover, 99
batch class list, 52 Field Accuracy report, 90
batch history, 58 Field Confidence report, 90
Batch Overview, 57 field data deletion, 86
Batches & Docs views, filter queries, 41
Batch Search, 64 filtering data, 84
Deleted Batches and Pages, 66 Filters tab, 41
Doc Search, 65
Error Batches, 67
Rejections, 68 G
Getting help, 7
C
Classification and Recognition reports, 90 H
configuration file, 99 hardware requirements, 11
configuring project, 26 Help for Kofax products, 7
Connections tab, 41 History, batch, 58
HistoryOfFields table, 86
D
dashboard, I
client, 18 IIS,
introduction, 9 configuring, 14
sharing, 98 IIS 7, 15
Dashboard Designer, 93 IIS 8, 15
accessing, 93 settings, 15
Studio, 93 installation,
data deletion, 86 Altosoft Insight, 22
data filtering, 84 Event Listener, 28
Data Processing settings, 84 Event Sender, 31
database, Kofax Analytics for Capture, 21
driver, 16 upgrading from previous version, 33
servers, 13
database configuration, 23
databases, 21 K
deployment scenarios,
distributed, 11 KA4CConfig.xml, 99
standalone, 11 Kofax Transformation Modules,
disaster recovery, 103 field synchronization with Kofax Capture, 31
documentation, 7

Index
L records and metrics, 94

refresh interval, 52
Labor views, release notes, 7
Labor Costs, 71 reports,
Operator Benchmark, 74 overview, 90
Operator Performance, 74 retries, configurable, 99
Operator Time, 69 roles,
Session Time, 72 creating, 40
Sessions Over Time, 73
language selection, 50
license, activating, 25 S
servers, 11
M service level agreement alerts, 87
SSL, 21
metadata repository, 16 staging database, 22
metrics, 94 station information, 89
metrics update, Support site, 7
manual, 84 system requirements, 11
O T
Operations views, Training, 7
Breakdowns, 59
Overview, 54
Process Latency, 62 U
Trending and Stats, 60 upgrade procedure, 33
Operator Productivity Summary report, 91 user authentication, 41
Oracle, users,
requirements, 17 assigning, 41
user privileges, 17 creating, 39
users and roles, 39
P
post-installation results, 24 V
prerequisites, 14 Viewer,
product overview, 9 introduction, 49
project, opening, 49
exporting, 47 screen layout, 51
importing, 46 using, 52
project configuration, 26 views, 53
Batches & Docs, 64
Q Labor, 69
Operations, 54
quality metrics, 85 overview, 9
Quality views, Quality, 75
Classification, 76
Classification Chart, 77
excluding deleted batches, 75 W
Extraction, 78 Web server, 14
Extraction Chart, 79 Windows authentication,
Field Extraction Benchmark, 82 and database access, 18
No Touch Processing, 81 configuring, 19
Separations, 80 Workflow Agent,
configuring, 31
R installing, 31
Workflow Management reports, 91
Reclassified Document Types report, 90

KAnalytics

Transféré par

Informations du document

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

KAnalytics

Transféré par

Droits d'auteur :

Formats disponibles

Kofax Analytics for

Third-party software is copyrighted and licensed from Kofax’s suppliers.

This product is protected by U.S. Patent No. 6,370,277.

THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF KOFAX,

DOCUMENTATION IS PROVIDED “AS IS” AND ALL EXPRESS OR IMPLIED CONDITIONS,

Kofax Analytics for Capture Administrator's Guide 3

Upgrading to Kofax Analytics for Capture 1.2.0 ..................................................................................................... 33

4 Kofax Analytics for Capture Administrator's Guide

Copying an Existing View ...................................................................................................................................... 94

Kofax Analytics for Capture Administrator's Guide 5

6 Kofax Analytics for Capture Administrator's Guide

Getting Help for Kofax Products

The Kofax support page provides:

Kofax Analytics for Capture Administrator's Guide 7

▪ Access to support tools.

8 Kofax Analytics for Capture Administrator's Guide

Batches & Docs Views

Kofax Analytics for Capture Administrator's Guide 9

10 Kofax Analytics for Capture Administrator's Guide

This section describes two typical deployment scenarios:

Kofax Analytics for Capture Administrator's Guide 11

Event Listener Server

12 Kofax Analytics for Capture Administrator's Guide

Data Database Server

As a point of reference, the Data database is typically hosted on a high-performing server,

Kofax Analytics for Capture Administrator's Guide 13

Staging Database Server

IIS Web Server

14 Kofax Analytics for Capture Administrator's Guide

6 In Server Manager, under Roles Summary, click Web Server (IIS).

Common HTTP Features:

Health and Diagnostics

Common HTTP Features:

Kofax Analytics for Capture Administrator's Guide 15

Under WCF Services for the .NET 4.5 Framework

16 Kofax Analytics for Capture Administrator's Guide

Database Client Software Requirements

Tablespace Usage Information

Sample create tablespace statement:

Creating User Privileges

Kofax Analytics for Capture Administrator's Guide 17

Sample create user and grant statement:

18 Kofax Analytics for Capture Administrator's Guide

Configuring Insight for Windows Authentication

Kofax Analytics for Capture Administrator's Guide 19

20 Kofax Analytics for Capture Administrator's Guide

Installing Kofax Analytics for Capture

Component Required File

Kofax Analytics for Capture Administrator's Guide 21

Creating the Staging Database

Installing Kofax Altosoft Insight

22 Kofax Analytics for Capture Administrator's Guide

Configuring the Database

Kofax Analytics for Capture Administrator's Guide 23

Installation Manager - IIS Application Pool Settings Screen

The Installation Details screen appears.

24 Kofax Analytics for Capture Administrator's Guide

Here is a summary of the items in the Altosoft program folder:

Activating the License

Kofax Analytics for Capture Administrator's Guide 25

Configuring Your Project

26 Kofax Analytics for Capture Administrator's Guide

Kofax Analytics for Capture Administrator's Guide 27

Installing the Event Listener