Batch Process Step - Redaction Tester

Provides a dedicated interface for testing the Redact activity on a Batch Process Step, allowing users to preview redaction results on selected documents or pages.

Remarks

The Redaction Tester tab is a focused workspace for validating, previewing, and refining redaction logic within a Batch Process Step.
It is designed for solution designers and administrators who need to test redaction results, visually inspect redacted content, and verify configuration before deploying changes to production.

Purpose

Use the Redaction Tester to run the Redact activity on selected test sources, preview the effect of redaction settings, and visually verify that sensitive information is properly removed or obscured. This enables rapid feedback and iterative improvement of redaction configuration and rules.

UI Components

• Test Source:
  • Presents a hierarchical view of available test data, such as batches, folders, documents, or pages.
  • Selecting an item determines the input for redaction testing and what is displayed in the Document Viewer.
  • Supports navigation and selection using mouse and keyboard.
  • Context menus may be available for additional actions, such as expanding/collapsing nodes or viewing item details.
• Document Viewer:
  • Displays the content of the currently-selected document or page, with redactions optionally applied for preview.
  • Visually highlights or obscures redacted regions, allowing users to confirm that sensitive data is properly handled.
  • Supports a variety of document types and formats, including images, text, and structured data.
  • Provides navigation, zoom, and search features for efficient review.
• Test Button:
  • Executes the redaction activity on the selected test source.
  • Updates the Document Viewer with a preview of the redacted output.
  • Provides immediate feedback on redaction configuration and effectiveness.

Workflow and Scope

• The tab is enabled for Batch Process Steps configured with a Redact activity.
• Use the Test Source to select the batch, folder, document, or page to test.
• Click the {test} button to run redaction and update the Document Viewer with the redacted result.
• Visually inspect the redacted output to ensure that all sensitive information is properly removed or obscured.
• Repeat as needed to refine redaction rules and configuration.

Accessibility

• Fully navigable by keyboard and mouse.
• Visual cues and highlighting indicate the selected test source and redacted regions.
• Tooltips and context menus provide guidance for available actions and controls.

Example

The following diagram illustrates the typical layout of the Redaction Tester tab, with labeled sections and controls:

┌───────────────────────────────────────────────────────────────────┐
│ Redaction Tester                                           {test} │
├───────────────────────────────────────────────────────────────────┤
│ Test Source      │ Document Viewer                                │
│ ┌──────────────┐ │ ┌────────────────────────────────────────────┐ │
│ │ Batch        │ │ │                                            │ │
│ │ ├─ Folder 1  │ │ │                                            │ │
│ │ │ └─ Page 1  │ │ │     Document / Page Content (Redacted)     │ │
│ │ └─ Folder 2  │ │ │                                            │ │
│ │   └─ Page 1  │ │ │                                            │ │
│ └──────────────┘ │ └────────────────────────────────────────────┘ │
└───────────────────────────────────────────────────────────────────┘

• {test}: Button to execute redaction and preview the result.
• Test Source: Hierarchical selector for batches, folders, documents, or pages.
• Document Viewer: Displays the selected document or page with redactions applied for review.

Advanced Features

• Visual Redaction Preview: Instantly see the effect of redaction rules on real documents or pages.
• Rapid Iteration: Quickly test and refine redaction settings for optimal results.
• Integrated Navigation: Browse and select test sources, then immediately preview redacted output in the same interface.

For more information, see the documentation for Redact activity, Batch Process Step, and related workflow objects.

Command Buttons

Button	Shortcut Key		Summary
play_circle test		►	Executes the redaction activity on the selected test source and displays the redacted result in the document viewer. The test button runs the configured redaction logic for this step on the selected item in the Test Source, updating the Document Viewer with a preview of the redacted output. Click this button to execute the redaction activity on the currently-selected batch, folder, document, or page. The Document Viewer will refresh to display the redacted result, allowing you to visually verify that sensitive information is properly removed or obscured. The button is enabled only when a valid test source is selected and the redaction activity is ready to run. Usage Guidance: Select the desired test source, then click the test button to execute redaction. Review the redacted output in the Document Viewer to ensure that all sensitive data is handled as expected. Repeat as needed to validate and refine redaction configuration. > [!NOTE] > The test run affects only the selected item and does not modify production data.

Child Controls

Name	Type		Summary
Test Source	Test Source	►	Selects the document or page to use as the test source for redaction. The Test Source control provides a hierarchical view of available test data, such as batches, folders, documents, and pages. Use this control to select the specific item you want to use as input for redaction testing. The tree structure mirrors the batch hierarchy, allowing you to drill down from the batch root to folders, documents, and individual pages. Selecting an item in the tree determines both the input for the redaction test and what is displayed in the Document Viewer. Supports navigation and selection using mouse and keyboard. Toolbar buttons are available for searching ({search}), browsing ({browse}), and jumping directly to a selected item ({goto}). Context menus may be available for additional actions, such as flagging, renaming, or batch operations. Usage Guidance: Click on a batch, folder, document, or page to select it as the test source. The selected item will be highlighted, and its content will appear in the Document Viewer. Only items within the current step's scope are available for selection. Use the toolbar and context menu actions to streamline navigation and management of test sources. > [!TIP] > Use keyboard navigation (Up, Down, Left, Right) to quickly move through the hierarchy. For more information, see the documentation for Test Source, Batch, Batch Folder, and Batch Page.
Document Viewer	Document Viewer	►	Displays the currently-selected document or page, with redactions optionally applied for preview. The Document Viewer control renders the content of the selected test item, showing the effect of redaction settings. It provides visual feedback for reviewing and verifying redaction results. Automatically selects the most appropriate viewer/editor for the document type (image, text, PDF, email, ZIP, etc.). Visually highlights or obscures redacted regions, allowing you to confirm that sensitive data is properly handled. Supports navigation, zoom, and search features for efficient review. For paginated documents, provides controls to switch between pages. For text-based documents, supports searching and highlighting of terms. Context menu commands and toolbar buttons may be available for viewer-specific actions. Usage Guidance: The viewer updates automatically when you select a different item in the Test Source. Use built-in navigation and search features to explore the document and verify redactions. For unsupported or empty documents, a placeholder viewer is shown. > [!NOTE] > The Document Viewer is read-only in the Redaction Tester context; editing is not supported.

Used By

Design Tab Host