Scan Viewer (UI Element): Difference between revisions

From Grooper Wiki
Line 594: Line 594:
** For most scenarios, a self-signed certificate is sufficient to connect using HTTPS. For information on how to create and bind a self-signed certificate to the Grooper website, [[Install_and_Setup#How to create and bind a self-signed certificate|review this part of the Install and Setup article.]]
** For most scenarios, a self-signed certificate is sufficient to connect using HTTPS. For information on how to create and bind a self-signed certificate to the Grooper website, [[Install_and_Setup#How to create and bind a self-signed certificate|review this part of the Install and Setup article.]]


=== Encountering "Unable to load Grooper.HPC.dll" and "Grooper.HPC.dll not found" errors ===
=== Encountering "Unable to load Grooper.HPC.dll" errors ===


These errors can crop up in multiple contexts in Grooper. However, it is most commonly encountered during scanning. These errors most commonly occurs due to:
These errors can crop up in multiple contexts in Grooper. However, it is most commonly encountered during scanning. These errors most commonly occurs due to:

Revision as of 08:23, 13 January 2026

This article is about the current version of Grooper.

Note that some content may still need to be updated.

20252024 2023

The Scan Viewer is a user interface that can be added to the user-attended person_search Review step in a settings Batch Process. It is used to scan documents into inventory_2 Batches from one or more scanning workstations.

About

The Scan Viewer interface

The Scan Viewer allows Grooper users to scan documents using a scanner connected to a workstation. The Scan Viewer can be executed in a Batch Process from a Review step. In order to operate the Scan Viewer the Grooper Desktop application must be installed and running on the scan user's workstation.

BE AWARE: Scanner drivers will need to be installed on the user's machine in order to scan.

This article presumes you've already installed scanner drivers on the user's machine.


BE AWARE: For Grooper Desktop to scan to the Grooper web server, you must connect securely in the browser (HTTPS).

All users:

  • Always use HTTPS to connect to the Grooper web app.
  • NEVER use HTTP to connect to the Grooper web app.
  • Scanned images will be refused if using an HTTP address.

Design users and administrators:

  • A self-signed certificate on the Grooper web server should be sufficient for scenarios where Grooper is isolated to your own network.
  • For information on how to create and bind a self-signed certificate, review this part of the Install and Setup article.

Installing Grooper Desktop

Grooper Desktop is a lightweight application required to scan paper documents into Grooper using scanner hardware. Furthermore:

  • Grooper supports ISIS and TWAIN scanner drivers.
  • Grooper Desktop must be installed on any desktop computer connected to scanner hardware.
  • Grooper Desktop runs as a service in the background. It can be opened from the Windows system tray to start and stop it.
  • Grooper Desktop must be running (started) in order to scan.
  • Once installed, users will use the Review activity's "Scan Viewer" to scan documents into Grooper.
  • Grooper Desktop drives the scanner from the Scan Viewer. It starts and stops the scanner from the Scan Viewer UI. It "listens" for images being scanned and sends them to the Grooper Repository.

In some cases, antivirus software will interfere with Grooper's installation, preventing a complete install.

  • You may need to whitelist the Grooper installers/software before installing.
  • This will ensure the antivirus software is not preventing DLL files from installing or executing.


Most commonly, this issue has been demonstrated when installing the Grooper Desktop application.

If Grooper Desktop is installed correctly, and you are able to scan using the scanner's native software (but not with Grooper), you may need to (1) uninstall Grooper Desktop, (2) whitelist the Grooper Desktop installer and GrooperDesktop.exe application and (3) reinstall Grooper Desktop to ensure you can scan from the Grooper web client.

To install Grooper Desktop:

  1. After extracting the installer ZIP package, open the extracted folder "GrooperDesktop_25.00.xxxx" to reveal the installation files.
  2. Open "setup.exe" to start the Grooper Desktop Installer.
    • This must be installed as an admin. The installer will run a network shell command to allow Grooper Desktop to communicate with the Grooper web server.
  3. When the installer opens, click "Next" to continue.
    • If this is your first time installing Grooper, you may be prompted to install one or more perquisite applications.
      • If prompted, select "Install" to start installing prereqs.
      • BE AWARE: Certain perquisite installs may require a restart. When prompted, please restart. After restarting, you will need to complete steps 1 through 4 again to continue your installation.
  4. After reading through the End User License Agreement, push the radio button next to "I accept the terms in the license agreement".
  5. Click "Next" to continue.
  6. If desired, you can choose the location where you want Grooper Desktop installed.
    We recommend using the default file path.
  7. Click "Next".
  8. Click the "Finish" to complete installation.

Installation should only take a few minutes. Press the "Finish" button when prompted to exit the installer.

FYI

Users no longer have to register a netsh command after installing Grooper Desktop

Previous versions of Grooper Desktop required an additional next step. Users would need to open the Windows Command Console and register a netsh command. The Grooper Desktop installer now does that step for you as part of its installation.

To download the installer for Grooper Desktop, click here



To open Grooper Desktop:

  • Press the Windows key on your keyboard or click the Windows Start icon and search for "Grooper Desktop"
  • Or, open the GrooperDesktop.exe file in your "Program Files (x86) > BIS > Grooper Desktop" folder



When Grooper Desktop is opened, it automatically starts running. When it starts running, you will see a notification in the right corner of your screen, informing you "Scan Server Started".


Grooper Desktop is a system tray application.

If Grooper Desktop is open but has stopped, you will need to manually start it. You can do so from the system tray by clicking on the "G" icon.


Press the "Start" button to manually start running Grooper Desktop.



The Scan Viewer for end-users

BE AWARE: For Grooper Desktop to scan to the Grooper web server, it is best practice to connect securely in the browser (HTTPS).

All users:

  • Always use HTTPS to connect to the Grooper web app.
  • NEVER use HTTP to connect to the Grooper web app.
  • Scanned images may be refused by your organization's browser policies if using an HTTP address.

Design users and administrators:

  • A self-signed certificate on the Grooper web server should be sufficient for scenarios where Grooper is isolated to your own network.
  • For information on how to create and bind a self-signed certificate, review this part of the Install and Setup article.

Managing device selection

Before you can start scanning, Grooper needs to know what scanner is hooked up and what settings you intend to use to scan. Depending on how the Scan Viewer is configured, you may do things in one of the following ways:

  • If the Scan Viewer has a default Scanner Profile, the user will not need to configure anything. The Scan Viewer will use the device and settings defined in the Scanner Profile.
  • If no default Scanner Profile is set, the user can select and configure the scanner from scratch in the Scan Viewer.
  • If a "Scanner Profiles Folder" is defined, the user can select from one of a list of Scanner Profiles in that folder.
    • If allowed to do so, users may optionally edit existing Scanner Profiles or save scanner settings to a new Scanner Profile.

Selecting and configuring a scanner from scratch

If the Scan Viewer has already been set up with default profile, then nothing will need to be configured. There are no buttons (upload/download/scanner settings/device settings) aside from the scan button. The Scan Viewer will look like this:



If the Scan Viewer is not set up with a default Scanner Profile, users will be able to choose and configure a scan device from the Scan Viewer.


1. Select scanner settings

To select a scanner from scratch in the Scan Viewer:

  1. Ensure Grooper Desktop is running.
    • If it is and you are able to select a scanner, you will see the message "Device selection required."
    • If it is not running (or is not installed), you will see the message "Grooper Desktop service not found."
  2. Press the Scanner Settings button.
  3. This will bring up the Scanner Settings window.
  4. Using the Device dropdown, select the device you are using to scan.
    • Most document scanners can use either ISIS or TWAIN drivers. Of those two, using ISIS drivers is more common because they tend to scan at a higher speed.
  5. Expand the Device settings.
  6. Using the Device Name dropdown choose your scanner model.
    • BE AWARE: You will only see devices whose drivers are installed on your workstation. Drivers must be installed before this step.
  7. Configure any remaining Scanner Settings if necessary.
    • These default settings work for most users. Commonly configured settings include Feed Orientation to indicate the orientation in which pages are scanned and Scan Once to dynamically generate black and white images to reviewers.
  8. Select "OK" when finished.


2. Configure device settings (as needed)

After selecting a scanning device, you may need to configure settings that device has. These are specific settings available to the scanner model. For example, many scanner models will allow you to choose if images are scanned in color, their resolution, and if images are scanned single-sided or double-sided. These are configured separately, using the "Device Settings" button.

After selecting a scanner, to configure its device settings:

  1. Press the "Device Settings" button.
    • You will see the Grooper Desktop status change to "not found". That's ok. Grooper Desktop must momentarily stop running to configure the device settings.
  2. Grooper Desktop will open the device settings.
  3. After configuring the scanner's settings as needed, select "OK".


3. Start scanning

With a scanning device selected and device settings configured as needed, you are ready to scan.

  1. The Grooper Desktop status will indicate "Ready".
  2. Press the "Start" button to start scanning.

Selecting a saved Scanner Profile

If the Scan Viewer is configured with a "Scanner Profiles Folder", users will be able to select from a list of preconfigured Scanner Profiles. This allows users to select a pre-saved scanner configuration instead of manually configuring the settings.


"Download" a Scanner Profile

To select a scanner from a Scanner Profile in the Scan Viewer:

  1. Ensure Grooper Desktop is running.
    • If it is and you are able to select a scanner, you will see the message "Device selection required."
    • If it is not running (or is not installed), you will see the message "Grooper Desktop service not found."
  2. Press the Download Scanner Profile button.
  3. In the Download Scanner Profile window, select a Scanner Profile from the list.
  4. Press the "OK" button when done.
  5. Press the "Scan" button to start scanning.

Saving scan settings to a Scanner Profile

If the Scan Viewer is configured to allow users to do so, users may save scanner settings to a new Scanner Profile. This is how Scanner Profiles get created in Grooper. Scanner Profiles are a convenient way of saving scanner settings for future use.


1. Select scanner and configure Scanner Settings

First, you must select a scan device and configure the "Scanner Settings". From the Scan Viewer:

  1. Ensure Grooper Desktop is running.
    • If it is and you are able to select a scanner, you will see the message "Device selection required."
    • If it is not running (or is not installed), you will see the message "Grooper Desktop service not found."
  2. Press the Scanner Settings button.
  3. Select the scanner device you want to use and configure any optional Scanner Settings you choose.
  4. Press "OK" when finished.


2. Configure device settings (if needed)

Device settings are local to the software in your scanner. These provide additional scanner settings you may want to use, such as color mode, duplex scanning, or DPI resolution. If you need to configure these settings, use the "Device Settings" to do so.

  1. Select the "Device Settings" button.
    • You will see the Grooper Desktop status change to "not found". That's ok. Grooper Desktop must momentarily stop running to configure the device settings.
  2. Grooper will open the scanner's device settings. Configure them as needed.
  3. Select "OK" when finished.


3. Save to a new Scanner Profile

With Scanner Settings and Device Settings configured as you need, you can now save these settings to a new Scanner Profile. This will upload the Scanner Profile to the Grooper web server. This allows you or other users to choose this Scanner Profile from the "Scanner Profiles folder".

  1. Select the "Upload" button.
  2. This brings up the "Save Scanner Profile" window.
  3. Name the Scanner Profile
  4. Select "OK" when finished.
    • In order to upload a new Scanner Profile, your Grooper Designer must have referenced a Scanner Profiles folder, and enabled both Allow Edit and Allow Upload on the Scan Viewer. If you do not see the Upload button, contact your Grooper Designer.


Operating the Scan Viewer

Create a new Batch

To start scanning, you will need to create a new Batch in Grooper. New Batches can be created from the Batches Page or the Tasks Page.

  1. Go to the Batches Page or the Tasks Page.
  2. Press the "New Batch" button.
  3. Using the Name property, name the Batch.
    • The Batch name will default to a date/time stamp.
  4. Using the Process property's dropdown, select a Batch Process.
    • Be sure to select a Batch Process whose first step is a "scan step" (a Review step with a Scan Viewer configured).
  5. Press the "OK" button when finished.
  6. The Batch is now ready to scan.
    • Batches with a "Ready" status are ready for review (in your case, ready to scan).
    • Review is the "Activity" type for all user-driven Batch Process steps in Grooper. Your Grooper designer may name the step something else to make it easier for you to identify (like "Scan"). Look for a custom step name in the "Step" column.
  7. Start reviewing the Batch by either:
    • Double-clicking on the Batch (Must be "Ready" and not "Paused").
    • Right-clicking the Batch and selecting "Review".
    • Or selecting the Batch and pressing "Ctrl + R" on your keyboard.


Start scanning with the Scan Viewer

With the Scan Viewer open, you can start scanning pages into the new Batch.

  1. Be sure your machine is connected to a scanning device and Grooper Desktop is running.
    • Grooper Desktop must be running to scan pages into a Batch. This light will be red if Grooper Desktop is not running. For more information on Grooper Desktop refer to this portion of the article.
    • After a scan device has been selected, it will be listed here as well.
  2. If you are not using a default Scanner Profile, configure your device selection.
    • There are many different ways to configure device selection. This will be determined by how your Grooper designer set up the Scan Viewer. For more information on how to configure device selection, refer to this portion of the article.
  3. With paper loaded into the scanner, press the "Scan" button to start scanning.
  4. As pages are scanned, they will be loaded into the Batch. You will see thumbnail previews for each page on the left and the full page in the Document Viewer on the right.
  5. Press the "Complete Task" button when finished scanning and reviewing pages. This will take the Batch to the next step in its Batch Process.
    • The "Stop" button will close the Review' task (in this case the Scan Viewer). You will not lose any work, but it will not move on to the next step in the Batch Process.
    • BE AWARE: The "Delete" button will permanently delete the Batch. There is no undo for this command. Only press this button if you are absolutely sure you want to delete the Batch.


Scan Viewer commands

Scan commands

There are several commands that allow to you continue scanning pages once you've started scanning. These commands are useful for:

  • Loading more pages into the scan feeder that need to be scanned.
  • Rescanning pages with defects, such as bent corners or pages with sticky notes on them.

There are four scan commands in the Scan Viewer. All of these commands can be accessed by right-clicking in the Scan Viewer from the "'Scan" flyout or with keyboard shortcuts.

  • Scan (Alt+Shift+S): Scans all pages in the feeder and adds them to the end of the Batch.
  • Scan Repeat (Alt+Shift+R): Scans all pages in the feeder and adds them to the end of the Batch. Grooper will then poll the scanner waiting for new pages to be added to the feeder. This allows Grooper to continuously scan in new pages while the scan operator keeps loading the feeder. To quit polling the scanner, close the "Feeder Empty" window at the bottom of the screen.
  • Scan Before (Alt+Shift+B): Scans all pages in the feeder and inserts them before the selected page in the Batch.
  • Scan After (Alt+Shift+A): Scans all pages in the feeder and inserts them after the selected page in the Batch.

Rotate commands

Any scanned page can be rotated in Grooper left or right in 90 degree increments. This allows users to correct misaligned pages and pages scanned upside down at scan-time.

There are two rotate commands in the Scan Viewer. These commands can be accessed by right-clicking a page from the "Image" flyout or with keyboard shortcuts.

  • Rotate Left (Ctrl+Left Arrow): Rotates the page left (counter-clockwise) by 90 degrees.
  • Rotate Right (Ctrl+Right Arrow): Rotates the page right (clockwise) by 90 degrees.


The Crop command

Border defects aren't just unsightly. They can interfere with OCR text recognition downstream during a Recognize step. In Grooper, you can use the Crop command to remove unwanted border defects resulting from the scanner. Cropping is the process of trimming the edges of an image to improve the image in one way or another.

To crop an image in the Scan Viewer:

  1. Select the image you want to crop.
  2. In the Document Viewer, press the "Rubberband Select" button.
  3. On the page's image, draw the area you want to cut out with your cursor.
  4. Press the "Crop" button.
  5. Grooper will ask you to confirm your selection. Press "OK" to do so.
    • BE AWARE: This change is permanent once you exit the Scan Viewer. However, you can undo the crop operation by selecting the page and entering Ctrl+Z on your keyboard as long as you do so before exiting the Scan Viewer.
  6. After confirming, the edges will be trimmed, leaving you with the cropped page.


All other image adjustment commands

Several other image adjustment commands can be accessed from the Scan Viewer as well. These include:

  • Invert: Inverts the "polarity" of an image (turns black pixels white and white pixels black).
  • Skew Angle: Adjusts the angle of the image.
  • Brightness: Adjusts the images brightness. Only usable on color and greyscale images.
  • Contrast: Adjusts the image's contrast. Only usable on color and greyscale images.
  • Saturation: Adjusts the image's saturation. Only usable on color images.


To access these commands in the Scan Viewer:

  1. Select the page you want to adjust.
  2. Press the "Adjust Image" button.
  3. Within the Adjust Image window, use the sliders with each command to make image adjustments.
  4. Press "OK" when finished.


Scan Repeat vs Automatic Feeding

Most scanner models have (at least) two different paper feeding options:

  • Standard Feeding - After scanning all pages into the hopper, users will need to press the scan button again to load more pages into the scanner.
  • Automatic Feeding - After scanning all pages into the hopper, the scanner will poll for more pages. When the user adds more pages to the hopper, the scanner will automatically start scanning them.

The software Grooper uses to interact with your scanner does not support Automatic Feeding for many (if not all) scanner models.

To get around this, you should use the Scan Viewer's "Scan Repeat" feature.

How Scan Repeat works

"Scan Repeat" simulates what your scanner does when set to Automatic Feeding.

  • The "Scan Repeat" command will scan all pages currently loaded in the scanner's hopper.
  • When all pages are scanned, Grooper will start a polling cycle. Every 5 seconds, Grooper will check to see if pages have been added to the feeder.
    • If pages are present, Grooper will scan them in.
    • If no pages are present, Grooper will pop up a "Feeder Empty" dialogue.
      • If the user adds pages to the feeder, Grooper will scan them in automatically.
      • After 5 seconds, Grooper will poll again. It will continually poll every 5 seconds until the "Feed Empty" dialogue is cancelled.

How to use Scan Repeat

To execute "Scan Repeat":

  1. Make sure your scanner is set to use Standard Feeding.
    • Grooper will error out if you use Automatic Feeding.
  2. In the Scan Viewer, either:
    • Right click any folder in the page. Select "Scan > Scan Repeat".
    • Use the Scan Repeat shortcut by pressing Alt + Shift + R on your keyboard.


FYI

Thick client versions of Grooper had a different solution to this issue: "Auto Resolve"

"Auto Resolve" did what "Scan Repeat" does. It polled the scanner every few seconds when the feeder was empty. When pages were added to the feeder, it would scan them into Grooper.

  • "Auto Resolve" is not present in the Grooper web client.
  • Because Scan Repeat does what Auto Resolve does, the developers opted to remove Auto Resolve.
  • The big difference is Auto Resolve would allow Grooper to ignore (more or less) when scanners were set to use Automatic Feeding. When using the web client, scanners cannot use Automatic Feeding without throwing an error.

Keyboard Shortcuts

For a complete list of the keyboard shortcuts ("hotkeys") in the Scan Viewer, refer to the following article:


The Scan Viewer for Grooper Designers

Basic setup

These are the most basic Scan Viewer settings. With this configuration, users will be able to select and configure a scanner device from scratch in the Scan Viewer.

  1. Add a Review Step to a Batch Process
  2. Select the Views property and press the ellipsis button at the end.
  3. This brings up the Views editor.
  4. Press the "Add" button.
  5. Select Scan View from the list of Review Views.
  6. Press "OK" to finish.
  7. Save changes when finished.


Defining a Scanner Profiles folder

Defining a "Scanner Profiles folder" allows users to select from one or more premade Scanner Profiles. This allows users to quickly select preconfigured device settings before scanning.

Set the "Scanner Profiles folder" in the Scan View configuration panel. From there:

  1. Select the Scanner Profiles Folder property and press the dropdown menu button.
  2. Or from the dropdown, select a folder in your Project.
    • Scan Viewer users will be able select from any Scanner Profiles in this folder.
    • If allowed, Scan Viewer users will be able to save new Scanner Profiles to this folder.


If you do not want your users to edit existing Scanner Profiles or upload new ones to the Grooper Repository, you are done at these point. Press "OK" and save your changes.

If you do want users to edit and upload Scanner Profiles, continue to the next section.

Optional: Allow Edit and Allow Upload

Scan Viewer users may optionally be allowed to edit existing Scanner Profiles and upload new ones to the "Scanner Profiles folder" by enabling the following properties.

  • Allow Edit - Enabling this property allows users to edit existing Scanner Profiles.
    • The Scanner Profiles Folder property must be configured for this property to appear.
  • Allow Upload - Enabling this property allows Scan Viewer users to upload their device settings to a new Scanner Profile. This is how Scanner Profiles are created.
    • The Allow Edit property must be configured for this property to appear.


Setting a default Scanner Profile

Setting a default Scanner Profile allows designers to configure a Scan Viewer's settings for them. The user won't have to do any manual configuration when they open the Scan Viewer. Setting a default Scanner Profile, selects the scan device for the user.

The default Scanner Profile is set in the Scan View configuration panel. From there:

  1. Select the Scanner Profile property and press the dropdown menu button.
  2. Select a Scanner Profile from your Project.
    • Scanner Profiles must be saved from a Scan Viewer (because the Scan Viewer is the only UI that connects to scanner hardware). If you need to know how to create a Scanner Profile, refer to this section of the article.
  3. (Optional) Set a "Scanner Profiles folder", if you wish for your users to be able to switch from a list of premade Scanner Profiles. Users will be able to scan using any Scanner Profile in the selected folder.
    • You can optionally enable the Allow Edit and Allow Upload properties at this point as well. Do this only if you do want users to be able to configure scan settings using the Scanner Settings and Device Settings buttons, edit existing Scanner Profiles and/or upload new Scanner Profiles.
  4. Select "OK" when finished.


Large volume advice: Use a Separation Profile to improve performance

When scanning large volumes of pages into a single Batch, the Scan Viewer can experience performance issues. As each page gets scanned into Grooper, the UI has to keep it in stored in memory. As the browser's cache fills, the UI will slow down. This can create a lag between when a page is fed into the scanner and when it appears in the Scan Viewer.

The solution: Use a Separation Profile and a low "Auto Collapse Threshold"

  • When a Separation Profile is set in the Scan View settings, it will automatically place pages into folders as they are scanned in, according to the Separation Profile's configuration.
  • The "Auto Collapse Threshold" will automaticaly collapse folders every n folders. When folders are collapsed, page images are cleared from the cache, freeing up memory for new scanned images, improving the Scan Viewer's performance.

For more information about Separation Profiles, click here.

To implement this solution you will do the following:

1. Create a Separation Profile to separate every n pages

  1. Right-click your Project.
  2. Select "Add > Separation Profile".
  3. Name the Separation Profile and press "Execute" to create it.
  4. Using the "Provider" dropdown, select "Event-Based".
  5. Expand the "Event-Based" settings and open the "Events" editor (Press the "..." button).
  6. Press the "Add" button and select "Page Count"
  7. Set the "Pages Per Document" to a number of your choosing.
    • We recommend starting at 100. This will create a folder in the Batch every 100 pages. Depending on many factors that affect performance (the throughput of your scanner, your network, your workstation's memory, etc.) you may be able to increase this number. However 100 is a good start.
  8. Press "OK".
  9. Save the Separation Profile.


2. Referencing a Separation Profile within the Scan Review

  1. Select the "Review" step in your Batch Process.
  2. If you have not done so already, add a Scan View. Otherwise, select the Scan View.
  3. Using the "Separation Profile" dropdown, browse to the Separation Profile created in "1. Create a Separation Profile to separate every n pages".
  4. Set the "Auto Collapse Threshold" to a number of your choosing.
    • We recommend starting at 1. This will ensure only a single folder is open during scanning, reducing the number of page images kept in memory while the scanner is running.
  5. Press "OK"
  6. Save the "Review" step settings.


3. Add a step to remove the folders

Inserting these folders is only done to improve performance when using the Scan Viewer. After pages are scanned in, these folders are not needed. Adding a "Remove Level" step will remove the folders, flattening the Batch out for subsequent processing.

  1. Right-click the Batch Process.
  2. Select "Add Activities > Utilities > Remove Level"
  3. The step's default Scope is set to "Batch" and Remove Level's "Level Count" is set to "1". This is the appropriate configuration for the majority of scenarios.
  4. Ensure the "Remove Level" step immediately follows the Review step configured with a Scan View. Use the "Move Up" and "Move Down" commands in the node tree as needed.

Troubleshooting

BE AWARE: For Grooper Desktop to scan to the Grooper web server, it is best practice to connect securely in the browser (HTTPS).

All users:

  • Always use HTTPS to connect to the Grooper web app.
  • NEVER use HTTP to connect to the Grooper web app.
  • Scanned images may be refused by your organization's browser policies if using an HTTP address.

Design users and administrators:

  • A self-signed certificate on the Grooper web server should be sufficient for scenarios where Grooper is isolated to your own network.
  • For information on how to create and bind a self-signed certificate, review this part of the Install and Setup article.

Verifying Grooper Desktop has reserved URLs

When the Grooper Desktop installer runs, it executes a netsh command to reserve a URL prefix in the system’s HTTP configuration. This allows the Grooper Desktop service to listen on a specific port for communication from local scanning components. As the scanner generates images, those images are passed to Grooper Desktop through this local port. Grooper Desktop then uploads the processed images to the Grooper Repository hosted on the Grooper web server.

By default, the Grooper Desktop installer registers port 13950.You can verify that the installer created the URL reservation by entering the following command in a Windows Command Prompt:

netsh http show urlacl | findstr "13950" 

You should see output similar to:

    Reserved URL            : http://192.0.2.10:13950/Scanner/
    Reserved URL            : http://+:13950/Scanner/

If no reserved URLs appear, you can manually create the reservation with the following command:

netsh http add urlacl url=http://+:13950/Scanner user=Everyone

If you need to use a different port, replace 13950 with the port number you want to assign.

Verifying Grooper Desktop is listening and actively being used

You can confirm that the Grooper Desktop service is actively listening and being used by running the following command in a Windows Command Prompt:

netstat -ano | findstr :13950

Run this command when:

  • Grooper Desktop is running
  • You have a Scan Viewer open in the Grooper web app.
  • The Scan Viewer has Scanner Settings configured (a device is selected).

With these conditions satisfied, and everything functioning correctly, you may see output similar to:

TCP    0.0.0.0:13950          0.0.0.0:0              LISTENING       4
TCP    [::]:13950             [::]:0                 LISTENING       4
TCP    [::1]:13950            [::1]:59257            ESTABLISHED     4
TCP    [::1]:13950            [::1]:61853            ESTABLISHED     4
TCP    [::1]:59257            [::1]:13950            ESTABLISHED     53444
TCP    [::1]:61853            [::1]:13950            ESTABLISHED     53444

Here’s what this indicates:

The service is successfully listening on port 13950

The first two lines show that the system’s HTTP driver (PID 4) is LISTENING on port 13950:
  • 0.0.0.0:13950 means it is listening on all IPv4 interfaces
  • [::]:13950 means it is listening on all IPv6 interfaces
This confirms that the URL reservation is active and the port is bound correctly.

Two active connections are currently using the port

The next four lines show two ESTABLISHED TCP connections:
  • The listening side ([::1]:13950) is owned by PID 4
  • The client side ([::1]:59257 and [::1]:61853) is owned by PID 53444
This means:
  • A local application (PID 53444) has opened two active connections to the Grooper Desktop service
    • In this example, the local application was Google Chrome, because the Grooper Scan Viewer was open in Chrome.
  • Both connections are happening over localhost ([::1]), so the communication is internal to the machine
  • Data is actively flowing between the scanning components and the Grooper Desktop service
    • Multiple connections are normal. Scanning components often use separate channels for commands, status updates, and streaming image data.

This output confirms:

  • Port 13950 is reserved and listening correctly
  • The Grooper Desktop service is actively being used
  • Local scanning components are successfully communicating with it
  • Nothing is blocking or conflicting with the port

Verifying Grooper Desktop is communicating with the Grooper web server

Grooper Desktop is a service that performs three core functions:

  • It drives and manages the document scanner when used from the Grooper Scan Viewer.
  • It listens on a designated local port for communication from the scanner’s capture components, receiving scan data as it is produced.
  • It uploads the scanned images to the Grooper Repository hosted on the Grooper web server.

To send images to the Grooper web server, Grooper Desktop (installed on a user's workstation) must be able to communicate with the web server via the Grooper web app launched from your browser.

If Grooper Desktop is running, these errors may indicate your browser is denying traffic.

If your browser is denying traffic from Grooper Desktop to the Grooper web server, you will see a series of connection errors in the browser console.

  • To open the console on Chromium browsers (Chrome & Edge) press Ctrl + Shift + J on your keyboard.
  • If the browser is denying traffic, you will see the following error in the console when the Scan Viewer is open:
    • net::ERR_CONNECTION_REFUSED
    • Be aware, if Grooper Desktop is not running, the same errors will appear for a different reason.
  • If your browser is managed by your organization, they control what traffic is and is not allowed.
    • The most common solution for this issue is simply to connect to the Grooper app securely using HTTPS instead of HTTP because many enterprise browsers block insecure localhost traffic.
    • For most scenarios, a self-signed certificate is sufficient to connect using HTTPS. For information on how to create and bind a self-signed certificate to the Grooper website, review this part of the Install and Setup article.

Encountering "Unable to load Grooper.HPC.dll" errors

These errors can crop up in multiple contexts in Grooper. However, it is most commonly encountered during scanning. These errors most commonly occurs due to:

Incorrect or corrupted driver installation (most common)
Solution: Download and reinstall the correct scanner driver.
  • Uninstall the scanner driver.
  • Reboot
  • Download the exact driver for:
    • Your scanner model
    • Your Windows Version (10/11)
    • The correct architecture (x86)
  • Install as Administrator
Limited user rights preventing access to required files
Solution: Make sure the logged in user has access to C:\Program Files (x86)\BIS
Incorrect or corrupted Grooper Desktop installation
Solution: Uninstall and reinstall Grooper Desktop
  • Uninstall Grooper Desktop
  • To verify residual files have been fully removed, verify the C:\Program Files (x86)\BIS\Grooper Desktop folder is empty.
  • Install Grooper Desktop as Administrator
  • In modern Grooper deployments, scan stations will only have Grooper Desktop installed on the machine. However, if Grooper is also installed on the machine, uninstall and reinstall it too. Verify no residual files remain in the "C:\Program Files\BIS\Grooper" folder.
Antivirus is quarantining required files
Solution: Whitelist required files/folders
  • Make sure your antivirus is not quarantining Grooper.HPC.dll. You will find this file in C:\Program Files (x86)\BIS\Grooper Desktop.
  • Ensure antivirus is not quarantining files in C:\Windows\PIXTRAN.
  • PIXTRAN files are required for scanning. The are typically created during a scanner's calibration process. They are paired with processing engines like Grooper.HPC.dll. If PIXTRAN files are inaccessible, this can result in a "Grooper.HPC.dll not found" related error.
  • If antivirus has removed a required file/folder, it will need to be restored prior to adding the exclusion.
The Windows registry has residual Grooper files (most rare)
Solution: Make sure the registry is free of Grooper files
  • Uninstall all Grooper applications.
  • Open the Windows Registry Editor
  • Verify there are no Grooper files in this location: Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\SharedDLLs
  • There will be plenty of other files in this location. Just ensure there are no Grooper files.
  • This happened in the past due to an issue in a previous version. While somewhat common in the past, this issue is unlikely to be the root cause in current installs. However, it should be checked when all else fails.