On Failure dialog

This dialog is available when you create or open an edit profile. You can use it to specify the action ScanTools software takes when a document fails an editing test for online editing, online edit correction, or post-scan editing.

The On Failure dialog appears at both the edit profile document and field levels:

• At the edit profile document level, if you define Maximum % of Light Marks in the Document Edit Options dialog and then click On Failure.

Procedure:

1. In the edit profile, place your mouse cursor over the Document Name - Number and click when the "magnifying glass" appears. The Edit Profile Document Popup appears.
2. In the Edit Profile Document Popup, select either Show Field List or Show All Field Edit Options.
3. In the edit profile, place your mouse cursor over the Document Name - Number and click when the "magnifying glass" appears. The Edit Profile Document Popup appears.
4. In the Edit Profile Document Popup, select Document Options.
5. In the Document Edit Options dialog, select a Maximum % of Light Marks percentage (other than No Checks).
6. In the edit profile Document Edit Options area, place your mouse cursor over the On Failure area and click when the magnifying glass appears.

The On Failure dialog appears.

At the edit profile field level, if you define an edit (Partial Edit, Full Edit, Graybox Edit, or Always Edit) and then click On Failure.

Procedure:

1. In the edit profile, place your mouse cursor over either the Application or Document Name - Number and click when the "magnifying glass" appears. The Edit Profile Document Popup appears.
2. In the Edit Profile Document Popup, select Show All Field Edit Options.
3. In an edit profile field area, place your mouse cursor over the On Failure area and click when the magnifying glass appears.

The On Failure dialog appears.

You can define three types of On Failure Actions:

• Program Action defines actions (Reject record, Reject document, etc.) for ScanTools software to take when an edit fails.

The contents of the Program Action section of this dialog vary, depending on whether you are defining On Failure actions for Non-Graybox edits or for Graybox edits. In addition, for Graybox edits, the Program Action behaviors vary, depending on whether you are resolving a Standard Graybox or an ICR/OCR Graybox and on whether other fields in the same record are failing an edit.

• Print Action defines information (an operator message, field contents, etc.) to print on the sheet associated with the edit failure.

Print Actions are highlighted in red if your currently selected scanner does not support them.

• Scanner Action defines actions (Stop scanner, Send to stacker, etc.) for the scanner to take when an edit fails.

Scanner Actions are highlighted in red if your currently selected scanner does not support them.

On Failure Dialog Help Contents

Program Action

Non-Graybox Edits

Graybox Edits

Standard Graybox

ICR/OCR Graybox

Print Action

Scanner Action

Program Action

The options below determine what action ScanTools software takes when it encounters a failing document record.

CAUTION: The Program Actions available for Non-Graybox and Graybox edits differ. In addition, for Graybox edits, the Program Action behaviors vary, depending on whether you are resolving a Standard Graybox or an ICR/OCR Graybox.

Program Action - Non-Graybox Edits

Select what ScanTools software does when it encounters a failing document record.

No action

The document record is stored in the data file. The record is not flagged or rejected when it fails to pass an edit. However, character replacement does occur if it is specified in the Extended Edit Options dialog.

Clip field/Flag record

The document record is stored in the data file with a flag set in the NCS Header showing that the record failed an edit. Failing fields are presented for correction in the post-scan editor. "Clip field" is for Image Scanner Implementation Only and does not apply to OMR scanners. "Flag record" applies to both Image and OMR scanners.

For image clips to be taken during scanning, imaging must be enabled in the Application Settings dialog for the side of the sheet where the failure occurred. Because image clips are taken during scanning, the clipping of the failing fields is based on the edit profile selected at scan time. If a different edit profile is used for post-scan editing, image clips may not exist for the failing fields.

Clip field/Flag record is the default setting for non-graybox fields in edit profiles created in ScanTools version 5.1 and later. Profiles created in and migrated from earlier versions keep whatever setting was previously defined.

Reject record

The document record is discarded, except when online edit correction is being used.

• If you are using online edit correction, Reject record is silently ignored. The failing record is queued for online edit correction and written to the data file.
• If you are checking for Maximum % of Light Marks (Document Edit Options), Reject record or No action are the available choices.

Program Action - Graybox Edits

Select what ScanTools software does when it encounters a failing document record.

Graybox data is defined by the Graybox Tool and edit behavior depends on a variety of factors, including the type of scanner you are using, your On Failure settings, whether you are resolving a Standard Graybox or an ICR/OCR Graybox, whether you are archiving, and whether other fields failed an edit. To apply a graybox edit to a field, its first grid must be a Standard Graybox or an ICR/OCR Graybox.

Standard Grayboxes

Scanner Type Considerations

Image Scanners and Standard Graybox Edits

At scanning time, a Standard Graybox field is searched for the presence of image data and the appropriate read mark value is stored in the document record. A Graybox edit compares the value stored in the data record against the Graybox threshold defined in the edit profile. If the value in the data record is greater than or equal to the graybox threshold value, the graybox field passes the edit, the document is flagged for editing, an image clip of the graybox field is taken, and the record is presented for key entry in the post-scan editor. The data you key enter in the post-scan editor replaces the Graybox value initially placed in the output during scanning.

If the value in the data record is less than the graybox threshold value, the graybox field fails the edit. A failure triggers the On Failure actions (Program Action and Scanner Action) listed below.

OMR Scanners and Standard Graybox Edits

A graybox edit may be presented for key entry in the post-scan editor. This graybox edit behavior depends on a combination of factors including whether other edit failures are present in the record, whether the field can or cannot be blank, and what edit options were selected. There are no image clips when an OMR scanner is used but you can key enter data from forms. The data you key enter in the post-scan editor replaces the blanks initially placed in the output during scanning. See Graybox Display for Edit for graybox edit behavior details.

Data Not Present

By definition, data is not present in a Standard Graybox when the read value is below the Graybox Threshold Value set in the Graybox Edit Parameters dialog. See data not present.

No Action

Indicates you want to take no action on failure.

Standard Grayboxes that contain data will be presented in the post-scan editor for key entry when No Action is selected. The document record will be flagged for editing.

Standard Grayboxes that do not contain data will not be presented in the post-scan editor for key entry.

No Action is the default setting for graybox fields in edit profiles created in version 6.1 and later. Profiles created in and migrated from earlier versions keep whatever setting was previously defined.

Require key entry

Indicates you want to key enter data on failure.

Standard Grayboxes will be presented in the post-scan editor for key entry, whether data is present or not. The document record will be flagged for editing.

Standard Graybox image clips appear for the records where the graybox data value meets or exceeds the graybox threshold defined in the edit profile. Image clips will not be displayed when the graybox data value is below the graybox threshold.

Reject document

The document record is discarded if the graybox data value is less than the graybox threshold defined in the edit profile. The record is not written to the data file.

ICR/OCR Confidence Failure

If you define a Standard Graybox or if you have configured an OMR scanner, ICR/OCR Confidence Failure settings are ignored.

ICR/OCR Grayboxes

Scanner Type Considerations

• Image ScannersandICR/OCR Graybox Edits

At scanning time, an ICR/OCR Graybox is evaluated for the presence of image data. If the mark value is equal to or greater than the cutoff value defined in the application, a clip of the evaluate region is sent to the recognition engine for processing. Resolved characters are then written to the data file. Asterisks are stored in the data file in place of questionable characters. ICR/OCR Confidence Failure occurs if any of the resolved characters are below the Minimum Character Confidence or the field fails an ICR/OCR Mod 10 Check. This failure triggers the Program Action specified in the ICR/OCR Confidence Failure group box.

Data is considered to be Not Present if:

• The mark value for the grid is less than the graybox cutoff value.
• The mark value for the grid is equal to or greater than the graybox cutoff value but no characters were recognized.

This failure triggers the On Failure Program Action in the Data Not Present group box.

• OMR Scanners and ICR/OCRGraybox Edits

A graybox edit may be presented for key entry in the post-scan editor. This graybox edit behavior depends on a combination of factors including whether other edit failures are present in the record, whether the field can or cannot be blank, and what edit options were selected. There are no image clips when an OMR scanner is used but you can key enter data from forms. The data you key enter in the post-scan editor replaces the blanks initially placed in the output during scanning. See Graybox Display for Post-Scan Edit for graybox edit behavior details.

Data Not Present

By definition, data is considered not present in an ICR/OCR Graybox when the read value is below the Cutoff Value set in the Graybox Tool dialog or when the ICR/OCR engine recognizes no characters. See data not present.

No Action

Indicates you want to take no action on failure.

The ICR/OCR Graybox will not be presented in the post-scan editor for key entry.

No Action is the default setting for Data Not Present for graybox fields in edit profiles created in version 6.1 and later. Profiles created and migrated in from earlier versions keep whatever setting was previously defined.

Require key entry

Indicates you want to key enter data on failure.

ICR/OCR Grayboxes will be presented in the post-scan editor for key entry when no data is present. The document record will be flagged for editing.

ICR/OCR Grayboxes with a read value below the Cutoff Value will not be sent to the recognition engine but will be clipped and presented in the post-scan editor.

Reject document

The document record is discarded if the graybox data value is less than the Cutoff Value set in the Graybox Tool dialog. The record is not written to the data file.

ICR/OCR Confidence Failure

ICR/OCR Confidence Failure occurs if the recognition engine returns questionable characters for an ICR/OCR graybox or if there are no questionable characters but the field failed other edits such as Completeness or Justification. Questionable characters include those below the Minimum Character Confidence and those that fail an ICR/OCR Mod 10 Check.

No Action

Indicates you want to take no action on failure.

The ICR/OCR graybox will not be displayed in the post-scan editor for key entry, even if it contains data and the characters fail the ICR/OCR confidence check.

Graybox display for edit depends on a combination of factors, as noted in the Graybox Display for Post-Scan Edit chart.

Require key entry

Require key entry is the default value for ICR/OCR Confidence Failure.

ICR/OCR grayboxes appear if data is resolved and there are questionable characters.

The document record is flagged for editing if the data contains questionable characters. The record will be presented for key entry in the post-scan editor.

Reject document

The document record is discarded if the graybox fails an ICR/OCR confidence check. The record is not written to the data file.

NOTE: If a Mod 10 Check is defined in the ICR/OCR Parameters for an ICR/OCR graybox and that ICR/OCR graybox fails the Mod 10 Check at scan time, asterisks are written to the data file. At edit time, you will see "ICR/OCR low confidence characters should be verified." in the edit failure text.

Print Action

These selections cause the scanner’s transport printer to print the information you specify when this edit failure occurs. The items selected here are printed regardless of the program action selected above.

String: Checking this check box causes the character string in the field to be printed on the document when the document fails an edit.

Field Contents: Checking this check box causes the contents of a selected field to be printed on the document when the document fails an edit.

In addition to these items, printing items can also be defined in the Scanning Options dialog (serial number, batch number, run number, and scan date), the Output Field Entry dialog, and the Print Scores dialog.

Scanner Action

These selections determine what actions are performed by your scanner upon rejecting a document record.

• No action
• Stop scanner
• Send to primary select stacker and stop
• Send to secondary select stacker and stop (OpScan 15 and 21 scanners only)
• Send document to primary select stacker
• Send document to secondary select stacker (OpScan 15 and 21 scanners only)

If the document is a booklet, ScanTools software allows any sheet of a booklet to be selected. This is done in the application module, Document, Stacker menu selection. See Stacker Options. For details on what happens to sheets of a booklet depending on combinations of Program Action and Scanner Action, see Booklet Edits.

Actions listed in red are not available with the currently configured scanner

If your configured scanner is not equipped with a transport printer or a select stacker, the message "Actions listed in red are not available with the currently configured scanner" appears, in red, in the dialog.