Field Instance

Returns the current value of the Field Instance as a string. This is the primary data captured for the field, either extracted automatically or entered by a user.

Usage and Impact

• The value is set during extraction or by user entry in the Data Review UI.
• Changing the value will trigger validation and may affect downstream logic, exports, or reporting.
• The value is displayed in the Data Review UI and is the main output for export or integration scenarios.

Example

• For a field "Invoice Number", the value might be INV-12345.
• For a date field, the value might be 2025-07-23.

Returns the Data Element object that defines the structure, extraction logic, and validation rules for this instance.
This association enables Grooper to map the extracted value to its definition in the Data Model, supporting validation, reporting, and export.

Usage and Impact

• The data element is set automatically during extraction and cannot be changed by the user.
• Used internally for validation, display, and mapping of extracted values.
• Advanced users may reference the data element in expressions or custom logic for automation or validation.

Example

• For a field instance representing an invoice number, this property references the Data Field "Invoice Number" in the data model.

Specifies the logical name of the Data Instance, typically matching the name of the corresponding Data Field, Data Section, or Data Table in the data model.

Usage

• Used to identify the instance in the Data Review UI, logs, and exports.
• The name is set automatically during extraction, but can be changed in advanced scenarios (such as scripting or custom code).
• Changing the name may affect expressions or logic that reference this instance by name.

Example

• For a field instance, the name might be InvoiceNumber.
• For a section, it could be VendorInformation.

Indicates the extraction confidence score for this Data Instance, as a value between 0 and 1.
Higher values indicate greater confidence in the accuracy of the extracted or assigned value.

Usage and Impact

• Used to highlight low-confidence values in the Data Review UI.
• May be referenced in validation rules, export logic, or reporting.
• Confidence is set automatically by the extraction engine and is not typically edited by users.

Example

• A value of 0.98 indicates very high confidence.
• A value below 0.5 may indicate a value that should be reviewed or validated.

Displays the type name of the Data Instance.

Usage

• Useful for distinguishing between different types of data elements (such as fields, sections, or tables) in the Data Review UI.
• The display name is automatically determined and cannot be changed by the user.

Displays the display name of the Extractor Node that produced this Data Instance.
This helps designers trace the origin of extracted values and understand which extraction logic was applied.

Usage

• Useful for troubleshooting extraction results or understanding how a value was obtained.
• The source is set automatically and cannot be changed by the user.

Example

• If the value was extracted using a regular expression extractor named Invoice Number Regex, this property will display that name.

Identifies the Content Type that defines the structure and extraction logic for this Data Instance.
The content type determines which data elements, validation rules, and behaviors apply to the instance.

Usage

• Used to display or filter data by document type in the Data Review UI.
• The content type is set automatically based on the parent Document Instance or data model configuration.
• Changing the content type (in advanced scenarios) may affect extraction, validation, and export behavior.

Example

• For an invoice document, the content type might be Invoice.
• For a supporting document, it could be Receipt or Packing Slip.

Contains the collection of Data Instance objects that represent text labels providing context for this value. Each label in the list corresponds to a detected label or prompt on the document that is linked to this instance.

Usage and Impact

• The labels are determined automatically during extraction based on proximity, layout, or configured context rules.
• Reviewing the labels helps users understand which part of the document the value was extracted from and why.
• Editing or reordering labels is not typical, but may be performed in advanced scenarios for troubleshooting or custom scripting.

Example

• For a field labeled "Date of Birth:", the labels list will include a Data Instance for the "Date of Birth" text found near the value.

Contains the collection of Data Instance objects that represent alternate candidate values for this field. Alternates are generated when multiple possible values are detected during extraction, such as ambiguous matches or overlapping extraction results.

Usage and Impact

• Alternates are determined automatically during extraction and are used to present users with possible choices in the Data Review UI.
• Reviewing alternates helps users select the correct value when multiple candidates are found.
• Alternates can be used in custom validation, reporting, or export logic to improve data quality.

Example

• If a field could be extracted as either "12345" or "12346" due to OCR ambiguity, both values will appear as alternates.

Contains the collection of Checkbox Instance objects that are contextually linked to this value. Each checkbox represents an OMR mark detected near the value, such as a selection box on a form or survey.

Usage and Impact

• The checkboxes are detected and associated automatically during extraction when a Data Field is configured for OMR or checkbox context.
• Reviewing the checkboxes allows users to verify which marks were detected and how they relate to the extracted value.
• The checked state of each checkbox can be used in validation, reporting, or export logic.

Example

• For a field with multiple options, such as "Yes" and "No" checkboxes, the list will include a Checkbox Instance for each detected box, along with its checked state.

Returns true if the field is configured as editable, or false if it is read-only.
Determined by the 'ReadOnly' property of the Data Field.

Usage and Impact

• Read-only fields cannot be edited by users in the Data Review UI.
• Used to enforce business rules or protect calculated or system-generated values from manual changes.
• Can be referenced in expressions or custom logic to control UI behavior.

Example

• A value of true means the field cannot be edited by users.
• A value of false means the field is editable.

Can be one of the following types:

Returns the Storage Type that defines the underlying data type for this field, such as text, number, date, or boolean. The storage type controls how values are parsed, validated, and formatted.

Usage and Impact

• Used to enforce data type rules and formatting for the field value.
• Determines how multi-value (array) fields are handled, including the delimiter used for splitting values.
• Can be referenced in expressions or custom logic for advanced validation or export scenarios.

Example

• For a text field, the storage type is Text.
• For a date field, the storage type is DateTime.

Returns true if the value of this Field Instance passes all validation rules defined in the associated Data Field. Validation may include required status, data type checks, custom expressions, or external lookups.

Usage and Impact

• Used to highlight invalid values in the Data Review UI and to control workflow logic.
• The value is determined automatically during extraction or validation and cannot be set directly by users.
• Advanced users may reference this property in expressions or custom logic for automation or reporting.

Example

• A value of true means the value is valid and meets all requirements.
• A value of false means the value is missing, incorrect, or failed validation.

When the 'Is Valid' property is false, this value will contain an error message indicating the reason for invalidity. The message is generated by validation rules or custom logic and is displayed in the Data Review UI for user guidance.

Usage and Impact

• Used to inform users of validation errors and guide corrections.
• The message is set automatically during validation and can be customized in the Data Field configuration.
• Can be referenced in expressions or custom logic for reporting or workflow control.

Example

• "Value is required but missing."
• "Invalid date format. Expected MM/DD/YYYY."

The 'Has Been Reviewed' property tracks whether the value of this Field Instance has been reviewed in the Data Review UI or by a user action.

Usage and Impact

• Set automatically when a user reviews or confirms the value in the UI.
• Can be used in workflow logic to require user review before export or approval.
• Useful for tracking review status in quality control or exception handling scenarios.

Example

• A value of true means the field has been reviewed and acknowledged by a user.
• A value of false means the field has not yet been reviewed.

Returns true if the field is configured as required, or false if it is optional.
Determined by the 'Required' property of the Data Field.

Usage and Impact

• Required fields must have a value to be considered valid.
• Used to enforce data completeness and support validation workflows.
• Can be referenced in expressions or custom logic to control UI behavior or export logic.

Example

• A value of true means the field must have a value.
• A value of false means the field is optional.

The 'Confirmed' property indicates that the value of this Field Instance has been explicitly confirmed as correct, either by a user or by automated logic.

Usage and Impact

• Set to true when a user or process confirms the value is correct and should not be changed.
• Used to lock the value against further validation errors or changes, supporting review and approval workflows.
• Can be referenced in expressions or custom logic to control downstream processing.

Example

• A value of true means the field is confirmed and will not be flagged as invalid, even if validation rules would otherwise apply.
• A value of false means the field is subject to normal validation and review.

Displays the character span (start index and length) of this Data Instance within its parent.
This helps users and advanced solution designers understand the precise location of the value in the parent’s text.

Usage

• Useful for troubleshooting extraction logic or understanding how values are mapped within the document.
• The span is set automatically and is not typically edited by users.

Example

• A span of Index=15, Length=8 means the value starts at character 15 and is 8 characters long within the parent instance.

The 'Page No' property returns the 1-based page number where this Data Instance is located within the document. This is calculated from the zero-based 'Page Index' property, making it suitable for display in user interfaces and reports.

Usage and Impact

• Used to display the page number in the Data Review UI, logs, and exports.
• Helps users and solution designers identify the physical page location of extracted values.
• The value is set automatically during extraction and cannot be changed by users.

Example

• If the instance's 'Page Index' is 0, 'Page No' will be 1 (the first page).
• If 'Page Index' is 4, 'Page No' will be 5 (the fifth page).

Specifies the rectangular region (in inches) on the page where this Data Instance was extracted or is located.
The location is used for highlighting, review, and geometric validation.

Usage and Impact

• The location is set automatically during extraction if geometric data is available (such as from OCR).
• Used to highlight the value in the document viewer during review.
• Can be edited in advanced scenarios using the zone editor.
• If the value spans multiple pages or is not associated with a specific region, the location may be empty.

Example

• A value of Left=1.25, Top=2.00, Right=2.75, Bottom=2.25 indicates a rectangular region on the page.

The 'Has Ocr Parity' property returns true if the number of characters in the instance's 'Value' exactly matches the number of OCR items in its associated OCR results. This indicates a one-to-one correspondence between each character in the value and an OCR result, which is important for precise mapping, highlighting, and validation of extracted text.

Usage and Impact

• Used to determine if the value can be reliably mapped to OCR data for geometric highlighting or advanced extraction scenarios.
• A value of true means each character in the value has a corresponding OCR item, supporting accurate region mapping and review.
• A value of false may indicate that the value was modified, post-processed, or does not directly correspond to OCR data.

Example

• If the value is "Invoice123" and there are exactly 10 OCR items, 'Has Ocr Parity' is true.
• If the value is "Invoice 123" but only 9 OCR items (due to a missing space or character), 'Has Ocr Parity' is false.