Data Grid

Displays a user interface for reviewing, correcting, or entering data for a Grooper document.

Remarks

The Data Grid is the primary UI component for presenting, editing, and validating extracted data from Grooper documents. It provides a structured, interactive view of a document's data model, supporting both production and design-time scenarios.

The Data Grid is responsible for rendering fields, tables, and sections defined by the document's Content Type, and enables users to review, correct, and validate extracted values. It supports keyboard navigation, context menus, and advanced features such as error navigation, sticky values, and preview rendering.

Usage Scenarios

• Production Review:
  In the Data Viewer, the Data Grid displays the extracted data for a document, allowing users to review and correct values, validate fields, and resolve errors before export or downstream processing.

• Design and Testing:
  On the Design Page, the Data Grid can be used to preview extraction results, test data models, and verify configuration changes in real time.

• Preview Mode:
  When configuring Data Elements on the Design Page, a live preview of the Data Grid is displayed to show how the data will appear.

Key Features

• Hierarchical Data Presentation:
  Presents fields, tables, and sections in a logical hierarchy that mirrors the document's data model.

• Keyboard Shortcuts:

  • Use F8 to navigate to the next error on the current document.
  • Use F7 to display a List Searcher when editing a field with a value list.
  • Use arrow keys to move between cells and sections.

• Context Menus:
  Provides right-click menus for fields and table rows, enabling quick access to commands such as flagging, clearing values, or launching custom actions. Context menus adapt to the selected item, offering relevant actions for fields, tables, or rows.

• Sticky Values:
  Supports the application and retrieval of sticky values, allowing certain field values to persist across documents for streamlined data entry. Sticky values can be applied or retrieved to speed up repetitive review tasks.

• Error Handling and Validation:
  Highlights invalid or missing values, supports error navigation, and integrates with document flagging mechanisms. Errors are visually flagged, and users can quickly jump to the next error using keyboard shortcuts.

• Tabular and Filtered Views:
  Can render data in a tabular format, filtered by Content Type, to support specialized review or extraction scenarios. Tabular views are especially useful for documents with tables or repeating sections.

Interactive Components

• Inputs:
  Editable fields use text boxes, dropdowns, or custom controls depending on the field type.
• Buttons and Commands:
  Save, reload, and context menu actions are available for document-level and field-level operations.
• Child Controls:
  The grid may embed other controls, such as Property Grid for advanced editing, or Thumbnail Viewer for page previews.
• Visual Indicators:
  Error flags, validation icons, and sticky value markers help users quickly identify issues and track changes.

Accessibility & Usability

• Keyboard navigation and shortcuts are fully supported for efficient review.
• Context menus provide quick access to common actions.
• Visual cues guide users to errors and required fields.
• Sticky values and auto-complete features reduce repetitive data entry.

Example Workflow

1. Open a document in the Data Viewer or Design page.
2. The Data Grid loads and displays the document's data model.
3. Review and edit fields, using context menus and keyboard shortcuts to correct errors or update values.
4. Save changes; errors are flagged for review, and sticky values are applied as needed.
5. Use advanced features such as preview mode or verbose statistics for specialized review scenarios.

Customizing Appearance of Data Elements

The appearance of Data Elements in the Data Grid is highly customizable using CSS properties and style sheets defined on Data Elements.
See CSS Builder for more details.

• Local CSS and Included Style Sheets:
  Use the CSS property on any Data Model, Data Section, or Data Table to define local style rules.
  Reference external style sheets (as Resource Files) using the 'Included Style Sheets' property on the Data Model for global or shared styles.

• CSS Class Assignment:
  Each Data Element (including Data Field, Data Section, Data Table, and Data Model) exposes a CSSClass property. Assign one or more class names to this property to target elements for custom styling.

• Dynamic Styling:
  Assign dynamic CSS classes by including a variable named "CSS_Class" on a Data Model, Data Section, or Data Table. This enables conditional formatting based on data values, extraction results, or workflow state.

Child Controls

Name	Type		Summary
Field Menu	Context Menu	►	The context menu to be used with fields in the Data Grid. Overview The Field Menu provides a right-click context menu for interacting with individual fields in the Data Grid. Purpose and Functionality Offers quick access to commands relevant to the selected Data Field, such as flagging, clearing values, launching custom actions, or opening the List Searcher. Adapts its available commands based on the field type, validation status, and workflow context. Enhances usability by allowing users to perform field-level actions without leaving the grid. How to Use Right-click any field in the Data Grid to open the Field Menu. Use arrow keys to navigate the menu, Enter or Space to execute a command, and Escape to close. Common commands include: Flag Field, Clear Value, Open List Searcher, and custom extraction or validation actions. Example > Right-click a field with a validation error and select "Flag Field" to mark it for review, or "Clear Value" to reset its contents.
Row Menu	Context Menu	►	The context menu to be used with table rows in the Data Grid. Overview The Row Menu provides a right-click context menu for interacting with table rows in the Data Grid. Purpose and Functionality Offers quick access to commands relevant to the selected Table Row Instance, such as adding, moving, or deleting rows, and launching custom row-level actions. Adapts its available commands based on the table configuration, row status, and workflow context. Supports efficient management of tabular data, including editing, validation, and error resolution. How to Use Right-click any row in a table within the Data Grid to open the Row Menu. Use arrow keys to navigate, Enter or Space to execute, and Escape to close. Common commands include: Add Row, Delete Row, Flag Row, and custom extraction or validation actions. Example > Right-click a row in the "Line Items" table to add a new item, delete an incorrect entry, or flag a row for further review.
Documents	Data Grid Document	►	One or more documents to be displayed in the Data Grid. Overview The Documents control represents the collection of documents currently loaded in the Data Grid. It serves as the primary container for all document data displayed, reviewed, and edited within the grid. Purpose and Functionality Displays the extracted data for each document, including fields, tables, and sections. Supports multi-document scenarios, allowing users to switch between documents or review multiple items in a batch. Provides the context for all grid operations, including navigation, editing, validation, and error handling. How to Use The grid automatically loads the relevant documents based on the selected batch, folder, or review context. Users interact with the grid to view, edit, and validate document data. Changes made in the grid are applied to the underlying document instances. Example > When reviewing a batch, the Documents control displays each document in turn, allowing you to correct errors and save changes.

Used By

Data ViewerData Element TesterContent Type - OverridesData Element - GeneralData Rule - Tester