How to Troubleshoot Browser Content Redirection

Browser Content Redirection feature description and details

Browser content redirection (BCR) allows the redirection of VDA-side browser viewports to the client-side. The benefits of BCR are achieved when offloading network utilization, page processing, graphics rendering to the endpoint, and improving end-user experience when browsing demanding webpages; especially those incorporating HTML5 or WebRTC video.

Currently there are two browsers supported:

  • Internet Explorer 11: The VDA-side IE11 browser viewport is redirected and rendered on the client-side using the client-side installed IE11 and the Citrix Workspace app for Windows process HdxBrowser.exe.
  • Google Chrome: The VDA-side Chrome browser viewport is redirected and rendered on the client-side using the Citrix Workspace app for Windows embedded Chrome engine and the HdxBrowserCef.exe process. Note that the Browser Content Redirection Extension must be installed and enabled on the VDA before using BCR with Chrome. The Browser Content Redirection Extension is available from the Chrome Web Store.


For further information, including BCR system requirements, please read the Browser content redirection section of the Citrix Virtual Apps and Desktops 7 Product Documentation.

Browser Content Redirection configuration for specific use cases

Server fetch and server render

No VDA-side viewport redirection to the client occurs. This could be due to the desired behavior as configured through BCR policies, or server fallback may have occurred unintentionally due to a client redirection failure.

To configure for this use case:

Browser content redirection policy: If set to Prohibited, BCR is disabled.

Alternatively, if “server fetch and server render” is to be applied for some websites, while permitting BCR for others, use the Browser content redirection Access Control List (ACL) policy settings policy to whitelist sites and/or the Browser content redirection blacklist setting policy to blacklist sites.

In this alternative scenario, the Browser content redirection policy needs to be unconfigured or set to Allowed. [Default value Allowed]

Server fetch and client render

This scenario is useful when the client does not have direct access to the internet.

To configure for this use case:

When the Browser content redirection proxy setting policy has been configured with a proxy server/port address, the client connects to the proxy server on the VDA’s network over the Port Forwarding virtual channel and renders the content locally.

Client fetch and client render

This use case affords the maximum benefits for bandwidth efficiency and VDA resource usage.

To configure for this use case:

Browser content redirection policy: No need to configure but Allowed can be set. [Default value Allowed]

Browser content redirection Access Control List (ACL) policy settings policy: Acts as whitelist. Add any websites (wildcard * can be used) that you want to be redirected.

[Default value: https://www.youtube.com/*]

Other BCR configuration options

To support whitelisted websites that navigate away to a 3rd-party site for authentication before redirecting back to the whitelisted site, configure the Browser content redirection authentication sites policy.

We’ll use YouTube as an example:

The Browser content redirection policy will include the value: https://www.youtube.com/* [note that this entry exists by default in the policy]

The Sign In button on the YouTube site navigates to https://accounts.google.com/… (the protocol/domain part will be consistent but the full path will vary).

To support the authentication-related navigation from https://www.youtube.com/ to https://accounts.google.com/ and back to https://www.youtube.com/, configure as follows:

In the Browser content redirection authentication sites policy, add the entry: https://accounts.google.com/* (note the wildcard * to accommodate variations in URL sub-folder values).

More info can be found in CTX238236.

Browser Content Redirection feature limitations

  • For websites with media content, only the following list of codecs are supported when the site is redirected:
  • User-added image
  • Due to the limitation of CEF(Chromium Embedded Framework), client endpoint GPU needs to be disabled if DPI scaling factor is set to a number other than 100% in order for BCR feature to work. To disable:
    • HKLMSOFTWARECitrixHdxMediastream

      For 64-bit:

      HKLMSOFTWAREWow6432NodeCitrixHdxMediastream

      Key: GPU (DWORD)

      Value: 0
  • Currently, copying text from redirected webpages is only possible with Chrome browser content redirection. Use Ctrl-C / Crtl-V to copy and paste.
  • Currently printing from redirected webpages is not possible from Internet Explorer 11 and Chrome.

Browser Content Redirection Troubleshooting

Before proceeding, please review the “Browser Content Redirection feature limitations” section.

General troubleshooting steps

Step May clear problem in
Close the browser, re-open, and navigate to a whitelisted site. Browser Add-On and HdxVideo.js file
Disconnect and reconnect the session. Citrix Workspace app, HdxBrowser.exe, HdxVideoCef.exe, WebsocketAgent, and services
Logoff and logon to a new session. Citrix Workspace app, HdxBrowser.exe, HdxBrowserCef.exe, WebsocketAgent, and services
Stop the services: 1. Browser redirection service, 2. HTML5 redirection service, and 3. Port forwarding service. Restart them in reverse order listed. Logoff and logon the session. All components


Data to collect for troubleshooting

CDF modules to trace:

VDA Side Citrix Workspace app (client) Side
HDX_Multimedia_BrowserService
HDX_Multimedia_HdxjsInjector
HDX_Multimedia_PortForwardLibrary
HDX_Multimedia_PortForwardService
HDX_Multimedia_WebSocketAgent
HDX_Multimedia_WebSocketPipe
HDX_Multimedia_WebSocketService
PE_Library_GvchBase
IcaClient_Multimedia_HdxBrowser_CtlGuid
IcaClient_DriversVd_BrowserRedir_CtlGuid
IcaClient_DriversVd_PortForward_CtlGuid

For Internet Explorer 11, ensure HdxBrowser.exe is running with Citrix Workspace app (use Task Manager) while you are on a whitelisted site.

For Google Chrome, ensure HdxBrowserCef.exe is running with Citrix Workspace app (use Task Manager) while you are on a whitelisted site.

This is how it looks on Process Explorer:

User-added image

Browser JavaScript log live debugging:

  1. Open %programfiles%CitrixHdxVideo.js

    (or depending on your VDA version, the Javascript can also be located inside a folder called %programfiles%CitrixICASERVICE)

    You might need to do this running Notepad as an Admin and opening the .js file from the Open menu

  2. Change the line var DEBUG_ONLY = false; to var DEBUG_ONLY = true;

    Save the file and close your Editor.

  3. Close Chrome or Internet Explorer and reopen it, hit Ctrl+Shift+i or F12 respectively, and go to the Console tab in Developer tools. Browse to a whitelisted site, e.g. https://www.youtube.com

  4. You should see traces from [HdxVideo.js] (example below). Collect the entire log.

    Key messages to look for are highlighted in bold, with additional comments inside brackets [ ]:

    [HdxVideo.js] OnUnload (window): [object Window]

    [HdxVideo.js] DocumentBodySuppressor.start()

    [HdxVideo.js Events] interceptEventListeners()

    [HdxVideo.js] DocumentBodySuppressor.trySetBodyStyle(): stopping observer

    [HdxVideo.js] OnLoad (window): [object HTMLDocument]

    [HdxVideo.js] Unredirected video count: 0

    [HdxVideo.js] HDX_DO_PAGE_REDIRECTION: true [if false, redirection is not even attempted. Problem with policies or browser Extension?]

    [HdxVideo.js] infallback: undefined

    [HdxVideo.js] Installing event listeners.

    [HdxVideo.js] msexitFullscreen – Found!

    [HdxVideo.js] onWSOpen: [Websocket opening to WebsocketAgent.exe 127.0.0.1:9001 succeeded. If failed, check your IE Security Settings]

    [HdxVideo.js] >>> {“v”:”pageurl”,”url”:”https://www.google.de/”}

    [HdxVideo.js] onVisibilityChange:

    [HdxVideo.js] >>> {“v”:”vis”,”vis”:true}

    [HdxVideo.js] onResize:

    [HdxVideo.js] >>> {“v”:”pageredir”}

    [HdxVideo.js] sendClientSize: w: 1316 h: 755

    [HdxVideo.js] >>> {“v”:”clisz”,”w”:1316,”h”:755}

    CSI/tbsd_: 15.599,072ms

    CSI/_tbnd: 15.658,128ms

    [HdxVideo.js] <<< {“v”:”winid”,”title”:”CitrixVideo:{1b83a2dc-39ae-4455-ad7d-d56e71fbb45d}”}

    [HdxVideo.js] onWSMessage: winid: CitrixVideo:{1b83a2dc-39ae-4455-ad7d-d56e71fbb45d}

    [HdxVideo.js] setWindowTitle: CitrixVideo:{1b83a2dc-39ae-4455-ad7d-d56e71fbb45d}

    [HdxVideo.js] documentTitleMutator.start()

    [HdxVideo.js] >>> {“v”:”winid”}

    [HdxVideo.js] <<< {“v”:”pageredir”} [VDA is instructing Receiver to start the redirection process]

    [HdxVideo.js] onWSMessage: pageredir

    [HdxVideo.js] Redirecting page — 화이팅! https://www.google.de/ [Korean characters means the redirection was successful]

A common error is:

[HdxVideo.js] OnUnload (window): [object Window]

Navigation Event Separator HTML1300: Navigation occurred.
www.youtube.com

[HdxVideo.js] DocumentBodySuppressor.start()

[HdxVideo.js Events] interceptEventListeners()

[HdxVideo.js] DocumentBodySuppressor.trySetBodyStyle(): stopping observer

[HdxVideo.js] OnLoad (window): [object HTMLDocument]

[HdxVideo.js] Installing event listeners.

[HdxVideo.js] msexitFullscreen – Found!


[HdxVideo.js] doRedirection(): exception connecting to WebSocket: SecurityError

[HdxVideo.js] onWSError:

[HdxVideo.js] Showing content — suspendRedirection.

In the Developer Tools console this can be seen as:

User-added image

This is caused by some security configurations in IE11’s Security Zones.

Please add the following entries to to the Trusted Zone in IE11 (Internet Options -> Security)


Another possible error is that some websites use a technology called CSP (Content Security Policy) which prevents any outside resource (like the Javascript used in BCR) from being executed in the trusted webpage context. Therefore Browsers prevent the injection of HdxVideo.js and BCR fails, falling back to server-side rendering.

User-added image


Browser Helper Object (BHO for IE11)

The BHO is explicitly enabled upon install time. If you want to disable it, please check the registry key created for the CLSID of the extension in the following path:

HKEY_LOCAL_MACHINESOFTWAREMicrosoftWindowsCurrentVersionPoliciesExtCLSID

There should be a key created with the CLSID of the extension ie {CA076BDE-8E41-44EE-B775-E791F26D0483}

The value of the key is set to 1. This means the extension is enabled and users cannot change it.

If changed to 0 , the extension will be disabled and users cannot change it.

If changed to 2 , the extension will be enabled and users can enable or disable it in the browser’s “Manage add-ons”.


How to verify the webpage is redirected

Method #1: Drag the IE11 window quickly. You will notice a ‘delay’ or ‘out of frame’ between the viewport and the User Interface.

Also you will notice a quick change in the title on the Tab (CitrixVideoId) before the original title is placed back

User-added image


Method #2: When the right mouse button is clicked on window area, a customized context menu is displayed. Back/Forward menu items are currently disabled for the initial releases. The remaining menu items perform the following tasks:

  • Refresh: refreshes current client side web page.
  • Open: if the mouse point is focused on a hyper link, the link will be opened; otherwise, nothing will happen.
  • Open in New Tab: if the mouse point is focused on a hyper link, the link will be opened in a new Tab; otherwise, nothing will happen. (Note: for the initial release, this works only when pop-up is enabled on VDA side IE instance.)
  • Open in New Window: if the mouse point is focused on a hyper link, the link will be opened in a new Tab; otherwise, nothing will happen. (Note: for the initial release, this works only when pop-up is enabled on VDA side IE instance and the link is opened in a new Tab rather than in a new Window)
  • About HDX Browser Redirection: Browse to Citrix support site in a new Tab
User-added image


Known issue: After starting a YouTube video using the YouTube HTML5 video player, full-screen mode might not work. You click the icon in the lower-right corner of the video, and the video doesn’t resize leaving the black background in the full area of the page. As a workaround, click the full screen button, and then select theater mode.

Related:

  • No Related Posts

Leave a Reply