Data Rule - Tester

Test the rule against documents in a test batch.

Remarks

The Data Rule Tester tab provides an interactive workspace for building, testing, and refining Data Rules in Grooper. This control is designed for solution designers, administrators, and subject matter experts who need to validate rule logic, review results, and troubleshoot rule configuration using real-world documents and immediate feedback.

Purpose

Use this tab to select a Data Rule, run tests against sample documents in a test batch, and review the results in a structured, visual format. The integrated workspace streamlines the process of developing, validating, and troubleshooting rule logic, providing powerful tools for rapid iteration and diagnostics.

UI Components

• Test Source Panel:

  • Displays a hierarchical tree of available test documents and batch folders.
  • Allows selection of the document or folder to test the rule against.
  • Supports multi-selection for batch testing scenarios.
  • May include context menu commands for sending items to the test batch, flagging, or organizing test data.

• Document Viewer:

  • Shows the currently-selected document, supporting images, PDFs, text, and other formats.
  • Provides navigation for multi-page documents, zoom, and fit-to-window options.
  • Allows users to visually verify the document content and context for rule testing.

• Data Grid:

  • Displays the extracted or transformed data for the currently-selected document after the rule is tested.
  • Supports sorting, filtering, and reviewing of rule results, including error flags and validation indicators.
  • May include context menu actions for reviewing, correcting, or exporting data.

• Toolbar and Buttons:

  • {test}: Execute the data rule and update the Data Grid with the results.
  • {diagnostics}: View diagnostics for the previous test, including error messages and performance metrics.
  • Button states and tooltips provide guidance for available actions and indicate when tests are complete or diagnostics are available.

Workflow and Scope

• The tab is available for any Data Rule node in the design tree.
• Select a test document or batch folder in the Test Source panel to begin testing.
• Click {test} to execute the rule and view results in the Data Grid.
• Use {diagnostics} to troubleshoot rule logic and review error messages or performance metrics.
• Use the Document Viewer to visually confirm rule results against the source content.
• Context menu commands and keyboard shortcuts streamline navigation and review.

Example

The following diagram illustrates the layout of the Data Rule Tester tab:

┌───────────────────────────────────────────────────────────────────────────────┐
│ Data Rule Tester                                         {test} {diagnostics} │
├───────────────────────────────────────────────────────────────────────────────┤
│ {Test Source}        │ {Data Grid}                                            │
│ ┌──────────────────┐ │ ┌────────────────────────────────────────────────────┐ │
│ │ Test Batch       │ │ │ Data Grid Results                                  │ │
│ │ ├─ Document 1    │ │ │ - Field 1: Value                                   │ │
│ │ ├─ Document 2    │ │ │ - Field 2: Value                                   │ │
│ │ ├─ Document 3    │ │ │ - ...                                              │ │
│ │ └─ Document 4    │ │ └────────────────────────────────────────────────────┘ │
│ │                  │ │ {Document Viewer}                                      │
│ │                  │ │ ┌────────────────────────────────────────────────────┐ │
│ │                  │ │ │ Document Preview                                   │ │
│ │                  │ │ │                                                    │ │
│ │                  │ │ │                                                    │ │
│ └──────────────────┘ │ └────────────────────────────────────────────────────┘ │
└───────────────────────────────────────────────────────────────────────────────┘

• Test Source: Tree of test batch folders and documents for rule testing.
• Document Viewer: Preview of the selected document.
• Data Grid: Tabular display of rule results and extracted/transformed data.
• {test}, {diagnostics}: Command buttons for executing the rule and viewing diagnostics.

Accessibility

• Fully navigable by keyboard and mouse.
• Visual cues and highlighting indicate the selected document, test status, and errors.
• Tooltips and context menus provide guidance for available actions.

Advanced Features

• Immediate Feedback: Rule results and diagnostics are updated in real time after each test run.
• Diagnostics: Access error messages, warnings, and performance metrics for troubleshooting rule logic.
• Batch Testing: Supports multi-selection and batch testing scenarios for comprehensive rule validation.
• Data Grid Features: Supports sorting, filtering, and reviewing of rule results, including error flags and validation indicators.
• Document Navigation: The document viewer supports zooming, panning, and page navigation for multi-page documents.

Command Buttons

Button	Shortcut Key		Summary
insert_chart_outlined diagnostics		►	View diagnostics for the previous test. The diagnostics button opens a diagnostics panel or dialog showing error messages, warnings, and performance metrics from the previous rule test. Use this command to troubleshoot rule logic and review detailed feedback. The button is enabled after a test is run and diagnostics are available. Tooltips provide guidance on usage and interpretation of diagnostics.
play_circle test		►	Execute the data rule and update the Data Grid with the results. The test button runs the selected data rule against the chosen document(s) and updates the Data Grid with the results. Use this command to validate rule logic and review extracted or transformed data. The button is enabled when a test source is selected and a rule is available. Tooltips provide guidance on running tests and interpreting results.

Child Controls

Name	Type		Summary
Test Source	Test Source	►	Displays a hierarchical tree of available test documents and batch folders. The Test Source control provides a navigable tree view of all test documents and batch folders available for rule testing. Allows selection of individual documents or folders to test the rule against. Supports multi-selection for batch testing scenarios. May include context menu commands for sending items to the test batch, flagging, or organizing test data. Selection updates the Data Grid and Document Viewer to reflect the chosen test context. Fully navigable by keyboard and mouse, with visual cues for selected items. Use this control to select the scope and source of documents for rule validation and diagnostics.
Document Viewer	Document Viewer	►	Displays the currently-selected document. The Document Viewer control shows the content of the currently-selected document from the test batch. Supports images, PDFs, text, and other document formats. Provides navigation for multi-page documents, zoom, and fit-to-window options. Allows users to visually verify document content and context for rule testing. Updates automatically when a new document is selected in the Test Source panel. May include context menu actions for page navigation, flagging, or document review. Use this control to confirm rule results and review document context during testing.
Data Grid	Data Grid	►	Displays data for the currently-selected document, and displays results after the "test" command is used. The Data Grid control presents the extracted or transformed data for the currently-selected document after the rule is tested. Supports sorting, filtering, and reviewing of rule results, including error flags and validation indicators. May include context menu actions for reviewing, correcting, or exporting data. Visual indicators highlight errors, validation issues, and flagged fields. Updates in real time after each test run, providing immediate feedback. Keyboard navigation and shortcuts are supported for efficient review. Use this control to analyze rule results, validate logic, and troubleshoot extraction or transformation issues.

Used By

Design Tab Host