IP Step - Tester

Edit properties and test image processing for a single IP Step.

Remarks

The IP Step Tester tab provides an interactive workspace for configuring, testing, and troubleshooting individual IP Steps in Grooper image processing workflows. This control is designed for solution designers and administrators who need to validate step logic, tune command parameters, and review diagnostic output using real-world images and immediate feedback.

Purpose

Use this tab to edit the properties of the selected IP Step, configure its associated IP Command, select test images, execute image processing tests, and review diagnostics. The workspace streamlines the process of building, validating, and troubleshooting image processing steps, supporting rapid iteration and diagnostics.

UI Components

• Step Properties Panel:
  • Displays all configurable properties of the current IP Step in a categorized, interactive grid.
  • Supports inline editing, drop-down lists, checkboxes, and expandable sections for complex properties.
  • Provides contextual help and validation for each property, with a help window that updates as you select different fields.
  • Right-click to access context menu commands such as Clear, Reset, Copy, and Paste.
• Command Properties Panel:
  • Displays all properties of the IP Command associated with the current step.
  • Supports editing of command-specific parameters, such as thresholds, detection options, and advanced settings.
  • Contextual help and validation are provided for each command property.
• Test Source Panel:
  • Allows selection and browsing of batches or documents to use as test images.
  • Supports hierarchical navigation and multi-selection for batch testing scenarios.
  • Toolbar buttons for searching, browsing, and navigating to specific items.
• Diagnostics Viewer:
  • Displays diagnostic output generated during image processing tests.
  • Shows logs, error messages, and supporting files in a dual-pane layout (file/folder tree and document viewer).
  • Allows users to preview diagnostic files, review logs, and analyze results.
• Toolbar and Buttons:
  • {test}: Execute a test on the current image using the configured IP Step.
  • {toggle}: Enable or disable automatic testing when the selected test document changes.
  • {unit}: Toggle unit testing mode (test only the current step, or the entire IP Profile).
  • {save}: Save changes to the properties of the IP Step.
  • {cancel}: Discard unsaved changes and revert to the last saved state.
  • Button states and tooltips provide guidance for available actions and indicate when unsaved changes are present.

Workflow and Scope

• The tab is available for any IP Step node in the design tree.
• Edit step properties and command parameters to define the logic and configuration of the image processing operation.
• Use the test source panel to select images for testing.
• Click {test} to execute the image processing step and review results in the diagnostics viewer.
• Use {toggle} to enable or disable automatic testing on image selection changes.
• Use {unit} to switch between unit testing (single step) and full profile testing up to the current step.
• Save changes to update the step configuration, or cancel to revert to the previous state.

Example

The following diagram illustrates the typical layout of the IP Step Tester tab, modeled after the IP Container Tester layout:

┌──────────────────────────────────────────────────────────────────┐
│ Tester                    {test} {toggle} {unit} {save} {cancel} │
├──────────────────────────────────────────────────────────────────┤
│ ┌───────── Left Pane ─────────┐ ┌───────── Right Pane ─────────┐ │
│ │ {StepProperties}            │ │ {Diagnostics}                │ │
│ │ ┌─────────────────────────┐ │ │ ┌──────────────────────────┐ │ │
│ │ │ Step Property Grid      │ │ │ │ Diagnostics Viewer       │ │ │
│ │ │ - Name                  │ │ │ │ - Diagnostics Tree       │ │ │
│ │ │ - Enabled               │ │ │ │ - Document Viewer        │ │ │
│ │ │ - Should Execute        │ │ │ │ - Log Output             │ │ │
│ │ │ ...                     │ │ │ │ - Diagnostic Images      │ │ │
│ │ └─────────────────────────┘ │ │ │ ...                      │ │ │
│ │ {CommandProperties}         │ │ │                          │ │ │
│ │ ┌─────────────────────────┐ │ │ │                          │ │ │
│ │ │ Command Property Grid   │ │ │ │                          │ │ │
│ │ │ - Command Type          │ │ │ │                          │ │ │
│ │ │ - Parameters            │ │ │ │                          │ │ │
│ │ │ ...                     │ │ │ │                          │ │ │
│ │ └─────────────────────────┘ │ │ │                          │ │ │
│ │ {TestSource}                │ │ │                          │ │ │
│ │ ┌─────────────────────────┐ │ │ │                          │ │ │
│ │ │ Batch Contents Tree     │ │ │ │                          │ │ │
│ │ │ - Folder 1              │ │ │ │                          │ │ │
│ │ │   - Document 1          │ │ │ │                          │ │ │
│ │ │   - Document 2          │ │ │ │                          │ │ │
│ │ │ - Folder 2              │ │ │ │                          │ │ │
│ │ │   - Document 3          │ │ │ │                          │ │ │
│ │ └─────────────────────────┘ │ │ └──────────────────────────┘ │ │
│ └─────────────────────────────┘ └──────────────────────────────┘ │
└──────────────────────────────────────────────────────────────────┘

• {StepProperties}: Edit and configure all properties of the IP step (top left).
• {CommandProperties}: Edit and configure all properties of the associated IP command (middle left).
• {TestSource}: Select and browse batches or documents for image processing tests (bottom left).
• {Diagnostics}: Review diagnostic output, logs, and supporting files after test execution (entire right pane).
• {test}, {toggle}, {unit}, {save}, {cancel}: Command buttons for testing, auto-test, unit test, saving, and discarding changes.

Accessibility

• Fully navigable by keyboard and mouse.
• Contextual help and validation are provided for all properties.
• Tooltips and context menus offer guidance for available actions.

Advanced Features

• Unit Testing: Test only the current step or the entire IP Profile for targeted validation.
• Live Testing: Instantly execute image processing tests and review diagnostics.
• Auto-Test: Enable automatic testing when the test source changes for rapid iteration.
• Diagnostics Review: Access detailed logs, error messages, and supporting files for troubleshooting.
• Contextual Help: Access documentation and usage guidance for each property and command.

Command Buttons

Button	Shortcut Key		Summary
play_circle test		►	Execute a test on the current image. The test button runs the configured image processing step on the selected test image(s) and updates the diagnostics output. Use this command to validate step logic and review results. The button is enabled when a test source is selected and the step is properly configured. Tooltips provide guidance on running tests and interpreting results.
toggle_on toggle		►	Toggle automatic testing on or off. This controls whether a test is run automatically each time the selected test document changes. When enabled, tests run automatically after each change to the selected test document. When disabled, tests must be run manually using the {test} button. Tooltips provide guidance on auto-test mode and its impact on workflow.
filter_alt unit		►	Toggle unit testing on or off. The unit button switches between unit testing mode (testing only the current step) and full profile testing (testing all steps up to the current one). When enabled, only the current step is tested. When disabled, the entire IP Profile is tested. Use this command to isolate and validate the behavior of a single step, or to test the step with all of the previous steps completed. The button is enabled when a test source is selected and the step is properly configured. Tooltips provide guidance on unit test mode and its impact on workflow.
save save		►	Save changes to the properties. The save button commits all changes made to the properties of the current IP Step. Applies edits to step logic, command parameters, and advanced options. The button is only enabled when there are unsaved changes. Tooltips provide guidance on saving and versioning.
cancel cancel		►	Discard changes to the properties. The cancel button reverts all unsaved changes to the properties of the current IP Step. Restores all properties to their last saved state, discarding any edits made since the last save. The button is only enabled when there are unsaved changes. Tooltips provide guidance on canceling and data loss prevention.

Child Controls

Name	Type		Summary
Step Properties	Property Grid	►	Properties of this IP Step. The Step Properties control displays all configurable properties of the current IP Step in a categorized, interactive grid. Properties are grouped by category and shown as rows with their name, value, and optional description. Supports inline editing, drop-down lists, checkboxes, color pickers, and expandable sections for complex or list properties. Provides contextual help and validation for each property, with a help window that updates as you select different fields. Right-click any property to access context menu commands such as Clear, Reset, Copy, and Paste. Validation errors are visually indicated, and error messages are shown in the help window. Keyboard navigation and multi-property selection are supported for efficient editing. Use this control to configure all aspects of the image processing step, including execution logic, step options, and advanced settings.
Command Properties	Property Grid	►	Properties of the IP Command associated with this IP Step. The Command Properties control displays all properties of the IP Command assigned to the current IP Step. Shows command-specific parameters such as thresholds, detection options, and advanced settings. Supports inline editing, drop-down lists, checkboxes, and expandable sections for complex command properties. Provides contextual help and validation for each command property, with a help window that updates as you select different fields. Right-click any property to access context menu commands such as Clear, Reset, Copy, and Paste. Validation errors are visually indicated, and error messages are shown in the help window. Keyboard navigation and multi-property selection are supported for efficient editing. Use this control to fine-tune the behavior of the image processing command executed by the step.
Test Source	Test Source	►	Allows selection and browsing of batches or documents to use as test images. The Test Source control enables users to select and browse batches or documents for image processing tests. Presents a hierarchical tree of folders, batches, and documents available for testing. Supports multi-selection for batch testing scenarios. Includes toolbar buttons for searching, browsing, and navigating to specific items. Selection updates the test context for image processing and diagnostics. Fully navigable by keyboard and mouse, with visual cues for selected items. Use this control to choose the source images for testing and validation of the IP step configuration.
Diagnostics	Diagnostics Viewer	►	Displays diagnostics after executing a test. The Diagnostics control presents diagnostic output generated during image processing tests. Shows logs, error messages, and supporting files in a dual-pane layout: file/folder tree on the left and document viewer on the right. Allows users to preview diagnostic files, review logs, and analyze results. Visual indicators highlight errors, warnings, and critical events. Includes a {launch} button to open the Diagnostics Viewer in a new window for expanded review. Automatically updates after each test run, providing immediate feedback and troubleshooting tools. Use this control to review diagnostic output, troubleshoot image processing steps, and analyze test results.

Used By

Design Tab Host