Scan Viewer

Displays a folder-based hierarchical view of the batch, and includes controls for document scanning.

Remarks

The Scan Viewer provides an integrated interface for scanning documents directly into a batch within Grooper's Review Page.
It combines a hierarchical folder view of the batch with interactive controls for selecting a scanner, configuring device and scan settings, and performing scan operations.

• Appears as a tab on the Review Page when a Scan View is included in the Review configuration.
• Enables users to scan new pages, insert them at specific locations, and manage scanned content in real time.
• Communicates with the Grooper Desktop scanning utility to access local scanning hardware.

Main Components

• Batch Viewer: Presents a tree-based, folder-oriented view of the batch, allowing users to navigate, select, and organize documents and pages.
• Device and Settings Controls: Buttons for selecting the capture device, adjusting scanner settings, and managing scanner profiles.
• Scan Controls: Buttons to start, stop, and repeat scanning, as well as to insert scanned pages before or after selected items.
• Profile Management: Options to download scanner settings from a Scanner Profile or upload current settings for reuse.

Command Buttons

The Scan Viewer includes the following toolbar buttons:

• Device: Opens the device selection dialog to choose a connected scanner.
• Settings: Opens scanner settings for configuration (e.g., resolution, color mode, duplex).
• Profile Download/Upload: Download settings from or upload current settings to a Scanner Profile.
• Scan: Initiates scanning of all pages in the feeder.
  • Keyboard shortcut: Alt + Shift + S
• Scan Before/After: Scans pages and inserts them before or after the currently selected item in the batch tree.
  • Before: Alt + Shift + B
  • After: Alt + Shift + A
• Scan Repeat: Continuously scans, automatically resuming when new pages are detected.
  • Shortcut: Alt + Shift + R
• Stop: Stops the current scanning operation.
  • Shortcut: Esc

Context Menu Commands

The Scan Viewer supports a right-click context menu within the batch hierarchy, providing quick access to common batch and scan-related actions.
These commands are available when right-clicking on folders, documents, or pages in the batch tree:

• Scan: Scan all pages in the feeder and insert them at the selected location.
  • Shortcut: Alt + Shift + S
• Scan Before: Scan all pages in the feeder and insert them before the selected item.
  • Shortcut: Alt + Shift + B
• Scan After: Scan all pages in the feeder and insert them after the selected item.
  • Shortcut: Alt + Shift + A
• Scan Repeat: Begin continuous scanning, automatically resuming when new pages are detected.
  • Shortcut: Alt + Shift + R
• Stop: Stop the current scanning operation.
  • Shortcut: Esc

Usage Workflow

1. Open a batch in the Review activity.
2. Select the Scan Viewer tab to access scanning controls.
3. Choose a scanner device and adjust settings as needed.
4. Use the scan controls to acquire new pages, inserting them at the desired location in the batch.
5. Organize, review, and complete the batch as usual.

Grooper Desktop Integration

The Scan Viewer relies on a local web service provided by the Grooper Desktop scanning utility to enable all scanning operations from the browser-based UI. This integration is essential for secure, real-time access to local scanner hardware and image processing capabilities.

• Service Role: The Grooper Desktop utility hosts a web service (typically on localhost and a configurable port) that acts as a bridge between the web application and the user's physical scanning devices. All device access, scan commands, and image transfers are routed through this service.
• Device Discovery and Selection: When the Scan Viewer loads, it queries the Grooper Desktop service to enumerate available scanner devices. Users select and configure their scanner through the UI, with all selections and settings communicated to the service in real time.
• Scan Execution: Initiating a scan from the Scan Viewer sends a request (including all scan settings) to the web service. The service manages the scanner hardware, starts the scan, and applies any configured real-time image processing or separation logic.
• Image Retrieval: As pages are scanned, the web service processes and packages images—often as compressed ZIP streams—and makes them available for download by the Scan Viewer. The UI retrieves and displays these images in the batch hierarchy as they become available.
• Status Monitoring and Error Handling: The Scan Viewer regularly polls the web service for scan progress, device status, and error conditions. If the service is unavailable or an error occurs, scanning controls are disabled and a compatibility error message is shown to the user.
• Profile and Settings Management: Users can upload current scanner settings to, or download settings from, the web service. This allows for easy reuse and sharing of scanner profiles across sessions and users.

Technical Notes:

• All communication between the Scan Viewer and Grooper Desktop service is performed over HTTP using JSON payloads and streamed file transfers.
• The service exposes endpoints for device queries, scan control (start, stop, cancel), image retrieval, and settings management.
• The Scan Viewer will not allow scanning unless the Grooper Desktop utility is running and accessible.
• To change the port number used for communication with the Grooper Desktop scan service:
  • Change the port number in the web.config for the web client, under application settings key ScanViewer:PortNumber.
  • Access the settings for Grooper Desktop (from the system tray) and update the port number in the 'Port Number' field.

See Also

• Scan View
• Batch Viewer
• Scanner Profile
• Review activity
• Real Time Image Processor

Context Menu Commands

Command	Shortcut	Description
Scanner Scan	Alt+Shift+S	Scan all pages in the feeder.
Scanner Scan After	Alt+Shift+A	Scan all pages in the feeder and insert them after the selected item.
Scanner Scan Before	Alt+Shift+B	Scan all pages in the feeder and insert them before the selected item.
Scanner Scan Repeat	Alt+Shift+R	Continuously scan all pages in the feeder. When the feeder is empty, poll the scanner until more pages are detected, and then automatically resume scanning.

Command Buttons

Button	Shortcut Key		Summary
adf_scanner device		►	Opens the device selection dialog to choose a connected scanner. The Device button allows users to select which scanner device to use for scanning operations. Clicking this button displays a list of available scanners detected by the Grooper Desktop utility. Use this control to switch between multiple connected scanners. Device selection is required before scanning can begin. The selected device determines available settings and scan capabilities. Tip: If no devices are listed, ensure the Grooper Desktop utility is running and your scanner is connected.
tune settings		►	Opens the scanner settings dialog for configuration. The Settings button provides access to scanner configuration options such as resolution, color mode, duplex scanning, and more. Use this control to adjust scan quality and behavior before starting a scan. Settings are applied to the selected device and persist for the current session. Advanced options may be available depending on the scanner model. Example: Set the resolution to 300 DPI and enable duplex mode for double-sided scanning.
download profile_down		►	Downloads scanner settings from a Scanner Profile. The Profile Download button retrieves scanner settings from a saved Scanner Profile. This allows users to quickly apply standardized configurations for different scanning scenarios. Use this control to load predefined settings for specific document types or workflows. Downloaded settings overwrite the current scanner configuration. Profiles are managed and stored within Grooper. Tip: Use profiles to ensure consistent scan quality and settings across users and batches.
upload profile_up		►	Uploads the current scanner settings to a Scanner Profile. The Profile Upload button saves the current scanner configuration as a Scanner Profile. This enables users to reuse and share preferred settings for future scanning sessions. Use this control to create or update profiles with your current settings. Uploaded profiles are available for download by all users with access. Supports standardization and efficiency in multi-user environments. Example: After configuring settings for a specific document type, upload them as a profile for team use.
play_circle scan	Alt+Shift+S	►	Starts scanning all pages in the feeder. The Scan button initiates a scan using the selected device and current settings. All pages loaded in the scanner's feeder will be scanned and added to the batch. Shortcut: Alt + Shift + S Scanned pages are inserted at the currently selected location in the batch. Real-time image processing and separation logic are applied as configured. Tip: Use this control for standard batch scanning operations.
stop_circle stop	Escape	►	Stops the current scanning operation. The Stop button halts any active scanning process. Use this control if you need to cancel a scan in progress or if an error occurs. Shortcut: Esc Any pages already scanned will remain in the batch; unscanned pages will not be processed. Useful for quickly aborting a scan due to misfeeds, jams, or user intervention. Example: Press the Stop button or Esc if you notice a problem with the loaded documents.

Child Controls

Name	Type		Summary
Batch Viewer	Batch Viewer	►	Displays the batch hierarchy, allowing users to view and organize scanned documents and pages. The Batch Viewer presents a tree-based, folder-oriented view of the current batch. Users can navigate, select, and organize documents and pages within the batch. This control is central to reviewing scanned content, moving pages, and managing the batch structure. Selecting a node in the Batch Viewer determines where new scanned pages will be inserted. Supports drag-and-drop, context menus, and other batch management features. Reflects real-time updates as new pages are scanned and added. Usage Example: After scanning, select a document or folder in the Batch Viewer to insert additional pages at a specific location.

Used By

Review Page