Field - ABBYY Documentation

Field provides read-only access to a document field’s value, type, structure, and OCR metadata in a Condition activity script.

Properties

Name	Type	Access	Description
Children	Field[]	Read-only	Child fields.
DataType	DataType	Read-only	The field data type.
FieldType	FieldType	Read-only	The field type (for example, text, barcode, or image).
FullName	string	Read-only	The full path from the document root. Parent field names are separated by `/` — for example, `Vendor/Address`.
HasSuspiciousSymbols	bool	Read-only	`true` if the field value contains characters recognized with low confidence.
Id	string	Read-only	The field identifier. May be identical across instances of a repeating field.
InstanceIndex	int	Read-only	The index of the current instance among all repeating fields of the same type. Only meaningful for repeating fields.
Instances	Field[]	Read-only	All instances of this field. Only meaningful for repeating fields.
IsConfirmed	bool	Read-only	`true` if the value was confirmed by an operator during verification.
IsRepeatable	bool	Read-only	`true` if the field is repeating.
IsSuspicious	bool	Read-only	`true` if recognition wasn’t confident for the field. Review manually.
IsValid	bool	Read-only	`true` if `Text` converted successfully to a `Value` of the correct type; otherwise `false`.
IsVisible	bool	Read-only	`true` if the field is visible to operators; `false` if hidden during verification.
Name	string	Read-only	The field name.
Parent	Field	Read-only	The parent field.
Regions	Region[]	Read-only	Regions on the image where the field is located.
Symbols	Symbol[]	Read-only	An array of characters that form the original value of the field in text format.
Text	string	Read-only	The field text as detected on the document.
Value	object	Read-only	The field value converted to the appropriate data type (for example, date or float).

Access fields in the Document.Fields array

The Document.Fields array contains only top-level fields. To access fields nested within a field group, walk the Children property recursively. For example, to read the Address field of the Vendor group:

var docs = Context.Transaction.Documents; 
for (var d = 0; d < docs.length; d++) { 
    if (docs[d].ResultClass == "Invoice") { 
        var fields = docs[d].Fields; 
        
        // Find the "Vendor" field group 
        for (var f = 0; f < fields.length; f++) { 
            if (fields[f].Name == "Vendor" && fields[f].Children) { 
                
                // Look for "Address" within Vendor's children 
                for (var c = 0; c < fields[f].Children.length; c++) { 
                    if (fields[f].Children[c].Name == "Address") { 
                        var address = fields[f].Children[c].Value; 
                        // Use the address value 
                        return address != ""; 
                    } 
                } 
            } 
        } 
    } 
} 
return false;

Document

The document being processed by the Condition activity.

DataType

The possible data types a field can contain.

FieldType

The possible types a field can have in a Condition activity script.

Region

Area on a page image that contains the text for a field.

Symbol

A single recognized character with its low-confidence flag.

Object model

Full JavaScript object reference for Condition activity scripts.

Skill Designer

Documentation Index

​Properties

​Access fields in the Document.Fields array

​Related topics