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

Data Element Tester

Control GrooperReview.Pages.Design

Provides a user interface for unit testing data element extraction within a batch process.

Remarks

The Data Element Tester is an interactive UI component for building, testing, and refining extraction logic for Data Elements and Data Models in Grooper. It enables users to select a data element or document, run extraction tests, review results, and access diagnostics—all in a single, integrated workspace.

Purpose and Functionality

  • Test Extraction Logic:
    Select a Data Element or Data Model and run extraction tests against sample documents to validate and refine extraction rules.
  • Immediate Feedback:
    View extraction results in a data grid, with support for reviewing saved data, sorting, and filtering.
  • Diagnostics and Inspection:
    Access detailed diagnostics from previous tests and launch the Data Inspector for in-depth review of extracted data.
  • Document Preview:
    Visually verify extraction results against the source document using the integrated document viewer.
  • Contextual Actions:
    Action buttons (Test, Save, Diagnostics, Data Inspector) are enabled or disabled based on the current context and state.
  • Auto-Run Support:
    Optionally run extraction tests automatically when a new selection is made.

UI Components

  • Test Source Panel:
    • Tree viewer for selecting the data element or document to test.
    • Action buttons: {test}, {save}, {diagnostics}, {inspect}.
  • Main Panel:
    • Split layout with the data grid (extraction results) on the left and the document viewer on the right.
    • The data grid displays extracted values for the selected element or model.
    • The document viewer shows the currently-selected document for visual verification.
  • Action Buttons:
    • {test}: Run extraction and update the data grid.
    • {save}: Save changes to extracted data or test configuration.
    • {diagnostics}: View diagnostics from the previous test.
    • {inspect}: Open the Data Inspector in a new window for detailed data review.

Interactive Features

  • Selection-Driven Workflow:
    • Selecting a new data element or document updates the data grid and document viewer.
    • If 'AutoRun' is enabled, extraction tests run automatically on selection change.
  • Button State Management:
    • Buttons are enabled or disabled based on context (e.g., 'Save' is enabled only when there are unsaved changes).
  • Diagnostics and Data Inspector:
    • Diagnostics provide error messages, warnings, and performance metrics for troubleshooting extraction logic.
    • The Data Inspector allows in-depth analysis of extracted data, including structure and values.
  • Document Navigation:
    • The document viewer supports zooming, panning, and page navigation for multi-page documents.
  • Data Grid Features:
    • Supports sorting, filtering, and reviewing of extraction results.
    • For Data Models, loads saved data if available for the selected document.

Example

The following diagram illustrates the layout of the Data Element Tester:

┌───────────────────────────────────────────────────────────────────────────────┐
│ Test Source Panel                                                             │
│ ┌───────────────────────────────────────────────────────────────────────────┐ │
│ │ {test} {save} {diagnostics} {inspect}                                     │ │
│ └───────────────────────────────────────────────────────────────────────────┘ │
├───────────────────────────────────────────────────────────────────────────────┤
│ ┌─────────────── Data Grid ───────────────┐ ┌─────── Document Viewer ───────┐ │
│ │                                         │ │                               │ │
│ │                                         │ │                               │ │
│ │                                         │ │                               │ │
│ └─────────────────────────────────────────┘ └───────────────────────────────┘ │
└───────────────────────────────────────────────────────────────────────────────┘
  • {TestSource}: Tree viewer for selecting the data element or document.
  • {test}: Run extraction test.
  • {save}: Save changes.
  • {diagnostics}: View diagnostics from the previous test.
  • {inspect}: Open Data Inspector.
  • {DataGrid}: Tabular display of extraction results.
  • {DocumentViewer}: Preview of the selected document.

Usage Tips

  • Select a data element or document in the Test Source panel to begin testing.
  • Click {test} to run extraction and view results in the data grid.
  • Use {diagnostics} to troubleshoot extraction issues and {inspect} for detailed data review.
  • Save changes with {save} when modifications are made to extracted data or configuration.
  • Use the document viewer to visually confirm extraction results against the source content.
  • Enable 'AutoRun' to automatically test extraction on selection changes for rapid iteration.

The Data Element Tester streamlines the process of developing, validating, and troubleshooting extraction logic, providing immediate feedback and powerful tools for data model designers and solution developers.

Command Buttons

ButtonShortcut KeySummary

Child Controls

NameTypeSummary

Used By

Notification