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

Section Instance Collection

Element Container Instance Grooper.Core

Represents the value of a multi-instance Data Section object.

Remarks

The Section Instance Collection class models a collection of repeating Section Instances within a document’s extracted data.
It serves as the container for multi-instance (repeating) sections, enabling Grooper to capture, validate, and manage lists or groups of related records—such as line items, claims, or entries—within a document.

Role in Grooper

Section Instance Collections are created automatically during extraction when a Data Section is configured as multi-instance (i.e., a collection).
Each Section Instance Collection contains one or more Section Instances, each representing a single occurrence of the section’s data structure. The Section Extract Method assigned to a Data Section determines how the section instances are recognized and populated.

This class is essential for modeling and processing documents that contain lists or repeating groups, such as invoices with multiple line items, EOBs with multiple claims, or forms with repeating sections.

Usage and Configuration

  • Section Instance Collections 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, add, or remove individual section records within the collection.
  • Advanced users may interact with Section Instance Collections via expressions, custom code, or API integrations for automation, validation, or custom export scenarios.

Hierarchy and Structure

  • A Section Instance Collection is always associated with a Data Section configured for multiple instances.
  • Its children are Section Instances, each representing a single record or occurrence of the section’s data.
  • The class provides methods for inserting new records, validating the number of records, and managing the collection as a whole.

Extraction, Validation, and Review

  • Section Instance Collections are created and populated during the Extract activity, using the extraction logic defined in the Data Section.
  • Validation includes checking that the number of records falls within the allowed range, as defined by the section’s configuration.
  • The Section Instance Collection tracks validation status and error messages for the entire group, supporting robust quality control.
  • In the Data Review UI, the collection provides a paged or list view for reviewing and editing each record.

Integration with Other Grooper Features

  • Section Instance Collections support advanced features such as dynamic record management, validation of element counts, and integration with diagnostic logging.
  • They are used in workflows for data extraction, validation, review, and export, ensuring that grouped records are processed as a unit.
  • The class provides utility methods for adding, removing, and renumbering records, as well as for validating collection constraints.

Diagnostics and Audit Trails

  • Section Instance Collections participate in diagnostic logging and audit trails for extraction, validation, and review activities.
  • Diagnostic artifacts may include logs of record creation, validation errors (such as element count violations), and audit trails of user edits or automated changes.

Properties

NameTypeDescription
General
Document Reference

See Also

Rectangle

Notification