Citrix Gateway

Add the Citrix Gateway plug-in to the Citrix Workspace app

December 14, 2020

Contributed by:

When Citrix Workspace app is installed on the user device, users can log on with the Citrix Gateway plug-in through the Citrix Workspace app. You upload the Citrix Gateway plug-in to the Merchandising Server, which then downloads and installs the plug-in to Citrix Workspace app on the user device. If users have the Citrix Gateway plug-in installed when they install Citrix Workspace app for the first time, the plug-in is automatically added to Citrix Workspace app.

Deliver plug-ins to the user devices

To deliver plug-ins to user devices, you must upload and configure the Citrix Gateway plug-in on the Merchandising Server. When users make a selection, the plug-in downloads and installs from the Merchandising Server.

If users install the Citrix Gateway plug-in and then later install Citrix Workspace app, when the Citrix Workspace app installation is complete, the Citrix Gateway plug-in appears in the Citrix Workspace app menu.

If users have Citrix Workspace app for Windows, users can install Citrix Workspace app Updater for Windows. This is an optional component that updates the plug-ins and communicates with the Merchandising Server. Citrix Workspace app includes all the plug-ins available for delivery, including the Citrix Gateway plug-in. For more information about Citrix Workspace app Updater for Windows, see the Citrix Workspace apps and plug-ins section in the Citrix Product Documentation.

Connect to Citrix Gateway with Citrix Workspace app

If users connect with Citrix Workspace app for Windows, they can right-click the Citrix Workspace app icon in the notification area, click Preferences, and then click plug-in status. If the Citrix Gateway plug-in is installed on the user device, users right-click the Citrix Gateway plug-in, and then click Logon. When authentication succeeds, the Citrix Gateway plug-in establishes the connection to Citrix Gateway and establishes a full VPN tunnel.

Users can also log on with a web browser. Users enter the fully qualified domain name (FQDN) of Citrix Gateway and log on. When Citrix Gateway establishes the connection, users can verify the connection on the Preferences > plug-in status panel in Citrix Workspace app.

The Citrix Gateway web address is part of the metadata configured on the Merchandising Server and users cannot change the address. The Citrix Gateway plug-in initiates the logon to Citrix Gateway. If the version of the Citrix Gateway plug-in for Windows that is installed on the user device is different than the version on the Citrix Gateway appliance, the plug-in downgrades or upgrades automatically when users log on. The Citrix Gateway plug-in for macOS X does not downgrade automatically. To install an earlier version of the plug-in on a Mac computer, users must first uninstall the Citrix Gateway plug-in and then download the earlier version from Citrix Gateway.

Upgrade or downgrade the Citrix Gateway plug-in

During an upgrade or downgrade of the Citrix Gateway plug-in, the appliance removes, downloads, and then installs the correct version of the plug-in. Users can confirm the new installation by checking the plug-in entry on the Preferences > plug-in status panel in Citrix Workspace app. The newly installed version of the Citrix Gateway plug-in might be a different version than what is configured on the Merchandising Server.

Add the Citrix Gateway plug-in to the Merchandising Server

You can also configure Citrix Gateway plug-in delivery on the Merchandising Server, which provides a web configuration interface that allows you to upload the Citrix Gateway plug-in MSI installation package. On Merchandising Server, you can:

Specify the version and metadata for the Citrix Gateway plug-in.
Configure one or more Web addresses for the Citrix Gateway appliance.
Associate specific rules based on operating system or other parameters for delivery.

Users cannot add or remove servers from the list of servers configured on Merchandising Server, although they can select a different server from the configured list in the Network Settings panel in Citrix Workspace app.

If you are using Access Scenario Fallback or load balancing, you can configure a fixed set of Citrix Gateway web addresses and designate the Merchandising Server as the default address. Users connect to the default server when they select Log On from the Citrix Workspace app menu. Users can select a different address from the provided list by using the Citrix Workspace app’s Preferences > Network Settings panel in Citrix Workspace app.

Users can continue to use a web browser to log on to any Citrix Gateway. If users log on by using a web browser, the Citrix Gateway plug-in upgrades or downgrades automatically to the version that is on Citrix Gateway.

The following are general steps for adding the Citrix Gateway plug-in to the Merchandising Server.

Configure the settings on the General tab in the Merchandising Server Administrator Console.
Add the Citrix Gateway plug-in to the Merchandising Server.
Select the appropriate plug-in version for the target platform. The Citrix Gateway plug-in must be added to the main page of the Merchandising Server for the plug-in to appear in the Add plug-ins to Delivery page.
Configure delivery for the Citrix Gateway plug-in.
Use a friendly name for the location that identifies the Citrix Gateway Web address. This name appears in Citrix Workspace app. You can also add more Citrix Gateway appliances.
Specify authentication type and customize specific labels that appear in the Citrix Workspace app logon dialog box, such as the user name, password, or personal identification number (PIN).
Add rules for the delivery.
Create rules if you want rules to appear in the Add Rule to Delivery page.
Schedule the delivery.

The official version of this content is in English. Some of the Citrix documentation content is machine translated for your convenience only. Citrix has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Citrix product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Citrix, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Citrix will not be held responsible for any damage or issues that may arise from using machine-translated content.

Add the Citrix Gateway plug-in to the Citrix Workspace app

December 14, 2020

Contributed by:

December 14, 2020

Contributed by:

Add the Citrix Gateway plug-in to the Citrix Workspace app

Deliver plug-ins to the user devices

Connect to Citrix Gateway with Citrix Workspace app

Upgrade or downgrade the Citrix Gateway plug-in

Add the Citrix Gateway plug-in to the Merchandising Server

In this article