The Evolution of Citrix Workspace Environment Management Service

Citrix WEM Service environment is consistently updating and bringing enhanced capability to the table. This post aims to track the changes and releases as they occur, and provide a single point of reference

I will do my best to maintain this list as and when features come out, as well as some commentary around their value where I can.

- - - - - October 2022

Feature: Additional trigger types available

Detail: The following built-in trigger types are now available when you create triggers:

  • Machine shutdown. Activates the trigger when machines shut down
  • Machine startup. Activates the trigger when machines start up

You can create triggers of these types and associate tasks with them. When activated, the triggers start those tasks in the user environment. The two additional trigger types give you more flexibility to control when to run your scripted tasks

Minimum agent version required: 2210.1.0.1

Feature: Support for using task results as triggers (preview)

Detail: The following trigger types are now available when you create triggers

  • Cloud Health Check result. Activates the trigger when Cloud Health Check returns specified health statuses
  • Profile Management health check result. Activates the trigger when Profile Management health check returns specified health statuses
  • Custom scripted task result. Activates the trigger when scripted tasks return specified results

You can create triggers of these types and associate tasks with them. When activated, the triggers start those tasks in the user environment. These trigger types let you automatically manage your user environments based on task execution results.

To enable this feature, go to Home, click the preview features icon in the upper-right corner, and enable Use task results as triggers.

Minimum agent version required: 2210.1.0.1

Feature: Profile Management

Detail: Workspace Environment Management now supports all supported versions of Profile Management through 2209. The following feature is now available in both the legacy console and the web console.

  • File deduplication. If enabled, Profile Management removes duplicate files from the user store and stores one copy of them in a central location. Doing so reduces the load on the user store by avoiding file duplication, thus reducing your storage cost.
    • In the web console, the feature is available under each configuration set in Profiles > Profile Management Settings > File deduplication
    • In the legacy console, the feature is available in Policies and Profiles > Citrix Profile Management Settings > File Deduplication

Minimum agent version required: 2210.1.0.1

Feature: View the registration status of agents

Detail: In the web console, a tab, Registrations, is now available in Monitoring > Administration > Agents. The tab lets you view the registration status of agents in your WEM deployment. With the information, you can troubleshoot agent registration issues.

Feature: Support for cloning assignment targets

Detail: You can now clone assignment targets (users and groups) from one configuration set to another, without the need to add them from scratch

- - - - - September 2022

Feature: Install and upgrade: Workspace Environment Management agent

Detail: The Workspace Environment Management agent is no longer included as an additional component in the VDA installation.

- - - - - August 2022

Feature: Use Windows events as triggers

Detail: A new trigger type, Windows event, is now available when you create triggers. It lets you create a Windows event based trigger. You can then associate tasks with it. When the Windows events meet the defined criteria, the trigger is activated and starts the associated tasks. This trigger type lets you automatically manage your user environments based on Windows events

Minimum agent version required: 2208.1.0.1

Feature: Use file shares for file downloads on the agent side

Detail: Previously, file downloads on the agent side always occurred through Citrix Cloud. You can now let file downloads on the agent side occur through file shares. Doing so reduces network resources needed for other critical operations. This feature reduces traffic on networks and reduces the time to download files to agent machines.

Minimum agent version required: 2208.1.0.1

Feature: Set timeouts for scripted tasks

Detail: An option, Set a timeout value, is now available when you configure a scripted task. The option lets you specify the time (in minutes) after which the task is forced to end. If you do not specify a timeout, the task might keep running, thus preventing other tasks from running

Minimum agent version required: 2207.2.0.1

Feature: Invite users to enroll agents

Detail: A new node, Enrollment, is now available in the web console. The node contains two pages:

  • Enrolled Agents. Lists all enrolled agents. You can manage them as needed.
  • Invitation. Lets you send enrollment invitations to users. Each invitation includes an invitation code and the steps needed to complete the enrollment.

Minimum agent version required: 2207.2.0.1

Feature: Contextualize scripted tasks

Detail: An option, Filter, is now available in General when you configure a scripted task. The option lets you use a filter to contextualize the task. As a result, the WEM agent runs the task only when all conditions in the selected filter are met

Minimum agent version required: 2207.2.0.1

- - - - - July 2022

Feature: Support for performing administrative tasks for non-domain-joined and enrolled agents

Detail: You can now perform administrative tasks (such as refreshing the cache, resetting settings, and retrieving agent information) for non-domain-joined and enrolled agents through the administration console, just like you do for other agents. Technically, this feature is a different implementation. The target agents are not immediately notified of performing those tasks. The notifications are sent when the target agents or other agents on the same subnet connect to Citrix Cloud to refresh settings. So, there might be a delay until the tasks run on the agent side. The more agents you have on the same subnet, the shorter the delay.

This feature is available in both the legacy console and the web console.

  • In the web console, go to Monitoring > Administration > Agents
  • In the legacy console, go to Administration > Agents

Minimum agent version required: 2207.1.0.1

Feature: Configure Windows GPOs by using Group Policy Administrative Templates

Detail: In the web console, a tab, Template-based, is now available in Actions > Group Policy Settings under each configuration set. The tab lets you configure Windows GPOs by using Group Policy Administrative Templates. You can configure GPOs at a machine and user level. After that, you deploy them by assigning them to your users, just like you do for registry-based GPOs.

Minimum agent version required: 2207.1.0.1

Feature: New features available in scripted task settings

Detail: The following new features are now available when you configure a scripted task:

  • File path. A parameter type that lets you pass a file path as a parameter to the System.IO.FileInfo class.
  • Collect output even if runtime errors occur. An option that controls whether to collect output file content and console output even if errors occur while running the task

Minimum agent version required: 2207.1.0.1

Feature: Deploy GPOs through the web console

Detail: In the web console, you can now manage Group Policy settings. The management takes the form of configuring Windows Group Policy Objects (GPOs). After you add or import your settings, you deploy them by assigning them to your users

Minimum agent version required: 2206.2.0.1

Feature: Profile Management

Detail: Workspace Environment Management now supports all versions of Profile Management through 2206. The following new options are now available in both the legacy console and the web console.

  • Enable profile streaming for pending area. If enabled, files in the pending area are fetched to the local profile only when they are requested. This ensures optimum logon experience in concurrent session scenarios.
    • In the web console, the option is available under each configuration set in Profiles > Profile Management Settings > Streamed user profiles
    • In the legacy console, the option is available in Policies and Profiles > Citrix Profile Management Settings > Streamed user profiles
  • Enable concurrent session support. Provides native Outlook search experience in concurrent sessions. If enabled, each concurrent session uses a separate Outlook OST file. You can specify the maximum number of VHDX disks for storing Outlook OST files.
  • Enable asynchronous processing for user Group Policy on logon. If enabled, Profile Management roams with users a registry value that Windows uses to determine the processing mode for the next user logon — synchronous or asynchronous processing mode. This ensures that the actual processing mode is applied each time users log on.
  • Enable OneDrive container. If enabled, Profile Management roams OneDrive folders with users by storing the folders on a VHDX disk. The disk is attached during logons and detached during logoffs.
    • In the web console, the three options are available under each configuration set in Profiles > Profile Management Settings > Advanced settings
    • In the legacy console, the three options are available in Policies and Profiles > Citrix Profile Management Settings > Advanced settings

Minimum agent version required: 2206.2.0.1

Feature: Application launcher

Detail: An application launcher tool, AppLauncherUtil.exe, is now available in the agent installation folder. The tool aggregates all applications you assigned to your users through the administration console. Using the tool, users can launch all assigned applications in one place

Minimum agent version required: 2206.2.0.1

- - - - - May 2022

Feature: Enroll agents without configuring Citrix Cloud Connectors

Detail: Previously, you had to configure Cloud Connectors for WEM agents to manage them. You can configure Cloud Connectors in two ways:

Starting with this release, you can enroll WEM agents without configuring Citrix Cloud Connectors. The enrollment applies to both domain-joined and non-domain-joined machines.

Minimum agent version required: 2205.1.0.1

Feature: Scripted task updates

Detail: The following features are now available with scripted tasks:

  • Support for bundling multiple files into a single zip file to upload. When adding a scripted task, you can now bundle multiple files into a single zip file to upload. This feature is useful when you want to run a scripted task that comprises multiple script files. After uploading the zip file, you specify an entry point, indicating which file to run at the beginning of the task
  • Include only regular expression matches in scripted task reports. A new option, Include only regular expression matches in reports, is now available in Output when you configure a scripted task. The option controls whether to include the entire output content in reports or only content that matches the regular expression. Enabling the option reduces the amount of data transmitted to Citrix Cloud
  • Ability to use tags to identify scripted tasks. You can now use tags to identify your scripted tasks. Also, the tags act as filters, letting you rearrange your view of tasks depending on criteria that are important to you
  • More scheduling options available with scripted tasks. You now have additional options to control when scripted tasks run. In addition to the hourly recurring pattern, you can now set daily, weekly, and monthly recurrence patterns. You can also specify the date and time at which you want scripted tasks to run, giving you more precise control. For agents earlier than 2205.1.0.1, be aware of the considerations when using the feature

Minimum agent version required: 2205.1.0.1

Feature: Enhancements to Profile Management health check

Detail: Enhancements to the Profile Management health check feature:

  • In the More menu of Monitoring > Administration > Agents:
    • Renamed Refresh Profile Management configuration check to Run Profile Management health check to make it easy to understand
    • Added an option, View Profile Management health check report. The option provides quick access to Profile Management health reports related to the target agent machines.
  • In Advanced Settings > Monitoring Preferences under a configuration set
    • Added a section, Profile Management health check. The section lets you specify which aspects to cover in Profile Management health check reports

Minimum agent version required: 2205.1.0.1

Feature: Ability to import Group Policy settings from registry files

Detail: An option, Import Group Policy settings from Registry Files, is now available in Legacy Console > Actions > Group Policy Settings. With the option, you can convert registry values that you export using the Windows Registry Editor into GPOs for management and assignment. If you are familiar with the Import registry files option available with Registry Entries, this feature:

  • Lets you import registry values under both HKEY_LOCAL_MACHINE and HKEY_CURRENT_USER
  • Lets you import registry values of the REG_BINARY and REG_MULTI_SZ types
  • Supports converting deletion operations associated with registry keys and values that you define in .reg files

Feature: Filters now available in the web console

Detail: In the web console, a new page, Filters, is now available within Assignments under each configuration set. Using that page, you can add filters for controlling when to assign actions to your users.

- - - - - April 2022

Feature: Updates to the More menu in Monitoring > Administration

Detail: This release organizes existing options in the More menu in Web Console > Monitoring > Administration into the following groups: Agent, Profile, and Power management. The workflows for using the options remain the same.

Additional updates to the More menu include:

  • Renaming Wake up agents to Wake and moving it to the Power management group
  • Adding the following four power management options:
    • Shut down. Lets you shut down agents
    • Restart. Lets you restart agents
    • Sleep. Lets you put agents into sleep mode
    • Hibernate. Lets you put agents into hibernate mode

Minimum agent version required: 2204.1.0.1

Feature: Support for cloning scripted tasks

Detail: You can now clone an existing scripted task to use as a template for a new one, without the need to create a similar task from scratch

Feature: Manage Azure Virtual Desktop using Citrix Optimization Pack

Detail: The Citrix Optimization Pack for Azure Virtual Desktop is a new Citrix offering for optimizing Azure Virtual Desktop workloads

- - - - - March 2022

Feature: Profile Management now available in the web console (preview)

Detail: In the web console, you can now use Citrix Profile Management to manage user profiles across sessions and desktops (You need to turn this feature on to use it)

Feature: Ability to pass parameters to scripted tasks

Detail: Using the web console, you can now provide inputs as parameter variables in a scripted task at runtime. Doing that lets you control how the scripted task behaves without changing the underlying code.

WEM provides you flexibility in what parameters you want to use — parameters that accept only objects of a specific type (such as, string, integer, switch) and named parameters (using the name of the parameter)

Minimum agent version required: 2203.2.0.1

Feature: Option to upgrade agents on demand

Detail: You can now upgrade your WEM agents from the console on demand. The option is available in both the legacy console and the web console. To use the feature:

  • In the legacy console, go to Administration > Agents, right-click an agent, and then select Upgrade agent to latest version
  • In the web console, go to Monitoring > Administration > Agents, select one or more agents, click More, and then select Upgrade agent to latest version

Minimum agent version required: 2203.2.0.1

Feature: Updates for the web console

Detail: This release introduces the following pages to the web console:

  • Home: Provides an overview of your WEM deployment along with information necessary for you to get to know and get started with WEM quickly. The interface comprises the following four parts:
    • Overview: Provides an overview of the WEM deployments
    • Quick access: Provides quick access to a subset of the key features that WEM offers
    • Highlights: Shows the key features that WEM offers
    • Preview features: Shows features that are currently in preview. You can enable or disable preview features yourself
  • Directory Objects Preview! Lets you add machines, groups, OUs, and more, that you want WEM to manage. You can now do the following:
    • Add machines, groups, Organizational Units (OUs), and more, that you want WEM to manage
    • Apply settings to agents that are not bound to any configuration set. You can control how unbound agents behave
  • Assignment Target Preview! Lets you add users and groups (targets) so that you can assign actions and security rules to them

Feature: Support for migrating your service instance yourself

Detail: If your WEM service instance does not reside in your current region, you can now migrate the instance to the current region yourself. Sign in to Citrix Cloud, go to Workspace Environment Management > Utilities and select Start migration.

It can take up to two days to receive the notification. Citrix encourages migration to the current region to improve performance. This is signficant for those that did not have a local WEM region initially (APJ for example)

- - - - - January 2022

Feature: Web console now available as a preview

Detail: A new, web-based Workspace Environment Management (WEM) console is now available. Citrix are in the process of migrating the full set of functionalities from the legacy console to the web console. The web console generally responds faster than the legacy console. You can switch between the web console and the legacy console from within the Manage tab to perform your configuration or deployment management tasks. Click the down arrow next to Manage and select an option:

  • Legacy Console takes you to the legacy console
  • Web Console takes you to the new, web-based console

The following features are available only in the web console:

Feature: Apply settings to unbound agents

Detail: You can now apply settings to agents that are not bound to any configuration set. The feature lets you control how unbound agents behave.

Minimum agent version required: 2201.2.0.1

Feature: Support for managing non-domain-joined machines in Citrix Virtual Apps and Desktops Standard for Azure deployments

Detail: You can now use WEM service to manage non-domain-joined machines in Citrix Virtual Apps and Desktops Standard for Azure deployments. This support enables you to assign policies and settings to non-domain-joined machines as you do with domain-joined machines.

Minimum agent version required: 2201.2.0.1

Feature: Support for enumerating Azure AD users and groups

Detail: WEM service now supports enumerating Azure Active Directory (AD) users and groups. After connecting your Citrix Cloud account to your Azure AD, you can add Azure AD users and groups that you want WEM to manage

Feature: External task enhancements

Detail: This release includes enhancements to the external task feature. The feature now provides you with three additional options to control when to run external tasks:

  • Disconnect controls whether to run the external task when a user disconnects from a machine where the agent is running
  • Lock controls whether to run the external task when a user locks a machine where the agent is running
  • Unlock controls whether to run the external task when a user unlocks a machine where the agent is running

Minimum agent version required: 2201.1.0.1

Feature: Profile Management enhancements

Detail: Workspace Environment Management now supports all versions of Profile Management through 2112. The following new options are now available in the Administration Console > Policies and Profiles > Citrix Profile Management Settings interface:

  • Enable File Exclusions for Profile Container. Available on the Profile Container Settings tab, the option controls whether to exclude the listed files from the profile container
  • Enable File Inclusions for Profile Container. Available on the Profile Container Settings tab, the option controls whether to keep the listed files in the profile container when their parent folders are excluded
  • Customize storage path for VHDX files. Available on the Advanced Settings tab, the option controls whether to store VHDX files of different policies in different folders under the specified storage path

Minimum agent version required: 2110.2.0.1

Feature: Administrative access to WEM service based on Azure Active Directory group membership

Detail: You can now manage administrative access to WEM service based on Azure AD group membership. Users (administrators) within the Azure AD group can directly onboard to Citrix Cloud and access WEM service – you do not need to manually add them in Citrix Cloud. A general workflow to use the feature is as follows:

Connect your Citrix Cloud account to your Azure AD -> Add the applicable group to Citrix Cloud from Azure AD -> Users can sign in to Citrix Cloud by using their Azure AD credentials

- - - - - November 2021

Feature: Message about instance migration

Detail: If you use a service in another region, a message now appears when you sign in to the administration console. The message reminds you to migrate your service instance to your current region

Feature: Export Statistics for Migration

Detail: Citrix added an option Export statistics to the migration tool. Use the option to control whether to export agent and user statistics when performing migrations

- - - - - October 2021

Feature: Allow users to self-elevate certain applications

Detail: This release introduces self-elevation for the privilege elevation feature. With self-elevation, you can automate privilege elevation for certain users without the need to provide the exact executables beforehand. Those users can request self-elevation for any applicable file simply by right-clicking the file and then selecting Run with administrator privileges in the context menu. After that, a prompt appears, requesting that they provide a reason for the elevation. This reason is for captured for auditing purposes. If the criteria is met, the elevation is applied, and the files run successfully with administrator privileges.

In addition, self-elevation provides flexibility to create allow lists for the files you permit users to self-elevate or block lists for files you want to prevent users from self-elevating.

Minimum agent version required: 2109.2.0.1

Feature: Bind a Citrix Virtual Apps and Desktops service catalog to a configuration set

Detail: You can now use the CVAD Service console to bind a catalog to a WEM configuration set. This is a quick option to automatically add a catalog to WEM configuration sets

Whilst a great feature, I have seen instances of inconsistencies in configuration set bindings - tried and proven AD objects in WEM fixed the issue

Feature: Workspace Environment Management now available in Citrix Cloud Japan

Detail: Workspace Environment Management service is now available in Citrix Cloud Japan, a cloud that is isolated and separate from Citrix Cloud. Japanese customers can use the service in a dedicated Citrix-managed environment.

The service requires Citrix Cloud Connector version 6.29.0.58841

Feature: Support for Windows 11

Detail: Minimum agent version required: 2109.2.0.1

- - - - - September 2021

Feature: More granular control over applying privilege elevation to child processes

Detail: Previously, when you used the Apply to Child Processes setting in a rule, you applied the rule to all child processes that the executable started. This release provides you with three additional options, giving you more granular control over applying privilege elevation to child processes

  • Apply only to executables in the same folder
  • Apply only to signed executables
  • Apply only to executables of the same publisher

Minimum agent version required: 2109.2.0.1

Feature: Support for Windows Server 2022

Detail: Minimum agent version required: 2109.2.0.1

- - - - - August 2021

Feature: Enablement of Asia Pacific South based instances

Detail: Citrix now offers Asia Pacific South based instances

- - - - - July 2021

Feature: Notifications about new agent versions

Detail: You can now opt in to Agent Version Upgrade notifications

- - - - - June 2021

Feature: Parameter matching for privilege elevation

Detail: This release introduces parameter matching for the privilege elevation feature. Parameter matching gives you more granular control by letting you restrict privilege elevation to executables that match the specified parameter. A parameter works as a match criterion. To further expand the criterion, you can use regular expressions.

Minimum agent version required: 2106.2.0.1

Feature: Privilege elevation support for Windows installer files

Detail: Starting with this release, you can apply privilege elevation to .msi and .msp Windows installer files. Using the feature, you elevate the privileges of non-administrative users to an administrator level necessary for some Windows installer files. As a result, those users can run those files as if they are members of the administrators group

Minimum agent version required: 2105.1.0.1

Feature: Profile Management Enhancements

Detail: Workspace Environment Management now supports all versions of Profile Management through 2106. The Administration Console > Policies and Profiles > Citrix Profile Management Settings user interface has changed, adding:

  • Replicate user stores
  • Accelerate folder mirroring
  • User Store Credentials

Minimum agent version required: 2106.2.0.1

- - - - - May 2021

Feature: Configure user processes as triggers for external tasks

Detail: This release includes enhancements to the external task feature. The feature now provides you with two additional options to control when to run external tasks:

  • Run when processes start controls whether to run the external task when specified processes start
  • Run when processes end controls whether to run the external task when specified processes end

Using the two options, you can define external tasks to supply resources only when certain processes are running and to revoke those resources when the processes end. Using processes as triggers for external tasks lets you manage your user environments more precisely compared with processing external tasks on logon or logoff

Minimum agent version required: 2104.1.0.1

Feature: Enhancements to process hierarchy control

Detail: This release introduces enhancements to the process hierarchy control feature that improve overall performance and stability. The enhancements include the following changes:

  • The AppInfoViewer tool has been updated to include the following two options: Enable Process Hierarchy Control and Disable Process Hierarchy Control. For the process hierarchy control feature to work, you must first use the tool on each agent machine to enable the feature. Every time you use the tool to enable or disable the feature, a machine restart is required
  • In certain scenarios, you must restart your agent machine after upgrading or uninstalling the agent

Minimum agent version required: 2105.1.0.1

- - - - - April 2021

Feature: Process hierarchy control

Detail: This release introduces the process hierarchy control feature. The feature lets you control whether certain child processes can be started through their parent processes. You create a rule by defining parent processes and then designating an allow list or a block list for their child processes. You then assign the rule on a per user or per user group basis. The following rule types are available:

  • Path applies the rule to an executable according to the executable file path
  • Publisher applies the rule according to publisher information
  • Hash applies the rule to identical executables as specified

Minimum agent version required: 2103.2.0.1

Feature: Overwrite or merge application security rules

Detail: This release adds two settings, Overwrite and Merge, to the Administration Console > Security > Application Security tab. The settings let you determine how the agent processes application security rules.

  • Select Overwrite if you want to overwrite existing rules. When selected, the rules that are processed last overwrite rules that were processed earlier. We recommend that you apply this setting only to single-session machines
  • Select Merge if you want to merge rules with existing rules. When conflicts occur, the rules that are processed last overwrite rules that were processed earlier

- - - - - March 2021

Feature: Discover Citrix Cloud Connectors from the CVAD service

Detail: This release introduces a policy setting titled Discover Citrix Cloud Connector from CVAD service. If you have not yet configured Cloud Connectors for the agent, use the setting to control whether the agent discovers Cloud Connector information from the relevant Citrix Virtual Apps and Desktops (CVAD) service deployment. The agent then connects to the corresponding Cloud Connector machines automatically

Feature: Support for the Windows 10 2009 template

Detail: Citrix added support for the Windows 10 2009 (also known as 20H2) template introduced in Citrix optimizer. You can now use WEM service to perform template-based system optimizations for Windows 10 2009 machines. In addition, Citrix have updated all existing templates to reflect changes introduced in the latest standalone Citrix optimizer

Feature: Brand-new home page

Detail: This release replaces the home page of the WEM administration console with a quick-start page that provides information necessary for you to get started with the WEM service

Feature: Profile Management Enhancements

Detail: Workspace Environment Management service now supports all versions of Profile Management through 2103. The following new options are now available in the Administration Console > Policies and Profiles > Citrix Profile Management Settings interface:

  • Enable Local Cache for Profile Container
  • Enable multi-session write-back for profile containers
  • Enable Profile Streaming for Folders

- - - - - January 2021

Feature: Microsoft Sync Framework 2.1 deprecation

Detail: Microsoft Sync Framework 2.1 reached End of Life on January 12, 2021. WEM has removed the legacy sync service based on that framework and instead uses a new sync framework, Dotmim.Sync, an open-source sync framework

Feature: WEM agent integration with the Citrix Virtual Apps and Desktops product software

Detail: The WEM agent is integrated with the Citrix Virtual Apps and Desktops product software, letting you include the WEM agent when installing a Virtual Delivery Agent (VDA). This integration is reflected in the Citrix Virtual Apps and Desktops 2012 product software and later

Feature: Support for condition-based assignment of Group Policy settings

Detail: Starting with this release, you can make Group Policy settings conditional by using a filter to contextualize their assignments. A filter comprises a rule and multiple conditions. The WEM agent applies the assigned Group Policy settings only when all conditions in the rule are met in the user environment at runtime. Otherwise, the agent skips those settings when enforcing filters.

Feature: Privilege elevation

Detail: This release introduces the privilege elevation feature. The feature lets you elevate the privileges of non-administrative users to an administrator level necessary for some executables. As a result, those users can start those executables as if they are members of the administrators group.

You can configure how a rule behaves according to the type of the operating system. You can also configure whether a rule takes effect at a particular time or within a particular time range. You assign a rule on a per user or per user group basis.

Minimum agent version required: 2010.2.0.1