59
The Administration Module
174
Kofax Capture Administrator's Guide
In addition, each document contains an area in which the customer writes her name,
customer number, and other information. But, because the information is encoded in the
bar code, you want to use the information read from the bar code when you process the
documents with Kofax Capture. For your validation operators, you may want to display the
areas on the form that are filled in by the customer to facilitate validation.
For this example, you can define:
▪ One index field to hold the 60 characters of data encoded in the 2-D bar code. You can
apply the “hidden” attribute to this field so that it does not display for your validation
operators. However, the data is available to your validation script.
▪ Three index fields for the customer’s information (first name, last name, and customer
number). The values for these fields can be parsed from the 2-D bar code with the custom
validation script. The index fields appear for your validation operators at validation time.
Then, draw four zones on your sample page.
▪ Draw one zone around the 2-D bar code, and associate it with the 60-character, hidden
index field. Assign a recognition profile that specifies the appropriate 2-D bar code type.
▪ Draw zones around the areas on the sample page where the customer writes information
(first name, last name, and customer number), and associate each with the appropriate
index field. For this example, clear the “Auto recognition” check box on the Index Zone
window so that no automatic recognition is applied to these zones.
Once your index fields are in place, you can write a custom validation script for your
document class. In the script, add SBL string processing functions to the
KfxDocPreProcess
function to parse the string stored in the hidden index field and copy the field data to the
three index fields to be displayed to your validation operators.
One simple method is shown below, which uses the SBL
GetField
function to parse the
values and copy them to the applicable index fields. In the example, “Customer_Record”
is the hidden index field that holds the value read from the 2-D bar code. “First_Name”,
“Last_Name”, and “Cust_Number” are the index fields to hold the values parsed from the 2-
D bar code. (The example does not show any error handling or necessary initialization.)
KfxFirst_Name = GetField(KfxCustomer_Record,1,"***")
KfxLast_Name = GetField(KfxCustomer_Record,2,"***")
KfxCust_Number = GetField(KfxCustomer_Record,3,"***")
Note that the SBL compiler requires that all variables and functions be declared before
they are used. Therefore, to process index fields in the
KfxDocPreProcess
function,
you must make certain that the variables for those index fields are declared before the
KfxDocPreProcess
function definition. The best place to put the declarations is right before
the
KfxLoadValidation
function definition. For the above example, add the following
declarations right before
KfxLoadValidation
function definition:
Global KfxFirst_Name As String
Global KfxLast_Name As String
Global KfxCust_Number As String
Global KfxCustomer_Record As String
Tip When you create a validation script, Kofax Capture automatically adds global variable
declarations for each defined index field. If you add your own global variables for index
fields, you must search for the global variables added by Kofax Capture and comment them
out or delete them. The declarations added by Kofax Capture is interspersed throughout the
script.
55
The Administration Module
Kofax Capture Administrator's Guide
175
The easiest way to locate the declarations is to use the SBL Find window. To display this
window, select Edit | Find from the SBL menu bar. Be sure to use the Up and Down buttons
to perform a complete search.
VB.NET Solution
The solution to parse the string data from the bar code can be done with a validation script
written in VB.NET. As explained in the SBL solution, you will define an index field to hold
the customer information encoded in the 2-D bar code, and three index fields for the customer
information (first name, last name, and customer number). To parse the data string, you add
the processing event as shown in the example that follows.
When you create a validation script with VB.NET, certain variable declarations are
automatically generated. The following field variables are generated when you create your
VB.NET project from the Scripts menu of the Administration module.
<IndexFieldVariableAttribute("Customer_Record")> _
Dim WithEvents Customer_Record As FieldScript
<IndexFieldVariableAttribute("First_Name")> _
Dim WithEvents First_Name As FieldScript
<IndexFieldVariableAttribute("Last_Name")> _
Dim WithEvents Last_Name As FieldScript
<IndexFieldVariableAttribute("Cust_Number")> _
Dim WithEvents Cust_Number As FieldScript
Now, you will want to add the processing that parses the string data to individual values.
From your VB.NET code editor, select the
DocumentPreProcessing
event from the
Declarations
list. The following
Private Sub
definition is generated:
Private Sub SampleDC2_DocumentPreProcessing(ByVal Param As Object, _
ByVal Param1 As Kofax.AscentCapture.Scripting.PreDocumentEventArgs) _
Handles Me.DocumentPreProcessing
End Sub
Add the following custom code within the
Private Sub
block to perform the data string
parsing:
'*** This sub will extract the first name, last name, and customer
'*** number from a string similar to "John***Smith***1234***"
'*** The string we want to parse into an array.
Dim oDelimiterArray As String() = {"***"}
'*** Split on "***"
Dim oCustomerRecordArray As String()
oCustomerRecordArray = Customer_Record.IndexField.Value.Split( _
oDelimiterArray, StringSplitOptions.RemoveEmptyEntries)
'*** The customer's first name is stored first (index 0)
First_Name.IndexField.Value = oCustomerRecordArray(0)
'*** The customer's last name is stored second (index 1)
Last_Name.IndexField.Value = oCustomerRecordArray(1)
'*** The customer's number is stored last (index 2)
Cust_Number.IndexField.Value = oCustomerRecordArray(2)
Compile and save your validation script. Republish the batch class associated with the
validation script.
35
The Administration Module
176
Kofax Capture Administrator's Guide
Turning off the Enhanced Bar Code Engine
The Enhanced Bar Code Engine is selected by default and used if proper licensing is in place
for bar code recognition operations. However, in some cases, you may want to turn it off. For
example, you may be processing one-dimensional bar codes from good quality bitonal images
and achieve better performance with the Standard Bar Code Engine.
You can turn off the Enhanced Bar Code Engine for a recognition profile. This causes the
Standard Bar Code Engine to be used for all processing that uses that recognition profile.
Note Once you turn off the Enhanced Bar Code Engine for a recognition profile, the Standard
Bar Code Engine is used for all processing that uses that profile. This is true even if the
licensing for the Enhanced Bar Code Engine is in place.
1 On the Recognition Profiles window, select the bar code recognition profile that uses the
Enhanced Bar Code Engine.
2 Click Advanced.
The Advanced Bar Code Settings window for the selected recognition profile appears.
3 Clear the “Use enhanced engine if licensed” check box.
Tip Once you clear the “Use enhanced engine if licensed” check box, any 2-D bar
code types previously selected on the General tab become cleared. Before you save
the recognition profile, you should carefully review the selected bar code types on the
General tab to ensure they are appropriate for your processing needs.
4 Click OK.
5 Click Save to save the selected recognition profile. Or, click Save As to save the selected
profile to a new name.
6 Click Close to close the Recognition Profiles window.
Patch Code Recognition
A patch code is a pattern of horizontal black bars separated by spaces and typically placed
near the leading edge of a paper document to be scanned. It can be used to separate
documents.
All patch codes are made up of narrow and wide bars, as follows:
▪ Narrow bars must be 0.08 inch in height.
▪ Wide bars must be 0.20 inch in height.
▪ Entire patch code must be 0.80 inch in height.
▪ Entire patch code should be at least 2.0 inches in width.
38
The Administration Module
Kofax Capture Administrator's Guide
177
Figure 2-43. Type II Patch Code
Patch Code Recognition Settings
There are several settings you can make to optimize patch code recognition.
Left Offset
This specifies a point measured from the left edge of the image that falls within the patch
code. A value of 0 specifies searching anywhere in the horizontal direction for a patch code.
See Patch Code Placement
.
See Patch Code Recognition
.
Note Kofax Capture allows you to use patch codes for various types of processing. For
example, you can use patch codes as batch separators, document separators, control the
counter for the endorser/annotation feature, etc. When setting up each type of processing,
you can specify a left offset for the patch code. If you specify different left offsets, Kofax
Capture will automatically default all the left offsets to 0.
Patch Code Type
This specifies a type of patch code. Kofax Capture supports the following patch code types
(Patch II, II, and T are Kodak ImageLink patch code types).
▪ Patch I
▪ Patch II
▪ Patch III
▪ Patch III
▪ Patch T
▪ Patch VI
A .wmf file for each patch code is included in your Kofax Capture Bin folder. The names of
the files are
Patch1.wmf
,
Patch2.wmf
, etc.
Patch Code Placement
To be detected, a patch code must be positioned correctly on the page:
▪ The patch code must be horizontal.
▪ It must be located at least 0.20 inch from the leading edge of the image.
▪ It must not extend beyond 3.75 inches from the leading edge of the image.
43
The Administration Module
178
Kofax Capture Administrator's Guide
Note For duplex scanning operations, patch codes are only detected on the front side of a
page. Patch codes on the back side of a page is ignored.
Group and User Profiles
From the Administration module, you can enable the User Profiles feature to manage Kofax
Capture access and activity on a user-by-user basis. This is accomplished by setting up
accounts or “profiles” for each Kofax Capture user. Each user profile defines a login ID for
the user and specifies the modules and batch classes to which the user is allowed access. The
profile also defines the administrative functions to which the user has rights. Additionally,
the administrator can set up group profiles to assign access rights to multiple users.
Upon installation, Kofax Capture automatically sets up a user profile called “Admin” for
the administrator. The Admin profile is used to add and edit additional user profiles and
group profiles. The administrator can edit the Admin profile, but it cannot be removed. Other
administrator users can access the Admin profile and make limited changes to it. By default,
the Admin profile does not have a password assigned to it.
Note You have the option of assigning the username and password for the Admin account
during installation. For details, see “Updating Default Administrator Account During
Installation” in the Kofax Capture Installation Guide. As another option, you can use the
User Profile Properties window in the Administration module to update the username or
password for the Admin account after installation. For details, click Help on the User Profile
Properties window.
User profiles and group profiles include assignments for the following:
▪ User login ID and optional password (user profiles only)
▪ Access to batch classes (including independent verification)
▪ Access to Kofax Capture modules
▪ Group profile membership
▪ Access to administrative functions and utilities
The implementation of user profiles is an optional feature that is enabled from the User
Profiles window.
Group vs. User Profiles
To take advantage of any of the Kofax Capture user management features, you must
first enable the User Profiles feature. You can turn this feature on and off as required. If
you disable the User Profiles feature, and later enable it again, all your previous settings
are restored and enforced. In Kofax Capture, users or groups can be given profiles that
regulate access to the modules and batch classes. The profile also defines access to various
administrative utilities.
Caution If you enable profiles, you may be asked for a password when starting Kofax
Capture modules. Kofax Capture cannot recover or reset these passwords. If you forget your
password, you need to contact Support personnel.
A user profile is a collection of permission and assignment settings that are assigned to an
individual Kofax Capture user. A group profile is a collection of permission and assignment
42
The Administration Module
Kofax Capture Administrator's Guide
179
settings that are assigned to a group. A group may consist of any number of Kofax Capture
users, and users can be members of any number of groups.
Groups can be assigned the same types of access rights as users, and all members inherit the
group’s rights. Because these rights are inherited, you can quickly change the settings for all
the members in a group simply by editing the group profile. For large groups, this simplifies
the maintenance of user rights and ensures consistency.
You can also link Kofax Capture to your operating system users and groups.
Note An individual user of Kofax Capture has all the permissions granted by the user profile
plus those in all the assigned group profiles.
Default Profiles
When you enable the User Profiles feature for the first time, two default profiles are already
in place: the “Admin” user profile and the “(Everyone)” group profile. You cannot remove
these profiles, but you can modify them. For example, the Admin profile does not have a
password assigned to it, and you may want to add a password to the Admin profile. You
can also change the username for the Admin profile. For details about updating the Admin
profile, click Help on the User Profile Properties window.
The Admin profile is intended to be used by the Kofax Capture administrator, who typically
is responsible for setting up and maintaining profiles. By default, every new user profile is
automatically assigned to the “(Everyone)” group. As a result, each new user inherits the
rights that are assigned to the “(Everyone)” group, in addition to the rights assigned in the
user profile.
For example, a user whose user profile does not allow access to the Scan module might
still be able to use it. This would occur if the user is a member of a group profile, such as
“(Everyone)”, for which access to the Scan module is allowed.
By default, the “(Everyone)” group is allowed access to every batch class and every Kofax
Capture module. You can use the Group Profile Properties window - Members tab to restrict
the batch class and module assignments for the “(Everyone)” group.
User Tracking
Kofax Capture can track activity for each user. Kofax Capture will maintain statistical records
with information about users, documents, keystrokes, and other common activities.
When you enable the User Tracking feature, Kofax Capture tracks user activity in a number
of database tables. The tables contain statistical records that are generated as a user creates
and updates Kofax Capture batches and opens/closes processing modules. The records track
information about various items such as user actions, documents, and keystrokes.
Depending on your database selection, the user tracking statistics are stored in the standard
Kofax Capture database or in your SQL Server, Oracle, or IBM DB2 database. Refer to
Database Utility
for more information about selecting different databases.
When you install Kofax Capture for the first time, the statistics tables are initially empty.
45
The Administration Module
180
Kofax Capture Administrator's Guide
Caution The
Stats.mdb
file is deprecated and may not be supported in future versions of
Kofax Capture. It is retained in this version for legacy compatibility only. If you are currently
using Microsoft Access (or something similar) for custom reports, you may continue to do
so. Kofax strongly recommends that you use the database connection method described in
custom reports for all your reporting needs. This method provides better performance and
enables access to several new database views that make it easier to generate custom reports.
If the User Tracking and User Profile features are enabled, statistics are maintained for linked
operating system users in the same manner as for Kofax Capture users.
Track User Activity
When you enable the User Tracking feature, Kofax Capture tracks user activity in four
database tables. The tables contain statistical records that are generated as a user creates and
updates Kofax Capture batches and opens/closes processing modules. The records track
information about users, documents, keystrokes, etc.
When you install Kofax Capture, the tables are initially blank. With client/server installations,
the statistics are compiled per workstation, with a separate database for each. With
standalone installations, the statistics are also compiled separately.
User tracking occurs if Tracking is selected in the Administration module. By default, the
option is disabled.
Note When User Profiles are enabled for your Kofax Capture installation, users who have
rights to the Administration module can enable/disable the User Tracking feature.
User Tracking Statistics
If the user tracking feature is enabled in Kofax Capture at the central site, user tracking begins
for each module the next time that module is started. If a module is running when batch
classes are downloaded, that module does not record user tracking until it is restarted.
Batch user tracking statistics are uploaded when a batch is uploaded. Statistics for deleted
batches and launched modules are uploaded only when synchronization occurs.
Once uploaded, user tracking statistics are incorporated automatically into the central Kofax
Capture database. Once a batch is successfully uploaded and inserted, the remote site RSA
deletes all user tracking statistics associated with that batch at the remote site.
User Tracking Data Tables
Depending on your database selection, user tracking data is stored in different locations. The
data schema and table structures remain the same, regardless of the storage location.
Caution The
Stats.mdb
file is deprecated and may not be supported in future versions of
Kofax Capture. It is retained in this version for legacy compatibility only. If you are currently
using Microsoft Access (or something similar) for custom reports, you may continue to do
so. Kofax strongly recommends that you use the database connection method described in
custom reports for all your reporting needs. This method provides better performance and
enables access to several new database views that make it easier to generate custom reports.
Documents you may be interested
Documents you may be interested
