Data Field

Defines what type of information this field will contain. Can be one of the following values:

• Boolean - Represents a Boolean (true or false) value.
• DateTime - Represents an instant in time, typically expressed as a date and/or time of day.
• Decimal - Represents a decimal value.
• Double - Represents a 64-bit floating point value.
• GUID - Represents a globally unique identifier (GUID).
• Int16 - Represents a 16-bit integer value.
• Int32 - Represents a 32-bit integer value.
• Int64 - Represents a 64-bit integer value.
• String - String values can store any type of text information.
• URL - A Uniform Resource Locator (URL) is a string of characters used to identify a web resource, such as a web page on an HTTP server, or a file on an FTP server.

The default extractor to use for this field. Can be one of the following values:

• Anchored Extract - Extracts text from a rectangular region located near a text anchor.
• Anchored OMR - Reads one or more checkboxes located near text labels.
• Find Barcode - Searches the document layout data for a barcode.
• Read Barcode - Reads a barcode value using barcode recognition.
• Reference - References an external extractor, such as a Data Type or Field Class.
• Text Pattern - Extracts a value from the text content using pattern matching.
• Zonal Extract - Extracts text content from a rectangular region of a specific page.

The minimum confidence required for extracted values. Any extracted field value with a confidence lower than this threshold will be set to error, requiring human review during Data Review.

Indicates the subelement of the field's data type to be used as the value for this field. For example, the built-in Address Data Type defines Address, City, State, and ZIP as subelements. To capture only the City from the address value, select the Address Data Type and indicate "City" as the subelement.

Generic property allowing an administrator to document the purpose of this Grooper Node.

The text alignment for this field. Can be one of the following values:

• Left - The object or text is aligned on the left of the control element.
• Right - The object or text is aligned on the right of the control element.
• Center - The object or text is aligned in the center of the control element.

The width of the field in pixels. Controls the width of the control which represents the field in the Index Panel. If the parent element is a Data Table, then this value specifies the column width.

The background color to use when the field has a validation error.

The background color for this item.

The foreground color for this item.

Controls whether this item is visible in the user interface.

Controls how the label for this item is displayed. Can be one of the following values:

• Left - The label is displayed to the left of the item.
• Above - The label is displayed above the item.
• Below - The label is displayed below the item.
• None - The label will not be displayed.

The text alignment to be used for the data element's label. Can be one of the following values:

• TopLeft - Content is vertically aligned at the top, and horizontally aligned on the left.
• TopCenter - Content is vertically aligned at the top, and horizontally aligned at the center.
• TopRight - Content is vertically aligned at the top, and horizontally aligned on the right.
• MiddleLeft - Content is vertically aligned in the middle, and horizontally aligned on the left.
• MiddleCenter - Content is vertically aligned in the middle, and horizontally aligned at the center.
• MiddleRight - Content is vertically aligned in the middle, and horizontally aligned on the right.
• BottomLeft - Content is vertically aligned at the bottom, and horizontally aligned on the left.
• BottomCenter - Content is vertically aligned at the bottom, and horizontally aligned at the center.
• BottomRight - Content is vertically aligned at the bottom, and horizontally aligned on the right.

Controls whether FieldSense™ is enabled for this field. Can be one of the following values:

• Enabled
• Disabled

Defines input masking settings. Can be one of the following values:

• Enabled
• Disabled

Defines multi-line input settings. Can be one of the following values:

• Enabled
• Disabled

The tooltip to display when a user hovers the mouse over this field. Include user assistance instructions here.

If set to true, the field will not be editable in the user interface.

If set to true, a value is required in the field.

If set to true, the field's value will persist when moving to the next document in data review.

If set to true, this field will require operator review. When Require Validation is enabled, the field will be created in an error state, and will remain in an error state until a user enters and leaves the field in the Index Panel. This feature is designed to ensure that a field receives human review.

If set to true, this field will not trigger recalculation

If set to true, this field will require operator review. Can be one of the following values:

• Enabled
• Disabled

Controls the character casing of this field. Can be one of the following values:

• Normal - The case of characters is left unchanged.
• Upper - Converts all characters to uppercase.
• Lower - Converts all characters to lowercase.

Indicates whether character-level position and confidence data should be saved. If true, character-level detail will be saved with the data element. If false, only the raw text of the element's value will be saved. As storing this information increases storage requirements and reduces performance, this feature should only be enabled for individual data elements in cases where it is needed.

Character-level data can be useful in custom activities or custom export sceanrios, and is also used in certain built-in Grooper activities.

The OCR Profile to use for rubberband OCR.

Generates the default value for the field. The expression must evaluate to a value matching the Value Type of the field. Below are various examples of default value expressions:

Default to a literal string value:
"None"

Default to a literal numeric value:
25.00

Default to the current date and time:
DateTime.Now

Default to the current date:
DateTime.Today

Default to the current user name:
Environment.UserName

Default to the current machine name:
Environment.MachineName

Default to the MIME type of the document:
Folder.NativeMimeType

Default to the name of the Content Type assigned to the document:
ContentTypeName

Default to the "Subject" metadata element of a PDF file:
DirectCast(Handler, PdfMimeTypeHandler).Subject

Default to the filename associated with a File System Link:
DirectCast(Link, FileSystemLink).FilePath

Default to the name of the 2nd directory level associated with a File System Link:
Link.GetPathSegment(1)

Default to the sender associated with a Mail Message:
DirectCast(Handler, MailMimeTypeHandler).From

Generate a unique idenfier:
Guid.NewGuid

A preview of the default value for this field with variables inserted.

Calculates the expected value for a field. The expression must evaluate to a value matching the Value Type of the field. Sections, Tables, and Fields which are peers in the Data Model hierarchy may be referenced by name. Below are various examples of calculate expressions:

Should equal the product of the Quantity and Unit Price fields:
Math.Round(Quantity * Unit_Price,2)

Should equal the sum of the Subtotal and Sales Tax fields:
Subtotal + Sales_Tax

Should equal the Invoice Date plus 30 days:
Invoice_Date.AddDays(30)

Should equal the sum of the 'Line Total' column in the 'Line Items' table.:
Line_Items.SumOf("Line Total")

Should equal the sum of the 'Total Hours' field from all instances of the 'Semester' section:
Semester.SumOf("Total Hours")

Call a static method named CalculateValue() in the 'Utilities' object library:
Utilities.CalculateValue(Instance)

When a Calculate Expression is provided, this property controls the behavior when the field is calculated. Can be one of the following values:

• Validate - The expression is used to validate the field value.
• SetIfEmpty - If the field is empty, it will be populated with the calculated value. Otherwise, the existing value will be validated.
• AlwaysSet - The field value will be always be set to the calculated value. In combination with a Read Only setting, this represents a pure calculated field.

The amount of tolerance allowed between a field's value and its calculated value. This setting affects the validation performed by a calculate expression. If this property is set to 0, then the field value must exactly match the calculated value.

Defines an expression which determines if the field value is valid or invalid. The expression must evaluate to a Boolean value. Sections, Tables, and Fields which are peers in the Data Model hierarchy may be referenced by name. A return value of True indicates that the value of the field is valid, and false indicates that the field value is invalid. Below are various examples of validate expressions:

Invoice Total must be greater than 0 and less than 100,000:
(Invoice_Total > 0) And (Invoice_Total < 100000)

Invoice Total must be greater than or equal the Subtotal:
Invoice_Total > Subtotal

Invoice Date cannot be older than 90 days:
DateTime.Now.Subtract(Invoice_Date).TotalDays <= 90

Invoice No cannot contain a tilde (~) character:
Not Invoice_No.Contains("~")

An optional custom message to display when the Validate Expression fails.

An Embedded Lexicon containing values for this field, which can include locally-defined lexicon entries as well as references to external lexicons.

If set to true, the field only allows values from the list and does not allow free typing.