Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 1
Module 10Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Slide 1
Slide 2 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Advanced Batch Class Properties, Database
Validation and Export, Batch
Manager
• Advanced Batch Class Properties
• Database Validation setup
• Export Connector – Database
• Batch Manager
• Batch class Update
Slide 3 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Advanced Batch Class Properties
• Partial Batch Export
• Sorting options
• eDocuments
• File import conversion
• Re-scanning options
• Color cleanup options
• Single document processing and routing
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 2
Slide 4 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Partial Batch Export
Select from the list of queuesProblem documents/pages will
be flagged for later processing, good documents
and pages continue processing through Export
Slide 5 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Sorting Options
Select a queue where sorting of documents will start
Slide 6 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
eDocument Import
If checked, BMP, PCX, JPEG and CALS files will not be converted to single page TIFF
If checked, allows importing files of almost any format
If checked, imported PDF files will be
converted to single page TIFF files
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 3
Slide 7 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Additional Advanced Options
Rubber Band OCR sets up on-the-fly optical
recognition
Other options apply at the batch class level and can be set here
including the behavior for validation, rescan, color image cleanup, table
field delimiters, and the internal image storage (when other than the
standard TIFF format is required)
Slide 8 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Single Document Processing
Slide 9 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Single Document Processing Operation
• Automatically recognize and separate scanned documents into single-document batches for individual document processing.
• Must use a Scan-time separation method.
• Accelerates the capture process and delivery of business-critical documents.
• A batch of multiple documents is scanned and separated at scan time resulting in single-document batches.
ExportScan
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 4
Slide 10 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Single Document Routing
•Single document routing -- The ability to route single document batches to groups, individuals, and/or locations to improve capture processing.
•A workflow agent is required to dynamically route the batches (we’ll discuss these in a later module).
ExportAt close of Recognition Server, the workflow agent
redirects the batches
Scan
Validation
Life PoliciesValidation
Auto Policies
Slide 11 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Database Validation
• Any ODBC compliant database may be used to provide data from tables and columns to be entered into index fields
• The setup is done on a document class level
• A database is selected, read access is required
• A field value is used to provide the key match (foreign key)
• A table is selected in the database for data retrieval
• A column is selected from the table to match the foreign key value from the Kofax Capture field
• Trigger timing is set
• Multiple match behavior is set
Data populates fields
Slide 12 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Document Class – Select Database Validation
Right mouse click on the document class and select “Database
Validation” or click on the Database Validation icon in the ribbon.
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 5
Slide 13 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Add a Setup
Click [Add]
Slide 14 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Selecting the Database
Workgroup file name, User name and Password may be entered if
required to log into the database –read access is required
Select the database type (Access or
ODBC compliant)
Browse to locate the database
Slide 15 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Foreign Key Mapping
An index field, table and column must be selected to
make a foreign key connection between Kofax Capture and
the database.
When a Table is selected, the columns are displayed
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 6
Slide 16 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Field Mapping
Click on the fly-out menu and select a field to receive the
data
Slide 17 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Complete Field Mapping
Not all fields need to be mapped
Slide 18 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Options – Trigger Timing
Trigger timing creates the event that will launch the
database lookup
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 7
Slide 19 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Trigger Timing
• Document Pre Process• Happens before the document is displayed
• Field Pre Process• Happens before the operator processes the field
• Field Post Process• Happens after the operator presses the termination key ([Tab] or
[Enter])
• Document Post Processing• Happens when the document is closing
• Script driven• Define a script to control the timing
Slide 20 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Options –Match Behavior and Advanced
Select a behavior if no match is found
Select a behavior if multiple matches are found
Check boxes allow for options
Slide 21 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Workstation Caching Options
Each workstation may cache lookup results from a database including the number and time
the results are discarded
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 8
Slide 22 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
KCN Server Options
When using KCNS, remote stations may
connect to the database directly or
through the KCN Server.
Each KCN Service can cache lookup results, which may improve performance when
lookups are repetitive
Slide 23 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Database Validation is Setup -- Multiple Lookups Available
More than one database validation lookup may be setup
Slide 24 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Export Connector -- Database
• Data may be sent to any ODBC compliant database
• Full access to the database is required
• Access is required during export setup
• Field values are linked to a table and column• Batch fields
• Document class index fields
• Folder index fields
• The Database Export Connector in Kofax Capture supports SQL pass-through statements, making data export faster
Data exported to database
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 9
Slide 25 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Select the Export Connector and Add for Setup
Select Export Connectors, and then select the Database Export Connector.
Click [Add]
Slide 26 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Select the Database
Workgroup file name, User name and Password may be entered if
required to log into the database –full access is required
Select the database type (Access or
ODBC compliant)
Browse to locate the database
Slide 27 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Select the Table
Selecting a table lists the columns in the table
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 10
Slide 28 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Index Field Mapping
Select a field and click on the fly-out menu
Slide 29 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Linking a Field Value to a Column
Select a type and select a field
Slide 30 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Linking a Batch Field to a Column
Batch fields are available too
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 11
Slide 31 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Selecting a System Value
System-supplied values may be selected
Slide 32 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Selecting a Text Constant
A text constant value may be
entered
Note: Not all fields in the database need to be populated with data
from Kofax Capture. It is possible to export only a subset of data
into this table.
Slide 33 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Documents Table
The Document ID is the foreign key that ties the Customer Data table to the Documents table.
Document ID is an integer or long integer.
The Documents table needs to be linked to the Customer Data table.
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 12
Slide 34 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Document Storage TIFF, OCR, PDF
Select a Check box and enter or browse to a file
An empty box means no export
Slide 35 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Image Format Selections
Several different output options are available for
setting the format of images when exported
Slide 36 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
A Reminder: Index Fields Not Used
When [OK] is clicked, Kofax Capture will
note any index fields which were not used.
In response, fields can be added in the Table Settings tab or the message can be
ignored.
Click [OK] to save the settings
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 13
Slide 37 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Database Export Connector is Setup
Slide 38 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Multiple Export Connectors
Multiple export allows images, documents, and data to be sent to
multiple file locations or applications with one process at
the conclusion of the Kofax Capture workflow processing
Slide 39 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Using Batch Manager
• Batch Manager is the operations center for Kofax Capture
• Batches in-process are listed
• Clicking on a column heading re-orders the list of batches in-process
• Batches are managed• Create batches
• Process batches
• Review batch history
• Change batch Priority
• Change batch Status
• Route batches – change Queue
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 14
Slide 40 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Batch Manager Icon
Slide 41 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Batch Manager – Batch List
All active batches are displayed.
Simply click on a column heading to reorder the list
based on that attribute.
Slide 42 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Batch Manager – Kofax Button
Left mouse click on the Kofax button to expose the menu items where
batches can be created, processed, deleted,
remote batches recalled, and batch properties viewed
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 15
Slide 43 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Batch Manager – Home Tab
Create and process batches
Create a log or
remove access to batches
Delete batches
Unreject batches
Update batches in process
View batch
properties
Slide 44 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Batch Manager – Remote Tab
Convert this station to a
remote KCNS site
Activate the Remote Synchronization
Agent (RSA) on this remote site
Set the central site server URL, the RSA polling, and the
batch processing polling settings for KCNS activity
Slide 45 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Batch Manager – View Tab
Display status bar and filter
panel
Lock toolbars
and restore defaults
Search batches
Set refresh time
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 16
Slide 46 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Batch Filtering
Check the [Filter Panel] checkbox
to display the filter options
Select the filter criteria
Batches displayed in the batch manager can be specified
through batch filtering options in the Filter Batches panel
Enable filtering
Slide 47 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Specifying Batch Filtering Criteria
Conditions can be set
Slide 48 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Batches are Displayed Based on Filter Options Specified
When the settings are applied, batches will be displayed
based on the conditions and settings specified.
The quantity of filtered batches is displayed in the Status bar
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 17
Slide 49 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Sorting Batches
The order in which batches are displayed can be determined
through setting the sort criteria
Batches can be sorted by clicking on the [Sort] icon in the View tab
Or batches can be sorted by right
clicking on any batch and selecting [Sort]
Select the sort criteria in the desired order and click on [OK]
Slide 50 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Changing Queue, Status, Priority
Changing Queue Changing Status Changing Priority
Slide 51 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Batch Status
• Status
• Ready: Send the batch to the next module (queue)
• Suspend: The batch is in a Temporary hold state
• Error: The batch has a problem that must be cleared before processing can continue
• Reserved: The batch is on hold in that module (queue) until the Status is changed
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 18
Slide 52 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Processing Batches and Viewing Properties
Properties of a batch can also be viewed by right mouse clicking on the batch and
selecting [Properties]
Batches can be processed directly from
Batch Manager by highlighting the batch
and clicking on [Process]
Properties of a batch can be viewed by
clicking on the [Batch Properties] icon in
the Home tab.
Slide 53 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Unreject Batches
• Rejected batches can be unrejected inside the Batch Manager from the Home tab.
• Options are available for unrejecting selected batches only or all rejected batches.
Confirm the operation
Slide 54 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Batch Class Update for Batches In-process
• There are times when batches have been created and something in the batch class is no longer valid.
• The Batch Class Update feature allows the administrator to correct and republish the batch class, and then update the batches in-process with the latest batch class definition.
• For example, you may be validating a batch and realize that you wanted database validation. You can suspend the batch in Validation, add database validation to the batch class in the Administration module, and then apply that change to the batch(es) in-process.
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 19
Slide 55 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Batch Class Update Procedure
• First suspend the batch(es) affected.
• Then make the changes to the batch in the Administration module and publish the batch class. Close the Administration module and return to the Batch Manager.
Slide 56 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Batch Class Update Procedure in Batch Manager
• From the Batch Manager, select one or more batches that are to be updated with the latest version of the source batch class and select [Batch Class Update] from the Home tab.
Confirm the operation
Slide 57 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Batch Class Update Restrictions
• Examples of updated settings include changing field types or redirecting export locations.
• After a successful batch class update, certain batch class changes may not have an effect on selected batches. For example, if the latest batch class included settings that are applied during scanning (such as the Scan Image Cleanup profile), this change will have no effect on the batch since scanning was already completed when the batch was updated with the latest version of the assigned batch class.
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 20
Slide 58 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Batch Class Update Detailed Restrictions
• Batch class updates will not occur if the latest version of a batch class includes:
• Added, removed, or renamed:
• Queues (renaming does not apply)
• Form types
• Folder classes
• Batch fields
• Document or folder index fields
• A changed Total index field setting in the document class
• A deleted export connector used during a partial batch export.
Slide 59 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Partial Batch Export
An “!” Indicates that Partial Batch Export is enabled for
the batch class and a problem page (s) or document (s) is in
the batch
The batch will continue being processed through Export, subsequently it will be sent to Quality Control to “fix” the page (s) or document (s)
A Partial Batch Export scenario is
indicated by a “!” in the “!” column
Slide 60 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Batch Manager Help
This icon launches the Kofax Capture
Help topics
This icon launches the About Kofax Capture screens
Launches Kofax Technical Support
Web pages
Launches Kofax Capture System
Information
Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Technical Training Page 21
Slide 61 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Kofax Capture System Information
Slide 62 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Demonstration
Database validation, partial batch export, database export, multiple export
connectors
Slide 63 Module 10 -- Advanced Batch Class Properties, Database Validation and Export, Batch Manager
Lab
• Database validation
• Partial batch export
• Database export
• Multiple export connectors
Refer to the Kofax Capture 10 Lab and Reference Guide