Running in Citrix and Terminal Services Environments

General information

  1. On Citrix thin clients and Windows Terminal Services hosts, the {Client} is deployed on the master image or golden image. {Client} creates print queues on the host.

    1. By default, without the ClientSideAcl feature flag, print queues are shared across all sessions on the virtual session host. In Citrix environments, all users must have permission to view all printers in Access Control, for example through Authenticated Users, Domain Users or its localized equivalent (such as Domänen-Benutzer). Otherwise, printers in Citrix sessions may behave unpredictably - they may appear or disappear unexpectedly, or stop working.

    2. With the optional ClientSideAcl feature flag enabled, the client modifies print queue permissions in Windows making them them visible only to the users with the appropriate permissions for the queue in {ProductName}. In other words, each user can see only their own printers. Contact your sales representative to have this feature enabled for your tenant.

  2. For Citrix thick (fat) clients, there are typically two possible approaches, depending on the customer’s best practices and environment requirements.

    1. Option 1 – Citrix maps the user’s local printers into the Citrix session through client printer redirection. In this case, the {Client} is not deployed on the VDI and is installed only on the workstation, following the standard documentation for Windows workstations.

    2. Option 2 – If Citrix client printer redirection is not used, deploy the {Client} on the master image or golden image.

  3. Remote desktop session limitations:

    • {Client} created printer(s) are visible also to users with local administrative rights.

    • {Client} does not delete printer(s) at logout.

Installing {Client} on master image and offline provisioning support

In many deployment scenarios, multiple Citrix instances are provisioned using a single master image with the {Client} preinstalled on it.

A. When installing {Client} on a master image for cloud storage mode with AUTHTYPE=6 (OAuth2 login), no special steps are required.

  • API keys and endpoints are not used in this scenario.

B. When installing {Client} on a master image for local storage mode, hybrid storage mode, or with /SECURESESSIONLOGIN=true, use /OFFLINE=true.

  • In these cases, the client requires endpoint registration. With /OFFLINE=true, it is installed with an empty client ID (UUID), and a unique ID is generated when it first starts on a provisioned node. Using /OFFLINE=false may result in a non-unique endpoint identity and cause various issues.

  • If servers are re-imaged automatically on a regular basis, it is recommended to use a dedicated API key for {Client} deployment and enable the following options in the API key settings:

    • Automatic endpoint trust — ensures that re-imaged instances are registered automatically without manual administrator approval.

    • Automatic endpoint deletion — removes expired endpoints after the specified number of hours. For example, if Citrix servers are re-imaged every week, the administrator can set this value to 168 hours, or slightly more, so that obsolete endpoints are removed automatically.

For both cases A. and B. described above:

  • To avoid repeated authentication requests in {Client} when users switch between Citrix, RDS, or other virtual session hosts, configure user profile synchronization in the underlying virtual session environment across all session hosts, including C:\Users\<username>\AppData\Roaming.

  • We recommend keeping Enable Auto-update in virtual environments turned off in virtual environments and updating {Client} when deploying a new master image. In Citrix, RDS, and other remote desktop sessions, updates are typically managed centrally through policies and standardized system images. Auto-updates may increase bandwidth usage and cause temporary printing issues while they are running. When planning master image maintenance, please take the SLA-supported version range of local components into account.