Workspace Environment Management

Citrix Profile Management Settings

Note:

Some options work only with specific versions of Profile Management. Consult the Profile Management documentation for details.

Workspace Environment Management (WEM) supports all versions of Citrix Profile Management through the current version.

In the console (Configuration Set > Profiles > Profile Management Settings), you can configure all settings for the current version of Citrix Profile Management.

In addition to using WEM to configure Citrix Profile Management features, you can use Active Directory GPOs, Citrix Studio policies, or .ini files on the VDA. We recommend that you use the same method consistently.

Profile Management settings

When enabled, you can configure and apply your settings. Enabling the option creates Profile Management related registries in the user environment.

Basic settings

Get started with Profile Management by applying basic settings. Basic settings include processed groups, excluded groups, user store, and more.

Enable Profile Management. Controls whether the WEM agent processes Profile Management settings. For Profile Management to work, you must enable this option. If disabled, none of the Profile Management settings are processed.

Set processed groups. Lets you specify which groups are processed by Profile Management. Only the specified groups have their Profile Management settings processed. If left empty, all groups are processed.

Set excluded groups. Lets you specify which groups are excluded from Profile Management.

Process logons of local administrators. If enabled, local administrator logons are treated the same as non-administrator logons for Profile Management.

Set path to user store. Lets you specify the path to the user store — the central location for Citrix user profiles. Enter an absolute UNC path or a path relative to the home directory. Example path:

  • \\<IP address or FQDN>\<user store directory>\%USERNAME%.%USERDOMAIN%\!CTX_OSNAME!!CTX_OSBITNESS!

Migrate user store. Lets you specify the path to the folder where the user settings (registry changes and synchronized files) were saved. Enter the user store path that you previously used. Use this option along with the Set path to user store option.

Enable active write back. If enabled, profiles are written back to the user store during the user session, preventing data loss.

  • Enable active write back registry. If enabled, registry entries are written back to the user store during the user session, preventing data loss.

Enable offline profile support. If enabled, profiles are cached locally for use while not connected.

Profile container

Configure profile container settings. Profile containers are VHDX disks stored on the network and attached during logon and detached during logoff.

Enable Profile Container. Lets you add folders you want to include in the profile container. To put an entire user profile in its profile container, add an asterisk (*) instead. If enabled, Profile Management maps the listed folders to the profile disk stored on the network, thus eliminating the need to save a copy of the folders to the local profile. Specify at least one folder to include in the profile container.

  • Enable local caching for profile container. If enabled, each local profile serves as a local cache of its profile container. This option requires you to put an entire user profile in its profile container.

Enable folder exclusions. If enabled, Profile Management excludes the listed folders from the profile container. Specify at least one folder to exclude from the profile container.

Enable file exclusions. If enabled, Profile Management excludes the listed files from the profile container. Specify at least one file to exclude from the profile container.

Enable folder inclusions. If enabled, Profile Management keeps the listed folders in the profile container when their parent folders are excluded. Folders on this list must be subfolders of the excluded folders. This means that you must use this option with the Enable folder exclusions option. Specify at least one folder to include in the profile container.

Enable file inclusions. If enabled, Profile Management keeps the listed files in the profile container when their parent folders are excluded. Files on this list must be contained in the excluded folders. This means that you must use this option with the Enable folder exclusions option. Specify at least one file to include in the profile container.

TIP:

When adding files or folders, you can use wildcards. For more information, see Wildcard support.

When adding profile container content, exclusions, and inclusions, you can add them individually and in bulk. When adding them in bulk, enter paths separated by line breaks. After that, click Run validation to validate items you are about to add. Only valid items can be added. Invalid items are skipped.

Also, you can have a hierarchical view of the profile container content, exclusions, and inclusions. To do that, click View hierarchy.

Profile handling

Specify how Profile Management handles user profiles.

Delete locally cached profiles on logoff. If enabled, locally cached profiles are deleted when the user logs off.

  • Set delay before deleting cached profiles. Lets you specify a delay (in seconds) before cached profiles are deleted on logoff. Supported values: 0–600.

Enable migration of existing profiles. If enabled, existing Windows profiles are migrated to Profile Management on logon. Specify the type of user profiles to migrate if the user store is empty. Types include:

  • Local and roaming
  • Local
  • Roaming

Automatic migration of existing application profiles. If enabled, existing application profiles are migrated automatically. Profile Management performs the migration when a user logs on and when there are no user profiles in the user store.

Enable local profile conflict handling. Configures how WEM handles cases where Profile Management and Windows profiles conflict. Specify what to do if both a local Windows user profile and a Citrix user profile exist in the user store:

  • Use local profile
  • Delete local profile
  • Rename local profile

Enable template profile. Lets you enter a template profile path. If enabled, Profile Management uses the specified template profile. You can configure additional settings as follows:

  • Template profile overrides local profile. If enabled, the template profile overrides local profiles.
  • Template profile overrides roaming profile. If enabled, the template profile overrides roaming profiles.
  • Use template profile as Citrix mandatory profile for all logons. If enabled, the template profile overrides all other profiles.

Advanced settings

Control the advanced configuration of Profile Management.

Set number of retries when accessing locked files. Configures the number of times the WEM agent retries accessing locked files. Supported values: 0–100.

Enable use of application definition files. Lets you enter the path to definition files. If enabled, only the settings included in the definition file are synchronized. Specify a folder where the Citrix virtual apps optimization definition files are located. For more information about creating definition files, see Create a definition file.

Process Internet cookie files on logoff. If enabled, stale cookies are deleted on logoff.

Delete redirected folders. If enabled, deletes local copies of redirected folders.

Disable automatic configuration. If enabled, dynamic configuration is disabled.

Log off user if problems occur. If enabled, users are logged off rather than switched to a temporary profile if a problem occurs.

Enable multi-session write-back for profile containers. If enabled, Profile Management saves changes in multi-session scenarios for both FSLogix Profile Container and Citrix Profile Management profile containers. If the same user launches multiple sessions on different machines, changes made in each session are synchronized and saved to the user’s profile container disk.

Enable asynchronous processing for user Group Policy on logon. If enabled, Profile Management roams with users a registry value that Windows uses to determine the processing mode for the next user logon — synchronous or asynchronous processing mode. If the registry value does not exist, synchronous mode is applied. Enabling the option ensures that the actual processing mode is applied each time users log on. If disabled, asynchronous mode can’t be applied as expected if users:

  • Log on to different machines.
  • Log on to the same machine where the Delete locally cached profiles on logoff option is enabled.

Customize storage path for VHDX files. Lets you specify a separate path to store VHDX files. By default, VHDX files are stored in the user store. Policies that use VHDX files include the following: Profile container, Search index roaming for Outlook, and Accelerate folder mirroring. If enabled, VHDX files of different policies are stored in different folders under the storage path.

Enable search index roaming for Microsoft Outlook users. If enabled, the user-specific Microsoft Outlook offline folder file (*.ost) and Microsoft search database are roamed along with the user profile. This improves the user experience when searching for emails in Microsoft Outlook.

  • Outlook search index database – backup and restore. If enabled, Profile Management automatically saves a backup of the last known good copy of the search index database. When there is a corruption, Profile Management reverts to that copy. As a result, you no longer need to manually reindex the database when the search index database becomes corrupted.

  • Enable concurrent session support. Provides native Outlook search experience in concurrent sessions. If enabled, each concurrent session uses a separate Outlook OST file.

    • Maximum number of VHDX disks for storing Outlook OST files. Lets you specify the maximum number of VHDX disks for storing Outlook OST files. If unspecified, only two VHDX disks can be used to store Outlook OST files (one file per disk). If more sessions start, their Outlook OST files are stored in the local user profile. Supported values: 1–10.

Enable OneDrive container. If enabled, Profile Management roams OneDrive folders with users by storing the folders on a VHDX disk. The disk is attached during logons and detached during logoffs.

Replicate user stores. If enabled, Profile Management replicates a user store to multiple paths on each logon and logoff, in addition to the path that the Set path to user store option specifies. To synchronize to the user stores files and folders modified during a session, enable active write back. Enabling the option can increase system I/O and might prolong logoffs. Currently, this feature does not support full container solutions.

Enable credential-based access to user store. If disabled, Profile Management impersonates the current user to access user stores. Thus, make sure that the current user has permission to directly access the user stores. Disabling this setting prevents all settings you specify in Add credentials from being processed. If enabled, Profile Management uses the specified user store credentials to access the user stores on behalf of the user. Enabling this setting lets you put user stores in storage repositories (for example, Azure Files) that the current user has no permission to access.

IMPORTANT:

Disabling this setting deletes all user store connections that the WEM agent previously established.

  • When adding or editing credentials, complete the following fields:

    • Server share. Enter a UNC path that specifies a server share.
    • User name. Enter the name in the form domain\username.
    • Password. Enter the password to be used to access the server share.
    • Show password. Control whether to show or hide the password.

Join the Citrix Customer Experience Improvement Program. If enabled, Profile Management uses the Customer Experience Improvement Program (CEIP) to help improve the quality and performance of Citrix products by collecting anonymous statistics and usage information. For more information on the CEIP, see About the Citrix Customer Experience Improvement Program (CEIP).

Log settings

Configure Profile Management logging.

Enable logging. Enables or disables logging of Profile Management operations.

Include more information in the logs. Lets you specify more information (or types of events) in the logs, including:

  • Common warnings
  • Common information
  • File system notifications
  • File system actions
  • Registry actions
  • Registry differences on logoff
  • Active Directory actions
  • Policy values on logon and logoff
  • Logon
  • Logoff
  • Personalized user information

Set maximum size of the log file. Lets you specify a maximum allowed size for the Profile Management log file. If the log file grows beyond the maximum size, its backup (.bak) is deleted, the log file is renamed to .bak, and a new log file is created. Supported values: 1–100.

Set path to log file. Lets you specify the location where the log file is created.

Registry

Specify which registry keys are included or excluded from Profile Management processing.

NTUSER.DAT backup. If enabled, Profile Management maintains a last known good backup of the NTUSER.DAT file. If Profile Management detects corruption, it uses the last known good backup copy to recover the profile.

Enable default registry exclusions. Provides a default list of registry keys in the HKCU hive that are not synchronized to the user profile. If enabled, registry settings that are selected in this list are forcibly excluded from Profile Management profiles.

Enable registry exclusions. If enabled, registry settings you add are forcibly excluded from Profile Management profiles.

Enable registry inclusions. If enabled, registry settings you add are forcibly included in Profile Management profiles.

File system

Specify which files and folders in a profile are excluded from synchronization, which ones are synchronized to the user store, and how to synchronize them.

Enable exclusion check on logon. If enabled, configures what Profile Management does when a user logs on when a profile in the user store contains excluded files or folders. (If disabled, the default behavior is Synchronize excluded files or folders). You can select one of the following behaviors in the list:

  • Synchronize excluded files or folders (default). Profile Management synchronizes these excluded files or folders from the user store to local profile when a user logs on.
  • Ignore excluded files or folders. Profile Management ignores the excluded files or folders in the user store when a user logs on.
  • Delete excluded files or folders. Profile Management deletes the excluded files or folders in the user store when a user logs on.

Enable default folder exclusions. Provides a default list of folders during synchronization. If enabled, folders that are selected in this list are excluded from synchronization.

Enable folder exclusions. If enabled, the listed folders are not included in a user’s profile. This setting lets you exclude specific folders containing a large amount of data that users do not need as part of their profile. The list is pre-populated with default Windows 7 exclusions, and can be pre-populated with default Windows XP exclusions instead.

Enable file exclusions. If enabled, the listed files are not included in a user’s profile. This setting lets you exclude specific files containing a large amount of data that users do not need as part of their profile. The list is pre-populated with default Windows 7 exclusions, and can be pre-populated with default Windows XP exclusions instead.

Enable folder inclusions. If enabled, folders you add are forcibly synchronized to the user store.

Enable file inclusions. If enabled, files you add are forcibly synchronized to the user store.

TIP:

When adding files or folders, you can use wildcards. For more information, see Wildcard support.

Enable folder mirroring. If enabled, the folders you add are mirrored to the user store on logoff, ensuring that files and subfolders in mirrored folders stored in the user store are exactly the same as the local versions. See below for more information about how folder mirroring works.

  • Accelerate folder mirroring. If enabled, mirrored folders are stored on a VHDX-based virtual disk. Profile Management attaches the virtual disk during logons and detaches it during logoffs, eliminating the need to copy the folders between the user store and local profiles.

    Files in mirrored folders will always overwrite files stored in the user store on session logoff, irrespective of whether they are modified.

    If extra files or subfolders are present in the user store compared to the local versions in mirrored folders, those extra files and subfolders are deleted from the user store on session logoff.

Enable large file handling. If enabled, large files are redirected to the user store, thus eliminating the need to synchronize those files over the network.

Note:

Some applications do not allow concurrent file access. We recommend that you take application behavior into consideration when you define your large file handling policy.

When adding exclusions, and inclusions, you can add them individually and in bulk. When adding them in bulk, enter paths separated by line breaks. After that, click Run validation to validate items you are about to add. Only valid items can be added. Invalid items are skipped.

Also, you can have a hierarchical view of exclusions and inclusions. To do that, click View hierarchy.

Streamed user profiles

Specify how Profile Management processes streamed user profiles.

Enable profile streaming. If disabled, none of the settings in this section are processed.

  • Enable profile streaming for folders. If enabled, folders are fetched only when they are being accessed, thus eliminating the need to traverse all folders during logon. This saves bandwidth and reduces the time to synchronize files.

Always cache. If enabled, files of the specified size (in MB) or larger are always cached. Supported values: 0–20,000.

Set timeout for files in pending area when user store remains locked. Lets you specify the number of days after which user’s files are written back to the user store from the pending area when the user store remains locked. Supported values: 1–30.

Set streamed user profile groups. Lets you add user groups for which streamed profiles are used.

Set excluded folders. If enabled, Profile Management does not stream folders in this list, and all the folders are fetched immediately from the user store to the local machine when users log on.

Enable profile streaming for pending area. If enabled, files in the pending area are fetched to the local profile only when they are requested. This ensures optimum logon experience in concurrent session scenarios. The pending area is used to ensure profile consistency while profile streaming is enabled. It temporarily stores profile files and folders changed in concurrent sessions. By default, this option is disabled. All files and folders in the pending area are fetched to the local profile during logon.

Wildcard support

When adding files or folders, you can use wildcards. Wildcards in file names are applied recursively while wildcards in folder names are not. You can use the vertical bar (|) to restrict the policy only to the current folder so that the policy does not apply to its subfolders.

Examples:

  • AppData\*.tmp excludes all files with the extension .tmp in the folder AppData and its subfolders.
  • AppData\*.tmp| excludes all files with the extension .tmp in the folder AppData.
  • Downloads\*\a.txt excludes a.txt in any immediate subfolder of the Downloads folder. Remember: wildcards in folder names are not applied recursively.
  • Downloads\* excludes all immediate subfolders of the Downloads folder.
Citrix Profile Management Settings