Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Table Row Instance

Field Container Instance Grooper.Core

Represents a table row in a Table Instance.

Remarks

The Table Row Instance class models a single row within a table’s extracted data in Grooper.
It serves as the container for all Table Cell Instances in a given row, enabling Grooper to capture, validate, and present the values for each column in a structured, row-based format.

Role in Grooper

Table Row Instances are created automatically during extraction as children of a Table Instance.
Each Table Row Instance contains one Table Cell Instance for each Data Column defined in the associated Data Table, ensuring that all expected columns are represented for every row.

Table Row Instances are essential for representing repeating data structures such as line items, transactions, or any tabular content within a document. They support both standard data rows and special rows such as footers for totals or summaries.

Usage and Configuration

  • Table Row Instances are managed by Grooper’s extraction engine and are not created or configured directly by end users.
  • They are visible in the Data Review UI, where users can review, validate, and edit the values for each cell in a row.
  • Advanced users may interact with Table Row Instances via expressions, custom code, or API integrations for automation, validation, or custom export scenarios.

Extraction, Validation, and Review

  • Table Row Instances are created and populated during the Extract activity, using the extraction logic defined in the Data Table and its Data Columns.
  • Validation is performed automatically or on demand, using rules defined in the Data Table, Data Column, and Data Model.
  • The Table Row Instance tracks validation status, error messages, and change tracking for all contained cells.
  • In the Data Review UI, the Table Row Instance provides a row-based view for reviewing, editing, and confirming tabular data.

Hierarchy and Structure

  • Table Row Instances exist only as children of Table Instance objects and contain one or more Table Cell Instances—one for each column.
  • Each row is associated with a specific Table Instance and is indexed by its position within the table.
  • The class provides methods for accessing cells by index or column name, retrieving cell values, and managing row-level properties such as footers.

Integration with Other Grooper Features

  • Table Row Instances support advanced features such as context-based extraction, footer row handling, and dynamic cell management.
  • They are used in workflows for data extraction, validation, review, and export, ensuring that tabular data is processed accurately and efficiently.
  • The class provides utility methods for annotation, error handling, and value management, supporting robust quality control and exception handling.

Diagnostics and Audit Trails

  • Table Row Instances participate in diagnostic logging and audit trails for extraction, validation, and review activities.
  • Diagnostic artifacts may include validation error messages, change logs, and audit trails of user edits or automated changes.

Properties

NameTypeDescription
General
Document Reference

See Also

Used By

Notification