Client Features

To configure certain Horizon Client features, you can use settings in the common-setting section. The editable property specifies the availability of settings to change by the user. An asterisk in the following table indicates settings you can configure in the editable list.

Note: To ensure that modified settings take effect, users must restart Horizon Client.

Setting	Description
`editable`	Configures a list of Horizon Client settings and specifies whether a user can modify certain `common settings`. In general, the policy from each server determines value of the settings. You can add any client feature in this table marked with an asterisk (). If the value for a setting listed in the `editable` property is `false`, that setting is unavailable. The user cannot change that setting. The user interface appears gray. To make changes, the system administrator can update the policy set by the server. If a setting is in `editable` property list and set to `true`, that setting is available in the user interface. The user can make a change. Note:* On first use, the client applies any settings in the policy for server. After that, if the setting is editable and has been changed by the user, the client uses that setting.
`allowDataSharing`*	Configures the data sharing feature. Set the value to enable or deactivate sharing. Valid values are `true` (enable) and `false` (deactivate).
`allowFileDownload`	Configures whether users can download files from a remote desktop to the client device using the file transfer feature. Set the value to enable or block file downloading. Valid values are `true` (enable) and `false` (block). The default value is `true`. Note: To enable file downloading with the file transfer feature, you must enable `allowFileDownload` on the client side and also set the `Configure file transfer` GPO setting to allow file downloading on the agent side. See Horizon Remote Desktop Features and GPOs.
`allowFileUpload`	Configures whether users can upload files to a remote desktop from the client device using the file transfer feature. Set the value to enable or block file uploading. Valid values are `true` (enable) and `false` (block). The default value is `true`. Note: To enable file uploading with the file transfer feature, you must enable `allowFileUpload` on the client side and also set the `Configure file transfer` GPO setting to allow file uploading on the agent side. See Horizon Remote Desktop Features and GPOs.
`autoForwardUSB*`	Activates or deactivates automatic USB redirection. The value specifies whether automatic USB redirection is activated or deactivated. The `editable` property specifies whether users can change the USB auto-connect settings in the Settings window. Valid values for both properties are `true` and `false`.
`display`*	Configures the use of local monitors available to the client. This setting can specify the size of the client window. This setting activates on launch of a remote desktop. Available options: `useAllMonitor`: render in all available monitors. `singleMonitor`: render in one monitor using the default window size. `singleMonitorFullscreen`: render in a one monitor using the full screen. `singleMonitorSmallWindow`: render in one monitor using a small window size (640x480) `singleMonitorLargeWindow`: render in one monitor using the large window size (1680x983). `{width:mmm, height:nnn}`: render in one monitor using the size you provide. (mmmxnnn) This setting is locked if `display` is missing from the list in the `editable` property or set to `false`. If set to `true` in the `editable` property, the user can change the setting. .
`enableAdvancedTouch`	Activates or deactivates support for advanced touchscreen gestures, as described in [Touchpad, Touchscreen, Keypad, and Mouse Gestures](TouchpadTouchscreenKeypadandMouseGestures.md). Valid values are `true` (activate) and `false` (deactivate). The default value is `true`.
`enableAnonymousLogin`*	Configures the Unauthenticated Access feature that appears as Log in anonymously using Unauthenticated Access in the settings dialog box. The `value` property specifies whether the feature is enabled or deactivated. Valid values are `true` and `false`.
`enableFileAssociation`	Configures the activation state of the File Association feature described in [Set File Association](Set File Association.md). Valid values are as follows: `true`: File Association is enabled. `false`: File Association is deactivated. Users can still right-click a local file and select Horizon Client for Chrome, but a warning message appears instead of a list of available apps. If `enableFileAssociation` is not configured, File Association is enabled by default.
`enableHighResolution*`	Configures the high resolution mode feature. The `value` property specifies whether the feature is activated or deactivated. The `editable` property specifies whether users can change the High Resolution Mode setting in Horizon Client. Valid values for both properties are `true` and `false`.
`enableMediaStream`	Determines whether client users can configure camera and microphone permissions for the Browser Redirection feature and the Media Optimization for Microsoft Teams feature for the Chrome client. Valid values are as follows: `true`: Client users can configure settings and respond to prompts that allow or deny remote browsers access to client cameras and microphones during Browser Redirection. `false`: All settings and prompts related to camera and microphone permissions are hidden from client users. Users cannot configure these permissions. Remote browsers are automatically denied access to client cameras and microphones during Browser Redirection. The default value is `true`. For more information, see [Configure Browser Redirection](ConfigureBrowserRedirection.md) and the "Media Optimization for Microsoft Teams" section in the Horizon Remote Desktop Features and GPOs document.
`enableH264`	Specifies whether the rendering method uses H.264 video mode. The client enables H.264 video mode. Valid values are `true` and `false`. Note: This option appears in the settings window only if you are using a normal display with a ratio greater than 100% and if the administrator has not deactivated the feature.
`enableRTAVH264Codec`	Enables or deactivates the H.264 codec for Real-Time Audio-Video. Valid values are `true` (enable H.264) and `false` (deactivate H.264). The default value is `true`. For more information, see [Using the Real-Time Audio-Video Feature for Webcams, Microphones, and Speakers](UsingtheReal-TimeAudio-VideoFeatureforWebcamsMicrophonesandSpeakers.md).
`forcePrivateMode`	Enable privacy mode for Horizon Cloud on Azure next-gen. Use this setting to force enable the privacy mode for end users. When this setting is enabled, users must authenticate to login. The user is then directed to the browser logout page when the Horizon client is closed or when the current server is disconnected. This setting is disabled when not configured
`enableNetworkIndicator`	Activates or deactivates the network notification feature, as described in [Detect Unstable Network Connections](DetectUnstableNetworkConnections.md). Valid values are `true` (feature activated) and `false` (feature deactivated). Setting the value to `false` removes the Disable network state display option from the Settings window. The default value is `true`.
`enableLogoutTriggeredQuit`	Triggers the client to close upon logout. When the policy option is enabled, the policy option triggers the client to close upon successful user logout. This option accepts boolean values of type `true` or `false`.
`enableDisconnectionTriggeredQuit`	Triggers the client to close upon the disconnection from the last active desktop or application. When the policy option is enabled, the policy option triggers the client to close upon the disconnection from the last active desktop or application. This option accepts boolean values of type `true` or `false`.
`enableScreenSharing`*	Allows or disallows users to share the contents of their local screen when using published applications. Valid values are `true` (allow) and `false` (disallow). The `editable` property specifies whether users can control their screen-sharing permissions from the Settings window.
`enableWebRTCRedirection`*	Activates or deactivates the media optimization feature for WebRTC-based applications. When activated, this feature optimizes audio, video, and screenshare streams from WebRTC-based applications inside a remote desktop. This feature improves the overall audio-visual experience of users during virtual meetings and conference calls. Valid values are `true` (feature activated) and `false` (feature deactivated). The `editable` property specifies whether users can control the activation state of WebRTC media optimization from the Settings window.
`enableWindowsKey*`	Activates or deactivates the Windows key for remote desktops. The value specifies whether the feature is activated or deactivated. The `editable` property specifies whether users can change the Enable Windows Key for Desktops setting in Horizon Client. Valid values for both properties are `true` and `false`.
`hardwareAccelerationOption`	Configures the client-side GPU hardware acceleration for Real-Time Audio-Video. For more information, see [Using the Real-Time Audio-Video Feature for Webcams, Microphones, and Speakers](UsingtheReal-TimeAudio-VideoFeatureforWebcamsMicrophonesandSpeakers.md). Valid values are as follows: `no-preference` allows the client flexibility to use either hardware acceleration or software acceleration, based on what is optimal for the system and configuration. This is the default value. `prefer-hardware` turns on hardware acceleration. `prefer-software` turns off hardware acceleration and uses software acceleration instead.
`hideSecondaryServer`	Configures whether Horizon Client displays a server icon for both the primary and secondary server host names, or for the primary server host name only. Valid values are `true` (display a single icon for the primary host name only) and `false`. When set to `true`, Horizon Client displays an icon for the primary host name only. When set to `false`, Horizon Client displays a server icon for both the primary and secondary server host names. This setting can result in the display of two icons for the same server. For example, in the case where a load balancer functions as the primary host and Unified Access Gateway (UAG) functions as the secondary host, Horizon Client displays an icon for the load balancer host name and a duplicate icon for the UAG host name. The default value is `true`.
`ignoreCertErrors`	Configures whether the Browser Redirection feature opens pages that contain SSL or security certificate errors. Valid values are as follows: `false`: The Browser Redirection feature does not open pages with SSL or certificate errors. The pages are not redirected and Horizon Client displays a message about the SSL or certificate error. `true`: The Browser Redirection feature proceeds to open pages with SSL or certificate errors. The errors are ignored and the pages are redirected. The default value is `false`. For more information, see [Configure Browser Redirection](ConfigureBrowserRedirection.md).
`networkStateConfig`	Specifies the threshold parameters used by Horizon Client to calculate the network quality score and determine network stability. For detailed information how Horizon Client uses these parameters, see [Detect Unstable Network Connections](DetectUnstableNetworkConnections.md). This setting includes the following properties: `networkStateTcpRttMSLow`: specifies the low RTT threshold value used to calculate the network quality score. The value must be a positive integer less than the `networkStateTcpRttMSHigh` value. The default value is 2. `networkStateTcpRttMSHigh:`specifies the high RTT threshold value used to calculate the network quality score. The value must be a positive integer greater than the `networkStateTcpRttMSLow` value. The default value is 400. `networkStateQualityScoreTcpThresholdGood`: specifies the minimum score required to indicate good network stability. Valid values must be from 0 through 100 and be greater than the `networkStateQualityScoreTcpThresholdPoor` value. The default value is 85. `networkStateQualityScoreTcpThresholdPoor`: specifies the high limit of the score range indicating poor network stability. Valid values must be from 0 through 100 and be less than the `networkStateQualityScoreTcpThresholdGood` value. The default value is 40. `networkStateRttCheckPeriodMs`: specifies the time interval, in milliseconds, during which network RTT is monitored. Valid values must be greater than 2000. The default value is 15000.
`powerSetting`	Prevents the device from going to sleep in response to user inactivity in a remote session. By default, the Chrome device goes to sleep after 10 minutes. When you configure `powerSetting`, the device does not go to sleep until after the last remote session ends. The `keepAwakeLevel` property specifies the level of the power policy. The following values are valid for the `keepAwakeLevel` property: `system`: prevents the system from sleeping in response to user inactivity. This value is the default. `display`: prevents the display from being turned off or dimmed, or the system from sleeping, in response to user inactivity.
`splitUSB`	Specifies the split redirection behavior for USB devices, as described in "Split Composite USB Devices" in [Use USB Devices in a Virtual Desktop](UseUSBDevicesinaVirtualDesktop.md). This setting includes the following properties: `allowList` specifies the composite devices that are allowed to be split for redirection. If a device is not listed, it is not split. Set the value to an array of data objects with the following key-value pairs: `<ul> <li><code>device</code> specifies the identity of the composite device. Valid values take the format <vid>:<pid>, where <vid> specifies the vendor ID and <pid> specifies the product ID of the device. </li> <li><code>excludedInterface</code> specifies the interfaces of the device that should not be redirected. Configure the value as an array of the excluded interface IDs. </li> </ul></li>` `blockList` specifies the composite devices that are blocked from being split for redirection. Configure the value as an array of objects using the format <vid>:<pid>, where <vid> specifies the vendor ID and <pid> specifies the product ID of the device. When this setting is used, the equivalent agent group policy setting (Split Vid/Pid Device) is ignored.
`urlFiltering`	Configures URL Content Redirection rules for the client. The URL Content Redirection feature also requires agent-side configuration. For more information, see Requirements for Using URL Content Redirection and "Configuring URL Content Redirection" in the Horizon Remote Desktop Features and GPOs document. Note: You must restart Horizon Client for any modified rules to take effect. Note: The URL Content Redirection rules configured using the `vdmutil` command-line interface on a Connection Server instance take priority over the URL Content Redirection configured using the `urlFiltering` setting. The `urlFiltering` setting has one property, `protocols`, which is set to an object array with the following properties: `brokerHostname`: IP address or fully qualified domain name (FQDN) of the Connection Server host to use when redirecting URLs. `protocol`: URL protocol to be redirected. `remoteItem`: display name of the remote desktop or application pool that can handle the URLs specified for `agentRules`. `agentRules`: URLs that are redirected to the remote desktop or application specified for `remoteItem`. For example, if you set `agentRules` to `.mycompany.com`, all URLs that include the string `mycompany.com` are redirected to the remote desktop or application. Note:* The range of redirected URLs can differ based on the rule syntax that you use for `agentRules`. The rule syntax `.mycompany.com` supports the redirection of all URLs that contain the string `mycompany.com`, including `http://mycompany.com`. The rule syntax `..mycompany.com` supports the redirection of all URLs that contain the string `.mycompany.com`. However, it does not support redirection of the root URL. For example, `http://mycompany.com` is not redirected.
`useAssetIdReplaceMachineName`	Configures how to pass the client asset ID (the physical computer name) to a corresponding Horizon environmental variable. For more information, see [Omnissa Knowledge Base (KB) article 92513](https://kb.omnissa.com/s/article/92513). Valid values are as follows: `false`: The asset ID is passed to the ViewClient_Asset_ID environmental variable. `true`: The asset ID is passed to the ViewClient_Machine_Name environmental variable. The default value is `false`.
`ws1WebviewMode`	Configures whether users can authenticate into Horizon Client running as a managed app, such as an app managed by Unified Access Gateway and Workspace ONE. Valid values are as follows: `secure-webview`: allows users to authenticate into Horizon Client as a managed app, and clears cache and cookies after authentication is complete. `persistent-webview`: allows users to authenticate into Horizon Client as a managed app, but does not clear cache and cookies after authentication is complete. This value allows the storage of authentication information. `browser`: requires the opening of a browser window for user authentication. This value prevents Horizon Client from running as a managed app. The default value is `secure-webview`.

The following example of a JSON configuration file shows the common settings and usage of the editable property. This example shows the recommended settings that maximize performance and efficiency for an optimal user experience.

{
  "broker_list": {
    "Value": {
      "settings": {
        "server-list": [
          {
            "server": "viewserver0.mydomain.com",
            "default": true,
            "description": "View Server 0",
            "username": "User0",
            "domain": "TestDomain0"
          }
        ],
        "common-setting": {
          "allowDataSharing": true,
          "allowFileDownload": true,
          "allowFileUpload": true,
          "autoForwardUSB": true,
          "autoForwardUSBPolicy": [
            {
               "desktop": "HorizonAutoUsbAll",
               "autoConnectAllOnStart": true,
               "autoConnectAllOnInsert": true
            }
         ],
          "enableAdvancedTouch": true,
          "enableAnonymousLogin": false,
          "enableDisconnectionTriggeredQuit": true,
          "enableFileAssociation": false,
          "enableH264": true,
          "enableHighResolution": false,
          "enableLogoutTriggeredQuit": true,
          "enableMediaStream": false,
          "enableNetworkIndicator": true,
          "enableRTAVH264Codec": true,
          "enableScreenSharing": true,
          "enableWindowsKey": true,
          "display": "useAllMonitor",
          "forcePrivateMode": true,
          "hardwareAccelerationOption": "no-preference",
          "hideSecondaryServer": true,
          "ignoreCertErrors": false,
          "useAssetIdReplaceMachineName": false,
          "ws1WebviewMode": "secure-webview",
          "networkStateConfig": {
            "networkStateTcpRttMSLow": 2,
            "networkStateTcpRttMSHigh": 400,
            "networkStateQualityScoreTcpThresholdGood": 85,
            "networkStateQualityScoreTcpThresholdPoor": 40,
            "networkStateRttCheckPeriodMs": 15000
          },
          "splitUSB": {
            "allowList": [
              {
                "device": "0554:1001",
                "excludedInterface": [
                  "00",
                  "01",
                  "02"
                ]
              }
            ]
          },
          "urlFiltering": {
            "protocols": [
              {
                "brokerHostname": "10.117.24.28",
                "protocol": "http",
                "remoteItem": "win2022_RDSH",
                "agentRules": ".*example1.com"
              },
              {
                "brokerHostname": "10.117.161.109",
                "protocol": "https",
                "remoteItem": "win10_VDI",
                "agentRules": ".*example2.com"
              }
            ]
          },
          "editable": {
            "allowDataSharing": true,
            "autoForwardUSB": true,
            "enableAnonymousLogin": true,
            "enableHighResolution": true,
            "enableH264": true,
            "enableWebRTCRedirection": true,
            "enableScreenSharing": true,
            "display": true
          }
        }
      }
    }
  }
}

Was this page helpful?

Client Features

Provide feedback for this topic

Write your review