Gateway

RfWebUI configuration parameters

September 23, 2024

Contributed by:

C C

The overall behavior of the NetScaler Gateway portal is influenced by two configuration files: the local NetScaler Gateway configuration file and the StoreFront file.

Depending on your deployment, you can modify the NetScaler Gateway portal behavior by changing the properties in the “plugins.xml” file. This file appears as a configuration file on the browser which is the request for /var/netscaler/logon/themes/<custom_theme>/plugins.xml.

During logon, the NetScaler Gateway configuration files are used. But when connected to StoreFront, StoreFront sends a new configuration and the earlier configuration is overwritten. This behavior differs for clientless VPN and ICA.

For ICA, the StoreFront configuration always takes precedence but some of the behaviors in the clientless VPN that are influenced by the NetScaler Gateway configuration are retained even after the new configuration is updated from the StoreFront.

The following table lists the parameters describing the configuration that takes precedence over clientless VPN and ICA.

Config type	sub config type	Parameter	Clientless VPN	ICA	Description
Session for clientless VPN / AuthManager for ICA	-	loginFormTimeout	NetScaler Gateway	-	Defines the time in minutes for the logon page timeout
Plug-in assistant	-	enabled	StoreFront	StoreFront	Enable or disable the plug-in assistant
Plug-in assistant	-	upgradeAtLogin	StoreFront	StoreFront	Prompts for upgrade of the plug-in at login
Plug-in assistant	-	showAfterLogin	NetScaler Gateway	StoreFront	Displays the plug-in prompt after login
Plug-in assistant	-	showOnlyIfRequiredByApps	NetScaler Gateway	StoreFront	Displays the plug-in prompt after login, if required by the apps
Plug-in assistant	macOS/win32	path	NetScaler Gateway	StoreFront	Defines the download path for the plug-ins
Plug-in assistant	protocolHandler	enabled	NetScaler Gateway	StoreFront	Toggle the protocol handler page before launching the plug-in
Plug-in assistant	protocolHandler	platforms	NetScaler Gateway	StoreFront	Identifies the supported platform for the plug-in
Plug-in assistant	-	skipDoubleHopCheckWhenDisabled	NetScaler Gateway	StoreFront	Toggle the double hop NetScaler Gateway config check for ICA passthrough
User interface	-	frameOptions	NA	NA	-
User interface		autoLaunchDesktop	StoreFront	StoreFront	Enable or disable the desktop launch
User interface	workspaceControl	enabled	StoreFront	StoreFront	Enable or disable the workspace control
User interface	workspaceControl	autoReconnectAtLogon	StoreFront	StoreFront	Toggle to auto-reconnect the previous session if available
User interface	workspaceControl	logoffAction	StoreFront	StoreFront	Defines the logoff behavior of Citrix Workspace
User interface	workspaceControl	showReconnectButton	StoreFront	StoreFront	Display or hide the Reconnect Button
User interface	workspaceControl	showDisconnectButton	StoreFront	StoreFront	Display or hide the Disconnect Button
User interface	workspaceControl	showDesktopsView	StoreFront	StoreFront	Display or hide the Desktops view
User interface	workspaceControl	showAppsView	StoreFront	StoreFront	Display or hide the Apps view
User interface	workspaceControl	defaultView	StoreFront	StoreFront	Select either the Desktop view or the App view
User interface	receiverConfiguration	enabled	StoreFront	StoreFront	Toggle the receiver configuration
User interface	receiverConfiguration	showOnlyIfRequiredByApps	NetScaler Gateway	NetScaler Gateway	Display the receiver prompt if required by the apps
User interface	receiverConfiguration	downloadURL	StoreFront	StoreFront	Download the URL for the receiver
User interface	appShortcuts	enabled	StoreFront	StoreFront	Enable or disable the app shortcut tab
User interface	appShortcuts	allowSessionReconnect	StoreFront	StoreFront	Allow session reconnect

To reflect the modified StoreFront configuration in RfWebUI for clientless VPN and ICA, manually update the corresponding parameter in the NetScaler Gateway configuration file. For example, if pluginAssistant.html5.enabled is set to Off in the StoreFront configuration, update the corresponding parameter in the NetScaler Gateway configuration file.

Customize the RfWebUI parameters in the NetScaler Gateway configuration file to match the StoreFront configuration using the following steps:

Open /var/netscaler/logon/themes/<customtheme>/plugins.xml.

Note:

If the custom theme was created on an older version, the “plugins.xml” file in the custom theme folder might be empty. Run the following command to populate “plugins.xml” with the required content.

cp /var/netscaler/logon/LogonPoint/homeconfig.xml /var/netscaler/logon/themes/<customtheme>/plugins.xml

Do not modify /var/netscaler/logon/LogonPoint/homeconfig.xml.
Edit only the required parameters and flush the NetScaler cache using the following command:

flush cache contentgroup loginstaticobjects

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group 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 Cloud Software Group 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 Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

RfWebUI configuration parameters

September 23, 2024

Contributed by:

C C

September 23, 2024

Contributed by:

C C

RfWebUI configuration parameters

In this article