This article describes how to set up a scanner to function with XenDesktop 5.x.

Requirements

The following screen shot displays the Citrix policies that must be enabled/selected (User policies): 

Note: Twain redirection and Client USB device redirection are alternatives, so only one must be enabled.

Generally, Twain redirection operates at a higher level and can perform other optimizations than the lower level USB redirection can, and it is expected that Twain redirection will be less sensitive to latency.

Therefore, it is usually best to use Twain redirection.

Enable only TWAIN redirection first. If you still do not see the device detected, then enable Client USB device redirection as well. (See troubleshooting notes for more information)

Other Requirements

• The scanner must be TWAIN compliant.

• The TWAIN drivers must be installed on the local device. They are not required to be installed on the XenDesktop VDA.

• The scanner must be attached locally (for example, through USB).

• Ensure that the scanner is using the local TWAIN driver and not the Windows Image Acquisition service.

• Ensure that there is no policy applied to the user account used for the test that is limiting the bandwidth within the ICA session (for example, client USB redirection bandwidth limit).

---

Instructions

Steps to Test Scanning

Complete the following steps to test scanning:

1. On the local device, navigate to the local Services panel (Control Panel > Administrative Tools) and disable the Windows Image Acquisition (WIA) service.
   This is done to ensure that the scanner will be using the TWAIN device driver (used only for test purpose): 

   

2. Scan a document locally using the scanner manufacturer’s scanning software to ensure that local scanning functions as expected.

3. If scanning locally works successfully, login to the XenDesktop session.

4. Open a TWAIN compliant application to see if scanning functions as expected within the XenDesktop session.

5. If the application does not see the scanner and scanning within XenDesktop fails, refer to the Troubleshooting section.

6. Check Citrix ready site for compatible solutions (Hardware and Software) - http://www.citrix.com/ready

Troubleshooting Information

TWAIN Testing Tool

You can install Twacker – a third party TWAIN testing tool - to the XenDesktop VDA and to the local client device to test TWAIN scanning within a XenDesktop session.

1. Download the tool from http://www.twain.org/scannerdriverdevelopers/specification-and-tools.html.

2. Install the appropriate version – 32-bit or 64-bit.

3. Within a XenDesktop session, complete the following steps:

   1. Launch Twacker.

   2. Click File > select Source and select your scanner from the list.

   3. Click File > Acquire.

   4. Click Scan to test your scanner.

If the Twacker application is able to scan successfully, then this means that the XenDesktop environment is configured properly for USB redirection and to use TWAIN devices, and that all of the requirements have been met on the local client device. If you are still having issues scanning within a particular application, it is likely a software issue.

  

HDX Monitor

http://blogs.citrix.com/2013/06/12/hdx-monitor-3-2-published/

 

Scanner Attributes

 

Scanner WMI

 

USB Devices Attributes

USB Devices WMI

Client USB Device Redirection

• As in most situations, it will not be possible to disable Client USB device redirection as it would prevent some other USB device to be mapped into the session. It is possible to enable the Client USB device redirection policy and add the Client USB device redirection rules policy in order to set up a policy that denies only the specific device that is being tested.

• When a user plugs in a USB device, the host device checks it against each policy rule in turn until a match is found. The first match for any device is considered definitive.

  • If the first match is an Allow rule, the device is remote to the virtual desktop.
  • If the first match is a Deny rule, the device is available only to the local desktop.
  • If no match is found, default rules are used.

For more information about the default policy configuration for USB devices, refer to CTX119722 - Creating USB Policy Rules.

This is an example, the USB device redirection policies are enabled but denied for a scanner with the following details:

VID=03F0 PID=B011

The PID and the VID can be retrieved in Device manager of the client device or using HDX monitor in the XenDesktop session:

 

This software application is provided to you as is with no representations, warranties or conditions of any kind. You may use and distribute it at your own risk. CITRIX DISCLAIMS ALL WARRANTIES WHATSOEVER, EXPRESS, IMPLIED, WRITTEN, ORAL OR STATUTORY, INCLUDING WITHOUT LIMITATION WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NONINFRINGEMENT. Without limiting the generality of the foregoing, you acknowledge and agree that: (a) the software application may exhibit errors, design flaws or other problems, possibly resulting in loss of data or damage to property; (b) it may not be possible to make the software application fully functional; and (c) Citrix may, without notice or liability to you, cease to make available the current version and/or any future versions of the software application. In no event should the software application be used to support ultra-hazardous activities, including but not limited to life support or blasting activities. NEITHER CITRIX NOR ITS AFFILIATES OR AGENTS WILL BE LIABLE, UNDER BREACH OF CONTRACT OR ANY OTHER THEORY OF LIABILITY, FOR ANY DAMAGES WHATSOEVER ARISING FROM USE OF THE SOFTWARE APPLICATION, INCLUDING WITHOUT LIMITATION DIRECT, SPECIAL, INCIDENTAL, PUNITIVE, CONSEQUENTIAL OR OTHER DAMAGES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. You agree to indemnify and defend Citrix against any and all claims arising from your use, modification or distribution of the software application.

This article describes how to set up a scanner to function with XenDesktop 5.x.

CTX136716 - USB Device do not Appear in Virtual Deskop

CTX123015 - How to Configure Automatic Redirection of USB Devices

CTX136197 - USB Scanner Device Not Listed in XenDesktop Toolbar

USB Class Codes