Session experience

DPI scaling

Citrix Workspace app for HTML5 supports DPI scaling for app and desktop sessions on a single monitor.

Citrix Workspace app for HTML5 lets you set the VDA resolution on the monitors that have a high pixel ratio. The DPI scaling feature is disabled by default for app and desktop sessions.

For Citrix Workspace app 1908 for HTML5 and earlier, go to the session toolbar and then select Toolbar > More > Preferences > Display Resolution to set the resolution for app and desktop sessions. The correct resolution is set on the VDA.

For Citrix Workspace app 1909 for HTML5 and later, go to the session toolbar and then select Toolbar > More > Display Resolution > Device Pixel Ratio Scaling to set the resolution for app and desktop sessions. The correct resolution is set on the VDA.

When you set the resolution correctly on the VDA, the blurry text becomes crisper.

Limitations:

  • The High DPI scaling feature is disabled on touch-screen devices.

Session reliability

The session reliability feature ensures that sessions remain active on the user’s screen even if there is a disruption in network connectivity. Users continue to see the application they’re using until network connectivity resumes.

When connectivity is lost, the session remains active on the server. To alert the user about the connectivity issue, the display becomes unresponsive and a reconnect overlay screen appears. Until connectivity resumes on the other side of the tunnel, session reliability reconnects users without reauthentication prompts.

Note:

The session reliability timeout policy setting has a default value of 180 seconds or three minutes. Though you can extend the time the session reliability keeps a session open, this feature is convenient to the user.

For more information about the feature, see Session reliability in the Citrix Virtual Apps and Desktops documentation.

Important

With the session reliability feature enabled, the default ports for session communication are 2598 for non-SSL VDA and 443 for SSL VDA.

You can use session reliability with Gateway and SSL VDAs. When using a non-SSL VDA with Citrix Gateway, data encryption happens between the user device and Citrix Gateway. When using SSL VDA with Citrix Gateway, data encryption happens from the user device to VDA.

Using session reliability policies

  • The session reliability connections policy setting allows or prevents session reliability.
  • The session reliability timeout policy setting has a default value of 180 seconds or three minutes. Though you can extend the time the session reliability keeps a session open, this feature is convenient to the user. Therefore, it does not prompt the user to re-authenticate.

Tips

  • Extending session reliability timeouts might cause a user to get distracted and walk away from the device, leaving the session accessible to unauthorized users. By default, incoming session reliability connections use port 2598, unless you change the port number in the session reliability port number policy setting. If you use session reliability, it closes, or disconnects, the user session after the amount of time you specify in the Session reliability timeout policy setting.
  • Session reliability is enabled by default on the server. To disable this feature, configure the policy managed by the server.

Configuring session reliability from Citrix Studio

By default, session reliability is enabled.

To disable session reliability:

  1. Launch Citrix Studio.
  2. Open the Session Reliability connections policy.
  3. Set the policy to Prohibited.

Configuring session reliability timeout

By default, the session reliability timeout is set to 180 seconds.

Note:

Session reliability timeout policy can be configured only with XenApp and XenDesktop 7.11 and later.

To modify session reliability timeout:

  1. Launch Citrix Studio.
  2. Open the Session reliability timeout policy.
  3. Edit the timeout value.
  4. Click OK.

Enhanced session reliability

The following improvements address network disruptions, ensuring a better user experience by reconnecting the session reliably:

  • When you switch between Internet Service Providers (ISP), the session becomes unresponsive. With the fix, you can reconnect to the session during ISP switches.
  • When you switch networks and one Wi-Fi connection lacks internet connectivity, the session reliability feature might fail. With the fix, you can now reconnect to the session during a network switch.

Toolbar

By default, the enhanced toolbar feature is enabled.

To hide the toolbar:

  1. While logged in as an administrator, access the configuration.js file in C:\ProgramFiles\Citrix\<actual path>\HTML5Client.
  2. Search the configuration.js file to locate ‘menubar key.’
  3. In the configuration.js file, set “menubar”:false.

You can also hide an individual icon to prevent it from showing up in the toolbar. For example, to hide the ctrl+alt+del button in the toolbar:

  1. While logged in as an administrator, access the configuration.js file in C:\ProgramFiles\Citrix<actual path>\HTML5Client.
  2. Search the configuration.js file to locate ‘lock.’
  3. In the configuration.js file, set lock:false.

URL redirection

URL redirection allows you to control whether users access the URL by using:

  • browser published on servers or
  • browser that run on user devices

URL (Host to client) redirection is one type of content redirection. It’s supported only on Server OS VDAs (not Desktop OS VDAs).

When the URL redirection is enabled, the URLs are intercepted on the server VDA and sent to the user device. Citrix Workspace app for HTML5 displays a dialog prompting the user to select whether to open the URL within the session or on the local device. The dialog appears for every URL.

When the URL redirection is disabled, users open the URLs with web browsers or multimedia players on the server VDA. When the URL redirection is enabled, users can’t disable it.

URL redirection was previously known as server to client redirection or host to client redirection.

For more information, see General content redirection.

Battery status indicator

The battery status of the device now appears in the notification area within the virtual desktop session. Previously, the battery status indicator wasn’t visible in the session. This setting sometimes led to a loss of productivity when the laptop shuts down after the battery runs out.

The newly available battery status indicator feature is supported on Google Chrome and Microsoft Edge (Chromium) browsers. It’s supported only on VDA versions 7.18 and later.

Note:

With Microsoft Windows 10 VDA, the battery status indicator might take about 1 or 2 minutes to appear.

Improved in-session toolbar

Starting with the 2411 version, an enhanced toolbar UI appears when you start a desktop session. The look and feel of the in-session toolbar UI has changed. The toolbar UI is designed to enhance the end user experience by organizing the options in a user-friendly manner.

Old toolbar UI

Old Toolbar UI

New toolbar UI

New Toolbar UI

Note:

This feature is disabled by default. To enable the feature, follow the configuration steps.

Known issue in the feature

  • When you move the toolbar notch in the session, the tooltip for the notch doesn’t appear. [RFHTMCRM-14281]

Configuration

You can configure the new toolbar feature for on-premises setups as follows:

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 configure 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 new toolbar feature:

  1. Navigate to the configuration.js file in the HTML5Client folder.
  2. Add the switchToNewToolbar attribute and set the attribute to true. For example:
   {
       'ui': {
           'toolbar': {
               'switchToNewToolbar': true,
           }
       }
   }
<!--NeedCopy-->

Global App Configuration Service

On the cloud setup, administrators can enable or disable the improved toolbar feature by navigating to Workspace Configuration > App Configuration > Session Experience > Toolbar > New Session Toolbar. Select the checkbox and respective toggle button to enable the feature.

GACS

Icons and Actions

Note:

The icons are visible to the end users only if their organization’s admin has enabled the specific feature.

Icon/Action Description
Toolbar notch When you start an app or a desktop session, the toolbar notch appears at the top of the screen. When you click the notch, the toolbar appears in the unpinned state. Drag and reposition the toolbar notch onto any side of the screen. After you release the mouse, the notch will automatically align itself with the nearest edge.
Pin When you pin it, you can drag and reposition the toolbar onto any side of the screen. After you release the mouse, the toolbar automatically aligns itself with the nearest edge. The advantage of pinning the toolbar is that it doesn’t minimize into a notch after you complete an action that involves toolbar icons.
Unpin When you unpin the toolbar, it minimizes into a notch after you complete an action that involves toolbar icons. You can drag and reposition the toolbar notch onto any side of the screen.
Switch apps Click the icon to view the already opened apps in the same VDA. Note that, this icon doesn’t appear in the desktop session. Switch apps
Ctrl+Alt+Del You can perform the Ctrl+Alt+Del function with the click of a button. This option helps users to sign out, switch users, lock the system, or access the Task Manager.
File transfer

 
  • Upload and Download: you can upload or download a file between a user device and a session. For more information, see File handling.
  • Map a drive: The Client Drive Mapping (CDM) feature allows you to access your local folders and drives from Citrix Workspace app. For more information, see Client Drive Mapping. File Transfer
Clipboard You can use the clipboard option to copy and paste plain text and HTML data from the VDA to the local device and back. For more information, see Clipboard.
Devices
Click to open the USB Devices dialog box. Click Add to view the USB devices connected to the local device. The dialog box lists the devices that can be redirected to the session. To redirect the USB devices, select an appropriate device and click Connect. For more information, see USB device redirection.
Note: You can view the Devices icon only if your IT administrator provides access to connect USB devices through policy settings.
Preferences


 
  • Display Resolution: select the size of the resolution for the session display. By default, the screen resolution is set to Auto-fit screen.
  • Multi-touch mode: click to use the multi-touch mode. You can toggle between Panning and Multi-touch mode. This option is applicable to touch-screen devices. For more information, see Touch and mobility support.
  • More: displays preferences about the soft keyboard button and Citrix Customer Experience Improvement Program (CEIP). Preferences
Help

 
  • Gesture Guide – a gesture guide appears with details on how to use finger taps. This option is applicable only to touch-screen devices.
  • About – displays the current version of the Citrix Workspace app that you’re using.
Fullscreen You can switch your screen from windowed mode to full-screen mode. In Citrix Workspace app for HTML5, the fullscreen icon action doesn’t span the session across monitors. However, if you select the monitors from the custom layout and the session spans to the respective monitors, then when you restore, the Fullscreen icon gets replaced by the Extend option. When you click on the Extend icon, the session spans to the previously selected monitors.
Disconnect


The disconnect action keeps the virtual desktop running. Log out to save energy.
Note: When admin configures both Log out and Disconnect options, the following message appears. Disconnet
Log out to save energy: the log out action shuts down the virtual machine and conserves energy. End users must make sure to save their work before logging out.
Disconnect: closes the virtual desktop session window. However, the virtual session remains active until the next sign-in. End users can resume their work easily. The Sustainability leaf icon appears only when the sustainability feature is enabled. For more information, see Sustainability initiative from Citrix Workspace app.

Sustainability initiative from Citrix Workspace app

Starting from the 2405 version, we have introduced a sustainability initiative that encourages users to conserve energy that might be used due to running unused virtual desktops.

Starting from the 2411 version, admins can customize the disconnect and log out dialog box contents.

With this feature enabled, when users tap on the X icon to disconnect the session, a prompt is displayed to log out from the desktop session. This feature can be helpful in enterprises that use Windows OS policies to shut down VMs when no users are logged in.

Notes:

  • This feature is disabled by default.
  • This feature is available on both cloud and on-premises store.
  • To use this feature, you must enable the new toolbar feature. To enable, see the configuration section in the Improved in-session toolbar feature.

To enable this feature, do the following:

  1. Navigate to Citrix Studio.
  2. Click Delivery Groups from the left navigation pane.
  3. Select the required VDA from the Delivery Group section.
  4. Click the Edit icon. The Edit Delivery Group page appears.
  5. Click Desktops from the left navigation pane.
  6. Select the required VDA where you must add the keywords.
  7. Click Edit. The Edit Desktop page appears.
  8. Set the ICA-LogOffOnClose keyword to true in the Description field.
  9. Click OK. The following dialog box appears when you close the virtual desktop.

Sustainability

End users can exit from the session in two ways:

Log out to save energy - This sustainability action shuts down the virtual machine and conserve energy. End users must make sure to save their work before signing out.

Disconnect to close the virtual desktop session window. However, the virtual session remains active until the next sign-in. End users can resume their work easily.

Customizing the text in the Save Energy screen

Starting from the 2411 version, admins can customize the disconnect and log out dialog box contents in the Save energy screen.

Notes:

  • This feature is disabled by default.
  • This feature is available on both cloud and on-premises store.
  • To use this feature, you must enable the new toolbar feature. To enable, see the configuration section in the Improved in-session toolbar feature.

Prerequisites

The minimum on-prem StoreFront version required is 2407.

Configure

Admins can customize the sustainability dialog box contents using the following keywords in DDC for both on-premises and cloud setup:

Note:

The maximum number of characters allowed in the Description field is 200.

Keyword Description
ICA-LogOffOnClose Keyword for enabling/disabling Sustainability. The default value is false.
ICA-Icon Keyword for enabling/disabling Sustainability leaf Icon. Even if this setting is empty, the ICA-LogOffOnClose setting applies.
ICA-PromptMessage Keyword for customizing the prompt message that appears in the dialog box. If you haven’t given a customized message, then the default message applies.
ICA-Title Keyword for customizing the title that appears in the dialog box. If you haven’t given a customized message, then the default message applies.

Notes:

  • The disconnect and log out dialog boxes appear according to the parsed key.
  • If you choose not to use the sustainability feature, then the admin can configure the key LogOffOnClose to false. However, the user sees the default dialog box, and can choose to click the Don’t ask me again checkbox. When the user clicks this option, the session disconnects, but the dialog box doesn’t appear in subsequent sessions.

Customization:

To customize the text in the Save Energy screen, do the following:

  1. Follow steps 1–8 from the preceding section.
  2. Set the ICA-PromptMessage keyword to the required text in the Description field.
  3. Set the ICA-Title keyword to the required text in the Description field.
  4. Set the ICA-Icon keyword to true or false.

    Example:

    KEYWORDS:ICA-LogOffOnClose=true ICA-PromptMessage="Do you want to sign out from the session?" ICA-Title="Sign out or disconnect" ICA-Icon=true
    <!--NeedCopy-->
    

    The following screenshot displays how to edit desktop group dialogs:

    For on-premises setups

    Sustainability

    For cloud setups

    Sustainability

    The keywords are assigned by default for new desktop machines assigned to the group. For existing desktop machines, you must run the following PowerShell commands for changes to apply:

    $dg = Get-BrokerDesktopGroup -Name '<group name>' -Property 'Name','Uid'
        
    $apr = @( Get-BrokerAssignmentPolicyRule -DesktopGroupUid $dg.Uid -Property 'Description' )
    
    Get-BrokerMachine -DesktopGroupUid $dg.Uid -IsAssigned $true | Set-BrokerMachine -Description $apr[0].Description
    <!--NeedCopy-->
    

    With this PowerShell script, it’s possible to have multiple assignment policy rules for a single Delivery Group. Using Citrix Studio also, you can configure multiple Assignment policy rules, each with a unique description value, and a possible set of different keywords.

  5. Click OK. The following dialog box appears when you close the virtual desktop:

    Sustainability

    When ICA-Icon=false, the Leaf icon doesn’t appear.

    Sustainability

End user experience

When users tap on the X icon to disconnect the session, the following prompt appears:

Disconnect Prompt

End users can exit from the session in the following two ways:

  • Log out to save energy - This sustainability action shuts down the virtual machine and conserves energy. End users must make sure to save their work before logging out.
  • Disconnect - click Disconnect to close the virtual desktop session window. However, the virtual session remains active until the next sign-in. End users can resume their work easily.

Note:

The sustainability leaf icon appears only when your admin has enabled the sustainability feature.

Enhanced desktop launch experience

Starting with version 2411, Citrix Workspace app for HTML5 ensures an enhanced desktop launch experience. You’ll experience a seamless, flicker-free transition to your desktop without intermediate screens. The app also eliminates dark screens and flickering during resizing or stretching, providing a stable and modern interface. This feature is enabled by default.

Enhanced virtual desktop screen resizing experience

Starting with the 2411 version, Citrix Workspace app for HTML5 ensures a smooth transition and prevents dark screens and flickers when resizing or stretching your virtual desktop screen. This feature is enabled by default.

Session experience