Using URIs to Configure Omnissa Horizon Client

You can use uniform resource identifiers (URIs) to create web page or email links that end users can click to start Horizon Client, connect to a server, or open a remote desktop or published application.

You create these links by constructing URIs that provide some or all the following information so that your end users do not need to supply it.

• Server address
• Port number for the server
• Active Directory user name
• Domain name
• Remote desktop or published application display name
• Window size
• Actions including reset, log out, and start session
• Display protocol

To use URIs to start Horizon Client, Horizon Client must already be installed on client computers.

Supported Queries

The following queries are supported for this type of Horizon Client. If you are creating URIs for multiple types of clients, such as desktop clients and mobile clients, see the guide document for each type of client system for the list of supported queries.

• action
  The following values can be used with the action query.

  Value	Description
  browse	Displays a list of available remote desktops and published applications hosted on the specified server. You are not required to specify a remote desktop or published application when using this action.
  start-session	Opens the specified remote desktop or published application. If no action query is provided and the remote desktop or published application name is provided, start-session is the default action.
  reset	Shuts down and restarts the specified remote desktop or published application. Unsaved data is lost. Resetting a remote desktop is the same as pressing the Reset button on a physical PC.
  restart	Shuts down and restarts the specified remote desktop. Restarting a remote desktop is the same as the Windows operating system restart command. The operating system usually prompts the user to save any unsaved data before it restarts.
  logoff	Logs the user out of the guest operating system in the remote desktop. If you specify a published application, the action is ignored or the end user sees the warning message "Invalid URI action."

• args

  Specifies command-line arguments to add when the published application starts. Use the syntax args=value, where value is a string. Use percent encoding for the following characters:

  • For a colon (:), use %3A
  • For a back slash (\), use %5C
  • For a space ( ), use %20
  • For a double quotation mark ("), use %22 For example, to specify the filename "My new file.txt" for the Notepad++ application, use %22My%20new%20file.txt%22.

• appProtocol

  For published applications, valid values are PCOIP and BLAST. For example, to specify PCoIP, use the syntax appProtocol=PCOIP.

• desktopLayout

  Sets the size of the remote desktop window. To use this query, you must set the action query to start-session or not have an action query.

  The following values can be used for the desktopLayout query.

  Value	Description
  fullscreen	Full screen on one monitor. This value is the default.
  multimonitor	Full screen on all monitors.
  windowLarge	Large window.
  windowSmall	Small window.
  WxH	Custom resolution, where you specify the width by height, in pixels. An example of the syntax is desktopLayout=1280x800.

• desktopProtocol

  For remote desktops, valid values are RDP, PCOIP, and BLAST. For example, to specify PCoIP, use the syntax desktopProtocol=PCOIP.

• domainName

  Specifies the NETBIOS domain name associated with the user who is connecting to the remote desktop or published application. For example, you might use mycompany rather than mycompany.com.

• launchMinimized

  Starts Horizon Client in minimized mode. The Horizon Client window remains minimized and hidden in the background while the user-specified remote desktop or published application starts. The syntax is launchMinimized=true. The default value is false.

• useExisting

  If this option is set to true, only one Horizon Client instance can run. If users try to connect to a second server, they must log out of the first server, causing remote desktop and published application sessions to be disconnected. If this option is set to false, multiple Horizon Client instances can run and users can connect to multiple servers at the same time. The default is true. An example of the syntax is useExisting=false.

• unauthenticatedAccessEnabled

  • If this option is set to true, the Unauthenticated Access feature is activated. The File > Unauthenticated Access setting is visible in the user interface and is selected.
  • If this option is set to false, the Unauthenticated Access feature is deactivated. The File > Unauthenticated Access setting is visible in the user interface and is deselected.
  • If this option is set to "", the Unauthenticated Access feature is deactivated and the File > Unauthenticated Access setting is visible in the user interface and is deselected. An example of the syntax is unauthenticatedAccessEnabled=true.

• unauthenticatedAccessAccount

  If the Unauthenticated Access feature is activated, sets the account to use. If Unauthenticated Access is deactivated, then this query is ignored. An example of the syntax using the anonymous1 user account is unauthenticatedAccessAccount=anonymous1.