INDICIUS 6.0 for KOFAX Capture Getting Started Guide (Fixed-Form) 10300774-000 Rev 1.
© 2006-2008 Kofax, Inc., 16245 Laguna Canyon Road, Irvine, California 92618, U.S.A. All rights reserved. Portions, copyright 1997-2006 Kofax Development UK Ltd. All Rights Reserved. Use is subject to license terms. Third-party software is copyrighted and licensed from Kofax’s suppliers. This product is protected by U.S. Patent No. 5,159,667. THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF KOFAX, INC.
Contents How to Use This Guide ............................................................................................................1 Introduction ............................................................................................................................ 1 How do I Use This Guide? .................................................................................................... 1 Related Documentation ................................................................................
Licensing ................................................................................................................................ 10 3 Basic Processing Tutorial .............................................................................................. 11 The Order Forms Example................................................................................................... 11 The Example Documents ..............................................................................................
Data Entry Fields .................................................................................................................. 68 Creating a Template ............................................................................................................. 68 Using Import .................................................................................................................. 68 From Scratch ...................................................................................................
vi Getting Started Guide (Fixed-Form)
How to Use This Guide Introduction This guide introduces INDICIUS and describes how it is used to process fixed-form (structured) documents. It starts with brief installation instructions which are followed by a tutorial. The tutorial will guide you through processing batches using the pre-installed Order Forms example. The guide then describes how each of the modules are configured, enabling you to create a new set of configuration files that process the order forms documents.
Related Documentation The following documentation is included with INDICIUS. Each PDF guide can be opened by clicking Start on the taskbar to display the menu, and selecting All Programs | INDICIUS | Documentation. The INDICIUS Help can be opened from the same menu, but can also be opened from the Help menu within the tools. Pressing F1 within Definer and Script Editor will open the topic for the feature being used. Installation Guide (.
Getting Started Guide (Free-Form) (.pdf) The Getting Started Guide (Free-Form) (.pdf) focuses on configuring a solution to extract data from free-form (semi-structured or unstructured) documents. The guide explains: How to extract data from single page documents of a known document type, using the installed Solicitors Letters example. How the tools, concepts and configuration files relate to the setup in Kofax Capture.
INDICIUS Help The INDICIUS Help is written for those configuring a solution and for system administrators, and assumes those reading it have read the Getting Started Guides or attended an INDICIUS training course. This assumption is made so that the INDICIUS Help can provide the most accurate and detailed information across every aspect of the product. The INDICIUS Help explains: How to configure the INDICIUS modules to process a document set.
Chapter 1 Overview Introduction This chapter introduces some of the concepts of data capture and key points of INDICIUS. What Does INDICIUS Add to Kofax Capture? INDICIUS is a set of modules that provide additional automatic recognition (classification, separation and extraction) as well as advanced keying (indexing and validation) functionality to Kofax Capture. Kofax Capture scans paper-based documents, creating a series of scanned image files.
Chapter 1 Table 1-1. INDICIUS Modules Module Function Recognition Automatically classifies and extracts data from each document, searching intelligently for data when necessary. May also automatically separate a stream of pages into documents. The standard instance of Recognition is installed by default. Additional instances can be registered with Kofax Capture using an AEX file.
Overview Table 1-3. INDICIUS Tools Tool Function BatchCompare A utility for detailed evaluation of classification and separation performance. Definer Configures Recognition (in conjunction with Transformation Studio) and Correction for a specific document set. Document Review Project Editor Configures Document Review for a specific document set. Also configures document separation (in conjunction with Transformation Studio).
Chapter 1 Low Volume, Single Station Environment In lower volume environments it is possible to run batches through all the modules on a single station, using Kofax Capture Batch Manager.
Chapter 2 Installing INDICIUS Introduction This chapter provides instructions for installing INDICIUS using the installation wizard (standard installation). To install INDICIUS the following items are required: 1 A computer satisfying the system requirements as described in the Installation Guide (.pdf). 2 An INDICIUS installation CD. 3 A Kofax Capture license hardware key with INDICIUS features enabled. Note Kofax Capture must be pre-installed and licensed.
Chapter 2 Installing INDICIUS for the First Time Standard Installation X To install INDICIUS 1 Place the INDICIUS installation CD into the CD-ROM drive. The main installation screen will display. 2 Select INDICIUS and follow the on-screen instructions. 3 To install Document Review, select INDICIUS Document Review and follow the on-screen instructions. 4 To install Transformation Studio, select Transformation Studio and follow the on-screen instructions.
Chapter 3 Basic Processing Tutorial The Order Forms Example The INDICIUS installation includes an example configuration that demonstrates some of the features of INDICIUS. The example uses a pre-defined batch class configured to capture data from a set of example images, as well as configuration files for Recognition, Correction, Completion, Verification and Scripted Export.
Chapter 3 Figure 3-1.
Basic Processing Tutorial Installing the Example Batch Class Installation X To install the example batch class 1 Start Administration by clicking Start on the taskbar to display the menu, and selecting: All Programs | Kofax Capture 8.0 | Administration 2 Select File | Import… to display a file selection window. 3 Select the following batch class: \examples\Order Forms\INDICIUS Order Forms Example.cab 4 Click Open to unpack the batch class.
Chapter 3 Note It is normal for a warning to be generated when the batch class is published. This is because Index Fields are defined to hold exported data but neither Kofax Capture Validation nor Kofax Capture Recognition Server are included in the batch class. This warning can be ignored. Troubleshooting In a client-server installation of Kofax Capture, an error may be generated when the batch class is published.
Basic Processing Tutorial Viewing the Modules X To view the modules included in the example batch class 1 On the Batch panel, select the “INDICIUS Order Forms Example” batch class. 2 Right click on the selection to display the menu, and select Properties. 3 The Batch Class Properties window is displayed. 4 Select the Queues tab. The modules included in the batch class are displayed in the Selected Queues list. 5 Click OK.
Chapter 3 Running the Order Forms Example The example can be tested on a batch of example images. The typical test process (which you will work through later) is as follows: Step 1: Create a batch. Step 2: Add images to the batch and establish document boundaries using Kofax Capture Scan. Step 3: Run the batch through INDICIUS Recognition to produce raw captured data. Step 4: Correct rejected characters in the batch with INDICIUS Correction. Step 5: Complete and validate the batch with INDICIUS Completion.
Basic Processing Tutorial Figure 3-2. Create Batch Window 4 Enter a name for the new batch in the “Name:” box, for example “Order Forms 1”. 5 Click Save. 6 Click Close. Your batch is displayed in the list. The Queue column indicates that the batch is ready to be processed by Kofax Capture Scan. X To import images and assemble documents 1 Make sure the name of the new batch is highlighted and select File | Process Batch or click Process Batch( ) on the toolbar.
Chapter 3 4 Click Open to import the images and establish document boundaries. 5 Select Batch | Close and click Yes to the message box. In Batch Manager, the Queue column indicates that the batch is ready to be processed by INDICIUS Recognition. Note The Order Forms example processes only a single type of document, using the Scan module to establish fixed document boundaries before the first INDICIUS module. X To recognize the data, click Process Batch on the toolbar in Batch Manager.
Basic Processing Tutorial X To correct the data 1 Click Process Batch on the toolbar in Batch Manager. 2 Wait for the batch to be automatically loaded in Correction. The first fields to correct are displayed (see Figure 3-3). Figure 3-3. Correction Seven fields require correction in the batch. Six of these are single-key corrections while the other requires full-key correction. The first field is a name that contains a character that Recognition rejected.
Chapter 3 The sixth field is an address line containing characters obscured by background noise on the document. The configuration files for Correction specify that an address field with more than one rejected character should be fully keyed. This improves efficiency. 6 Enter “13 BENNETT PLACE” for the sixth field. The last field requires a single-key correction. 7 Enter the character “R”. When all the fields have been corrected, an End of Batch window displays. 8 Click Exit Correction.
Basic Processing Tutorial X To complete the data 1 Click Process Batch on the toolbar in Batch Manager. 2 Wait for the batch to be automatically loaded into Completion. Completion will automatically load the first document in the batch that requires attention. The first four images of the batch are not displayed because the data captured by Recognition and Correction passes all validations and none of the mandatory fields are blank. Figure 3-4.
Chapter 3 6 Click OK. No data requires modification on these forms – the data is displayed merely for review purposes. 7 Press Tab, Page Up and Page Down to move between the fields and review the data and then press F12 to release the form. Note All captured dates have been transformed into a standard “MMDDYYYY” format and are validated as being true dates. A check-digit validation has been defined for the credit card number field using script.
Basic Processing Tutorial In Batch Manager, the Queue column indicates that the batch is ready to be processed by INDICIUS Scripted Export. X To export the batch, click Process Batch on the toolbar in Batch Manager. Scripted Export will automatically begin processing the batch. Information messages will be displayed and the “Docs Processed” should increment. When “Docs Processed” reaches 7, Scripted Export will close.
Chapter 3 7 Select File | Exit to close Stats Reporter. Process the Batch from Dedicated Applications Kofax Capture and INDICIUS modules may be run from a desktop or Start menu shortcut, rather than being run from Batch Manager. In most production environments a module is left to run continuously on a computer, and hence is referred to as a “dedicated application”. When running as a dedicated application, the module will usually be set to poll for batches.
Basic Processing Tutorial 2 Select Session | Select Batch… 3 Select the batch created in Scan from the list. 4 Click Ok. Recognition will begin processing the batch. Information messages will be displayed and the “Docs Processed” should increment. When “Docs Processed” reaches 7, the status bar will display “Idle”. 5 Select Session | Exit to close Recognition.
Chapter 3 X To check data accuracy 1 Open Verification by clicking Start on the taskbar to display the menu, and selecting: All Programs | INDICIUS | Verification X 2 Select Session | Select Batch. 3 Select your batch from the list. 4 Click Ok. 5 Verify the Surname field as before when running from Batch Manager. 6 When the End Of Batch window displays, click Exit Verification.
Chapter 4 Configuration Concepts Processing Configuration and Document Configuration The behavior of INDICIUS when processing a particular document set is controlled by a set of configuration files as well as settings within the batch class. Configuration is done using both Kofax Capture Administration and the set of specialized INDICIUS configuration tools.
Chapter 4 Configuration Files The following table specifies the configuration files used by each INDICIUS module, whether they are mandatory for fixed-form extraction and which tools are used to generate them. Table 4-4. Configuration Files (Fixed-Form Extraction, Single Document Type) Module Configuration Files Recognition Definition File (.idf) - mandatory Specifies the location of the fields on each document type and details of expected character types, typefaces, noise removal strategies, etc.
Configuration Concepts Table 4-4. Configuration Files (Fixed-Form Extraction, Single Document Type) Module Configuration Files Completion Template File (.kfi) – mandatory Specifies the fields to be keyed and the behavior of the Completion interface. Also specifies the validation to be used for each field. Generated by Template Editor. Script File (.ifv) – optional Used to transform the data before it is loaded into Completion and also when it is output. Also used to validate data as it is keyed.
Chapter 4 Viewing the Configuration Files for the Example The names and locations of the configuration files used by the INDICIUS modules in the Order Forms example can be viewed by opening the setup dialogs from within Kofax Capture Administration. X To view the configuration files for the example 1 Start Administration by clicking Start on the taskbar to display the menu, and selecting: All Programs | Kofax Capture 8.
Configuration Concepts Some Important Terminology This section details specific terminology used by INDICIUS. Fields An item of data that is to be captured is called a field. Fields can be of the following types: single line text, multi-line text, mark sense, mark grid, table or barcode. For each field, the definition file generated by Definer specifies: The coordinates (relative to a registration point) of the fields. The type of the field (text, mark sense, mark grid, barcode or table).
Chapter 4 If this stage of the processing fails, then automatic recognition of data from the document will not be possible, or can give poor results. Segmentation Lines of text, marks and barcodes must first be distinguished from the background of the document. After this, segmentation can occur. Segmentation has the following stages: Lines of text on the image are identified. Within those lines of text, the boundaries between individual characters are established.
Chapter 5 Configuring Recognition and Correction Overview The following tutorial shows how the Definer tool can be used to generate a definition file (.idf) for Recognition and Correction. Definer allows configuration changes to be made quickly. It includes an embedded Recognition engine that allows the effect of changes on the recognition process to be tested immediately. The definition file created here specifies a subset of the data fields on the example images used in the Basic Processing Tutorial.
Chapter 5 Step 5: Remove any background elements for the data fields, for example lines, boxes etc. Step 6: Segment the characters, marks or barcodes. Step 7: Recognize the characters, marks or barcodes. Important If any of these stages fails or is not accurate, the stages thereafter may fail or be inaccurate. It is therefore important to ensure that every stage of the process operates at its best, particularly the earlier ones.
Configuring Recognition and Correction f 3 If the document type is not identified correctly or alignment is not corrected for any image, alter the registration points and retest until satisfactory performance is achieved. Define and configure data fields as follows: a For the first data field, define its position, set noise and background removal schemes, configure segmentation and select suitable recognition weights from the standard set. b Test the definition on a single example image.
Chapter 5 Note In this tutorial, Definer will be used to develop a definition file for a set of example images from scratch; use of Recognition Trainer to tune character recognition will not be covered. Creating a Definition X To load an example image 1 Open Definer by clicking Start on the taskbar to display the menu, and selecting All Programs | INDICIUS | Tools | Definer. 2 Select Image | Open Image… from the main menu to display a file selection window.
Configuring Recognition and Correction Figure 5-5.
Chapter 5 X To define a registration point The example images used in this tutorial are of a single document type and have been corrected for skew during the scanning process. Therefore, only a single registration point needs to be defined to correct for document shift. 1 Scroll to the top right corner of the image until the spiral logo is visible. 2 Click Mark Registration (Figure 5-5 , item 3) on the toolbar.
Configuring Recognition and Correction 7 Select File | Save Definition and save the configuration with the following filename: \config\MyOrderForms.idf. X To test the registration point 1 Select Tools | Test Registration or press CTRL+Shift+F8 to put Definer into test mode. Definer’s test mode allows changes to the configuration of registration points and data fields to be tested immediately. Test mode uses an embedded version of Recognition.
Chapter 5 Figure 5-7. Definer Test Mode Interface 1 Process Step: pauses after each processing step. 2 Process Field: pauses after processing each field or registration point. 3 Process Document: pauses at the end of each document. 4 Process All: does not pause until all selected documents are processed. 5 Auto Exit: toggle auto exit from test mode. 6 Run: Start running the test. 7 Run Step: run the next processing step. 8 Pause Processing: pause the test to change options.
Configuring Recognition and Correction 4 Click Open. This will allow the registration point to be tested on a further 6 images. 5 Click Select All to indicate that all the images are to be used in the test. 6 Click Run or press F8 – this will process the registration point on the “Order Form 1.tif” image again. 7 Click Run Step, or press Space, to process the next image. 8 Check that the registration point is correctly located. 9 Repeat for all remaining images.
Chapter 5 X To create a single line field 1 Select the “Formid 1” tab and then scroll and zoom the image until the surname “PETERS” is clearly visible. 2 Click Single Line Field 3 Click on the image with the left mouse button and hold it down to draw a red box around the surname. on the toolbar. This box defines the area where Recognition will look for the surname. 4 Position and resize the field as shown below. Figure 5-8.
Configuring Recognition and Correction 10 Select “Expected” and set Width to 27 and Height to 34 (the average character size). 11 Move the green box around the image to compare its size to the characters. 12 Select “Maximum” and set Width to 52 and Height to 53 (approximately 1½ times the character width and height, or slightly larger than the size of an upper case W for a variable width font). Figure 5-9. Definer Character Sizes Window 13 Click OK to close the Definer Character Sizes window.
Chapter 5 Figure 5-10. Allowed Characters and Weights 16 Select the Recognition tab and select the “Confidence” property. 17 Click the button and set “Confidence” to 5. “Confidence” specifies how sure Recognition needs to be about the identity of a character before accepting it. Setting “Confidence” to 0 means Recognition will reject no characters, whereas a 10 means Recognition will reject all but the most confident characters.
Configuring Recognition and Correction This will invoke the embedded version of Recognition and will show how Recognition finds the registration point on the selected image and then processes the field. 4 Click Run Step to process the “Surname” field. 5 Click Run Step or press Space to finish processing the selected image. Test mode will automatically exit. 6 Press F8 to launch test mode again. 7 This time, click Select All, click Process Field press F8.
Chapter 5 10 On the Allowed Characters panel, select “Numerics”, “Upper Case Alpha” and “Lower Case Alpha”. Leave “Spaces” clear. 11 Click the button to display a Character Selection window. 12 Type ”,/” (a comma followed by a forward slash) and click OK. These are additional characters that will be allowed in this field. 13 On the “Weights” panel, select “Machine – General” and “Machine - Times Roman” and leave the other options clear. 14 Select the Recognition Tab (Figure 5-5 , item 10).
Configuring Recognition and Correction X To remove noise from the field Recognition uses image processing algorithms to strip out unwanted noise from a document image prior to recognition. Features can include (but are not limited to): Dots/speckles Lines/Boxes Images/logos Recognition uses knowledge of the dimensions and number of pixels for each feature on the image, as well as the minimum separation between neighboring features to deduce which features are noise.
Chapter 5 Table 5-7. Single Line Field Configuration Property Value Right: 2392 Bottom: 2561 Allowed Characters: Numerics Weights: Hand Print Minimum Character Size 2 x 19 Expected Character Size 72 x 81 Maximum Character Size 97 x 107 Correction Mode: Characters Correction Limit: 2 3 Select the Background tab. 4 Under Box Removal, select the Box Size property and click the display the Box Removal window.
Configuring Recognition and Correction Figure 5-13. Box Removal Window 7 Click OK. 8 On the Background tab under Box Removal, set the “Box Count” property to 16. This indicates a group of 16 boxes in the field. 9 Set the “Character Per Box” property to “Yes”. This indicates that characters may only be found within a box, and that only one character may be found in each box. Default noise removal is automatically selected when box removal is configured. This occurs after box removal.
Chapter 5 Figure 5-14. Blob Removal 11 Select Tools | Test Definition or press F8 to save and test the definition. 12 Test on one example image and then all example images as before. Note how the boxes are removed from the “CreditCardNumber” field prior to recognition and that some characters are rejected. Note When Hand Print is selected for weights, the character sizes will automatically be set.
Configuring Recognition and Correction Table 5-8.
Chapter 5 10 Select Tools | Test Definition or press F8 to save and test the definition. 11 Test on one example image and then all example images as before. Note that some characters may be rejected. X To create a single line field with a format Formats can be applied to restrict characters at certain positions within fields so they can only take on certain values. Multiple formats can be applied to a single field.
Configuring Recognition and Correction If, however, the boxes are irregularly spaced or there is a large amount of text or other marks attached to the boxes, each box should be defined as a single mark sense field. Completion can then be configured to group the data for these fields into a single field for keying. Mark sense fields are created in a similar way as text fields, but the Allowed Characters, Weights, Confidence and Correction Limit parameters are not required.
Chapter 5 Table 5-9. Mark Sense Field Configuration Property Value Box Count: 1 Character Per Box: Yes 4 Select Tools | Test Definition or press F8 to save and test the definition. 5 Test on one example image and then all example images as before. The presence of a mark in a mark sense field is indicated by an “@” character. 6 Select the “Mr” field and use copy, paste and the dragging functionality to create fields for “Mrs” and “Miss”.
Configuring Recognition and Correction 10 Select Tools | Test Definition or press F8 to save and test the definition. 11 Test on one example image and then all example images as before. 12 Select the “Check” field and use copy and paste to create fields for “Visa”, “Mastercard” and “AmericanExpress”. Figure 5-16. Method of Payment Fields 13 Select Tools | Test Definition or press F8 to save and test the definition. 14 Test on one example image and then all example images as before.
Chapter 5 Figure 5-17. Barcode Field Table 5-11. Barcode Field Configuration Property Value Name: Barcode Left: 1780 Top: 3207 Right: 2484 Bottom: 3499 Correction Mode: Never Barcode Type: Code 39 Leave all other properties as their defaults. Note The “Barcode Type” property is set on the Recognition tab. 3 Select Tools | Test Definition or press F8 to save and test the definition. 4 Test on one example image and then all example images as before.
Configuring Recognition and Correction X To create a table field The example image has a table field comprising a set of line items and a subtotal/tax/total area. Recognition processes the two separate areas using two separate Table Formats and decides which one to use on the basis of recognizing a “Table Format Heading”.
Chapter 5 Table 5-12. Table Field Configuration Property Value Name: OrderDetails Left: 204 Top: 1407 Right: 2316 Bottom: 2207 Minimum Character Size: 3 x 14 Expected Character Size: 22 x 37 Maximum Character Size: 38 x 52 Allowed Characters: Numerics, Upper Case Alpha, Lower Case Alpha, Spaces, “().,” (brackets, periods and commas) Weights: Machine - General, Machine Arial Recognition Confidence: 0 Correction Mode: Never Leave all other properties as their defaults.
Configuring Recognition and Correction 6 The Table Format Definition window is displayed, where you will add the first Table Format. Figure 5-19. Table Format Definition Mode 7 In the “Format Name” field, enter “OrderDetails” and leave “Heading” blank. 8 Click Add Column and move the red and magenta line on the image snippet to either side of the first column of the table containing the item numbers “U112” and “Y283”.
Chapter 5 Note that as new columns are added the lines defining the existing columns on the image snippet turn blue. 10 Select each column in turn by clicking on it in the Columns Defined list, and set the following properties: Table 5-13. Table Column Properties – Item Number Property Value Name: ItemNo Allowed Characters: Numerics & Upper case Weights: Machine - General, Machine - Arial Confidence: 5 Table 5-14.
Configuring Recognition and Correction 12 Click on the format. button on the Table Formats panel to add the second table 13 In the “Format Name” field, enter “Totals”. 14 In the “Heading” field, enter “TOTALS”. “Heading” is used by Recognition to differentiate between the two Table Formats. 15 In the “Heading Tolerance” field, enter a value of 2. “Heading Tolerance” is the number of recognized characters that can be different from the defined “Heading” before it is rejected as being this Table Format.
Chapter 5 Table 5-17. Table Column Properties – Totals Amount Property Value Confidence: 5 18 Click OK. Further properties can be set on the columns in the text editor. 19 Select the Definition File tab at the bottom left of the view. 20 Scroll up to the VIRTUALFIELD object called “ItemNo”. 21 Enter the new line “FORMAT A###” prior to the END statement. This will constrain the characters allowed in each position of the field. Figure 5-20.
Configuring Recognition and Correction 25 Test on one example image and then all example images as before. Note the field is read twice; firstly to separate the field into characters and to locate the format headings, secondly to apply the formats and columns.
Chapter 5 Testing a Definition File So far, testing of the definition file has been limited to a few documents in the Definer test mode. The next stage is to run a test in the Recognition Test Tool, where statistics can automatically be generated to show processing performance. Typically this tool would be used for testing on a large number of images.
Configuring Recognition and Correction Recognition Test Tool with the project “MyOrderForms.rtp” and re-run the test to check for improvements. Assigning the Definition File to a Batch Class Now a new definition file has been created, it can be assigned to the example batch class. Note that whenever a new configuration file is assigned a batch class, the batch class needs to be re-published.
Chapter 5 11 Right click on the selection to display the menu, and select INDICIUS Correction Setup. The Correction setup dialog is displayed. The Correction configuration files are specified (and can be changed) here. 12 Select the existing entry in the Configuration Files list and click the button to remove it. A confirmation window will display. 13 Click Yes. 14 Click Select Files to display a file selection window. 15 Select the following file: \config\MyOrderForms.idf.
Chapter 6 Configuring Completion and Verification Overview This tutorial shows how the Template Editor tool can be used to generate a template file (.kfi) for Completion and Verification. A template file contains parameters that specify. The layout of the Completion interface for each document. The position and type of the data entry fields. How document images are to be displayed. Simple validation rules and references to more complex validation scripts.
Chapter 6 Note The template file created here uses only a basic subset of available features for controlling the behavior of Completion. This subset is common to all template files. For details of all available features, refer to the How to Configure Completion book in the INDICIUS Help. Data Entry Fields Data entry fields are where data captured using Recognition and Correction will be displayed. The user will then have the opportunity to edit the data in these fields.
Configuring Completion and Verification Step 3: Define the layout of the imported fields, adding frames and additional tabs: Tabs are generally used to separate different kinds of data on a document or to separate data for different pages of a multi-page document. Frames are used to logically group data entry fields within a tab. Step 4: Specify the View Area and default Focus Area for each field. Step 5: Edit or specify validation schemes, scripted or simple, for each data field.
Chapter 6 Creating Your Template Opening Template Editor X To create a template and define the basic layout 1 Open Template Editor by clicking Start on the taskbar to display the menu, and selecting All Programs | INDICIUS | Tools | Template Editor. 2 Select File | New Template from the menu to display a New Template window. 3 Select the top left Form Layout (image viewing area at the top, data entry area at the bottom). Leave the Target Screen Resolution at “1024x768”.
Configuring Completion and Verification Figure 6-22. Template Editor Interface 1 New Text field 2 New Checkbox field 3 New List field 4 New Table field 5 New Label field 6 New Frame field 7 Properties panel 8 Hooks tab 9 Properties tab 10 Tab 1 Importing Fields X To import fields 1 Select File | Import Definition File… to display the Import Definition File window.
Chapter 6 \config\MyOrderForms.idf. 3 Click Open. The Import Definition File window will display. Figure 6-23. Import Definition File Window 4 Highlight the “Surname”, “FirstName”, “Date”, “CreditCardNumber”, “Address”, “CustomerID”, “Barcode” and “OrderDetails” fields in the Definition File Fields list by pressing and holding down Ctrl and selecting the fields. 5 Click Add to move them to the Completion Fields list.
Configuring Completion and Verification 11 Save the template using the default name, “MyOrderForms.kfi” in the following folder: \templates\. Note The default behavior is to save the template with the same name as the definition file. If multiple document types were to be processed in the same batch, it is important that these names match so that Completion knows which template it should display. Figure 6-24.
Chapter 6 A label field is automatically added for each data field; the name is the same as the data field with a “:” added to the end. If multiple fields are added as a text or list group then the name of the field is the same as the first data field with “ group:” added to the end. Add As Text Group is used when data from multiple fields defined for Recognition needs to be presented as a single value in Completion, as is often (and usually only) the case for mutually exclusive mark sense fields.
Configuring Completion and Verification 4 Click OK. 5 Select then right-click on Tab 2. 6 From the menu select Edit Tab Name. 7 Enter the new name “Order Details”. 8 Click OK. 9 Select the Customer Details tab. 10 Select the “Barcode” and “Date” fields and labels on this tab (click each in turn while holding down Ctrl). 11 Select Edit | Cut or press Ctrl+X to move these fields to the clipboard. 12 Select the Order Details tab. 13 Select Edit | Paste or press Ctrl+V.
Chapter 6 Once positions are defined they can all be locked using the Format | Lock Field Positions menu option. X To create frames (New Frame Field) button on the toolbar to create a new 1 Click on the frame. 2 Drag and resize the frame to surround the Customer Details fields. 3 Repeat for the Payment Details set of fields so the Customer Details tab looks like Figure 6-26. Figure 6-26. New Frames 4 Select Frame1.
Configuring Completion and Verification 9 X Save the template. To update field labels and captions Field labels default to having the same name as the field. The name of a field label is the same as the caption it displays. It will sometimes be necessary to update these names to improve clarity. 1 Double-click on the “CreditCardNumber:” label. The Field Name window will display.
Chapter 6 2 Select the “Mr Group” text field and rename it to “Title” on the Properties panel. 3 On the same panel, select the Group Fields property. 4 Double-click on the value to open the Group Fields window. 5 Change the values in the “Output value” column to “1”, “2” and “3” for source field names “Mr”, “Mrs” and “Miss” respectively. 6 Click OK. 7 At the prompt click Yes to automatically update the validations according to the new values.
Configuring Completion and Verification The following steps will edit the “Check Group” field. X 1 Double-click on the “Check Group:” label and rename it to “Payment Method:”. 2 Select the “Check Group” text field and rename it to “PaymentMethod” using the Properties panel. 3 On the same panel, select the Group Fields property and click Group Fields window. 4 For the “AmericanExpress” source field name, change the “Output value” to be “American Express”. 5 Click OK.
Chapter 6 3 Click Insert Column to add a new column to hold the type of entry information. 4 Edit all the columns as follows: Table 6-19. Column Index 0 Properties - Entry Property Value Index: 0 Header: Entry Width: 1875 Column Number: 0 Table 6-20. Column Index 1 Properties – Item No Property Value Index: 1 Header: Item No Width: 1725 Column Number: 1 Table 6-21.
Configuring Completion and Verification Table 6-22. Column Index 3 Properties – Amount Property Value Index: 3 Header: Amount Width: 1590 Column Number: 3 Table 6-23. Column Index 4 Properties – Description Property Value Index: 4 Header: Description Width: 2800 Column Number: 0 5 For the column with Index 5, click Remove Column 6 Click OK Note The “Column Number” links the column in the table field in Completion to a column defined on the table in the Recognition definition file.
Chapter 6 The general area of the image that is displayed, known as the View Area, can be explicitly set for each field using Template Editor. Alternatively, Completion can determine it automatically using knowledge of the position of the field on the image passed through from Recognition. For View Areas the following is recommended: For documents where the position of the field is fixed it is recommended that the view area is set to be static, that is, to use the coordinates defined in the template.
Configuring Completion and Verification 4 Click the image inside the red box but outside the blue box to select the red box. 5 Resize/move it to set the View Area as shown in Figure 6-29. Figure 6-29. View Area 6 Copy the View Area position by selecting Edit | Copy Image Position or pressing F11. 7 Paste the View Area from the “Title” field onto the “FirstName” field by selecting the “FirstName” field and selecting Edit | Paste Image View Position Only.
Chapter 6 2 Select the “Title” field in the table and click the is at the top of the list. (Up) button until “Title” 3 Select each other field in turn until the order shown in Figure 6-30 is set. Figure 6-30. Change Field Order Window 4 Click OK. Validations Template Editor allows simple validations to be specified for a field according to character type, data type (name, address etc.), or according to length and value. Fields can also be set as mandatory.
Configuring Completion and Verification Basic validations (data length, allowed characters, values etc) are automatically configured during import. X To set simple validations 1 Select the “Title” field. 2 On the Properties window, select the Validation property. 3 Click the 4 Set the values of “Minimum Length” and “Maximum Length” to 1. 5 Click OK. 6 Select the Order Details tab. 7 Select the “Date” field. 8 Open the Field Validation window as before.
Chapter 6 \templates\. 5 Maximize Template Editor. 6 In the bottom right of the screen, click Hooks to display the Script Hooks panel. 7 Select the row containing “CreditCardNumber” in the first column and “Validate” in the second. 8 Double-click in the “File” column to show a list of all script files in the same directory as the template. 9 Select the script “Order Form.ifv”. 10 Double-click in the “Function” column to show a list of script functions within this file.
Configuring Completion and Verification Figure 6-31. Script Hooks 12 Save the template file. Note “CardNo_Validate” validates the credit card number by length and according to a check digit algorithm. For a breakdown of the Completion script, see the chapter Configuring Scripted Export.
Chapter 6 Autoskip Completion can be configured to automatically forward the user to the next data field once the entry in a particular field is full and valid (a maximum length must be specified on the field). The keystroke saving achieved by implementing Autoskip can be considerable. X To set autoskip functionality 1 Select the “Customer Details” tab. 2 Select the “Title” field. 3 On the right hand side of the Template Editor window, click Properties to display the Properties panel.
Configuring Completion and Verification Table 6-24. Text Field Script Hooks Script Hook Runs When… Validate A document is loaded into Completion and when the user attempts to leave the field, prior to the exit hook. Field values should not be changed in this hook. Exit The user navigates away from a field, after the validate hook. Additional hooks are available for table and list fields but these are not discussed in this guide.
Chapter 6 In this tutorial, a script is attached to the “Start of Document” hook to prepare the tabular data for display (removing blank rows, retrieving item descriptions, setting color coding etc) and to transform the date fields on the example documents into a consistent “MMDDYYYY” format before display. The transformation is implemented in a script function “Start_Of_Document” in the script file “Order Form.ifv”.
Configuring Completion and Verification For an introduction to Script Editor and a breakdown of the Completion script, see the chapter Configuring Scripted Export.
Chapter 6 Configuring Verification Verification uses the same template as Completion and just requires a single additional property to be set on each field. The “Verify Type” property has four options: Table 6-26. Verify Type Options Verify Type Description 1 - None Requires no double-keying. 2 – Separate Requires double keying in the Verification module. (Default) 3 – Immediate Requires double keying in the Completion module.
Configuring Completion and Verification X To assign the template file to the batch class 1 Start Administration by clicking Start on the taskbar to display the menu, and selecting: All Programs | Kofax Capture 8.0 | Administration. 2 On the Batch panel, select the “INDICIUS Order Forms Example” batch class. 3 Right click on the selection to display the menu, and select INDICIUS Completion Setup. The Completion setup dialog is displayed.
Chapter 6 16 On the Batch panel, select the “INDICIUS Order Forms Example” batch class. 17 Select File | Publish. The Publish window will display. 18 Click Publish. The progress of the publishing operation will be logged in the Results panel. 19 When publishing has been completed, click Close. 20 Select File | Exit to close Kofax Capture Administration.
Chapter 7 Configuring Scripted Export Overview Script Editor is used to generate script files (.ifv) for Scripted Export, transforming the data from any previous INDICIUS module ready for release. Script Editor can also be used to develop scripts for transforming data at the moment it is output from Recognition, Completion or Verification and for validating data in Correction, Completion and Verification.
Chapter 7 Figure 7-32. Script Editor 2 Select File | Open File… to display an Open Script File window. 3 Select the following file: \examples\Order Forms\scriptex\Order Form_scriptex.ifv. 4 Click Open. There are 3 script functions defined in this file: “start_batch”, “process_doc” and “end_batch”. 5 Scroll in the code window to view the script contents, or select the functions from the pull-down Declarations list. 6 Select File | Exit to close Script Editor.
Configuring Scripted Export In the example script file, the “start_batch” function sets the name of the export file name to be the same as the batch name; this is the simplest option for creating an export file. The “end_batch” function closes the export file. In the example script file, the “process_doc” function formats the data captured from the example images and prints it out to the export file.
Chapter 7 Table 7-27. Script Functions Functions Description CardNo_Validate Validates a credit card number by length using a mod 11 check digit algorithm. Run on all credit card numbers. It calls the “ccFormat” and “ccValidate” functions. ccFormat & ccValidate Used by the “CardNo_Validate” function. PaymentMethod_Exit Directs the user away from specifying a credit card number if payment is by check. Run whenever the user navigates away from the payment method field.
