Element |
+Data Type |
+Mandatory |
+
Filename |
+FilenameString |
+True |
+
Architecture |
+Architecture |
+False |
+
ProductName |
+String |
+False |
+
FileDescription |
+String |
+False |
+
ProductVersion |
+ProcessVersion |
+False |
+
FileVersion |
+ProcessVersion |
+False |
+
Element |
+Description |
+
Asynchronous |
+Asynchronous settings packages are applied without blocking the application startup so that the application start proceeds while the settings are still being applied. This is useful for settings that can be applied asynchronously, such as those |
+
PreventOverlappingSynchronization |
+By default, UE-V only saves settings for an application when the last instance of an application using the template is closed. When this element is set to ‘false’, UE-V exports the settings even if other instances of an application are running. Suited templates – those that include a Common element section– that are shipped with UE-V use this flag to enable shared settings to always export on application close, while preventing application-specific settings from exporting until the last instance is closed. |
+
AlwaysApplySettings |
+(introduced in 2.1) +This parameter forces an imported settings package to be applied even if there are no differences between the package and the current state of the application. This parameter should be used only in special cases since it can slow down settings import. |
+
Field/Type |
+Description |
+
Name |
+Specifies a unique name for the settings location template. This is used for display purposes when referencing the template in WMI, PowerShell, Event Viewer and debug logs. For more information, see [Name](#name21). |
+
ID |
+Populates a unique identifier for a particular template. This tag becomes the primary identifier that the UE-V Agent uses to reference the template at runtime. For more information, see [ID](#id21). |
+
Description |
+An optional description of the template. |
+
LocalizedNames |
+An optional name displayed in the UI, localized by a language locale. |
+
LocalizedDescriptions |
+An optional template description localized by a language locale. |
+
Version |
+Identifies the version of the settings location template for administrative tracking of changes. For more information, see [Version](#version21). |
+
DeferToMSAccount |
+Controls whether this template is enabled in conjunction with a Microsoft account or not. If MSA syncing is enabled for a user on a machine, then this template will automatically be disabled. |
+
DeferToOffice365 |
+Similar to MSA, this controls whether this template is enabled in conjunction with Office365. If Office 365 is being used to sync settings, this template will automatically be disabled. |
+
FixedProfile (Introduced in 2.1) |
+Specifies that this template can only be associated with the profile specified within this element, and cannot be changed via WMI or PowerShell. |
+
Processes |
+A container for a collection of one or more Process elements. For more information, see [Processes](#processes21). |
+
Settings |
+A container for all the settings that apply to a particular template. It contains instances of the Registry, File, SystemParameter, and CustomAction settings. For more information, see Settings in [Data types](#data21). |
+
Field/Type |
+Description |
+
Name |
+Specifies a unique name for the settings location template. This is used for display purposes when referencing the template in WMI, PowerShell, Event Viewer and debug logs. For more information, see [Name](#name21). |
+
ID |
+Populates a unique identifier for a particular template. This tag becomes the primary identifier that the UE-V Agent uses to reference the template at runtime. For more information, see [ID](#id21). |
+
Description |
+An optional description of the template. |
+
LocalizedNames |
+An optional name displayed in the UI, localized by a language locale. |
+
LocalizedDescriptions |
+An optional template description localized by a language locale. |
+
Version |
+Identifies the version of the settings location template for administrative tracking of changes. For more information, see [Version](#version21). |
+
DeferToMSAccount |
+Controls whether this template is enabled in conjunction with a Microsoft account or not. If MSA syncing is enabled for a user on a machine, then this template will automatically be disabled. |
+
DeferToOffice365 |
+Similar to MSA, this controls whether this template is enabled in conjunction with Office365. If Office 365 is being used to sync settings, this template will automatically be disabled. |
+
FixedProfile (Introduced in 2.1) |
+Specifies that this template can only be associated with the profile specified within this element, and cannot be changed via WMI or PowerShell. |
+
Settings |
+A container for all the settings that apply to a particular template. It contains instances of the Registry, File, SystemParameter, and CustomAction settings. For more information, see Settings in [Data types](#data21). |
+
Field/Type |
+Description |
+
Name |
+Specifies a unique name for the settings location template. This is used for display purposes when referencing the template in WMI, PowerShell, Event Viewer and debug logs. For more information, see [Name](#name21). |
+
ID |
+Populates a unique identifier for a particular template. This tag becomes the primary identifier that the UE-V Agent uses to reference the template at runtime. For more information, see [ID](#id21). |
+
Description |
+An optional description of the template. |
+
LocalizedNames |
+An optional name displayed in the UI, localized by a language locale. |
+
LocalizedDescriptions |
+An optional template description localized by a language locale. |
+
| Element | +Data Type | +Mandatory | +
|---|---|---|
Filename |
+FilenameString |
+True |
+
Architecture |
+Architecture |
+False |
+
ProductName |
+String |
+False |
+
FileDescription |
+String |
+False |
+
ProductVersion |
+ProcessVersion |
+False |
+
FileVersion |
+ProcessVersion |
+False |
+
| Element | +Description | +
|---|---|
Asynchronous |
+Asynchronous settings packages are applied without blocking the application startup so that the application start proceeds while the settings are still being applied. This is useful for settings that can be applied asynchronously, such as those |
+
PreventOverlappingSynchronization |
+By default, UE-V only saves settings for an application when the last instance of an application using the template is closed. When this element is set to ‘false’, UE-V exports the settings even if other instances of an application are running. Suited templates – those that include a Common element section– that are shipped with UE-V use this flag to enable shared settings to always export on application close, while preventing application-specific settings from exporting until the last instance is closed. |
+
| Field/Type | +Description | +
|---|---|
Name |
+Specifies a unique name for the settings location template. This is used for display purposes when referencing the template in WMI, PowerShell, Event Viewer and debug logs. For more information, see [Name](#name). |
+
ID |
+Populates a unique identifier for a particular template. This tag becomes the primary identifier that the UE-V Agent uses to reference the template at runtime. For more information, see [ID](#id). |
+
Description |
+An optional description of the template. |
+
LocalizedNames |
+An optional name displayed in the UI, localized by a language locale. |
+
LocalizedDescriptions |
+An optional template description localized by a language locale. |
+
Version |
+Identifies the version of the settings location template for administrative tracking of changes. For more information, see [Version](#version). |
+
DeferToMSAccount |
+Controls whether this template is enabled in conjunction with a Microsoft account or not. If MSA syncing is enabled for a user on a machine, then this template will automatically be disabled. |
+
DeferToOffice365 |
+Similar to MSA, this controls whether this template is enabled in conjunction with Office365. If Office 365 is being used to sync settings, this template will automatically be disabled. |
+
Processes |
+A container for a collection of one or more Process elements. For more information, see [Processes](#processes). |
+
Settings |
+A container for all the settings that apply to a particular template. It contains instances of the Registry, File, SystemParameter, and CustomAction settings. For more information, see Settings in [Data types](#data). |
+
| Field/Type | +Description | +
|---|---|
Name |
+Specifies a unique name for the settings location template. This is used for display purposes when referencing the template in WMI, PowerShell, Event Viewer and debug logs. For more information, see [Name](#name). |
+
ID |
+Populates a unique identifier for a particular template. This tag becomes the primary identifier that the UE-V Agent uses to reference the template at runtime. For more information, see [ID](#id). |
+
Description |
+An optional description of the template. |
+
LocalizedNames |
+An optional name displayed in the UI, localized by a language locale. |
+
LocalizedDescriptions |
+An optional template description localized by a language locale. |
+
Version |
+Identifies the version of the settings location template for administrative tracking of changes. For more information, see [Version](#version). |
+
DeferToMSAccount |
+Controls whether this template is enabled in conjunction with a Microsoft account or not. If MSA syncing is enabled for a user on a machine, then this template will automatically be disabled. |
+
DeferToOffice365 |
+Similar to MSA, this controls whether this template is enabled in conjunction with Office365. If Office 365 is being used to sync settings, this template will automatically be disabled. |
+
Settings |
+A container for all the settings that apply to a particular template. It contains instances of the Registry, File, SystemParameter, and CustomAction settings. For more information, see Settings in [Data types](#data). |
+
| Field/Type | +Description | +
|---|---|
Name |
+Specifies a unique name for the settings location template. This is used for display purposes when referencing the template in WMI, PowerShell, Event Viewer and debug logs. For more information, see [Name](#name). |
+
ID |
+Populates a unique identifier for a particular template. This tag becomes the primary identifier that the UE-V Agent uses to reference the template at runtime. For more information, see [ID](#id). |
+
Description |
+An optional description of the template. |
+
LocalizedNames |
+An optional name displayed in the UI, localized by a language locale. |
+
LocalizedDescriptions |
+An optional template description localized by a language locale. |
+
| Task name | +Default event | +
|---|---|
\Microsoft\UE-V\Collect CEIP data |
+Logon |
+
| Task name | +Default event | +
|---|---|
\Microsoft\UE-V\Monitor Application Status |
+Logon |
+
| Task name | +Default event | +
|---|---|
\Microsoft\UE-V\Sync Controller Application |
+Logon, and every 30 minutes thereafter |
+
| Task name | +Default event | +
|---|---|
\Microsoft\UE-V\Synchronize Settings at Logoff |
+Logon |
+
| Task name | +Default event | +
|---|---|
\Microsoft\UE-V\Template Auto Update |
+System startup and at 3:30 AM every day, at a random time within a 1-hour window |
+
| Task name | +Default event | +
|---|---|
\Microsoft\UE-V\Upload CEIP data |
+At logon and every 4 hours |
+
Task Name (file name) |
+Default Frequency |
+Power Toggle |
+Idle Only |
+Network Connection |
+Description |
+
Monitor Application Settings (UevAppMonitor.exe) |
+Starts 30 seconds after logon and continues until logoff. |
+No |
+Yes |
+N/A |
+Synchronizes settings for Windows (AppX) apps. |
+
Sync Controller Application (Microsoft.Uev.SyncController.exe) |
+At logon and every 30 min thereafter. |
+Yes |
+Yes |
+Only if Network is connected |
+Starts the Sync Controller which synchronizes local settings with the settings storage location. |
+
Synchronize Settings at Logoff (Microsoft.Uev.SyncController.exe) |
+Runs at logon and then waits for Logoff to Synchronize settings. |
+No |
+Yes |
+N/A |
+Start an application at logon that controls the synchronization of applications at logoff. |
+
Template Auto Update (ApplySettingsCatalog.exe) |
+Runs at initial logon and at 3:30 AM every day thereafter. |
+Yes |
+No |
+N/A |
+Checks the settings template catalog for new, updated, or removed templates. This task only runs if SettingsTemplateCatalog is configured. |
+
Collect CEIP data (UevSqmSession.exe) |
+At logon launches service |
+No |
+Yes |
+N/A |
+If the user or administrator opts in to the Customer Experience Improvement Program (CEIP), this task collects data that helps improve UE-V future releases. |
+
Upload CEIP Data (UevSqmUploader.exe) |
+Runs at logon and at 4:00 AM every day thereafter. |
+No |
+Yes |
+Only if Network is connected |
+If the user or administrator opts in to the Customer Experience Improvement Program (CEIP), this task uploads the data to the CEIP servers. |
+
| Group Policy setting name | +Target | +Group Policy setting description | +Configuration options | +
|---|---|---|---|
Contact IT Link Text |
+Computers Only |
+This Group Policy setting specifies the text of the Contact IT URL hyperlink in the Company Settings Center. |
+If you enable this Group Policy setting, the Company Settings Center displays the specified text in the link to the Contact IT URL. |
+
Contact IT URL |
+Computers Only |
+This Group Policy setting specifies the URL for the Contact IT link in the Company Settings Center. |
+If you enable this setting, the Company Settings Center Contact IT text links to the specified URL. The link can be of any standard protocol, such as HTTP or mailto. |
+
Do not use the sync provider |
+Computers and Users |
+By using this Group Policy setting, you can configure whether UE-V uses the sync provider feature. This policy setting also lets you enable notification to appear when the import of user settings is delayed. |
+Enable this setting to configure the UE-V Agent not to use the sync provider. |
+
First Use Notification |
+Computers Only |
+This Group Policy setting enables a notification in the notification area that appears when the UE-V +agent runs for the first time. |
+The default is enabled. |
+
Roam Windows settings |
+Computers and Users |
+This Group Policy setting configures the synchronization of Windows settings. |
+Select which Windows settings synchronize between computers. +By default, Windows themes, desktop settings, and Ease of Access settings synchronize settings between computers of the same operating system version. |
+
Settings package size warning threshold |
+Computers and Users |
+This Group Policy setting lets you configure the UE-V Agent to report when a settings package file size reaches a defined threshold. |
+Specify the preferred threshold for settings package sizes in kilobytes (KB). +By default, the UE-V Agent does not have a package file size threshold. |
+
Settings storage path |
+Computers and Users |
+This Group Policy setting configures where the user settings are to be stored. |
+Enter a Universal Naming Convention (UNC) path and variables such as \\Server\SettingsShare\%username%. |
+
Settings template catalog path |
+Computers Only |
+This Group Policy setting configures where custom settings location templates are stored. This policy setting also configures whether the catalog is to be used to replace the default Microsoft templates that are installed with the UE-V Agent. |
+Enter a Universal Naming Convention (UNC) path such as \\Server\TemplateShare or a folder location on the computer. +Select the check box to replace the default Microsoft templates. |
+
Sync settings over metered connections |
+Computers and Users |
+This Group Policy setting defines whether UE-V synchronizes settings over metered connections. |
+By default, the UE-V Agent does not synchronize settings over a metered connection. |
+
Sync settings over metered connections even when roaming |
+Computers and Users |
+This Group Policy setting defines whether UE-V synchronizes settings over metered connections outside of the home provider network, for example, when the data connection is in roaming mode. |
+By default, UE-V does not synchronize settings over a metered connection when it is in roaming mode. |
+
Synchronization timeout |
+Computers and Users |
+This Group Policy setting configures the number of milliseconds that the computer waits before a time-out when it retrieves user settings from the remote settings location. If the remote storage location is unavailable, and the user does not use the sync provider, the application start is delayed by this many milliseconds. |
+Specify the preferred synchronization time-out in milliseconds. The default value is 2000 milliseconds. |
+
Tray Icon |
+Computers Only |
+This Group Policy setting enables the User Experience Virtualization (UE-V) tray icon. |
+The default is enabled. |
+
Use User Experience Virtualization (UE-V) |
+Computers and Users |
+This Group Policy setting lets you enable or disable User Experience Virtualization (UE-V). |
+Enable or disable this Group Policy setting. |
+
| Group Policy setting name | +Target | +Group Policy setting description | +Configuration options | +
|---|---|---|---|
Do not synchronize Windows Apps |
+Computers and Users |
+This Group Policy setting defines whether the UE-V Agent synchronizes settings for Windows apps. |
+The default is to synchronize Windows apps. |
+
Windows App List |
+Computer and User |
+This setting lists the family package names of the Windows apps and states expressly whether UE-V synchronizes that app’s settings. |
+You can use this setting to specify that settings of an app are never synchronized by UE-V, even if the settings of all other Windows apps are synchronized. |
+
Sync Unlisted Windows Apps |
+Computer and User |
+This Group Policy setting defines the default settings sync behavior of the UE-V Agent for Windows apps that are not explicitly listed in the Windows app list. |
+By default, the UE-V Agent only synchronizes settings of those Windows apps that are included in the Windows app list. |
+
Max package size |
+ Enable/disable Windows app sync |
+ Wait for sync on application start |
+
Setting import delay |
+ Sync unlisted Windows apps |
+ Wait for sync on logon |
+
Settings import notification |
+ IT contact URL |
+ Wait for sync timeout |
+
Settings storage path |
+ IT contact descriptive text |
+ Settings template catalog path |
+
Sync enablement |
+ Tray icon enabled |
+ Start/Stop UE-V agent service |
+
Sync method |
+ First use notification |
+ Define which Windows apps will roam settings |
+
Sync timeout |
+ + | + |
| User account | +Recommended permissions | +
|---|---|
Everyone |
+ No permissions |
+
Security group of UE-V users |
+ Full control |
+
| User account | +Recommended permissions | +Folder | +
|---|---|---|
Creator/owner |
+ Full control |
+ Subfolders and files only |
+
Security group of UE-V users |
+ List folder/read data, create folders/append data |
+ This folder only |
+
| Deployment type | +Deployment description | +Example | +
|---|---|---|
Command prompt |
+When you install the UE-V Agent at a command prompt, use the %^username% variable format. If quotation marks are required because of spaces in the settings storage path, use a batch script file for deployment. + |
+
|
+
Batch script |
+When you install the UE-V Agent from a batch script file, use the %%username%% variable format. If you use this installation method, you must escape the variable with the %% characters. Without this character, the script expands the username variable at installation time, rather than at run time, which causes UE-V to use a single settings storage location for all users. |
+
|
+
Windows PowerShell |
+When you install the UE-V Agent from a Windows PowerShell prompt or a Windows PowerShell script, use the %username% variable format. |
+
|
+
Electronic software distribution, such as deployment of Configuration Manager Software Deployment |
+When you install the UE-V Agent by using Configuration Manager, use the ^%username^% variable format. |
+
|
+
| Command-line parameter | +Definition | +Notes | +
|---|---|---|
/help or /h or /? |
+Displays the AgentSetup.exe usage dialog box. |
++ |
SettingsStoragePath |
+Indicates the Universal Naming Convention (UNC) path that defines where settings are stored. |
+
+Important
+
+You must specify a SettingsStoragePath in UE-V 2.1 and UE-V 2.1 SP1. You can set the AdHomePath string to specify that the user's Active Directory home path is used. For example, In UE-V 2.0, you can leave SettingsStoragePath blank to use the Active Directory home path instead. +
+
+
+%username% or %computername% environment variables are accepted. Scripting can require escaped variables. +Default: <none> |
+
SettingsStoragePathReg |
+Gets the SettingsStoragePath value from the registry during installation. |
+At the command prompt, type the following example to force UE-V to use the Active Directory home path instead of a specific UNC. +
|
+
SettingsTemplateCatalogPath |
+Indicates the Universal Naming Convention (UNC) path that defines the location that was checked for new settings location templates. |
+Only required for custom settings location templates |
+
RegisterMSTemplates |
+Specifies whether the default Microsoft templates should be registered during installation. |
+True | False +Default: True |
+
SyncMethod |
+Specifies which synchronization method should be used. |
+SyncProvider | None +Default: SyncProvider |
+
SyncTimeoutInMilliseconds |
+Specifies the number of milliseconds that the computer waits before time-out when it retrieves user settings from the settings storage location. |
+Default: 2000 milliseconds +(wait up to 2 seconds) |
+
SyncEnabled |
+Specifies whether UE-V synchronization is enabled or disabled. |
+True | False +Default: True |
+
MaxPackageSizeInBytes |
+Specifies a settings package file size in bytes when the UE-V Agent reports that files exceed the threshold. |
+<size> +Default: none (no warning threshold) |
+
CEIPEnabled |
+Specifies the setting for participation in the Customer Experience Improvement program. If set to True, installer information is uploaded to the Microsoft Customer Experience Improvement Program site. If set to False, no information is uploaded. |
+True | False +Default: False |
+
NoRestart |
+Supports deferral of the restart of the computer after the UE-V Agent is installed. |
++ |
INSTALLFOLDER |
+Enables a different installation folder to be set for the UE-V Agent or UE-V Generator. |
++ |
MUENABLED |
+Enables Setup to accept the option to be included in the Microsoft Update program. |
++ |
ACCEPTLICENSETERMS |
+Lets UE-V be installed silently. This must be set to True to install UE-V silently and bypass the requirement that the user accepts the UE-V license terms. If set to False or left empty, the user receives an error message and UE-V is not installed. |
+
+Important
+
+This parameter is required to install UE-V silently. +
+
+ |
+
NORESTART |
+Prevents a mandatory restart after the UE-V Agent is installed. |
++ |
| User account | +Recommended permissions | +
|---|---|
Everyone |
+ No Permissions |
+
Domain Computers |
+ Read Permission Levels |
+
Administrators |
+ Read/Write Permission Levels |
+
| User account | +Recommended permissions | +Apply to | +
|---|---|---|
Creator/Owner |
+ Full Control |
+ This Folder, Subfolders and Files |
+
Domain Computers |
+ List Folder Contents and Read |
+ This Folder, Subfolders and Files |
+
Everyone |
+ No Permissions |
+ No Permissions |
+
Administrators |
+ Full Control |
+ This Folder, Subfolders and Files |
+
| Component | +Function | +
|---|---|
UE-V Agent |
+Installed on every computer that needs to synchronize settings, the UE-V Agent monitors registered applications and the operating system for any settings changes, then synchronizes those settings between computers. |
+
Settings packages |
+Application settings and Windows settings are stored in settings packages created by the UE-V Agent. Settings packages are built, locally stored, and copied to the settings storage location. +
The sync provider determines when the application or operating system settings are read from the Settings Packages and synchronized. |
+
Settings storage location |
+This is a standard network share that your users can access. The UE-V Agent verifies the location and creates a hidden system folder in which to store and retrieve user settings. |
+
Settings location templates |
+UE-V uses XML files as settings location templates to monitor and synchronize desktop application settings and Windows desktop settings between user computers. By default, some settings location templates are included in UE-V . You can also create, edit, or validate custom settings location templates by [managing settings synchronization for custom applications](#customapps). +
+Note
+
+Settings location templates are not required for Windows apps. +
+
+ |
+
Windows app list |
+Settings for Windows apps are captured and applied dynamically. The app developer specifies the settings that are synchronized for each app. UE-V determines which Windows apps are enabled for settings synchronization using a managed list of apps. By default, this list includes most Windows apps. +You can add or remove applications in the Windows app list by following the procedures shown [here](http://technet.microsoft.com/library/dn458925.aspx). |
+
UE-V Generator |
+Use the UE-V Generator to create custom settings location templates that you can then distribute to user computers. The UE-V Generator also lets you edit an existing template or validate a template that was created by using another XML editor. |
+
Settings template catalog |
+The settings template catalog is a folder path on UE-V computers or a Server Message Block (SMB) network share that stores the custom settings location templates. The UE-V Agent checks this location once a day, retrieves new or updated templates, and updates its synchronization behavior. +If you use only the UE-V default settings location templates, then a settings template catalog is unnecessary. For more information about settings deployment catalogs, see [Configure a UE-V settings template catalog](http://technet.microsoft.com/library/dn458942.aspx#deploycatalogue). |
+
| Feature | +Synchronize Profiles using Windows 7 | +Synchronize Profiles using Windows 8 | +Synchronize Profiles using Windows 10 | +Microsoft account | +UE-V 2.0 | +UE-V 2.1 and 2.1 SP1 | +
|---|---|---|---|---|---|---|
Synchronize settings between multiple computers |
+● |
+● |
+● |
+● |
+● |
+● |
+
Synchronize settings between physical and virtual apps |
++ | + | + | + | ● |
+● |
+
Synchronize Windows app settings |
++ | + | + | ● |
+● |
+● |
+
Manage via WMI |
++ | ● |
+● |
++ | ● |
+● |
+
Synchronize settings changes on a regular basis |
++ | + | + | ● |
+● |
+● |
+
Minimal configuration for Setup |
+● |
+● |
+● |
+● |
+● |
+● |
+
Supported on non-domain joined computers |
++ | + | + | ● |
++ | + |
Supports Primary Computer Active Directory attribute |
++ | ● |
+● |
++ | + | + |
Synchronizes settings between virtual desktop infrastructure (VDI)/Remote Desktop Services (RDS) and rich desktops |
++ | + | + | + | ● |
+● |
+
Unlimited setting storage space |
+● |
+● |
+● |
++ | ● |
+● |
+
Choice in which app settings to synchronize |
++ | + | + | + | ● |
+● |
+
Backup/Restore for IT Pro |
++ | + | + | ● |
+Partial |
+● |
+
| Operating system | +Edition | +Service pack | +System architecture | +Windows PowerShell | +Microsoft .NET Framework | +
|---|---|---|---|---|---|
Windows 7 |
+Ultimate, Enterprise, or Professional Edition |
+SP1 |
+32-bit or 64-bit |
+Windows PowerShell 3.0 or higher |
+.NET Framework 4 or higher |
+
Windows Server 2008 R2 |
+Standard, Enterprise, Datacenter, or Web Server |
+SP1 |
+64-bit |
+Windows PowerShell 3.0 or higher |
+.NET Framework 4 or higher |
+
Windows 8 and Windows 8.1 |
+Enterprise or Pro |
+None |
+32-bit or 64-bit |
+Windows PowerShell 3.0 or higher |
+.NET Framework 4.5 |
+
Windows Server 2012 or Windows Server 2012 R2 |
+Standard or Datacenter |
+None |
+64-bit |
+Windows PowerShell 3.0 or higher |
+.NET Framework 4.5 |
+
| User account | +Recommended permissions | +
|---|---|
Everyone |
+ No permissions |
+
Security group of UE-V users |
+ Full control |
+
| User account | +Recommended permissions | +Folder | +
|---|---|---|
Creator/owner |
+ Full control |
+ Subfolders and files only |
+
Security group of UE-V users |
+ List folder/read data, create folders/append data |
+ This folder only |
+
| Windows PowerShell cmdlet | +Description | +
|---|---|
|
+ Restores the user settings for an application or restores a group of Windows settings. |
+
| WMI command | +Description | +
|---|---|
|
+ Restores the user settings for an application or restores a group of Windows settings. |
+
| Windows PowerShell command | +Description | +
|---|---|
|
+ Lists all the settings location templates that are registered on the computer. |
+
|
+ Lists all the settings location templates that are registered on the computer where the application name or template name contains <string>. |
+
|
+ Lists all the settings location templates that are registered on the computer where the template ID contains <string>. |
+
|
+ Lists all the settings location templates that are registered on the computer where the application or template name, or template ID contains <string>. |
+
|
+ Gets the name of the program and version information, which depend on the template ID. |
+
|
+ Gets the effective list of Windows apps. |
+
|
+ Gets the list of Windows apps that are configured for the computer. |
+
|
+ Gets the list of Windows apps that are configured for the current user. |
+
|
+ Registers one or more settings location template with UE-V by using relative paths and/or wildcard characters in file paths. After a template is registered, UE-V synchronizes the settings that are defined in the template between computers that have the template registered. |
+
|
+ Registers one or more settings location template with UE-V by using literal paths, where no characters can be interpreted as wildcard characters. After a template is registered, UE-V synchronizes the settings that are defined in the template between computers that have the template registered. |
+
|
+ Unregisters a settings location template with UE-V. When a template is unregistered, UE-V no longer synchronizes the settings that are defined in the template between computers. |
+
|
+ Unregisters all settings location templates with UE-V. When a template is unregistered, UE-V no longer synchronizes the settings that are defined in the template between computers. |
+
|
+ Updates one or more settings location templates with a more recent version of the template. Use relative paths and/or wildcard characters in the file paths. The new template should be a newer version than the existing template. |
+
|
+ Updates one or more settings location templates with a more recent version of the template. Use full paths to template files, where no characters can be interpreted as wildcard characters. The new template should be a newer version than the existing template. |
+
|
+ Removes one or more Windows apps from the computer Windows app list. |
+
|
+ Removes Windows app from the current user Windows app list. |
+
|
+ Removes all Windows apps from the computer Windows app list. |
+
|
+ Removes one or more Windows apps from the current user Windows app list. |
+
|
+ Removes all Windows apps from the current user Windows app list. |
+
|
+ Disables a settings location template for the current user of the computer. |
+
|
+ Disables one or more Windows apps in the computer Windows app list. |
+
|
+ Disables one or more Windows apps in the current user Windows app list. |
+
|
+ Enables a settings location template for the current user of the computer. |
+
|
+ Enables one or more Windows apps in the computer Windows app list. |
+
|
+ Enables one or more Windows apps in the current user Windows app list. |
+
|
+ Determines whether one or more settings location templates comply with its XML schema. Can use relative paths and wildcard characters. |
+
|
+ Determines whether one or more settings location templates comply with its XML schema. The path must be a full path to the template file, but does not include wildcard characters. |
+
Windows PowerShell command |
+ Description | +
|---|---|
|
+ Lists all the settings location templates that are registered for the computer. |
+
|
+ Gets the name of the program and version information, which depends on the template name. |
+
|
+ Gets the effective list of Windows apps. |
+
Get-WmiObject -Namespace root\Microsoft\UEV MachineConfiguredWindows8App |
+ Gets the list of Windows apps that are configured for the computer. |
+
|
+ Gets the list of Windows apps that are configured for the current user. |
+
|
+ Registers a settings location template with UE-V. |
+
|
+ Unregisters a settings location template with UE-V. As soon as a template is unregistered, UE-V no longer synchronizes the settings that are defined in the template between computers. |
+
|
+ Updates a settings location template with UE-V. The new template should be a newer version than the existing one. |
+
|
+ Removes one or more Windows apps from the computer Windows app list. |
+
|
+ Removes one or more Windows apps from the current user Windows app list. |
+
|
+ Disables one or more settings location templates with UE-V. |
+
|
+ Disables one or more Windows apps in the computer Windows app list. |
+
|
+ Disables one or more Windows apps in the current user Windows app list. |
+
|
+ Enables a settings location template with UE-V. |
+
|
+ Enables Windows apps in the computer Windows app list. |
+
|
+ Enables Windows apps in the current user Windows app list. |
+
|
+ Determines whether a given settings location template complies with its XML schema. |
+
| Windows PowerShell command | +Description | +
|---|---|
|
+ Gets the effective UE-V Agent settings. User-specific settings have precedence over the computer settings. |
+
|
+ Gets the UE-V Agent settings values for the current user only. |
+
|
+ Gets the UE-V Agent configuration settings values for all users on the computer. |
+
|
+ Gets the details for each configuration setting. Displays where the setting is configured or if it uses the default value. Is displayed if the current setting is valid. |
+
|
+ Sets the text that is displayed in the Company Settings Center for the help link. |
+
|
+ Sets the URL of the link in the Company Settings Center for the help link. Any URL protocol can be used. |
+
|
+ Configures the UE-V Agent to not synchronize any Windows apps for all users on the computer. |
+
|
+ Configures the UE-V Agent to not synchronize any Windows apps for the current computer user. |
+
|
+ Configures the UE-V Agent to display notification the first time the agent runs for all users on the computer. |
+
|
+ Configures the UE-V Agent to not display notification the first time that the agent runs for all users on the computer. |
+
|
+ Configures the UE-V Agent to notify all users on the computer when settings synchronization is delayed. +Use the DisableSettingsImportNotify parameter to disable notification. |
+
|
+ Configures the UE-V Agent to notify the current user when settings synchronization is delayed. +Use the DisableSettingsImportNotify parameter to disable notification. |
+
|
+ Configures the UE-V Agent to synchronize all Windows apps that are not explicitly disabled by the Windows app list for all users of the computer. For more information, see "Get-UevAppxPackage" in [Managing UE-V 2.x Settings Location Templates Using Windows PowerShell and WMI](uev-managing-settings-location-templates-using-windows-powershell-and-wmi.md). +Use the DisableSyncUnlistedWindows8Apps parameter to configure the UE-V Agent to synchronize only Windows apps that are explicitly enabled by the Windows App List. |
+
|
+ Configures the UE-V Agent to synchronize all Windows apps that are not explicitly disabled by the Windows app list for the current user on the computer. For more information, see "Get-UevAppxPackage" in [Managing UE-V 2.x Settings Location Templates Using Windows PowerShell and WMI](uev-managing-settings-location-templates-using-windows-powershell-and-wmi.md). +Use the DisableSyncUnlistedWindows8Apps parameter to configure the UE-V Agent to synchronize only Windows apps that are explicitly enabled by the Windows App List. |
+
|
+ Disables UE-V for all the users on the computer. +Use the EnableSync parameter to enable or re-enable. |
+
|
+ Disables UE-V for the current user on the computer. +Use the EnableSync parameter to enable or re-enable. |
+
|
+ Enables the UE-V icon in the notification area for all users of the computer. +Use the DisableTrayIcon parameter to disable the icon. |
+
|
+ Configures the UE-V agent to report when a settings package file size reaches the defined threshold for all users on the computer. Sets the threshold package size in bytes. |
+
|
+ Configures the UE-V agent to report when a settings package file size reaches the defined threshold. Sets the package size warning threshold for the current user. |
+
|
+ Specifies the time in seconds before the user is notified for all users of the computer |
+
|
+ Specifies the time in seconds before notification for the current user is sent. |
+
|
+ Defines a per-computer settings storage location for all users of the computer. |
+
|
+ Defines a per-user settings storage location. |
+
|
+ Sets the settings template catalog path for all users of the computer. |
+
|
+ Sets the synchronization method for all users of the computer: SyncProvider or None. |
+
|
+ Sets the synchronization method for the current user: SyncProvider or None. |
+
|
+ Sets the synchronization time-out in milliseconds for all users of the computer |
+
|
+ Set the synchronization time-out for the current user. |
+
|
+ Clears the specified setting for all users on the computer. |
+
|
+ Clears the specified setting for the current user only. |
+
|
+ Exports the UE-V computer configuration to a settings migration file. The file name extension must be .uev. +The |
+
|
+ Imports the UE-V computer configuration from a settings migration file. The file name extension must be .uev. |
+
Windows PowerShell command |
+ Description |
+
Export-UevPackage MicrosoftCalculator6.pkgx |
+ Extracts the settings from a Microsoft Calculator package file and converts them into a human-readable format in XML. |
+
Repair-UevTemplateIndex |
+ Repairs the index of the UE-V settings location templates. |
+
Windows PowerShell command |
+ Description | +
|---|---|
|
+ Displays the active UE-V Agent settings. User-specific settings have precedence over the computer settings. |
+
|
+ Displays the UE-V Agent configuration that is defined for a user. |
+
|
+ Displays the UE-V Agent configuration that is defined for a computer. |
+
|
+ Displays the details for each configuration item. |
+
$config.Put() |
+ Defines a per-computer settings storage location. |
+
|
+ Defines a per-user settings storage location. |
+
|
+ Sets the synchronization time-out in milliseconds for all users of the computer. |
+
|
+ Configures the UE-V Agent to report when a settings package file size reaches a defined threshold. Set the threshold package file size in bytes for all users of the computer. |
+
|
+ Sets the synchronization method for all users of the computer: SyncProvider or None. |
+
|
+ To enable a specific per-computer setting, clear the setting, and use $null as the setting value. Use UserConfiguration for per-user settings. |
+
|
+ To disable a specific per-computer setting, clear the setting, and use $null as the setting value. Use User Configuration for per-user settings. |
+
|
+ Updates a specific per-computer setting. To clear the setting, use $null as the setting value. |
+
|
+ Updates a specific per-user setting for all users of the computer. To clear the setting, use $null as the setting value. |
+
| WMI command | +Description | +
|---|---|
|
+ Extracts the settings from a package file and converts them into a human-readable format in XML. |
+
|
+ Repairs the index of the UE-V settings location templates. Must be run as administrator. |
+
| Application category | +Description | +
|---|---|
Microsoft Office 2010 applications +([Download a list of all settings synced](http://www.microsoft.com/download/details.aspx?id=46367)) |
+Microsoft Word 2010 +Microsoft Excel 2010 +Microsoft Outlook 2010 +Microsoft Access 2010 +Microsoft Project 2010 +Microsoft PowerPoint 2010 +Microsoft Publisher 2010 +Microsoft Visio 2010 +Microsoft SharePoint Workspace 2010 +Microsoft InfoPath 2010 +Microsoft Lync 2010 +Microsoft OneNote 2010 +Microsoft SharePoint Designer 2010 |
+
Microsoft Office 2013 applications +([Download a list of all settings synced](http://www.microsoft.com/download/details.aspx?id=46367)) |
+Microsoft Word 2013 +Microsoft Excel 2013 +Microsoft Outlook 2013 +Microsoft Access 2013 +Microsoft Project 2013 +Microsoft PowerPoint 2013 +Microsoft Publisher 2013 +Microsoft Visio 2013 +Microsoft InfoPath 2013 +Microsoft Lync 2013 +Microsoft OneNote 2013 +Microsoft SharePoint Designer 2013 +Microsoft Office 2013 Upload Center +Microsoft OneDrive for Business 2013 +The UE-V 2.1 and 2.1 SP1 Microsoft Office 2013 settings location templates include improved Outlook signature support. We’ve added synchronization of default signature settings for new, reply, and forwarded emails. +
+Note
+
+An Outlook profile must be created for any device on which a user wants to sync their Outlook signature. If the profile is not already created, the user can create one and then restart Outlook on that device to enable signature synchronization. +
+
+ |
+
Browser options: Internet Explorer 8, Internet Explorer 9, Internet Explorer 10, and Internet Explorer 11 |
+Favorites, home page, tabs, and toolbars. +
+Note
+
+UE-V does not roam settings for Internet Explorer cookies. +
+
+ |
+
Windows accessories |
+Microsoft Calculator, Notepad, WordPad. |
+
| Application category | +Description | +
|---|---|
Microsoft Office 2007 applications +([Download a list of all settings synced](http://www.microsoft.com/download/details.aspx?id=46367)) |
+Microsoft Access 2007 +Microsoft Communicator 2007 +Microsoft Excel 2007 +Microsoft InfoPath 2007 +Microsoft OneNote 2007 +Microsoft Outlook 2007 +Microsoft PowerPoint 2007 +Microsoft Project 2007 +Microsoft Publisher 2007 +Microsoft SharePoint Designer 2007 +Microsoft Visio 2007 +Microsoft Word 2007 |
+
Microsoft Office 2010 applications +([Download a list of all settings synced](http://www.microsoft.com/download/details.aspx?id=46367)) |
+Microsoft Word 2010 +Microsoft Excel 2010 +Microsoft Outlook 2010 +Microsoft Access 2010 +Microsoft Project 2010 +Microsoft PowerPoint 2010 +Microsoft Publisher 2010 +Microsoft Visio 2010 +Microsoft SharePoint Workspace 2010 +Microsoft InfoPath 2010 +Microsoft Lync 2010 +Microsoft OneNote 2010 +Microsoft SharePoint Designer 2010 |
+
Browser options: Internet Explorer 8, Internet Explorer 9, and Internet Explorer 10 |
+Favorites, home page, tabs, and toolbars. +
+Note
+
+UE-V does not roam settings for Internet Explorer cookies. +
+
+ |
+
Windows accessories |
+Microsoft Calculator, Notepad, WordPad. |
+
| Windows settings | +Description | +Apply on | +Export on | +Default state | +
|---|---|---|---|---|
Desktop background |
+Currently active desktop background or wallpaper. |
+Logon, unlock, remote connect, Scheduled Task events. |
+Logoff, lock, remote disconnect, user clicking Sync Now in Company Settings Center, or scheduled task interval |
+Enabled |
+
Ease of Access |
+Accessibility and input settings, Microsoft Magnifier, Narrator, and on-Screen Keyboard. |
+Logon only. |
+Logoff, user clicking Sync Now in Company Settings Center, or scheduled task interval |
+Enabled |
+
Desktop settings |
+Start menu and Taskbar settings, Folder options, Default desktop icons, Additional clocks, and Region and Language settings. |
+Logon only. |
+Logoff, user clicking Sync Now in Company Settings Center, or scheduled task |
+Enabled |
+
| Settings group | +Category | +Capture | +Apply | +
|---|---|---|---|
Application Settings |
+Windows apps |
+Close app +Windows app settings change event |
+Start the UE-V App Monitor at startup +Open app +Windows App Settings change event +Arrival of a settings package |
+
| + | Desktop applications |
+Application closes |
+Application opens and closes |
+
Desktop settings |
+Desktop background |
+Lock or logoff |
+Logon, unlock, remote connect, notification of new package arrival, user clicks Sync Now in Company Settings Center, or scheduled task runs. |
+
| + | Ease of Access (Common – Accessibility, Narrator, Magnifier, On-Screen-Keyboard) |
+Lock or Logoff |
+Logon |
+
| + | Ease of Access (Shell - Audio, Accessibility, Keyboard, Mouse) |
+Lock or logoff |
+Logon, unlock, remote connect, notification of new package arrival, user clicks Sync Now in Company Settings Center, or scheduled task runs |
+
| + | Desktop settings |
+Lock or logoff |
+Logon |
+
| + | Description | +
|---|---|
 |
+Does this application contain settings that the user can customize? |
+
|
+Is it important for the user that these settings are synchronized? |
+
|
+Are these user settings already managed by an application management or settings policy solution? UE-V applies application settings at application startup and Windows settings at logon, unlock, or remote connect events. If you use UE-V with other settings sharing solutions, users might experience inconsistency across synchronized settings. |
+
|
+Are the application settings specific to the computer? Application preferences and customizations that are associated with hardware or specific computer configurations do not consistently synchronize across sessions and can cause a poor application experience. |
+
|
+Does the application store settings in the Program Files directory or in the file directory that is located in the Users\[User name]\AppData\LocalLow directory? Application data that is stored in either of these locations usually should not synchronize with the user, because this data is specific to the computer or because the data is too large to synchronize. |
+
|
+Does the application store any settings in a file that contains other application data that should not synchronize? UE-V synchronizes files as a single unit. If settings are stored in files that include application data other than settings, then synchronizing this additional data can cause a poor application experience. |
+
|
+How large are the files that contain the settings? The performance of the settings synchronization can be affected by large files. Including large files can affect the performance of settings synchronization. |
+
| Operating system | +Edition | +Service pack | +System architecture | +Windows PowerShell | +Microsoft .NET Framework | +
|---|---|---|---|---|---|
Windows 7 |
+Ultimate, Enterprise, or Professional Edition |
+SP1 |
+32-bit or 64-bit |
+Windows PowerShell 3.0 or higher |
+.NET Framework 4.5 or higher for UE-V 2.1. +.NET Framework 4 or higher for UE-V 2.0. |
+
Windows Server 2008 R2 |
+Standard, Enterprise, Datacenter, or Web Server |
+SP1 |
+64-bit |
+Windows PowerShell 3.0 or higher |
+.NET Framework 4.5 or higher for UE-V 2.1. +.NET Framework 4 or higher for UE-V 2.0. |
+
Windows 8 and Windows 8.1 |
+Enterprise or Pro |
+None |
+32-bit or 64-bit |
+Windows PowerShell 3.0 or higher |
+.NET Framework 4.5 or higher |
+
Windows 10 +
+Note
+
+Only UE-V 2.1 SP1 supports Windows 10 +
+
+ |
+Enterprise or Pro |
+None |
+32-bit or 64-bit |
+Windows PowerShell 3.0 or higher |
+.NET Framework 4.6 |
+
Windows Server 2012 and Windows Server 2012 R2 |
+Standard or Datacenter |
+None |
+64-bit |
+Windows PowerShell 3.0 or higher |
+.NET Framework 4.5 or higher |
+
| User account | +Recommended permissions | +
|---|---|
Everyone |
+ No permissions |
+
Security group of UE-V |
+ Full control |
+
| User account | +Recommended permissions | +Folder | +
|---|---|---|
Creator/Owner |
+ No permissions |
+ No permissions |
+
Domain Admins |
+ Full control |
+ This folder, subfolders, and files |
+
Security group of UE-V users |
+ List folder/read data, create folders/append data |
+ This folder only |
+
Everyone |
+ Remove all permissions |
+ No permissions |
+
| User account | +Recommend permissions | +
|---|---|
Everyone |
+ No permissions |
+
Domain computers |
+ Read permission Levels |
+
Administrators |
+ Read/write permission levels |
+
| User account | +Recommended permissions | +Apply to | +
|---|---|---|
Creator/Owner |
+ Full control |
+ This folder, subfolders, and files |
+
Domain Computers |
+ List folder contents and Read permissions |
+ This folder, subfolders, and files |
+
Everyone |
+ No permissions |
+ No permissions |
+
Administrators |
+ Full Control |
+ This folder, subfolders, and files |
+
SyncMethod Configuration |
+V1.0 |
+V2.0 |
+V2.1 and V2.1 SP1 |
+Description |
+
SyncProvider |
+n/a |
+Default |
+Default |
+Settings changes for a specific application or for global Windows desktop settings are saved locally to a cache folder. These changes are then synchronized with the settings storage location when a synchronization trigger event takes place. Pushing out changes will save the local changes to the settings storage path. +This default setting is the gold standard for computers. This option attempts to synchronize the setting and times out after a short delay to ensure that the application or operating system startup isn’t delayed for a long period of time. +This functionality is also tied to the Scheduled task – Sync Controller Application. The administrator controls the frequency of the Scheduled task. By default, computers synchronize their settings every 30 min after logging on. |
+
OfflineFiles |
+Default |
+Deprecated |
+Deprecated |
+Behaves the same as SyncProvider in V2.0. +If Offline files are enabled and the folder is pinned then UE-V will unpin this folder and sync directly to the central SMB directory. +NOTE: In V1.0 if you wanted to use UE-V in a CorpNet disconnected manner (aka traveling with a Laptop), then the guidance is to use Offline Files to ensure that your settings roamed. We received sufficient customer feedback that turning on Offline files is a non-trivial enterprise blocker. So in UE-V 2, we created a tightly coupled synchronization engine to cache your data locally and synchronize the settings to the central server. This feature area does not replace Offline Files or Folder Redirection. +UE-V 2 does not work well with Offline folders so the guidance is not to set the settings storage path to a pinned Offline or CSC folder. |
+
External |
+n/a |
+n/a |
+Supported |
+New in UE-V 2.1, this configuration method specifies that if UE-V settings are written to a local folder on the user computer, then any external sync engine (such as OneDrive for Business, Work Folders, Sharepoint, or Dropbox) can be used to apply these settings to the different computers that users access. |
+
None |
+Yes |
+Yes |
+Yes |
+This configuration setting is designed for the Virtual Desktop Infrastructure (VDI) and Streamed Application experience primarily. This setting should be used on Windows Server boxes used in a datacenter, where the connection will always be available. +Any settings changes are saved directly to the server. If the network connection to the settings storage path is not available, then the settings changes are cached on the device and are synchronized the next time that the Sync Provider runs. If the settings storage path is not found and the user profile is removed from a pooled VDI environment on logoff, then these settings changes are lost, and the user must reapply the change when the computer can again reach the settings storage path. +Apps and OS will wait indefinitely for the location to be present. This could cause App load or OS logon time to dramatically increase if the location is not found. |
+
UE-V 2 Trigger Event |
+SyncMethod=SyncProvider |
+SyncMethod=None |
+
Windows Logon |
+
|
+
|
+
Windows Logoff |
+Store changes locally and cache and copy asynchronous and synchronous Windows settings to the settings storage location server, if available |
+Store changes to asynchronous and synchronous Windows settings storage location |
+
Windows Connect (RDP) / Unlock |
+Synchronize any asynchronous Windows settings from settings storage location to local cache, if available. +Apply cached Windows settings |
+Download and apply asynchronous windows settings from settings storage location |
+
Windows Disconnect (RDP) / Lock |
+Store asynchronous Windows settings changes to the local cache. +Synchronize any asynchronous Windows settings from the local cache to settings storage location, if available |
+Store asynchronous Windows settings changes to the settings storage location |
+
Application start |
+Apply application settings from local cache as the application starts |
+Apply application settings from settings storage location as the application starts |
+
Application closes |
+Store any application settings changes to the local cache and copy settings to settings storage location, if available |
+Store any application settings changes to settings storage location |
+
Sync Controller Scheduled Task or “Sync Now” is run from the Company Settings Center + |
+Application and Windows settings are synchronized between the settings storage location and the local cache. +
+Note
+
+Settings changes are not cached locally until an application closes. This trigger will not export changes made to a currently running application. +For Windows settings, this means that any changes will not be cached locally and exported until the next Lock (Asynchronous) or Logoff (Asynchronous and Synchronous). +
+
+
+Settings are applied in these cases: +
|
+NA |
+
Asynchronous Settings updated on remote store* |
+Load and apply new asynchronous settings from the cache. |
+Load and apply settings from central server |
+
| Office 2013 templates (UE-V 2.0, available on UE-V gallery): | +Office 2010 templates (UE-V 1.0 & 1.0 SP1): | +
|---|---|
MicrosoftOffice2013Win32.xml +MicrosoftOffice2013Win64.xml +MicrosoftLync2013Win32.xml +MicrosoftLync2013Win64.xml |
+MicrosoftOffice2010Win32.xml +MicrosoftOffice2010Win64.xml +MicrosoftLync2010.xml + |
+
Microsoft Access 2013 +Microsoft Lync 2013 +Microsoft Excel 2013 +Microsoft InfoPath 2013 +Microsoft OneNote 2013 +Microsoft Outlook 2013 +Microsoft PowerPoint 2013 +Microsoft Project 2013 +Microsoft Publisher 2013 +Microsoft SharePoint Designer 2013 +Microsoft Visio 2013 +Microsoft Word 2013 +Microsoft Office Upload Manager |
+Microsoft Access 2010 +Microsoft Lync 2010 +Microsoft Excel 2010 +Microsoft InfoPath 2010 +Microsoft OneNote 2010 +Microsoft Outlook 2010 +Microsoft PowerPoint 2010 +Microsoft Project 2010 +Microsoft Publisher 2010 +Microsoft SharePoint Designer 2010 +Microsoft Visio 2010 +Microsoft Word 2010 + |
+