Skip to main content
Skip table of contents

Field Automation

Automation Tab

This tab allows for automation processing on a field. For example:

  • A field can automatically process if the is no validation rules

  • A field can automatically press the F3 browse button to launch the search screen (if configured)

Figure 89 - the field's Automation tab

Automatically move to the next field after successfully processing this field

When ticked, this option will automatically press the KFI form Next (field) button to move the viewer to the next field during KFI processing.

  1. This option should not be set on the last zone in the KFI type.

  2. The box for ALL fields may be ticked at the same time by exiting the field and, on the main KFI screen go to the Viewer tab, select the Apply Field Flow Automation option. The process can also be "undone" by clicking on the Remove Field Flow Automation option.Refer to the Viewer tab section on pager

Automatically submit document after successfully processing this field

When ticked, this option will automatically press the KFI form Submit button to move the viewer to the next document during KFI processing.

  1. Note" This option should only be set on the last field in the KFI

Automatically show browse form

When ticked, this option will automatically press the KFI Field browse button


  • If a KFI field has a browse button

    and needs to be clicked every time a job is run it is recommended to have this option enabled.

Re-evaluate ODBC lookup when dependency field values change

Always re-evaluate the ODBC lookup when any fields referenced by placeholders change, otherwise only when field is processed.

Skip ODBC/Integration lookup when field already has a value

Skips the ODBC/Integration lookup in field processing if a value has already been populated from another input source such as Recognition or Custom Extract.

Activate Add Zone Pen

This option will automatically activate the zone pen during KFI profiling.

  • The operator can then draw the area around the zone so EzeScan can process it.
    This would be used with the Discovery options or if using a dynamic zone.

Allow field validation override

If a field does not meet the requirements, (e.g. database lookup failed or number of characters not met) the operator can tick this option to allow the message to be overridden.

  • When the message appears the operator can press Ctrl + Space and it will move to the next KFI field.

Ignore Field Validation Error

This option is designed for automated jobs where the operator does not want EzeScan to stop or halt processing.

  • If a field has a validation error the operator can enable this option.

  • EzeScan will ignore the validation error and keep processing the field.


This option allows the operator to validate the value in a KFI field against an ODBC compliant database or can validate data from another field using the comparison option.

  • If via ODBC and the value is not in the database EzeScan will display a Validation failed message.

  • In the validation options, the operator can set the option "On Error Substitute Field Value With" with a value to replace with.

    • e.g. If the validation failed EzeScan can put in this value so the operator can keep processing to the next field, or alternatively the allow field validation override option can be used.

    • This will allow the operator to override the error and move to the next KFI field.

    • This option is documented above (see "Allow field validation override").

  • The operator can also use a custom error message with the "Custom Validation Error Message" option.

  • When the Validation button is pressed, the following screen is displayed.

  1. Further details regarding the validation screen are coved on page

Ignore errors, replace them with:

If a KFI zone contains a field validation error, EzeScan will ignore the error and replace it with the value specified

Spell check the input data using the dictionary

When the spell check option is selected…

  • After the field information is entered, the dictionary will check the spelling of the word/s.

  • If a word is not understood a dictionary screen will appear offering suggestions.

    You can select from multiple language dictionaries or create your own "custom" dictionary. Languages available are…

  • Custom

  • Dutch

  • English AUS

  • English UK

  • English US

  • French

  • None

    Further details are available in the Setting up and activating the EzeScan dictionary section in the appendices on page .

  1. Only use this setting on important fields such as Document Title etc.

Setting up the Validation Rules on a field

To create a validation rule on a KFI field; which alerts the operator that the field has met the required criteria is set up on the field's Automation tab.
There are two types of validation which may be employed…

  1. ODBC

  2. Comparison

  3. Only one of these types may be used.

ODBC Tab - Validate the Input Data Using an Internal ODBC Lookup

Figure 90 - Field Validation Settings - ODBC tab - tick the box to begin

This option does not require you to set-up an ODBC DSN. It utilises an inbuilt EzeScan function which will validate a field's value.
In this example we will be validating a Document Title which has been created via the EzeScan Profiling Spreadsheet. Clicking the ODBC button display the following screen. This will allow the operator to input a SQL select statement to validate the data against an ODBC compliant database.

Figure 91 - follow the steps below to do your Validation rule

  1. Tick the  Use Lookup box

  2. Select the  Return value based on a placeholder value option

  3. Add your SQL string (see below)

  4. Click the OK button

The SQL string

In this example we are looking for a particular value in the Title field which should not be there and if it is will create an error.
Select IIF(InStr('<<Title>>', '<') = 0 AND Instr('<<Title>>', '>') = 0, '<<Title>>', 'ERROR')

  • The string begins with Select IIF

  • We are checking the field called Title '<<Title>>'

  • Looking for a '<' AND a '>' (the things which should not be there)

  • If they do then an 'ERROR' will occurand then provide the operator with a message when the field has an error; due to the < > values being present.

  1. Copy the above string for use in your own validation script. It must be in the same format, just change the field name to suit.

Custom Validation Error Message

Add a meaningful message here so that the operator will understand what the error is as shown in Figure 90 on page .
An example of the error message the operator would receive is shown below; due to the <type> text being drawn into the Title field from the EzeScan Profiling spreadsheet.

Figure 92 - The error message is shown in brackets. The operator cannot proceed until the < > are removed.

ODBC Tab - Validate the Input Data Using a DSN Based ODBC Lookup

Please refer to the ODBC Settings section on page for details on creating a DSN based ODBC Lookup. The same functionality would be used here to perform a validation of the field value.

Comparison Tab

This screen allows to validate the current field value against another field value or static text. For example the operator may need to compare two numerical or date values.
A comparison operator and custom error message can also be defined.

Figure 93 - Field Validation Settings - COMPARISON tab - tick the box to begin

Action Tab

The field Action allows the operator to set rules based whether a previous or current field is blank, not blank or a specific static value. The rule can be set to Process or Skip based on the previous / current field condition.

Figure 94 - the field's Action tab - tick the box to initiate

e.g. if the operator wanted to skip Field 10 because Field 5 had a Blank value the following would be set.

Figure 95 - set to skip a blank field

If the operator wanted to have Field 10 Hidden because Field 5 had a value of NO the following would be set…

Figure 96 - set to skip a field with a value of NO

  1. In this instance field 5 will remain hidden until it has been processed and if field 5 does not have a value of "No" then field 10 would display.

  1. The option (on the automation tab) "Automatically move to the next field after successfully processing this field" must also be ticked.

Ignore if page missing

This option will ignore the field if the page is missing.
This option is recommended for jobs that have variable data only.

Hide Field

Sometimes with KFI a field value may be default or it may be looking up information from another source. By using the Hide Field option, the field will automatically captured as the value, without the KFI operator having to verify that zone.
During KFI processing hidden fields can be unhidden at any time by simply pressing the KFI Show button.

  1. The option (on the automation tab) "Automatically move to the next field after successfully processing this field" must also be ticked.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.