Table Instance

The 'Instance No' property identifies the position of this Field Container Instance within its parent collection, such as a section, table, or repeating group. This index is used to distinguish between multiple instances of the same data element, enabling Grooper to support repeating sections, table rows, and other multi-instance structures.

Usage and Impact

• The instance number is assigned automatically by Grooper during extraction or when new instances are added.
• It is zero-based, meaning the first instance in a collection has an 'Instance No' of 0, the second is 1, and so on.
• The property is used in the Data Review UI to label and differentiate repeated elements (e.g., "Line Item 1", "Line Item 2").
• Changing the instance number (typically via scripting or advanced automation) will affect the display order and naming of the instance.

Example

• In a table with three rows, the first row's 'Instance No' is 0, the second is 1, and the third is 2.
• In a repeating section, each occurrence is assigned a unique instance number based on its order.

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 Table Header Instance objects that represent detected or configured column headers for this table. Each header provides context for the columns, supporting dynamic column ordering, header-based extraction, and improved accuracy in table recognition.

Usage and Impact

• Column headers are determined automatically during extraction or can be configured in the Data Table.
• Reviewing column headers helps users understand how columns were mapped and extracted from the document.
• Headers are used for display in the Data Review UI and for advanced extraction scenarios.

Example

• For a table with columns "Item", "Qty", and "Price", the column headers collection will include header instances for each detected or configured column.

Contains the list of Table Header Instance objects that represent detected or configured row headers for this table. Row headers provide context for rows, supporting advanced extraction scenarios such as multi-level headers or row grouping.

Usage and Impact

• Row headers are determined automatically during extraction or can be configured in the Data Table.
• Reviewing row headers helps users understand how rows were mapped and extracted from the document.
• Row headers are used for display in the Data Review UI and for advanced extraction scenarios.

Example

• For a table with grouped rows (e.g., by category), the row headers collection will include header instances for each detected or configured group.

The 'Footer Row' property represents a special Table Row Instance at the end of the table, typically used for totals, summaries, or calculated values.

Usage and Impact

• The footer row is generated automatically if the Data Table is configured to include a footer.
• Footer cells can be calculated, validated, or manually entered, depending on the configuration of each Data Column.
• The footer row is displayed in the Data Review UI and can be used in exports or reporting.

Example

• For an invoice table, the footer row may include the sum of the "Total" column or other summary values.

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.