Session watermark policy settings
The session watermark section includes policy settings to configure this feature. Enabling this feature causes a significant rise in the network bandwidth and CPU usage by the VDA machine. We recommend that you configure the session watermark for selected VDA machines based on your available hardware resources.
Important
Enable session watermark for the other watermark policy settings to be effective. To achieve a better user experience, don’t enable more than two watermark text items.
Enable session watermark
When you enable this setting, the session display has an opaque textual watermark displaying session-specific information. The other watermark settings depend on this one being enabled.
By default, the session watermark is disabled.
Include client IP address
When you enable this setting, the session displays the current client IP address as a watermark.
By default, Include client IP address is disabled.
Include connection time
When you enable this setting, the session watermark displays a connect time. The format is yyyy/mm/dd hh:mm. The time displayed is based on the system clock and time zone.
By default, Include connection time is disabled.
Include logon user name
When you enable this setting, the session displays the current logon user name as a watermark. The display format is USERNAME@DOMAINNAME. We recommend that the user name is a maximum of 20 characters. When a user name is more than 20 characters, excessively small character fonts or truncation might occur and lessen the watermark effectiveness.
By default, Include logon user name is enabled.
Include VDA host name
When you enable this setting, the session displays the VDA host name of the current ICA session as a watermark.
By default, Include VDA host name is enabled.
Include VDA IP address
When you enable this setting, the session displays the VDA IP address of the current ICA session as a watermark.
By default, the VDA IP address is disabled.
Session watermark style
This setting controls whether you display a single watermark text label or multiple labels. Choose Multiple or Single from the Value drop-down menu.
Multiple displays five watermark labels in the session. One in the center and four in the corners.
Single displays a single watermark label in the center of the session.
By default, the Session watermark style is Multiple.
Watermark custom text
This setting lets you apply custom text (for example, the corporate name) to display in the session watermark. When you configure a non-empty string, it displays the text in a new line appending other information enabled in the watermark. The watermark custom text is limited to 25 Unicode characters. If you configure a longer string, it is truncated to 25 characters.
There is no default text.
Starting with Citrix Virtual Apps and Desktops 7 2206, you can add more customization using custom tags in the text. As a result, the maximum number of characters in the custom text is increased to 1024.
The available tags for watermark settings are described in the following table:
| Tag | Description | Example |
|---|---|---|
<font=value> |
Allows you to change the font of watermark text. The value is the name of a font available on the VDA. | <font=Courier New> |
<fontzoom=value> |
Allows you to set the percentage of the font zoom factor. The value is 200 for 200% zoom on watermark text. | <fontzoom=200> |
<position=value> |
Allows you to change the position of the watermark text. The values are center, topleft, topright, bottomleft, and bottomright. This tag is only applicable with single style. |
<position=topright> |
<rotation=value> |
Allows you to rotate watermark text. The value is specified in degree and the range is from -360 and 360. | <rotation=45> |
<style=value> |
Allows you to change the display style. This tag overrides the Session watermark style policy. | <style=single> |
The following watermark styles are available:
- Single style - A single watermark text label appears at the center of the session. You can use the position tag to change the location.
- xstyle or multiple - Five watermark labels appear in the session - one in the center and one in each corner.
- Tile - Multiple labels appear in the session. Watermark text is placed equally across the entire screen.
The available tags for changing watermark text are described in the following table:
| Tag | Description |
|---|---|
<clientip> |
The IP address of the endpoint. |
<date> |
The date the session was established. |
<domain> |
The domain name of the logged-in user account. |
<hostname> |
The machine name of the VDA. |
<newline> |
Creates an extra line. |
<serverip> |
The IP address of the VDA. |
<time> |
The time the session was established. |
<username> |
The name of the user. |
Note:
- The Watermark custom text policy takes effect only when the Enable session watermark policy is enabled. Its default value is Disabled.
- If you use the tags for changing watermark text, all other session watermark policies, except Enable session watermark, are ignored. If you use the tags for watermark text settings, you can use all other watermark policies.
Watermark transparency
You can specify watermark opacity from 0 through 100. The larger the value specified, the more opaque the watermark.
By default, the value is 17.