[EARLY ADOPTER] CITRIX Optimization for Rainbow Desktop application

Citrix media optimization overview

The audio optimization is achieved via integration of the Citrix Unified Communication SDK (UC SDK)

Applicable for the following Rainbow usages:

• Rainbow Desktop application used in Telephony mode
• Or any profile where :
  • Use IP video in individual or multi-party conversations is set to Not Allowed
  • Use screen and application sharing in individual or multi-party conversations is set to Not Allowed
• Rainbow Business Telephony for Microsoft Teams.

CITRIX compatibility

Minimum Citrix component version to use the Citrix optimization with Rainbow are:

• VDA: 1912 LTSR or 2206
• Citrix Workspace app (Windows): 2205
• Citrix Workspace app (Mac): 2206.1
• Citrix Workspace app (Linux): 2205

Configuration

• Run Rainbow Desktop application v2.130.2 or higher, with the Citrix UC SDK integrated by default.
• The Rainbow Desktop application automatically detects the Citrix environment and the capability to activate optimization, no configuration to do on Rainbow side except for the company administrator to manage the users profile to forbid video calls and screensharing.
• The capability is driven by the appropriate configuration by the IS/IT on the VDA, positioning two registry keys.

Registry key setup on Citrix VDA

Step 1: White list the Rainbow Desktop application in the Local Machine registry:

White list Rainbow.exe in

Key Path: HKLM\Software\WOW6432Node\Citrix\WebSocketService
Key Name: ProcessWhitelist
Key Type: MULTISZ

Then restart the process CtxHdxWebSocketService

Step 2: Enable Redirection on VDA in the Current User registry:

Key Path: HKCU\Software\Citrix\HDXMediaStream
Key Name: MSTeamsRedirectionSupport
Key Type: DWORD
Key Value:
- 0 indicates Citrix virtual environment is active, however, WebRTC redirection is not supported
- 1 indicates Citrix virtual environment is active, and WebRTC redirection is supported

This key is monitored by the Rainbow desktop app to activate optimization.

User Profile Configuration

The Citrix optimisation is perfectly adapted for a Rainbow usage with a Telephony only profile but any profile can be used as soon as video calls and screensharing is not allowed.

Troubleshooting

Status check

• In the Rainbow Desktop app you can see if the Citrix Redirection is used.

• Another point that can be verified is that the process HdxRtcEngine.exe is running during audio calls on the Endpoints

Report a malfunction/bug

If the issue is reproduced provide use a step by step description to reproduced the problem. Please feel free to add screenshots or videos to help us understand the problem.

In case of issues about calls do not forget to give us all details about the users configuration:

• PBX type/version
• Device (Deskphone, REX, Anydevice)
• WebRTC gateway version
• Routing setting (Computer mode/Office Phone)
• Exact date and time of the call.

All information about the caller and called party

• email of the Rainbow account
• caller number / called number

In addition to this information please provide all involved Rainbow client logs and the WebRTC gateway logs in case of VoIP calls (Computer mode).

Open a support ticket by sending an e-mail to support@openrainbow.com with the following tag in the subject line [EA CITRIX]. If you are an end customer, ask your reseller to open the ticket for you.

Logs

For the time being, in case of an issue please collect the Rainbow Desktop application logs. 

This chapter will be update in case further logs need to be collected on the VDA or the endpoints

Known restrictions

• In the Audio settings there is no visual indicator of Microphone audio level
  It's a Citrix UC SDK limitation.
  
• Vocal message in instant messages are not yet working (collaboration feature)