WDIScan

Document and Image Scanning for Jira

Home / Documentation / Support

Requirements

  • USB scanners: Chrome/Edge browser;
  • Network scanners: Chrome browser with WDIScan extension;
  • Protocol: Mopria eSCL (Apple AirPrint);

Many recent scanners and all-in-one printers already support eSCL/AirPrint. You may need to enable it on the scanner/printer interface, check your manual.

Depending on your OS and scanner type you may need to do some extra setup:

USB Scanners (Chrome/Edge) Network Scanners (Chrome)
Windows Use Zadig (+info) Extension (+info)
macOS No extra setup Extension (+info)
Linux Disable ipp-usb (+info) Extension (+info)

Use this Scanner Test page to check if your scanner is compatible before installing WDIScan.


Accessing WDIScan

After installing WDIScan on your Jira instance a new item will be available on the issue view actions menu, "Scan a Document or Image":

Clicking it will open the WDIScan scanning dialog, you can now connect to your scanner:

For USB scanners click "Authorize a USB scanner" and select the scanner (see next sections):

For network scanners you need to provide the IP address or hostname (see next sections):


Connecting to USB scanners

A Chrome/Edge browser is required, with some extra steps depending on your operating system:

Windows

When connecting to a USB scanner on Windows you may see a "scanner in use" or generic error message. Most likely your system does not have the correct drivers installed.

Follow these steps to install the correct drivers using the free tool Zadig.

macOS

No extra setup, just connect the scanner and start scanning.

Linux

When connecting to a USB scanner on Linux you may see a "scanner in use" message, even when the scanner is not actually in use. This can happen when ipp-usb is installed on the system.

The ipp-usb service is used by other programs to access USB printers/scanners. But because WDIScan is also trying to access the scanner directly through USB, it causes a conflict.

You can fix the conflict by disabling ipp-usb, e.g. using systemd:

sudo systemctl disable --now ipp-usb

Alternatively, you can also use the scanner through ipp-usb as a network scanner. This involves installing the extension (as explained in the next section) and connecting to the scanner at the default ipp-usb address localhost:60000, or any subsequent ports i.e. 60001, 60002 etc. Find the exact address using DNS-SD:

avahi-browse -rt _uscan._tcp

Connecting to network scanners

Using network scanners requires installing the WDIScan extension to allow access to scanners on your local network. You will be asked to authorize access to each new scanner.

Install the WDIScan Connector extension from the Chrome Web Store.

With the extension installed, just click "Select network scanner" and connect to the scanner with an IP address or hostname.


Scanning

After connecting the scanner you have two scanning options:

The "Scan images" mode works only on flatbed scanners, with better control over the scanning area. The scan result is always an image file, but you can combine one or more images into a PDF file:

The "Scan documents" mode works with all types of scanners, including scanners with an ADF (automatic document feeder). Just select ADF as the input source and the correct paper size to automatically scan multiple pages as a single PDF file:

At any point you can attach the scanned files to the current Jira issue, any files not saved will disappear when the dialog is closed:

That's it for now, feel free to explore all the other options.

Contact us with any issues or questions.