ChkConfidence

Syntax

bool ChkConfidence (StrParam)

Parameters

Two or three comma-separated values:

1. The Numeric value of the minimum confidence required. This value is superseded on a field-by-field basis, if the field's ReqConf variable is set.
2. The Numeric Page Status code to assign to any page that has one or more fields with Low Confidence data: if a field's ConfidenceString property contains a value lower than the first parameter. Subfields, line items, and so on, are included. Typically, "1" (Problem) is the value of this parameter. If only two parameters are specified, only pages with Status=0 are checked by this action.
3. If a third parameter is supplied, these parameters specify the list of Page Statuses to be checked.

Smart parameters are supported.

Returns

True, if all fields in all source pages are High Confidence. False, if any field has Low Confidence data, or if the parameters are not Numeric.

Level

All levels. This action operates on the entire batch regardless of the level to which its rule is bound.

Details

Checks the confidence of all field data on selected pages, which are selected by Page Status, against a minimum acceptable confidence value (Parameter 1). If any fields contain Low Confidence data, the page is marked with the status specified as a parameter.

Optionally, checks only pages of the status that is specified as Parameter 3.

Example:

ChkConfidence(8,1)