Table of Contents
A few days ago, Workspace Environment Management (WEM) Version 1912 was published. Below an introduction to WEM and a guide to upgrade to version 1912.
General Information
Workspace Environment Management is a Performance Management and UEM (User Environment Management) tool from Citrix. It is licensed to all customers with Virtual Apps/Virtual Desktop Advanced and Premium (formerly XenApp/XenDesktop Enterprise and Platinum) Versions, as well as an active customer success services.
New Feature in 1912
Following are the new features of the WEM 1912 version.
Replacing Microsoft SQL Server Compact with SQLite
In previous versions, if the WEM agent works offline, it uses Microsoft SQL Server Compact to synchronize with SQL Server. Microsoft SQL Server Compact 3.5 Service Pack 2 is the last version that supports this functionality. Versions 4.0 and later do not support synchronization with SQL Server. However, SQL Server Compact 3.5 Service Pack 2 reached End of Life (EOL) in 2018. Starting with this release, the agent relies on SQLite for offline mode to work.
REQUIREMENTS
If you do not want to use Microsoft SQL Server Compact 3.5 Service Pack 2, upgrade the infrastructure services, the Administration Console and the agent to the latest version.
Copying configuration sets
WEM supports now exporting and importing (copying) configuration sets using the Administration Console. You can export and import only one configuration set at a time.
To export configuration sets, use the Backup wizard, where the Configuration set option is available on the Select what to back up page.
To import configuration sets, use the Restore wizard, where the Configuration set option is available on the Select what to restore page.
Reset Actions Option
WEM supports resetting assigned actions (purging action-related registry entries in the user environment). The feature also provides the flexibility to reset assigned actions. You can reset all assigned actions by using the administration console or let users decide what to reset in their environment. The feature might be useful in scenarios where actions you assign to users or user groups do not take effect.
The following has changed in the Administration Console user interface:
The Advanced Settings > UI Agent Personalization > UI Agent Options tab introduces an “Allow Users to Reset Actions” option. Use that option to control whether to let current users specify what actions to reset in their environment.
Agent administrative templates
There are now two policies associated with the WEM agent cache synchronization:
- Cache synchronization port
- Cached data synchronization port
Starting with Version 1912 the WEM agent relies on Cached data synchronization port to keep the agent cache in sync with the WEM infrastructure service. If you have Workspace Environment Management 1909 or earlier deployed in your environment, you cannot use Cached data synchronization port. Instead, use Cache synchronization port.
Upgrade enhancement SQL Always On
This release simplifies the process of upgrading the WEM database. In earlier releases, to upgrade the database, you needed to remove the database from the availability group if the database was deployed in a SQL Server Always On availability group. Starting with this release, you can upgrade the database without removing it from the availability group.
WEM PowerShell SDK modules
This release includes enhancements to the PowerShell modules in the WEM SDK. You can now use the PowerShell SDK to:
- Create, update, query, and delete configuration sets and user-level and machine-level AD objects
- Export and import configuration sets or user-level or machine-level AD objects
Fixed Issues with WEM 1912
- When you use a configuration object with WEM PowerShell modules SDK cmdlets, all parameters must be specified. If they are not, the command fails with an InvalidOperation error.
- In Transformer (Kiosk) mode and with Log Off Screen Redirection enabled, WEM might fail to redirect the user to the logon page after logging off.
- The Administration Console might exit unexpectedly when you scroll down the agent list on the Administration Console > Agents > Statistics tab.
- The Use Cache Even When Online option on the Administration Console > Advanced Settings > Configuration > Agent Options tab might not work.
- Attempts to import registry files might fail with the following error message: Error “Import from Registry file” – Import Completed with Errors. The issue occurs when a registry file to be imported contains two or more values that have the same name.
If you still have a problem with the Synchronization State after the update, please go to the following link and follow the instructions of Igor van der Burgh regarding missing user permissions in the DBSync folder
Port Overview
| Source | Destination | Type | Port | Details |
|---|---|---|---|---|
| Infrastructure service | Agent host | TCP | 49752 | “Agent port”. Listening port on the agent host that receives instructions from the infrastructure service. |
| Administration console | Infrastructure service | TCP | 8284 | “Administration port”. Port on which the administration console connects to the infrastructure service. |
| Agent | Infrastructure service | TCP | 8286 | “Agent service port”. Port on which the agent connects to the infrastructure server. |
| Agent cache synchronization process | Infrastructure service | TCP | 8285 | “Cache synchronization port”. Applicable to Workspace Environment Management 1909 and earlier; replaced by Cached data synchronization port in Workspace Environment Management 1912 and later. Port on which the agent cache synchronization process connects to the infrastructure service to synchronize the agent cache with the infrastructure server. |
| Agent cache synchronization process | Infrastructure service | TCP | 8288 | “Cached data synchronization port”. Applicable to Workspace Environment Management 1912 and later; replaces Cache synchronization port of Workspace Environment Management 1909 and earlier. Port on which the agent cache synchronization process connects to the infrastructure service to synchronize the agent cache with the infrastructure server. |
| Infrastructure service | Citrix License Server | TCP | 27000 | “Citrix License Server port”. The port on which the Citrix License Server is listening and to which the infrastructure service then connects to validate licensing. |
| Infrastructure service | Citrix License Server | TCP | 7279 | The port used by the dedicated Citrix component (daemon) in the Citrix License Server to validate licensing. |
| Monitoring service | Infrastructure service | TCP | 8287 | “WEM monitoring port”. Listening port on the infrastructure server used by the monitoring service. (Not yet implemented.) |
Upgrade to Version 1912
The following in-place upgrade scenarios are supported:
| From | To | In-place Upgrade supported |
|---|---|---|
| 4.6 and earlier | 4.7 | Yes |
| 4.6 and earlier | 1808 or later | No ( an intermediate step to 4.6 is required) |
| 4.7 | 1808 or later | Yes |
- Check your license server for the correct Citrix version (Advanced or Premium) and a Customer Success Service that has not expired
- Download and extract new WEM package
Citrix Infrastructure Server
- On the WEM Broker, start the extracted Citrix Workspace Environment Management Infrastructure Services Setup.exe
- Click in the install dialog Next until the Setup Type.
- Select here Complete and finish the installation
Citrix WEM database
- Then run the Database Management Utility tool and start the Database Upgrade
- In the following windows, check the existing login data for the previously existing WEM SQL database to deposit and start the upgrade of the database
- Confirm the warning about the upgrade and wait until the following message of the tool appears
- After the successful upgrade of the database, the configuration must be checked using the WEM Infrastructure service configuration Utility.
- Check the Licensing and Database Settings and if necessary correct it
- Save Configuration and let broker service restart
- Now only the Administration Console and the Agent must be reinstalled on the existing machines (no uninstall of the old version is necessary)
Citrix WEM Agent
The following items should be followed before an update of the agent software is performed:
- Ensures that no more users are logged on to the target device
- The WEM Infrastructure Server version must be equal to or greater than the WEM Agent version
- Start the Citrix Workspace Environment Management Agent Setup.exe file on the target device
- Confirm the License Agreement with the checkbox and start with a click on Install
- Click on Next in the following window
- Note here the changed path (no more Norskale mention)
- Since version 1909 there is only one agent for OnPrem and Cloud, so choose your deployment type here
- Now define your infrastructure server and ports for OnPrem environments
- For Cloud environments the Cloud Connector must be saved here
- Then define the alternative Cache Location (PVS & MCS Deployments) & a delay for Published Apps via VUEMAppCmd
- Confirm the settings in this window with Install
- Confirm the warning so that the installation can start
- After installation, the new agent should appear in the Administration Console
