Product Documentation

Install and configure

Use the following sequence to set up your Workspace Environment Management service deployment. Review the entire process before starting the deployment, so you’ll know what to expect. Links are provided to product documentation and videos.

If you are not familiar with the components and terminology used in a Workspace Environment Management service deployment, see Workspace Environment Management service.

Get started

Get started by signing up for a Citrix account and requesting a Workspace Environment Management service trial.

Set up resource locations and install Cloud Connectors

Resource locations contain infrastructure servers (such as Active Directory and Citrix Cloud Connectors), and the machines that deliver apps or desktops to users.

Before you install the Workspace Environment Management service agent, you must set up resource locations and install at least one Citrix Cloud Connector in each one. For high availibility Citrix recommend two cloud connectors in each resource location.

See Resource locations and Cloud Connector Installation.

Install and configure the Workspace Environment Management agent

Note:

  • To configure the Workspace Environment Management service agent, you need administrative access to your Active Directory.
  • To assign resources published in Citrix StoreFront stores as application shortcuts in Workspace Environment Management service from the administration console, Citrix Receiver for Windows must be installed on the agent host machine. For more information see System requirements.

Step 1: Join agent host machines to AD

Agent host machines must belong to the same Active Directory domain as the configured cloud connectors. Ensure that the agent host machines in each resource location are correctly joined.

Step 2: Download the agent

Download the Workspace Environment Management service agent package (Workspace-Environment-Management-Service-Agent.zip) from the Workspace Environment Management service Downloads tab and save a copy on each agent host.

Step 3: Configure group policies

The Workspace Environment Management Agent Host Configuration.admx administrative template, provided in the agent package, adds the Agent Host Configuration policy. Use the Group Policy Management Editor to configure a GPO with the following settings:

Group Policy management Editor

Infrastructure server. Not required for Workspace Environment Management service. Leave state ‘Not configured’.

Agent service port: Not required for Workspace Environment Management service. Leave state ‘Not configured’.

Cache synchronization port: Not required for Workspace Environment Management service. Leave state ‘Not configured’.

Citrix Cloud Connectors: Configure at least one Citrix Cloud Connector. Agent host machines must be in the same active directory domain as the configured cloud connector machines.

VUEMAppCmd extra sync delay. The default value is 0. The delay interval in milliseconds for the agent application launcher (VUEMAppCmd.exe) to wait before XenApp and XenDesktop published resources are started. This ensures that the necessary agent work has completed first.

Step 4: Deploy the agent

The agent setup program Citrix Workspace Environment Management Service Agent Setup is provided in the agent download. You can run the agent setup program in your user environment, or deploy it to your users. The 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)

After installation, the agent runs as the following service, as account LocalSystem: Norskale Agent Host Service (NT SERVICE\Norskale Agent Host Service). Changing this account is not supported. The agent service requires ‘log on as a local system’ permission.

The setup program executable accepts standard InstallShield deployment switches, and acknowledges the following custom arguments:

  • WaitForNetwork. This argument allows you to configure whether the WaitForNetwork registry key created during installation is active or not. Accepted values are 0 and 1. If not specified, the key will not be created during installation.

  • SyncForegroundPolicy. This argument allows you to configure whether the SyncForegroundPolicy registry key created during installation is active or not. Accepted values are 0 and 1. If not specified, the key will not be created during installation.

  • GpNetworkStartTimeoutPolicyValue. This argument allows you to configure the value of the GpNetworkStartTimeoutPolicyValue 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\Software\Microsoft\Windows NT\CurrentVersion\Winlogon during the installation process, and are there to ensure that the user environment receives the infrastructure server address GPOs before logon. In network environments where the Active Directory or Domain Controller servers are slow to respond, this may lead to additional processing time prior to the login screen being displayed. Microsoft recommend setting the value of the GpNetworkStartTimeoutPolicyValue key to a minimum of 30 in order for it to have an impact.

  • AgentPort: The agent installer runs a script to open firewall ports locally, to make sure the agent network traffic is not blocked. This argument allows you to configure which port is opened. If unspecified, the default port 8286 is used. Accepted values are any valid port.

  • AgentSyncPort: The agent installer runs a script to open firewall ports locally, to make sure the agent network traffic is not blocked. This argument allows you to configure which port is opened. If unspecified, the default port 8285 is used. Accepted values are any valid port.

  • ServicesPipeTimeout. This argument allows you to configure the value of the ServicesPipeTimeout registry key, which is created during installation under HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet. This registry key adds a delay before the service control manager is allowed to report on the state of the Workspace Environment Management agent service, which prevents the agent from failing because the agent service launched before the network was initialized. This argument will accept any value, in milliseconds. If unspecified, a default value of 60000 (60 seconds) is used).

  • CmdLineToolsDebug. If the value of this argument is 1, the setup executable displays all arguments passed to the agent installer in a separate cmd window that will pause the installation until dismissed.

  • ARPSYSTEMCOMPONENT. This argument allows you to designate the agent as a system component, which prevents it from appearing in Add/Remove Programs. Accepted values are 0 or 1.

  • AgentCacheAlternateLocation. This argument allows you to specify the value of the associated registry setting which must be expressed as a valid file path. If configured, the agent local cache file is saved in the designated location, instead of in the agent installation directory.

Run the agent setup process using the following syntax:

"path:\\to\\Citrix Workspace Environment Management Agent Setup.exe" /v"argument=\\"value\\""

For example:

"C:\VUEM 4.04.00.00\Citrix Workspace Environment Management Agent Setup.exe" /v"WaitForNetwork=\"1\" GpNetworkStartTimeoutPolicyValue=\"45\""

Step 5: Build the agent service cache (optional)

By default, the agent service cache is built the first time the agent runs. You can optionally build the agent service cache before the agent is run. This is useful if you want to build an image that includes the Workspace Environment Management Agent Host as pre-installed software.

To build or rebuild the agent Service cache, run the command line executable AgentCacheUtility.exe in the agent installation directory. The executable accepts the following command line arguments:

-help: display a list of allowed arguments

-refreshcache or -r: trigger a cache build or refresh

Step 6: Restart the machine to complete the installation