Workspace Environment Management 4.4

Workspace Environment Management 4.4
Aug 17, 20 17
Workspace Environment Management 4 .4 is the current release. For documentation about earlier releases, see the
following sections:
Workspace Environment Management 4.3 (PDF, 998 kB)
Workspace Environment Management 4.2 (PDF, 1016 kB)
Workspace Environment Management 4.1 (PDF, 25 kB)
For information about upgrading, see Upgrade a deployment.
To install the current release, see Install and configure.
Introducing Workspace Environment Management
Workspace Environment Management uses intelligent resource management and Profile Management technologies to
deliver the best possible performance, desktop logon, and application response times for XenApp and XenDesktop
deployments. It is a software-only, driver-free solution.
Resource management - To provide the best experience for users, Workspace Environment Management monitors and
analyzes user and application behavior in real time, then intelligently adjusts RAM, CPU, and I/O in the user workspace
environment.
Profile Management - To deliver the best possible logon performance, Workspace Environment Management replaces
commonly used Windows Group Policy Object objects, logon scripts, and preferences with an agent which is deployed on
each virtual machine or server. T he agent is multi-threaded and applies changes to user environments only when required,
ensuring users always have access to their desktop as soon as possible.
Technical overview
Workspace Environment Management (WEM) has the following architecture:
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.1
Inf rastructure services. T he infrastructure services are installed on a Windows server. T hey synchronize the various backend components (SQL Server, Active Directory) with the front-end components (administration console, agent).
Note
Infrastructure services cannot be installed on a domain controller. Kerberos authentication issues prevent the infrastructure service
from working in this scenario.
Administration console. T he Workspace Environment Management administration console is installed on a Windows
client or on a server operating system (OS). It connects to the infrastructure services. You use the administration console to
manage your Workspace Environment Management installation (to create and assign resources, manage policies, authorize
users, and so on).
Agent . T he Workspace Environment Management agent connects to the Workspace Environment Management
infrastructure services and is responsible for enforcing the settings you configure by using the administration console. T he
agent can either be deployed on VDAs or on physical Windows devices (for Transformer use cases). It can be installed on a
Windows client (to manage client environments) or on a Windows Server (to manage server environments, or to manage
published desktops and applications).
Note
T he agent cannot be installed on the infrastructure server. T he agent installer fails in this scenario.
T he T ransformer feature is not supported on server operating systems.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.2
SQL Server Database: Workspace Environment Management requires an SQL Server database to store its settings.
Microsof t Active Directory Server: Workspace Environment Management requires access to your Active Directory to
push settings to your users.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.3
What's new
Aug 17, 20 17
For information about upgrading, see Upgrade a deployment.
What's new in Workspace Environment Management 4.4
Workspace Environment Management 4.4 includes the following new features. For information about bug fixes, see Fixed
issues.
Data analytics
From this release, the Workspace Environment Management infrastructure service sends anonymous usage data to Google
Analytics. For more information, and for opt-out instructions, see Infrastructure services.
Profile Management
From this release, Workspace Environment Management supports Citrix Profile Management 7.15. T he following new
options are now available in the administration console:
Enable Logon Exclusion Check (options controlling file system exclusions)
Enable Prof ile Streaming Exclusion List - Directories (option controlling user profile streaming)
Database maintenance
In the Infrastructure Services Configuration utility, the Database Maintenance tab has a new option Agent registrations
retention period. T his allows agent registration logs to be deleted after a set time, which reduces the size of the
database. It also reduces lag in populating the Registrations tab in the administration console.
Documentation
At this release, Workspace Environment Management documentation is updated to reflect current product behavior. T he
documentation has also been remodeled as a single "versionless" documentation set describing the “current release.” T his
approach reduces duplication in the online documentation set, gives more focused search results, and is better suited to
agile release processes. Associated changes include:
A top level "current release" article contains links to previous documentation sets in PDF format only. (HT ML
documentation for previous releases is no longer provided.)
"What's new" summarizes the new functionality at the current release, and in previous releases.
A new "Reference" section gathers reference information in one location. Port information previously in the introductory
article is relocated to "Reference."
What's new in Workspace Environment Management 4.3
Workspace Environment Management 4.3 includes the following new features. For information about bug fixes, see Fixed
issues.
Site management
In previous releases, site settings were stored on the agent side and it was possible to change them from the agent GPO.
Workspace Environment Management 4.3 introduces a different approach to site management which improves product
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.4
security. Sites are now assigned to machines (or Security Groups or OUs) by the infrastructure service (broker) using a
new Machines page in the administration console. A new Registrations tab under Administration>Agents in the
administration console indicates machines which are bound incorrectly to multiple sites, so that you can take the
appropriate action to remove the duplicate binding.
From this release, Workspace Environment Management "sites" are referred to as "configuration sets" in the user interface
and documentation.
Agent localization improvements
T he session agent user interface is now localized for the following languages: German, Spanish, French, Italian, Japanese,
Korean, Dutch, Russian, Traditional and Simplified Chinese.
User interf ace improvements
Various text labels and messages in the installation wizards, administration console, and GPO templates have been
rationalised and made mutually consistent to improve the user experience. For example, fields used to enter the same
parameters in different installation wizards now use the same labels. Current and changed terminology is describe in a
new glossary.
Documentation
Workspace Environment Management 4.3 documentation is updated to reflect current product behaviour. Various minor
improvements have also been made, including the following improvements designed to assist users:
a number of installation field descriptions have been revised to better explain their purpose
the documentation uses new standardized terminology visible in the installation wizards, GPO templates, and in the
administration console. For example, the term "broker" is replaced by "infrastructure service".
a glossary has been added to explain the new terminology seen in the installation wizards, the administration console,
and the documentation. Changed terms are also indicated.
the technical overview diagram is updated
a new port information table has been added to summarize port usage
What's new in Workspace Environment Management 4.2
Workspace Environment Management 4.2 includes the following new features. For information about bug fixes, see Fixed
issues.
Profile Management
Workspace Environment Management 4.2 now supports all versions of Profile Management up to v5.6. New options are
now provided in the Citrix Profile Management Settings pages in the Administration Console.
Documentation
Workspace Environment Management 4.2 documentation is now provided in HT ML format in docs.citrix.com. Articles can
be downloaded as PDF as required. Advice on load balancing has been added to the section Install infrastructure services.
What's new in Workspace Environment Management 4.1
Workspace Environment Management 4.1 includes the following new features. For information about bug fixes, see Fixed
issues.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.5
Transf ormer module re-enabled. T he T ransformer module is available in the Administration Console. T ransformer
allows you to configure your physical machines to operate a locked-down thin client version of Windows.
Agent Host enhancements. Improvements to the Agent Host remove the communication between the WEM Broker
Service and Agent Host executable. All communication now occurs between the WEM Broker Service and Agent Host
Service, which then passes its instructions down to the Agent Host executable. T his includes local cache access.
Documentation on docs.citrix.com. Workspace Environment Management 4.1 documentation is now available from
docs.citrix.com. T hese PDFs are no longer included in the download. Filter conditions are now documented in the
Administration Guide.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.6
Fixed issues
Aug 17, 20 17
Fixed in Workspace Environment Management 4 .4
T he following issues have been fixed in the current release:
If you run the Workspace Environment Management administration console as a standard Windows user, and you
attempt to start the Modelling Wizard, the wizard does not start.
[#WEM-187]
When you attempt to add a user group, which is in a different AD domain to the infrastructure server, as a processed
group in the Citrix User Profile Management tab in the administration console, the exception
*IndexOutOfRangeException is raised, and the group is not processed.
[#WEM-210]
Links in "T his PC" in Windows 10 do not reflect folder redirection, and still point to local folders.
[#WEM-234]
T he Agent Host waits about 5 minutes before starting if Workspace Environment Management is installed on Windows
version 8, or Server 2012, and a language pack is installed.
[#WEM-244]
If you launch or refresh a UI session agent when it is not bound to a configuration set, keyboard and mouse locks which
are active during the agent refresh are not released.
[#WEM-321]
If you attempt to add an agent host machine to a configuration set when the agent host machine is in a different
domain to the infrastructure service, the machine is not added in the administration console Active Directory Objects
tab. T his happens regardless of the actual AD topology involved (parent/child domains, multi-forest setups, one- or twoway trust relationships, and so on).
[#WEM-326, #WEM-299]
Fixed in Workspace Environment Management 4 .3
When the Workspace Environment Management session agent is running in command line mode, User Statistics data is
not reported to the WEM infrastructure services.
[#WEM-41]
T he Workspace Environment Management session agent interface does not render correctly when a computer display is
extended to external displays connected via a dock. T his problem, which occurs when extending to multiple displays with
different screen resolution settings, results in a portion of the right-hand side of the display not rendering completely.
T his prevents users seeing the home button or being able to change other native Workspace Environment Management
settings.
[#WEM-90]
T he Workspace Environment Management session agent causes the mouse to stop working on virtual machines which
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.7
have the System Center Configuration Manager (SCCM) client installed with Power Management enabled.
[#WEM-115]
When you are using the T ransformer feature, the session agent generates an unhandled exception if Wi-Fi is turned off
using "ms-settings:network-wifi."
[#WEM-133]
T he Workspace Environment Management session agent causes the mouse to stop working on virtual machines after
an interruption to network access is restored.
[#WEM-159]
Fixed in Workspace Environment Management 4 .2
File Association actions cannot be processed by the Agent Host on Windows 8, 8.1, Server 2012, Server 2012 R2, and
Server 2016 due to registry access issues.
[#WEM-15]
T he Agent Host waits about 5 minutes before starting if Workspace Environment Management is installed on Windows
version 8, 8.1, 10, Server 2012, Server 2012 R2, or Server 2016 (all branches and builds) and a language pack is installed.
[#WEM-17]
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.8
Known issues
Aug 17, 20 17
T his release contains the following issues:
On Windows Server 2012 R2, if Adobe Acrobat Reader is installed it prevents Workspace Environment Management from
associating PDF files with other PDF reader applications. Users are forced to manually select the PDF reader application
to use each time they open a PDF.
[#WEM-33]
When you uninstall the Workspace Environment Management agent, the Windows Firewall inbound rule “Norskale agent
in” is not deleted by the uninstall process. You should manually delete this rule in the Windows Firewall with Advanced
Security dialog.
[#WEM-312]
If you attempt to add an agent host machine to a configuration set when the agent host machine is in a different
forest to the infrastructure service, it can take several minutes before the agent host is added, depending on the actual
AD topology involved. During this time, the administration console displays the message "Please Wait loading…" and
further activities are not possible.
[#WEM-358]
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.9
Deprecation
Aug 17, 20 17
T he announcements in this section are intended to give you advanced notice of platforms and Workspace Environment
Management features which are being phased out so that you can make timely business decisions. Citrix monitors
customer use and feedback to determine when they are withdrawn. T his list is subject to change in subsequent releases
and may not include every deprecated feature or functionality.
T he following platforms and Workspace Environment Management features are deprecated. T his does not mean that they
are removed immediately. Citrix will continue to support them up to and including the next XenApp and XenDesktop Long
Term Service Release (LT SR) release. Deprecated items will be removed in a Current Release following the next LT SR.
Alternatives for deprecated items are suggested where possible.
For complete details about product lifecycle support, see Product Lifecycle Support Policy.
Announced
in
Item
Support for assigning and binding existing (pre-version 4.3) agents to sites
via GPO.
4.3
Alternative
Upgrade agents to Workspace
Environment Management 4.3.
T he Administration Console will not be supported on the following
platforms after the next LT SR:
Windows XP SP3 32-bit and 64-bit
Windows Vista SP1 32-bit and 64-bit
4.2
Windows 8.x 32-bit and 64-bit
Windows Server 2003 32-bit and 64-bit
Windows Server 2003 R2 32-bit and 64-bit Windows Server 2008
Windows Server 2008 R2
Workspace Environment Management will not be supported on the
following software after the next LT SR:
Microsoft .NET Framework 4.0
4.2
Microsoft .NET Framework 4.5.0
Microsoft .NET Framework 4.5.1
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.10
System requirements
Aug 17, 20 17
Sof tware prerequisites
.NET Framework. T his is necessary for all Workspace Environment Management components. If the correct version is not
available, installation fails. Version 4.5.2 or 4.6.2 are recommended (depending on OS), but the following versions are the
minimum requirements:
.NET 4 .0 (f ull package or Client Profile). T his is the minimum necessary for the agent and administration console.
.NET 4 .5.2. T his is minimum necessary for the infrastructure services.
Microsof t SQL Server Compact 3.5 SP2: SQL Server Compact is used by Workspace Environment Management to cache
settings, primarily for use in offline mode. It must be installed on the infrastructure server. Install SQL Server Compact on
any agent environment to allow the agent to cache settings and run when in offline mode. If SQL Server Compact is not
already installed, it is installed during infrastructure services installation.
Microsof t Sync Framework 2.1. T his is necessary for all Workspace Environment Management components. If not already
installed, this prerequisite is installed during installation.
Microsof t SQL Server 2008 R2 or later: Workspace Environment Management requires sysadmin access to a SQL Server
instance to create its database, and read/write access to this database to use it.
Microsof t Active Directory: Workspace Environment Management requires read access to your Active Directory to push
configured settings out to users. Administrative access is required to configure the agent.
Citrix License Server 11.14 : Workspace Environment Management requires a Citrix license. Citrix licenses are managed and
stored on Citrix License Servers.
Citrix XenApp and XenDesktop. Any currently supported version of XenApp or XenDesktop is required for this release of
Workspace Environment Management.
Tip
SQL AlwaysOn
Workspace Environment Management does not use any features or settings that would prevent you using SQL AlwaysOn. However,
SQL AlwaysOn is currently not one of our test scenarios and cannot therefore be certified. We will continue to monitor demand for
SQL AlwaysOn for certification consideration in a future release.
In the meantime if you are using SQL AlwaysOn and run into issues, to get support you may need to break the clustering and
demonstrate that the issue is still present without SQL AlwaysOn.
Operating system prerequisites
Inf rastructure services
Windows Server 2008 R2
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.11
Windows Server 2012
Windows Server 2012 R2
Windows Server 2016
Administration console
Windows XP SP3 32-bit and 64-bit
Windows Vista SP1 32-bit and 64-bit
Windows 7 32-bit and 64-bit
Windows 8.x 32-bit and 64-bit
Windows 10 32-bit and 64-bit
Windows Server 2003 32-bit and 64-bit
Windows Server 2003 R2 32-bit and 64-bit
Windows Server 2008
Windows Server 2008 R2
Windows Server 2012
Windows Server 2012 R2
Windows Server 2016
Agent
Windows XP SP3 32-bit and 64-bit
Windows Vista SP1 32-bit and 64-bit
Windows 7 32-bit and 64-bit
Windows 8.x 32-bit and 64-bit
Windows 10 32-bit and 64-bit
Windows Server 2003 32-bit and 64-bit*
Windows Server 2003 R2 32-bit and 64-bit*
Windows Server 2008*
Windows Server 2008 R2*
Windows Server 2012*
Windows Server 2012 R2*
Windows Server 2016*
* T he Transformer feature is not supported on server operating systems.
Hardware prerequisites
Inf rastructure services (for up to 3,000 users): 4 vCPUs, 8 GB RAM, 80 MB of available disk space.
Administration console: minimum dual core processor with 2 GB RAM, 40 MB of available disk space (100 MB during install).
Agent: average RAM consumption is 10 MB, but we recommend that you provide 20 MB to be safe. 40 MB of available disk
space (100 MB during installation).
Database: minimum 50 MB of available disk space for the Workspace Environment Management database.
Service dependencies
Netlogon. T he agent service ("Norskale Agent Host service") is added to the Netlogon Dependencies list to ensure that the
agent service is running before logons can be made.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.12
Anti-virus exclusions
Workspace Environment Management agent and infrastructure services are installed in the following default directories:
C:\Program Files (x86)\Norskale\Norskale Agent Host
(on 64-bit OS)
C:\Program Files\Norskale\Norskale Agent Host
(on 32-bit OS)
C:\Program Files (x86)\Norskale\Norskale Infrastructure Services
On-access scanning must be disabled for the entire "Norskale" installation directory for both the Workspace Environment
Management agent and infrastructure services. If this is not possible, the following processes must be excluded from onaccess scanning:
In the inf rastructure services installation directory:
Norskale Broker Service.exe
Norskale Broker Service Configuration Utility.exe
Norskale Database Management Utility.exe
In the agent installation directory:
Norskale Agent Host Service.exe
VUEMUIAgent.exe
Agent Log Parser.exe
AgentCacheUtility.exe
AppsMgmtUtil.exe
PrnsMgmtUtil.exe
VUEMAppCmd.exe
VUEMAppCmdDbg.exe
VUEMAppHide.exe
VUEMCmdAgent.exe
VUEMMaintMsg.exe
VUEMRSAV.exe
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.13
Install and configure
Aug 17, 20 17
Install and configure the following components:
Infrastructure services
Administration console
Agent
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.14
Infrastructure services
Aug 17, 20 17
T here is currently one infrastructure service:
Norskale Infrastructure Service (NT SERVICE\Norskale Infrastructure Service) : Manages WEM Infrastructure services.
Account: LocalSystem or specified user account.
Install the infrastructure services
Important
Workspace Environment Management infrastructure services cannot be installed on a domain controller. Kerberos authentication
issues prevent the infrastructure service from working in this scenario.
Note
Usage data collection notice
By default, the infrastructure service collects anonymous analytics on Workspace Environment Management usage each night and
sends it immediately to the Google Analytics server via HT T PS. Analytics collection complies with the Citrix Privacy Policy.
Data collection is enabled by default when you install or upgrade the infrastructure service. To opt out, in the WEM Infrastructure
Service Configuration dialog Advanced Settings tab, select the option Do not help improve Workspace Environment
Management using Google Analytics.
To Install the infrastructure services, run Citrix Workspace Environment Management Inf rastructure Services
v4 .04 .00.00 Setup.exe on your infrastucture server. T he infrastructure services install into the following default directory:
C:\Program Files (x86)\Norskale\Norskale Infrastructure Services.
You can customize your installation using the following arguments:
AgentPort: T he infrastructure services setup runs a script that opens firewall ports locally, to ensure that the agent
network traffic is not blocked. T he AgentPort argument allows you to configure which port is opened. T he default
port is 8286. Any valid port is an accepted value.
AgentSyncPort: T he infrastructure services setup runs a script that opens firewall ports locally, to ensure that the
agent network traffic is not blocked. T he AgentSyncPort argument allows you to configure which port is opened. T he
default port is 8285. Any valid port is an accepted value.
AdminPort: T he infrastructure services setup program runs a script that opens firewall ports locally, to ensure that
the agent network traffic is not blocked. T he AdminPort argument allows you to configure which port is opened. T he
default port is 8284. Any valid port is an accepted value.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.15
T he syntax for these install arguments is:
"path:\to\Citrix Workspace Environment Management Inf rastructure
Services v4 .04 .00.00 Setup" /v"argument1=\"value1\" argument2=\"value2\""
Create SPNs
Note
When you are using load balancing, all instances of the infrastructure services must be installed and configured using the same
service account name.
After the installer is finished, create a Service Principal Name (SPN) for the infrastructure service. Use the command that is
applicable to your environment:
You do not use Windows authentication or load balancing:
setspn -C -S Norskale/BrokerService [hostname]
where [hostname] is the name of the infrastructure server.
You use Windows authentication or you use load balancing (which requires Windows authentication):
setspn -U -S Norskale/BrokerService [accountname]
where [accountname] is the name of the service account that is being used for Windows authentication.
SPNs are case-sensitive.
Configure load balancing
To configure Workspace Environment Management with a load balancing service:
1. Create a Windows infrastructure service account for the Workspace Environment Management infrastructure service to
connect to the Workspace Environment Management database.
2. When you create the Workspace Environment Management database, select the option Use Windows
authentication f or inf rastructure service database connection and specify the infrastructure service account
name. [See Create a Workspace Environment Management database.]
3. Configure each infrastructure service to connect to the SQL database using Windows authentication instead of SQL
authentication: select the option Enable Windows account impersonation and provide the infrastructure service
account credentials. [See Configure the Infrastructure Service.]
4. Configure the Service Principal Names (SPNs) for the Workspace Environment Management infrastructure services to
use the infrastructure service account name. [See Create SPNs.]
5. Create a virtual IP address (VIP) that covers the number of infrastructure servers you want to put behind a VIP. All the
infrastructure servers covered by a VIP are eligible when agents connect to the VIP.
6. When you configure the Agent Host Configuration GPO, set the infrastructure server setting to the VIP instead of the
address for any individual infrastructure server. [See Configure the agent.]
7. Session persistence is required for the connection between administration consoles and the infrastructure service.
(Session persistence between the agent and the infrastructure service is not required.) Citrix recommends that you
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.16
directly connect each administration console to an infrastructure service server, rather than using the VIP.
Create a Workspace Environment Management
database
Use the WEM Database Management Utility to create the database. T his is installed during the infrastructure services
installation process, and it starts immediately afterwards.
Note: If you are using Windows authentication for your SQL Server, run the database creation utility under an identity that
has sysadmin permissions.
1. If the Database Management Utility is not already open, from the Start menu select Citrix>Workspace Environment
Management>WEM Database Management Utility.
2. Click Create Database, then click Next.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.17
3. Type the following Database Information, then click Next:
Server and instance name. Address of the SQL Server on which the database will be hosted. T his address must be
reachable exactly as typed from the infrastructure server. Type server and instance name as the machine name, fully
qualified domain name, or IP address. Specify a full instance address as serveraddress,port\instancename. If port is
unspecified the default SQL port number (1433) is used.
Database name. Name of the SQL database to create.
Data file: path to the .mdf file location on the SQL Server.
Log file: path to the .ldf file location on the SQL Server.
Note. T he database management utility cannot query your SQL Server for the default location of the data and log files.
T hey default to the default values for a default installation of MS SQL Server. Make sure that the values in these two fields
are correct for your MS SQL Server installation or the database creation process will fail.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.18
4. Provide Database Server Credentials which the wizard can use to create the database, then click Next. T hese credentials
are independent from the credentials the infrastructure service uses to connect to the database after it is created. T hey
are not stored.
T he option Use integrated connection is selected by default. It allows the wizard to use the Windows account of the
identity it is running under to connect to SQL and create the database. If this Windows account does not have sufficient
permissions to create the database, you can either run the database management utility as a Windows account with
sufficient privileges, or you can clear this option and provide an SQL account with sufficient privileges instead.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.19
5. Enter VUEM Administrators and Database Security details, then click Next. T he credentials you provide here are used by
the infrastructure service to connect to the database after it is created. T hey are stored in the database.
Initial administrator group. T his user group is pre-configured as Full Access administrators for the Administration
Console. Only users configured as Workspace Environment Management administrators are allowed to use the
administration console. Specify a valid user group or you will not be able to use the administration console yourself.
Use Windows authentication f or inf rastructure service database connection. When this option is cleared (the
default) the database expects the infrastructure service to connect to it using the vuemUser SQL user account. T he
vuemUser SQL user account is created by the installation process. T his requires Mixed-Mode Authentication to be
enabled for the SQL instance.
When this option is selected, the database expects the infrastructure service to connect to it using a Windows
account. In this case the Windows account you select must not already have a login on the SQL instance. In other
words, you cannot use the same Windows account to run the infrastructure service as you used to create the
database.
Set vuemUser SQL user account password. By default, the vuemUser SQL account is created with an 8-character
password which uses upper and lower case letters, digits, and punctuation. Select this option if you want to enter
your own vuemUser SQL account password (for example, if your SQL policy requires a more complex password).
Important: If you set your own password here, remember to specify the same password when you configure the
infrastructure service.
6. In the summary pane, review the settings you have selected, and when you are satisfied click Create Database.
7. When you are notified that the database creation has completed successfully, click Finish to exit the wizard.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.20
If there is an error during the database creation, check the log file "Citrix WEM Database Management Utility Debug
Log.log" in the infrastructure services installation directory.
Configure the infrastructure service
Before the infrastructure service runs, you must configure it using the WEM Inf rastructure Service Configuration utility.
1. From the Start menu select Citrix>Workspace Environment Management>WEM Inf rastructure Service
Configuration Utility.
2. In the Database Settings tab enter the following details:
Database server and instance. Address of the SQL Server instance on which the Workspace Environment
Management database is hosted. T his must be reachable exactly as typed from the infrastructure server. Specify a full
instance address as "serveraddress,port\instancename". If port is unspecified the default SQL port number (1433) is
used.
Database f ailover server and instance. If you are using database mirroring, specify the failover server address here.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.21
Database name. Name of the Workspace Environment Management database on the SQL instance.
3. In the Network Settings tab type the ports the infrastructure service uses:
Administration port. T his port is used by the administration console to connect to the infrastructure service.
Agent service port. T his port is used by your agent hosts to connect to the infrastructure service.
Cache synchronization port. T his port is used by the agent service to synchronize its cache with the infrastructure
service.
WEM monitoring port. [Not currently used.]
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.22
4. In the Advanced Settings tab, enter impersonation and automatic refresh settings.
Enable Windows account impersonation. By default, this option is cleared and the infrastructure service uses
mixed-mode authentication to connect to the database (using the SQL account vuemUser created during database
creation). If you instead selected a Windows infrastructure service account during database creation, you must select
this option and specify the same Windows account for the infrastructure service to impersonate during connection.
T he account you select must be a local administrator on the infrastructure server.
Set vuemUser SQL user account password. Allows you to inform the infrastructure service of a custom password
configured for the vuemUser SQL user during database creation. Only enable this option if you provided your own
password during database creation.
Inf rastructure service cache ref resh delay. T ime (in minutes) before the infrastructure service refreshes its cache.
T he cache is used if the infrastructure service is unable to connect to SQL.
Inf rastructure service SQL state monitor delay. T ime (in seconds) between each infrastructure service attempt to
poll the SQL server.
Inf rastructure service SQL connection timeout. T ime (in seconds) which the infrastructure service waits when
trying to establish a connection with the SQL server before terminating the attempt and generating an error.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.23
Enable debug mode. If enabled, the infrastructure service is set to verbose logging mode.
Use cache even if online. If enabled, the infrastructure service always reads site settings from its cache.
Help improve Workspace Environment Management using Google Analytics. If selected, the infrastructure
service sends anonymous analytics to the Google Analytics server.
Do not help improve Workspace Environment Management using Google Analytics. If selected, the
infrastructure service does not send anonymous analytics to the Google Analytics server.
5. You can use the Database Maintenance tab to configure database maintenance.
Enable scheduled database maintenance. If enabled, this setting deletes old statistics records from the database
at periodic intervals.
Statistics retention period. Determines how long user and agent statistics are retained. Default is 365 days.
System monitoring retention period. Determines how long system optimization statistics are retained. Default is
90 days.
Agent registrations retention period. Determines how long agent registration logs are retained in the database.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.24
Default is 1 day.
Execution time. Determines the time at which the database maintenance action is performed. Default is 02:00.
6. You can optionally use the Licensing tab to specify a Citrix License Server during infrastructure service configuration. If
you do not, when an administration console connects to a new Workspace Environment Management database for the
first time, you will need to enter the Citrix License Server credentials in the About tab of the administration console ribbon.
T he Citrix License Server information is stored in the same location in the database in both cases.
Global license server override. Enable this option to enter the credentials of the Citrix License Server used by
Workspace Environment Management. Information you enter here will override any Citrix License Server information
already in the Workspace Environment Management database.
After the infrastructure services are configured to your satisfaction, click Save Configuration to save these settings
and then exit the Infrastructure Services Configuration utility.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.25
Administration console
Aug 17, 20 17
Install the administration console
Run Citrix Workspace Environment Management Console v4 .04 .00.00 Setup.exe on your administrator console
environment.
You can customize your installation using these arguments:
AgentPort: T he administration console setup runs a script that opens firewall ports locally, to make sure the agent
network traffic is not blocked. T his argument allows you to configure which port is opened. If unspecified, the default
port 8286 is used. Accepted values are any valid port.
AdminPort: T he administration console setup runs a script that opens firewall ports locally, to make sure the agent
network traffic is not blocked. T his argument allows you to configure which port is opened. If unspecified, the default
port 8284 is used. Accepted values are any valid port.
T he syntax for these install arguments is as follows:
"path:\to\Citrix Workspace Environment Management Console v4 .04 .00.00 Setup " /v"argument=\"value\""
Configure the administration console
Create an inf rastructure server connection
1. In the Start menu select Citrix>Workspace Environment Management>WEM Administration Console. By default,
the administration console launches in a disconnected state.
2. In the ribbon, click Connect to open the New Infrastructure Server Connection window.
3. Enter the following values then click Connect:
Inf rastructure server name. T he name of the Workspace Environment Management infrastructure server. It must
resolve from the administration console environment exactly as you type it.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.26
Administration port. T he port on which the administration console connects to the infrastructure service.
T he first time you connect to a new database, you will see the following message because a Citrix License Server with valid
licenses is not yet configured:
Configure the database with a license server
To configure the database with a license server, in the administration console ribbon click About then click Configure
License Server and enter your Citrix License Server details. T he Citrix License Server address must resolve from the
administration console environment exactly as entered.
Import quickstart settings
Workspace Environment Management includes XML files which pre-configure your Workspace Environment Management
database so that it is proof-of-concept-ready out of the box. T he Environmental Settings included in the quickstart setting
files are a sample lockdown configuration. All other setting groups are based on best practices.
1. To import the quickstart setting files, in the Home ribbon click Restore:
2. In the Restore Wizard, select Settings then click Next.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.27
3. In the Restore Wizard, select the folder "Configuration Templates" containing the quickstart setting files, then select all
Setting Types.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.28
Agent
Aug 17, 20 17
Configure the agent
Note
T he Workspace Environment Management agent cannot be installed on the infrastructure server.
Agent configuration requires administrative access to your Active Directory.
Prerequisites
To configure the agent, use the Workspace Environment Management Agent Host Configuration v4 .04 .00.00.adm or
the Workspace Environment Management Agent Host Configuration v4 .04 .00.00.admx administrative template
(provided with Workspace Environment Management).
Configure group policies
Use the Group Policy Management Editor to configure a GPO with the following settings:
Inf rastructure server. T he address of the Workspace Environment Managementi infrastructure server. It must be
reachable exactly as typed from the user environment.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.29
Agent service port: T he default value is 8286. T he agent service port must be the same as the port you configured for
agent service port during infrastructure services configuration.
Cache synchronization port: T he default value is 8285. T he cache synchronization port must be the same as the port you
configured for cache synchronization port during infrastructure services configuration.
VUEMAppCmd extra sync delay. T he default value is 0. T he delay interval in milliseconds for the agent application launcher
(VUEMAppCmd.exe) to wait before XenApp and XenDesktop published resources are started. T his ensures that the
necessary agent work has completed first.
Deploy the agent
T here is one agent service:
Norskale Agent Host Service (NT SERVICE\Norskale Agent Host Service) : Manages WEM Agent. Account:
LocalSystem
You can run Citrix Workspace Environment Management Agent Setup in your user environment, or deploy the installer
to your users. T he installer accepts standard InstallShield deployment switches. T he agent installs into the following default
directory:
C:\Program Files (x86)\Norskale\Norskale Agent Host (on 64-bit OS)
C:\Program Files\Norskale\Norskale Agent Host (on 32-bit OS)
T he Citrix Workspace Environment Management Agent Setup executable acknowledges the following custom
arguments:
WaitForNetwork. T his argument allows you to configure whether the WaitForNetwork registry key created during
installation is active or not. Accepted values are 0 and 1. If not specified, the key will not be created during installation.
SyncForegroundPolicy. T his argument allows you to configure whether the SyncForegroundPolicy registry key
created during installation is active or not. Accepted values are 0 and 1. If not specified, the key will not be created
during installation.
GpNetworkStartTimeoutPolicyValue. T his argument allows you to configure the value of the
GpNetworkStartT imeoutPolicyValue registry key created during installation, in seconds. By default, this value is 30, but
the argument will accept any whole number.
All three keys are created under HKEY_LOCAL_MACHINE\Sof tware\Microsof t\Windows
NT\CurrentVersion\Winlogon during the installation process, and are there to ensure that the user environment
receives the infrastructure server address GPOs before logon. In network environments where the Active Directory or
Domain Controller servers are slow to respond, this may lead to additional processing time prior to the login screen
being displayed. Microsoft recommend setting the value of the GpNetworkStartTimeoutPolicyValue key to a
minimum of 30 in order for it to have an impact.
AgentPort: T he agent installer runs a script to open firewall ports locally, to make sure the agent network traffic is
not blocked. T his argument allows you to configure which port is opened. If unspecified, the default port 8286 is used.
Accepted values are any valid port.
AgentSyncPort: T he agent installer runs a script to open firewall ports locally, to make sure the agent network traffic
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.30
is not blocked. T his argument allows you to configure which port is opened. If unspecified, the default port 8285 is
used. Accepted values are any valid port.
ServicesPipeTimeout. T his argument allows you to configure the value of the ServicesPipeT imeout registry key,
which is created during installation under HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet. T his registry key
adds a delay before the service control manager is allowed to report on the state of the Workspace Environment
Management agent service, which prevents the agent from failing because the agent service launched before the
network was initialised. T his argument will accept any value, in milliseconds. If unspecified, a default value of 60000 (60
seconds) is used).
CmdLineToolsDebug. If the value of this argument is 1, the setup executable displays all arguments passed to the
agent installer in a separate cmd window that will pause the installation until dismissed.
ARPSYSTEMCOMPONENT. T his argument allows you to designate the agent as a system component, which prevents
it from appearing in Add/Remove Programs. Accepted values are 0 or 1.
AgentCacheAlternateLocation. T his argument allows you to specify the value of the associated registry setting
which must be expressed as a valid file path. If configured, the agent local cache file is saved in the designated
location, instead of in the agent installation directory.
AgentServiceUseNonPersistentCompliantHistory. T his argument allows you to specify the value of the associated
registry setting. If configured, the agent service process optimisation history is saved externally to an XML file in the
same location as the agent local cache (by default, the agent installation directory, or the location configured via
AgentCacheAlternateLocation) rather than in the machine registry. Accepted value is 1.
T he syntax for these install arguments is as follows:
"path:\to\Citrix Workspace Environment Management Agent v4 .04 .00.00 Setup.exe"
/v"argument=\"value\""
For example:
COPY
"C:\VUEM 4.04.00.00\Citrix Workspace Environment Management Agent v4.04.00.00 Setup.exe" /v"WaitForNetwork=\"1\" GpNetworkStartTimeo
Build the agent service cache
As an optional third step, or to build an image that includes the Workspace Environment Management Agent Host as preinstalled software, you can ensure that the agent service cache is built before the agent is run. (By default, the cache is
built the first time the agent runs).
To create or rebuilds the agent Service cache, run the command line executable AgentCacheUtility.exe in the agent
installation directory. T he executable accepts the following command line arguments:
-help: display a list of allowed arguments.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.31
-ref reshcache or -r: trigger a cache build or refresh.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.32
Upgrade a deployment
Aug 17, 20 17
Introduction
You can upgrade deployments to newer versions without having to first set up new machines or Sites; this is called an inplace upgrade. T he following upgrade paths have been tested:
From Workspace Experience Manager version 4.3 to the latest released (current) version
From Workspace Experience Manager version 4.2 to the latest released (current) version
T he Workspace Environment Management components must be upgraded in the following order:
1. Infrastructure services
2. Database
3. Administration console
4. Agent
Step 1: Upgrade the infrastructure services
To upgrade the Workspace Environment Management infrastructure services, run the new Workspace Environment
Management infrastructure services setup on your infrastructure server. T he upgrade procedure is otherwise identical to
the installation procedure.
Note: Remember to reconfigure the Workspace Environment Management infrastructure services after the database
upgrade completes.
Step 2: Upgrade the database
Important
T he database upgrade process is not reversible. Ensure that you have a valid database backup before launching the upgrade
process.
Use the WEM Database Management Utility to update the database. T his is installed is installed on your Workspace
Environment Management infrastructure server during the infrastructure services installation process.
Note: If you are using Windows authentication for your SQL Server, run the database upgrade utility under an identity that
has sysadmin permissions.
1. From the Start menu select Citrix>Workspace Environment Management>WEM Database Management Utility.
2. Click Upgrade Database.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.33
Server and instance name. Address of the SQL Server\instance on which the database is hosted. It must be reachable
exactly as entered from the infrastructure server.
Database name. Name of the database to be upgraded.
Inf rastructure service uses Windows authentication.
When this option is cleared (the default) the database expects the infrastructure service to connect to it using the
vuemUser SQL user account. T he vuemUser SQL user account is created by the installation process. T his requires MixedMode Authentication to be enabled for the SQL instance.
When this option is selected, the database expects the infrastructure service to connect to it using a Windows account. In
this case the Windows account you select must not already have a login on the SQL instance. In other words, you cannot
use the same Windows account to run the infrastructure service as you used to create the database.
T he option Use integrated connection is selected by default. It allows the wizard to use the Windows account of the
identity it is running under to connect to SQL and create the database. If this Windows account does not have sufficient
permissions to create the database, you can either run the database management utility as a Windows account with
sufficient privileges, or you can clear this option and provide an SQL account with sufficient privileges instead.
Click Upgrade to start the database upgrade process. Once you are notified that the database upgrade has completed
successfully, you can exit the application.
If there are errors during the database upgrade, please check the VUEM Database Management Utility Log file in your
Workspace Environment Management infrastructure services installation directory.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.34
Step 3: Upgrade the administration console
All Workspace Environment Management settings configured with the Administration Console are stored in the database
and are preserved during upgrade.
To upgrade the administration console, run the administration console setup executable. T he procedure is otherwise
identical to the installation procedure.
Step 4: Upgrade the agent
Important
Before upgrading an agent, make sure no users are logged in. T his ensures that the upgrade process can modify the files on that
machine.
To upgrade the agent, run the new agent setup executable on the target machine.
After upgrading the agent (via installer or private patch) run the following two commands to ensure that the Agent .dll files
are correctly precompiled:
C:\Windows\Microsof t .NET\Framework64 \v4 .0.30319\ngen.exe update
C:\Windows\Microsof t .NET\Framework64 \v4 .0.30319\ngen.exe eqi 3
(Please note that for 32-bit operating systems, the path is instead
C:\Windows\Microsof t .NET\Framework\v4 .0.30319\ngen.exe).
By design, agents are backward-compatible within the same major release version.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.35
User experience
Aug 17, 20 17
Start the administration console
1. From the Start menu select Citrix>Workspace Environment Management>WEM Administration Console. By
default, the administration console launches in a disconnected state.
2. In the administration console ribbon click Connect.
3. In the New Infrastructure Server Connection window, enter the address of your infrastructure server and click Connect.
Configure your installation
In the administration console:
1. Click on menu items in the lower-left-hand pane to display their sub-sections in the pane above them.
2. Click on sub-section items to populate the main window area with appropriate content.
3. Change configuration as required. See the user interface reference for information on settings you can use.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.36
User interface reference
Aug 17, 20 17
T his section describes the Workspace Environment Management administration console user interface. Use the contents
list to navigate between the following sections of the user interface:
Ribbon
Actions
Filters
Assignments
System optimization
Policies and profiles
Security
Active Directory Objects
T ransformer settings
Advanced settings
Administration
Monitoring
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.37
Ribbon
Aug 17, 20 17
T he ribbon in the administration console contains the following tabs:
Home tab
About tab
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.38
Home tab
Aug 17, 20 17
T he Home tab contains the following controls:
Connect. Connect administration console to specified infrastructure server. In the New Inf rastructure Server Connection
dialog specify:
Inf rastructure server name. Name of the infrastructure server you wish to connect to.
Administration port. Port on which you wish to connect to the infrastructure service. Default value of 8284 is prepopulated.
Disconnect. Disconnect administration console from current infrastructure service. T his allows the administrator to
manage multiple infrastructure services from a single console, by disconnecting from one and connecting to another.
Configuration set. Switch from one Workspace Environment Management site (configuration set) to another.
Create. Open the Create configuration set window.
Name. Site (configuration set) name as it will appear in the configuration set list in the Ribbon.
Description. Site (configuration set) description as it appears in the site edition window.
Site State. Toggles whether the site (configuration set) is Enabled or Disabled. When Disabled, Citrix Workspace
Environment Management Agents cannot connect to the site (configuration set).
Edit. Open the Edit configuration set window, with similar options to the Create configuration set window.
Delete. Delete the site (configuration set). Note that you cannot delete "Default site" because it is required for Workspace
Environment Management to function. You can, however, rename it.
Ref resh. Refresh the site (configuration set) list. Note: T he list does not refresh automatically when sites are created from
different administration consoles.
Backup. Open the Backup Wizard to back up the current configuration in a special Workspace Environment Management
XML format. You can then use this backup to Restore settings into a Workspace Environment Management installation.
You can back up actions or settings in each operation.
Actions. Back up selected Workspace Environment Management actions. Each type of action is exported as a
separate XML file.
Settings. Back up selected Workspace Environment Management settings. Each type of setting is exported as a
separate XML file.
Restore. Open the Restore Wizard to restore settings you previously created using the Workspace Environment
Management Backup wizard into your current configuration set. Select a folder containing Workspace Environment
Management XML format backup files. Actions restored from the backup file are added to existing actions.
Settings restored from the backup file replace existing settings.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.39
About tab
Aug 17, 20 17
Configure License Server. Allows you to specify the address of your Citrix License Server, without which the administration
console will not let you modify any settings. Alternatively, you can use the Licensing tab in the Infrastructure Services
Configuration utility to specify these credentials. Citrix License Server information is stored in the same location in the
database in both cases.
Get Help. Opens the Citrix Product Documentation website in a web browser window.
Options. Opens the Administration Console Options dialog. T hese options are specific to this local instance of the
administration console.
Auto Admin Logon. If enabled, the administration console automatically connects to the last infrastructure service it
connected to at startup.
Enable Debug Mode. Enables verbose logging for the administration console. Logs are created in the root of the
current user "Users" folder.
Console Skin. Allows you to select from a variety of skins for the administration console only.
Port Number. Allows you to customize the port on which the administration console connects to the infrastructure
service. T his port must match the port configured in the infrastructure services configuration.
About. Lists the current version of the administration console as well as licensing (license type, registration and count) and
legal information.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.40
Actions
Aug 17, 20 17
T hese settings create user resources such as network drives or application shortcuts. You can use dynamic tokens
to extend Workspace Environment Management actions to make them more powerful.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.41
Applications
Aug 17, 20 17
Controls the creation of application shortcuts.
Tip
To use the Workspace Environment Management agent with XenApp XenApp and XenDesktop applications, edit your XenApp
application to point to VUEMAppCmd.exe (located in the agent installation directory) with the application path as an argument.
T hen create your shortcuts as normal, either via XenApp or via Workspace Environment Management, by copying the XenApp
shortcut details to a new application action in the admin console.
Application List
A list of your existing application resources. You can use Find to filter the list by name or ID against a text string.
To add an application
1. Use the context menu Add command.
2. Enter details in the New Application dialog tabs, then click OK.
Name. T he display name of the application shortcut, as it appears in the application list.
Description. T his field is only shown in the edition/creation wizard and allows you to specify additional
information about the resource.
Command Line. T he path to the application executable as the client machine will see it. T he Browse
General
tab
button allows you to browse to the executable if it is installed locally.
Working Directory. T he shortcut working directory. Automatically filled out if you browse to the
executable.
Parameters. Allows you to specify any launch parameters for the application.
Start Menu Integration. Allows you to select a specific path in the Start Menu. By default, a new
shortcut is created in Programs.
Select Icon. Allows you to browse to an icon file and select an icon for your application. By default, this
uses the application executable's icon but you can select any valid icon. Icons are stored in the database as
text.
High Resolution Icons Only. Only displays HD icons in the selection box.
Application State. Controls whether the application shortcut is enabled or not. When disabled, it is not
processed by the agent even if assigned to a user.
Maintenance Mode. When active, this will prevent the user from running the application shortcut. T he
shortcut icon is modified to include a warning sign to denote that the icon is not available, and the user will
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.42
receive a short message informing them the application is unavailable if they try to launch it. T his allows you
Options
tab
to proactively manage scenarios where published applications are in maintenance without having to disable
or delete application shortcut resources.
Display Name. T he name of the shortcut as it will appear in the user's environment.
Window Style. T his controls what state the application starts in (minimized, maximized, or normal).
Self-Service Display. If selected, the resource will not be shown in the Workspace Environment
Management agent self-service window.
Hotkey. Allows you to specify a hotkey for the user to launch the application with. Hotkeys are case
sensitive and are entered in the following format (e.g.): Ctrl + Alt + S.
Action Type. Describes what type of action this resource is.
Enable Automatic Self-Healing. When selected, application shortcuts will automatically be recreated by
the agent at refresh if they have been moved or deleted by the user.
Advanced
Settings
tab
Enf orce Icon Location. Allows you to specify the exact location of the application shortcut on the user's
desktop. Values are in pixels.
Application Type. Controls the type of application that this shortcut points to. T his modifies the settings
available on the General tab.
Start Menu View
Displays a tree view of your application shortcut resource locations in the Start Menu.
Ref resh. Refreshes the application list.
Move. Opens up a wizard which allows you to select a location to move the application shortcut to.
Edit. Opens up the application edition wizard.
Delete. Deletes the selected application shortcut resource.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.43
Printers
Aug 17, 20 17
T his tab controls the mapping of printers.
Network Printer List
A list of your of your existing printer resources, with unique IDs. You can use Find to filter your printers list by name or ID
against a text string. You can import printers using Import Network Print Server on the ribbon.
To add a printer
1. Use the context menu Add command.
2. Enter details in the New Network Printer dialog tabs, then click OK.
Name. T he display name of the printer, as it appears in the printer list.
Description. T his field is only shown in the edition/creation wizard and allows you to specify additional
information about the resource.
General
tab
Target Path. T he path to the printer as it resolves in the user's environment.
Printer State. Toggles whether the printer is enabled or disabled. When disabled, it is not processed by the
agent even if assigned to a user.
External Credentials. Allows you to state specific credentials with which to connect to the printer.
Self-Healing. Toggles whether the printer is automatically recreated for users when the agent refreshes.
Options
tab
Action Type. Describes what type of action this resource is. For Use Device Mapping Printers File, specify
Target Path as the absolute path to an XML printer list file (see XML printer list configuration). When the
agent refreshes it parses this XML file for printers to add to the action queue.
To import a printer
1. In the ribbon click Import Network Print Server.
2. Enter details in the Import f rom Network Print Server dialog, then click OK:
Print Server Name. T he name of the print server you wish to import printers from.
Use Alternate Credentials. By default, the import uses the credentials of the Windows account under whose
identity the administration console is currently running. Select this option to specify different credentials for the
connection to the print server.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.44
Network Drives
Aug 17, 20 17
Controls the mapping of network drives.
Network Drive List
A list of your existing network drives. You can use Find to filter the list by name or ID against a text string.
To add a network drive:
1. Use the context menu Add command.
2. Enter details in the New Network Drive dialog tabs, then click OK.
Tab
Controls
General
Name. T he display name of the drive, as it appears in the network drive list.
Description. T his field is only shown in the edition/creation wizard and allows you to specify
additional information about the resource.
Target Path. T he path to the network drive as it resolves in the user's environment. T he Browse
button allows you to browse to the executable if it is installed locally.
Network Drive State. Toggles whether the network drive is enabled or disabled. When disabled, it is
not processed by the agent even if assigned to a user.
Parameters. Allows you to specify any launch parameters for the application.
External Credentials. Allows you to state specific credentials with which to connect to the
network drive.
Options
Enable Automatic Self-Healing. Toggles whether the printer is automatically recreated for your
users when the agent refreshes.
Set as Home Drive.
Action Type. Describes what type of action this resource is. Defaults to Map Network Drive.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.45
Virtual Drives
Aug 17, 20 17
Controls the mapping of virtual drives. Virtual drives are Windows virtual drives or MS-DOS device names which map local file
paths to drive letters.
Virtual Drive List
A list of your existing virtual drives, with a unique ID. You can use Find to filter the list by name or ID against a text string.
To add a virtual drive:
1. Use the context menu Add command.
2. Enter details in the New Virtual Drive dialog tabs, then click OK.
Tab
Controls
General
Name. T he display name of the drive, as it appears in the virtual drive list.
Description. T his field is only shown in the edition/creation wizard and allows you to specify
additional information about the resource.
Target Path. T he path to the virtual drive as it resolves in the user's environment.
Virtual Drive State. Toggles whether the virtual drive is enabled or disabled. When disabled, it will
not be processed by the agent even if assigned to a user.
Parameters. Allows you to specify any launch parameters for the application.
External Credentials. Allows you to state specific credentials with which to connect to the printer.
Options
https://docs.citrix.com
Action Type. Describes what type of action this resource is.
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.46
Registry Entries
Aug 17, 20 17
Controls the creation of registry entries.
Registry Value List
A list of your existing registry entries. You can use Find to filter the list by name or ID against a text string.
To add a registry entry:
1. Use the context menu Add command.
2. Enter details in the New Registry Value dialog tabs, then click OK.
Tab
Controls
General
Name. T he display name of the registry entry, as it appears in the registry entry list.
Description. T his field is only shown in the edition/creation wizard and allows you to specify
additional information about the resource.
Registry Value State. Toggles whether the registry entry is enabled or disabled. When disabled, it
will not be processed by the agent even if assigned to a user.
Target Path. T he registry location in which the registry entry will be created. Workspace
Environment Management can only create Current User registry entries, so you do not need to
preface your value with %ComputerName%\HKEY_CURRENT_USER – this is done automatically.
Target Name. T he name of your registry value as it will appear in the registry (e.g. NoNtSecurity).
Target Type. T he type of registry entry that will be created.
Target Value. T he value of the registry entry once created (e.g. 0 or C:\Program Files)
Run Once. By default, Workspace Environment Management creates registry entries every time the
agent refreshes. T ick this box to make Workspace Environment Management only create the
registry entry once, rather than at every refresh. T his speeds up the agent refresh process, especially
if you have many registry entries assigned to your users.
Options
Action Type. Describes what type of action this resource is.
To import registry files:
1. In the ribbon click Import Registry File.
2. Enter details in the Import f rom Registry dialog, then click OK:
Registry File Name. T his field allows you to browse to browse to a .reg file containing the registry settings you want
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.47
to import into Workspace Environment Management. For best results, the .reg file should be generated from a clean
environment that has only the registry settings you wish to import applied to it.
Scan. T his will scan the .reg file and display a list of registry settings contained inside it.
Registry Values List. T his lists all of the registry values contained within your imported .reg.
Enable Imported Items. If disabled, newly-imported registry keys are disabled by default.
Prefix Imported Item Names. T his adds a prefix to the name of all registry items imported via this wizard (e.g. "XP
ONLY" or "finance"), to make it easier to organise your registry entries.
Note
T he wizard cannot import registry entries with duplicate names. If your .reg file contains more than one registry entry with the same
name (as displayed in the Registry Values List), select one of these entries for import and rename it if you want to import the others.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.48
Environment Variables
Aug 17, 20 17
Controls the creation of environment variables.
Environment variable list
A list of your existing environment variables. You can use Find to filter the list by name or ID against a text string.
To add an environment variable:
1. Use the context menu Add command.
2. Enter details in the New Environment Variable dialog tabs, then click OK.
Tab
Controls
General
Name. T he display name of the variable, as it appears in the environment variable list.
Description. T his field is only shown in the edition/creation wizard and allows you to specify
additional information about the resource.
Environment Variable State. Toggles whether the environment variable is enabled or disabled.
When disabled, it is not processed by the agent even if assigned to a user.
Variable Name. T he functional name of the environment variable.
Variable Value. T he environment variable value.
Options
Action Type. Describes what type of action this resource is.
Execution order.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.49
Ports
Aug 17, 20 17
Controls the mapping of ports.
Ports list
A list of your existing ports. You can use Find to filter the list by name or ID against a text string.
To add a port:
1. Use the context menu Add command.
2. Enter details in the New Port dialog tabs, then click OK.
Tab
Controls
General
Name. T he display name of the port, as it appears in the port list.
Description. T his field is only shown in the edition/creation wizard and allows you to specify
additional information about the resource.
Port State. Toggles whether the port is enabled or disabled. When disabled, it is not processed by
the agent even if assigned to a user.
Port Name. T he functional name of the port.
Port Target. T he target port.
Options
https://docs.citrix.com
Action Type. Describes what type of action this resource is.
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.50
Ini Files
Aug 17, 20 17
Controls the creation of .ini file operations, which allow you to modify .ini files.
Ini files operation list
A list of your existing ini file operations. You can use Find to filter the list by name or ID against a text string.
To add an .ini files operation:
1. Use the context menu Add command.
2. Enter details in the New Ini Files Operation dialog tabs, then click OK.
Tab
Controls
General
Name. T he display name of the .ini file operation, as it appears in the Ini File Operations list.
Description. T his field is only shown in the edition/creation wizard and allows you to specify
additional information about the resource.
.ini File Operation State. Toggles whether the .ini file operation is enabled or disabled. When
disabled, it is not processed by the agent even if assigned to a user.
Target Path. T his specifies the location of the .ini file that will be modified as it resolves in the user's
environment.
Target Section. T his specifies which section of the .ini file is targeted by this operation. If you
specify a non-existent section, it will be created.
Target Value Name. T his specifies the name of the value that will be added.
Target Value. T his specifies the value itself.
Run Once. By default, Workspace Environment Management performs a .ini file operation every
time the agent refreshes. T ick this box to make Workspace Environment Management only perform
the operation once, rather than at every refresh. T his speeds up the agent refresh process,
especially if you have many .ini file operations assigned to your users.
Options
https://docs.citrix.com
Action Type. Describes what type of action this resource is.
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.51
External Tasks
Aug 17, 20 17
Controls the execution of external tasks such as running .vbs or .cmd scripts.
External task list
A list of your existing external tasks. You can use Find to filter the list by name or ID against a text string.
To add an external task:
1. Use the context menu Add command.
2. Enter details in the New External Task dialog tabs, then click OK.
Tab
Controls
General
Name. T he display name of the external task, as it appears in the external task list.
Name. T he display name of the external task, as it appears in the external task list.
Description. T his field is only shown in the edition/creation wizard and allows you to specify
additional information about the resource.
Target Path. T he path to the external task script as it resolves in the user's environment.
Target Arguments. Allows you to specify any launch parameters or arguments.
External Task State. Toggles whether the external task is enabled or disabled. When disabled, it is
not processed by the agent even if assigned to a user.
Run Hidden. If selected, the external task runs in the background and is not shown to the user.
Run Once. By default, Workspace Environment Management runs an external task every time the
agent refreshes. T ick this box to make Workspace Environment Management only run the external
task once, rather than at every refresh. T his speeds up the agent refresh process, especially if you
have many external tasks assigned to your users.
Wait f or Task Completion. T his toggles whether or not the agent waits for the external task to
complete. T he T imeout value controls the maximum wait time.
Execute Only at Logon. If selected, the external task will only be run at logon rather than during
every single refresh.
External Task Execution Order. T his allows you to specify a priority for each individual external
task, in case multiple tasks are assigned to one user and some tasks rely on results from others to
run successfully.
Options
https://docs.citrix.com
Action Type. Describes what type of action this resource is.
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.52
File System Operations
Aug 17, 20 17
Controls the copying of folders and files into the user's environment.
File system operations list
A list of your existing file/folder operations. You can use Find to filter the list by name or ID against a text string.
To add a file system operation:
1. Use the context menu Add command.
2. Enter details in the New File System Operation dialog tabs, then click OK.
Tab
Controls
General
Name. T he display name of the file/folder operation, as it appears in the list.
Description. T his field is only shown in the edition/creation wizard and allows you to specify
additional information about the resource.
Filesystem Operation State. Toggles whether the file system operation is enabled or disabled.
When disabled, it is not processed by the agent even if assigned to a user.
Source Path. T he path to the source file or folder that is copied.
Target Path. T he destination path for the source file or folder that is copied.
Overwrite Target if Existing. Toggles whether the file/folder operation overwrites existing files or
folders with the same names in the target location. If cleared, and a file or folder with the same
name already exists at the target location, the affected files are not copied.
Run Once. By default, Workspace Environment Management runs a file system operation every
time the agent refreshes. T ick this box to make Workspace Environment Management only run the
operation once, rather than at every refresh. T his speeds up the agent refresh process, especially if
you have many file system operations assigned to your users.
Options
Action Type. Describes what type of action this file/folder action is: Copy, Delete, Move, Rename
or Symbolic Link operation. Please note that for symbolic link creation, you will need to give users
the SeCreateSymbolicLinkPrivilege privilege for Windows to allow symbolic link creation.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.53
User DSN
Aug 17, 20 17
Controls the creation of user DSNs.
User DSN list
A list of your existing user DSNs. You can use Find to filter the list by name or ID against a text string.
To add a user DSN:
1. Use the context menu Add command.
2. Enter details in the New User DSN dialog tabs, then click OK.
Tab
Controls
General
Name. T he display name of the user DSN, as it appears in the user DSN list.
Description. T his field is only shown in the edition/creation wizard and allows you to specify
additional information about the resource.
User DSN State. Toggles whether the user DSN is enabled or disabled. When disabled, it will not be
processed by the agent even if assigned to a user.
DSN Name. T he functional name of the user DSN.
Driver. T he DSN driver. At present, only SQL server DSNs are supported.
Server Name. T he name of the SQL server to which the user DSN is connecting.
Database Name. T he name of the SQL database to which the user DSN is connecting.
Options
Connect Using Specific Credentials. Allows you to specify credentials with which to connect to
the server/database.
Run Once. By default, Workspace Environment Management will create a user DSN every time the
agent refreshes. T ick this box to make Workspace Environment Management only create the user
DSN once, rather than at every refresh. T his speeds up the agent refresh process, especially if you
have many DSNs assigned to your users.
Action Type. Describes what type of action this resource is.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.54
File Associations
Aug 17, 20 17
Controls the creation of file associations in the user environment.
File association list
A list of your existing file associations. You can use Find to filter the list by name or ID against a text string.
To add a file association:
1. Use the context menu Add command.
2. Enter details in the New File Association dialog tabs, then click OK.
Tab
Controls
General
Name. T he display name of the file association, as it appears in the file association list.
Description. T his field is only shown in the edition/creation wizard and allows you to specify
additional information about the resource.
File Association State. Toggles whether the file association is enabled or disabled. When disabled,
it is not processed by the agent even if assigned to a user.
File Extension. Allows you to specify the extension used for this file association.
ProgID. Allows you to specify the extension ProgID.
Action. Allows you to select the action type: open, edit or print.
Target. Allows you to specify the executable used with this file extension.
Command. Allows you to state any specific commands the executable should follow.
Set as Def ault Action. Toggles whether the association is set as a default for that file extension
or not.
Overwrite. Toggles whether or not this file association will overwrite any existing associations for
the specified extension.
Run Once. By default, Workspace Environment Management creates a file association every time
the agent refreshes. T ick this box to make Workspace Environment Management only create the
file association once, rather than at every refresh. T his speeds up the agent refresh process,
especially if you have many file associations assigned to your users.
Options
https://docs.citrix.com
Action Type. Describes what type of action this resource is.
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.55
Filters
Aug 17, 20 17
Filters contains rules and conditions which allow you to make actions available (assign) to users. Set up rules and conditions
before assigning actions to users.
Rules
Conditions
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.56
Rules
Aug 17, 20 17
Rules are composed of multiple conditions. You use rules to define when an action is assigned to a user.
Filter rule list
A list of your existing rules. You can use Find to filter the list by name or ID against a text string
To add a filter rule:
1. Use the context menu Add command.
2. Enter details in the New Filter Rule dialog.
3. Move conditions you want configured in this rule from the Available list to the Conf igured list.
4. Click OK.
Tab
Controls
General
Name. T he display name of the rule, as it appears in the rule list.
Description. T his field is only shown in the edition/creation wizard and allows you to specify
additional information about the rule.
Filter Rule State. Toggles whether the rule is enabled or disabled. When disabled, the agent does
not process actions using this rule even if they are assigned.
Available Conditions. T hese are the filter conditions available to be added to the rule. Note. T he
DateTime filter expects results in the format: YYYY/MM/DD HH:mm
Multiple values can be separated with semicolons (;) and ranges can be separated with hyphens.
When specifying a range between two times on the same date, the date should be included in both
ends of the range, e.g.: 1969/12/31 09:00-1969/12/31 17:00
Configured Conditions. T hese are the conditions already added to the rule.
Note: these conditions are AND statements, not OR statements. Adding multiple conditions
requires them all to trigger for the filter to be considered triggered.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.57
Conditions
Aug 17, 20 17
Conditions are specific triggers which allow you to configure the circumstances under which the agent acts to assign a
resource to a user.
Filter condition list
A list of your existing conditions. You can use Find to filter the list by name or ID against a text string.
To add a filter condition:
1. Use the context menu Add command.
2. Enter details in the New Filter Condition dialog tabs, then click OK.
Tab
Controls
General
Name. T he display name of the condition, as it appears in the condition list and in the rule
creation/edition wizard.
Description. T his field is only shown in the edition/creation wizard and allows you to specify
additional information about the condition.
Filter Condition State. Toggles whether the filter is enabled or disabled. When disabled, it will not
appear in the rule creation/edition wizard.
Filter Condition Type. T he type of filter condition type to use. See Filter conditions. Note: rules
using the Always True condition will always trigger.
Settings. T hese are the specific settings for individual conditions. See Filter conditions.
Note
When entering an IP address, you can either specify individual addresses or ranges.
If you specify a range, both bounds must be specified in full. Use the dash character (-) to separate IP range bounds (e.g.
192.168.10.1-192.168.10.5). Separate multiple ranges or addresses using the semicolon character (;) . For example,
192.168.10.1-192.168.10.5;192.168.10.8-192.168.10;192.168.10.17 is a valid value which includes the ranges .1-.5 and .8-.10,
plus the individual address .17.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.58
Assignments
Aug 17, 20 17
Tip
Before assigning actions to users you need to perform the following steps in the order given:
Configure users, see Users in Active Directory Objects.
Define conditions, see Conditions.
Define filter rules, see Rules.
Configure actions, see Actions Assignment.
Use assignments to make actions available to your users. T his allows you to replace a portion of your users' logon scripts.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.59
Action Assignment
Aug 17, 20 17
Users
T his is your list of configured users and groups (see Users in Active Directory Objects). Double-click a user or group to
populate the assignments menu. You can use Find to filter the list by name or ID against a text string.
Assignments
Allows you to assign actions to the selected user/group. You can use Find to filter the list by name or ID against a text
string.
Available. T hese are the actions available to you to assign to this user or group.
Double-clicking an action or clicking the arrow buttons will assign/unassign it. When you assign an action, you are
prompted to select the rule you wish to use to contextualize it.
Assigned. T hese are the actions already assigned to this user or group. You can expand individual actions to configure
them (application shortcut locations, default printers, drive letter, and so on).
To assign actions to users/groups:
1. In the Users list, double-click on a user/group. T his populates the Assignments lists.
2. In the Available list, select an action and click the right-arrow (>) button.
3. In the Assign Filter dialog, select a Filter Rule and click OK.
4. In the Assigned list, you can use the Enable and Disable context actions to fine-tune the behaviour of the
assignment.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.60
Modelling Wizard
Aug 17, 20 17
T he Actions Modelling Wizard displays the resultant actions for a given user only (it does not work for groups).
Pane
Controls
1
Actions Modelling Target User: You can Select the account name for the user you wish to model.
2
Resultant Actions. T he actions assigned to the user (whether individually or to groups the user
belongs to).
User Groups. T he groups the user belongs to.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.61
System optimization
Aug 17, 20 17
T hese settings allow you to optimize applications and desktops.
Fast Logoff
CPU Management
Memory Management
I/O Management
Process Management
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.62
Fast Logoff
Aug 17, 20 17
Settings
Enable Fast Logof f . Enables fast logoff for all users on this site. Fast logoff logs users out instantly while continuing to
perform logoff tasks in the background. Note Fast Logoff works with XenApp/RDS resources only.
Exclude Specific Groups. Allows you to exclude specific groups of users from fast logoff.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.63
CPU Management
Aug 17, 20 17
T hese settings allow you to optimize CPU usage.
CPU Management Settings
T hese settings control global CPU optimization.
Enable CPU Spikes Protection. T his setting will prevent all processes from taking more than a percentage of the server's
processing power by lowering their priority.
CPU Usage Limit. T his is the percentage of CPU utilization that will trigger CPU spike protection. Please note that
this is a total percentage across all cores.
Limit Sample Time. T his is the duration over which a process must exceed the CPU Usage Limit for its priority to be
lowered.
Idle Priority Time. T his is the length of time for which the process' priority is lowered.
Limit CPU/Core Usage. If enabled, processes that trigger CPU Spike Protection are also confined to the selected number
of cores (CPU/Core Usage Limit) while Spike Protection is triggered.
Enable Intelligent CPU Optimization. If enabled, the agent keeps a list of processes that have triggered spike protection
and intelligently optimizes process CPU priority based on that process history. Processes that repeatedly trigger spike
protection are assigned lower CPU priority at launch than processes that behave correctly.
Enable Intelligent I/O Optimization. If enabled, the agent keeps a list of processes that have triggered spike protection
and intelligently optimizes process I/O priority based on that process history. Processes that repeatedly trigger spike
protection are assigned lower I/O priority at launch than processes that behave correctly.
Exclude Specified Processes. Excludes processes from CPU spike protection by executable name (e.g. notepad.exe).
CPU Priority
Enable Process Priority. If enabled, this allows you to manually set process priority for specified processes.
CPU Af finity
Enable Process Af finity. If enabled, this allows you to manually set process affinity for specified processes.
CPU Clamping
T hese settings allow you to forcefully prevent named processes from using more than X% of the CPU. Note T he clamping
percentage is global, not per core (that is, 10% on a quad-core CPU is 10%, not 10% of one core).
Enable Process Clamping. Toggles whether process clamping is enabled or not.
Add. Add the process by executable name (for example, notepad.exe).
Remove. Deletes the highlighted process from the clamping list.
Edit. Allows you to edit the values entered for a given process.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.64
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.65
Memory Management
Aug 17, 20 17
T hese settings allow you to optimize application memory usage.
Enable Working Set Optimization. Toggles whether WSO is enabled or not. When enabled, applications that are idle (have
not been interacted with by a user) for a certain time are forced to release excess memory until they are no longer idle.
Idle Sample Time. T ime in minutes for which an application must be idle before it is forced to release excess memory.
Idle State Limit. T he CPU usage threshold under which a process is considered idle.
Exclude Specified Processes. Allows you to exclude processes from memory management by name (for example,
notepad.exe).
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.66
I/O Management
Aug 17, 20 17
T hese settings allow you to optimize I/O usage.
I/O Priority
Enable Process I/O Priority. If enabled, this allows you to manually set I/O priority for specified processes.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.67
Policies and profiles
Aug 17, 20 17
T hese settings allow you to replace user GPOs and configure user profiles.
Environmental Settings
Microsoft USV Settings
Citrix Profile Management Settings
VMware Persona settings
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.68
Environmental Settings
Aug 17, 20 17
T hese options modify the user's environmental settings. Some or the options are processed at logon, while some others
can be refreshed in session with the agent refresh feature.
T hese options modify the user's Start Menu.
Process Environmental Settings. T his checkbox toggles whether or not the agent processes environmental settings. If it
is cleared, no environmental settings are processed.
Exclude Administrators. If enabled, environmental settings are not processed for administrators, even if the agent is
launched.
User Interf ace: Start Menu. T hese settings control which Start Menu functions are disabled by the agent.
User Interf ace: Appearance. T hese settings allow you to customize the user's Windows theme and desktop. Paths to
resources must be entered as they are accessed from the user's environment.
User Interf ace: Desktop. T hese settings control which desktop elements are disabled by the agent.
User Interf ace: Edge UI. T hese settings allow you to disable aspects of the Windows 8.x Edge user interface.
T hese settings control which Windows Explorer functionalities are disabled by the agent.
User Interf ace: Explorer. T hese options allow you to disable access to regedit or cmd, and hide certain elements in
Windows Explorer.
Hide Specified Drives. If enabled, the listed drives are hidden from the user's My Computer menu. T hey are still accessible if
browsed to directly.
Restrict Specified Drives. If enabled, the listed drives are blocked. Neither the user nor their applications can access them.
Hide Control Panel. T his option is enabled by default to secure the user environment. If disabled, the user has access to his
Windows control panel.
Show only specified Control Panel Applets. If enabled, all control panel applets except the ones listed here are hidden
from the user. Additional applets are added using their canonical name.
Hide specified Control Panel Applets. If enabled, only the listed control panel applets are hidden. Additional applets are
added using their canonical name.
See Common Control Panel applets along with their canonical names.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.69
Disable Specified Known Folders. Prevents the creation of the specified user profile known folders at profile creation.
User Environment: Advanced Tuning. T hese options allow you to optimize performance in SBC/HVD environments.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.70
Microsoft USV Settings
Aug 17, 20 17
T hese settings allow you to optimize Microsoft User State Virtualization (USV).
T hese settings allow you to configure Workspace Environment Management's integration with Microsoft roaming profiles.
Process USV Configuration. Controls whether or not the agent processes USV settings. If it is cleared, no USV settings are
processed.
Set Windows Roaming Profile Path. T he path to your Windows profiles.
Set RDS Roaming Profiles Path. T he path to your RDS roaming profiles.
Set RDS Home Drive Path. T he path to your RDS home drive, as well as the drive letter it will appear with in the user
environment.
T hese are the advanced roaming profile optimization options.
Enable Folder Exclusions. If enabled, the listed folders are not included in a user’s roaming profile. T his allows you to
exclude specific folders known to contain large amounts of data which the user does not need to have as part of their
roaming profile. T he list is pre-populated with default Windows 7 exclusions, and can be pre-populated with default
Windows XP exclusions instead.
Delete Cached Copies of Roaming Profiles. If enabled, the agent deletes cached copies of the roaming profiles.
Add Administrators Security Group to Roaming User Profiles. If enabled, the Administrators group is added as owner to
roaming user profiles.
Do Not Check f or User Ownership of Roaming Profiles Folders. If enabled, the agent does not check to see if the user
owns the roaming profiles folder before acting.
Do Not Detect Slow Network Connections. If enabled, connection speed detection is skipped.
Wait f or Remote User Profile. If enabled, the agent waits for the remote user profile to be fully downloaded before
processing its settings.
Profile Cleansing. Opens the Profiles Cleanser wizard, which allows you to clean up existing profiles.
Cleanse Profiles. T his button cleans the selected profiles per the Folder Exclusion settings.
Scan Profiles Folder. Scans the specified folder with the specified recursion settings to find user profiles, then displays
all profiles found.
Profiles Root Folder. T he root folder of your user profiles. You can also Browse to this folder if you wish.
Search Recursion. Controls how many levels of recursion the user profile search will go through.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.71
Process Folder Redirection Configuration. T his checkbox toggles whether or not the Agent will process folder
redirections. If it is cleared, no folder redirections are processed. Select the options here to controls whether and where the
user's folders are redirected.
Delete Local Redirected Folders. If enabled, the Agent will delete the local copies of the folders selected for redirection.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.72
Citrix Profile Management Settings
Aug 17, 20 17
T hese settings control Workspace Environment Management's integration with Citrix Profile Management technology.
Workspace Environment Management supports Profile Management up to and including version 7.15.
Note Some options only work with specific versions of UPM; please consult the relevant Citrix documentation for detailed
instructions.
T hese settings control the main Citrix Profile Management parameters.
Enable Profile Management Configuration. T his checkbox toggles whether or not the agent processes Citrix Profile
Management settings. If cleared, none of the Profile Management settings are processed.
Enable Profile Management. T his checkbox toggles whether or not the agent processes the settings in the Profile
Management section of this page. If disabled, the agent does not process any of these.
Set processed groups. Allows you to specify which groups are processed by Profile Management. Only the specified
groups have their Profile Management settings processed. If left blank, all groups are processed.
Set excluded groups. Allows you to specify which groups are excluded from Profile Management.
Process logons of local administrators. If enabled, local administrator logons are treated the same was as non-admin
logons for Profile Management.
Set path to user store. T his field allows you to specify the path to the user store directory.
Enable active write back. If enabled, profiles are written back to the user store during the user's session. T his helps
prevent data loss.
Enable Of fline profile support. If enabled, profiles are cached locally for use while not connected.
Enable active write back registry. If enabled, registry entries are written back to the user store during the user's session.
T his helps prevent data loss.
T hese settings control Profile Management profile handling.
Delete local cached profiles on logof f . If enabled, locally-cached profiles are deleted when the user logs off.
Set delay bef ore deleting cached profiles. Allows you to specify a delay (in seconds) before cached profiles are deleted
at log-off.
Enable Migration of Existing Profiles. If enabled, existing Windows profiles are migrated to Profile Management at login.
Enable local profile conflict handling. T his setting configures how Citrix Workspace Environment Management handles
cases where Profile Management and Windows profiles conflict.
Enable template profile. If enabled, this will use a template profile at the indicated location.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.73
Template profile overrides local profile. If enabled, the template profile will override local profiles.
Template profile overrides roaming profile. If enabled, the template profile will override roaming profiles.
Template profile used as Citrix mandatory profile f or all logons. If enabled, the template profile will override all other
profiles.
T hese options control advanced UPM settings.
Set number of retries when accessing locked files. Configures the number of times the Agent will retry accessing locked
files.
Set Directory of MFT cache file. Allows you to specify the MFT cache file directory.
Process Internet cookie files on logof f . If enabled, stale cookies are deleted at logoff.
Delete redirected f olders. If enabled, will delete local copies of redirected folders.
Disable automatic configuration. If enabled, dynamic configuration will be disabled.
Log of f user if a problem is encountered. If enabled, users are logged off rather than switched to a temporary profile if
a problem is encountered.
Customer experience improvement program. If enabled, Profile Management uses the Customer Experience
Improvement Program (CEIP) to help improve the quality and performance of Citrix products by collecting anonymous
statistics and usage information. For more information on the CEIP, see About the Citrix Customer Experience Improvement
Program (CEIP).
T hese options control Profile Management logging.
Enable Logging. Enables/disables logging of Profile Management operations.
Configure Log Settings. Allows you to specify which types of events to include in the logs.
Set Maximum Size of Log File. Allows you to specify a maximum size in bytes for the log file.
Set Path to Log File. Allows you to specify the location at which the log file will be created.
T hese options control Profile Management registry settings.
NTUSER.DAT Backup. If selected, Profile Management maintains a last known good backup of the NT USER.DAT file. If
Profile Panagement detects corruption, it uses the last known good backup copy to recover the profile.
Enable Def ault Exclusion List. Default list of registry keys in the HKCU hive that are not synchronized to the user's profile.
If selected, registry settings which are selected in this list are forcibly excluded from Profile Management profiles.
Enable Registry Exclusions. Registry settings in this list are forcibly excluded from Profile Management profiles.
Enable Registry Inclusions. Registry settings in this list are forcibly included in Profile Management profiles.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.74
T hese options control file system exclusions for Profile Management.
Enable Logon Exclusion Check. If enabled, configures what Profile Management does when a user logs on when a profile
in the user store contains excluded files or folders. (If disabled, the default behavior is Synchronize excluded files or
f olders). You can select one of the following behaviors in the list:
Synchronize excluded files or f olders (default). Profile Management will synchronize these excluded files or folders
from the user store to local profile when a user logs on
Ignore excluded files or f olders. Profile Management ignores the excluded files or folders in the user store when a
user logs on.
Delete excluded files or f older. Profile Management deletes the excluded files or folders in the user store when a
user logs on.
Enable Def ault Exclusion List - Directories. Default list of directories ignored during synchronization. If selected, folders
which are selected in this list are excluded from the Profile Management synchronization.
Enable File Exclusions. If enabled, the listed files are not included in a user's Profile Management profile. T his allows you to
exclude specific folders known to contain large amounts of data which the user does not need to have as part of their
Profile Management profile. T he list is pre-populated with default Windows 7 exclusions, and can be pre-populated with
default Windows XP exclusions instead.
Enable Folder Exclusions. If enabled, the listed folders are not included in a user's Profile Management profile. T his allows
you to exclude specific folders known to contain large amounts of data which the user does not need to have as part of
their Profile Management profile. T he list is pre-populated with default Windows 7 exclusions, and can be pre-populated
with default Windows XP exclusions instead.
Profile Cleansing. Opens the Profile Cleansing wizard, which allows you to clean up existing profiles.
Profiles Root Folder. T his field allows you to specify the root folder of your user profiles. You can also Browse to this
folder if you wish.
Search Recursion. T his setting controls how many levels of recursion the user profile search will go through.
Scan Profiles Folder. Will scan the specified folder with the specified recursion settings to find user profiles, then will
display all profiles found.
Cleanse Profiles. T his button will cleanse the selected profiles per the Folder Exclusion settings.
T hese options control Profile Management synchronization settings.
Enable Directory Synchronization. If enabled, the listed folders are synchronized with the profile store at refresh.
Enable File Mirroring. If enabled, the listed files are mirrored to the profile store, ensuring users always get the most up-todate versions of these files.
Enable Folder Mirroring. If enabled, the listed folders are mirrored to the profile store, ensuring users always get the most
up-to-date versions of these folders.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.75
T hese options control streamed user profile settings.
Enable Profile Streaming. If disabled, none of the settings in this section are processed.
Always cache. If enabled, files of the specified size (in megabytes) or larger will always be cached.
Set timeout f or pending area lock files: frees up files so they are written back to the user store from the pending area
after the specified time, in the event that the user store remains locked when a server becomes unresponsive.
Set streamed user profile groups. T his list determines which user groups streamed profiles are used for.
Enable Profile Streaming Exclusion List - Directories. If selected, Profile Management does not stream folders in this list,
and all the folders are fetched immediately from the user store to the local computer when users log on.
T hese options control cross-platform settings.
Enable cross-platf orm settings. If disabled, none of the settings in this section are processed.
Set cross-platf orm settings groups. Allows you to specify the user groups for which cross-platform profiles are used.
Set path to cross-platf orm definitions. Allows you to specify the path to your cross-platform definition files.
Set path to cross-platf orm setting store. Allows you to specify the path to your cross-platform setting store.
Enable source f or creating cross-platf orm settings. Enables a source platform for cross-platform settings.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.76
VMware Persona settings
Aug 17, 20 17
T hese settings control Workspace Environment Management's integration with VMware View Persona Management.
Please note that some options only work with specific versions of View Persona Management; please consult the relevant
VMware documentation for detailed instructions.
T hese settings control the main Persona parameters.
Enable VMware Persona Settings Management. T his checkbox controls whether the Agent processes Persona settings
management instructions. If it is cleared, none of the Persona settings are processed.
Manage User Persona. When enabled, the user's persona settings are managed dynamically. T he profile upload interval is
used to determine how often to upload profile changes to the network.
Enable Persona Repository Location. T his setting controls the UNC path to the repository where user profiles are stored.
Override Active Directory User Profile Path. If enabled, the AD user profile path is overridden with the Persona
repository location if both have been configured.
Remove Local Persona at Logof f . When enabled, each user's locally stored profile is removed at log off.
Remove Locally Stored Personas When Users Log Of f . If enabled, Local Settings and AppData\Local are deleted
when the persona is removed.
Roam Local Settings Folders. When enabled, the local settings folders are roamed along with the rest of the user's profile.
Enable Background Download f or Laptops. When enabled, laptop users are allowed to background download their
profile.
Cleanup CLFS Files. If enabled, CLFS logs are removed at logoff.
Hide Local Of fline File Icon. When enabled, the offline icon is hidden when locally viewing most offline persona files.
Show Progress When Downloading Large Files. When enabled, a progress window is shown when downloading large files
from the persona repository. T he minimum file size required to show the progress window can be specified as well.
Show Critical Errors to Users. When enabled, critical tray icon alerts pertaining to replication or network connectivity
failure are displayed to the user.
Set Logging Filename. T he full pathname of the local View Persona Management log file. T his path should include the file
name, and cannot be a UNC path.
Set Logging Destination. T hese settings allow you to specify whether to send log messages to the local log file or the
debug port.
Set Logging Flags. T hese settings allow you to control what messages are logged.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.77
Set Debug Flags. T hese settings allow you to control what messages are logged in debug mode.
Enable Files and Folders to Preload. When enabled, the selected file and folder paths are downloaded at user logon and
replicated when files are changed. Exceptions can also be configured.
Enable Windows Roaming Profile Synchronisation. When enabled, the selected file and folder paths are downloaded at
user logon and replicated during logoff. Exceptions can also be configured.
Enable Files and Folders Excluded f rom Roaming. When enabled, the selected file and folder paths are completely
excluded from roaming. Exceptions can also be configured to select subfolders and files within the folders excluded from
roaming that need to be roamed.
Enable Folders to Background Download. When enabled, the selected file and folder paths are downloaded in the
background after users log on. Exceptions can also be configured.
Enable Excluded Processes. When enabled, the selected processes' I/O is ignored by Persona.
T hese settings allow you to configure redirection for individual user profile folders.
Enable Files and Folders Excluded f rom Redirection. When enabled, the selected file and folder paths are completely
excluded from redirection. Exceptions can also be configured to select subfolders and files within the folders excluded from
redirection that need to be redirected.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.78
Active Directory Objects
Aug 17, 20 17
Use this page to specify the users, computers, groups, and organizational units you want to be managed by Workspace
Environment Management.
Note
Users, computers, groups and OUs must be added to Workspace Environment Management before the agent manages them.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.79
Users
Aug 17, 20 17
A list of your existing users and groups. You can use Find to filter the list by name or ID against a text string.
To add a user:
1. Use the context menu Add command.
2. Enter a user or group name in the Windows Select Users dialog, then click OK.
Name. T he name of the user or group.
Description. T his field is only shown in the Edit Item dialog and allows you to specify additional information about
the user or group.
Item Priority. T his allows you to configure priority between different groups and user accounts. In case of conflict
(for example, when mapping network drives), the group or user account with the higher priority will win out.
Item State. T his allows you to choose whether a user/group is enabled or disabled. If disabled, it is not available to
assign actions to.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.80
Machines
Aug 17, 20 17
A list of computers which have been added to the current site (configuration set). Only computers listed here are managed
by Workspace Environment Management. When agents on these computers register with the infrastructure server it sends
them the necessary machine-dependent settings for the configuration set. You can use Find to filter the list by name or ID
against a text string.
Tip
To check whether agents on these machines are correctly registered with the infrastructure server, see Agents in the Administration
section.
To add a computer or computer group to the current site (configuration set):
1. Use the Add Object context menu command or button.
2. In the Select Computers or Groups dialog, select a computer or computer group, then click OK.
To add computers in an organizational unit to the site (configuration set):
1. Use the Add OU context menu command or button.
2. In the Organizational Units dialog, select an organizational unit, then click OK.
To edit computer, computer group, or OU details:
1. Select an item in the list.
2. Use the Edit context menu command or button.
3. In the Edit item dialog, any of the following details (which are not read-only), then click OK.
Name*. T he computer, computer group, or OU name.
Distinguished Name*. T he distinguished name (DN) of the selected computer or computer group. T his field allows
you to differentiate different OUs if they have the same Name.
Description. Additional information about the computer, computer group, or OU.
Type*. T he selected type (Computer, Group or Organizational Unit).
Item State. T he state of the computer, computer group, or OU (enabled or disabled). If disabled, the computer,
computer group, or OU is not available to assign actions to.
Item Priority. T he priority of the computer, computer group, or OU. In cases of conflict (for example, when mapping
network drives), the machine or OU with the higher priority wins.
* Read-only details from Active Directory.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.81
Security
Aug 17, 20 17
T hese settings allow you to control end-user activity within Workspace Environment Management.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.82
Process Management
Aug 17, 20 17
T hese settings allow you to whitelist or blacklist specific processes.
Enable Process Management. T his toggles whether process whitelists/blacklists are in effect. If disabled, none of the
settings on the Process BlackList and Process WhileList tabs are taken into account.
Note
T his option only works if the session agent is running in the user's session. To do this use the Main Configuration Agent settings
to set the Launch Agent options (at Logon/at Reconnect/f or Admins) to launch according to the user/session type, and set
Agent Type to "UI". T hese options are described in Advanced Settings Configuration.
T hese settings allow you to blacklist specific processes.
Enable Process Blacklist. T his enables process blacklisting. Processes must be added by executable name (for example,
cmd.exe).
Exclude Local Administrators. Excludes local administrator accounts from the process blacklisting.
Exclude Specified Groups. Allows you to exclude specific user groups from process blacklisting.
T hese settings allow you to whitelist specific processes. Process blacklists and process whitelists are mutually exclusive.
Enable Process Whitelist. T his enables process whitelisting Processes must be added by executable name (for example,
cmd.exe). Note If enabled, Enable Process Whitelist automatically blacklists all processes not in the whitelist.
Exclude Local Administrators. Excludes local administrator accounts from the process whitelisting (they are able to run all
processes).
Exclude Specified Groups. Allows you to exclude specific user groups from process whitelisting (they are able to run all
processes).
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.83
Transformer settings
Aug 17, 20 17
T hese options allow you to configure the Transformer feature. Transformer allows agents to connect as web/application
launchers which redirect users to the configured remote desktop interface.
General
Advanced
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.84
General
Aug 17, 20 17
T hese settings control the appearance and basic settings for Transformer.
Enable Transf ormer. If you enable this option, Agent Hosts connected to this site will automatically go into kiosk mode.
While in kiosk mode, the Agent Host becomes a web/application launcher which will redirect the user to the configured
remote desktop interface. T he user environment can be completely locked down and the user only allowed to interact with
the Agent. If you disable this option, none of the settings in either the General or Advanced pages are processed.
Web Interf ace URL. T his URL is used as the web frontend for the user's virtual desktop. T his should be the access URL for
your XenDesktop or XenApp environment,
Custom Title. If enabled, the Citrix Workspace Environment Management Agent kiosk window is given a custom title-bar.
Enable Window Mode. If enabled, the Citrix Workspace Environment Management Agent kiosk will start in windowed
mode. T he user will still be locked out of their Windows environment.
Allow Language Selection. If enabled, users are allowed to pick what language the Transformer interface is in.
Show Navigation Buttons. If enabled, the "Forward", "Back" and "Home" web navigation buttons display on the Agent
kiosk window. "Home" sends users back to the web interface URL defined above.
Display Clock. If enabled, displays a clock in the Transformer UI.
Show 12 Hour Clock. By default, the Transformer clock is a 24-hour clock. If enabled, this will instead display a 12hour clock (AM/PM).
Enable Application Panel. If enabled, this will display a panel with the user's applications as assigned in Citrix Workspace
Environment Management.
Auto-Hide Application Panel. If enabled, the application panel auto-hides itself when not in use.
Change Unlock Password. T his option allows you to specify the password that can be used to unlock the user's
environment by pressing Ctrl+Alt+U. T his is designed to allow administrators and support agents to troubleshoot the user
environment without restrictions.
Enable Site List. If enabled, this option adds a list of URLs to the kiosk interface.
Enable Tool List. If enabled, this option adds a list of tools to the kiosk interface.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.85
Advanced
Aug 17, 20 17
T hese options allow you to turn the Citrix Workspace Environment Management Agent kiosk mode into a process launcher
rather than presenting a web interface.
Enable Process Launcher. If enabled, this option will put the Citrix Workspace Environment Management Agent into
process launcher mode. While in process launcher mode, the Citrix Workspace Environment Management Agent will launch
the process specified in Process Command Line. If terminated, the process will simply be re-launched.
Process Command Line. T his field allows you to enter the command line for a specific process (for example, the path to
mstsc.exe to launch an RDP connection).
Process Arguments. T his field allows you to specify any arguments to the command line listed above (for example, in the
case of mstsc.exe, the IP address of the machine to connect to).
Fix Browser Rendering. If enabled, this will force IE to run in IE7 compatibility mode.
Log Of f Screen Redirection. If enabled, this will automatically redirect the user to the logon page whenever they land on
the logoff page.
Suppress Script Errors. If enabled, the Agent will suppress any script errors it encounters.
Fix SSL Sites. If enabled, hides SSL warnings entirely.
Hide Kiosk While in Citrix Session. If enabled, the Citrix Workspace Environment Management Agent kiosk is hidden while
the user is connected to their Citrix session.
Always Show Admin Menu. If enabled, will display the kiosk admin menu at all times – this gives all users access to the
kiosk admin menu.
Hide Taskbar & Start Button. If enabled, this will hide the user's taskbar and start menu; otherwise, the user will still be
able to access their desktop.
Lock Alt-Tab. If enabled, this will ignore alt tab commands, preventing the user from switching away from the Agent.
Fix Z-Order. If enabled, adds a "hide" button to the kiosk interface that allows the user to push the kiosk to the
background.
Administration Settings. By default, the Citrix Workspace Environment Management Agent kiosk mode allows the user to
control some aspects of the underlying OS. T hese options allow you to disable these features.
Pre-Launch Receiver. If enabled, the Agent will launch Receiver and wait for it to load before bringing up the kiosk mode
window.
Disable Unlock. If enabled, the Agent cannot be unlocked via the Ctrl+Alt+U unlock shortcut.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.86
Enable Auto-Logon Mode. If enabled, users are automatically logged on into the desktop environment by the Agent,
bypassing the Windows login screen.
Log Of f Web Portal When Session is Launched. If enabled, the web frontend specified in the General Settings page is
logged off when the user's desktop session is launched.
End of Session Options. T his allows you to specify which action the Agent should take with the environment it is running
in when the user ends their session.
Shut Down at Specified Time. If enabled, the Agent will automatically shut off the environment it is running in at the
specified local time.
Shut Down When Idle. If enabled, the Agent will automatically shut off the environment it is running in after running idle
(no user input) for the specified length of time.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.87
Advanced settings
Aug 17, 20 17
T hese settings modify how and when the agent processes actions.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.88
Configuration
Aug 17, 20 17
T hese options control basic Agent behaviour.
Agent Actions. T hese settings determine whether or not the agent processes actions configured in the Actions tab. T hese
settings apply at login, automatic refresh, or manual (user or administrator triggered) refresh.
Process Applications. When selected, the agent processes application actions.
Process Printers. When selected, the agent processes printer actions.
Process Network Drives. When selected, the agent processes network drives actions.
Process Virtual Drives. When selected, the agent processes virtual drive actions. (Virtual drives are Windows virtual
drives or MS-DOS device names which map a local file path to a drive letter.)
Process Registry Values. When selected, the agent processes registry entry actions.
Process Environment Variables. When selected, the agent processes environment variable actions.
Process Ports. When selected, the agent processes port actions.
Process Ini Files Operations. When selected, the agent processes .ini file actions.
Process External Tasks. When selected, the agent processes external task actions.
Process File System Operations. When selected, the file system operation actions.
Process File Associations. When selected, the agent processes file association actions.
Process User DSNs. When selected, the agent processes user DSN actions.
Agent Service Actions. T hese settings determine when the agent service processes its instructions.
Launch Agent at Logon. Determines whether or not the agent runs at logon.
Launch Agent at Reconnect. Determines whether or not the agent runs when reconnecting to a published desktop.
Launch Agent f or Admins. Determines whether agent runs when a user is an administrator.
Agent Type. Determines whether the user is presented with a user interface (UI) or not (CMD) when interacting with
the Agent.
Enable (Virtual) Desktop Compatibility. T his setting is necessary for the agent to be launched when the user is
logged in to session 1. If you have any users on physical desktops or VDI, select this option.
Execute only CMD Agent in Published Applications. If enabled, the agent will launch in command line mode (CMD)
when launching a published application, rather than in UI mode. CMD mode displays a command prompt instead of an
agent splash screen.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.89
T hese settings determine whether or not the agent performs an environment cleanup on refresh.
Shortcut Deletion at Startup. T he agent deletes all shortcuts of the selected type whenever it refreshes.
Delete Network Drives at Startup. If enabled, the agent deletes all network drives whenever it refreshes.
Delete Network Printers at Startup. If enabled, the agent deletes all network printers whenever it refreshes.
Preserve Auto-created Printers. If enabled, the agent does not delete auto-created printers.
Preserve Specific Printers. If enabled, the agent does not delete any of the printers in this list.
T hese options control the agent settings.
Enable Agent Logging. Enables the agent log file.
Log File. T he log file location. By default, this is the profile root of the logged-in user.
Debug Mode. T his enables verbose logging for the agent.
Enable Of fline Mode. If this is disabled, the agent does not fall back on its cache if it cannot connect to the infrastructure
service. Note In order for Offline Mode to work, SQL Server Compact Edition 3.5 SP2 must be installed in the user
environment and on the Workspace Environment Management infrastructure server.
Use Cache Even if Online. If enabled, the agent always reads its settings and actions from its cache (which is built
whenever the agent service cycles).
Ref resh Settings. If enabled, the agent triggers a Windows refresh when an agent refresh occurs.
Ref resh on Environmental Setting Change. If enabled, the agent triggers a Windows refresh when an environmental
setting is modified.
Asynchronous Printer Processing. If enabled, the agent processes printers asynchronously from other actions.
Asynchronous Network Drive Processing. If enabled, the agent processes network drives asynchronously from other
actions.
Initial Environment/Desktop Cleanup. If enabled, the agent cleans up the environment/desktop at first login only.
Check Application Existence. If enabled, the agent checks that an application is available to the user/group before
creating a shortcut to that application.
Expand App Variables. If enabled, variables are expanded by default (see Environment variables for normal behavior when
the agent encounters a variable).
Enable Cross-Domain User Group Search. If enabled, the agent queries user groups in all Active Directory domains. Note:
T his is an extremely time-intensive process which should only be selected if necessary.
Broker Service Timeout. T he timeout value after which the agent switches to its own cache, when it fails to connect to
the infrastructure service. T he default value is 2000 milliseconds.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.90
Directory Services Timeout. T he timeout value for directory services on the Agent Host machine, after which the agent
uses its own internal cache of user group associations. T he default value is 2000 milliseconds.
Network Resources Timeout. T he timeout value for resolving network resources (network drives or file/folder resources
located on the network), after which the agent considers the action has failed. T he default value is 500 milliseconds.
Agent Max Degree of Parallelism. T he maximum number of threads the agent can use. Default value is 0 (as many
threads as physically allowed by the processor), 1 is single-threaded, 2 is dual-threaded, etc. In most cases this value does
not need changing.
Enf orce Execution of Agent Actions. If these settings are enabled, the Agent Host will always refresh those actions,
even if no changes have been made.
Revert Unassigned Actions. If these settings are enabled, the Agent Host will delete any unassigned actions when it next
refreshes.
Automatic Ref resh. If enabled, the Agent Host will refresh automatically. By default, the refresh delay is 30 minutes.
Action Processing on Reconnection. T hese settings control what actions the Agent Host processes upon reconnection
to the user environment.
Filter Processing Enf orcement. If enabled, these options will force the Agent Host to re-process filters at every refresh.
T hese settings configure the Agent Host service.
Agent Cache Ref resh Delay. T his setting controls how long the Agent Host service will wait to refresh its cache.
SQL Settings Ref resh Delay. T his setting controls how long the Agent Host service will wait to refresh its SQL connection
settings.
Agent Extra Launch Delay. T his setting controls how long the Agent Host service will wait to launch the Agent Host
executable.
Enable Debug Mode. T his enables verbose logging for all Agent Hosts connecting to this site.
Bypass ie4 uinit Check. By default, the Agent Host service will wait for ie4uinit to run before launching the Agent Host
executable. T his setting forces the Agent Host service to not wait for ie4uinit.
Agent Launch Exclusions. If enabled, the Citrix Workspace Environment Management Agent Host will not be launched for
any user belonging to the specified user groups.
Forbidden Drives. Any drive letter added to this list is excluded from the drive letter selection when assigning a drive
resource.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.91
UI Agent Personalization
Aug 17, 20 17
T hese options allow you to personalize the look and feel of the Citrix Workspace Environment Management session agent
in UI mode, as well as help desk and self-service facilities.
Note
T hese options apply to the session agent in UI mode only. T hey do not apply to the session agent in CMD mode.
T hese settings let you customize the appearance of the session agent (in UI mode only) in the user's environment.
Custom Background Image Path. If entered, will display a custom image when the session agent launches/refreshes,
rather than the Citrix Workspace Environment Management logo. T he image used must be accessible from the user
environment. It is recommended you use a 400*200px .bmp file.
Loading Circle Color. Allows you to modify the color of the loading circle to fit your custom background.
Text Label Color. Allows you to modify the color of the loading text to fit your custom background.
UI Agent Skin. Allows you to select a preconfigured skin to use for dialogs and self service forms (printers/applications).
Note: T his does not change the splash screen.
Hide Agent Splashscreen. If enabled, hides the splash screen when the session agent is loading/refreshing. T his takes
effect after the session agent has refreshed while the setting is enabled.
Hide Agent Icon in Published Applications. If enabled, published applications do not show the Citrix Workspace
Environment Management session agent.
Hide Agent Splashscreen in Published Applications. If enabled, hides the session agent splash screen for published apps
running through it.
Only Admins Can Close Agent. If enabled, only administrators can shut down the Citrix Workspace Environment
Management session agent.
Allow Users to Manage Printers. If enabled, users can access the Citrix Workspace Environment Management session
agent Manage Printers menu to assign a default printer and modify print preferences.
Allow Users to Manage Applications. If enabled, users can access the Citrix Workspace Environment Management
session agent Manage Applications menu to manage where their application shortcuts are created. Shortcuts created in
self-healing mode cannot be deleted using this menu.
Prevent Admins to Close Agent. If enabled, administrators cannot shut down the Citrix Workspace Environment
Management session agent.
Enable Applications Shortcuts. If enabled, users can run applications from the Manage Applications menu.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.92
Disable Administrative Ref resh Feedback. When Administrators force a session agent to refresh from the Administration
Console, this options prevents a notification tooltip appearing in the user environment.
T hese options control the Agent Host's help desk functionalities.
Help Link Action. T his field controls what happens when the user clicks on the Help command in the Citrix Workspace
Environment Management Agent Host.
Custom Link Action. T his field controls what happens when the user clicks on the Support command in the Citrix
Workspace Environment Management Agent Host.
Enable Screen Capture. If enabled, users are given the option to open a screen capture utility. T his allows the user to
screenshot any errors in their environment, which they can then send to your support staff.
Enable Send to Support Option. If enabled, the user is able to send screenshots and log files directly to the
nominated support email address, with the specified template. T his requires a working, configured email client.
Custom Subject. If enabled, the support email generated by the Citrix Workspace Environment Management Agent
Host screen capture utility is sent with the specified subject.
Email Template. T his field allows you to specify a template for the support email generated by the Citrix Workspace
Environment Management Agent Host screen capture utility. Note You must configure the email template to include
useful information.
See Dynamic tokens for a list of hash-tags which can be used in the email template. Note Users are only presented
with the option to enter a comment if the ##UserScreenCaptureComment## hash-tag is included in the email
template.
Use SMTP to Send Email. If enabled, this will send the support email using SMT P instead of MAPI.
Test SMTP. Tests your SMT P settings as entered above to verify that they are correct.
Shut Down At Specified Time. If enabled, the Agent Host will automatically shut off the environment it is running in at
the specified local time.
Shut Down When Idle. If enabled, the Agent Host will automatically shut off the environment it is running in after running
idle (no user input) for the specified length of time.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.93
Administration
Aug 17, 20 17
T hese settings control administrative functions such as delegation, user statistics, and change logging.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.94
Administrators
Aug 17, 20 17
T hese options allow you to define Workspace Environment Management administrators (users or groups) and give them
permissions to access sites (configuration sets) via the administration console.
Configured Administrators List
A list of configured administrators showing their permission level (Full Access, Read Only or Granular Access, see details
below). You can use Find to filter the list by name or ID against a text string.
To add an administrator:
1. Use the context menu Add command.
2. Enter details in the Select Users or Groups dialog, then click OK.
Name. T he name of the user or group you are currently editing.
Description. Additional information about the user or group.
Global Administrator. Select to specify that the selected user/group is a Global Administrator. Clear to specify that
the selected user/group is a Site Administrator. Global Administrators have their permissions applied to all sites
(configuration sets). Site Administrators have their permissions configured on a per-site basis.
Permissions. T his allows you to specify one of the following levels of access to the selected user/group. Note:
Administrators can only view settings which they have access to.
Full Access administrators have full control over every aspect of the specified sites (configuration sets). Only
Global Administrators with Full Access can add/delete Workspace Environment Management administrators.
Only Global Full Access and Global Read Only administrators can see the Administration tab.
Read Only administrators can view the entire console, but cannot modify any settings at all. Only Global Full
Access and Global Read Only administrators can see the Administration tab.
Granular Access indicates that the administrator has one or more of the following permission sets:
Action Creators can create and manage actions.
Action Managers can create, manage, and assign actions. T hey cannot edit or delete actions.
Filter Managers can create and manage conditions and rules. Rules that are in use on assigned
applications cannot be edited or deleted by Filter Managers.
Assignment Managers can assign resources to users or groups.
System Utilities Managers can manage the System Utilities settings (CPU, RAM and process
management).
Policies and Profiles Managers can manage Policies and Profiles settings.
Configured Users Managers can add, edit, and remove users or groups from the configured users list.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.95
Users or groups with assigned actions cannot be edited or deleted by Configured Users Managers.
Transf ormer Managers can manage Transformer settings.
Advanced Settings Managers can manage advanced settings (enabling or disabling action processing,
cleanup actions, and so on).
Security Managers can access all controls in the Security tab.
State. T his controls whether the selected user/group is enabled or disabled. When disabled, the user/group is not
considered to be a Workspace Environment Management administrator and cannot use the administration console.
Type. T his field is read only and indicates whether the selected entity is a user or a group.
If the Global Administrator is cleared, the following controls are enabled:
Site Name. All Workspace Environment Management sites (configuration sets) belonging to the database this
infrastructure service is connected to.
Enabled. Select to enable this administrator for the specified Workspace Environment Management site
(configuration set). When disabled, the user/group is not considered to be an administrator for that site and
cannot access it.
Permissions. Select a permission level for the selected user/group for each Workspace Environment
Management site (configuration set) attached to this infrastructure service.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.96
Users
Aug 17, 20 17
T his page displays statistics about your Workspace Environment Management installation.
Statistics
T his page displays a summary of users whose agent hosts have connected to the database.
Users Summary. Displays a count of total users who have reserved a Workspace Environment Management license, for
both the current site (configuration set) and all sites (configuration sets). Also displays a count of new users in the last 24
hours and in the last month.
Users History. T his displays connection information for all the users associated with the current site (configuration set),
including the last connection time, the name of the machine from which they last connected and the session agent type
(UI or CMD) and version. You can use Find to filter the list by name or ID against a text string.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.97
Agents
Aug 17, 20 17
T his page displays statistics about the agents in your Workspace Environment Management installation.
Statistics
T his page displays a summary of the Workspace Environment Management agents recorded in the Workspace Environment
Management database.
Agents Summary. Displays a count of total agents who have reserved a Workspace Environment Management license, for
both the current site (configuration set) and all sites (configuration sets). It also reports agents added in the last 24 hours
and in the last month.
Agents History. T his displays connection information for all agents registered with this site (configuration set), including
the last connection time, the name of the device from which they last connected and the agent version. You can use Find
to filter the list by name or ID against a text string.
In the Synchronization State column, the following icons indicate when the agent last uploaded statistics to the
infrastructure service. (Note: these icons do not indicate that the agent cache is synchronized with the Workspace
Environment Management database.)
When you refresh an agent it communicates with the infrastructure server. T he infrastructure server validates the agent
host identity with the Workspace Environment Management database.
1. Click Ref resh to update the list of agents.
2. In the context menu select Ref resh Workspace Agent(s).
Registrations
T his page shows the registration status of the Workspace Environment Management agents recorded in the database.
Important
Agents must only be registered with one configuration set.
T he following information is reported:
Machine Name. Name of computer on which the agent is running.
State. Registration status of agent on the agent host computer, indicated by icons and the following description giving
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.98
more information about registration success or failure:
Agent is not bound to any site. T he infrastructure server cannot resolve any site (configuration set) for this agent
because the agent is not bound to any site (configuration set).
Agent is bound to one site. T he infrastructure server is sending the necessary machine-dependent settings to the
agent for that site (configuration set).
Agent is bound to multiple sites. T he infrastructure server cannot resolve a site (configuration set) for this agent
because the agent is bound to more than one site (configuration set).
Either
edit the Active Directory hierarchy (relations between computers, computer groups, and OUs)
OR
edit the Workspace Environment Management hierarchy (in the Active Directory Objects section of the administration
console) so that a computer binds to only one site (configuration set).
After making these changes, refresh agents with the infrastructure server.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.99
Logging
Aug 17, 20 17
T his tab displays a list of all changes made to the Workspace Environment Management settings in the database. By
default, the log is unpopulated until the log is refreshed manually.
F ilt ering Opt ions . T hese options allow you to filter the log by site (configuration set), and date range.
Export Log . Exports the log in XLS format.
Ref resh Log . Refreshes the log.
Clear Log . Clears the log for all configuration sets. T his cannot be undone . Clearing the log adds one event in the new
log indicating this has been done. T his option is only available to Global Full Access administrators.
T his tab lists all changes made to your Workspace Environment Management agents. T he log is unpopulated until you click
Ref resh .
F ilt ering Opt ions . T hese options allow you to filter the log by site (configuration set), and date range.
Export Log . Exports the log in XLS format.
Ref resh Log . Refreshes the log.
Clear Log . Clears the log for all configuration sets. T his cannot be undone . Clearing the log adds one event in the new
log indicating this has been done. T his option is only available to Global Full Access administrators.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.100
Monitoring
Aug 17, 20 17
T hese pages contain detailed user login and machine boot reports. You can Export all reports in various formats.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.101
Daily Reports
Aug 17, 20 17
Daily Login Report . A daily summary of login times across all users connected to this site. You can double-click a category
for a detailed view showing individual logon times for each user on each device.
Daily Boot Report . A daily summary of boot times across all devices connected to this site. You can double-click a
category for a detailed view showing individual boot times for each device.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.102
User Trends
Aug 17, 20 17
Login T rends Report . T his report displays overall login trends for each day over the selected period. You can double-click
each category of each day for a detailed view.
Boot T rends Report . T his report displays overall boot trends for each day over the selected period. You can double-click
each category of each day for a detailed view.
Device T ypes . T his report displays a daily count of the number of devices of each listed operating system connecting to
this site. You can double-click each device type for a detailed view.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.103
User & Device Reports
Aug 17, 20 17
User Report . T his report allows you to view login trends for a single user over the selected period. You can double-click
each data point for a detailed view.
Device Report . T his report allows you to view boot trends for a single device over the selected period. You can doubleclick each data point for a detailed view.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.104
Configuration
Aug 17, 20 17
T hese options allow you to control the reporting period and work days. You can also specify minimum Boot T ime and
Login T ime (in seconds) below which values are not reported.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.105
Reference
Aug 17, 20 17
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.106
Port information
Aug 17, 20 17
Workspace Environment Management uses the following ports.
S o urce
Infrastructure
service
De s tina tio n
T y pe
Po rt
Agent host
TCP
49752
TCP
8284
TCP
8286
TCP
8285
Administration
Infrastructure
console
service
Agent
Agent cache
synchronization
process
Infrastructure
service
Infrastructure
service
Infrastructure
Citrix License
service
Server
Monitoring
Infrastructure
service
service
https://docs.citrix.com
De ta ils
"Agent port". Listening port on the agent host which receives instructions from
the infrastructure service.
"Administration port". Port on which the administration console connects to the
infrastructure service.
"Agent service port". Port on which the agent connects to the infrastructure
server.
"Cache synchronization port". Port on which the agent cache synchronization
process connects to the infrastructure service to synchronize the agent cache
with the infrastructure server.
"Citrix License Server port". T he port on which the Citrix License Server is
TCP
27000
listening and to which the infrastructure service then connects to validate
licensing.
TCP
8287
"WEM monitoring port". Listening port on the infrastructure server used by the
monitoring service. (Not yet implemented.)
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.107
Dynamic tokens
Aug 17, 20 17
You can use dynamic tokens in any Workspace Environment Management actions to make them more powerful.
Sometimes you need to manipulate strings within a script to map drives or launch applications. T he following string
operations are accepted by the Workspace Environment Management agent:
#Left(string,length)#
#Right(string,length)#
#Truncate(string,length)#
&Trim(string)&
&RemoveSpaces(string)&
&Expand(string)&
$Split(string,[splitter],index)$
#Mid(string,startindex)#
!Mid(string,startindex,length)!
Note
All Operators are case sensitive. String operations are also supported with hashtags and Active Directory attributes. In cases where
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.108
your string operations are nested, Mid operations are always performed last.
Hash-tags are a replacement feature widely in Workspace Environment Management item processing. T he following
example illustrates how you use hash-tags:
To write to an .ini file, you can use % UserName% in the .ini file's path and Workspace Environment Management processes
it and expands the final directory. However, assessing the value which Workspace Environment Management writes in the
.ini itself is more complicated: you may want to write % UserName% literally, or write the expanded value.
To increase flexibility, ##UserName## exists as a hash-tag, so that using % UserName% for a value writes it literally and
##UserName## writes the expanded value.
T he following hash-tags have been implemented for general use:
##UserName##
##UserProfile##
##FullUserName##
##UserInitials##
##UserAppData##
##UserPersonal##
##UserDocuments##
##UserDesktop##
##UserFavorites##
##UserTemplates##
##UserStartMenu##
##UserStartMenuPrograms##
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.109
##ComputerName##
##ClientName##
##ClientIPAddress##
##ADSite##
##DefaultRegValue##
##UserLDAPPath##
##VUEMAgentFolder##
##RDSSessionID##
##RDSSessionName##
##ClientRemoteOS##
##ClientOSInfos##
Hash-tag ##UserScreenCapt ureComment ## is implemented for use in specific parts of the product. T his tag can be
included in the Email Template under Advanced Set t ings > UI Agent P ersonalisat ion > Helpdesk Opt ions . When
included, users are presented with a comment field located below the screen capture in the agent screen capture utility.
T he comment is included in the support email at the location at which you placed the tag in the email template.
Note
All Hashtags are case sensitive.
To work with Active Directory Attributes, Workspace Environment Management replaces the [ADAt t ribut e:at t rName]
value with the related Active Directory attribute.
For user OU structures, Citrix Workspace Environment Management replaces the [UserParent OU:level] value with the
related Active Directory OU name.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.110
Note
All AD attributes are case sensitive.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.111
Common Control Panel applets
Aug 17, 20 17
T he following Control Panel applets are common in Windows:
Applet name
Canonical name
Action Center
Microsoft.ActionCenter
Administrative Tools
Microsoft.AdministrativeTools
AutoPlay
Microsoft.AutoPlay
Biometric Devices
Microsoft.BiometricDevices
BitLocker Drive Encryption
Microsoft.BitLockerDriveEncryption
Color Management
Microsoft.ColorManagement
Credential Manager
Microsoft.CredentialManager
Date and T ime
Microsoft.DateAndT ime
Default Programs
Microsoft.DefaultPrograms
Device Manager
Microsoft.DeviceManager
Devices and Printers
Microsoft.DevicesAndPrinters
Display
Microsoft.Display
Ease of Access Center
Microsoft.EaseOfAccessCenter
Family Safety
Microsoft.ParentalControls
File History
Microsoft.FileHistory
Folder Options
Microsoft.FolderOptions
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.112
Fonts
Microsoft.Fonts
HomeGroup
Microsoft.HomeGroup
Indexing Options
Microsoft.IndexingOptions
Infrared
Microsoft.Infrared
Internet Options
Microsoft.InternetOptions
iSCSI Initiator
Microsoft.iSCSIInitiator
iSNS Server
Microsoft.iSNSServer
Keyboard
Microsoft.Keyboard
Language
Microsoft.Language
Location Settings
Microsoft.LocationSettings
Mouse
Microsoft.Mouse
MPIOConfiguration
Microsoft.MPIOConfiguration
Network and Sharing Center
Microsoft.NetworkAndSharingCenter
Notification Area Icons
Microsoft.NotificationAreaIcons
Pen and Touch
Microsoft.PenAndTouch
Personalization
Microsoft.Personalization
Phone and Modem
Microsoft.PhoneAndModem
Power Options
Microsoft.PowerOptions
Programs and Features
Microsoft.ProgramsAndFeatures
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.113
Recovery
Microsoft.Recovery
Region
Microsoft.RegionAndLanguage
RemoteApp and Desktop Connections
Microsoft.RemoteAppAndDesktopConnections
Sound
Microsoft.Sound
Speech Recognition
Microsoft.SpeechRecognition
Storage Spaces
Microsoft.StorageSpaces
Sync Center
Microsoft.SyncCenter
System
Microsoft.System
Tablet PC Settings
Microsoft.TabletPCSettings
Taskbar and Navigation
Microsoft.Taskbar
Troubleshooting
Microsoft.Troubleshooting
T SAppInstall
Microsoft.T SAppInstall
User Accounts
Microsoft.UserAccounts
Windows Anytime Upgrade
Microsoft.WindowsAnytimeUpgrade
Windows Defender
Microsoft.WindowsDefender
Windows Firewall
Microsoft.WindowsFirewall
Windows Mobility Center
Microsoft.MobilityCenter
Windows To Go
Microsoft.PortableWorkspaceCreator
Windows Update
Microsoft.WindowsUpdate
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.114
Work Folders
https://docs.citrix.com
Microsoft.WorkFolders
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.115
Log parser
Aug 17, 20 17
Workspace Environment Management includes a log parser application which is located in the agent installation directory:
T he WEM Agent Log Parser allows you to open any Workspace Environment Management agent log file, making them
searchable and filterable. T he parser also summarizes the total number of events, warnings and exceptions (in the top right
of the ribbon), as well as details about the log file (the name and port of the infrastructure service it first connected to, as
well as the agent version and username).
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.116
XML printer list configuration
Aug 17, 20 17
Workspace Environment Management includes the ability to configure user printers via an XML printer list file.
After you have created an XML printer list file, create a printer action in the administration console with an Act ion T ype
option set to Use Device Mapping P rint ers F ile .
Note
Only printers that do not require specific Windows credentials are supported.
T he XML file is encoded in UT F-8, and has the following basic XML structure:
<?xml version="1.0" encoding="UTF-8"?>
<ArrayOfSerializableKeyValuePairOfStringListOfVUEMUserAssignedPrinter xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://
...
</ArrayOfSerializableKeyValuePairOfStringListOfVUEMUserAssignedPrinter>
Every client and associated device is represented by an object of the following type:
SerializableKeyValuePair<string, List<VUEMUserAssignedPrinter>>>
Each device is represented like this:
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.117
<SerializableKeyValuePairOfStringListOfVUEMUserAssignedPrinter>
<Key>DEVICE1</Key>
<Value>
<VUEMUserAssignedPrinter>
...
</VUEMUserAssignedPrinter>
</Value>
</SerializableKeyValuePairOfStringListOfVUEMUserAssignedPrinter>
Each block of devices must be matched to a specific client or computer name. T he <Key> tag contains the relevant name.
T he <Value> tag contains a list of VUEMUserAssignedP rint er objects matching the printers assigned to the specified
client.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.118
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfSerializableKeyValuePairOfStringListOfVUEMUserAssignedPrinter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs
<SerializableKeyValuePairOfStringListOfVUEMUserAssignedPrinter>
<Key>DEVICE1</Key>
<Value>
<VUEMUserAssignedPrinter>
...
</VUEMUserAssignedPrinter>
</Value>
</SerializableKeyValuePairOfStringListOfVUEMUserAssignedPrinter>
</ArrayOfSerializableKeyValuePairOfStringListOfVUEMUserAssignedPrinter>
Each configured printer must be defined in a <VUEMUserAssignedP rint er> tag, using the following attributes:
<IdP rint er> . T his is the Workspace Environment Management printer ID for the configured printer. Each printer must have
a different ID. Not e T he XML Printer List action configured in the Workspace Environment Management Administration
Console is also a printer action with its own ID which must be different from the ID of printers individually configured in the
XML list.
<IdSit e> . Contains the site ID for the relevant Workspace Environment Management site, which must match the ID of an
existing site.
<St at e> . Specifies the state of the printer where 1 is active and 0 is disabled.
<Act ionT ype> . Must always be 0.
<UseExt Credent ials> . Must be 0. T he use of specific Windows credentials is not currently supported.
<isDef ault > . If 1, printer is the default Windows printer. If 0, it is not configured as default.
<IdF ilt erRule> . Must always be 1.
<RevisionId> . Must always be 1. If printer properties are subsequently modified, increment this value by 1 to notify the
Agent Host and ensure the printer action is re-processed.
<Name> . T his is the printer name as perceived by the Workspace Environment Management Agent Host. T his field cannot
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.119
be left blank.
<Descript ion> . T his is the printer description as perceived by the Workspace Environment Management Agent Host. T his
field can be blank.
<DisplayName> . T his is unused and should be left blank.
<T arget Pat h> . T his is the UNC path to the printer.
<Ext Login> . Contains the name of the Windows account used when specifying Windows credentials for connection.
[Currently unsupported. Leave this field blank.].
<Ext Password> . Contains the password for the Windows account used when specifying Windows credentials for
connection. [Currently unsupported. Leave this field blank.].
<Reserved01> . T his contains advanced settings. Do not alter it in any way.
&gt;&lt;VUEMActionAdvancedOption&gt;&lt;Name&gt;SelfHealingEnabled&lt;/Name&gt;&lt;Value&gt;0&lt;/Value&gt;&lt;/VUEMActionAdvancedOpti
To activate self-healing for a given printer object, simply copy and paste the above contents, changing the highlight 0 value
to 1.
Example printer object
T he following example assigns two active printers on the client or computer DEVICE1:
HP LaserJet 2200 Series on UNC path \\server.example.net \HP LaserJet 2200 Series (default printer)
Canon C5531i Series printer on UNC path \\server.example.net \Canon C5531i Series
It also assigns one active printer on the client or computer DEVICE2:
HP LaserJet 2200 Series on UNC path \\server.example.net \HP LaserJet 2200 Series
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfSerializableKeyValuePairOfStringListOfVUEMUserAssignedPrinter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs
<SerializableKeyValuePairOfStringListOfVUEMUserAssignedPrinter>
<Key>DEVICE1</Key>
<Value>
<VUEMUserAssignedPrinter>
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.120
<VUEMUserAssignedPrinter>
<IdPrinter>1</IdPrinter>
<IdSite>1</IdSite>
<State>1</State>
<ActionType>0</ActionType>
<UseExtCredentials>0</UseExtCredentials>
<isDefault>1</isDefault>
<IdFilterRule>1</IdFilterRule>
<RevisionId>1</RevisionId>
<Name>HP LaserJet 2200 Series</Name>
<Description />
<DisplayName />
<TargetPath>\\server.example.net\HP LaserJet 2200 Series</TargetPath>
<ExtLogin />
<ExtPassword />
<Reserved01>&lt;?xml version="1.0" encoding="utf-8"?&gt;&lt;ArrayOfVUEMActionAdvancedOption xmlns:xsi="http://www.w3.org/200
</VUEMUserAssignedPrinter>
</Value>
<Value>
<VUEMUserAssignedPrinter>
<IdPrinter>2</IdPrinter>
<IdSite>1</IdSite>
<State>1</State>
<ActionType>0</ActionType>
<UseExtCredentials>0</UseExtCredentials>
<isDefault>0</isDefault>
<IdFilterRule>1</IdFilterRule>
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.121
<RevisionId>1</RevisionId>
<Name>Canon C5531i Series</Name>
<Description />
<DisplayName />
<TargetPath>\\server.example.net\Canon C5531i Series</TargetPath>
<ExtLogin />
<ExtPassword />
<Reserved01>&lt;?xml version="1.0" encoding="utf-8"?&gt;&lt;ArrayOfVUEMActionAdvancedOption xmlns:xsi="http://www.w3.org/200
</VUEMUserAssignedPrinter>
</Value>
<Key>DEVICE2</Key>
<Value>
<VUEMUserAssignedPrinter>
<IdPrinter>1</IdPrinter>
<IdSite>1</IdSite>
<State>1</State>
<ActionType>0</ActionType>
<UseExtCredentials>0</UseExtCredentials>
<isDefault>0</isDefault>
<IdFilterRule>1</IdFilterRule>
<RevisionId>1</RevisionId>
<Name>HP LaserJet 2200 Series</Name>
<Description />
<DisplayName />
<TargetPath>\\server.example.net\HP LaserJet 2200 Series</TargetPath>
<ExtLogin />
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.122
<ExtLogin />
<ExtPassword />
<Reserved01>&lt;?xml version="1.0" encoding="utf-8"?&gt;&lt;ArrayOfVUEMActionAdvancedOption xmlns:xsi="http://www.w3.org/200
</VUEMUserAssignedPrinter>
</Value></SerializableKeyValuePairOfStringListOfVUEMUserAssignedPrinter>
</ArrayOfSerializableKeyValuePairOfStringListOfVUEMUserAssignedPrinter>
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.123
Filter conditions
Aug 17, 20 17
Workspace Environment Management includes the following filter conditions which you use to configure the circumstances
under which the agent assigns resources to users. (For details of using these conditions in the administration console, see
filter conditions.)
Condition Name
Always T rue
Expected value type
N/A
Expected result type
N/A
Expected syntax
N/A
Returns
true
Condition Name
Comput erName Mat ch
Expected value type
N/A
Expected result type
String
Expected syntax
Single name test : Computername
Multiple tests (OR) : Computername1;Computername2
Wildcard (also works with multiples) : ComputerName*
Returns
True if the current computer name matches the tested value false otherwise
Condition Name
Client Name Mat ch
Expected value type
N/A
Expected value type
String
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.124
Expected syntax
Single name test : Clientname
Multiple tests (OR) : Clientname1;Clientname2
Wildcard (also works with multiples) : ClientName*
Returns
True if the current client name matches the tested value false otherwise
Condition Name
IP Address Mat ch
Expected value type
N/A
Expected result type
IP address
Expected syntax
Single name test : IpAddress
Multiple tests (OR) : IpAddress1;IpAddress2
Wildcard (also works with multiples) : IpAddress*
Range (also works with multiples) : IpAddress1-IpAddress2
Returns
True if the current computer ip address matches the tested value false otherwise
Condition Name
Client IP Address Mat ch
Expected value type
N/A
Expected result type
IP address
Expected syntax
Single name test : ClientIpAddress
Multiple tests (OR) : ClientIpAddress1;ClientIpAddress2
Wildcard (also works with multiples) : ClientIpAddress*
Range (also works with multiples) : IpAddress1-IpAddress2
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.125
Returns
True if the current client ip address matches the tested value false otherwise
Condition Name
Act ive Direct ory Sit e Mat ch
Expected value type
N/A
Expected result type
Exact name of the Active Directory site to test
Expected syntax
Active directory site name
Returns
True if the specified site matches the current site false otherwise
Condition Name
Scheduling
Expected value type
N/A
Expected result type
Day of week (example: Monday)
Expected syntax
Single name test : DayOfWeek
Multiple tests (OR) : DayOfWeek1; DayOfWeek2
Returns
True if today matches the tested value false otherwise
Condition Name
Environment Variable Mat ch
Expected value type
String. Name of the tested variable
Expected result type
String. Expected value of the tested variable
Expected syntax
Single name test : value
Not null test: ?
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.126
Returns
True if environment variable exists and value matches false otherwise.
Condition Name
Regist ry Value Mat ch
Expected value type
String. Full path and name of the registry value to test. Example : Registry Key
HKCU\Sof t ware\Cit rix\Test ValueName
Expected result type
String. Expected value of the tested registry entry
Expected syntax
Single name test : value
Not null test: ?
Returns
True if registry value exists and value matches false otherwise.
Condition Name
WMI Query result Mat ch
Expected value type
N/A
Expected result type
String.
Expected syntax
Valid WMI query. https://msdn.microsoft.com/en-us/library/aa392902(v=vs.85).aspx
Returns
True if query is successful and has result false otherwise.
Condition Name
User Count ry Mat ch
Expected value type
N/A
Expected result type
String.
Expected syntax
Two letter ISO language name.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.127
Returns
True if user ISO language name matches the specified value false otherwise.
Condition Name
User UI Language Mat ch
Expected value type
N/A
Expected result type
String. Two letter ISO language name. Example FR
Expected syntax
Two letter ISO language name. Example FR
Returns
True if user UI ISO language name matches the specified value false otherwise.
Condition Name
User SBC Resource T ype
Expected value type
N/A
Expected result type
Select from dropbox
Expected syntax
N/A
Returns
True if user context (published desktop or application) matches selected value false
otherwise.
Condition Name
OS P lat f orm T ype
Expected value type
N/A
Expected result type
Select from dropbox
Expected syntax
N/A
Returns
True if machine platform type (x64 or x86) matches selected value false otherwise.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.128
Condition Name
Connect ion St at e
Expected value type
N/A
Expected result type
Select from dropbox
Expected syntax
N/A
Returns
True if connection state (online or offline) matches selected value false otherwise.
Condition Name
XenApp Version Mat ch
Expected value type
N/A
Expected result type
String. XenApp Version. Example: 6.5
Expected syntax
N/A
Returns
True if version matches selected value false otherwise.
Condition Name
XenApp Farm Name Mat ch
Expected value type
N/A
Expected result type
String. XenApp Farm Name (up to version 6.5). Example: Farm
Expected syntax
N/A
Returns
True if name matches selected value false otherwise.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.129
Condition Name
XenApp Z one Name Mat ch
Expected value type
N/A
Expected result type
String. XenApp Zone Name (up to version 6.5). Example: Zone
Expected syntax
N/A
Returns
True if name matches selected value false otherwise.
Condition Name
XenDeskt op Farm Name Mat ch
Expected value type
N/A
Expected result type
String. XenDesktop Farm Name (up to version 5). Example: Farm
Expected syntax
N/A
Returns
True if name matches selected value false otherwise.
Condition Name
XenDeskt op Deskt op Group Name Mat ch
Expected value type
N/A
Expected result type
String. XenDesktop Desktop Group Example: Group
Expected syntax
N/A
Returns
True if name matches selected value false otherwise.
Condition Name
P rovisioning Services Image Mode
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.130
Expected value type
N/A
Expected result type
Select from dropbox
Expected syntax
N/A
Returns
True if current provisioning services image mode matches selected value false otherwise.
Condition Name
Client OS
Expected value type
N/A
Expected result type
Select from dropbox
Expected syntax
N/A
Returns
True if current client operating system matches selected value false otherwise.
Condition Name
Act ive Direct ory Pat h Mat ch
Expected value type
N/A
Expected result type
String. Name of the tested Active Directory Path
Expected syntax
Single name test : strict LDAP path matching
Wilcard test: OU=Users*
Multiple entries: separate entries with semicolon (;)
Returns
True if attribute exists and value matches false otherwise.
Condition Name
Act ive Direct ory At t ribut e Mat ch
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.131
Expected value type
String. Name of the tested Active Directory attribute
Expected result type
String. Expected value of the tested Active Directory attribute
Expected syntax
Single value test : value
Multiple value entries: separate entries with semicolon (;)
Test for not null: ?
Returns
True if attribute exists and value matches false otherwise.
Condition Name
Name or Value is in List
Expected value type
String. Full file path of the xml list generated by the Integrity List manager utility
Expected result type
String. Expected value of the name/value to look for in the list
Expected syntax
String
Returns
True if the value is found in the name/value pairs in the specified list false otherwise.
Condition Name
No Comput erName Mat ch
Negative condition behavior
Will execute Comput erName Mat ch and return the opposite result (true if false, false
if true).
See condition Comput erName Mat ch for more information.
Condition Name
No Client Name Mat ch
Negative condition behavior
Will execute ClientName Match and return the opposite result (true if false, false if true).
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.132
See condition Client Name Mat ch for more information.
Condition Name
No IP Address Mat ch
Negative condition behavior
Will execute IP Address Match and return the opposite result (true if false, false if true).
See condition IP Address Mat ch for more information.
Condition Name
No Client IP Address Mat ch
Negative condition behavior
Will execute Client IP Address Match and return the opposite result (true if false, false if
true).
See condition Client IP Address Mat ch for more information.
Condition Name
No Act ive Direct ory Sit e Mat ch
Negative condition behavior
Will execute Active Directory Site Match and return the opposite result (true if false,
false if true).
See condition Act ive Direct ory Sit e Mat ch for more information.
Condition Name
No Environment Variable Mat ch
Negative condition behavior
Will execute Environment Variable Match and return the opposite result (true if false,
false if true).
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.133
See condition Environment Variable Mat ch for more information.
Condition Name
No Regist ry Value Mat ch
Negative condition behavior
Will execute Registry Value Match and return the opposite result (true if false, false if
true).
See condition Regist ry Value Mat ch for more information.
Condition Name
No WMI Query result Mat ch
Negative condition behavior
Will execute WMI Query result Match and return the opposite result (true if false, false
if true).
See condition WMI Query result Mat ch for more information.
Condition Name
No User Count ry Mat ch
Negative condition behavior
Will execute User Country Match and return the opposite result (true if false, false if
true).
See condition User Count ry Mat ch for more information.
Condition Name
No User UI Language Mat ch
Negative condition behavior
Will execute User UI Language Match and return the opposite result (true if false, false if
true).
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.134
See condition User UI Language Mat ch for more information.
Condition Name
No XenApp Version Mat ch
Negative condition behavior
Will execute XenApp Version Match and return the opposite result (true if false, false if
true).
See condition XenApp Version Mat ch for more information.
Condition Name
No XenApp Farm Name Mat ch
Negative condition behavior
Will execute XenApp Farm Name Match and return the opposite result (true if false,
false if true).
See condition XenApp Farm Name Mat ch for more information.
Condition Name
No XenApp Z one Name Mat ch
Negative condition behavior
Will execute XenApp Zone Name Match and return the opposite result (true if false,
false if true).
See condition XenApp Z one Name Mat ch for more information.
Condition Name
No XenDeskt op Farm Name Mat ch
Negative condition behavior
Will execute XenDesktop Farm Name Match and return the opposite result (true if false,
false if true).
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.135
See condition XenDeskt op Farm Name Mat ch for more information.
Condition Name
No XenDeskt op Deskt op Group Name Mat ch
Negative condition behavior
Will execute XenDesktop Desktop Group Name Match and return the opposite result
(true if false, false if true).
See condition XenDeskt op Deskt op Group Name Mat ch for more information.
Condition Name
No Act ive Direct ory Pat h Mat ch
Negative condition behavior
Will execute Active Directory Path Match and return the opposite result (true if false,
false if true).
See condition Act ive Direct ory Pat h Mat ch for more information.
Condition Name
No Act ive Direct ory At t ribut e Mat ch
Negative condition behavior
Will execute Active Attribute Path Match and return the opposite result (true if false,
false if true).
See condition Act ive At t ribut e Pat h Mat ch for more information.
Condition Name
Name or Value is not in List
Negative condition behavior
Will execute Name or Value is in List and return the opposite result (true if false, false if
true).
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.136
See condition Name or Value is in List for more information.
Condition Name
Client Remot e OS Mat ch
Expected value type
N/A
Expected result type
Select from dropbox
Expected syntax
N/A
Returns
True if current remote client operating system matches selected value false otherwise.
Condition Name
No Client Remot e OS Mat ch
Negative condition behavior
Will execute Client Remote OS Match and return the opposite result (true if false, false
if true).
See condition Client Remot e OS Mat ch for more information.
Condition Name
Dynamic Value Mat ch
Expected value type
String. Any dynamic expression using environment variables or Dynamic Tokens
Expected result type
String. Expected value of the tested expression
Expected syntax
Single name test : value
Not null test: ?
Returns
https://docs.citrix.com
True if dynamic expression result value exists and value matches false otherwise.
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.137
Condition Name
No Dynamic Value Mat ch
Negative condition behavior
Will execute Dynamic Value Match and return the opposite result (true if false, false if
true).
See condition Dynamic Value Mat ch for more information.
Condition Name
T ransf ormer Mode St at e
Expected value type
N/A
Expected result type
Select from dropbox
Expected syntax
N/A
Returns
True if current Transformer state matches selected value false otherwise.
Condition Name
No Client OS Mat ch
Negative condition behavior
Will execute Client OS Match and return the opposite result (true if false, false if true).
See condition Client OS Mat ch for more information.
Condition Name
Act ive Direct ory Group Mat ch
Expected value type
N/A
Expected result type
String
Expected syntax
Single name test : group netbios name (DOMAIN\Groupname)
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.138
Multiple tests (OR) : Groupname1;Groupname2
Returns
True if any of the current user groups matches the tested value false otherwise
Condition Name
No Act ive Direct ory Group Mat ch
Negative condition behavior
Will execute Active Directory Group Match and return the opposite result (true if false,
false if true).
See condition Act ive Direct ory Group Mat ch for more information.
Condition Name
F ile Version Mat ch
Expected value type
String. Full path and name of the file to test.
Example : C:\Test \Test F ile.dll
Expected result type
String. Expected file version value of the tested file
Expected syntax
Single name test : value
Not null test: ?
Returns
True if registry value exists and value matches false otherwise.
Condition Name
No F ile Version Mat ch
Negative condition behavior
Will execute File Version Match and return the opposite result (true if false, false if true).
See condition F ile Version Mat ch for more information.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.139
Condition Name
Net work Connect ion St at e
Expected value type
N/A
Expected result type
Select from dropbox
Expected syntax
N/A
Returns
True if current network connection state matches selected value false otherwise.
Condition Name
Published Resource Name
Expected value type
N/A
Expected result type
String. Name of the published resource (XenApp/XenDesktop/RDS)
Expected syntax
Single name test : published resource name
Multiple tests (OR) : Name1;Name2
Wildcard test: Name*
Returns
True if the current published resource name matches the tested value false otherwise
Condition Name
Name is in List
Expected value type
String. Full file path of the xml list generated by the Integrity List manager utility
Expected result type
String. Expected value of the name to look for in the list
Expected syntax
String
Returns
True if there is a name match in the name/value pairs in the specified list false otherwise.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.140
Condition Name
Name is not in List
Negative condition behavior
Will execute Name is in List and return the opposite result (true if false, false if true).
See condition Name is in List for more information.
Condition Name
F ile/F older exist s
Expected value type
N/A
Expected result type
String.
Expected syntax
Full path of the file system entry (file or folder) to test
Returns
True if the specified file system entry exists false otherwise
Condition Name
F ile/F older does not exist
Negative condition behavior
Will execute File/Folder exists and return the opposite result (true if false, false if true).
See condition F ile/F older exist s for more information.
Condition Name
Dat eT ime Mat ch
Expected value type
N/A
Expected result type
DateT ime as String. Date/time to test
Expected syntax
Single Date: 06/01/2016
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.141
Date Range: 06/01/2016-08/01/2016
Multiple entries: entry1;entry2 Ranges and single dates can be mixed
Returns
True if execution datetime matches any of the specified entry false otherwise.
Condition Name
No Dat eT ime Mat ch
Negative condition behavior
Will execute DateT ime Match and return the opposite result (true if false, false if true).
See condition Dat eT ime Mat ch for more information.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.142
Glossary
Aug 17, 20 17
T his topic contains terms and definitions used in the Workspace Environment Management (WEM) software and
documentation.
Admin Broker P ort
Legacy term for "administration port".
administ rat ion console
An interface that connects to the infrastructure services. You use the administration console to create and assign
resources, manage policies, authorize users, and so on.
administ rat ion port
Port on which the administration console connects to the infrastructure service. T he port defaults to 8284 and
corresponds to the AdminPort command-line argument.
agent
T he Workspace Environment Management agent consists of two components: the agent service and the session agent.
T hese components are installed on the agent host.
Agent Host execut able
Legacy term for "session agent".
Agent Host machine
Legacy term for "agent host".
Agent Host service
Legacy term for "agent service".
Agent Broker P ort
Legacy term for "agent service port".
Agent Cache Synchronizat ion P ort
Legacy term for"cache synchronization port".
agent host
T he machine on which the agent is installed.
agent host configurat ion GP O
T he Group Policy Object (GPO) administrative template provided with the agent installation as ADM or ADMX files.
Administrators import these files into Active Directory and then apply the settings to a suitable organizational unit.
agent port
Listening port on the agent host which receives instructions from the infrastructure service. Used, for example, to force
agents to refresh from the administration console. T he port default is 49752.
agent service
T he service deployed on VDAs or on physical Windows devices in transformer use cases. It is responsible for enforcing the
settings you configure using the administration console.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.143
agent service port
A port on which the agent connects to the infrastructure server. T he port defaults to 8286 and corresponds to the
AgentPort command-line argument.
Agent Sync Broker P ort
Legacy term for "cache synchronization port".
broker
Legacy term for "infrastructure service".
Broker account
Legacy term for "infrastructure service account".
Broker server
Legacy term for "infrastructure server".
Broker Service Account
Legacy term for "infrastructure service account".
cache synchronizat ion port
A port on which the agent cache synchronization process connects to the infrastructure service to synchronize the agent
cache with the infrastructure server. T he port defaults to 8285 and corresponds to the AgentSyncPort command-line
argument.
Cit rix License Server port
T he port on which the Citrix License Server is listening and to which the infrastructure service then connects to validate
licensing. T he port default is 27000.
configurat ion set
A set of Workspace Environment Management configuration settings.
Connect ion Broker
Legacy term for "infrastructure server".
dat abase
A database created in an SQL Server instance and containing the Workspace Environment Management configuration
settings.
dat abase server account
T he account used by the database creation wizard to connect to the SQL instance to create the Workspace Environment
Management database.
DSN
A data source name (DSN) contains database name, directory, database driver, UserID, password, and other information.
Once you create a DSN for a particular database, you can use the DSN in an application to call information from the
database.
inf rast ruct ure server
T he computer on which the Workspace Environment Management infrastructure services are installed.
Inf rast ruct ure Server Administ rat ion P ort
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.144
Legacy term for "administration port".
inf rast ruct ure service
T he service installed on the infrastructure server which synchronizes the various back-end components (SQL Server, Active
Directory) with the front-end components (administration console, agent host). T his service was previously called the
"broker."
inf rast ruct ure service account
T he account which the infrastructure service uses to connect to the database. By default this account is the vuemUser
SQL account, but during database creation you can optionally specify other Windows credentials for the infrastructure
service to use.
Inf rast ruct ure service server
Legacy term for "infrastructure server".
inf rast ruct ure services
Services installed on the infrastructure server by the infrastructure services installation process.
init ial administ rat ors group
A user group which is selected during database creation. Only members of this group have Full Access to all Workspace
Environment Management sites in the administration console. By default this group is the only group with this access.
int egrat ed connect ion
Connection of the database creation wizard to the SQL instance using the current Windows account instead of an SQL
account.
kiosk mode
A mode in which the agent becomes a web or application launcher redirecting users to a single app or desktop experience.
T his allows administrators to lock down the user environment to a single app or desktop.
Monit oring Broker P ort
Legacy term for"WEM monitoring port".
mixed-mode aut hent icat ion
In SQL Server, an authentication mode that enables both Windows Authentication and SQL Server Authentication. T his is
the default mechanism by which the infrastructure service connects to the database.
License server port
Legacy term for "Citrix License Server port".
net work drive
A physical storage device on a LAN, a server, or a NAS device.
self-service window
An interface in which end users can select functionality configured in Workspace Environment Management (for example
icons, default printer). T his interface is provided by the session agent in "UI mode."
service principal name (SP N)
T he unique identifier of a service instance. SPNs are used by Kerberos authentication to associate a service instance with a
service logon account.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.145
session agent
An agent that configures app shortcuts for user sessions. T he agent operates in "UI mode" and "command line" mode. UI
mode provides a self-service interface accessible from a status bar icon, from which end users can select certain functions
(for example icons, default printer).
Sit e
Legacy term for "Configuration set".
SQL user account
An SQL user account with name of "vuemUser" created during installation. T his is the default account that the
infrastructure service uses to connect to the database.
t ransf ormer
A feature in which Workspace Environment Management agents connect in a restricted kiosk mode.
virt ual drive
A Windows virtual drive (also called an MS-DOS device name) created using the subst command or the DefineDosDevice
function. A virtual drive maps a local file path to a drive letter.
virt ual IP address (VIP )
An IP address that does not correspond to an actual physical network interface (port).
VUEM
Virtual User Environment Management. T his is a legacy Norskale term that appears in some places in the product.
vuemUser
An SQL account created during Workspace Environment Management database creation. T his is the default account that
the Workspace Environment Management infrastructure service uses to connect to the database.
WEM Broker
Legacy term for "infrastructure service".
WEM monit oring port
A listening port on the infrastructure server used by the monitoring service. T he port defaults to 8287. (Not yet
implemented.)
WEM UI Agent execut able
Legacy term for "session agent".
Windows account impersonat ion
When a service runs under the identity of a Windows account.
Windows AppLocker
A Windows feature that allows you to specify which users or groups can run particular applications in your organization
based on unique identities of files. If you use AppLocker, you can create rules to allow or deny applications from running.
Windows aut hent icat ion
In SQL Server, the default authentication mode in which specific Windows user accounts and group accounts are trusted
to log in to SQL Server. An alternate mode of authentication in SQL Server is mixed mode authentication.
Windows securit y
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.146
Legacy term for "Windows authentication".
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.147
Download PDF
Similar pages