Product Documentation

Quick start guide

This guide describes how to install and configure Workspace Environment Management (WEM). It provides step-by-step installation and configuration instructions, and suggested best practices.

Overview

WEM uses intelligent resource management and profile management technologies to deliver the best possible performance, desktop logon, and application response times for Citrix Virtual Apps and Desktops deployments. It is a software-only, driver-free solution.

Prerequisites

Before you install WEM in your environment, verify that you meet all system requirements. For more information, see System requirements.

Installation and configuration

Citrix recommends that you install the latest version of WEM. Deploying WEM consists of installing and configuring three core components: Infrastructure services, Administration console, and Agent. The following procedures detail how to install and configure these components:

Note:

  • Do not install any of the components above on a domain controller.
  • Do not install the infrastructure services on the server where the Delivery Controller is installed.

Step 1: Install the infrastructure services

1. Download the latest WEM installer here. Extract the zip file to a convenient folder.

WEM installer folder

2. Run Citrix Workspace Environment Management Infrastructure Services Setup.exe on your infrastructure server.

3. Click Install.

Installing infrastructure services 01

4. Click Next.

Installing infrastructure services 02

5. Select “I accept the terms in the license agreement” and then click Next.

Installing infrastructure services 03

6. Type your user name and organization and then click Next.

Installing infrastructure services 04

7. Select Complete and then click Next.

Note:

To change the installation folder, or to prevent SDK installation, select Custom.

Installing infrastructure services 05

8. On the Ready to Install the Program page, click Install.

Installing infrastructure services 06

9. Click Finish and then go to Step 2.

Note:

By default, the Start the Database Management Utility option is selected, and the utility starts automatically. You can also start the utility from the Start menu at Citrix > Workspace Environment Management > WEM Database Management Utility.

Installing infrastructure services 07

Step 2: Create a WEM database

1. In the database management utility, click Create Database to create a WEM database for your deployment. The database creation wizard appears.

Note:

If you are using Windows authentication for your SQL Server, run the database creation utility under an identity that has system administrator permissions.

Creating a WEM database 01

2. On the Welcome page, click Next.

Creating a WEM database 02

3. On the Database Information page, type the required information and then click Next.

Note:

  • For the server and instance name, type the machine name, fully qualified domain name, or IP address.
  • For the file paths, type the exact paths specified by your database administrator. Make sure that any auto-completed file paths are correct.

Creating a WEM database 03

4. On the Database Server Credentials page, type the required information and then click Next.

Creating a WEM database 04

5. Under VUEM Administrators, click Select.

Creating a WEM database 05

6. In the Select Group window, type a user group with administration permissions to the administration console, click Check Names, and then click OK.

Creating a WEM database 06

7. Under Database Security, select Use Windows authentication for infrastructure service database connection and then click Select.

Note:

  • If you select neither Use Windows authentication for infrastructure service database connection nor Set vuemUser SQL user account password, the SQL user account is used by default.
  • To use your own vuemUser SQL account password (for example, if your SQL policy requires a more complex password), select Set vuemUser SQL user account password.

Creating a WEM database 07

8. In the Select User window, type the name of the infrastructure service account, click Check Names, and then click OK.

Creating a WEM database 08

9. Click Next.

Creating a WEM database 09

10. On the Database Information Summary page, click Create Database.

Creating a WEM database 10

11. Click OK.

Creating a WEM database 11

12. On the Database Information Summary page, click Finish.

Creating a WEM database 12

13. Close the WEM Database Management Utility.

Creating a WEM database 13

14. In the Exit Application Dialog, click Yes.

Note:

If an error occurs during the database creation, check the log file “Citrix WEM Database Management Utility Debug Log.log” in the infrastructure services installation folder for more information.

Creating a WEM database 14

Step 3: Configure infrastructure services

1. Open the WEM Infrastructure Service Configuration Utility from the Start menu.

2. On the Database Settings tab, type the required information.

Configuring infrastructure services 01

3. On the Advanced Settings tab, select Enable Windows account impersonation and then click Browse.

Note:

Depending on the choices you made during WEM database creation in Step 2, select Enable Windows account impersonation or Set vuemUser SQL user account password.

Configuring infrastructure services 02

4. Type a user name, click Check Names, and then click OK.

Configuring infrastructure services 03

5. Type the infrastructure service account password.

Configuring infrastructure services 04

6. Select Enable debug mode.

Configuring infrastructure services 05

7. On the Licensing tab, select Global license server override, type your license information, and then click Save Configuration.

Note:

  • For Citrix License Server name, type the machine name, fully qualified domain name, or IP address of the license server.
  • For Citrix License Server port, the default port is 27000.

Configuring infrastructure services 06

8. Click Yes.

Configuring infrastructure services 07

9. Close the WEM Infrastructure Service Configuration utility.

Step 4: Install the administration console

1. Run Citrix Workspace Environment Management Console Setup.exe.

WEM installer folder

2. On the Welcome page, click Next.

Installing the administration console 01

3. On the License Agreement page, select “I accept the terms in the license agreement” and then click Next.

Installing the administration console 02

4. On the Customer Information page, type the required information and then click Next.

Installing the administration console 03

5. On the Setup Type page, select Complete and then click Next.

Installing the administration console 04

6. On the Ready to Install the Program page, click Install.

Installing the administration console 05

7. Click Finish to exit the wizard.

Installing the administration console 06

Step 5: Configure configuration sets

1. Open the WEM Administration Console from the Start menu and click Connect.

Configuring configuration sets 01

2. In the New Infrastructure Server Connection window, check the information and then click Connect.

Note:

  • For Infrastructure server name, type the machine name, fully qualified domain name, or IP address of the WEM infrastructure server.
  • For Administration port, the default port is 8284.

Configuring configuration sets 02

3. On the Home tab, on the ribbon, click Create to create your configuration set.

Configuring configuration sets 03

4. In the Create Configuration Set window, type a name and description for your configuration set and then click OK.

Configuring configuration sets 04

5. On the ribbon, under Configuration Set, select the newly created configuration set.

Configuring configuration sets 05

6. On the ribbon, under Backup, click Restore. The Restore wizard appears.

Configuring configuration sets 06

7. On the Select what to restore page, select Settings and then click Next.

Configuring configuration sets 07

8. On the Restore settings page, click Next.

Configuring configuration sets 08

9. On the Source page, click Browse.

Configuring configuration sets 09

10. In the Browse For Folder window, browse to the Default Recommended Settings folder (provided with Workspace Environment Management) and then click OK.

Configuring configuration sets 10

11. On the Source page, select System Optimization Settings, Agent Configuration Settings, and System Monitoring Settings, and then click Next.

Configuring configuration sets 11

12. On the Restore settings processing page, under Restore settings, click Restore Settings.

Configuring configuration sets 12

13. Click Yes.

Configuring configuration sets 13

14. Click Finish.

Configuring configuration sets 14

Step 6: Import group policy template

1. Open the Group Policy Management console on the domain controller.

2. In the console, right-click Group Policy Objects and select New.

Importing group policy template 01

3. In the New GPO window, type the required information and then click OK.

Importing group policy template 02

4. In the console, right-click the newly created GPO and select Edit.

Importing group policy template 03

5. Right-click Administrative Templates (Computer Configuration > Policies > Administrative Templates), and select Add/Remove Templates.

Importing group policy template 04

6. In the Add/Remove Templates windows, Click Add.

Importing group policy template 05

7. Browse to the Citrix Workspace Environment Management Agent Host Configuration.adm template in the Agent Group Policies folder (provided with Workspace Environment Management installer), and then click Open.

Importing group policy template 06

8. Click Close.

Importing group policy template 07

9. In the Group Policy Management Editor window, go to Computer Configuration > Policies > Administrative Templates > Classic Administrative Templates (ADM) > Citrix > Workspace Environment Management > Agent Host Configuration and double-click Infrastructure server.

Importing group policy template 08

10. In the Infrastructure server window, select Enabled, and under Options, type the IP address of the computer on which the infrastructure services are installed, and then click Apply and OK.

Importing group policy template 09

11. Go to the agent host, open a command line, and type gpupdate /force.

Importing group policy template 10

Step 7: Install the agent

Important:

Do not install the WEM agent on the infrastructure server.

1. Run Citrix Workspace Environment Management Agent Setup.exe on your machine.

WEM installer folder

2. Click Install.

Installing the agent 01

3. On the Welcome page, click Next.

Installing the agent 02

4. On the License agreement page, select “I accept the terms in the license agreement” and then click Next.

Installing the agent 03

5. On the Customer Information page, type the required information and then click Next.

Installing the agent 04

6. On the Setup Type page, select Complete and then click Next.

Installing the agent 05

7. On the Ready to Install the Program page, click Install.

Installing the agent 06

8. Click Finish to exit the wizard.

Installing the agent 07

Step 8: Add the agent to the configuration set you created

1. From the Start menu, open the WEM Administration Console, click Active Directory Objects, and then click Add.

Adding the agent to the configuration set 01

2. In the Select Users or Groups window, type the name, click Check Names, and then click OK.

Adding the agent to the configuration set 02

3. Click Machines.

Adding the agent to the configuration set 03

4. On the Machines tab, click Add OU or Add Object to add the machines that you want to manage to the configuration set you created.