# Administration Console - Citrix Docs

Workspace Environment Management 4.2 Apr 12, 20 17

Workspace Environment Management Workspace Environment Management uses intelligent resource management and Proﬁle 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. Proﬁle 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.

What's new Proﬁle Management Workspace Environment Management 4.2 now supports all versions of Proﬁle Management up to v5.6. New options are now provided in the Citrix Proﬁle 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.

Fixed issues T he following issues have been ﬁxed since Version 4.1: 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]

Known issues T his release contains the following issues:

http://docs.citrix.com

p.1

On Windows Server 2012 R2, if Adobe Acrobat Reader is installed it prevents Workspace Environment Management associating files of type .PDF 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]

Future removals T he platforms, Citrix products, and features described below will be removed in future. Citrix will continue to support them up to and including the next XenApp and XenDesktop Long Term Service Release (LT SR) release, but they are expected to be removed in a subsequent Current Release. When possible, alternatives are offered for items that are deprecated. T he announcements below are intended to give you advanced notice of features which are being phased out so that you can make timely business decisions. Citrix monitors customer use and feedback about feature removal to determine when they are withdrawn. Platform support in XenApp and XenDesktop generally ends when the platform's manufacturer ends extended support. See the System requirements article for exceptions.

Announced in Workspace Environment Management 4.2 Citrix Workspace Environment Management 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 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 Citrix Workspace Environment Management will not be supported on the following software after the next LT SR: Microsoft .NET Framework 4.0 Microsoft .NET Framework 4.5.0 Microsoft .NET Framework 4.5.1

Technical overview Workspace Environment Management has the following architecture:

http://docs.citrix.com

p.2

Workspace Environment Management Inf rastructure Services. T he Infrastructure Services broker is installed on a Windows server. It synchronizes the various back-end components (SQL Server, Active Directory) with the front-end components (Administration Console, Agent Host).

Note Workspace Environment Management Infrastructure Services cannot be installed on a domain controller. Kerberos authentication issues prevent the broker service from working in this scenario.

Workspace Environment Management Administration Console. T he Administration Console is installed on a Windows client or on a server operating system (OS). It connects to the Workspace Environment Management 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). Workspace Environment Management Agent Host . T he Agent Host 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). It connects to the Workspace Environment Management Infrastructure Services and is responsible for enforcing the settings you conﬁgure by using the Administration Console.

Note T he Workspace Environment Management Agent Host cannot be installed on the Workspace Environment Management Infrastructure Services server. T he Agent Host installer fails in this scenario.

http://docs.citrix.com

p.3

Note T he Transformer feature is not supported on server operating systems.

SQL Server Database: Workspace Environment Management requires a SQL Server database to store its settings. T he Workspace Environment Management database requires a minimum of 50 MB of disk space. Microsof t Active Directory Server: Workspace Environment Management requires access to your Active Directory to push settings to your users.

http://docs.citrix.com

p.4

System requirements Apr 12, 20 17

Operating system prerequisites Workspace Environment Management Inf rastructure Services Windows Server 2008 R2 Windows Server 2012 Windows Server 2012 R2 Windows Server 2016 Workspace Environment Management 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

http://docs.citrix.com

p.5

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 Workspace Environment Management Agent Host 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 Workspace Environment Management Inf rastructure Services (for up to 3,000 users): 4 vCPUs, 8 GB RAM, 80 MB of available disk space. Workspace Environment Management Administration Console: minimum dual core processor with 2 GB RAM, 40 MB of available disk space (100 MB during install). Workspace Environment Management Agent Host: 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). Workspace Environment Management database: 50 MB of available disk space.

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.

Anti-virus exclusions Workspace Environment Management Agent and Workspace Environment Management 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

http://docs.citrix.com

p.6

On-access scanning must be disabled for the entire Norskale installation directory for both the Workspace Environment Management Agent and Workspace Environment Management Infrastructure Services. If this is not possible, the following processes must be excluded from on-access scanning: In the Inf rastructure Service installation directory: Norskale Broker Service.exe Norskale Broker Service Configuration Utility.exe Norskale Database Management Utility.exe In the Agent Host 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

http://docs.citrix.com

p.7

Install and conﬁgure Feb 23, 20 17

Install and conﬁgure the following components: Infrastructure services Administration console Agent Host

http://docs.citrix.com

p.8

Infrastructure Services May 21, 20 17

T here is currently one infrastructure service: Norskale Infrastructure Service (NT SERVICE\Norskale Infrastructure Service) : Manages WEM Infrastructure services. Account: LocalSystem or speciﬁed user account.

Install the infrastructure services Important Workspace Environment Management Infrastructure Services cannot be installed on a domain controller. Kerberos authentication issues prevent the broker service from working in this scenario.

To Install the infrastructure services, run Citrix Workspace Environment Management Inf rastructure Services v4 .02.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 ﬁrewall ports locally, to ensure that the agent network trafﬁc is not blocked. T he AgentPort argument allows you to conﬁgure 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 ﬁrewall ports locally, to ensure that the agent network trafﬁc is not blocked. T he AgentSyncPort argument allows you to conﬁgure 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 ﬁrewall ports locally, to ensure that the agent network trafﬁc is not blocked. T he AdminPort argument allows you to conﬁgure which port is opened. T he default port is 8284. Any valid port is an accepted value. T he syntax for these install arguments is: "path:\to\Citrix Workspace Environment Management Inf rastructure Services v4 .02.00.00 Setup" /v"argument1=\"value1\" argument2=\"value2\""

Create SPNs

Note When you are using load balancing, all instances of the Workspace Environment Management Infrastructure Services must be installed and conﬁgured using the same service account name.

http://docs.citrix.com

p.9

After the installer is ﬁnished, 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 Citrix Workspace Environment Management Broker 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.

Conﬁgure load balancing To conﬁgure Workspace Environment Management with a load balancing service: 1. Create a Windows Broker Service Account for the Workspace Environment Management broker service to connect to the Workspace Environment Management database. 2. When you create the Workspace Environment Management database, select the option Broker Database Connection Uses Windows Security and specify the Broker Service Account name. [See Create a Workspace Environment Management Database.] 3. Configure each broker to connect to the SQL database using Windows authentication instead of SQL authentication: select the option Enable Windows Account Impersonation and provide the Broker Service Account credentials. [See Configure the Citrix Workspace Environment Management Infrastructure Services.] 4. Configure the Service Principal Names (SPNs) for the Workspace Environment Management Infrastructure Services to use the Broker Service Account name. [See Create SPNs.] 5. Create a virtual IP address (VIP) that covers the number of brokers you want to put behind a VIP. All the brokers covered by a VIP are eligible when agents connect to the VIP. 6. When you configure the Agent Host Configuration GPO, set the Connection Broker Name setting to the VIP instead of the address for any individual broker. [See Configure the Agent.] 7. Session persistence is required for the connection between agent and broker, and between consoles and broker. Citrix recommends that you connect all Administration Consoles to one Broker Service, rather than using the VIP.

Create a Workspace Environment Management Database Use the Norskale Database Management Utility to create the database. T his is installed during the infrastructure services installation process. Note: If you are using Windows authentication for your SQL Server, run the database creation utility under an identity that has sysadmin permissions. 1. Start the Database Management Utility from the Citrix>Workspace Environment Management>Database Management folder in the Start menu.

http://docs.citrix.com

p.10

2. Click Create Database.

3. Type the following Database Information, then click Next: Server and Instance Name. Address of the SQL Server on which the database can be hosted. T his address must be

http://docs.citrix.com

p.11

reachable exactly as typed from the Broker server. T he server and instance name can be typed as the machine name, fully qualiﬁed domain name, or IP address. Specify a full instance address as serveraddress,port\instancename. If port is unspeciﬁed the default SQL port number (1433) is used. Database Name. Name of the SQL database to create. Data File: path to the .mdf ﬁle location on the SQL Server. Log File: path to the .ldf ﬁle location on the SQL Server. Note. T he database management utility cannot query your SQL Server for the default location of these ﬁles. T he default values for the data and log ﬁles are the default values for a default installation of MSSQL. You must type the correct values in these two ﬁelds or the database creation process will fail.

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 sufﬁcient permissions to create the database, you can either run the database management utility as a Windows account with sufﬁcient privileges, or you can clear this option and provide an SQL account with sufﬁcient privileges instead.

http://docs.citrix.com

p.12

Important If you set the password here, remember to specify the same vuemUser SQL account password when you conﬁgure the infrastructure service.

http://docs.citrix.com

p.13

6. Review the settings you have selected, and when you are satisﬁed click Create Database. 7. When you are notiﬁed that the database creation has completed successfully, click Finish to exit the wizard. If there is an error during the database creation, check the log ﬁle "Citrix WEM Database Management Utility Debug Log.log" in the infrastructure services installation directory.

Conﬁgure the infrastructure service Before the infrastructure service runs, you must conﬁgure it using the Broker Service Conﬁguration utility. 1. From the Start menu select Citrix>Workspace Environment Management>Broker Service Conﬁguration.

http://docs.citrix.com

p.14

2. In the Database Settings tab enter the following details: Database Server and Instance. Address of the SQL Server instance on which the database is hosted. Must be reachable exactly as typed from the Broker server. Specify a full instance address as serveraddress,port\instancename. If port is unspeciﬁed the default SQL port number (1433) is used. Database Failover Server. If you are using database mirroring, specify the failover server address here. Database Name. Name of the Workspace Environment Management database on the SQL instance.

http://docs.citrix.com

p.15

3. In the Network Settings tab type the ports the Workspace Environment Management Infrastructure Services uses: Admin Broker Port. T his port is used by the Administration Console to connect to the Workspace Environment Management Infrastructure Services. Agent Broker Port. T his port is used by your Workspace Environment Management Agent Hosts to connect to the Workspace Environment Management Infrastructure Services. Agent Sync Broker Port. T his port is used by the Workspace Environment Management Agent Host service to synchronize its cache with the Workspace Environment Management Infrastructure Services. Monitoring Broker Port. [Not currently used.]

http://docs.citrix.com

p.16

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 an SQL account called vuemUser created during database creation). If you selected a Windows account (Broker Service Account) during database creation, you must select this option and specify the same Windows account for the service to impersonate during connection. T he account you select must be a local administrator on the infrastructure server. Workspace Environment Management SQL Account Password. If enabled, this setting indicates to the infrastructure service the custom password conﬁgured for the Workspace Environment Management SQL user during database creation. If no custom password was conﬁgured, do not enable this setting. Broker Cache Ref resh Delay. T ime (in minutes) before the Workspace Environment Management Infrastructure Services refreshes its cache. T he cache is used if the Workspace Environment Management Infrastructure Service is unable to connect to SQL. Broker SQL State Monitor Delay. T ime (in seconds) between the broker's attempts to poll the SQL server. Enable Debug Mode. If enabled, the Workspace Environment Management Infrastructure Services are set to verbose logging mode.

http://docs.citrix.com

p.17

Use Cache Even if Online. If enabled, the Workspace Environment Management Infrastructure Services always reads site settings from its cache.

5. You can use the Database Maintenance tab to conﬁgure 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. System Monitoring Retention Period. Determines how long system optimization statistics are retained. Execution Time. Determines the time at which the database maintenance action is performed.

http://docs.citrix.com

p.18

http://docs.citrix.com

p.19

Administration Console Feb 23, 20 17

Install the Administration Console Run Citrix Workspace Environment Management Console v4 .02.00.00 Setup.exe on your Administrator Console environment. You can customize your installation using the arguments: AgentPort: T he Administration Console setup runs a script that opens ﬁrewall ports locally, to make sure the agent network trafﬁc is not blocked. T his argument allows you to conﬁgure which port is opened. If unspeciﬁed, the default port 8286 is used. Accepted values are any valid port. AdminPort: T he Administration Console setup runs a script that opens ﬁrewall ports locally, to make sure the agent network trafﬁc is not blocked. T his argument allows you to conﬁgure which port is opened. If unspeciﬁed, 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 .02.00.00 Setup " /v"argument=\"value\""

Conﬁgure the Administration Console Create a Database Broker Connection 1. In the Start menu select Citrix>Workspace Environment Management>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 Services server. It must resolve from the Administration Console environment exactly as entered.

http://docs.citrix.com

p.20

Inf rastructure Service Administration Port. T he port on which the Administration Console connects to the Workspace Environment Management Infrastructure Services. Click Connect. T he ﬁrst time you connect to a new database, you will see a message warning you that you must have a valid Citrix License Server with valid licenses conﬁgured in order to use Workspace Environment Management Administration Console:

Import quickstart settings Workspace Environment Management includes XML ﬁles which pre-conﬁgure 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 ﬁles are a sample lockdown conﬁguration. All other setting groups are based on best practices. 1. To import the quickstart setting ﬁles, in the Home ribbon click Import Settings:

2. In the Setting Import Wizard, select the folder "Conﬁguration Templates" containing the quickstart setting ﬁles, then

http://docs.citrix.com

p.21

select every Setting Type.

http://docs.citrix.com

p.22

Agent Host Apr 12, 20 17

Conﬁgure the Agent Host Note T he Workspace Environment Management Agent Host cannot be installed on the Workspace Environment Management Infrastructure Services server. Agent conﬁguration requires administrative access to your Active Directory.

Prerequisites To conﬁgure the Agent, use the Citrix Workspace Environment Management Agent Host Conﬁguration v4 .0.adm or the Citrix Workspace Environment Management Agent Host Conﬁguration v4 .0.admx administrative template (provided with the Citrix Workspace Environment Management binaries).

Conﬁgure group policies Use the Group Policy Management Editor to conﬁgure a GPO with the following settings:

Connection Broker Name. T he address of the Workspace Environment Management Infrastructure Services server. It must be reachable as entered from the user environment. Agent Port: T he default value is 8286. T he agent port can be changed to use whichever port you conﬁgured for Agent

http://docs.citrix.com

p.23

connection during the Workspace Environment Management Infrastructure Services conﬁguration phase. Agent Cache Synchronisation Port: T he default value is 8285. T he agent cache synchronization port can be changed to use whichever port you conﬁgured for Agent connection during the Workspace Environment Management Infrastructure Services conﬁguration phase. VUEMAppCmd Extra Sync Delay. T ime (in milliseconds) that the Workspace Environment Management Agent Host Application Launcher should wait after launch before checking for the Workspace Environment Management Agent Host mutex. If left unconﬁgured, the Application Launcher will check at launch.

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 conﬁgure whether the WaitForNetwork registry key created during installation is active or not. Accepted values are 0 and 1. If not speciﬁed, the key will not be created during installation. SyncForegroundPolicy. T his argument allows you to conﬁgure whether the SyncForegroundPolicy registry key created during installation is active or not. Accepted values are 0 and 1. If not speciﬁed, the key will not be created during installation. GpNetworkStartTimeoutPolicyValue. T his argument allows you to conﬁgure 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 Broker 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. Please note that 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 Host setup runs a script to open ﬁrewall ports locally, to make sure the agent network trafﬁc is not blocked. T his argument allows you to conﬁgure which port is opened. If unspeciﬁed, the default port 8286 is used. Accepted values are any valid port. AgentSyncPort: T he Agent Host setup now runs a script to open ﬁrewall ports locally, to make sure the agent

http://docs.citrix.com

p.24

network trafﬁc is not blocked. T his argument allows you to conﬁgure which port is opened. If unspeciﬁed, the default port 8285 is used. Accepted values are any valid port. ServicesPipeTimeout. T his argument allows you to conﬁgure 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 Host service, thereby preventing the Agent from failing because the service launched before the network was initialised. T his argument will accept any value, in milliseconds. If unspeciﬁed, a default value of 60000 (60 seconds) will be used). CmdLineToolsDebug. If the value of this argument is 1, the setup executable will display 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 VUEM Agent as a system component, which will prevent 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 ﬁle path. If conﬁgured, the Agent's local cache ﬁle will be saved in the designated location instead of in the Agent install directory. AgentServiceUseNonPersistentCompliantHistory. T his argument allows you to specify the value of the associated registry setting. If conﬁgured, the Agent service's process optimisation history will be saved externally to an XML ﬁle in the same location as the Agent local cache (the Agent install directory by default, or the location conﬁgured 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 Setup.exe" /v"argument=\"value\"" For example:

COPY

"C:\VUEM 4.01.00.00\Cit rix Workspace Environment Management Agent Set up.exe " /v"Wait ForNet work=\"1\" GpNet workSt art Timeo

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 setting cache is built before the Agent is run. (By default, the cache is built the ﬁrst time the Agent runs). Run the command line executable AgentCacheUtility.exe in the Agent Host install directory. T his constructs the Agent Service cache or, if the cache already exists, triggers a rebuild. T he executable accepts the following command line arguments: -help: display a list of allowed arguments.

http://docs.citrix.com

p.25

-ref reshcache or -r: trigger a cache build or refresh.

http://docs.citrix.com

p.26

Upgrade a deployment Mar 21, 20 17

Introduction You can upgrade certain deployments to newer versions without having to ﬁrst set up new machines or Sites; this is called an in-place upgrade. You can upgrade: From Workspace Experience Manager version 4.0 to the latest released (current) Workspace Experience Manager version T he Workspace Environment Management components must be upgraded in the following order: 1. Infrastructure Services 2. Database 3. Administration Console 4. Agent Host

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 broker server. T his is otherwise identical to the installation procedure. You will need to reconﬁgure the Workspace Environment Management Infrastructure Services once the database upgrade (described in the next section) is over.

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.

Note Upgrading the database requires the same rights as creating a new database.

To upgrade the Workspace Environment Management database, run the Database Management Utility on your Workspace Environment Management Infrastructure Services server and click Upgrade Database.

http://docs.citrix.com

p.27

Server and Instance Name. Address of the SQL Server\instance on which the database can be hosted. Must be reachable as-entered from the Broker server. Database Name. Name of the database as it will be created in SQL. Broker uses Windows Authentication. By default, the Workspace Environment Management Infrastructure Services runs as a local system service. To select alternative credentials, select this option and type an Account Name. (Note: You cannot use the same Windows account as both the database server account and the broker service account.) Database Credentials. By default, the Database Management Utility uses the credentials of the identity it is currently running under to create the database. If this identity does not have the requisite rights to create a database, you cannot create a database. If you wish to use a SQL account instead, clear the Use Integrated Connection option. T hese credentials are not stored. Click Upgrade to launch the database upgrade process. Once you are notiﬁed that the database upgrade has completed successfully, you can exit the application. If there has been an error during the database creation, please check the VUEM Database Management Utility Log ﬁle in your Workspace Environment Management Infrastructure Services installation directory.

Step 3: Upgrade the Administration Console To upgrade the Workspace Environment Management Administration Console, run the Workspace Environment Management Administration Console setup executable. T his is otherwise identical to the installation procedure.

http://docs.citrix.com

p.28

Note All of the settings you have conﬁgured via the Administration Console are stored in the Citrix Workspace Environment Management database and are preserved during upgrade.

Step 4: Upgrade the Agent Host To upgrade the Workspace Environment Management Agent Host, run the new Workspace Environment Management Agent Host setup executable on the target machines. Make sure that no users are logged in on the machine on which you are updating the Agent Host so that setup can modify the ﬁles it needs to modify. After upgrading the agent (via installer or private patch) run the following two commands to ensure that the Agent .dll ﬁles 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.

http://docs.citrix.com

p.29

Use the Administration Console Feb 23, 20 17

Start the Administration Console To start the Workspace Environment Management Administration Console: 1. From the Start menu use the Administration Console shortcut. By default, the Administration Console launches in a disconnected state. 2. In the Administration Console ribbon click Connect. 3. In the Database Broker Connection window, enter the address of your Workspace Environment Management broker and click Connect.

Conﬁgure your installation 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.

http://docs.citrix.com

p.30

User interface reference Feb 23, 20 17

T his section describes the Citrix 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 Configured Users T ransformer Settings Advanced Settings Administration Monitoring

http://docs.citrix.com

p.31

Ribbon Feb 23, 20 17

T he ribbon in the Administration Console contains the following tabs: Home tab About tab

http://docs.citrix.com

p.32

Home tab Dec 23, 20 16

T he Home tab contains the following controls: Connect. Connect administration console to speciﬁed Infrastructure Service server. In the New Inf rastructure Server Connection dialog specify: Inf rastructure Server Name. Name of the Infrastructure Service server you wish to connect to. Inf rastructure Server Administration Port. Port on which you wish to connect to the Infrastructure Service server. Default value of 8284 is pre-populated and corresponds to the default Infrastructure Service connection port in the Infrastructure Service setup utility. Disconnect. Disconnect administration console from current Infrastructure Service server. T his allows the administrator to manage multiple Infrastructure Services from a single console, by disconnecting from one and connecting to another. Current Site. T his dropdown menu allows you to switch from one conﬁgured Citrix Workspace Environment Management site to another. Create. Opens up the site creation window. Name. Site name as it appears in the Current Site dropdown menu. Description. Site description as it appears in the site edition window. Site State. Toggles whether the site is Enabled or Disabled. When Disabled, Citrix Workspace Environment Management Agents cannot connect to the site. Edit. Opens up the Edit Site dialog, with identical options to the site creation window. Delete. Deletes the speciﬁed site and all its settings. Note that you cannot delete the default Citrix Workspace Environment Management site as it is required for Citrix Workspace Environment Management to function. You can, however, rename it. Ref resh. Refreshes the Current Site sites list. T he list will not refresh automatically if a new site is created from another administration console. Export Actions. Opens up the Actions Export Wizard: Action Types to Export. T hese checkboxes allow you to select the Action categories you wish to export. Export Actions

Export Destination. Allows you to specify the location at which the Action Export ﬁles are created.

Action Export Processing

http://docs.citrix.com

Export Actions. Creates the Action Export files in the previously-specified location. Each type of Action is exported as a separate XML file.

p.33

Import Actions. Opens the Actions Import Wizard: Export Folder. Allows you to specify which folder to import exported Actions from.

Action Type to Import. Allows you to select which type of Actions to import.

You to search for actions by entering a search string and clicking Find. Actions

Update Existing Action. Allows you to specify whether or not the Action Import will overwrite existing

Selection

site Actions with identical names. If unselected, duplicate Actions are not imported.

Actions Import Processing

Import Actions. Starts the import.

Export Settings. Opens up the Settings Export wizard. Setting Types to Export. T hese checkboxes allow you to select the setting categories you wish to Export Settings

Settings Export Processing

export. Export Destination. Allows you to specify the location at which the Setting Export ﬁles are created.

Export Settings. Creates the Settings Export files in the previously-specified location. Each category of settings is exported as a separate XML file.T his pane displays the Settings Export log during the export

Import Settings. Opens the Setting Import wizard. Export Folder. Allows you to specify which folder to import exported settings from. Export File Load

Settings Import Processing

http://docs.citrix.com

Setting Types to Import. Allows you to select which category of settings to import.

Import Settings. Imports the selected setting categories, overwriting current settings.

p.34

About tab Feb 23, 20 17

http://docs.citrix.com

p.35

Actions Feb 23, 20 17

T hese settings create user resources such as network drives or application shortcuts.

http://docs.citrix.com

p.36

Applications Feb 23, 20 17

Controls the creation of application shortcuts.

Tip To use the Citrix 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. You can then create your shortcuts as normal via XenApp, or via Citrix 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 ﬁlter 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 ﬁeld 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 ﬁlled 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 speciﬁc path in the Start Menu. By default, a new shortcut is created in Programs.

Select Icon. Allows you to browse to an icon ﬁle 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 modiﬁed to include a warning sign to denote that the icon is not available, and the user will

http://docs.citrix.com

p.37

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 Citrix 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 modiﬁes 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.

http://docs.citrix.com

p.38

Printers Feb 23, 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 ﬁlter 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 ﬁeld 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 speciﬁc credentials with which to connect to the printer.

Self-Healing. Toggles whether the printer will automatically be recreated for your users when the Agent Options tab

refreshes. 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 ﬁle (see XML printer list conﬁguration). When the Agent Host refreshes it parses this XML ﬁle 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.

http://docs.citrix.com

p.39

Network Drives Feb 23, 20 17

Controls the mapping of network drives.

Network Drive List A list of your existing network drives. You can use Find to ﬁlter 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 ﬁeld 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 speciﬁc 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.

http://docs.citrix.com

p.40

Virtual Drives Apr 12, 20 17

Controls the mapping of virtual drives. Virtual drives are Windows virtual drives or MS-DOS device names which map local ﬁle paths to drive letters.

Virtual Drive List A list of your existing virtual drives, with a unique ID. You can use Find to ﬁlter 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 ﬁeld 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 speciﬁc credentials with which to connect to the printer.

Options

http://docs.citrix.com

Action Type. Describes what type of action this resource is.

p.41

Registry Entries Feb 23, 20 17

Controls the creation of registry entries.

Registry Value List A list of your existing registry entries. You can use Find to ﬁlter 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 ﬁeld 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. Citrix 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, Citrix Workspace Environment Management will create registry entries every time the Agent refreshes. T ick this box to make Citrix Workspace Environment Management only create the registry entry once, rather than at every refresh. T his will speed 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 ﬁles: 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 ﬁeld allows you to browse to browse to a .reg ﬁle containing the registry settings you wish

http://docs.citrix.com

p.42

to import into Citrix Workspace Environment Management. For best results, the .reg ﬁle 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 ﬁle 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. Preﬁx Imported Item Names. T his adds a preﬁx to the name of all registry items imported via this wizard (e.g. "XP ONLY" or "ﬁnance"), to make it easier to organise your registry entries.

Note T he wizard cannot import registry entries with duplicate names. If your .reg ﬁle 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 wish to import the others.

http://docs.citrix.com

p.43

Environment Variables Feb 23, 20 17

Controls the creation of environment variables.

Environment Variable List A list of your existing environment variables. You can use Find to ﬁlter 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 ﬁeld 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 will not be 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.

http://docs.citrix.com

p.44

Ports Feb 23, 20 17

Controls the mapping of ports.

Ports List A list of your existing ports. You can use Find to ﬁlter 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 ﬁeld 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 will not be 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

http://docs.citrix.com

Action Type. Describes what type of action this resource is.

p.45

Ini Files Feb 23, 20 17

Controls the creation of .ini ﬁle operations, which allow you to modify .ini ﬁles.

Ini Files Operation List A list of your existing ini ﬁle operations. You can use Find to ﬁlter the list by name or ID against a text string. To add an .ini ﬁles 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 ﬁle operation, as it appears in the Ini File Operations list. Description. T his ﬁeld 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 ﬁle operation is enabled or disabled. When disabled, it will not be processed by the Agent even if assigned to a user. Target Path. T his speciﬁes the location of the .ini ﬁle that will be modiﬁed as it resolves in the user's environment. Target Section. T his speciﬁes which section of the .ini ﬁle is targeted by this operation. If you specify a non-existent section, it will be created. Target Value Name. T his speciﬁes the name of the value that will be added. Target Value. T his speciﬁes the value itself. Run Once. By default, Citrix Workspace Environment Management will perform an .ini ﬁle operation every time the Agent refreshes. T ick this box to make Citrix Workspace Environment Management only perform the operation once, rather than at every refresh. T his will speed up the Agent refresh process, especially if you have many .ini ﬁle operations assigned to your users.

Options

http://docs.citrix.com

Action Type. Describes what type of action this resource is.

p.46

External Tasks Feb 23, 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 ﬁlter 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

Options

http://docs.citrix.com

Action Type. Describes what type of action this resource is.

p.47

File System Operations Feb 23, 20 17

Controls the copying of folders and ﬁles into the user's environment.

File System Operations List A list of your existing ﬁle/folder operations. You can use Find to ﬁlter the list by name or ID against a text string.

To add a ﬁle 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 ﬁle/folder operation, as it appears in the list. Description. T his ﬁeld is only shown in the edition/creation wizard and allows you to specify additional information about the resource. Filesystem Operation State. Toggles whether the ﬁle 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 ﬁle or folder that is copied. Target Path. T he destination path for the source ﬁle or folder that is copied. Overwrite Target if Existing. Toggles whether the ﬁle/folder operation will overwrite existing ﬁles or folders with the same names in the target location. If cleared and a ﬁle or folder with the same name already exists at the target location, offending ﬁles are not copied. Run Once. By default, Citrix Workspace Environment Management will run a ﬁle system operation every time the Agent refreshes. T ick this box to make Citrix Workspace Environment Management only run the operation once, rather than at every refresh. T his will speed up the Agent refresh process, especially if you have many ﬁle system operations assigned to your users.

Options

Action Type. Describes what type of action this ﬁle/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.

http://docs.citrix.com

p.48

User DSN Feb 23, 20 17

Controls the creation of user DSNs.

User DSN List A list of your existing user DSNs. You can use Find to ﬁlter 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 ﬁeld 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 Speciﬁc Credentials. Allows you to specify credentials with which to connect to the server/database. Run Once. By default, Citrix Workspace Environment Management will create a user DSN every time the Agent refreshes. T ick this box to make Citrix Workspace Environment Management only create the user DSN once, rather than at every refresh. T his will speed 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.

http://docs.citrix.com

p.49

File Associations Feb 23, 20 17

Controls the creation of ﬁle associations in the user environment.

File Association List A list of your existing ﬁle associations. You can use Find to ﬁlter the list by name or ID against a text string. To add a ﬁle 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 ﬁle association, as it appears in the ﬁle association list. Description. T his ﬁeld is only shown in the edition/creation wizard and allows you to specify additional information about the resource. File Association State. Toggles whether the ﬁle association is enabled or disabled. When disabled, it will not be processed by the Agent even if assigned to a user. File Extension. Allows you to specify the extension used for this ﬁle 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 ﬁle extension. Command. Allows you to state any speciﬁc commands the executable should follow. Set as Def ault Action. Toggles whether the association is set as a default for that ﬁle extension or not. Overwrite. Toggles whether or not this ﬁle association will overwrite any existing associations for the speciﬁed extension. Run Once. By default, Citrix Workspace Environment Management will create a ﬁle association every time the Agent refreshes. T ick this box to make Citrix Workspace Environment Management only create the ﬁle association once, rather than at every refresh. T his will speed up the Agent refresh process, especially if you have many ﬁle associations assigned to your users.

Options

http://docs.citrix.com

Action Type. Describes what type of action this resource is.

p.50

Filters Feb 23, 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

http://docs.citrix.com

p.51

Rules Feb 23, 20 17

Rules are composed of multiple conditions. You use rules to deﬁne when an action is assigned to a user.

Filter Rule List A list of your existing rules. You can use Find to ﬁlter the list by name or ID against a text string To add a ﬁlter 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 ﬁeld 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 will not process actions using this rule even if they are assigned. Available Conditions. T hese are the ﬁlter conditions available to be added to the rule. Note. T he DateTime ﬁlter 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 Conﬁgured 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 ﬁlter to be considered triggered.

http://docs.citrix.com

p.52

Conditions Feb 23, 20 17

Conditions are speciﬁc triggers which allow you to conﬁgure the circumstances under which the Agent Host acts to assign a resource to a user.

Filter Condition List A list of your existing conditions. You can use Find to ﬁlter the list by name or ID against a text string. To add a ﬁlter 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 ﬁeld is only shown in the edition/creation wizard and allows you to specify additional information about the condition. Filter Condition State. Toggles whether the ﬁlter is enabled or disabled. When disabled, it will not appear in the rule creation/edition wizard. Filter Condition Type. T he type of ﬁlter condition type to use. See Filter conditions. Note: rules using the Always True condition will always trigger. Settings. T hese are the speciﬁc 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 speciﬁed 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.

http://docs.citrix.com

p.53

Assignments Feb 23, 20 17

Tip Before assigning actions to users you need to perform the following steps in the order given: Configure users, see Configured Users. 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. To assign actions to users/groups: 1. In the Conﬁgured 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 ﬁne-tune the behaviour of the assignment.

http://docs.citrix.com

p.54

Action Assignment Feb 23, 20 17

Conﬁgured Users T his is your list of conﬁgured users and groups (see Conﬁgured Users). Double-click a user or group to show the assignments menu. You can use Find to ﬁlter 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 ﬁlter 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 conﬁgure them (application shortcut locations, default printers, drive letter, and so on).

http://docs.citrix.com

p.55

Modelling Wizard Feb 23, 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.

http://docs.citrix.com

p.56

System Optimization Feb 23, 20 17

T hese settings allow you to optimize applications and desktops. Fast Logoff CPU Management Memory Management I/O Management Process Management

http://docs.citrix.com

p.57

Fast Logoff Feb 23, 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 Speciﬁc Groups. Allows you to exclude speciﬁc groups of users from fast logoff.

http://docs.citrix.com

p.58

CPU Management Feb 23, 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 conﬁned to the selected number of cores (CPU/Core Usage Limit) while Spike Protection is triggered. Enable Intelligent CPU Optimization. If enabled, the Agent will keep a list of processes that have triggered spike protection and intelligently optimize process CPU priority based on that process history. Processes that repeatedly trigger spike protection is assigned lower CPU priority at launch than processes that behave correctly. Enable Intelligent I/O Optimization. If enabled, the Agent will keep a list of processes that have triggered spike protection and intelligently optimize process I/O priority based on that process history. Processes that repeatedly trigger spike protection is assigned lower I/O priority at launch than processes that behave correctly. Exclude Speciﬁed 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 speciﬁed processes.

CPU Af ﬁnity Enable Process Af ﬁnity. If enabled, this allows you to manually set process afﬁnity for speciﬁed 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.

http://docs.citrix.com

p.59

http://docs.citrix.com

p.60

Memory Management Feb 23, 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 is 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 Speciﬁed Processes. Allows you to exclude processes from memory management by name (for example, notepad.exe).

http://docs.citrix.com

p.61

I/O Management Feb 23, 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 speciﬁed processes.

http://docs.citrix.com

p.62

Process Management Feb 23, 20 17

T hese settings allow you to whitelist or blacklist speciﬁc processes.

Process Management 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 WEM UI Agent executable is running in the user's session. To do this use the Main Conﬁguration 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 Conﬁguration.

Process BlackList T hese settings allow you to blacklist speciﬁc 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 Speciﬁed Groups. Allows you to exclude speciﬁc user groups from process blacklisting.

Process WhiteList T hese settings allow you to whitelist speciﬁc 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 Speciﬁed Groups. Allows you to exclude speciﬁc user groups from process whitelisting (they are able to run all processes).

http://docs.citrix.com

p.63

Policies and Proﬁles Feb 23, 20 17

T hese settings allow you to replace user GPOs and conﬁgure user proﬁles. Environmental Settings Microsoft USV Settings Citrix Profile Management Settings VMware Persona settings

http://docs.citrix.com

p.64

Environmental Settings Feb 23, 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.

Start Menu T hese options modify the user's Start Menu. Process Environmental Settings. T his checkbox toggles whether or not the Agent will process 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.

Desktop 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.

Windows Explorer 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 Speciﬁed 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 Speciﬁed Drives. If enabled, the listed drives are blocked. Neither the user nor their applications can access them.

Control Panel 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 speciﬁed 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 speciﬁed 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.

Known Folders Management

http://docs.citrix.com

p.65

Disable Speciﬁed Known Folders. Prevents the creation of the speciﬁed user proﬁle known folders at proﬁle creation.

SBC/HVD Tuning User Environment: Advanced Tuning. T hese options allow you to optimize performance in SBC/HVD environments.

http://docs.citrix.com

p.66

Microsoft USV Settings Feb 23, 20 17

T hese settings allow you to optimize Microsoft User State Virtualization (USV).

Roaming Proﬁles Conﬁguration T hese settings allow you to conﬁgure Citrix Workspace Environment Management's integration with Microsoft roaming proﬁles. Process USV Conﬁguration. T his checkbox toggles whether or not the Agent will process USV settings. If it is cleared, no USV settings are processed. Set Windows Roaming Proﬁle Path. T his ﬁeld allows you to specify the path to your Windows proﬁles. Set RDS Roaming Proﬁles Path. T his ﬁeld allows you to specify the path to your RDS roaming proﬁles. Set RDS Home Drive Path. T his ﬁeld allows you to specify the path to your RDS home drive, as well as the drive letter it will appear with in the user environment.

Roaming Proﬁles Advanced Conﬁguration T hese are the advanced roaming proﬁle optimization options. Enable Folder Exclusions. If enabled, the listed folders are not included in a user’s roaming proﬁle. T his allows you to exclude speciﬁc folders known to contain large amounts of data which the user does not need to have as part of their roaming proﬁle. 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 Proﬁles. If enabled, the Agent will delete cached copies of the roaming proﬁles. Add Administrators Security Group to Roaming User Proﬁles. If enabled, the Administrators group is added as owner to roaming user proﬁles. Do Not Check f or User Ownership of Roaming Proﬁles Folders. If enabled, the Agent will not check to see if the user owns the roaming proﬁles folder before acting. Do Not Detect Slow Network Connections. If enabled, will skip the connection speed detection. Wait f or Remote User Proﬁle. If enabled, the Agent will wait for the remote user proﬁle to be fully downloaded before processing its settings. Proﬁle Cleansing. Opens the Proﬁles Cleanser wizard, which allows you to clean up existing proﬁles. Cleanse Proﬁles. T his button will cleanse the selected proﬁles per the Folder Exclusion settings. Scan Proﬁles Folder. Will scan the speciﬁed folder with the speciﬁed recursion settings to ﬁnd user proﬁles, then will display all proﬁles found. Proﬁles Root Folder. T his ﬁeld allows you to specify the root folder of your user proﬁles. You can also Browse to this folder if you wish.

http://docs.citrix.com

p.67

Search Recursion. T his setting controls how many levels of recursion the user proﬁle search will go through.

Folders Redirection Process Folder Redirection Conﬁguration. 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.

http://docs.citrix.com

p.68

Citrix Proﬁle Management Settings Feb 23, 20 17

T hese settings control Citrix Workspace Environment Management's integration with Citrix User Proﬁle Management (UPM) technology. Not e Some options only work with speciﬁc versions of UPM; please consult the relevant Citrix documentation for detailed instructions.

T hese settings control the main Citrix Proﬁle Management parameters. Enable P roﬁle Management Conﬁgurat ion . T his checkbox toggles whether or not the Agent processes Citrix Proﬁle Management settings. If cleared, none of the Proﬁle Management settings are processed. Enable P roﬁle Management . T his checkbox toggles whether or not the Agent will process the settings in the Proﬁle Management section of this page. If disabled, the Agent will not process any of these. Set processed groups . Allows you to specify which groups are processed by Proﬁle Management. Only the speciﬁed groups will have their Proﬁle Management settings processed. If left blank, all groups are processed. Set excluded groups . Allows you to specify which groups to exclude from UPM. P rocess logons of local administ rat ors . If enabled, local administrator logons are treated the same was as non-admin logons for Proﬁle Management. Set pat h t o user st ore . T his ﬁeld allows you to specify the path to the user store directory. Enable act ive writ e back . If enabled, proﬁles are written back to the user store during the user's session. T his helps prevent data loss. Enable Of ﬂine proﬁle support . If enabled, proﬁles are cached locally for use while not connected. Enable act ive writ e back regist ry . 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 Proﬁle Management proﬁle handling. Delet e local cached proﬁles on logof f . If enabled, locally-cached proﬁles are deleted when the user logs off. Set delay bef ore delet ing cached proﬁles . Allows you to specify a delay (in seconds) before cached proﬁles are deleted at log-off. Enable Migrat ion of Exist ing P roﬁles . If enabled, existing Windows proﬁles are migrated to Proﬁle Management at login. Enable local proﬁle conﬂict handling . T his setting conﬁgures how Citrix Workspace Environment Management handles cases where Proﬁle Management and Windows proﬁles conﬂict. Enable t emplat e proﬁle . If enabled, this will use a template proﬁle at the indicated location.

http://docs.citrix.com

p.69

Templat e proﬁle overrides local proﬁle . If enabled, the template proﬁle will override local proﬁles. Templat e proﬁle overrides roaming proﬁle . If enabled, the template proﬁle will override roaming proﬁles. Templat e proﬁle used as Cit rix mandat ory proﬁle f or all logons. If enabled, the template proﬁle will override all other proﬁles.

T hese options control advanced UPM settings. Set number of ret ries when accessing locked ﬁles . Conﬁgures the number of times the Agent will retry accessing locked ﬁles. Set Direct ory of MF T cache ﬁle . Allows you to specify the MFT cache ﬁle directory. P rocess Int ernet cookie ﬁles on logof f . If enabled, stale cookies are deleted at logoff. Delet e redirect ed f olders . If enabled, will delete local copies of redirected folders. Disable aut omat ic conﬁgurat ion . If enabled, dynamic conﬁguration will be disabled. Log of f user if a problem is encount ered . If enabled, users are logged off rather than switched to a temporary proﬁle if a problem is encountered. Cust omer experience improvement program. If enabled, Proﬁle 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 Proﬁle Management logging. Enable Logging . Enables/disables logging of Proﬁle Management operations. Conﬁgure Log Set t ings . Allows you to specify which types of events to include in the logs. Set Maximum Size of Log F ile . Allows you to specify a maximum size in bytes for the log ﬁle. Set Pat h t o Log F ile . Allows you to specify the location at which the log ﬁle will be created.

T hese options control Proﬁle Management registry settings. NT USER.DAT Backup . If selected, Proﬁle Management maintains a last known good backup of the NT USER.DAT ﬁle. If Proﬁle Panagement detects corruption, it uses the last known good backup copy to recover the proﬁle. Enable Def ault Exclusion List . Default list of registry keys in the HKCU hive that are not synchronized to the user's proﬁle. If selected, registry settings which are selected in this list are forcibly excluded from Proﬁle Management proﬁles. Enable Regist ry Exclusions . Registry settings in this list are forcibly excluded from Proﬁle Management proﬁles. Enable Regist ry Inclusions . Registry settings in this list are forcibly included in Proﬁle Management proﬁles.

http://docs.citrix.com

p.70

T hese options control ﬁle system exclusions for Proﬁle Management. Enable Def ault Exclusion List - Direct ories . Default list of directories ignored during synchronization. If selected, folders which are selected in this list are excluded from the Proﬁle Management synchronization. Enable F ile Exclusions . If enabled, the listed ﬁles are not included in a user's Proﬁle Management proﬁle. T his allows you to exclude speciﬁc folders known to contain large amounts of data which the user does not need to have as part of their Proﬁle Management proﬁle. T he list is pre-populated with default Windows 7 exclusions, and can be pre-populated with default Windows XP exclusions instead. Enable F older Exclusions . If enabled, the listed folders are not included in a user's Proﬁle Management proﬁle. T his allows you to exclude speciﬁc folders known to contain large amounts of data which the user does not need to have as part of their Proﬁle Management proﬁle. T he list is pre-populated with default Windows 7 exclusions, and can be pre-populated with default Windows XP exclusions instead. P roﬁle Cleansing . Opens the P roﬁle Cleansing wizard, which allows you to clean up existing proﬁles. P roﬁles Root F older. T his ﬁeld allows you to specify the root folder of your user proﬁles. You can also Browse to this folder if you wish. Search Recursion . T his setting controls how many levels of recursion the user proﬁle search will go through. Scan P roﬁles F older. Will scan the speciﬁed folder with the speciﬁed recursion settings to ﬁnd user proﬁles, then will display all proﬁles found. Cleanse P roﬁles . T his button will cleanse the selected proﬁles per the Folder Exclusion settings.

T hese options control Proﬁle Management synchronization settings. Enable Direct ory Synchronizat ion . If enabled, the listed folders are synchronized with the proﬁle store at refresh. Enable F ile Mirroring . If enabled, the listed ﬁles are mirrored to the proﬁle store, ensuring users always get the most upto-date versions of these ﬁles. Enable F older Mirroring . If enabled, the listed folders are mirrored to the proﬁle store, ensuring users always get the most up-to-date versions of these folders.

T hese options control streamed user proﬁle settings. Enable P roﬁle St reaming . If disabled, none of the settings in this section are processed. Always cache . If enabled, ﬁles of the speciﬁed size (in megabytes) or larger will always be cached. Set t imeout f or pending area lock ﬁles : frees up ﬁles so they are written back to the user store from the pending area after the speciﬁed time, in the event that the user store remains locked when a server becomes unresponsive. Set st reamed user proﬁle groups . T his list determines which user groups streamed proﬁles are used for.

http://docs.citrix.com

p.71

T hese options control cross-platform settings. Enable cross-plat f orm set t ings . If disabled, none of the settings in this section are processed. Set cross-plat f orm set t ings groups . Allows you to specify the user groups for which cross-platform proﬁles are used. Set pat h t o cross-plat f orm deﬁnit ions . Allows you to specify the path to your cross-platform deﬁnition ﬁles. Set pat h t o cross-plat f orm set t ing st ore . Allows you to specify the path to your cross-platform setting store. Enable source f or creat ing cross-plat f orm set t ings . Enables a source platform for cross-platform settings.

http://docs.citrix.com

p.72

VMware Persona settings Feb 23, 20 17

T hese settings control Citrix Workspace Environment Management's integration with VMware View Persona Management. Please note that some options only work with speciﬁc versions of View Persona Management; please consult the relevant VMware documentation for detailed instructions.

T hese settings control the main Persona parameters. Enable VMware P ersona Set t ings Management . T his checkbox toggles whether or not the Agent will process Persona settings management instructions. If it is cleared, none of the Persona settings are processed. Manage User P ersona . When enabled, the user's persona settings are managed dynamically. T he proﬁle upload interval is used to determine how often to upload proﬁle changes to the network. Enable P ersona Reposit ory Locat ion . T his setting controls the UNC path to the repository where user proﬁles are stored. Override Act ive Direct ory User P roﬁle Pat h . If enabled, the AD user proﬁle path is overridden with the Persona repository location if both have been conﬁgured. Remove Local P ersona at Logof f . When enabled, each user's locally stored proﬁle is removed at log off. Remove Locally St ored P ersonas When Users Log Of f . If enabled, this deletes Local Settings and AppData\Local when the persona is removed. Roam Local Set t ings F olders . When enabled, the local settings folders are roamed along with the rest of the user's proﬁle. Enable Background Download f or Lapt ops . When enabled, laptop users are allowed to background download their proﬁle. Cleanup CLF S F iles . If enabled, CLFS logs are removed at logoff.

Hide Local Of ﬂine F ile Icon . When enabled, the ofﬂine icon is hidden when locally viewing most ofﬂine persona ﬁles. Show P rogress When Downloading Large F iles . When enabled, a progress window is shown when downloading large ﬁles from the persona repository. T he minimum ﬁle size required to show the progress window can be speciﬁed as well. Show Crit ical Errors t o Users . When enabled, critical tray icon alerts pertaining to replication or network connectivity failure is displayed to the user. Set Logging F ilename . T he full pathname of the local View Persona Management log ﬁle. T his path should include the ﬁle name, and cannot be a UNC path. Set Logging Dest inat ion . T hese settings allow you to specify whether to send log messages to the local log ﬁle or the debug port.

http://docs.citrix.com

p.73

Set Logging F lags . T hese settings allow you to control what messages are logged. Set Debug F lags . T hese settings allow you to control what messages are logged in debug mode.

Enable F iles and F olders t o P reload . When enabled, the selected ﬁle and folder paths are downloaded at user logon and replicated when ﬁles are changed. Exceptions can also be conﬁgured.

Enable Windows Roaming P roﬁle Synchronisat ion . When enabled, the selected ﬁle and folder paths are downloaded at user logon and replicated during logoff. Exceptions can also be conﬁgured.

Enable F iles and F olders Excluded f rom Roaming . When enabled, the selected ﬁle and folder paths are completely excluded from roaming. Exceptions can also be conﬁgured to select subfolders and ﬁles within the folders excluded from roaming that need to be roamed.

Enable F olders t o Background Download . When enabled, the selected ﬁle and folder paths are downloaded in the background after users log on. Exceptions can also be conﬁgured. Enable Excluded P rocesses . When enabled, the selected processes' I/O is ignored by Persona.

T hese settings allow you to conﬁgure redirection for individual user proﬁle folders.

Enable F iles and F olders Excluded f rom Redirect ion . When enabled, the selected ﬁle and folder paths are completely excluded from redirection. Exceptions can also be conﬁgured to select subfolders and ﬁles within the folders excluded from redirection that need to be redirected.

http://docs.citrix.com

p.74

Conﬁgured Users Feb 23, 20 17

T his page allows you to add users and groups to Citrix Workspace Environment Management.

Note Users and groups must be added to Citrix Workspace Environment Management before the Agent can do anything for them.

http://docs.citrix.com

p.75

Conﬁgured Users Feb 23, 20 17

A list of your existing users and groups. You can use F ind to ﬁlter the list by name or ID against a text string. To add a use r: 1. Use the context menu Add command. 2. Enter details in theWindows Select Users dialog, then click OK . Name . T he name of the user or group. Descript ion . T his ﬁeld is only shown in the Edit It em dialog and allows you to specify additional information about the user or group. It em St at e . T his allows you to choose whether a user/group is enabled or disabled. If disabled, it is not available to assign actions to. It em P riorit y . T his allows you to conﬁgure priority between different groups and user accounts. In case of conﬂict (for example, when mapping network drives), the group or user account with the higher priority will win out.

http://docs.citrix.com

p.76

Transformer Settings Feb 23, 20 17

T hese options allow you to conﬁgure the Transformer thin-client mode. General Advanced

http://docs.citrix.com

p.77

General Feb 23, 20 17

T hese settings control the appearance and basic settings for Transformer. Enable T ransf 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 conﬁgured 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 Int erf 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, Cust om T it le . 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 Select ion . If enabled, users are allowed to pick what language the Transformer interface is in. Show Navigat ion But t ons . 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 deﬁned 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 Applicat ion Panel. If enabled, this will display a panel with the user's applications as assigned in Citrix Workspace Environment Management. Aut o-Hide Applicat ion 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 Ct rl+ Alt + U. T his is designed to allow administrators and support agents to troubleshoot the user environment without restrictions.

Enable Sit e 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.

http://docs.citrix.com

p.78

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 P rocess 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 speciﬁed in Process Command Line. If terminated, the process will simply be re-launched. P rocess Command Line . T his ﬁeld allows you to enter the command line for a speciﬁc process (for example, the path to mstsc.exe to launch an RDP connection). P rocess Argument s . T his ﬁeld 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).

http://docs.citrix.com

p.79

Enable Aut o-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 P ort al When Session is Launched . If enabled, the web frontend speciﬁed in the General Settings page is logged off when the user's desktop session is launched. End of Session Opt ions . 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 Speciﬁed T ime . If enabled, the Agent will automatically shut off the environment it is running in at the speciﬁed 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 speciﬁed length of time.

http://docs.citrix.com

p.80

Advanced Settings Feb 23, 20 17

T hese settings modify how and when the Agent Host processes actions.

http://docs.citrix.com

p.81

Conﬁguration Apr 12, 20 17

T hese options control basic Agent behaviour.

Agent Act ions . T hese settings determine whether or not the Agent processes actions conﬁgured in the Actions tab. T hese settings apply at login, automatic refresh, or manual (user or admin triggered) refresh. P rocess Applicat ions . When selected, the Agent processes application actions. P rocess P rint ers . When selected, the Agent processes printer actions. P rocess Net work Drives . When selected, the Agent processes network drives actions. P rocess Virt ual Drives . When selected, the Agent processes virtual drive actions. (Virtual drives are Windows virtual drives or MS-DOS device names which map a local ﬁle path to a drive letter.) P rocess Regist ry Values . When selected, the Agent processes registry entry actions. P rocess Environment Variables . When selected, the Agent processes environment variable actions. P rocess P ort s . When selected, the Agent processes port actions. P rocess Ini F iles Operat ions . When selected, the Agent processes .ini ﬁle actions. P rocess Ext ernal T asks . When selected, the Agent processes external task actions. P rocess F ile Syst em Operat ions . When selected, the ﬁle system operation actions. P rocess F ile Associat ions . When selected, the Agent processes ﬁle association actions. P rocess User DSNs . When selected, the Agent processes user DSN actions. Agent Service Act ions . T hese settings determine when the Agent service processes its instructions. Launch Agent at Logon . Determines whether or not the Agent executable is run at logon. Launch Agent at Reconnect . Determines whether or not the Agent executable is run when reconnecting to a published desktop. Launch Agent f or Admins . Determines whether or not the Agent executable will run when a user is an administrator. Agent T ype . Determines whether the user is presented with a user interface (UI) or not (CMD) when interacting with the Agent. Enable (Virt ual) Deskt op Compat ibilit y . T his setting is necessary for the Agent to be launched when the user is logged in to session 1. It should be enabled if you have any users on physical desktops or VDI. Execut e only CMD Agent in P ublished Applicat ions . If enabled, the Agent will launch in command line mode when launching a published application, rather than in GUI mode. T his will display a command prompt instead of the

http://docs.citrix.com

p.82

Agent splash screen.

T hese settings determine whether or not the Agent performs an environment cleanup on refresh. Short cut Delet ion at St art up . T he Agent will delete all shortcuts of the selected type whenever it refreshes. Delet e Net work Drives at St art up . If enabled, the Agent will delete all network drives whenever it refreshes. Delet e Net work P rint ers at St art up . If enabled, the Agent will delete all network printers whenever it refreshes. P reserve Aut o-creat ed P rint ers . If enabled, the Agent will not delete auto-created printers. P reserve Speciﬁc P rint ers . If enabled, the Agent will not delete any of the printers in this list.

T hese options control the Agent Host's settings. Enable Agent Logging . Enables the Agent Host log ﬁle. Log F ile Locat ion . By default, this is the root of the logged-in user's proﬁle. Debug Mode . T his enables verbose logging for the Agent Host. Enable Of ﬂine Mode . If this is disabled, the Agent Host will not fall back on its cache if it cannot connect to the Broker Service. Not e In order for Ofﬂine Mode to work, SQL Server Compact Edition 3.5 SP2 must be installed in the user's environment and on the Citrix Workspace Environment Management Broker server. Use Cache Even if Online . If enabled, the Agent Host will always read its settings and actions from its cache (which is built whenever the Agent service cycles). Ref resh Set t ings . If enabled, the Agent will trigger a Windows refresh whenever an Agent refresh occurs. Ref resh on Environment al Set t ing Change . If enabled, the Agent will always trigger a Windows refresh if an environmental setting has been modiﬁed. Asynchronous P rint er P rocessing . If enabled, the Agent will process printers asynchronously from other actions. Asynchronous Net work Drive P rocessing . If enabled, the Agent will process network drives asynchronously from other actions. Init ial Environment /Deskt op Cleanup . If enabled, the Agent will clean up the environment/desktop at ﬁrst login only. Check Applicat ion Exist ence . If enabled, the Agent will check 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 Error! Reference source not found. for normal behavior when the Agent Host encounters a variable). Enable Cross-Domain User Group Search . If enabled, the Agent Host will query user groups in all domains under your AD. Please be aware that this is an extremely time-intensive process and that this option should not be used if at all possible.

http://docs.citrix.com

p.83

Broker Service T imeout . T his allows you to conﬁgure the timeout value for the Agent Host to Broker connection, beyond which the Agent Host will switch to its cache if conﬁgured to do so. Default value is 2000 milliseconds. Direct ory Services T imeout . T his allows you to conﬁgure the timeout value for directory services on the Agent Host machine, beyond which the Agent Host will use its own internal cache of user group associations. Default value is 2000 milliseconds. Net work Resources T imeout . T his allows you to conﬁgure the timeout value for resolving network resources (e.g. network drives or ﬁle/folder resources located on the network), beyond which the Agent Host will pass on the action and mark it as failed. Default value is 500 milliseconds. Agent Max Degree of Parallelism. T his allows you to control the maximum number of threads the Agent Host is allowed to operate at. Default value is 0 (as many threads as physically allowed by the processor), 1 is single-threaded, 2 is dual-threaded, etc. You should not need to modify this value in most cases.

Enf orce Execut ion of Agent Act ions . If these settings are enabled, the Agent Host will always refresh those actions, even if no changes have been made. Revert Unassigned Act ions . If these settings are enabled, the Agent Host will delete any unassigned actions when it next refreshes. Aut omat ic Ref resh . If enabled, the Agent Host will refresh automatically. By default, the refresh delay is 30 minutes.

Act ion P rocessing on Reconnect ion . T hese settings control what actions the Agent Host processes upon reconnection to the user environment.

F ilt er P rocessing Enf orcement . If enabled, these options will force the Agent Host to re-process ﬁlters at every refresh.

T hese settings conﬁgure 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 Set t ings Ref resh Delay . T his setting controls how long the Agent Host service will wait to refresh its SQL connection settings. Agent Ext ra 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 speciﬁed user groups.

http://docs.citrix.com

p.84

F orbidden Drives . Any drive letter added to this list is excluded from the drive letter selection when assigning a drive resource.

http://docs.citrix.com

p.85

UI Agent Personalization Apr 10 , 20 17

T hese options allow you to personalize the look and feel of the Citrix Workspace Environment Management Agent Host as well as help desk and self-service facilities.

T hese options control the Agent Host's help desk functionalities. Help Link Act ion . T his ﬁeld controls what happens when the user clicks on the "Help" link in the Citrix Workspace

http://docs.citrix.com

p.86

Environment Management Agent Host. Cust om Link Act ion . T his ﬁeld controls what happens when the user clicks on the "Support" link in the Citrix Workspace Environment Management Agent Host. Enable Screen Capt ure . 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 t o Support Opt ion . If enabled, the user is able to send screenshots and log ﬁles directly to the nominated support email address, with the speciﬁed template. T his requires a working, conﬁgured email client. Cust om Subject . If enabled, the support email generated by the Citrix Workspace Environment Management Agent Host screen capture utility is sent with the speciﬁed subject. Email Templat e . T his ﬁeld 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 conﬁgure the email template to include useful information. See Dynamic tokens for a list of hash-tags which can be used in the email template. Not e Users are only presented with the option to enter a comment if the ##UserScreenCapt ureComment ## hash-t ag is included in the email template. Use SMT P t o Send Email. If enabled, this will send the support email using SMT P instead of MAPI. Test SMT P . Tests your SMT P settings as entered above to verify that they are correct.

Shut Down At Speciﬁed T ime . If enabled, the Agent Host will automatically shut off the environment it is running in at the speciﬁed 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 speciﬁed length of time.

http://docs.citrix.com

p.87

T hese settings control administrative functions such as delegation, user statistics, and change logging.

http://docs.citrix.com

p.88

T hese options allow you to nominate Citrix Workspace Environment Management administrators (users or groups who have the right to connect to the current site via the Administration Console).

http://docs.citrix.com

p.89

T ransf ormer Managers can manage Transformer settings. Advanced Set t ings Managers can manage advanced settings (enabling or disabling action processing, cleanup actions, etc.). St at e . T his controls whether the selected user/group is enabled or disabled. If disabled, the user/group is treated as if they were not a Citrix Workspace Environment Management administrator and is unable to use the Citrix Workspace Environment Management Administration Console. T ype . T his ﬁeld is informative only and indicates whether the selected entity is a user or group. If the Global Administ rat or checkbox is cleared the following controls are enabled: Sit e Name . All Citrix Workspace Environment Management sites belonging to the database this broker is connected to. Enabled . Select to enable this administrator for the speciﬁed Citrix Workspace Environment Management site. If disabled, the user/group is treated as if it were not an administrator of that site and is unable to access it. P ermissions . Select a permission level for the selected user/group for each Citrix Workspace Environment Management site attached to this broker.

http://docs.citrix.com

p.90

Users Feb 23, 20 17

T his page displays statistics about your Citrix Workspace Environment Management installation.

Statistics T his page displays a summary of users whose Agent Hosts have connected to this database. Users Summary . Displays a count of total users who have reserved a Citrix Workspace Environment Management license, for both the current site and all sites. Also displays a count of new users in the last 24 hours and in the last month. Users Hist ory . T his displays connection information for all the users associated with this site, including the last connection time, the name of the machine from which they last connected and the Agent Host type (UI or CMD) and version. You can use F ind to ﬁlter the list by name or ID against a text string.

http://docs.citrix.com

p.91

Agents Feb 23, 20 17

T his page displays statistics about your Citrix Workspace Environment Management installation.

Statistics T his page displays a summary of Agent Host connected to this database. Agent s Summary . Displays a count of total Agent Hosts who have reserved a Citrix Workspace Environment Management license, for both the current site and all sites. Also displays a count of new Agent Hosts in the last 24 hours and in the last month. Agent s Hist ory . T his displays connection information for all the Agent Hosts associated with this site, including the last connection time, the name of the device from which they last connected and the Agent Host version. You can use F ind to ﬁlter the list by name or ID against a text string.

http://docs.citrix.com

p.92

Administration Log Feb 23, 20 17

T he administration log displays a list of all changes made to your Citrix Workspace Environment Management settings. By default, the log is unpopulated until the log is refreshed manually. F ilt ering Opt ions . T hese options allow you to ﬁlter the log by site, as well as specifying bounding dates. Export Log . T his button will export the log in XLS format. Ref resh Log . T his button will refresh the log. Clear Log . T his button ﬂushes the log. T his applies f or all users, and cannot be undone. Clearing the log leaves an event in the new log indicating this has been done. T his option is only available to Global Full Access administrators.

http://docs.citrix.com

p.93

Monitoring Feb 23, 20 17

T hese pages contain detailed user login and machine boot reports. You can Export all reports in various formats.

http://docs.citrix.com

p.94

Daily Reports Feb 23, 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.

http://docs.citrix.com

p.95

User Trends Feb 23, 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.

http://docs.citrix.com

p.96

User & Device Reports Feb 23, 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.

http://docs.citrix.com

p.97

Conﬁguration Feb 23, 20 17

Report Opt ions . 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.

http://docs.citrix.com

p.98

Dynamic tokens Feb 23, 20 17

Sometimes you need to manipulate strings within a script to map drives or launch applications. T he following string operations are accepted by the Agent Host:

#Left (st ring,lengt h)#

#Right (st ring,lengt h)#

#Truncat e(st ring,lengt h)#

&Trim(st ring)&

&RemoveSpaces(st ring)&

&Expand(st ring)&

$Split (st ring,[split t er],index)$

#Mid(st ring,st art index)#

!Mid(st ring,st art index,lengt h)!

Note All Operators are case sensitive. String operations are also supported with hashtags and Active Directory attributes. In cases where your string operations are nested, Mid operations are always performed last.

http://docs.citrix.com

p.99

Hash-tags are a replacement feature embedded in almost all of Workspace Environment Management's item processing. T he following example illustrates how you use hash-tags: To write to an .ini ﬁle, you can use % UserName% in the .ini ﬁle's path and Citrix Workspace Environment Management will process it and expand the ﬁnal directory. However, assessing the value which Citrix Workspace Environment Management writes in the .ini itself is more complicated: you may want to write % UserName% literally or to write the expanded value. To increase ﬂexibility, ##UserName## exists as a hash-tag, so that using % UserName% for a value will write it literally and ##UserName## will write the expanded value. T he following hash-tags have been implemented for general use:

##UserProﬁle##

##UserInit ials##

##UserAppDat a##

##UserPersonal##

##UserDocument s##

##UserDeskt op##

##UserFavorit es##

##UserTemplat es##

##Comput erName##

##Client Name##

http://docs.citrix.com

p.100

##Default RegValue##

##UserLDAPPat h##

##VUEMAgent Folder##

##RDSSessionID##

##RDSSessionName##

##Client Remot eOS##

##Client OSInfos##

Additionally, hash-tag ##UserScreenCapt ureComment ## has been implemented for use in speciﬁc 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, the user is presented with a comment ﬁeld located below the screen capture in the Citrix Workspace Environment Management Agent Host 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.

If you need to work with Active Directory Attributes, Citrix 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.

Note All AD attributes are case sensitive.

http://docs.citrix.com

p.101

http://docs.citrix.com

p.102

Common Control Panel applets Feb 23, 20 17

T he following applets are common control panel applets in Windows: Applet name

Canonical name

Action Center

Microsoft.ActionCenter

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

http://docs.citrix.com

p.103

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

MPIOConﬁguration

Microsoft.MPIOConﬁguration

Network and Sharing Center

Microsoft.NetworkAndSharingCenter

Notiﬁcation Area Icons

Microsoft.NotiﬁcationAreaIcons

Pen and Touch

Microsoft.PenAndTouch

Personalization

Microsoft.Personalization

Phone and Modem

Microsoft.PhoneAndModem

Power Options

Microsoft.PowerOptions

Programs and Features

Microsoft.ProgramsAndFeatures

http://docs.citrix.com

p.104

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

Troubleshooting

Microsoft.Troubleshooting

T SAppInstall

Microsoft.T SAppInstall

User Accounts

Microsoft.UserAccounts

Windows Defender

Microsoft.WindowsDefender

Windows Firewall

Microsoft.WindowsFirewall

Windows Mobility Center

Microsoft.MobilityCenter

Windows To Go

Microsoft.PortableWorkspaceCreator

Windows Update

Microsoft.WindowsUpdate

http://docs.citrix.com

p.105

Work Folders

http://docs.citrix.com

Microsoft.WorkFolders

p.106

Log parser Feb 23, 20 17

Workspace Environment Management includes a log parser application which is located in the Workspace Environment Management Agent Host installation directory:

T he Log Parser allows you to open any Workspace Environment Management Agent Host log, making them searchable and ﬁlterable. 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 ﬁle (the name and port of the Workspace Environment Management Broker service it ﬁrst connected to, as well as the Agent Host version and username).

http://docs.citrix.com

p.107

XML printer list conﬁguration Apr 24 , 20 17

Workspace Environment Management includes the ability to conﬁgure user printers via an XML printer list ﬁle. After you have created an XML printer list ﬁle, 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 speciﬁc Windows credentials are supported.

T he basic structure is as follows:

Encoding is in UT F-8. T he object representing every client and associated device is of the following type:

SerializableKeyValuePair>>

Individual tags for each device are as follows:

http://docs.citrix.com

p.108

DEVICE1 ...

Each block of devices must be matched to a speciﬁc client or computer name. T he tag contains the relevant name. T he tag contains a list of VUEMUserAssignedP rint er objects matching the printers assigned to the speciﬁed client.

http://docs.citrix.com

p.109

DEVICE1 ...

Each conﬁgured printer must be deﬁned in a tag, using the following attributes: . T his is the Workspace Environment Management printer ID for the conﬁgured printer. Each printer must have a different ID. Not e T he XML Printer List action conﬁgured 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 conﬁgured in the XML list. . Contains the site ID for the relevant Workspace Environment Management site, which must match the ID of an existing site. . Speciﬁes the state of the printer where 1 is active and 0 is disabled. . Must always be 0. . Must be 0. T he use of speciﬁc Windows credentials is not currently supported. . If 1, printer is the default Windows printer. If 0, it is not conﬁgured as default. . Must always be 1. . Must always be 1. If printer properties are subsequently modiﬁed, increment this value by 1 to notify the Agent Host and ensure the printer action is re-processed. . T his is the printer name as perceived by the Workspace Environment Management Agent Host. T his ﬁeld cannot

http://docs.citrix.com

p.110

be left blank. . T his is the printer description as perceived by the Workspace Environment Management Agent Host. T his ﬁeld can be blank. . T his is unused and should be left blank. . T his is the UNC path to the printer. . Contains the name of the Windows account used when specifying Windows credentials for connection. [Currently unsupported. Leave this ﬁeld blank.]. . Contains the password for the Windows account used when specifying Windows credentials for connection. [Currently unsupported. Leave this ﬁeld blank.]. . T his contains advanced settings. Do not alter it in any way.

> ;< ;VUEMAct ionAdvancedOpt ion> ;< ;Name> ;SelfHealingEnabled< ;/Name> ;< ;Value> ;0< ;/Value> ;< ;/VUEMAc

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 an active printer with the name HP LaserJet 2200 Series printer on the client or computer DEVICE1, the UNC path \\server.example.net \HP LaserJet 2200 Series , and which is not conﬁgured as the default printer:

DEVICE1 1 1

http://docs.citrix.com

p.111

1 0 0 0 1 1 HP LaserJet 2200 Series \\server.example.net \HP LaserJet 2200 Series

< ;?xml version="1.0" encoding="ut f-8"?> ;< ;ArrayOfVUEMAct ionAdvancedOpt ion xmlns:xsi="ht t p://w

http://docs.citrix.com

p.112

Filter conditions Feb 23, 20 17

Workspace Environment Management includes the following ﬁlter conditions which you use to conﬁgure the circumstances under which the Agent Host assigns resources to users. (For details of using these conditions in the Administration Console, see ﬁlter 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

http://docs.citrix.com

p.113

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

Expected value type

N/A

Expected result type

Expected syntax

Returns

True if the current computer ip address matches the tested value false otherwise

Condition Name

Expected value type

N/A

Expected result type

Expected syntax

http://docs.citrix.com

p.114

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 speciﬁed 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: ?

http://docs.citrix.com

p.115

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. http://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.

http://docs.citrix.com

p.116

Returns

True if user ISO language name matches the speciﬁed 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 speciﬁed 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.

http://docs.citrix.com

p.117

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 ofﬂine) 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.

http://docs.citrix.com

p.118

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

http://docs.citrix.com

p.119

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

http://docs.citrix.com

p.120

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 ﬁle 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 speciﬁed 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).

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).

http://docs.citrix.com

p.121

Condition Name

Negative condition behavior

Will execute IP Address Match and return the opposite result (true if false, false if true).

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).

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).

http://docs.citrix.com

p.122

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).

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).

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).

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).

http://docs.citrix.com

p.123

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).

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).

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).

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).

http://docs.citrix.com

p.124

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).

http://docs.citrix.com

p.125

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).

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

http://docs.citrix.com

True if dynamic expression result value exists and value matches false otherwise.

p.126

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).

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).

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)

http://docs.citrix.com

p.127

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 ﬁle to test. Example : C:\Test \Test F ile.dll

Expected result type

String. Expected ﬁle version value of the tested ﬁle

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).

http://docs.citrix.com

p.128

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 ﬁle 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 speciﬁed list false otherwise.

http://docs.citrix.com

p.129

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).

Condition Name

F ile/F older exist s

Expected value type

N/A

Expected result type

String.

Expected syntax

Full path of the ﬁle system entry (ﬁle or folder) to test

Returns

True if the speciﬁed ﬁle 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).

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

http://docs.citrix.com

p.130

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 speciﬁed 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).

http://docs.citrix.com

p.131

## Administration Console - Citrix Docs

Workspace Environment Management 4.2 Apr 12, 20 17 Workspace Environment Management Workspace Environment Management uses intelligent resource manage...

#### Recommend Documents

XenApp 6.5 - Citrix Docs
Apr 27, 2016 - You can start with a basic proof of concept deployment for XenApp Connector and then scale it for high av

Jul 25, 2017 - http://www.citrix.com/content/dam/citrix/en_us/documents/products/netscaler-data-sheet.pdf ..... For inst

Configuring a VLAN - Citrix Docs
May 26, 2015 - When you configure the NetScaler, you must not create overlapping IP subnets. Doing so impedes Layer 3 fu

Citrix XenServer Â® 7.0 Administrator's Guide - Citrix Docs
revise the information in this document at any time without notice. This document and the ... Citrix Systems, Inc., the