How To Customize The Window Title Of Native Citrix Receiver Authentication Dialogs
Article ID: CTX205896
Updated On:
Description
This article is intended for Citrix administrators and technical teams only.
Non-admin users must contact their company’s Help Desk/IT support team and can refer to CTX297149 for more information.
All native Citrix Receiver authentication dialogs have title “Citrix Receiver” thus:
This article describes configuration changes to StoreFront Services and/or NetScaler Gateway to provide a custom window title such as this:
Note that the custom title does not apply to the following:
-
Smart card authentication dialogs;
-
Authentication dialogs generated by the NetScaler Gateway plug-in.
Additionally, the customization detailed here will not dynamically localize the window title in accordance with the client’s “Accept-Language” HTTP header.
Instructions
The customization is performed on the Internet Information Services (IIS) instance hosting your StoreFront Services. If your deployment also contains a NetScaler Gateway, that should be customized too.
In both cases, the customization adds an HTTP response header similar to this:
X-Citrix-AM-Title: Please%20Log%20On
In this case, the header value is Please%20Log%20On, which will cause Receiver to display the window title “Please Log On”. More generally, the string value supplied must be URL-encoded (also known as “percent-encoded”). Search for “url encode” to find online tools you can use to URL-encode your custom window title.
StoreFront customization
Open Internet Information Services (IIS) Manager on the computer where StoreFront is installed. Select the StoreFront authentication service web app, then double click the “HTTP Response Headers” feature to open it:
Select “Add…”, then fill in the dialog with the header name and your URL encoded custom title string, then click OK:
NetScaler Gateway customization: method 1
If you have the appropriate NetScaler Gateway licensing, you can configure the custom window title by adding an X-Citrix-AM-Title header to the Gateway’s HTTP responses.
The advantage of this approach is that the custom window title can be varied between the virtual servers of your NetScaler.
You can configure the HTTP header using the NetScaler’s administration UI, or by using the command line. The example below shows how to use the command line to configure a virtual server with a custom window title “Please Log On”. Start by making an SSH connection to the NetScaler IP Address and logging on with the administrator’s username and password. Then enter the following commands:
- Add a rewrite action named insertWindowTitleHeader. The two sets of quotes in the command-line below are important – they configure a literal string for the header value.
- add rewrite action insertWindowTitleHeader insert_http_header X-Citrix-AM-Title '"Please%20Log%20On"'
- Link the rewrite action to a policy named insertWindowTitleHeaderPolicy thus:
- add rewrite policy insertWindowTitleHeaderPolicy true insertWindowTitleHeader
- Bind the policy to a virtual server (the priority level you choose isn’t important):
- bind vpn vserver <your vserver name> -policy insertWindowTitleHeaderPolicy -type RESPONSE -priority 50
NetScaler Gateway customization: method 2
If you do not have the NetScaler Gateway licencing for method 1, you can instead use this method. It works by making a customization to the /vpn/index.html page of your NetScaler. Note that all the virtual servers on your NetScaler Gateway will be affected by this change, therefore they will all be configured with the same custom window title.
To configure a custom window title “Please Log On” (for example), insert the following HTTP meta tag in the HTML HEAD section of the page (bold item). Then follow the instructions contained in the article for persisting your change.
<HTML><HEAD><TITLE>NetScaler Gateway</TITLE>
<link rel="SHORTCUT ICON" href="/vpn/images/AccessGateway.ico" type="image/vnd.microsoft.icon">
<LINK href="/vpn/images/caxtonstyle.css" type=text/css rel=STYLESHEET>
….
Important note: The META tag must have the exact capitalization and spacing as given above (excluding the custom title string).
Issue/Introduction
