SDK

HDX SDK

Citrix Workspace app enhances support for HDX and SDK sessions by enabling you to customize your delivery model for Citrix hosted apps and desktops through your website.

This feature is useful for building a rich app experience in your Enterprise portals, and for users as a service. You can provide the experience when you host Citrix Workspace app for HTML5 on your web server while launching Citrix hosted apps and desktops from your website.

For the HDX SDK for Citrix Workspace app for HTML5 documentation, see HDX SDK for HTML5.

For HDX SDK examples, refer to the Citrix download page.

Autoupdate support for Citrix Workspace app for HTML5 using HDX SDK for HTML5

Citrix HDX SDK for HTML5 enhances the setPath API to consume the latest build of Citrix Workspace app for HTML5 from the CDN. This enhancement allows Citrix Workspace app for HTML5 to run on the latest version seamlessly. For existing HDX SDK for HTML5 users, change citrix.receiver.setPath in the customer code to use the latest from the CDN. For new users, the setPath API provides the option by default.

CDN is provided as the default. If there are any issues with the CDN, the hosted location provides the fallback path. For more information, see HDX SDK for HTML5.

Latest version of Citrix HDX SDK for HTML5

Verify that you use the latest version of the Citrix HDX SDK for HTML5 to start the sessions. Else, the session might fail to start.

For more information, see Citrix Workspace app for HTML5 HDX SDK.

Virtual Channel SDK support

The Citrix Virtual Channel (VC) SDK supports writing server-side applications and client-side drivers using the ICA protocol. The server-side virtual channel applications are on the Citrix Virtual Apps and Desktops server.

VC SDK supports writing new virtual channels and Citrix Workspace app for HTML5 can support up to 20 custom-virtual channels.

Known limitations in the feature

• If the configuration of the virtual channels is incorrect, you can observe a lag of 30 seconds.
• When you create a custom VC, start the ‘streamName’ with anything other than ‘CTX’.

For more information, see Citrix Virtual Channel SDK for Citrix Workspace app for HTML5.

Support for Unified Communications (UC) SDK

The Citrix Unified Communications SDK allows Unified Communications vendors, Cloud contact center providers, Communications Platform as a Service (CPaaS) providers, or any WebRTC-based communications vendors to integrate seamlessly with electron-based desktop or browser-based applications.

For more information, see Unified Communications (UC) SDK, which is a tech zone article.

Redirection of WebHID APIs

Unified Communications SDK for Citrix Workspace app for HTML5 implements the redirection of WebHID APIs as defined in Citrix-WebRTC, with certain known limitations. They are:

• If multiple HID devices of the same type exist, the user can’t select a specific device for testing.
• On Mac machines, when you use Citrix Workspace app for HTML5, the app might fail to retrieve the custom ‘compositeId’ before a newly connected media device is ready.
• On both Windows and Mac systems, when using Citrix Workspace app for HTML5, users might need to re-grant access permissions for reconnected devices. This process includes devices using a wireless keyboard or mouse USB receiver. The need to re-grant permissions is due to the absence of a connection event.

Note:

This feature is disabled by default.

How to configure

You can enable the feature by using:

• Configuration.js
• Global App Configuration service

Configuration.js

In Citrix Workspace app for HTML5, the configuration.js file is located under the C:\Program Files\Citrix\Receiver StoreFront\HTML5Client folder. Edit this file to enableee the feature.

Notes:

• Citrix recommends that you back up the configuration.js file before modifying it.
• Administrator-level credentials are required to edit the configuration.js file.

To enable the feature:

1. Navigate to the configuration.js file in the HTML5Client folder.

2. Make sure you set the attribute webHID to true. The following is an example of JSON data:

   'features' : {
       'msTeamsOptimization' : { 
           'webHID' : true 
           } 
           }
    

3. Set the attribute hidDeviceBlockList with the correct format. If you want to block some HID devices, the following is an example of JSON data:

   'features' : {
   'msTeamsOptimization' : {       
       // The format of the blocklist is ["VID:PID", "VID:PID", "VID:PID", ...]
       // Each VID and PID is an up to 4-digit hexadecimal number with an optional "0x" prefix.
       // The VID is a required field. The PID is optional, so the colon and PID can be omitted.
       // example ["35ab:21ff", "45ac", "0x567:123a", "0x1234:0x5678"]
       'hidDeviceBlockList' : [] 
       }
   }
    

4. Save the changes.

Global App Configuration service

Administrators can enable the feature by navigating to Workspace Configuration > App Configuration > HDX and Multimedia > MS Teams > Enable webHID redirection and HID Device Blocklist. Select the checkbox and respective toggle button to enable the feature.