These settings modify how and when the agent processes actions.
These options control basic agent behavior.
Agent Actions. These settings determine whether or not the agent processes actions configured in the Actions tab. These settings apply at login, automatic refresh, or manual (user or administrator triggered) refresh.
Process Applications. When selected, the agent processes application actions.
Process Printers. When selected, the agent processes printer actions.
Process Network Drives. When selected, the agent processes network drives actions.
Process Virtual Drives. When selected, the agent processes virtual drive actions. (Virtual drives are Windows virtual drives or MS-DOS device names which map a local file path to a drive letter.)
Process Registry Values. When selected, the agent processes registry entry actions.
Process Environment Variables. When selected, the agent processes environment variable actions.
Process Ports. When selected, the agent processes port actions.
Process Ini Files Operations. When selected, the agent processes .ini file actions.
Process External Tasks. When selected, the agent processes external task actions.
Process File System Operations. When selected, the agent processes file system operation actions.
Process File Associations. When selected, the agent processes file association actions.
Process User DSNs. When selected, the agent processes user DSN actions.
Agent Service Actions. These settings determine when the agent service processes its instructions.
Launch Agent at Logon. Determines whether or not the agent runs at logon.
Launch Agent at Reconnect. Determines whether or not the agent runs when reconnecting to a published desktop.
Launch Agent for Admins. Determines whether agent runs when a user is an administrator.
Agent Type. Determines whether the user is presented with a user interface (UI) or not (CMD) when interacting with the Agent.
Enable (Virtual) Desktop Compatibility. This setting is necessary for the agent to be launched when the user is logged in to session 1. If you have any users on physical desktops or VDI, select this option.
Execute only CMD Agent in Published Applications. If enabled, the agent will launch in command line mode (CMD) when launching a published application, rather than in UI mode. CMD mode displays a command prompt instead of an agent splash screen.
Options present on this tab control whether the agent deletes the shortcuts or other items (network drives and printers) when the agent refreshes. If you assign actions to a user or user group, you might find that you can also control the creation of the shortcuts or items. You can do so by configuring the options for the actions in the Assigned pane of the Assignments > Action Assignment > Action Assignment tab. Workspace Environment Management processes these options according to a specific priority:
- The options present on the Cleanup Actions tab
- The options configured for the assigned actions in the Assigned pane
For example, suppose you have enabled the Create Desktop option for the assigned application in the Assigned pane, and the application shortcut is already created on the desktop. The shortcut is still on the desktop when the agent refreshes, even though you enabled the Delete Desktop Shortcuts option on the Cleanup Actions tab.
Shortcut Deletion at Startup. The agent deletes all shortcuts of the selected types when it refreshes.
Delete Network Drives at Startup. If enabled, the agent deletes all network drives whenever it refreshes.
Delete Network Printers at Startup. If enabled, the agent deletes all network printers whenever it refreshes.
Preserve Auto-created Printers. If enabled, the agent does not delete auto-created printers.
Preserve Specific Printers. If enabled, the agent does not delete any of the printers in this list.
These options control the agent settings.
Enable Agent Logging. Enables the agent log file.
Log File. The log file location. By default, this is the profile root of the logged-in user.
Debug Mode. This enables verbose logging for the agent.
Enable Offline Mode. If this is disabled, the agent does not fall back on its cache if it cannot connect to the infrastructure service. Note In order for Offline Mode to work, SQL Server Compact Edition 3.5 SP2 must be installed in the user environment and on the Workspace Environment Management infrastructure server.
Use Cache Even if Online. If enabled, the agent always reads its settings and actions from its cache (which is built whenever the agent service cycles).
Refresh Settings. If enabled, the agent triggers a Windows refresh when an agent refresh occurs.
Refresh on Environmental Setting Change. If enabled, the agent triggers a Windows refresh when an environmental setting is modified.
Asynchronous Printer Processing. If enabled, the agent processes printers asynchronously from other actions.
Asynchronous Network Drive Processing. If enabled, the agent processes network drives asynchronously from other actions.
Initial Environment/Desktop Cleanup. If enabled, the agent cleans up the environment/desktop at first login only.
Check Application Existence. If enabled, the agent checks that an application is available to the user/group before creating a shortcut to that application.
Expand App Variables. If enabled, variables are expanded by default (see Environment variables for normal behavior when the agent encounters a variable).
Enable Cross-Domain User Group Search. If enabled, the agent queries user groups in all Active Directory domains. Note: This is an extremely time-intensive process which should only be selected if necessary.
Broker Service Timeout. The timeout value after which the agent switches to its own cache, when it fails to connect to the infrastructure service. The default value is 2000 milliseconds.
Directory Services Timeout. The timeout value for directory services on the Agent Host machine, after which the agent uses its own internal cache of user group associations. The default value is 2000 milliseconds.
Network Resources Timeout. The timeout value for resolving network resources (network drives or file/folder resources located on the network), after which the agent considers the action has failed. The default value is 500 milliseconds.
Agent Max Degree of Parallelism. The maximum number of threads the agent can use. Default value is 0 (as many threads as physically allowed by the processor), 1 is single-threaded, 2 is dual-threaded, etc. In most cases this value does not need changing.
Enable Notifications. If enabled, the agent displays notification messages on the agent host when the connection to the infrastructure service is lost or restored. Citrix recommends that you do not enable this option on poor-quality network connections. Otherwise, connection state change notifications might appear frequently on the endpoint (agent host).
Enforce Execution of Agent Actions. If these settings are enabled, the Agent Host will always refresh those actions, even if no changes have been made.
Revert Unassigned Actions. If these settings are enabled, the Agent Host will delete any unassigned actions when it next refreshes.
Automatic Refresh. If enabled, the Agent Host will refresh automatically. By default, the refresh delay is 30 minutes.
Action Processing on Reconnection. These settings control what actions the Agent Host processes upon reconnection to the user environment.
Filter Processing Enforcement. If enabled, these options will force the Agent Host to re-process filters at every refresh.
These settings configure the Agent Host service.
Agent Cache Refresh Delay. This setting controls how long the Agent Host service will wait to refresh its cache.
SQL Settings Refresh Delay. This setting controls how long the Agent Host service will wait to refresh its SQL connection settings.
Agent Extra Launch Delay. This setting controls how long the Agent Host service will wait to launch the Agent Host executable.
Enable Debug Mode. This enables verbose logging for all Agent Hosts connecting to this site.
Bypass ie4uinit Check. By default, the Agent Host service will wait for ie4uinit to run before launching the Agent Host executable. This setting forces the Agent Host service to not wait for ie4uinit.
Agent Launch Exclusions. If enabled, the Citrix Workspace Environment Management Agent Host will not be launched for any user belonging to the specified user groups.
Forbidden Drives. Any drive letter added to this list is excluded from the drive letter selection when assigning a drive resource.
Use this tab to add StoreFront stores to the Workspace Environment Management configuration. You can then assign an Applications Action tab to define shortcuts to applications from in that those stores. For Transformer kiosk-enabled machines, assigned StoreFront Applications Actions appear in the Applications tab in the Transformer kiosk. For more information on StoreFront stores, see StoreFront documentation.
To add a store
- Click Add.
- Enter details in the Add Store dialog, then click OK. The store is saved in your configuration set.
Store URL. The URL of the store on which you want to access resources using Workspace Environment Management. The URL must be specified in the form http[s]://hostname[:port], where hostname is the fully qualified domain name of the store and port is the port used for communication with the store if the default port for the protocol is not available.
Description. Optional text describing the store.
To edit a store
Select a store in the list and click Edit to change the store URL or description.
To remove a store
Select a store in the list and click Remove to remove a store from your configuration set.
To apply changes
Click Apply to apply store settings immediately to your agents.
Options present on this tab let you switch from the on-premises agent to the service agent.
Agent switch works at a configuration set level. The switch operation you perform affects only the agents in the configuration set.
Switch to Service Agent. If enabled, the agent switches from the on-premises agent to the service agent. You can then specify Citrix Cloud Connectors to which the agent connects. This is useful when you want to migrate your existing on-premises deployment to the WEM service.
Enable this option only if you want to move your on-premises deployment to the WEM service. This move cannot be reversed through the WEM administration console.
Configure Citrix Cloud Connectors. Lets you configure the Citrix Cloud Connectors by typing the FQDN or IP address of the Cloud Connector. Click Add to add one Cloud Connector at a time. To ensure high service availability, Citrix recommends that you install at least two Cloud Connectors in each resource location. Therefore, you need to configure at least two Citrix Cloud Connectors.
Skip Citrix Cloud Connector Configuration. Select this option if you want to configure Citrix Cloud Connectors using Group Policy.
It might take some time for the agent switch settings to take effect, depending on the SQL Settings Refresh Delay setting you configured on the Advanced Settings > Configuration > Service Options tab.
The agent might fail to connect to the WEM service after you switch from the on-premises agent to the service agent, and you might want to roll back. To do so, use the AgentConfigurationUtility.exe command line; for example:
<WEM agent installation folder path>AgentConfigurationUtility.exe switch -o --server <server name> --agentport <port number> --syncport <port number>
<WEM agent installation folder path>AgentConfigurationUtility.exe switch -o --server <server name>
<WEM agent installation folder path>AgentConfigurationUtility.exe switch --usegpo -o
UI Agent Personalization
These options allow you to personalize the look and feel of the Citrix Workspace Environment Management session agent in UI mode, as well as help desk and self-service facilities.
These options apply to the session agent in UI mode only. They do not apply to the session agent in CMD mode.
UI Agent Options
These settings let you customize the appearance of the session agent (in UI mode only) in the user’s environment.
Custom Background Image Path. If entered, will display a custom image when the session agent launches/refreshes, rather than the Citrix Workspace Environment Management logo. The image used must be accessible from the user environment. It is recommended you use a 400*200px .bmp file.
Loading Circle Color. Allows you to modify the color of the loading circle to fit your custom background.
Text Label Color. Allows you to modify the color of the loading text to fit your custom background.
UI Agent Skin. Allows you to select a preconfigured skin to use for dialogs and self service forms (printers/applications). Note: This does not change the splash screen.
Hide Agent Splashscreen. If enabled, hides the splash screen when the session agent is loading/refreshing. This takes effect after the session agent has refreshed while the setting is enabled.
Hide Agent Icon in Published Applications. If enabled, published applications do not show the Citrix Workspace Environment Management session agent.
Hide Agent Splashscreen in Published Applications. If enabled, hides the session agent splash screen for published apps running through it.
Only Admins Can Close Agent. If enabled, only administrators can shut down the Citrix Workspace Environment Management session agent.
Allow Users to Manage Printers. If enabled, users can access the Citrix Workspace Environment Management session agent Manage Printers menu to assign a default printer and modify print preferences.
Allow Users to Manage Applications. If enabled, users can access the Citrix Workspace Environment Management session agent Manage Applications menu to manage where their application shortcuts are created. Shortcuts created in self-healing mode cannot be deleted using this menu.
Prevent Admins to Close Agent. If enabled, administrators cannot shut down the Citrix Workspace Environment Management session agent.
Enable Applications Shortcuts. If enabled, users can run applications from the Manage Applications menu.
Disable Administrative Refresh Feedback. When Administrators force a session agent to refresh from the Administration Console, this options prevents a notification tooltip appearing in the user environment.
These options control the Agent Host’s help desk functionalities.
Help Link Action. This field controls what happens when the user clicks on the Help command in the Citrix Workspace Environment Management Agent Host.
Custom Link Action. This field controls what happens when the user clicks on the Support command in the Citrix Workspace Environment Management Agent Host.
Enable Screen Capture. If enabled, users are given the option to open a screen capture utility. This allows the user to screenshot any errors in their environment, which they can then send to your support staff.
Enable Send to Support Option. If enabled, the user is able to send screenshots and log files directly to the nominated support email address, with the specified template. This requires a working, configured email client.
Custom Subject. If enabled, the support email generated by the Citrix Workspace Environment Management Agent Host screen capture utility is sent with the specified subject.
Email Template. This field allows you to specify a template for the support email generated by the Citrix Workspace Environment Management Agent Host screen capture utility. Note you must configure the email template to include useful information.
See Dynamic tokens for a list of hash-tags which can be used in the email template. Note Users are only presented with the option to enter a comment if the ##UserScreenCaptureComment## hash-tag is included in the email template.
Use SMTP to Send Email. If enabled, this will send the support email using SMTP instead of MAPI.
Test SMTP. Tests your SMTP settings as entered above to verify that they are correct.
Shut Down At Specified Time. If enabled, the Agent Host will automatically shut off the environment it is running in at the specified local time.
Shut Down When Idle. If enabled, the Agent Host will automatically shut off the environment it is running in after running idle (no user input) for the specified length of time.