Checkbox Instance

Specifies the exact location and size of the detected checkbox, in inches, relative to the page.
This region is used for annotation, highlighting, and validation of the checkbox in the document viewer.

Usage

• The bounds are set automatically during extraction and reflect the detected position of the checkbox mark.
• Used to visually highlight the checkbox in the Data Review UI and to support geometric validation.
• Can be referenced in custom logic or export scenarios where the physical location of the checkbox is required.

Example

• A value of Left=2.10, Top=3.25, Right=2.30, Bottom=3.45 indicates a small square region on the page.

Returns true if the checkbox was detected as marked (checked), or false if it was unmarked (unchecked).
This value is determined by OMR analysis during extraction and can be reviewed or corrected by users.

Usage and Impact

• Used to populate the value of checkbox or OMR fields in the data model.
• The checked state is displayed in the Data Review UI and can be edited if manual correction is needed.
• Downstream logic, such as validation rules or exports, may use this property to determine the meaning of the checkbox.

Example

• true indicates the checkbox is filled or marked.
• false indicates the checkbox is empty or unmarked.

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.

Contains the extracted, calculated, or user-entered text value for this Data Instance.
The value may represent a single character, a word, a field, or the entire document, depending on the instance’s role in the data model.

Usage and Impact

• The value is populated automatically during extraction, but can be edited by users in the Data Review UI.
• Changing the value will clear any cached preprocessing results, ensuring that validation and formatting are recalculated.
• The value is used for validation, export, and reporting throughout Grooper.

Example

• For a field instance representing an invoice number, the value might be: INV-12345
• For a section instance, the value could be a block of address text.

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.

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.