You can customize Horizon HTML Access to co-brand Horizon HTML Access with a VMware partner. As a result of the co-branding, the user interface of the Horizon HTML Access will be a combination of the VMware brand and the brand of a VMware partner.

Create a Folder For Branding

Before you customize the HTML Access page, create a folder for branding and perform the following steps:

  1. Install Horizon Connection Server and navigate to the default installation directory at: C:\Program Files\VMware\VMware View\Server\broker.
    Note: In the following steps, the installation directory is represented by {CS_INSTALL_DIR}.
  2. Create a new folder called rebrandresource, within the C:\ drive.
  3. Create the following new folders within C:\rebrandresource folder at the following paths:
    Folder Name File Path
    icons C:\rebrandresource\icons
    bundle C:\rebrandresource\bundle
  4. Copy all the images to be used for branding into the icons folder. For more information, see the Client Logo section.
  5. Copy all the files to be used for branding text into the bundles folder. For more information, see the Client Text section.
  6. Navigate to CommonAppDataFolder\VMware\VDM\portal directory and open the portal-links-html-access.properties file using a text editor.
    Note: The CommonAppDataFolder directory is usually in the C:\ProgramData directory. To view the C:\ProgramData folder in Windows Explorer, use the Folder Options dialog box to show the hidden folders.
  7. Open the portal-links-html-access.properties configuration file and add the following lines at the end of the file:
    # Configure whether it is rebranded
    rebrand.enable=true
    # The rebranding name string, rebrand client page title (ASCII characters only)
    rebrand.name={NEW_BRAND}
    # Add the URL of online help system for login page if necessary
    rebrand.helpURL={NEW_HELP_LINK}
    # Path to rebranding resource folder (Only ASCII characters and forward slash “/” are supported, e.g. c:/rebrandresource.)
    cobranding.location=C:/rebrandresource
  8. Modify the Client download and help links. For more information, see the Client Download and Help Links section.
  9. Restart the VMware Horizon Web Component service after all the modification is complete.

Configure the VMware Horizon 8 Web Portal Page

On the VMware Horizon 8 Web portal page, the installer icon and the HTML Access icon is enabled by default and the links associated with these icons navigate to the client download page on the VMware website. To disable an icon and removea an icon from the web page, perform the following steps:

  1. Set the Disable HTML Access property to false.
  2. Use a text editor to open the portal-links-html-access.properties file and modify the properties in the file. For more information on locating the portal-links-html-access.properties file, see the Create a Folder for Branding section.
Option Property Setting
Disable HTML Access

enable.webclient=false

If this option is set to false, but the enable.download option is set to true, the user is navigated to a web page for downloading the native Horizon Client installer. If both options are set to false, the user receives the following message: "Contact your local administrator for instructions on accessing this Connection Server."

Disable downloading Horizon Client

enable.download=false

If this option is set to false and the enable.webclient option is set to true, the user is navigated to the HTML Access login web page. If both options are set to false, the user receives the following message: "Contact your local administrator for instructions on accessing this Connection Server."

Note: After you configure the VMware Horizon 8 Web portal page, you must restart the VMware Horizon Web Component service.

Client Download and Help Links

In certain scenarios, you might want the links on the VMware Horizon 8 Web portal page to point to an internal web server, or you might want to make specific client versions available on your own server. You can reconfigure the VMware Horizon 8 Web portal page to point to a different download URL by modifying the contents of the portal-links-html-access.properties file.

For example, if you browse to the VMware Horizon 8 Web portal page from a macOS system, the link for the Horizon Client for Mac installer appears. For Linux clients, you can make separate links for 32-bit and 64-bit installers. For Chrome clients, you can substitute the link to Horizon Client for Chrome in the Chrome Web Store.

Note:
  • Privacy policy cannot be modified due to legal issue.
  • For the users to download installers from an external location other than the VMware website, copy the installer files on the HTTP server where the installer files reside. This location must correspond to the URLs that you specified in the portal-links-html-access.properties file or in the oslinks.properties file from the previous step.

    For example, to place the files in a downloads directory on the Connection Server host, use the following path: C:\Program Files\VMware\VMware View\Server\broker\webapps\downloads.

  • Restart the Horizon Web Component service after the modification is complete.

Use a text editor to open the portal-links-html-access.properties file. For more information on accessing the portal-links-html-access.properties file, see Create a Folder for Branding section.

Option Property Setting
Change the URL of the Web page for downloading Horizon Client

link.download=https://url-of-web-server

Use this property to create your own web page.

Change the URL for the Help link in the portal page

link.help

By default, this link points to a help system hosted on the VMware website. The Help link appears at the bottom of the login page.

Change the URL for the Help link in the login page

rebrand.helpURL={NEW_HELP_LINK}

Add this setting at the end of the portal-links-html-access.properties file.

Create links for specific installers

The following examples display full URLs. If you place the installer files in the downloads directory, that is, under the C:\Program Files\VMware\VMware View\Server\broker\webapps\ directory on the Connection Server host, you can use the relative URLs as described in the following list.

Note: If the portal-links-html-access.properties file is unavailable or is empty, and the oslinks.properties file exists, then the oslinks.properties file determines the link value for the installer file.

The oslinks.properties file is installed in the installation-directory\VMware\VMware View\Server\broker\webapps\portal\WEB-INF directory. If this file is missing during the HTML Access session, then by default, the download link directs the users to https://www.vmware.com/go/viewclients. The file contains the following default values.

Note: The oslinks.properties file can be used only to configure the links to the specific installer files.

Use a text editor to open the oslinks.properties file.

link.download=https://www.vmware.com/go/viewclients # download Links for particular platforms
link.win32=https://www.vmware.com/go/viewclients#win32
link.win64=https://www.vmware.com/go/viewclients#win64
link.linux32=https://www.vmware.com/go/viewclients#linux32
link.linux64=https://www.vmware.com/go/viewclients#linux64
link.mac=https://www.vmware.com/go/viewclients#mac
link.ios=https://itunes.apple.com/us/app/vmware-view-for-ipad/id417993697
link.android=https://play.google.com/store/apps/details?id=com.vmware.view.client.android
link.chromeos=https://play.google.com/store/apps/details?id=com.vmware.view.client.android
link.winmobile=https://www.microsoft.com/en-us/store/p/vmware-horizon-client/9nblggh51p19

Modifying the Logo in the Client User Interface

You can modify the logo in the client user interface. Before you begin, add any custom files you are using for this process to the C:\rebrandresource\icons folder. If you have not yet created this folder, see Create a Folder for Branding section.

Note: You must copy the new icons with the same size and format.

The following table lists the format and sizing information of the icons in the VMware Horizon 8 Web portal page.

Image Description File Name Format Size
VMware Horizon icon on portal page and login page. logo.png PNG 181 x 105 px
VMware Horizon icon on portal page and Log in page in 200 dpi logo@2x.png PNG 362 x 210 px
VMware logo on portal, pre-login, and login pages

vmware_logo_

footer.svg

SVG 83 x 13 px

The following table lists the format and sizing information of the icons in the Client page.

Image Description File Name Format Size
Logo used in the About VMware Horizon Client dialog window. horizon-icon.svg SVG 100 x 100 px
Logo on select pages. logo-horizon.png PNG 161 x 40
Logo on select pages in 200 dpi. logo-horizon2x.png PNG 322 x 80 px

The following images show an example of the appearance of the VMware Horizon 8 Web portal page before and after these changes.

Before applying the changes:

After applying the changes:

Modifying Client Text in the Client User Interface

You can modify the client text in the client user interface. Before you begin, add any custom files you are using for this process to the C:\rebrandresource\bundle folder. If you have not yet created this folder, see Create a Folder for Branding section.

Copy all the files in the ${CS_INSTALL_DIR}\webapps\portal\WEB-INF\classes\com\vmware\vdi\installer\i18n folder and place the customized files in the C:\rebrandresource\bundle folder. Modify the following files according to the languages that are supported and convert non-ASCII characters to Unicode format.

Language File
English bundle.properties
German bundle_de.properties
French bundle_fr.properties
Spanish bundle_es.properties
Japanese bundle_ja.properties
Korean bundle_ko.properties
Chinese Simplified bundle_zh_CN.properties
Chinese Traditional bundle_zh_TW.properties
Others bundle.properties

For example, the following text strings in the bundle.properties file can be modified:

Default Text String New Text String
app.title=VMware Horizon app.title={NEW_BRAND}
logo.icon.alt=VMware Horizon logo.icon.alt={NEW_BRAND}
logo.label.alt=VMware Horizon logo.label.alt={NEW_BRAND}
install.message.first=You can connect to your desktop and applications by using the VMware Horizon Client, or to your desktop through the browser. install.message.first=You can connect to your desktop and applications by using the {NEW_BRAND}, or to your desktop through the browser.
install.message.second=The VMware Horizon Client offers better performance and features. install.message.second=The {NEW_BRAND} offers better performance and features.
native.button.title=VMware Horizon Client native.button.title={NEW_BRAND}
install.native.button.title=Install VMware Horizon client

install.native.button.title=Install {NEW_BRAND} client

web.button.title=VMware Horizon HTML Access web.button.title={NEW_BRAND} HTML Access
install.web.button.title=VMware Horizon HTML Access install.web.button.title={NEW_BRAND} HTML Access
download.link.message=To see the full list of VMware Horizon Clients, click download.link.message=To see the full list of {NEW_BRAND} Clients, click
download.link.title=Download VMware Horizon Client download.link.title=Download {NEW_BRAND}
help.link.message=For help with VMware Horizon help.link.message=For help with {NEW_BRAND}, click

Modifying Client Text in the Client page

Before you begin, add any custom files for this process to the C:\rebrandresource\ folder. If you have not yet created this folder, see Create a Folder For Branding section. Copy all the files in the {CS_INSTALL_DIR}\webapps\portal\webclient\locale folder and place the customized files in the C:\rebrandresource\ folder. Modify the following files according to the languages that are supported.

Language File
English en.json
German de.json
French fr.json
Spanish es.json
Japanese ja.json
Korean ko.json
Chinese Simplified zh_CN.json
Chinese Traditional zh_TW.json

For example, the following text strings in the en.json file can be modified:

Default Text String New Text String

"dialog_confirm_logout" : "Are you sure you want to log out of the Horizon Connection Server?"

"dialog_confirm_logout" : "Are you sure you want to log out of the {NEW_BRAND} Connection Server?"

"header_about_horizon" : "About VMware Horizon"

"header_about_horizon" : "About {NEW_BRAND}"

"help_with_vmware_horizon": "Help with VMware Horizon"

"help_with_vmware_horizon": "Help with {NEW_BRAND}"

"install_native_client": "Install VMware Horizon Client"

"install_native_client": "Install {NEW_BRAND} Client"

"LOGOFF_BROKER": "Log off from VMware Horizon"

"LOGOFF_BROKER": "Log off from {NEW_BRAND}"

"validation_server_name": "Enter the host name of the Horizon Connection Server."

"validation_server_name": "Enter the host name of the {NEW_BRAND} Connection Server."

"download_rich_client_os_win32": "Download the Horizon Client for Windows (x86)", "download_rich_client_os_win64": "Download the Horizon Client for Windows (x64)", "download_rich_client_os_winmobile": "Download the Horizon Client for Windows UWP",

"download_rich_client_os_linux32": "Download the Horizon Client for Linux (x86)",

"download_rich_client_os_linux64": "Download the Horizon Client for Linux (x64)",

"download_rich_client_os_mac": "Download the Horizon Client for Mac OS X",

"download_rich_client_os_android": "Download the Horizon Client for Android",

"download_rich_client_os_ios": "Download the Horizon Client for iOS",

"download_rich_client_os_chromeos": "Download the Horizon Client for Chrome OS",

"download_rich_client_os_unknown": "Download the Horizon Client for a richer experience"

"download_rich_client_os_win32": "Download the {NEW_BRAND} Client for Windows (x86)", "download_rich_client_os_win64": "Download the {NEW_BRAND} Client for Windows (x64)",

"download_rich_client_os_winmobile": "Download the {NEW_BRAND} Client for Windows UWP",

"download_rich_client_os_linux32": "Download the {NEW_BRAND}" Client for Linux (x86)",

"download_rich_client_os_linux64": "Download the {NEW_BRAND} Client for Linux (x64)",

"download_rich_client_os_mac": "Download the {NEW_BRAND} Client for Mac OS X",

"download_rich_client_os_android": "Download the {NEW_BRAND} Client for Android",

"download_rich_client_os_ios": "Download the {NEW_BRAND} Client for iOS",

"download_rich_client_os_chromeos": "Download the {NEW_BRAND} Client for Chrome OS",

"download_rich_client_os_unknown": "Download the {NEW_BRAND} Client for a richer experience"

Modify HTML Access Tab Logo

Before you begin to modify the HTML Access tab logo, add any custom files for this process to the C:\rebrandresource folder. If you have not yet created this folder, see Create a Folder for Branding. section.

Copy the modified file in the C:\rebrandresource folder.

Filename Format Size

favicon.ico

ICO 32 × 32 px
Note: To view the branding updates, end users must clear their browser cache and reload the portal page.

The following image shows the page before applying the changes:

The following image shows the page after applying the changes:

Upgrade HTML Access

Before you upgrade the HTML Access components, take a backup of any changes to the portal-links-html-access.properties file in the <CommonAppDataFolder>\VMware\VDM\portal folder.

For example, for the Windows Server 2012 operating systems, the file is located at C:\ProgramData\VMware\VDM\portal\portal-links-html-access.properties. The upgrade process will overwrite any changes to this file.