mirror of
https://github.com/MicrosoftDocs/windows-itpro-docs.git
synced 2025-05-16 15:27:22 +00:00
Merge pull request #9866 from MicrosoftDocs/main
Publish main to live, Thursday 10:30AM PDT, 05/23
This commit is contained in:
Stacyrch140
GitHub
commit
e19d045bad
@ -899,6 +899,141 @@
|
||||
"source_path": "windows/configuration/start/start-secondary-tiles.md",
|
||||
"redirect_url": "/windows/configuration/start/layout",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-administering-uev-with-windows-powershell-and-wmi.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-administering-uev-with-windows-powershell-and-wmi",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-administering-uev.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-administering-uev",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-application-template-schema-reference.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-application-template-schema-reference",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-changing-the-frequency-of-scheduled-tasks.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-changing-the-frequency-of-scheduled-tasks",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-configuring-uev-with-group-policy-objects.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-configuring-uev-with-group-policy-objects",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-configuring-uev-with-system-center-configuration-manager.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-configuring-uev-with-system-center-configuration-manager",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-deploy-required-features.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-deploy-required-features",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-deploy-uev-for-custom-applications.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-deploy-uev-for-custom-applications",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-for-windows.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-for-windows",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-getting-started.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-getting-started",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-manage-administrative-backup-and-restore.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-manage-administrative-backup-and-restore",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-manage-configurations.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-manage-configurations",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-managing-settings-location-templates-using-windows-powershell-and-wmi.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-managing-settings-location-templates-using-windows-powershell-and-wmi",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-managing-uev-agent-and-packages-with-windows-powershell-and-wmi.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-managing-uev-agent-and-packages-with-windows-powershell-and-wmi",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-migrating-settings-packages.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-migrating-settings-packages",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-prepare-for-deployment.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-prepare-for-deployment",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-release-notes-1607.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-release-notes-1607",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-security-considerations.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-security-considerations",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-sync-methods.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-sync-methods",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-sync-trigger-events.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-sync-trigger-events",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-synchronizing-microsoft-office-with-uev.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-synchronizing-microsoft-office-with-uev",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-technical-reference.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-technical-reference",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-troubleshooting.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-troubleshooting",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-upgrade-uev-from-previous-releases.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-upgrade-uev-from-previous-releases",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-using-uev-with-application-virtualization-applications.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-using-uev-with-application-virtualization-applications",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-whats-new-in-uev-for-windows.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-whats-new-in-uev-for-windows",
|
||||
"redirect_document_id": false
|
||||
},
|
||||
{
|
||||
"source_path": "windows/configuration/ue-v/uev-working-with-custom-templates-and-the-uev-generator.md",
|
||||
"redirect_url": "/microsoft-desktop-optimization-pack/ue-v/uev-working-with-custom-templates-and-the-uev-generator",
|
||||
"redirect_document_id": false
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
@ -22,4 +22,4 @@ items:
|
||||
- name: Windows Configuration Designer
|
||||
href: wcd/toc.yml
|
||||
- name: User Experience Virtualization (UE-V)
|
||||
href: ue-v/toc.yml
|
||||
href: /microsoft-desktop-optimization-pack/ue-v/uev-for-windows
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 60 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 591 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 848 B |
Binary file not shown.
|
Before Width: | Height: | Size: 6.4 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 558 KiB |
@ -1,65 +0,0 @@
|
||||
items:
|
||||
- name: User Experience Virtualization (UE-V) for Windows 10
|
||||
href: uev-for-windows.md
|
||||
- name: Get started with UE-V
|
||||
items:
|
||||
- name: Get started with UE-V
|
||||
href: uev-getting-started.md
|
||||
- name: What's New in UE-V for Windows 10, version 1607
|
||||
href: uev-whats-new-in-uev-for-windows.md
|
||||
- name: User Experience Virtualization Release Notes
|
||||
href: uev-release-notes-1607.md
|
||||
- name: Upgrade to UE-V for Windows 10
|
||||
href: uev-upgrade-uev-from-previous-releases.md
|
||||
- name: Prepare a UE-V Deployment
|
||||
items:
|
||||
- name: Prepare a UE-V Deployment
|
||||
href: uev-prepare-for-deployment.md
|
||||
- name: Deploy Required UE-V Features
|
||||
href: uev-deploy-required-features.md
|
||||
- name: Deploy UE-V for use with Custom Applications
|
||||
href: uev-deploy-uev-for-custom-applications.md
|
||||
- name: Administer UE-V
|
||||
items:
|
||||
- name: UE-V administration guide
|
||||
href: uev-administering-uev.md
|
||||
- name: Manage Configurations for UE-V
|
||||
items:
|
||||
- name: Manage Configurations for UE-V
|
||||
href: uev-manage-configurations.md
|
||||
- name: Configuring UE-V with Group Policy Objects
|
||||
href: uev-configuring-uev-with-group-policy-objects.md
|
||||
- name: Configuring UE-V with Microsoft Configuration Manager
|
||||
href: uev-configuring-uev-with-system-center-configuration-manager.md
|
||||
- name: Administering UE-V with Windows PowerShell and WMI
|
||||
href: uev-administering-uev-with-windows-powershell-and-wmi.md
|
||||
- name: Managing the UE-V Service and Packages with Windows PowerShell and WMI
|
||||
href: uev-managing-uev-agent-and-packages-with-windows-powershell-and-wmi.md
|
||||
- name: Managing UE-V Settings Location Templates Using Windows PowerShell and WMI
|
||||
href: uev-managing-settings-location-templates-using-windows-powershell-and-wmi.md
|
||||
- name: Working with Custom UE-V Templates and the UE-V Template Generator
|
||||
href: uev-working-with-custom-templates-and-the-uev-generator.md
|
||||
- name: Manage Administrative Backup and Restore in UE-V
|
||||
href: uev-manage-administrative-backup-and-restore.md
|
||||
- name: Changing the Frequency of UE-V Scheduled Tasks
|
||||
href: uev-changing-the-frequency-of-scheduled-tasks.md
|
||||
- name: Migrating UE-V Settings Packages
|
||||
href: uev-migrating-settings-packages.md
|
||||
- name: Using UE-V with Application Virtualization Applications
|
||||
href: uev-using-uev-with-application-virtualization-applications.md
|
||||
- name: Troubleshooting UE-V
|
||||
href: uev-troubleshooting.md
|
||||
- name: Technical Reference for UE-V
|
||||
items:
|
||||
- name: Technical Reference for UE-V
|
||||
href: uev-technical-reference.md
|
||||
- name: Sync Methods for UE-V
|
||||
href: uev-sync-methods.md
|
||||
- name: Sync Trigger Events for UE-V
|
||||
href: uev-sync-trigger-events.md
|
||||
- name: Synchronizing Microsoft Office with UE-V
|
||||
href: uev-synchronizing-microsoft-office-with-uev.md
|
||||
- name: Application Template Schema Reference for UE-V
|
||||
href: uev-application-template-schema-reference.md
|
||||
- name: Security Considerations for UE-V
|
||||
href: uev-security-considerations.md
|
||||
@ -1,26 +0,0 @@
|
||||
---
|
||||
title: Administering UE-V with Windows PowerShell and WMI
|
||||
description: Learn how User Experience Virtualization (UE-V) provides Windows PowerShell cmdlets to help administrators perform various UE-V tasks.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Administering UE-V with Windows PowerShell and WMI
|
||||
|
||||
User Experience Virtualization (UE-V) provides Windows PowerShell cmdlets to help administrators perform various UE-V tasks. The following sections provide more information about using Windows PowerShell in UE-V.
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> Administering UE-V with Windows PowerShell requires PowerShell 3.0 or higher. For a complete list of UE-V cmdlets, see [User Experience Virtualization in Windows PowerShell](/powershell/module/uev/).
|
||||
|
||||
## Managing the UE-V service and packages by using Windows PowerShell and WMI
|
||||
|
||||
You can use Windows PowerShell and Windows Management Instrumentation (WMI) to manage UE-V service configuration and synchronization behavior. The following topic describes how to manage configuration and synchronization.
|
||||
|
||||
[Managing the UE-V Service and Packages with Windows PowerShell and WMI](uev-managing-uev-agent-and-packages-with-windows-powershell-and-wmi.md)
|
||||
|
||||
## Managing UE-V settings location templates by using Windows PowerShell and WMI
|
||||
|
||||
After you create and deploy UE-V settings location templates, you can manage those templates by using Windows PowerShell or WMI. The following topic describes how to manage the settings location templates by using Windows PowerShell and WMI.
|
||||
|
||||
[Managing UE-V Settings Location Templates Using Windows PowerShell and WMI](uev-managing-settings-location-templates-using-windows-powershell-and-wmi.md)
|
||||
@ -1,55 +0,0 @@
|
||||
---
|
||||
title: Administering UE-V
|
||||
description: Learn how to perform administrative tasks for User Experience Virtualization (UE-V). These tasks include configuring the UE-V service and recovering lost settings.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Administering UE-V
|
||||
|
||||
After you finish deploying User Experience Virtualization (UE-V), you'll perform ongoing administrative tasks, such as managing the configuration of the UE-V service and recovering lost settings. These tasks are explained in the following sections.
|
||||
|
||||
## Managing UE-V configurations
|
||||
|
||||
In the course of the UE-V lifecycle, you'll manage the configuration of the UE-V service and also manage storage locations for resources such as settings package files.
|
||||
|
||||
[Manage Configurations for UE-V](uev-manage-configurations.md)
|
||||
|
||||
## Working with custom UE-V templates and the UE-V template generator
|
||||
|
||||
This topic explains how to use the UE-V template generator and manage custom settings location templates.
|
||||
|
||||
[Working with Custom UE-V Templates and the UE-V Template Generator](uev-working-with-custom-templates-and-the-uev-generator.md)
|
||||
|
||||
## Back up and restore application and Windows settings that are synchronized with UE-V
|
||||
|
||||
Windows Management Instrumentation (WMI) and Windows PowerShell features of UE-V allow you to restore settings packages. By using WMI and Windows PowerShell commands, you can restore application and Windows settings to their original state and restore other settings when a user adopts a new device.
|
||||
|
||||
[Manage Administrative Backup and Restore in UE-V](uev-manage-administrative-backup-and-restore.md)
|
||||
|
||||
## Changing the frequency of UE-V scheduled tasks
|
||||
|
||||
You can configure the scheduled tasks that manage when UE-V checks for new or updated settings or for updated custom settings location templates in the settings template catalog.
|
||||
|
||||
[Changing the Frequency of UE-V Scheduled Tasks](uev-changing-the-frequency-of-scheduled-tasks.md)
|
||||
|
||||
## Migrating UE-V settings packages
|
||||
|
||||
You can relocate the user settings packages either when they migrate to a new server or for backup purposes.
|
||||
|
||||
[Migrating UE-V Settings Packages](uev-migrating-settings-packages.md)
|
||||
|
||||
## Using UE-V with Application Virtualization applications
|
||||
|
||||
You can use UE-V with Microsoft Application Virtualization (App-V) to share settings between virtual applications and installed applications across multiple computers.
|
||||
|
||||
[Using UE-V with Application Virtualization Applications](uev-using-uev-with-application-virtualization-applications.md)
|
||||
|
||||
## Other resources for this feature
|
||||
|
||||
- [User Experience Virtualization for Windows overview](uev-for-windows.md)
|
||||
- [Get Started with UE-V](uev-getting-started.md)
|
||||
- [Prepare a UE-V Deployment](uev-prepare-for-deployment.md)
|
||||
- [Troubleshooting UE-V](uev-troubleshooting.md)
|
||||
- [Technical Reference for UE-V](uev-technical-reference.md)
|
||||
|
||||
@ -1,744 +0,0 @@
|
||||
---
|
||||
title: Application Template Schema Reference for UE-V
|
||||
description: Learn details about the XML structure of the UE-V settings location templates and learn how to edit these files.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Application Template Schema Reference for UE-V
|
||||
|
||||
User Experience Virtualization (UE-V) uses XML settings location templates to define the desktop application settings and Windows settings that are captured and applied by UE-V. UE-V includes a set of default settings location templates. You can also create custom settings location templates with the UE-V template generator.
|
||||
|
||||
An advanced user can customize the XML file for a settings location template. This topic details the XML structure of the UE-V settings location templates and provides guidance for editing these files.
|
||||
|
||||
## UE-V Application Template Schema Reference
|
||||
|
||||
This section details the XML structure of the UE-V settings location template and provides guidance for editing this file.
|
||||
|
||||
### In This Section
|
||||
|
||||
- [XML Declaration and Encoding Attribute](#xml21)
|
||||
- [Namespace and Root Element](#namespace21)
|
||||
- [Data types](#data21)
|
||||
- [Name Element](#name21)
|
||||
- [ID Element](#id21)
|
||||
- [Version Element](#version21)
|
||||
- [Author Element](#author21)
|
||||
- [Processes and Process Element](#processes21)
|
||||
- [Application Element](#application21)
|
||||
- [Common Element](#common21)
|
||||
- [SettingsLocationTemplate Element](#settingslocationtemplate21)
|
||||
- [Appendix: SettingsLocationTemplate.xsd](#appendix21)
|
||||
|
||||
### <a href="" id="xml21"></a>XML Declaration and Encoding Attribute
|
||||
|
||||
**Mandatory: True**
|
||||
**Type: String**
|
||||
|
||||
The XML declaration must specify the XML version 1.0 attribute (<?xml version="1.0">). Settings location templates created by the UE-V template generator are saved in UTF-8 encoding, although the encoding isn't explicitly specified. We recommend that you include the encoding="UTF-8" attribute in this element as a best practice. All templates included with the product specify this tag as well (see the documents in %ProgramFiles%\\Microsoft User Experience Virtualization\\Templates for reference). For example:
|
||||
|
||||
`<?xml version="1.0" encoding="UTF-8"?>`
|
||||
|
||||
### <a href="" id="namespace21"></a>Namespace and Root Element
|
||||
|
||||
**Mandatory: True**
|
||||
**Type: String**
|
||||
|
||||
UE-V uses the `https://schemas.microsoft.com/UserExperienceVirtualization/2012/SettingsLocationTemplate` namespace for all applications. SettingsLocationTemplate is the root element and contains all other elements. Reference SettingsLocationTemplate in all templates using this tag:
|
||||
|
||||
```xml
|
||||
<SettingsLocationTemplate xmlns='https://schemas.microsoft.com/UserExperienceVirtualization/2012/SettingsLocationTemplate'>
|
||||
```
|
||||
|
||||
### <a href="" id="data21"></a>Data types
|
||||
|
||||
These data types are the ones for the UE-V application template schema.
|
||||
|
||||
<a href="" id="guid"></a>**GUID**
|
||||
GUID describes a standard globally unique identifier regular expression in the form "\\{\[a-fA-F0-9\]{8}-\[a-fA-F0-9\]{4}-\[a-fA-F0-9\]{4}-\[a-fA-F0-9\]{4}-\[a-fA-F0-9\]{12}\\}". This GUID is used in the Filesetting\\Root\\KnownFolder element to verify the formatting of well-known folders.
|
||||
|
||||
<a href="" id="filenamestring"></a>**FilenameString**
|
||||
FilenameString refers to the file name of a process to be monitored. Its values are restricted by the regex \[^\\\\\\?\\\*\\|<>/:\]+, (that is, they may not contain backslash characters, asterisk or question mark wild-card characters, the pipe character, the greater than or less than sign, forward slash, or colon characters).
|
||||
|
||||
<a href="" id="idstring"></a>**IDString**
|
||||
IDString refers to the ID value of Application elements, SettingsLocationTemplate, and Common elements (used to describe application suites that share common settings). It's restricted by the same regex as FilenameString (\[^\\\\\\?\\\*\\|<>/:\]+).
|
||||
|
||||
<a href="" id="templateversion"></a>**TemplateVersion**
|
||||
TemplateVersion is an integer value used to describe the revision of the settings location template. Its value may range from 0 to 2147483647.
|
||||
|
||||
<a href="" id="empty"></a>**Empty**
|
||||
Empty refers to a null value. This data type is used in Process\\ShellProcess to indicate that there's no process to monitor. This value shouldn't be used in any application templates.
|
||||
|
||||
<a href="" id="author"></a>**Author**
|
||||
The Author data type is a complex type that identifies the author of a template. It contains two child elements: **Name** and **Email**. Within the Author data type, the Name element is mandatory while the Email element is optional. This type is described in more detail under the SettingsLocationTemplate element.
|
||||
|
||||
<a href="" id="range"></a>**Range**
|
||||
Range defines an integer class consisting of two child elements: **Minimum** and **Maximum**. This data type is implemented in the ProcessVersion data type. If specified, both Minimum and Maximum values must be included.
|
||||
|
||||
<a href="" id="processversion"></a>**ProcessVersion**
|
||||
ProcessVersion defines a type with four child elements: **Major**, **Minor**, **Build**, and **Patch**. This data type is used by the Process element to populate its ProductVersion and FileVersion values. The data for this type is a Range value. The Major child element is mandatory and the others are optional.
|
||||
|
||||
<a href="" id="architecture"></a>**Architecture**
|
||||
Architecture enumerates two possible values: **Win32** and **Win64**. These values are used to specify process architecture.
|
||||
|
||||
<a href="" id="process"></a>**Process**
|
||||
The Process data type is a container used to describe processes to be monitored by UE-V. It contains six child elements: **Filename**, **Architecture**, **ProductName**, **FileDescription**, **ProductVersion**, and **FileVersion**. This table details each element's respective data type:
|
||||
|
||||
|Element|Data Type|Mandatory|
|
||||
|--- |--- |--- |
|
||||
|Filename|FilenameString|True|
|
||||
|Architecture|Architecture|False|
|
||||
|ProductName|String|False|
|
||||
|FileDescription|String|False|
|
||||
|ProductVersion|ProcessVersion|False|
|
||||
|FileVersion|ProcessVersion|False|
|
||||
|
||||
<a href="" id="processes"></a>**Processes**
|
||||
The Processes data type represents a container for a collection of one or more Process elements. Two child elements are supported in the Processes sequence type: **Process** and **ShellProcess**. Process is an element of type Process and ShellProcess is of data type Empty. At least one item must be identified in the sequence.
|
||||
|
||||
<a href="" id="path"></a>**Path**
|
||||
Path is consumed by RegistrySetting and FileSetting to refer to registry and file paths. This element supports two optional attributes: **Recursive** and **DeleteIfNotFound**. Both values are set to default="False".
|
||||
|
||||
Recursive indicates that the path and all subfolders are included for file settings or that all child registry keys are included for registry settings. In both cases, all items at the current level are included in the data captured. For a FileSettings object, all files within the specified folder are included in the data captured by UE-V but folders aren't included. For registry paths, all values in the current path are captured but child registry keys aren't captured. In both cases, care should be taken to avoid capturing large data sets or large numbers of items.
|
||||
|
||||
The DeleteIfNotFound attribute removes the setting from the user's settings storage path data. This removal may be desirable in cases where removing these settings from the package will save a large amount of disk space on the settings storage path file server.
|
||||
|
||||
<a href="" id="filemask"></a>**FileMask**
|
||||
FileMask specifies only certain file types for the folder that is defined by Path. For example, Path might be `C:\users\username\files` and FileMask could be `*.txt` to include only text files.
|
||||
|
||||
<a href="" id="registrysetting"></a>**RegistrySetting**
|
||||
RegistrySetting represents a container for registry keys and values and the associated desired behavior on the part of the UE-V service. Four child elements are defined within this type: **Path**, **Name**, **Exclude**, and a sequence of the values **Path** and **Name**.
|
||||
|
||||
<a href="" id="filesetting"></a>**FileSetting**
|
||||
FileSetting contains parameters associated with files and files paths. Four child elements are defined: **Root**, **Path**, **FileMask**, and **Exclude**. Root is mandatory and the others are optional.
|
||||
|
||||
<a href="" id="settings"></a>**Settings**
|
||||
Settings is a container for all the settings that apply to a particular template. It contains instances of the Registry, File, SystemParameter, and CustomAction settings described earlier. In addition, it can also contain the following child elements with behaviors described:
|
||||
|
||||
|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 element is useful for settings that can be applied asynchronously, such as those settings get/set through an API, like SystemParameterSetting.|
|
||||
|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 templates 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|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.|
|
||||
|
||||
### <a href="" id="name21"></a>Name Element
|
||||
|
||||
**Mandatory: True**
|
||||
**Type: String**
|
||||
|
||||
Name specifies a unique name for the settings location template. This name is used for display purposes when referencing the template in WMI, PowerShell, Event Viewer and debug logs. In general, avoid referencing version information, as this referencing can be objected from the ProductVersion element. For example, specify `<Name>My Application</Name>` rather than `<Name>My Application 1.1</Name>`.
|
||||
|
||||
> [!NOTE]
|
||||
> UE-V does not reference external DTDs, so it's not possible to use named entities in a settings location template. For example, do not use ® to refer to the registered trade mark sign ®. Instead, use canonical numbered references to include these types of special characters, for example, &\#174 for the ® character. This rule applies to all string values in this document.
|
||||
|
||||
See <http://www.w3.org/TR/xhtml1/dtds.html> for a complete list of character entities. UTF-8-encoded documents may include the Unicode characters directly. Saving templates through the UE-V template generator converts character entities to their Unicode representations automatically.
|
||||
|
||||
### <a href="" id="id21"></a>ID Element
|
||||
|
||||
**Mandatory: True**
|
||||
**Type: String**
|
||||
|
||||
ID populates a unique identifier for a particular template. This tag becomes the primary identifier that the UE-V service uses to reference the template at runtime (for example, see the output of the Get-UevTemplate and Get-UevTemplateProgram PowerShell cmdlets). By convention, this tag shouldn't contain any spaces, which simplifies scripting. Version numbers of applications should be specified in this element to allow for easy identification of the template, such as `<ID>MicrosoftOffice2016Win64</ID>`.
|
||||
|
||||
### <a href="" id="version21"></a>Version Element
|
||||
|
||||
**Mandatory: True**
|
||||
**Type: Integer**
|
||||
**Minimum Value: 0**
|
||||
**Maximum Value: 2147483647**
|
||||
|
||||
Version identifies the version of the settings location template for administrative tracking of changes. The UE-V template generator automatically increments this number by one each time the template is saved. Notice that this field must be a whole number integer; fractional values, such as `<Version>2.5</Version>` aren't allowed.
|
||||
|
||||
> [!TIP]
|
||||
> You can save notes about version changes using XML comment tags `<!-- -->`, for example:
|
||||
|
||||
```xml
|
||||
<!--
|
||||
Version History
|
||||
|
||||
Version 1 Jul 05, 2012 Initial template created by Generator - Denise@Contoso.com
|
||||
Version 2 Jul 31, 2012 Added support for app.exe v2.1.3 - Mark@Contoso.com
|
||||
Version 3 Jan 01, 2013 Added font settings support - Mark@Contoso.com
|
||||
Version 4 Jan 31, 2013 Added support for plugin settings - Tony@Contoso.com
|
||||
-->
|
||||
<Version>4</Version>
|
||||
```
|
||||
|
||||
> [!IMPORTANT]
|
||||
> This value is queried to determine if a new version of a template should be applied to an existing template in these instances:
|
||||
|
||||
- When the scheduled Template Auto Update task executes
|
||||
- When the Update-UevTemplate PowerShell cmdlet is executed
|
||||
- When the microsoft\\uev:SettingsLocationTemplate Update method is called through WMI
|
||||
|
||||
### <a href="" id="author21"></a>Author Element
|
||||
|
||||
**Mandatory: False**
|
||||
**Type: String**
|
||||
|
||||
Author identifies the creator of the settings location template. Two optional child elements are supported: **Name** and **Email**. Both attributes are optional, but, if the Email child element is specified, it must be accompanied by the Name element. Author refers to the full name of the contact for the settings location template, and email should refer to an email address for the author. We recommend that you include this information in templates published publicly.
|
||||
|
||||
### <a href="" id="processes21"></a>Processes and Process Element
|
||||
|
||||
**Mandatory: True**
|
||||
**Type: Element**
|
||||
|
||||
Processes contain at least one `<Process>` element, which in turn contains the following child elements: **Filename**, **Architecture**, **ProductName**, **FileDescription**, **ProductVersion**, and **FileVersion**. The Filename child element is mandatory and the others are optional. A fully populated element contains tags similar to this example:
|
||||
|
||||
```xml
|
||||
<Process>
|
||||
<Filename>MyApplication.exe</Filename>
|
||||
<Architecture>Win64</Architecture>
|
||||
<ProductName> MyApplication </ProductName>
|
||||
<FileDescription>MyApplication.exe</FileDescription>
|
||||
<ProductVersion>
|
||||
<Major Minimum="2" Maximum="2" />
|
||||
<Minor Minimum="0" Maximum="0" />
|
||||
<Build Minimum="0" Maximum="0" />
|
||||
<Patch Minimum="5" Maximum="5" />
|
||||
</ProductVersion>
|
||||
<FileVersion>
|
||||
<Major Minimum="2" Maximum="2" />
|
||||
<Minor Minimum="0" Maximum="0" />
|
||||
<Build Minimum="0" Maximum="0" />
|
||||
<Patch Minimum="5" Maximum="5" />
|
||||
</FileVersion>
|
||||
</Process>
|
||||
```
|
||||
|
||||
### Filename
|
||||
|
||||
**Mandatory: True**
|
||||
**Type: String**
|
||||
|
||||
Filename refers to the actual file name of the executable as it appears in the file system. This element specifies the primary criterion that UE-V uses to evaluate whether a template applies to a process or not. This element must be specified in the settings location template XML.
|
||||
|
||||
Valid filenames must not match the regular expression \[^\\\\\\?\\\*\\|<>/:\]+, that is, they may not contain backslash characters, asterisk or question mark wild-card characters, the pipe character, the greater than or less than sign, forward slash, or colon (the \\ ? \* | < > / or : characters.).
|
||||
|
||||
> [!TIP]
|
||||
> To test a string against this regex, use a PowerShell command window and substitute your executable's name for **YourFileName**:
|
||||
|
||||
`"YourFileName.exe" -match "[\\\?\*\|<>/:]+"`
|
||||
|
||||
A value of **True** indicates that the string contains illegal characters. Here are some examples of illegal values:
|
||||
|
||||
- \\\\server\\share\\program.exe
|
||||
- Program\*.exe
|
||||
- Pro?ram.exe
|
||||
- Program<1>.exe
|
||||
|
||||
> [!NOTE]
|
||||
> The UE-V template generator encodes the greater than and less than characters as > and < respectively.
|
||||
|
||||
In rare circumstances, the FileName value won't necessarily include the .exe extension, but it should be specified as part of the value. For example, `<Filename>MyApplication.exe</Filename>` should be specified instead of `<Filename>MyApplication</Filename>`. The second example won't apply the template to the process if the actual name of the executable file is "MyApplication.exe".
|
||||
|
||||
### Architecture
|
||||
|
||||
**Mandatory: False**
|
||||
**Type: Architecture (String)**
|
||||
|
||||
Architecture refers to the processor architecture for which the target executable was compiled. Valid values are Win32 for 32-bit applications or Win64 for 64-bit applications. If present, this tag limits the applicability of the settings location template to a particular application architecture. For an example of this applicability restriction, compare the %ProgramFiles%\\Microsoft User Experience Virtualization\\templates\\ MicrosoftOffice2016Win32.xml and MicrosoftOffice2016Win64.xml files included with UE-V. This applicability restriction is useful when relative paths change between different versions of an executable or if settings have been added or removed when moving from one processor architecture to another.
|
||||
|
||||
If this element is absent, the settings location template ignores the process' architecture and applies to both 32-bit and 64-bit processes if the file name and other attributes apply.
|
||||
|
||||
> [!NOTE]
|
||||
> UE-V does not support ARM processors in this version.
|
||||
|
||||
### ProductName
|
||||
|
||||
**Mandatory: False**
|
||||
**Type: String**
|
||||
|
||||
ProductName is an optional element used to identify a product for administrative purposes or reporting. ProductName differs from Filename in that there are no regular expression restrictions on its value. This flexibility allows for more easily understood descriptions of a process where the executable name may not be obvious. For example:
|
||||
|
||||
```xml
|
||||
<Process>
|
||||
<Filename>MyApplication.exe</Filename>
|
||||
<ProductName>My Application 6.x by Contoso.com</ProductName>
|
||||
<ProductVersion>
|
||||
<Major Minimum="6" Maximum="6" />
|
||||
</ProductVersion>
|
||||
</Process>
|
||||
```
|
||||
|
||||
### FileDescription
|
||||
|
||||
**Mandatory: False**
|
||||
**Type: String**
|
||||
|
||||
FileDescription is an optional tag that allows for an administrative description of the executable file. This tag is a free text field and can be useful in distinguishing multiple executables within a software package where there's a need to identify the function of the executable.
|
||||
|
||||
For example, in a suited application, it might be useful to provide reminders about the function of two executables (MyApplication.exe and MyApplicationHelper.exe), as shown here:
|
||||
|
||||
```xml
|
||||
<Processes>
|
||||
|
||||
<Process>
|
||||
<Filename>MyApplication.exe</Filename>
|
||||
<FileDescription>My Application Main Engine</ FileDescription>
|
||||
<ProductVersion>
|
||||
<Major Minimum="6" Maximum="6" />
|
||||
</ProductVersion>
|
||||
</Process>
|
||||
<Process>
|
||||
<Filename>MyApplicationHelper.exe</Filename>
|
||||
<FileDescription>My Application Background Process Executable</FileDescription>
|
||||
<ProductVersion>
|
||||
<Major Minimum="6" Maximum="6" />
|
||||
</ProductVersion>
|
||||
</Process>
|
||||
</Processes>
|
||||
```
|
||||
|
||||
### ProductVersion
|
||||
|
||||
**Mandatory: False**
|
||||
**Type: String**
|
||||
|
||||
ProductVersion refers to the major and minor product versions of a file, as well as a build and patch level. ProductVersion is an optional element, but if specified, it must contain at least the Major child element. The value must express a range in the form Minimum="X" Maximum="Y" where X and Y are integers. The Minimum and Maximum values can be identical.
|
||||
|
||||
The product and file version elements may be left unspecified. Doing so makes the template "version agnostic", meaning that the template will apply to all versions of the specified executable.
|
||||
|
||||
**Example 1:**
|
||||
|
||||
Product version: 1.0 specified in the UE-V template generator produces the following XML:
|
||||
|
||||
```xml
|
||||
<ProductVersion>
|
||||
<Major Minimum="1" Maximum="1" />
|
||||
<Minor Minimum="0" Maximum="0" />
|
||||
</ProductVersion>
|
||||
```
|
||||
|
||||
**Example 2:**
|
||||
|
||||
File version: 5.0.2.1000 specified in the UE-V template generator produces the following XML:
|
||||
|
||||
```xml
|
||||
<FileVersion>
|
||||
<Major Minimum="5" Maximum="5" />
|
||||
<Minor Minimum="0" Maximum="0" />
|
||||
<Build Minimum="2" Maximum="2" />
|
||||
<Patch Minimum="1000" Maximum="1000" />
|
||||
</FileVersion>
|
||||
```
|
||||
|
||||
**Incorrect Example 1 - incomplete range:**
|
||||
|
||||
Only the Minimum attribute is present. Maximum must be included in a range as well.
|
||||
|
||||
```xml
|
||||
<ProductVersion>
|
||||
<Major Minimum="2" />
|
||||
</ProductVersion>
|
||||
```
|
||||
|
||||
**Incorrect Example 2 - Minor specified without Major element:**
|
||||
|
||||
Only the Minor element is present. Major must be included as well.
|
||||
|
||||
```xml
|
||||
<ProductVersion>
|
||||
<Minor Minimum="0" Maximum="0" />
|
||||
</ProductVersion>
|
||||
```
|
||||
|
||||
### FileVersion
|
||||
|
||||
**Mandatory: False**
|
||||
**Type: String**
|
||||
|
||||
FileVersion differentiates between the release version of a published application and the internal build details of a component executable. For most of the commercial applications, these numbers are identical. Where they vary, the product version of a file indicates a generic version identification of a file, while file version indicates a specific build of a file (as in the example of a hotfix or update). This file version uniquely identifies files without breaking detection logic.
|
||||
|
||||
To determine the product version and file version of a particular executable, right-click on the file in Windows Explorer, select Properties, then click on the Details tab.
|
||||
|
||||
Including a FileVersion element for an application allows for more granular fine-tuning detection logic, but isn't necessary for most applications. The ProductVersion element settings are checked first, and then FileVersion is checked. The more restrictive setting will apply.
|
||||
|
||||
The child elements and syntax rules for FileVersion are identical to those elements and rules of ProductVersion.
|
||||
|
||||
```xml
|
||||
<Process>
|
||||
<Filename>MSACCESS.EXE</Filename>
|
||||
<Architecture>Win32</Architecture>
|
||||
<ProductVersion>
|
||||
<Major Minimum="14" Maximum="14" />
|
||||
<Minor Minimum="0" Maximum="0" />
|
||||
</ProductVersion>
|
||||
<FileVersion>
|
||||
<Major Minimum="14" Maximum="14" />
|
||||
<Minor Minimum="0" Maximum="0" />
|
||||
</FileVersion>
|
||||
</Process>
|
||||
```
|
||||
|
||||
### <a href="" id="application21"></a>Application Element
|
||||
|
||||
Application is a container for settings that apply to a particular application. It's a collection of the following fields/types.
|
||||
|
||||
|Field/Type|Description|
|
||||
|--- |--- |
|
||||
|Name|Specifies a unique name for the settings location template. This name 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 service 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 type controls whether this template is enabled in conjunction with Office361. If Office 365 is being used to sync settings, this template will automatically be disabled.|
|
||||
|FixedProfile|Specifies that this template can only be associated with the profile specified within this element, and can't 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)".|
|
||||
|
||||
### <a href="" id="common21"></a>Common Element
|
||||
|
||||
Common is similar to an Application element, but it's always associated with two or more Application elements. The Common section represents the set of settings that are shared between those Application instances. It's a collection of the following fields/types.
|
||||
|
||||
|Field/Type|Description|
|
||||
|--- |--- |
|
||||
|Name|Specifies a unique name for the settings location template. This name 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 service 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 type controls whether this template is enabled in conjunction with Office361. If Office 365 is being used to sync settings, this template will automatically be disabled.|
|
||||
|FixedProfile|Specifies that this template can only be associated with the profile specified within this element, and can't 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).|
|
||||
|
||||
### <a href="" id="settingslocationtemplate21"></a>SettingsLocationTemplate Element
|
||||
|
||||
This element defines the settings for a single application or a suite of applications.
|
||||
|
||||
|Field/Type|Description|
|
||||
|--- |--- |
|
||||
|Name|Specifies a unique name for the settings location template. This type 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 service 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.|
|
||||
|
||||
### <a href="" id="appendix21"></a>Appendix: SettingsLocationTemplate.xsd
|
||||
|
||||
Here's the SettingsLocationTemplate.xsd file showing its elements, child elements, attributes, and parameters:
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<xs:schema id="UevSettingsLocationTemplate"
|
||||
targetNamespace="https://schemas.microsoft.com/UserExperienceVirtualization/2013A/SettingsLocationTemplate"
|
||||
elementFormDefault="qualified"
|
||||
xmlns="https://schemas.microsoft.com/UserExperienceVirtualization/2013A/SettingsLocationTemplate"
|
||||
xmlns:mstns="https://schemas.microsoft.com/UserExperienceVirtualization/2013A/SettingsLocationTemplate"
|
||||
xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||||
|
||||
<xs:simpleType name="Guid">
|
||||
<xs:restriction base="xs:string">
|
||||
<xs:pattern value="\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}" />
|
||||
</xs:restriction>
|
||||
</xs:simpleType>
|
||||
|
||||
<xs:simpleType name="FilenameString">
|
||||
<xs:restriction base="xs:string">
|
||||
<xs:pattern value="[^\\\?\*\|<>/:]+" />
|
||||
</xs:restriction>
|
||||
</xs:simpleType>
|
||||
|
||||
<xs:simpleType name="IDString">
|
||||
<xs:restriction base="xs:string">
|
||||
<xs:pattern value="[^\\\?\*\|<>/:.]+" />
|
||||
</xs:restriction>
|
||||
</xs:simpleType>
|
||||
|
||||
<xs:simpleType name="CompositeIDString">
|
||||
<xs:restriction base="xs:string">
|
||||
<xs:pattern value="[^\\\?\*\|<>/:.]+([.][^\\\?\*\|<>/:.]+)?" />
|
||||
</xs:restriction>
|
||||
</xs:simpleType>
|
||||
|
||||
<xs:simpleType name="TemplateVersion">
|
||||
<xs:restriction base="xs:integer">
|
||||
<xs:minInclusive value="0" />
|
||||
<xs:maxInclusive value="2147483647" />
|
||||
</xs:restriction>
|
||||
</xs:simpleType>
|
||||
|
||||
<xs:complexType name="Empty">
|
||||
<xs:sequence/>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="LocalizedString">
|
||||
<xs:simpleContent>
|
||||
<xs:extension base="xs:string">
|
||||
<xs:attribute name="Locale" type="xs:string" use="required"/>
|
||||
</xs:extension>
|
||||
</xs:simpleContent>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="LocalizedName">
|
||||
<xs:sequence>
|
||||
<xs:element name="Name" type="LocalizedString" minOccurs="1" maxOccurs="unbounded" />
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="LocalizedDescription">
|
||||
<xs:sequence>
|
||||
<xs:element name="Description" type="LocalizedString" minOccurs="1" maxOccurs="unbounded" />
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="ReplacedTemplates">
|
||||
<xs:sequence>
|
||||
<xs:element name="ID" type="CompositeIDString" minOccurs="1" maxOccurs="unbounded" />
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="Author">
|
||||
<xs:all>
|
||||
<xs:element name="Name" type="xs:string" minOccurs="1" />
|
||||
<xs:element name="Email" type="xs:string" minOccurs="0" />
|
||||
</xs:all>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="Range">
|
||||
<xs:attribute name="Minimum" type="xs:integer" use="required"/>
|
||||
<xs:attribute name="Maximum" type="xs:integer" use="required"/>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="ProcessVersion">
|
||||
<xs:sequence>
|
||||
<xs:element name="Major" type="Range" minOccurs="1" />
|
||||
<xs:element name="Minor" type="Range" minOccurs="0" />
|
||||
<xs:element name="Build" type="Range" minOccurs="0" />
|
||||
<xs:element name="Patch" type="Range" minOccurs="0" />
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:simpleType name="Architecture">
|
||||
<xs:restriction base="xs:string">
|
||||
<xs:enumeration value="Win32"/>
|
||||
<xs:enumeration value="Win64"/>
|
||||
</xs:restriction>
|
||||
</xs:simpleType>
|
||||
|
||||
<xs:complexType name="Process">
|
||||
<xs:sequence>
|
||||
<xs:element name="Filename" type="FilenameString" minOccurs="1" />
|
||||
<xs:element name="Architecture" type="Architecture" minOccurs="0" />
|
||||
<xs:element name="ProductName" type="xs:string" minOccurs="0" />
|
||||
<xs:element name="FileDescription" type="xs:string" minOccurs="0" />
|
||||
<xs:element name="ProductVersion" type="ProcessVersion" minOccurs="0" maxOccurs="unbounded"/>
|
||||
<xs:element name="FileVersion" type="ProcessVersion" minOccurs="0" maxOccurs="unbounded"/>
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="Processes">
|
||||
<xs:sequence>
|
||||
<xs:choice minOccurs="1">
|
||||
<xs:element name="Process" type="Process" />
|
||||
<xs:element name="ShellProcess" type="Empty" />
|
||||
</xs:choice>
|
||||
<xs:element name="Process" type="Process" minOccurs="0" maxOccurs="unbounded" />
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="Path">
|
||||
<xs:simpleContent>
|
||||
<xs:extension base="xs:string">
|
||||
<xs:attribute name="Recursive" type="xs:boolean" default="false"/>
|
||||
<xs:attribute name="DeleteIfNotFound" type="xs:boolean" default="false"/>
|
||||
</xs:extension>
|
||||
</xs:simpleContent>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="RegistrySetting">
|
||||
<xs:sequence>
|
||||
<xs:element name="Path" type="Path" />
|
||||
<xs:element name="Name" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
|
||||
<xs:element name="Exclude" minOccurs="0" maxOccurs="unbounded">
|
||||
<xs:complexType>
|
||||
<xs:sequence>
|
||||
<xs:element name="Path" type="Path" minOccurs="0" />
|
||||
<xs:element name="Name" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
</xs:element>
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="FileSetting">
|
||||
<xs:sequence>
|
||||
|
||||
<xs:element name="Root">
|
||||
<xs:complexType>
|
||||
<xs:choice>
|
||||
<xs:element name="KnownFolder" type="Guid" />
|
||||
<xs:element name="RegistryEntry" type="xs:string" />
|
||||
<xs:element name="EnvironmentVariable" type="xs:string" />
|
||||
</xs:choice>
|
||||
</xs:complexType>
|
||||
</xs:element>
|
||||
|
||||
<xs:element name="Path" minOccurs="0" type="Path" />
|
||||
<xs:element name="FileMask" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
|
||||
|
||||
<xs:element name="Exclude" minOccurs="0" maxOccurs="unbounded">
|
||||
<xs:complexType>
|
||||
<xs:sequence>
|
||||
<xs:element name="Path" type="Path" minOccurs="0" />
|
||||
<xs:element name="FileMask" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
</xs:element>
|
||||
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:simpleType name="CustomActionSetting">
|
||||
<xs:restriction base="xs:anyURI"/>
|
||||
</xs:simpleType>
|
||||
|
||||
<xs:simpleType name="SystemParameterSetting">
|
||||
<xs:restriction base="xs:string">
|
||||
|
||||
<!-- Accessibility parameters -->
|
||||
<xs:enumeration value="AccessTimeout"/>
|
||||
<xs:enumeration value="AudioDescription"/>
|
||||
<xs:enumeration value="ClientAreaAnimation"/>
|
||||
<xs:enumeration value="DisableOverlappedContent"/>
|
||||
<xs:enumeration value="FilterKeys"/>
|
||||
<xs:enumeration value="FocusBorderHeight"/>
|
||||
<xs:enumeration value="FocusBorderWidth"/>
|
||||
<xs:enumeration value="HighContrast"/>
|
||||
<xs:enumeration value="MessageDuration"/>
|
||||
<xs:enumeration value="MouseClickLock"/>
|
||||
<xs:enumeration value="MouseClickLockTime"/>
|
||||
<xs:enumeration value="MouseKeys"/>
|
||||
<xs:enumeration value="MouseSonar"/>
|
||||
<xs:enumeration value="MouseVanish"/>
|
||||
<xs:enumeration value="ScreenReader"/>
|
||||
<xs:enumeration value="ShowSounds"/>
|
||||
<xs:enumeration value="SoundSentry"/>
|
||||
<xs:enumeration value="StickyKeys"/>
|
||||
<xs:enumeration value="ToggleKeys"/>
|
||||
|
||||
<!-- Input parameters -->
|
||||
<xs:enumeration value="Beep"/>
|
||||
<xs:enumeration value="BlockSendInputResets"/>
|
||||
<xs:enumeration value="DefaultInputLang"/>
|
||||
<xs:enumeration value="DoubleClickTime"/>
|
||||
<xs:enumeration value="DoubleClkHeight"/>
|
||||
<xs:enumeration value="DoubleClkWidth"/>
|
||||
<xs:enumeration value="KeyboardCues"/>
|
||||
<xs:enumeration value="KeyboardDelay"/>
|
||||
<xs:enumeration value="KeyboardPref"/>
|
||||
<xs:enumeration value="KeyboardSpeed"/>
|
||||
<xs:enumeration value="Mouse"/>
|
||||
<xs:enumeration value="MouseButtonSwap"/>
|
||||
<xs:enumeration value="MouseHoverHeight"/>
|
||||
<xs:enumeration value="MouseHoverTime"/>
|
||||
<xs:enumeration value="MouseHoverWidth"/>
|
||||
<xs:enumeration value="MouseSpeed"/>
|
||||
<xs:enumeration value="MouseTrails"/>
|
||||
<xs:enumeration value="SnapToDefButton"/>
|
||||
<xs:enumeration value="WheelScrollChars"/>
|
||||
<xs:enumeration value="WheelScrollLines"/>
|
||||
|
||||
<!-- Desktop parameters (limited subset) -->
|
||||
<xs:enumeration value="DeskWallpaper"/>
|
||||
<xs:enumeration value="DesktopColor"/>
|
||||
|
||||
</xs:restriction>
|
||||
</xs:simpleType>
|
||||
|
||||
<xs:complexType name="Settings">
|
||||
<xs:sequence>
|
||||
<xs:element name="Asynchronous" type="xs:boolean" minOccurs="0" />
|
||||
<xs:element name="PreventOverlappingSynchronization" type="xs:boolean" minOccurs="0" />
|
||||
<xs:element name="AlwaysApplySettings" type="xs:boolean" minOccurs="0" />
|
||||
<xs:choice minOccurs="0" maxOccurs="unbounded">
|
||||
<xs:element name="Registry" type="RegistrySetting" />
|
||||
<xs:element name="File" type="FileSetting" />
|
||||
<xs:element name="SystemParameter" type="SystemParameterSetting" />
|
||||
<xs:element name="CustomAction" type="CustomActionSetting" />
|
||||
</xs:choice>
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="Common">
|
||||
<xs:sequence>
|
||||
<xs:element name="Name" type="xs:string" />
|
||||
<xs:element name="ID" type="IDString" />
|
||||
<xs:element name="ReplacedTemplates" type="ReplacedTemplates" minOccurs="0" />
|
||||
<xs:element name="Description" type="xs:string" minOccurs="0" />
|
||||
<xs:element name="LocalizedNames" type="LocalizedName" minOccurs="0" />
|
||||
<xs:element name="LocalizedDescriptions" type="LocalizedDescription" minOccurs="0" />
|
||||
<xs:element name="Version" type="xs:integer" />
|
||||
<xs:element name="DeferToMSAccount" type="Empty" minOccurs="0" />
|
||||
<xs:element name="DeferToOffice365" type="Empty" minOccurs="0" />
|
||||
<xs:element name="Settings" type="Settings" />
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="Application">
|
||||
<xs:sequence>
|
||||
<xs:element name="Name" type="xs:string" />
|
||||
<xs:element name="ID" type="IDString" />
|
||||
<xs:element name="ReplacedTemplates" type="ReplacedTemplates" minOccurs="0" />
|
||||
<xs:element name="Description" type="xs:string" minOccurs="0" />
|
||||
<xs:element name="LocalizedNames" type="LocalizedName" minOccurs="0" />
|
||||
<xs:element name="LocalizedDescriptions" type="LocalizedDescription" minOccurs="0" />
|
||||
<xs:element name="Version" type="xs:integer" />
|
||||
<xs:element name="DeferToMSAccount" type="Empty" minOccurs="0" />
|
||||
<xs:element name="DeferToOffice365" type="Empty" minOccurs="0" />
|
||||
<xs:element name="Processes" type="Processes" />
|
||||
<xs:element name="Settings" type="Settings" />
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:element name="SettingsLocationTemplate">
|
||||
<xs:complexType>
|
||||
<xs:sequence>
|
||||
|
||||
<xs:element name="Name" type="xs:string" />
|
||||
<xs:element name="ID" type="IDString" />
|
||||
<xs:element name="Description" type="xs:string" minOccurs="0" />
|
||||
<xs:element name="LocalizedNames" type="LocalizedName" minOccurs="0" />
|
||||
<xs:element name="LocalizedDescriptions" type="LocalizedDescription" minOccurs="0" />
|
||||
|
||||
<xs:choice>
|
||||
|
||||
<!-- Single application -->
|
||||
<xs:sequence>
|
||||
<xs:element name="ReplacedTemplates" type="ReplacedTemplates" minOccurs="0" />
|
||||
<xs:element name="Version" type="TemplateVersion" />
|
||||
<xs:element name="Author" type="Author" minOccurs="0" />
|
||||
<xs:element name="FixedProfile" type="xs:string" minOccurs="0" />
|
||||
<xs:element name="DeferToMSAccount" type="Empty" minOccurs="0" />
|
||||
<xs:element name="DeferToOffice365" type="Empty" minOccurs="0" />
|
||||
<xs:element name="Processes" type="Processes" />
|
||||
<xs:element name="Settings" type="Settings" />
|
||||
</xs:sequence>
|
||||
|
||||
<!-- Suite of applications -->
|
||||
<xs:sequence>
|
||||
<xs:element name="ManageSuiteOnly" type="xs:boolean" minOccurs="0" />
|
||||
<xs:element name="Author" type="Author" minOccurs="0" />
|
||||
<xs:element name="FixedProfile" type="xs:string" minOccurs="0" />
|
||||
<xs:element name="Common" type="Common" />
|
||||
<xs:element name="Application" type="Application" minOccurs="2" maxOccurs="unbounded" />
|
||||
</xs:sequence>
|
||||
|
||||
</xs:choice>
|
||||
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
</xs:element>
|
||||
<!-- SettingsLocationTemplate -->
|
||||
|
||||
</xs:schema>
|
||||
```
|
||||
|
||||
## Related topics
|
||||
|
||||
[Working with Custom UE-V Templates and the UE-V Template Generator](uev-working-with-custom-templates-and-the-uev-generator.md)
|
||||
[Technical Reference for UE-V](uev-technical-reference.md)
|
||||
@ -1,109 +0,0 @@
|
||||
---
|
||||
title: Changing the Frequency of UE-V Scheduled Tasks
|
||||
description: Learn how to create a script that uses the Schtasks.exe command-line options so you can change the frequency of UE-V scheduled tasks.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Changing the Frequency of UE-V Scheduled Tasks
|
||||
|
||||
When the User Experience Virtualization (UE-V) service is enabled, it creates the following scheduled tasks:
|
||||
|
||||
- [Monitor Application Settings](#monitor-application-settings)
|
||||
- [Sync Controller Application](#sync-controller-application)
|
||||
- [Synchronize Settings at Logoff](#synchronize-settings-at-logoff)
|
||||
- [Template Auto Update](#template-auto-update)
|
||||
|
||||
> [!NOTE]
|
||||
> These tasks must remain enabled, because UE-V cannot function without them.
|
||||
|
||||
These scheduled tasks aren't configurable with the UE-V tools. Administrators who want to change the scheduled task for these items can create a script that uses the Schtasks.exe command-line options.
|
||||
|
||||
For more information about Schtasks.exe, see [Schtasks](/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/cc725744(v=ws.11)).
|
||||
|
||||
## UE-V Scheduled Tasks
|
||||
|
||||
The following scheduled tasks are included in UE-V with sample scheduled task configuration commands.
|
||||
|
||||
### Monitor Application Settings
|
||||
|
||||
The **Monitor Application Settings** task is used to synchronize settings for Windows apps. It's runs at sign in but is delayed by 30 seconds to not affect the logon detrimentally. The Monitor Application Status task runs the UevAppMonitor.exe file, which is located in the UE-V Agent installation directory.
|
||||
|
||||
|Task name|Default event|
|
||||
|--- |--- |
|
||||
|\Microsoft\UE-V\Monitor Application Status|Sign in|
|
||||
|
||||
### Sync Controller Application
|
||||
|
||||
The **Sync Controller Application** task is used to start the Sync Controller to synchronize settings from the computer to the settings storage location. By default, the task runs every 30 minutes. At that time, local settings are synchronized to the settings storage location, and updated settings on the settings storage location are synchronized to the computer. The Sync Controller application runs the Microsoft.Uev.SyncController.exe, which is located in the UE-V Agent installation directory.
|
||||
|
||||
|Task name|Default event|
|
||||
|--- |--- |
|
||||
|\Microsoft\UE-V\Sync Controller Application|Sign in, and every 30 minutes thereafter|
|
||||
|
||||
For example, the following command configures the agent to synchronize settings every 15 minutes instead of the default 30 minutes.
|
||||
|
||||
```console
|
||||
Schtasks /change /tn "Microsoft\UE-V\Sync Controller Application" /ri 15
|
||||
```
|
||||
|
||||
### Synchronize Settings at Logoff
|
||||
|
||||
The **Synchronize Settings at Logoff** task is used to start an application at sign in that controls the synchronization of applications at sign out for UE-V. The Synchronize Settings at Logoff task runs the Microsoft.Uev.SyncController.exe file, which is located in the UE-V Agent installation directory.
|
||||
|
||||
|Task name|Default event|
|
||||
|--- |--- |
|
||||
|\Microsoft\UE-V\Synchronize Settings at Logoff|Sign in|
|
||||
|
||||
### Template Auto Update
|
||||
|
||||
The **Template Auto Update** task checks the settings template catalog for new, updated, or removed templates. This task only runs if the SettingsTemplateCatalog is configured. The **Template Auto Update** task runs the ApplySettingsCatalog.exe file, which is located in the UE-V Agent installation directory.
|
||||
|
||||
|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|
|
||||
|
||||
**Example:** The following command configures the UE-V service to check the settings template catalog store every hour.
|
||||
|
||||
```console
|
||||
schtasks /change /tn "Microsoft\UE-V\Template Auto Update" /ri 60
|
||||
```
|
||||
|
||||
## UE-V Scheduled Task Details
|
||||
|
||||
The following chart provides additional information about scheduled tasks for UE-V 2:
|
||||
|
||||
|Task Name (file name)|Default Frequency|Power Toggle|Idle Only|Network Connection|Description|
|
||||
|--- |--- |--- |--- |--- |--- |
|
||||
|**Monitor Application Settings** (UevAppMonitor.exe)|Starts 30 seconds after sign in and continues until sign out.|No|Yes|N/A|Synchronizes settings for Windows (AppX) apps.|
|
||||
|**Sync Controller Application** (Microsoft.Uev.SyncController.exe)|At sign in and every 30 min thereafter.|Yes|Yes|Only if Network is connected|Starts the Sync Controller that synchronizes local settings with the settings storage location.|
|
||||
|**Synchronize Settings at Logoff** (Microsoft.Uev.SyncController.exe)|Runs at sign in and then waits for sign out to Synchronize settings.|No|Yes|N/A|Start an application at sign in that controls the synchronization of applications at sign out.|
|
||||
|**Template Auto Update** (ApplySettingsCatalog.exe)|Runs at initial sign in 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.|
|
||||
|
||||
**Legend**
|
||||
|
||||
- **Power Toggle** - Task Scheduler will optimize power consumption when not connected to AC power. The task might stop running if the computer switches to battery power.
|
||||
- **Idle Only** - The task will stop running if the computer ceases to be idle. By default the task won't restart when the computer is idle again. Instead the task will begin again on the next task trigger.
|
||||
- **Network Connection** - Tasks marked "Yes" only run if the computer has a network connection available. Tasks marked "N/A" run regardless of network connectivity.
|
||||
|
||||
### How to Manage Scheduled Tasks
|
||||
|
||||
To find Scheduled Tasks, perform the following steps:
|
||||
|
||||
1. Open "Schedule Tasks" on the user computer.
|
||||
1. Navigate to: Task Scheduler -> Task Scheduler Library -> Microsoft -> UE-V
|
||||
1. Select the scheduled task you wish to manage and configure in the details pane.
|
||||
|
||||
### Additional information
|
||||
|
||||
The following additional information applies to UE-V scheduled tasks:
|
||||
|
||||
- All task sequence programs are located in the UE-V Agent installation folder, `%programFiles%\Microsoft User Experience Virtualization\Agent\[architecture]\`, by default.
|
||||
- The Sync Controller Application Scheduled task is the crucial component when the UE-V SyncMethod is set to "SyncProvider" (UE-V default configuration). This scheduled task keeps the SettingsSToragePath synchronized with the locally cached versions of the settings package files. If users complain that settings don't synchronize often enough, then you can reduce the scheduled task setting to as little as 1 minute. You can also increase the 30-min default to a higher amount if necessary.
|
||||
- You don't need to disable the Template Auto Update scheduled task if you use another method to keep the clients' templates in sync (that is, Group Policy or Configuration Manager Baselines). Leaving the SettingsTemplateCatalog property value blank prevents UE-V from checking the settings catalog for custom templates. This scheduled task runs ApplySettingsCatalog.exe and will essentially return immediately.
|
||||
- The Monitor Application Settings scheduled task will update Windows app (AppX) settings in real time, based on Windows app program setting triggers built into each app.
|
||||
|
||||
## Related topics
|
||||
|
||||
[Administering UE-V](uev-administering-uev.md)
|
||||
[Deploy UE-V for Custom Applications](uev-deploy-uev-for-custom-applications.md)
|
||||
@ -1,66 +0,0 @@
|
||||
---
|
||||
title: Configuring UE-V with Group Policy Objects
|
||||
description: In this article, learn how to configure User Experience Virtualization (UE-V) with Group Policy objects.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Configuring UE-V with Group Policy Objects
|
||||
|
||||
Some User Experience Virtualization (UE-V) Group Policy settings can be defined for computers, and other Group Policy settings can be defined for users. The Group Policy administrative templates for these settings are included in Windows 10, version 1607.
|
||||
|
||||
The following policy settings can be configured for UE-V.
|
||||
|
||||
### Group Policy settings
|
||||
|
||||
|Group Policy setting name|Target|Group Policy setting description|Configuration options|
|
||||
|--- |--- |--- |--- |
|
||||
|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 service 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 service runs for the first time.|The default is enabled.|
|
||||
|Synchronize Windows settings|Computers and Users|This Group Policy setting configures the synchronization of Windows settings.|Select which Windows settings synchronize between computers.<br>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 service to report when a settings package file size reaches a defined threshold.|Specify the preferred threshold for settings package sizes in kilobytes (KB).<br>By default, the UE-V service 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 service.|Enter a Universal Naming Convention (UNC) path such as \Server\TemplateShare or a folder location on the computer.<br>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 service 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.|This setting only has an effect for UE-V 2.x and earlier. It has no effect for UE-V in Windows 10, version 1607.|
|
||||
|Use User Experience Virtualization (UE-V)|Computers and Users|This Group Policy setting lets you enable or disable User Experience Virtualization (UE-V).|This setting only has an effect for UE-V 2.x and earlier. For UE-V in Windows 10, version 1607, use the **Enable UE-V** setting.|
|
||||
|Enable UE-V|Computers and Users|This policy setting allows you to enable or disable User Experience Virtualization (UE-V) feature. Reboot is needed for enable to take effect.|This setting only has an effect for UE-V in Windows 10, version 1601. For UE-V 2.x and earlier, choose the **Use User Experience Virtualization (UE-V)** setting.|
|
||||
|
||||
>[!NOTE]
|
||||
>In addition, Group Policy settings are available for many desktop applications and Windows apps. You can use these settings to enable or disable settings synchronization for specific applications.
|
||||
|
||||
### Windows App Group Policy settings
|
||||
|
||||
|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 service 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 service for Windows apps that are not explicitly listed in the Windows app list.|By default, the UE-V service only synchronizes settings of those Windows apps that are included in the Windows app list.|
|
||||
|
||||
For more information about synchronizing Windows apps, see [Windows App List](uev-managing-settings-location-templates-using-windows-powershell-and-wmi.md#win8applist).
|
||||
|
||||
**To configure computer-targeted Group Policy settings**
|
||||
|
||||
1. Use the Group Policy Management Console (GPMC) or the Advanced Group Policy Management (AGPM) on the computer that acts as a domain controller to manage Group Policy settings for UE-V computers. Navigate to **Computer configuration**, select **Policies**, select **Administrative Templates**, click **Windows Components**, and then select **Microsoft User Experience Virtualization**
|
||||
1. Select the Group Policy setting to be edited
|
||||
|
||||
**To configure user-targeted Group Policy settings**
|
||||
|
||||
1. Use the Group Policy Management Console (GPMC) or the Advanced Group Policy Management (AGPM) tool in Microsoft Desktop Optimization Pack (MDOP) on the domain controller computer to manage Group Policy settings for UE-V. Navigate to **User configuration**, select **Policies**, select **Administrative Templates**, click **Windows Components**, and then select **Microsoft User Experience Virtualization**
|
||||
1. Select the edited Group Policy setting
|
||||
|
||||
The UE-V service uses the following order of precedence to determine synchronization.
|
||||
|
||||
**Order of precedence for UE-V settings**
|
||||
|
||||
1. User-targeted settings that are managed by Group Policy settings - These configuration settings are stored in the registry key by Group Policy under `HKEY_CURRENT_USER\Software\Policies\Microsoft\Uev\Agent\Configuration`
|
||||
1. Computer-targeted settings that are managed by Group Policy settings - These configuration settings are stored in the registry key by Group Policy under `HKEY_LOCAL_MACHINE\Software\Policies\Microsoft\Uev\Agent\Configuration`
|
||||
1. Configuration settings that are defined by the current user by using Windows PowerShell or Windows management Instrumentation (WMI) - These configuration settings are stored by the UE-V service under this registry location: `HKEY_CURRENT_USER\Software\Microsoft\Uev\Agent\Configuration`
|
||||
1. Configuration settings that are defined for the computer by using Windows PowerShell or WMI. These configuration settings are stored by the UE-V service under this registry location: `HKEY_LOCAL_MACHINE\Software\Microsoft\Uev\Agent\Configuration`
|
||||
|
||||
## Related topics
|
||||
|
||||
[Administering UE-V](uev-administering-uev.md)
|
||||
[Manage Configurations for UE-V](uev-manage-configurations.md)
|
||||
@ -1,152 +0,0 @@
|
||||
---
|
||||
title: Configuring UE-V with Microsoft Configuration Manager
|
||||
description: Learn how to configure User Experience Virtualization (UE-V) with Microsoft Configuration Manager.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Configuring UE-V with Microsoft Configuration Manager
|
||||
|
||||
After you deploy User Experience Virtualization (UE-V) and its required features, you can start to configure it to meet your organization's need. The UE-V Configuration Pack provides a way for administrators to use the Compliance Settings feature of Microsoft Configuration Manager to apply consistent configurations across sites where UE-V and Configuration Manager are installed.
|
||||
|
||||
## UE-V Configuration Pack supported features
|
||||
|
||||
The UE-V Configuration Pack includes tools to:
|
||||
|
||||
- Create or update UE-V settings location template distribution baselines
|
||||
- Define UE-V templates to be registered or unregistered
|
||||
- Update UE-V template configuration items and baselines as templates are added or updated
|
||||
- Distribute and register UE-V templates using standard Configuration Item remediation
|
||||
- Create or update a UE-V Agent policy configuration item to set or clear these settings
|
||||
|
||||
|Configuration|Setting|Description|
|
||||
|--- |--- |--- |
|
||||
|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 sign in|
|
||||
|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|||
|
||||
|
||||
- Verify compliance by confirming that UE-V is running.
|
||||
|
||||
## Generate a UE-V service policy configuration item
|
||||
|
||||
All UE-V service policy and configuration is distributed through a single configuration item that is generated using the UevAgentPolicyGenerator.exe tool. This tool reads the desired configuration from an XML configuration file and creates a CI containing the discovery and remediation settings needed to bring the machine into compliance.
|
||||
|
||||
The UE-V service policy configuration item CAB file is created using the UevTemplateBaselineGenerator.exe command line tool, which has these parameters:
|
||||
|
||||
- Site <site code>
|
||||
- PolicyName <name> Optional: Defaults to "UE-V Agent Policy" if not present
|
||||
- PolicyDescription <description> Optional: A description is provided if not present
|
||||
- CabFilePath <full path to configuration item .CAB file>
|
||||
- ConfigurationFile <full path to agent configuration XML file>
|
||||
|
||||
> [!NOTE]
|
||||
> It might be necessary to change the PowerShell execution policy to allow these scripts to run in your environment. Perform these steps in the Configuration Manager console:
|
||||
|
||||
1. Select **Administration > Client Settings > Properties**
|
||||
1. In the **User Agent** tab, set the **PowerShell Execution Policy** to **Bypass**
|
||||
|
||||
<a href="" id="create"></a>**Create the first UE-V policy configuration item**
|
||||
|
||||
1. Copy the default settings configuration file from the UE-V Config Pack installation directory to a location visible to your ConfigMgr Admin Console:
|
||||
|
||||
```cmd
|
||||
C:\Program Files (x86)\Windows Kits\10\Microsoft User Experience Virtualization\Management\AgentConfiguration.xml
|
||||
```
|
||||
|
||||
The default configuration file contains five sections:
|
||||
|
||||
<a href="" id="computer-policy"></a>**Computer Policy**
|
||||
|
||||
All UE-V machine level settings. The DesiredState attribute can be
|
||||
|
||||
- **Set** to have the value assigned in the registry
|
||||
- **Clear** to remove the setting
|
||||
- **Unmanaged** to have the configuration item left at its current state
|
||||
|
||||
Don't remove lines from this section. Instead, set the DesiredState to `Unmanaged` if you don't want Configuration Manager to alter current or default values.
|
||||
|
||||
<a href="" id="currentcomputeruserpolicy"></a>**CurrentComputerUserPolicy**
|
||||
|
||||
All UE-V user level settings. These entries override the machine settings for a user. The DesiredState attribute can be
|
||||
|
||||
- **Set** to have the value assigned in the registry
|
||||
- **Clear** to remove the setting
|
||||
- **Unmanaged** to have the configuration item left at its current state
|
||||
|
||||
Don't remove lines from this section. Instead, set the DesiredState to 'Unmanaged' if you don't want Configuration Manager to alter current or default values.
|
||||
|
||||
<a href="" id="services"></a>**Services**
|
||||
|
||||
Entries in this section control service operation. The default configuration file contains a single entry for the UevAgentService. The DesiredState attribute can be set to **Running** or **Stopped**.
|
||||
|
||||
<a href="" id="windows8appscomputerpolicy"></a>**Windows8AppsComputerPolicy**
|
||||
|
||||
All machine level Windows app synchronization settings. Each PackageFamilyName listed in this section can be assigned a DesiredState of
|
||||
|
||||
- **Enabled** to have settings roam
|
||||
- **Disabled** to prevent settings from roaming
|
||||
- **Cleared** to have the entry removed from UE-V control
|
||||
|
||||
More lines can be added to this section based on the list of installed Windows apps that can be viewed using the PowerShell cmdlet GetAppxPackage.
|
||||
|
||||
<a href="" id="windows8appscurrentcomputeruserpolicy"></a>**Windows8AppsCurrentComputerUserPolicy**
|
||||
|
||||
Identical to the Windows8AppsComputerPolicy with settings that override machine settings for an individual user.
|
||||
|
||||
1. Edit the configuration file by changing the desired state and value fields.
|
||||
1. Run this command on a machine running the ConfigMgr Admin Console:
|
||||
```cmd
|
||||
C:\Program Files (x86)\Microsoft User Experience Virtualization\ConfigPack\UevAgentPolicyGenerator.exe -Site ABC -CabFilePath "C:\MyCabFiles\UevPolicyItem.cab" -ConfigurationFile "c:\AgentConfiguration.xml"
|
||||
```
|
||||
1. Import the CAB file using ConfigMgr console or PowerShell Import-CMConfigurationItem
|
||||
|
||||
**Update a UE-V Policy Configuration Item**
|
||||
|
||||
1. Edit the configuration file by changing the desired state and value fields.
|
||||
1. Run the command from Step 3 in [Create the First UE-V Policy Configuration Item](#create). If you changed the name with the PolicyName parameter, make sure you enter the same name.
|
||||
1. Reimport the CAB file. The version in ConfigMgr will be updated.
|
||||
|
||||
## <a href="" id="create2"></a>Generate a UE-V Template Baseline
|
||||
|
||||
UE-V templates are distributed using a baseline containing multiple configuration items. Each configuration item contains the discovery and remediation scripts needed to install one UE-V template. The actual UE-V template is embedded within the remediation script for distribution using standard Configuration Item functionality.
|
||||
|
||||
The UE-V template baseline is created using the UevTemplateBaselineGenerator.exe command line tool, which has these parameters:
|
||||
|
||||
- Site <site code>
|
||||
- BaselineName <name> (Optional: defaults to "UE-V Template Distribution Baseline" if not present)
|
||||
- BaselineDescription <description> (Optional: a description is provided if not present)
|
||||
- TemplateFolder <UE-V template folder>
|
||||
- Register <comma separated template file list>
|
||||
- Unregister <comma separated template list>
|
||||
- CabFilePath <Full path to baseline CAB file to generate>
|
||||
|
||||
The result is a baseline CAB file that is ready for import into Configuration Manager. If at a future date, you update or add a template, you can rerun the command using the same baseline name. Importing the CAB results in CI version updates on the changed templates.
|
||||
|
||||
### <a href="" id="create2"></a>Create the First UE-V Template Baseline
|
||||
|
||||
1. Create a "master" set of UE-V templates in a stable folder location visible to the machine running your ConfigMgr Admin Console. As templates are added or updated, this folder is where they're pulled for distribution. The initial list of templates can be copied from a machine with UE-V installed. The default template location is C:\\Program Files\\Microsoft User Experience Virtualization\\Templates.
|
||||
1. Create a text.bat file where you can add the template generator command. This step is optional, but will make regeneration simpler if you save the command parameters
|
||||
1. Add the command and parameters to the .bat file that will generate the baseline. The following example creates a baseline that distributes Notepad and Calculator:
|
||||
```cmd
|
||||
C:\Program Files (x86)\Microsoft User Experience Virtualization\ConfigPack\UevTemplateBaselineGenerator.exe -Site "ABC" -TemplateFolder "C:\ProductionUevTemplates" -Register "MicrosoftNotepad.xml, MicrosoftCalculator.xml" -CabFilePath "C:\MyCabFiles\UevTemplateBaseline.cab"
|
||||
```
|
||||
1. Run the .bat file to create UevTemplateBaseline.cab ready for import into Configuration Manager
|
||||
|
||||
### Update a UE-V Template Baseline
|
||||
|
||||
The template generator uses the template version to determine if a template should be updated. If you make a template change and update the version, the baseline generator compares the template in your master folder with the template contained in the CI on the ConfigMgr server. If a difference is found, the generated baseline and modified CI versions are updated.
|
||||
|
||||
To distribute a new Notepad template, you would perform these steps:
|
||||
|
||||
1. Update the template and template version located in the <Version> element of the template
|
||||
1. Copy the template to your master template directory
|
||||
1. Run the command in the .bat file that you created in Step 3 in [Create the First UE-V Template Baseline](#create2)
|
||||
1. Import the generated CAB file into ConfigMgr using the console or PowerShell Import-CMBaseline
|
||||
|
||||
## Related articles
|
||||
|
||||
[Manage Configurations for UE-V](uev-manage-configurations.md)
|
||||
@ -1,131 +0,0 @@
|
||||
---
|
||||
title: Deploy required UE-V features
|
||||
description: Learn how to install and configure User Experience Virtualization (UE-V) features, for example, a network share that stores and retrieves user settings.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Deploy required UE-V features
|
||||
|
||||
To get up and running with User Experience Virtualization (UE-V), install and configure the following features.
|
||||
|
||||
- [Deploy a settings storage location](#deploy-a-ue-v-settings-storage-location) that is accessible to end users.
|
||||
This feature is a standard network share that stores and retrieves user settings.
|
||||
- [Choose the configuration method for UE-V](#choose-the-configuration-method-for-ue-v)
|
||||
You can deploy and configure UE-V with common management tools including group policy, Configuration Manager, or Windows Management Infrastructure and PowerShell.
|
||||
- [Enable the UE-V service](#enable-the-ue-v-service) on user devices.
|
||||
With Windows 10, version 1607, UE-V is installed automatically. You need to enable the UE-V service on each user device you want to include in your UE-V environment.
|
||||
|
||||
The articles in this section describe how to deploy these features.
|
||||
|
||||
## Deploy a UE-V Settings Storage Location
|
||||
|
||||
UE-V requires a location in which to store user settings in settings package files. You can configure this settings storage location in one of these ways:
|
||||
|
||||
- Create your own settings storage location
|
||||
- Use existing Active Directory for your settings storage location
|
||||
|
||||
> [!NOTE]
|
||||
> As a matter of [performance and capacity planning](uev-prepare-for-deployment.md#performance-and-capacity-planning) and to reduce problems with network latency, create settings storage locations on the same local networks where the users' devices reside. We recommend 20 MB of disk space per user for the settings storage location.
|
||||
|
||||
### Create a UE-V Settings Storage Location
|
||||
|
||||
Before you define the settings storage location, you must create a root directory with read/write permissions for users who store settings on the share. The UE-V service creates user-specific folders under this root directory.
|
||||
|
||||
The settings storage location is defined by setting the SettingsStoragePath configuration option, which you can configure by using one of these methods:
|
||||
|
||||
- Through [Group Policy](uev-configuring-uev-with-group-policy-objects.md) settings
|
||||
- With the [Configuration Manager Pack](uev-configuring-uev-with-system-center-configuration-manager.md) for UE-V
|
||||
- With [Windows PowerShell or Windows Management Instrumentation (WMI)](uev-administering-uev-with-windows-powershell-and-wmi.md)
|
||||
|
||||
The path must be in a universal naming convention (UNC) path of the server and share. For example, **\\Server\Settingsshare\**. This configuration option supports the use of variables to enable specific synchronization scenarios. For example, you can use the %username%\%computername% variables to preserve the end user settings experience in these scenarios:
|
||||
|
||||
- End users that use multiple physical devices in your enterprise
|
||||
- Enterprise computers that are used by multiple end users
|
||||
|
||||
The UE-V service dynamically creates a user-specific settings storage path, with a hidden system folder named **SettingsPackages**, based on the configuration setting of **SettingsStoragePath**. The service reads and writes settings to this location as defined by the registered UE-V settings location templates.
|
||||
|
||||
**UE-V settings are determined by a "Last write wins" rule:** If the settings storage location is the same for a user with multiple managed computers, one UE-V service reads and writes to the settings location independently of services running on other computers. The last written settings and values are the ones applied when the service next reads from the settings storage location.
|
||||
|
||||
**Deploy the settings storage location:** Follow these steps to define the settings storage location rather than using your existing Active Directory agent. You should limit access to the settings storage share to those users that require it, as shown in the tables below.
|
||||
|
||||
**To deploy the UE-V network share**
|
||||
|
||||
1. Create a new security group for UE-V users.
|
||||
1. Create a new folder on the centrally located computer that stores the UE-V settings packages, and then grant UE-V users access with group permissions to the folder. The administrator who supports UE-V must have permissions to this shared folder.
|
||||
1. Set the following share-level Server Message Block (SMB) permissions for the settings storage location folder.
|
||||
|
||||
| **User account** | **Recommended permissions** |
|
||||
|------------------------------|-----------------------------|
|
||||
| Everyone | No permissions |
|
||||
| Security group of UE-V users | Full control |
|
||||
|
||||
1. Set the following NTFS file system permissions for the settings storage location folder.
|
||||
|
||||
| **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 |
|
||||
|
||||
With this configuration, the UE-V service creates and secures a Settingspackage folder while it runs in the context of the user, and grants each user permission to create folders for settings storage. Users receive full control to their Settingspackage folder while other users can't access it.
|
||||
|
||||
> [!NOTE]
|
||||
> If you create the settings storage share on a computer running a Windows Server operating system, configure UE-V to verify that either the local Administrators group or the current user is the owner of the folder where settings packages are stored. To enable this extra security, specify this setting in the Windows Server Registry Editor:
|
||||
>
|
||||
> 1. Add a **REG_DWORD** registry key named **"RepositoryOwnerCheckEnabled"** to **HKEY_LOCAL_MACHINE\Software\Microsoft\UEV\Agent\Configuration**
|
||||
> 1. Set the registry key value to *1*
|
||||
|
||||
### Use Active Directory with UE-V
|
||||
|
||||
The UE-V service uses Active Directory (AD) by default if you don't define a settings storage location. In these cases, the UE-V service dynamically creates the settings storage folder under the root of the AD home directory of each user. However, if a custom directory setting is configured in AD, then that directory is used instead.
|
||||
|
||||
## Choose the Configuration Method for UE-V
|
||||
|
||||
You'll need to decide which configuration method you'll use to manage UE-V after deployment since this configuration method is the one you'll use to deploy the UE-V Agent. Typically, this configuration method is the one that you already use in your environment, such as Windows PowerShell or Configuration Manager.
|
||||
|
||||
You can configure UE-V before, during, or after you enable the UE-V service on user devices, depending on the configuration method that you use.
|
||||
|
||||
- [**Group Policy**](uev-configuring-uev-with-group-policy-objects.md) You can use your existing Group Policy infrastructure to configure UE-V before or after you enable the UE-V service. The UE-V Group Policy ADMX template enables the central management of common UE-V service configuration options and includes settings to configure UE-V synchronization.
|
||||
|
||||
> [!NOTE]
|
||||
> Starting with Windows 10, version 1607, UE-V ADMX templates are installed automatically.
|
||||
|
||||
Group Policy ADMX templates configure the synchronization settings for the UE-V service and enable the central management of common UE-V service configuration settings by using an existing Group Policy infrastructure.
|
||||
Supported operating systems for the domain controller that deploys the Group Policy Objects include:
|
||||
Windows Server 2012 and Windows Server 2012 R2
|
||||
|
||||
- [**Configuration Manager**](uev-configuring-uev-with-system-center-configuration-manager.md) The UE-V Configuration Pack lets you use the Compliance Settings feature of Microsoft Configuration Manager to apply consistent configurations across sites where UE-V and Configuration Manager are installed.
|
||||
- [**Windows PowerShell and WMI**](uev-administering-uev-with-windows-powershell-and-wmi.md) You can use scripted commands for Windows PowerShell and Windows Management Instrumentation (WMI) to modify the configuration of the UE-V service.
|
||||
|
||||
> [!NOTE]
|
||||
> Registry modification can result in data loss, or the computer becomes unresponsive. We recommend that you use other configuration methods.
|
||||
|
||||
## Enable the UE-V service
|
||||
|
||||
The UE-V service is the client-side component that captures user-personalized application and Windows settings and saves them in settings packages. Settings packages are built, locally stored, and copied to the settings storage location.
|
||||
|
||||
Before enabling the UE-V service, you need to register the UE-V templates for first time use. In a PowerShell window, type **register-<TemplateName>** where **TemplateName** is the name of the UE-V template you want to register, and press ENTER.
|
||||
|
||||
> [!NOTE]
|
||||
> With Windows 10, version 1607, you must register UE-V templates for all inbox and custom templates. This provides flexibility for only deploying the required templates.
|
||||
|
||||
With Windows 10, version 1607 and later, the UE-V service is installed on user devices. Enable the service to start using UE-V. You can enable the service with the Group Policy editor or with Windows PowerShell.
|
||||
|
||||
**To enable the UE-V service with Group Policy**
|
||||
|
||||
1. Open the device's **Group Policy Editor**
|
||||
1. Navigate to **Computer Configuration** > **Administrative Templates** > **Windows Components** > **Microsoft** **User Experience Virtualization**
|
||||
1. Run **Enable UEV**
|
||||
1. Restart the device
|
||||
|
||||
**To enable the UE-V service with Windows PowerShell**
|
||||
|
||||
1. In a PowerShell window, type **Enable-UEV** and press ENTER
|
||||
1. Restart the device
|
||||
1. In a PowerShell window, type **Get-UEVStatus** and press ENTER to verify that the UE-V service was successfully enabled
|
||||
|
||||
## Related articles
|
||||
|
||||
[Prepare a UE-V deployment](uev-prepare-for-deployment.md)
|
||||
[Deploy UE-V for use with custom applications](uev-deploy-uev-for-custom-applications.md)
|
||||
[Upgrade to UE-V for Windows 10](uev-upgrade-uev-from-previous-releases.md)
|
||||
@ -1,198 +0,0 @@
|
||||
---
|
||||
title: Use UE-V with custom applications
|
||||
description: Use User Experience Virtualization (UE-V) to create your own custom settings location templates with the UE-V template generator.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Use UE-V with custom applications
|
||||
|
||||
User Experience Virtualization (UE-V) uses XML files called ***settings location templates*** to monitor and synchronize application settings and Windows settings between user devices. By default, some settings location templates are included in UE-V. However, if you want to synchronize settings for desktop applications other than those settings included in the default templates, you can create your own custom settings location templates with the UE-V template generator.
|
||||
|
||||
After you've reviewed [Prepare a UE-V Deployment](uev-prepare-for-deployment.md) and decided that you want to synchronize settings for custom applications (for example, third-party, line-of-business), you'll need to deploy the features of UE-V described in this topic.
|
||||
|
||||
To start, here are the main steps required to synchronize settings for custom applications:
|
||||
|
||||
- [Install the UE-V template generator](#install-the-uev-template-generator)
|
||||
Use the UEV template generator to create custom XML settings location templates.
|
||||
- [Configure a UE-V settings template catalog](#deploy-a-settings-template-catalog)
|
||||
You can define this path where custom settings location templates are stored.
|
||||
- [Create custom settings location templates](#create-custom-settings-location-templates)
|
||||
These custom templates let users sync settings for custom applications.
|
||||
- [Deploy the custom settings location templates](#deploy-the-custom-settings-location-templates)
|
||||
|
||||
After you test the custom template to ensure that settings are synced correctly, you can deploy these templates in one of these ways:
|
||||
|
||||
- With your existing electronic software distribution solution, such as Configuration Manager
|
||||
- With Group Policy preferences
|
||||
- With a UE-V settings template catalog
|
||||
|
||||
> [!NOTE]
|
||||
> Templates that are deployed with electronic software distribution methods or Group Policy must be registered with UE-V Windows Management Instrumentation (WMI) or Windows PowerShell.
|
||||
|
||||
## Prepare to deploy UE-V for custom applications
|
||||
|
||||
Before you start deploying the UE-V features that handle custom applications, review the following important information.
|
||||
|
||||
### The UE-V template generator
|
||||
|
||||
Use the UE-V template generator to monitor, discover, and capture the locations where Win32 applications store settings. The template generator doesn't create settings location templates for the following types of applications:
|
||||
|
||||
- Virtualized applications
|
||||
- Applications that are offered through Terminal Services
|
||||
- Java applications
|
||||
- Windows applications
|
||||
|
||||
> [!NOTE]
|
||||
> UE-V settings location templates can't be created from virtualized applications or Terminal Services applications. However, settings that are synchronized by using the templates can be applied to those applications. To create templates that support Virtual Desktop Infrastructure (VDI) and Terminal Services applications, open a version of the Windows Installer (.msi) package of the application by using the UE-V template generator. For more information about synchronizing settings for virtual applications, see [Using UE-V with virtual applications](uev-using-uev-with-application-virtualization-applications.md).
|
||||
|
||||
**Excluded Locations:** The discovery process excludes locations that commonly store application software files that don't synchronize settings well between user computers or computing environments. By default, these files are excluded:
|
||||
|
||||
- HKEY_CURRENT_USER registry keys and files to which the signed-in user can't write values
|
||||
- HKEY_CURRENT_USER registry keys and files that are associated with the core functionality of the Windows operating system
|
||||
- All registry keys that are located in the HKEY_LOCAL_MACHINE hive
|
||||
- Files that are located in Program Files directories
|
||||
- Files that are located in Users \ [User name] \ AppData \ LocalLow
|
||||
- Windows operating system files that are located in %Systemroot%
|
||||
|
||||
If registry keys and files that are stored in excluded locations are required to synchronize application settings, you can manually add the locations to the settings location template during the template creation process.
|
||||
|
||||
### Replace the default Microsoft templates
|
||||
|
||||
A default group of settings location templates for common Microsoft applications and Windows settings is included with Windows 10, version 1601. If you customize these templates, or create settings location templates to synchronize settings for custom applications, the UE-V service can be configured to use a settings template catalog to store the templates. In this case, you'll need to include the default templates with the custom templates in the settings template catalog.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> After you enable the UE-V service, you'll need to register the settings location templates using the `Register-UevTemplate` cmdlet in Windows PowerShell.
|
||||
|
||||
When you use Group Policy to configure the settings template catalog path, you can choose to replace the default Microsoft templates. If you configure the policy settings to replace the default Microsoft templates, all of the default Microsoft templates that are installed with Windows 10, version 1607 are deleted and only the templates that are located in the settings template catalog are used.
|
||||
|
||||
> [!NOTE]
|
||||
> If there are customized templates in the settings template catalog that use the same ID as the default Microsoft templates, the Microsoft templates are ignored.
|
||||
|
||||
You can replace the default templates by using the UE-V Windows PowerShell features. To replace the default Microsoft template with Windows PowerShell, unregister all of the default Microsoft templates, and then register the customized templates.
|
||||
|
||||
Old settings packages remain in the settings storage location even if you deploy new settings location templates for an application. These packages aren't read by the UE-V service, but neither are they automatically deleted.
|
||||
|
||||
### Install the UEV template generator
|
||||
|
||||
Use the UE-V template generator to create custom settings location templates that you can then distribute to user devices. You can also use the template generator to edit an existing template or validate a template that was created with another XML editor.
|
||||
|
||||
The UE-V template generator is included in the Windows Assessment and Deployment Kit (ADK) for Windows 10.
|
||||
|
||||
Install the UE-V template generator on a computer that you can use to create a custom settings location template. This computer should have the applications installed for which custom settings location templates need to be generated.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> UE-V for Windows 10, version 1607 includes a new template generator. If you are upgrading from an existing UE-V installation, you'll need to use the new generator to create settings location templates. Templates created with previous versions of the UE-V template generator will continue to work.
|
||||
|
||||
To install the UE-V template generator:
|
||||
|
||||
1. Go to [Download the Windows ADK](https://developer.microsoft.com/windows/hardware/windows-assessment-deployment-kit) to access the ADK.
|
||||
1. Select the **Get Windows ADK for Windows 10** button on this page to start the ADK installer. On the window pictured below, select **Microsoft User Experience Virtualization (UE-V) Template Generator** and then select Install.
|
||||
|
||||
<!-- PRESERVING ORIGINAL IMAGE CODING JUST IN CASE
|
||||
<img src="media/image1.png" width="537" height="394" />
|
||||
-->
|
||||
|
||||
|
||||
|
||||
1. To open the generator, select **Microsoft Application Virtualization Generator** from the **Start** menu.
|
||||
1. See [Working with Custom UE-V Templates and the UE-V Template Generator](uev-working-with-custom-templates-and-the-uev-generator.md) for information about how to use the template generator.
|
||||
|
||||
### Deploy a settings template catalog
|
||||
|
||||
The UE-V settings template catalog is a folder path on UE-V computers or a Server Message Block (SMB) network share that stores all the custom settings location templates. The UE-V service checks this location one time each day and updates its synchronization behavior, based on the templates in this folder.
|
||||
|
||||
The UE-V service checks this folder for templates that were added, updated, or removed. It registers new and changed templates and unregisters removed templates. By default, templates are registered and unregistered one time per day at 3:30 A.M. local time by the Task Scheduler and at system startup. To customize the frequency of this scheduled task, see [Changing the frequency of UE-V scheduled tasks](uev-changing-the-frequency-of-scheduled-tasks.md).
|
||||
|
||||
You can configure the settings template catalog path with command-line options, Group Policy, WMI, or Windows PowerShell. Templates stored at the settings template catalog path are automatically registered and unregistered by a scheduled task.
|
||||
|
||||
To configure the settings template catalog for UE-V:
|
||||
|
||||
1. Create a new folder on the computer that stores the UE-V settings template catalog.
|
||||
1. Set the following share-level (SMB) permissions for the settings template catalog folder.
|
||||
|
||||
| **User account** | **Recommended permissions** |
|
||||
|------------------|------------------------------|
|
||||
| Everyone | No Permissions |
|
||||
| Domain Computers | Read Permission Levels |
|
||||
| Administrators | Read/Write Permission Levels |
|
||||
|
||||
1. Set the following NTFS file system permissions for the settings template catalog folder.
|
||||
|
||||
| **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 |
|
||||
|
||||
1. Click **OK** to close the dialog boxes.
|
||||
|
||||
At a minimum, the network share must grant permissions for the Domain Computers group. In addition, grant access permissions for the network share folder to administrators who are to manage the stored templates.
|
||||
|
||||
### Create custom settings location templates
|
||||
|
||||
Use the UE-V template generator to create settings location templates for line-of-business applications or other custom applications. After you create the template for an application, deploy it to computers to synchronize settings for that application.
|
||||
|
||||
To create a UE-V settings location template with the UE-V template generator:
|
||||
|
||||
1. Click **Start** > **All Programs** > **Microsoft User Experience Virtualization** > **Microsoft User Experience Virtualization template generator**.
|
||||
1. Click **Create a settings location template**.
|
||||
1. Specify the application. Browse to the file path of the application (.exe) or the application shortcut (.lnk) for which you want to create a settings location template. Specify the command-line arguments, if any, and working directory, if any.
|
||||
1. Click **Next** to continue.
|
||||
|
||||
>**Note** Before the application is started, the system displays a prompt for **User Account Control**. Permission is required to monitor the registry and file locations that the application uses to store settings.
|
||||
|
||||
1. After the application starts, close the application. The UE-V template generator records the locations where the application stores its settings.
|
||||
1. After the process is completed, click **Next** to continue.
|
||||
|
||||
1. Review and select the appropriate registry settings locations and settings file locations to synchronize for this application. The list includes the following two categories for settings locations:
|
||||
|
||||
- **Standard**: Application settings that are stored in the registry under the HKEY_CURRENT_USER keys or in the file folders under \ **Users** \ [User name] \ **AppData** \ **Roaming**. The UE-V template generator includes these settings by default.
|
||||
- **Nonstandard**: Application settings that are stored outside the locations are specified in the best practices for settings data storage (optional). These include files and folders under **Users** \ [User name] \ **AppData** \ **Local**. Review these locations to determine whether to include them in the settings location template. Select the locations check boxes to include them.
|
||||
|
||||
1. Click **Next** to continue.
|
||||
1. Review and edit any **Properties**, **Registry** locations, and **Files** locations for the settings location template.
|
||||
|
||||
- Edit the following properties on the **Properties** tab:
|
||||
|
||||
- **Application Name**: The application name that is written in the description of the program files properties.
|
||||
- **Program name**: The name of the program that is taken from the program file properties. This name usually has the .exe file name extension.
|
||||
- **Product version**: The product version number of the .exe file of the application. This property, in conjunction with the **File version**, helps determine which applications are targeted by the settings location template. This property accepts a major version number. If this property is empty, the settings location template applies to all versions of the product.
|
||||
- **File version**: The file version number of the .exe file of the application. This property, in conjunction with the **Product version**, helps determine which applications are targeted by the settings location template. This property accepts a major version number. If this property is empty, the settings location template applies to all versions of the program.
|
||||
- **template author name** (optional): The name of the settings location template author.
|
||||
- **template author email** (optional): The email address of the settings location template author.
|
||||
- The **Registry** tab lists the **Key** and **Scope** of the registry locations that are included in the settings location template. Edit the registry locations by using the **Tasks** drop-down menu. Tasks enable you to add new keys, edit the name or scope of existing keys, delete keys, and browse the registry where the keys are located. Use the **All Settings** scope to include all the registry settings under the specified key. Use the **All Settings and Subkeys** to include all the registry settings under the specified key, subkeys, and subkey settings.
|
||||
- The **Files** tab lists the file path and file mask of the file locations that are included in the settings location template. Edit the file locations by use of the **Tasks** drop-down menu. Tasks for file locations enable you to add new files or folder locations, edit the scope of existing files or folders, delete files or folders, and open the selected location in Windows Explorer. Leave the file mask empty to include all files in the specified folder.
|
||||
1. Click **Create**, and then click **Save** to save the settings location template on the computer.
|
||||
1. Click **Close** to close the settings template wizard. Exit the UE-V template generator application.
|
||||
1. After you've created the settings location template for an application, test the template. Deploy the template in a lab environment before you put it into production in the enterprise.
|
||||
|
||||
See [Application template schema reference for UE-V](uev-application-template-schema-reference.md) for details about the XML structure of the UE-V settings location template and for guidance about editing these files.
|
||||
|
||||
### Deploy the Custom Settings Location templates
|
||||
|
||||
After you create a settings location template with the UE-V template generator, you should test it to ensure that the application settings are synchronized correctly. You can then safely deploy the settings location template to user devices in the enterprise.
|
||||
|
||||
You can deploy settings location templates using of these methods:
|
||||
|
||||
- An electronic software distribution (ESD) system such as Microsoft Configuration Manager
|
||||
- Group Policy preferences
|
||||
- A UE-V settings template catalog
|
||||
|
||||
Templates that are deployed by using an ESD system or Group Policy objects must be registered using UE-V Windows Management Instrumentation (WMI) or Windows PowerShell. Templates that are stored in the settings template catalog location are automatically registered by the UE-V service.
|
||||
|
||||
To deploy UE-V settings location templates with a settings template catalog path:
|
||||
|
||||
1. Browse to the network share folder that you defined as the settings template catalog.
|
||||
1. Add, remove, or update settings location templates in the settings template catalog to reflect the UE-V service template configuration that you want for UE-V computers.
|
||||
> [!NOTE]
|
||||
> Templates on computers are updated daily. The update is based on changes to the settings template catalog.
|
||||
1. To manually update templates on a computer that runs the UE-V service, open an elevated command prompt, and browse to **Program Files\Microsoft User Experience Virtualization \ Agent \ <x86 or x64 >**, and then run **ApplySettingstemplateCatalog.exe**.
|
||||
> [!NOTE]
|
||||
> This program runs automatically during computer startup and daily at 3:30 A. M. to gather any new templates that were recently added to the catalog.
|
||||
|
||||
## Related topics
|
||||
|
||||
- [Prepare a UE-V Deployment](uev-prepare-for-deployment.md)
|
||||
- [Deploy Required UE-V Features](uev-deploy-required-features.md)
|
||||
@ -1,78 +0,0 @@
|
||||
---
|
||||
title: User Experience Virtualization for Windows 10, version 1607
|
||||
description: Overview of User Experience Virtualization for Windows 10, version 1607
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# User Experience Virtualization (UE-V) for Windows 10 overview
|
||||
|
||||
Many users customize their settings for Windows and for specific applications. Customizable Windows settings include Microsoft Store appearance, language, background picture, font size, and accent colors. Customizable application settings include language, appearance, behavior, and user interface options.
|
||||
|
||||
With User Experience Virtualization (UE-V), you can capture user-customized Windows and application settings and store them on a centrally managed network file share. When users log on, their personalized settings are applied to their work session, regardless of which device or virtual desktop infrastructure (VDI) sessions they log on to.
|
||||
|
||||
**With UE-V you can…**
|
||||
|
||||
- Specify which application and Windows settings synchronize across user devices
|
||||
- Deliver the settings anytime and anywhere users work throughout the enterprise
|
||||
- Create custom templates for your third-party or line-of-business applications
|
||||
- Recover settings after hardware replacement or upgrade, or after re-imaging a virtual machine to its initial state
|
||||
|
||||
With the release of Windows 10, version 1607, UE-V is included with the Windows 10 for Enterprise edition. If you are new to Windows 10 and UE-V or upgrading from a previous version of UE-V, you'll need to download, activate, and install server- and client-side components to start synchronizing user-customized settings across devices.
|
||||
|
||||
## Components of UE-V
|
||||
|
||||
The diagram below illustrates how UE-V components work together to synchronize user settings.
|
||||
|
||||
<img src="images/uev-archdiagram.png" alt="UE-V architecture, with server share, desktop, and UE-V service" width="625" height="351" />
|
||||
|
||||
<!-- SIMPLER METHOD FOR CODING IMAGE
|
||||
|
||||
-->
|
||||
|
||||
| **Component** | **Function** |
|
||||
|--|--|
|
||||
| **UE-V service** | Enabled on every device that needs to synchronize settings, the **UE-V service** monitors registered applications and Windows for any settings changes, then synchronizes those settings between devices. |
|
||||
| **Settings packages** | Application settings and Windows settings are stored in **settings packages** created by the UE-V service. Settings packages are built, locally stored, and copied to the settings storage location.<br>The setting values for **desktop applications** are stored when the user closes the application.<br>Values for **Windows settings** are stored when the user logs off, when the computer is locked, or when the user disconnects remotely from a computer.<br>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 service 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](#manage-settings-synchronization-for-custom-applications).<br>**Note** Settings location templates are not required for Windows applications. |
|
||||
| **Universal Windows applications list** | Settings for Windows applications are captured and applied dynamically. The app developer specifies the settings that are synchronized for each app. UE-V determines which Windows applications are enabled for settings synchronization using a managed list of applications. By default, this list includes most Windows applications.<br>You can add or remove applications in the Windows app list by following the procedures in [Managing UE-V Settings Location Templates Using Windows PowerShell and WMI](uev-managing-settings-location-templates-using-windows-powershell-and-wmi.md). |
|
||||
|
||||
## Manage settings synchronization for custom applications
|
||||
|
||||
Use these UE-V components to create and manage custom templates for your third-party or line-of-business applications.
|
||||
|
||||
| Component | Description |
|
||||
|--|--|
|
||||
| **UE-V template generator** | Use the **UE-V template generator** to create custom settings location templates that you can then distribute to user computers. The UE-V template generator also lets you edit an existing template or validate a template that was created with a different XML editor. <br>With the Windows 10, version 1607 release, the UE-V template generator is installed with the [Windows Assessment and Deployment kit for Windows 10, version 1607](https://developer.microsoft.com/windows/hardware/windows-assessment-deployment-kit) (Windows ADK). <br>If you are upgrading from an existing UE-V installation, you'll need to use the new generator to create new settings location templates. Application templates created with previous versions of the UE-V template generator are still supported, however. |
|
||||
| **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 service checks this location once a day, retrieves new or updated templates, and updates its synchronization behavior.<br>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 [Deploy a UE-V settings template catalog](uev-deploy-uev-for-custom-applications.md). |
|
||||
|
||||
<!-- PRESERVING ORIGINAL IMAGE CODING JUST IN CASE - NOTE THAT UPDATED IMAGE IS A PNG FILE
|
||||
<img src="media/image2.gif" width="595" height="330" />
|
||||
-->
|
||||
|
||||
|
||||
|
||||
## Settings synchronized by default
|
||||
|
||||
UE-V synchronizes settings for these applications by default. For a complete list and more detailed information, see [Settings that are automatically synchronized in a UE-V deployment](uev-prepare-for-deployment.md).
|
||||
|
||||
- Microsoft Office 2016, 2013, and 2010
|
||||
- Internet Explorer 11 and 10
|
||||
- Many Windows applications, such as Xbox
|
||||
- Many Windows desktop applications, such as Notepad
|
||||
- Many Windows settings, such as desktop background or wallpaper
|
||||
|
||||
> [!NOTE]
|
||||
> You can also [customize UE-V to synchronize settings](uev-deploy-uev-for-custom-applications.md) for applications other than those synchronized by default.
|
||||
|
||||
## Other resources for this feature
|
||||
|
||||
- [Get Started with UE-V for Windows 10](uev-getting-started.md)
|
||||
- [UE-V for Windows 10 Release Notes](uev-release-notes-1607.md)
|
||||
- [Prepare to deploy UE-V for Windows 10](uev-prepare-for-deployment.md)
|
||||
- [Upgrade to UE-V for Windows 10](uev-upgrade-uev-from-previous-releases.md)
|
||||
- [Administer UE-V for Windows 10](uev-administering-uev.md)
|
||||
- [Technical Reference for UE-V for Windows 10](uev-technical-reference.md)
|
||||
|
||||
For UE-V issues, use the [UE-V TechNet Forum](https://social.technet.microsoft.com/Forums/home?forum=mdopuev&filter=alltypes&sort=lastpostdesc).
|
||||
@ -1,132 +0,0 @@
|
||||
---
|
||||
title: Get Started with UE-V
|
||||
description: Use the steps in this article to deploy User Experience Virtualization (UE-V) for the first time in a test environment.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Get Started with UE-V
|
||||
|
||||
>[!NOTE]
|
||||
>This documentation is for the most recent version of UE-V. If you're looking for information about UE-V 2.x, which was included in the Microsoft Desktop Optimization Pack (MDOP), see [Get Started with UE-V 2.x](/microsoft-desktop-optimization-pack/uev-v2/get-started-with-ue-v-2x-new-uevv2).
|
||||
|
||||
Follow the steps in this topic to deploy User Experience Virtualization (UE-V) for the first time in a test environment. Evaluate UE-V to determine whether it's the right solution to manage user settings across multiple devices within your enterprise.
|
||||
|
||||
>[!NOTE]
|
||||
>The information in this section is explained in greater detail throughout the rest of the documentation. If you've already determined that UE-V is the right solution and you don't need to further evaluate it, see [Prepare a UE-V deployment](uev-prepare-for-deployment.md).
|
||||
|
||||
The standard installation of UE-V synchronizes the default Microsoft Windows and Office settings and many Windows applications settings. For best results, ensure that your test environment includes two or more user computers that share network access.
|
||||
|
||||
- [Step 1: Confirm prerequisites](#step-1-confirm-prerequisites). Review the supported configurations in this section to verify that your environment is able to run UE-V.
|
||||
- [Step 2: Deploy the settings storage location](#step-2-deploy-the-settings-storage-location). Explains how to deploy a settings storage location. All UE-V deployments require a location to store settings packages that contain the synchronized setting values.
|
||||
- [Step 3: Enable and configure the UE-V service](#step-3-enable-and-configure-the-ue-v-service-on-user-devices). Explains how to enable to UE-V service on user devices and configure the storage path. To synchronize settings using UE-V, devices must have the UE-V service enabled and running.
|
||||
- [Step 4: Test Your UE-V evaluation deployment](#step-4-test-your-ue-v-evaluation-deployment). Run a few tests on two computers with the UE-V service enabled to see how UE-V works and if it meets your organization's needs.
|
||||
- Step 5: Deploy UE-V for custom applications (optional). If you want to evaluate how your third-party and line-of-business applications work with UE-V, follow the steps in [Use UE-V with custom applications](uev-deploy-uev-for-custom-applications.md). Following this link takes you to another topic. Use your browser's **Back** button to return to this topic.
|
||||
|
||||
## Step 1: Confirm prerequisites
|
||||
|
||||
Before you proceed, ensure that your environment meets the following requirements for running UE-V.
|
||||
|
||||
| **Operating system** | **Edition** | **Service pack** | **System architecture** | **Windows PowerShell** | **Microsoft .NET Framework** |
|
||||
|--|--|--|--|--|--|
|
||||
| Windows 10, version 1607 | Windows 10 Enterprise | NA | 32-bit or 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 |
|
||||
|
||||
## Step 2: Deploy the settings storage location
|
||||
|
||||
You'll need to deploy a settings storage location, a standard network share where user settings are stored in a settings package file. When you create the settings storage share, you should limit access to users that require it. For more information, see [Deploy a UE-V Settings Storage Location](uev-deploy-required-features.md#deploy-a-ue-v-settings-storage-location).
|
||||
|
||||
**Create a network share**
|
||||
|
||||
1. Create a new security group and add UE-V users to the group.
|
||||
1. Create a new folder on the centrally located computer that stores the UE-V settings packages, and then grant the UE-V users access with group permissions to the folder. The administrator who supports UE-V must have permissions to this shared folder.
|
||||
1. Assign UE-V users permission to create a directory when they connect. Grant full permission to all subdirectories of that directory, but block access to anything above.
|
||||
1. Set the following share-level Server Message Block (SMB) permissions for the settings storage location folder.
|
||||
|
||||
| **User account** | **Recommended permissions** |
|
||||
|--|--|
|
||||
| Everyone | No permissions |
|
||||
| Security group of UE-V users | Full control |
|
||||
|
||||
1. Set the following NTFS file system permissions for the settings storage location folder.
|
||||
|
||||
| **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 |
|
||||
|
||||
**Security Note** If you create the settings storage share on a computer running a Windows Server operating system, configure UE-V to verify that either the local Administrators group or the current user is the owner of the folder where settings packages are stored. To enable this additional security, specify this setting in the Windows Server Registry Editor:
|
||||
|
||||
1. Add a **REG\_DWORD** registry key named **"RepositoryOwnerCheckEnabled"** to **HKEY\_LOCAL\_MACHINE\\Software\\Microsoft\\UEV\\Agent\\Configuration**.
|
||||
1. Set the registry key value to *1*.
|
||||
|
||||
## Step 3: Enable and configure the UE-V service on user devices
|
||||
|
||||
For evaluation purposes, enable the service on at least two devices that belong to the same user in your test environment.
|
||||
|
||||
The UE-V service is the client-side component that captures user-personalized application and Windows settings and saves them in settings packages. Settings packages are built, locally stored, and copied to the settings storage location.
|
||||
|
||||
Before enabling the UE-V service, you'll need to register the UE-V templates for first use. In a PowerShell window, type `Register-UevTemplate [TemplateName]` where **TemplateName** is the name of the UE-V template you want to register, and press ENTER. For instance, to register all built-in UE-V templates, use the following PowerShell Command:
|
||||
`Get-childItem c:\programdata\Microsoft\UEV\InboxTemplates\*.xml|% {Register-UevTemplate $_.Fullname}`
|
||||
|
||||
A storage path must be configured on the client-side to tell where the personalized settings are stored.
|
||||
|
||||
**To set the storage path for UE-V with Group Policy**
|
||||
|
||||
1. Open the device's **Group Policy Editor**.
|
||||
1. Navigate to **Computer Configuration** > **Administrative Templates** > **Windows Components** > **Microsoft** **User Experience Virtualization**.
|
||||
1. Double click **Settings storage path**.
|
||||
1. Select **Enabled**, fill in the **Settings storage path**, and click **OK**.
|
||||
|
||||
- Ensure that the storage path ends with **%username%** to ensure that each user gets a unique folder.
|
||||
|
||||
**To set the storage path for UE-V with PowerShell**
|
||||
|
||||
1. In a PowerShell window, type **Set-uevConfiguration -SettingsStoragePath [StoragePath]** where **[StoragePath]** is the path to the location created in step 2 followed by **\%username%**.
|
||||
|
||||
- Ensure that the storage path ends with **%username%** to ensure that each user gets a unique folder.
|
||||
|
||||
With Windows 10, version 1607 and later, the UE-V service is installed on user devices when the operating system is installed. Enable the service to start using UE-V. You can enable the service with the Group Policy editor or with Windows PowerShell.
|
||||
|
||||
**To enable the UE-V service with Group Policy**
|
||||
|
||||
1. Open the device's **Group Policy Editor**.
|
||||
1. Navigate to **Computer Configuration** > **Administrative Templates** > **Windows Components** > **Microsoft** **User Experience Virtualization**.
|
||||
1. Double click **Use User Experience Virtualization (UE-V)**.
|
||||
1. Select **Enabled** and click **OK**.
|
||||
1. Restart the device.
|
||||
|
||||
**To enable the UE-V service with Windows PowerShell**
|
||||
|
||||
1. In a PowerShell window, type **Enable-UEV** and press ENTER.
|
||||
1. Restart the device.
|
||||
1. In a PowerShell window, type **Get-UEVStatus** and press ENTER to verify that the UE-V service was successfully enabled.
|
||||
|
||||
## Step 4: Test your UE-V evaluation deployment
|
||||
|
||||
You're ready to run a few tests on your UE-V evaluation deployment to see how UE-V works.
|
||||
|
||||
1. On the first device (Computer A), make one or more of these changes:
|
||||
- Open Windows Desktop and move the taskbar to a different location in the window.
|
||||
- Change the default fonts.
|
||||
- Open Notepad and set format -> word wrap **on**.
|
||||
- Change the behavior of any Windows application, as detailed in [Managing UE-V settings location templates using Windows PowerShell and WMI](uev-managing-settings-location-templates-using-windows-powershell-and-wmi.md).
|
||||
|
||||
- Disable Microsoft Account settings synchronization and roaming profiles.
|
||||
|
||||
1. Log off Computer A. Settings are saved in a UE-V settings package when users lock, logoff, exit an application, or when the sync provider runs (every 30 minutes by default).
|
||||
1. Log in to the second device (Computer B) as the same user as Computer A.
|
||||
1. Open Windows Desktop and verify that the taskbar location matches that of Computer A. Verify that the default fonts match and that NotePad is set to **word wrap on**. Also verify the change you made to any Windows applications.
|
||||
1. You can change the settings in Computer B back to the original Computer A settings. Then log off Computer B and log in to Computer A to verify the changes.
|
||||
|
||||
For UE-V issues, use the [UE-V TechNet Forum](https://social.technet.microsoft.com/Forums/home?forum=mdopuev&filter=alltypes&sort=lastpostdesc).
|
||||
|
||||
## Other resources for this feature
|
||||
|
||||
- [User Experience Virtualization overview](uev-for-windows.md)
|
||||
- [Prepare a UE-V Deployment](uev-prepare-for-deployment.md)
|
||||
- [Upgrade to UE-V for Windows 10](uev-upgrade-uev-from-previous-releases.md)
|
||||
- [Administering UE-V](uev-administering-uev.md)
|
||||
- [Troubleshooting UE-V](uev-troubleshooting.md)
|
||||
- [Technical Reference for UE-V](uev-technical-reference.md)
|
||||
@ -1,111 +0,0 @@
|
||||
---
|
||||
title: Manage Administrative Backup and Restore in UE-V
|
||||
description: Learn how an administrator of User Experience Virtualization (UE-V) can back up and restore application and Windows settings to their original state.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Manage Administrative Backup and Restore in UE-V
|
||||
|
||||
As an administrator of User Experience Virtualization (UE-V), you can restore application and Windows settings to their original state. You can also restore more settings when a user adopts a new device.
|
||||
|
||||
## Restore Settings in UE-V when a User Adopts a New Device
|
||||
|
||||
To restore settings when a user adopts a new device, you can put a settings location template in a **backup** or **roam (default)** profile using the Set-UevTemplateProfile PowerShell cmdlet. This setup lets computer settings sync to the new computer, in addition to user settings. Templates assigned to the backup profile are backed up for that device and configured on a per-device basis. To back up settings for a template, use the following cmdlet in Windows PowerShell:
|
||||
|
||||
```powershell
|
||||
Set-UevTemplateProfile -ID <TemplateID> -Profile <backup>
|
||||
```
|
||||
|
||||
- <TemplateID> is the UE-V Template ID
|
||||
- <backup> can either be Backup or Roaming
|
||||
|
||||
When a user's device is being replaced, UE-V automatically restores settings if the user's domain, username, and device name all match. All synchronized and any backup data is restored on the device automatically.
|
||||
|
||||
You can also use the Windows PowerShell cmdlet, Restore-UevBackup, to restore settings from a different device. To clone the settings packages for the new device, use the following cmdlet in Windows PowerShell:
|
||||
|
||||
```powershell
|
||||
Restore-UevBackup -ComputerName <Computer name>
|
||||
```
|
||||
|
||||
where <ComputerName> is the computer name of the device.
|
||||
|
||||
Templates such as the Office 2013 template that include many applications can either all be included in the roamed (default) or backed up profile. Individual apps in a template suite follow the group. Office 2013 in-box templates include both roaming and backup-only settings. Backup-only settings can't be included in a roaming profile.
|
||||
|
||||
As part of the Backup/Restore feature, UE-V added **last known good (LKG)** to the options for rolling back to settings. In this release, you can roll back to either the original settings or LKG settings. The LKG settings let users roll back to an intermediate and stable point ahead of the pre-UE-V state of the settings.
|
||||
|
||||
### How to Backup/Restore Templates with UE-V
|
||||
|
||||
Here are the key backup and restore components of UE-V:
|
||||
|
||||
- Template profiles
|
||||
- Settings packages location within the Settings Storage Location template
|
||||
- Backup trigger
|
||||
- How settings are restored
|
||||
|
||||
**Template Profiles**
|
||||
|
||||
A UE-V template profile is defined when the template is registered on the device or post registration through the PowerShell/WMI configuration utility. The profile types include:
|
||||
|
||||
- Roaming (default)
|
||||
- Backup
|
||||
- BackupOnly
|
||||
|
||||
All templates are included in the roaming profile when registered unless otherwise specified. These templates synchronize settings to all UE-V enabled devices with the corresponding template enabled.
|
||||
|
||||
Templates can be added to the Backup Profile with PowerShell or WMI using the Set-UevTemplateProfile cmdlet. Templates in the Backup Profile back up these settings to the Settings Storage Location in a special Device name directory. Specified settings are backed up to this location.
|
||||
|
||||
Templates designated BackupOnly include settings specific to that device that shouldn't be synchronized unless explicitly restored. These settings are stored in the same device-specific settings package location on the settings storage location as the Backedup Settings. These templates have a special identifier embedded in the template that specifies they should be part of this profile.
|
||||
|
||||
**Settings packages location within the Settings Storage Location template**
|
||||
|
||||
Roaming Profile settings are stored on the settings storage location. Templates assigned to the Backup or the BackupOnly profile store their settings to the Settings Storage Location in a special Device name directory. Each device with templates in these profiles has its own device name. UE-V doesn't clean up these directories.
|
||||
|
||||
**Backup trigger**
|
||||
|
||||
Backup is triggered by the same events that trigger a UE-V synchronization.
|
||||
|
||||
**How settings are restored**
|
||||
|
||||
Restoring a user's device restores the currently registered Template's settings from another device's backup folder and all synchronized settings to the current machine. Settings are restored in these two ways:
|
||||
|
||||
- **Automatic restore**
|
||||
|
||||
If the user's UE-V settings storage path, domain, and Computer name match the current user then all of the settings for that user are synchronized, with only the latest settings applied. If a user signs in to a new device for the first time and these criteria are met, the settings data is applied to that device.
|
||||
|
||||
> [!NOTE]
|
||||
> Accessibility and Windows Desktop settings require the user to sign in again to Windows to be applied.
|
||||
|
||||
- **Manual Restore**
|
||||
|
||||
If you want to assist users by restoring a device during a refresh, you can choose to use the Restore-UevBackup cmdlet. This command ensures that the user's current settings become the current state on the Settings Storage Location.
|
||||
|
||||
## Restore Application and Windows Settings to Original State
|
||||
|
||||
WMI and Windows PowerShell commands let you restore application and Windows settings to the settings values that were on the computer the first time that the application started after the UE-V service was enabled. This restoring action is performed on a per-application or Windows settings basis. The settings are restored the next time that the application runs, or the settings are restored when the user signs in to the operating system.
|
||||
|
||||
**To restore application settings and Windows settings with Windows PowerShell for UE-V**
|
||||
|
||||
1. Open the Windows PowerShell window.
|
||||
1. Enter the following Windows PowerShell cmdlet to restore the application settings and Windows settings.
|
||||
|
||||
|**Windows PowerShell cmdlet**|**Description**|
|
||||
|--- |--- |
|
||||
|`Restore-UevUserSetting -<TemplateID>` |Restores the user settings for an application or restores a group of Windows settings.|
|
||||
|
||||
**To restore application settings and Windows settings with WMI**
|
||||
|
||||
1. Open a Windows PowerShell window.
|
||||
1. Enter the following WMI command to restore application settings and Windows settings.
|
||||
|
||||
|**WMI command**|**Description**|
|
||||
|--- |--- |
|
||||
|`Invoke-WmiMethod -Namespace root\Microsoft\UEV -Class UserSettings -Name RestoreByTemplateId -ArgumentList <template_ID>`|Restores the user settings for an application or restores a group of Windows settings.|
|
||||
|
||||
>[!NOTE]
|
||||
>UE-V doesn't provide a settings rollback for Windows apps.
|
||||
|
||||
## Related topics
|
||||
|
||||
[Administering UE-V with Windows PowerShell and WMI](uev-administering-uev-with-windows-powershell-and-wmi.md)
|
||||
[Administering UE-V](uev-administering-uev.md)
|
||||
@ -1,48 +0,0 @@
|
||||
---
|
||||
title: Manage Configurations for UE-V
|
||||
description: Learn to manage the configuration of the User Experience Virtualization (UE-V) service and also learn to manage storage locations for UE-V resources.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Manage Configurations for UE-V
|
||||
|
||||
In the course of the User Experience Virtualization (UE-V) lifecycle, you have to manage the configuration of the UE-V service and also manage storage locations for resources such as settings package files. The following topics provide guidance for managing these UE-V resources.
|
||||
|
||||
## Configuring UE-V by using Group Policy Objects
|
||||
|
||||
You can use Group Policy Objects to modify the settings that define how UE-V synchronizes settings on computers.
|
||||
|
||||
[Configuring UE-V with Group Policy Objects](uev-configuring-uev-with-group-policy-objects.md)
|
||||
|
||||
## Configuring UE-V with Microsoft Configuration Manager
|
||||
|
||||
You can use Microsoft Endpoint Configuration Manager to manage the UE-V service by using the UE-V Configuration Pack.
|
||||
|
||||
[Configuring UE-V with Microsoft Configuration Manager](uev-configuring-uev-with-system-center-configuration-manager.md)
|
||||
|
||||
## Administering UE-V with PowerShell and WMI
|
||||
|
||||
UE-V provides Windows PowerShell cmdlets, which can help administrators perform various UE-V tasks.
|
||||
|
||||
[Administering UE-V with Windows PowerShell and WMI](uev-administering-uev-with-windows-powershell-and-wmi.md)
|
||||
|
||||
## Examples of configuration settings for UE-V
|
||||
|
||||
Here are some examples of UE-V configuration settings:
|
||||
|
||||
- **Settings Storage Path:** Specifies the location of the file share that stores the UE-V settings.
|
||||
- **Settings Template Catalog Path:** Specifies the Universal Naming Convention (UNC) path that defines the location that was checked for new settings location templates.
|
||||
- **Register Microsoft Templates:** Specifies whether the default Microsoft templates should be registered during installation.
|
||||
- **Synchronization Method:** Specifies whether UE-V uses the sync provider or "none". The "SyncProvider" supports computers that are disconnected from the network. "None" applies when the computer is always connected to the network. For more information about the Sync Method, see [Sync Methods for UE-V](uev-sync-methods.md).
|
||||
- **Synchronization Timeout:** Specifies the number of milliseconds that the computer waits before time-out when it retrieves the user settings from the settings storage location.
|
||||
- **Synchronization Enable:** Specifies whether the UE-V settings synchronization is enabled or disabled.
|
||||
- **Maximum Package Size:** Specifies a settings package file threshold size in bytes at which the UE-V service reports a warning.
|
||||
- **Don't Sync Windows App Settings:** Specifies that UE-V should not synchronize Windows apps.
|
||||
- **Enable/Disable First Use Notification:** Specifies whether UE-V displays a dialog box the first time that the UE-V service runs on a user's computer.
|
||||
|
||||
## Related topics
|
||||
|
||||
[Administering UE-V](uev-administering-uev.md)
|
||||
[Deploy Required UE-V Features](uev-deploy-required-features.md)
|
||||
[Use UE-V with custom applications](uev-deploy-uev-for-custom-applications.md)
|
||||
@ -1,178 +0,0 @@
|
||||
---
|
||||
title: Managing UE-V Settings Location Templates Using Windows PowerShell and WMI
|
||||
description: Managing UE-V Settings Location Templates Using Windows PowerShell and WMI
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Managing UE-V Settings Location Templates Using Windows PowerShell and WMI
|
||||
|
||||
User Experience Virtualization (UE-V) uses XML settings location templates to define the settings that User Experience Virtualization captures and applies. UE-V includes a set of standard settings location templates. It also includes the UE-V template generator tool that enables you to create custom settings location templates. After you create and deploy settings location templates, you can manage those templates by using Windows PowerShell and the Windows Management Instrumentation (WMI).
|
||||
|
||||
> [!NOTE]
|
||||
> For a complete list of UE-V cmdlets, see [User Experience Virtualization in Windows PowerShell](/powershell/module/uev/).
|
||||
|
||||
## Manage UE-V settings location templates by using Windows PowerShell
|
||||
|
||||
The WMI and Windows PowerShell features of UE-V include the ability to enable, disable, register, update, and unregister settings location templates. By using these features, you can automate the process of registering, updating, or unregistering templates with the UE-V service. You can also manually register templates by using WMI and Windows PowerShell commands. By using these features in conjunction with an electronic software distribution solution, Group Policy, or another automated deployment method such as a script, you can further automate that process.
|
||||
|
||||
You must have administrator permissions to update, register, or unregister a settings location template. Administrator permissions are not required to enable, disable, or list templates.
|
||||
|
||||
**To manage settings location templates by using Windows PowerShell**
|
||||
|
||||
1. Use an account with administrator rights to open a Windows PowerShell command prompt.
|
||||
1. Use the following Windows PowerShell cmdlets to register and manage the UE-V settings location templates.
|
||||
|
||||
|Windows PowerShell command|Description|
|
||||
|--- |--- |
|
||||
|`Get-UevTemplate`|Lists all the settings location templates that are registered on the computer.|
|
||||
|`Get-UevTemplate -Application <string>`|Lists all the settings location templates that are registered on the computer where the application name or template name contains.|
|
||||
|`Get-UevTemplate -TemplateID <string>`|Lists all the settings location templates that are registered on the computer where the template ID contains.|
|
||||
|`Get-UevTemplate [-ApplicationOrTemplateID] <string>`|Lists all the settings location templates that are registered on the computer where the application or template name, or template ID contains.|
|
||||
|`Get-UevTemplateProgram [-ID] <template ID>`|Gets the name of the program and version information, which depend on the template ID.|
|
||||
|`Get-UevAppXPackage`|Gets the effective list of Windows apps.|
|
||||
|`Get-UevAppXPackage -Computer`|Gets the list of Windows apps that are configured for the computer.|
|
||||
|`Get-UevAppXPackage -CurrentComputerUser`|Gets the list of Windows apps that are configured for the current user.|
|
||||
|`Register-UevTemplate [-Path] <template file path>[,<template file path>]`|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.|
|
||||
|`Register-UevTemplate -LiteralPath <template file path>[,<template file path>]`|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.|
|
||||
|`Unregister-UevTemplate [-ID] <template ID>`|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.|
|
||||
|`Unregister-UevTemplate -All`|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.|
|
||||
|`Update-UevTemplate [-Path] <template file path>[,<template file path>]`|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.|
|
||||
|`Update-UevTemplate -LiteralPath <template file path>[,<template file path>]`|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.|
|
||||
|`Clear-UevAppXPackage -Computer [-PackageFamilyName] <package family name>[,<package family name>]`|Removes one or more Windows apps from the computer Windows app list.|
|
||||
|`Clear-UevAppXPackage -CurrentComputerUser`|Removes Windows app from the current user Windows app list.|
|
||||
|`Clear-UevAppXPackage -Computer -All`|Removes all Windows apps from the computer Windows app list.|
|
||||
|`Clear-UevAppXPackage [-CurrentComputerUser] [-PackageFamilyName] <package family name>[,<package family name>]`|Removes one or more Windows apps from the current user Windows app list.|
|
||||
|`Clear-UevAppXPackage [-CurrentComputerUser] -All`|Removes all Windows apps from the current user Windows app list.|
|
||||
|`Disable-UevTemplate [-ID] <template ID>`|Disables a settings location template for the current user of the computer.|
|
||||
|`Disable-UevAppXPackage -Computer [-PackageFamilyName] <package family name>[,<package family name>]`|Disables one or more Windows apps in the computer Windows app list.|
|
||||
|`Disable-UevAppXPackage [-CurrentComputerUser] [-PackageFamilyName] <package family name>[,<package family name>]`|Disables one or more Windows apps in the current user Windows app list.|
|
||||
|`Enable-UevTemplate [-ID] <template ID>`|Enables a settings location template for the current user of the computer.|
|
||||
|`Enable-UevAppXPackage -Computer [-PackageFamilyName] <package family name>[,<package family name>]`|Enables one or more Windows apps in the computer Windows app list.|
|
||||
|`Enable-UevAppXPackage [-CurrentComputerUser] [-PackageFamilyName] <package family name>[,<package family name>]`|Enables one or more Windows apps in the current user Windows app list.|
|
||||
|`Test-UevTemplate [-Path] <template file path>[,<template file path>]`|Determines whether one or more settings location templates comply with its XML schema. Can use relative paths and wildcard characters.|
|
||||
|`Test-UevTemplate -LiteralPath <template file path>[,<template file path>]`|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.|
|
||||
|
||||
The UE-V Windows PowerShell features enable you to manage a group of settings templates that are deployed in your enterprise. Use the following procedure to manage a group of templates by using Windows PowerShell.
|
||||
|
||||
**To manage a group of settings location templates by using Windows PowerShell**
|
||||
|
||||
1. Modify or update the desired settings location templates.
|
||||
1. If you want to modify or update the settings location templates, deploy those settings location templates to a folder that is accessible to the local computer.
|
||||
1. On the local computer, open a Windows PowerShell window with administrator rights.
|
||||
1. Unregister all the previously registered versions of the templates by typing the following command.
|
||||
|
||||
```powershell
|
||||
Unregister-UevTemplate -All
|
||||
```
|
||||
|
||||
This command unregisters all active templates on the computer.
|
||||
|
||||
1. Register the updated templates by typing the following command.
|
||||
|
||||
```powershell
|
||||
Register-UevTemplate <path to template folder>\*.xml
|
||||
```
|
||||
|
||||
This command registers all of the settings location templates that are located in the specified template folder.
|
||||
|
||||
### <a href="" id="win8applist"></a>Windows app list
|
||||
|
||||
By listing a Windows app in the Windows app list, you specify whether that app is enabled or disabled for settings synchronization. Apps are identified in the list by their Package Family name and whether settings synchronization should be enabled or disabled for that app. When you use these settings along with the Unlisted Default Sync Behavior setting, you can control whether Windows apps are synchronized.
|
||||
|
||||
To display the Package Family Name of installed Windows apps, at a Windows PowerShell command prompt, enter:
|
||||
|
||||
```powershell
|
||||
Get-AppxPackage | Sort-Object PackageFamilyName | Format-Table PackageFamilyName
|
||||
```
|
||||
|
||||
To display a list of Windows apps that can synchronize settings on a computer with their package family name, enabled status, and enabled source, at a Windows PowerShell command prompt, enter: `Get-UevAppxPackage`
|
||||
|
||||
**Definitions of Get-UevAppxPackage properties**
|
||||
|
||||
<a href="" id="packagefamilyname"></a>**PackageFamilyName**
|
||||
|
||||
The name of the package that is installed for the current user.
|
||||
|
||||
<a href="" id="enabled"></a>**Enabled**
|
||||
|
||||
Defines whether the settings for the app are configured to synchronize.
|
||||
|
||||
<a href="" id="enabledsource"></a>**EnabledSource**
|
||||
|
||||
The location where the configuration that enables or disables the app is set. Possible values are: *NotSet*, *LocalMachine*, *LocalUser*, *PolicyMachine*, and *PolicyUser*.
|
||||
|
||||
<a href="" id="notset"></a>**NotSet**
|
||||
|
||||
The policy is not configured to synchronize this app.
|
||||
|
||||
<a href="" id="localmachine"></a>**LocalMachine**
|
||||
|
||||
The enabled state is set in the local computer section of the registry.
|
||||
|
||||
<a href="" id="localuser"></a>**LocalUser**
|
||||
|
||||
The enabled state is set in the current user section of the registry.
|
||||
|
||||
<a href="" id="policymachine"></a>**PolicyMachine**
|
||||
|
||||
The enabled state is set in the policy section of the local computer section of the registry.
|
||||
|
||||
To get the user-configured list of Windows apps, at the Windows PowerShell command prompt, enter: `Get-UevAppxPackage -CurrentComputerUser`
|
||||
|
||||
To get the computer-configured list of Windows apps, at the Windows PowerShell command prompt, enter: `Get-UevAppxPackage -Computer`
|
||||
|
||||
For either parameter, CurrentComputerUser or Computer, the cmdlet returns a list of the Windows apps that are configured at the user or at the computer level.
|
||||
|
||||
**Definitions of properties**
|
||||
|
||||
<a href="" id="packagefamilyname"></a>**PackageFamilyName**
|
||||
|
||||
The name of the package that is installed for the current user.
|
||||
|
||||
<a href="" id="enabled"></a>**Enabled**
|
||||
|
||||
Defines whether the settings for the app are configured to synchronize for the specified switch, that is, **user** or **computer**.
|
||||
|
||||
<a href="" id="installed"></a>**Installed**
|
||||
|
||||
True if the app, that is, the PackageFamilyName is installed for the current user.
|
||||
|
||||
### Manage UE-V settings location templates by using WMI
|
||||
|
||||
User Experience Virtualization provides the following set of WMI commands. Administrators can use these interfaces to manage settings location templates from Windows PowerShell and automate template administrative tasks.
|
||||
|
||||
**To manage settings location templates by using WMI**
|
||||
|
||||
1. Use an account with administrator rights to open a Windows PowerShell window.
|
||||
|
||||
1. Use the following WMI commands to register and manage the UE-V settings location templates.
|
||||
|
||||
|`Windows PowerShell command`|Description|
|
||||
|--- |--- |
|
||||
|`Get-WmiObject -Namespace root\Microsoft\UEV SettingsLocationTemplate Select-Object TemplateId,TemplateName, TemplateVersion,Enabled Format-Table -Autosize`|Lists all the settings location templates that are registered for the computer.|
|
||||
|`Invoke-WmiMethod -Namespace root\Microsoft\UEV -Class SettingsLocationTemplate -Name GetProcessInfoByTemplateId <template Id>`|Gets the name of the program and version information, which depends on the template name.|
|
||||
|`Get-WmiObject -Namespace root\Microsoft\UEV EffectiveWindows8App`|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.|
|
||||
|`Get-WmiObject -Namespace root\Microsoft\UEV UserConfiguredWindows8App`|Gets the list of Windows apps that are configured for the current user.|
|
||||
|`Invoke-WmiMethod -Namespace root\Microsoft\UEV -Class SettingsLocationTemplate -Name Register -ArgumentList <template path >`|Registers a settings location template with UE-V.|
|
||||
|`Invoke-WmiMethod -Namespace root\Microsoft\UEV -Class SettingsLocationTemplate -Name UnregisterByTemplateId -ArgumentList <template ID>`|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.|
|
||||
|`Invoke-WmiMethod -Namespace root\Microsoft\UEV -Class SettingsLocationTemplate -Name Update -ArgumentList <template path>`|Updates a settings location template with UE-V. The new template should be a newer version than the existing one.|
|
||||
|`Invoke-WmiMethod -Namespace root\Microsoft\UEV -Class MachineConfiguredWindows8App -Name RemoveApp -ArgumentList <package family name>`|Removes one or more Windows apps from the computer Windows app list.|
|
||||
|`Invoke-WmiMethod -Namespace root\Microsoft\UEV -Class UserConfiguredWindows8App -Name RemoveApp -ArgumentList <package family name>`|Removes one or more Windows apps from the current user Windows app list.|
|
||||
|`Invoke-WmiMethod -Namespace root\Microsoft\UEV -Class SettingsLocationTemplate -Name DisableByTemplateId -ArgumentList <template ID>`|Disables one or more settings location templates with UE-V.|
|
||||
|`Invoke-WmiMethod -Namespace root\Microsoft\UEV -Class MachineConfiguredWindows8App -Name DisableApp -ArgumentList <package family name>`|Disables one or more Windows apps in the computer Windows app list.|
|
||||
|`Invoke-WmiMethod -Namespace root\Microsoft\UEV -Class UserConfiguredWindows8App -Name DisableApp -ArgumentList <package family name>`|Disables one or more Windows apps in the current user Windows app list.|
|
||||
|`Invoke-WmiMethod -Namespace root\Microsoft\UEV -Class SettingsLocationTemplate -Name EnableByTemplateId -ArgumentList <template ID>`|Enables a settings location template with UE-V.|
|
||||
|`Invoke-WmiMethod -Namespace root\Microsoft\UEV -Class MachineConfiguredWindows8App -Name EnableApp -ArgumentList <package family name>`|Enables Windows apps in the computer Windows app list.|
|
||||
|`Invoke-WmiMethod -Namespace root\Microsoft\UEV -Class UserConfiguredWindows8App -Name EnableApp -ArgumentList <package family name>`|Enables Windows apps in the current user Windows app list.|
|
||||
|`Invoke-WmiMethod -Namespace root\Microsoft\UEV -Class SettingsLocationTemplate -Name Validate -ArgumentList <template path>`|Determines whether a given settings location template complies with its XML schema.|
|
||||
|
||||
> [!NOTE]
|
||||
> Where a list of Package Family Names is called by the WMI command, the list must be in quotes and separated by a pipe symbol, for example, `"<package family name | package family name>"`.
|
||||
|
||||
## Related topics
|
||||
|
||||
[Administering UE-V with Windows PowerShell and WMI](uev-administering-uev-with-windows-powershell-and-wmi.md)
|
||||
[Administering UE-V](uev-administering-uev.md)
|
||||
[User Experience Virtualization in Windows PowerShell](/powershell/module/uev/)
|
||||
@ -1,109 +0,0 @@
|
||||
---
|
||||
title: Manage UE-V Service and Packages with Windows PowerShell and WMI
|
||||
description: Managing the UE-V service and packages with Windows PowerShell and WMI
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Managing the UE-V service and packages with Windows PowerShell and WMI
|
||||
|
||||
You can use Windows Management Instrumentation (WMI) and Windows PowerShell to manage User Experience Virtualization (UE-V) service configuration and synchronization behavior.
|
||||
|
||||
> [!NOTE]
|
||||
> For a complete list of UE-V cmdlets, see [User Experience Virtualization in Windows PowerShell](/powershell/module/uev/).
|
||||
|
||||
## To configure the UE-V service with Windows PowerShell
|
||||
|
||||
1. Open a Windows PowerShell window. To manage computer settings that affect all users of the computer by using the *Computer* parameter, open the window with an account that has administrator rights.
|
||||
1. Use the following Windows PowerShell commands to configure the service.
|
||||
|
||||
|Windows PowerShell command|Description|
|
||||
|--- |--- |
|
||||
|`Enable-UEV`|Turns on the UE-V service. Requires reboot.|
|
||||
|`Disable-UEV`|Turns off the UE-V service. Requires reboot.|
|
||||
|`Get-UevStatus`|Displays whether UE-V service is enabled or disabled, using a Boolean value.|
|
||||
|`Get-UevConfiguration`|Gets the effective UE-V service settings. User-specific settings have precedence over the computer settings.|
|
||||
|`Get-UevConfiguration -CurrentComputerUser`|Gets the UE-V service settings values for the current user only.|
|
||||
|`Get-UevConfiguration -Computer`|Gets the UE-V service configuration settings values for all users on the computer.|
|
||||
|`Get-UevConfiguration -Details`|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.|
|
||||
|`Set-UevConfiguration -Computer -EnableDontSyncWindows8AppSettings`|Configures the UE-V service to not synchronize any Windows apps for all users on the computer.|
|
||||
|`Set-UevConfiguration -CurrentComputerUser -EnableDontSyncWindows8AppSettings`|Configures the UE-V service to not synchronize any Windows apps for the current computer user.|
|
||||
|`Set-UevConfiguration -Computer -EnableFirstUseNotification`|Configures the UE-V service to display notification the first time the service runs for all users on the computer.|
|
||||
|`Set-UevConfiguration -Computer -DisableFirstUseNotification`|Configures the UE-V service to not display notification the first time that the service runs for all users on the computer.|
|
||||
|`Set-UevConfiguration -Computer -EnableSettingsImportNotify`|Configures the UE-V service to notify all users on the computer when settings synchronization is delayed.<p>Use the DisableSettingsImportNotify parameter to disable notification.|
|
||||
|`Set-UevConfiguration -CurrentComputerUser -EnableSettingsImportNotify`|Configures the UE-V service to notify the current user when settings synchronization is delayed.<p>Use the DisableSettingsImportNotify parameter to disable notification.|
|
||||
|`Set-UevConfiguration -Computer -EnableSyncUnlistedWindows8Apps`|Configures the UE-V service to synchronize all Windows apps that aren't explicitly disabled by the Windows app list for all users of the computer. For more information, see "Get-UevAppxPackage" in [Managing UE-V Settings Location Templates Using Windows PowerShell and WMI](uev-managing-settings-location-templates-using-windows-powershell-and-wmi.md).<p>Use the DisableSyncUnlistedWindows8Apps parameter to configure the UE-V service to synchronize only Windows apps that are explicitly enabled by the Windows App List.|
|
||||
|`Set-UevConfiguration -CurrentComputerUser - EnableSyncUnlistedWindows8Apps`|Configures the UE-V service to synchronize all Windows apps that aren't explicitly disabled by the Windows app list for the current user on the computer. For more information, see "Get-UevAppxPackage" in [Managing UE-V Settings Location Templates Using Windows PowerShell and WMI](uev-managing-settings-location-templates-using-windows-powershell-and-wmi.md).<p>Use the DisableSyncUnlistedWindows8Apps parameter to configure the UE-V service to synchronize only Windows apps that are explicitly enabled by the Windows App List.|
|
||||
|`Set-UevConfiguration -Computer -DisableSync`|Disables UE-V for all the users on the computer.<p>Use the EnableSync parameter to enable or re-enable.|
|
||||
|`Set-UevConfiguration -CurrentComputerUser -DisableSync`|Disables UE-V for the current user on the computer.<p>Use the EnableSync parameter to enable or re-enable.|
|
||||
|`Set-UevConfiguration -Computer -EnableTrayIcon`|Enables the UE-V icon in the notification area for all users of the computer.<p>Use the DisableTrayIcon parameter to disable the icon.|
|
||||
|`Set-UevConfiguration -Computer -MaxPackageSizeInBytes <size in bytes>`|Configures the UE-V service 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.|
|
||||
|`Set-UevConfiguration -CurrentComputerUser -MaxPackageSizeInBytes <size in bytes>`|Configures the UE-V service to report when a settings package file size reaches the defined threshold. Sets the package size warning threshold for the current user.|
|
||||
|`Set-UevConfiguration -Computer -SettingsImportNotifyDelayInSeconds`|Specifies the time in seconds before the user is notified for all users of the computer|
|
||||
|`Set-UevConfiguration -CurrentComputerUser -SettingsImportNotifyDelayInSeconds`|Specifies the time in seconds before notification for the current user is sent.|
|
||||
|`Set-UevConfiguration -Computer -SettingsStoragePath <path to _settings_storage_location>`|Defines a per-computer settings storage location for all users of the computer.|
|
||||
|`Set-UevConfiguration -CurrentComputerUser -SettingsStoragePath <path to _settings_storage_location>`|Defines a per-user settings storage location.|
|
||||
|`Set-UevConfiguration -Computer -SettingsTemplateCatalogPath <path to catalog>`|Sets the settings template catalog path for all users of the computer.|
|
||||
|`Set-UevConfiguration -Computer -SyncMethod <sync method>`|Sets the synchronization method for all users of the computer: SyncProvider or None.|
|
||||
|`Set-UevConfiguration -CurrentComputerUser -SyncMethod <sync method>`|Sets the synchronization method for the current user: SyncProvider or None.|
|
||||
|`Set-UevConfiguration -Computer -SyncTimeoutInMilliseconds <timeout in milliseconds>`|Sets the synchronization time-out in milliseconds for all users of the computer|
|
||||
|`Set-UevConfiguration -CurrentComputerUser -SyncTimeoutInMilliseconds <timeout in milliseconds>`|Set the synchronization time-out for the current user.|
|
||||
|`Clear-UevConfiguration -Computer -<setting name>`|Clears the specified setting for all users on the computer.|
|
||||
|`Clear-UevConfiguration -CurrentComputerUser -<setting name>`|Clears the specified setting for the current user only.|
|
||||
|`Export-UevConfiguration <settings migration file>`|Exports the UE-V computer configuration to a settings migration file. The file name extension must be .uev.<p>The `Export` cmdlet exports all UE-V service settings that are configurable with the Computer parameter.|
|
||||
|`Import-UevConfiguration <settings migration file>`|Imports the UE-V computer configuration from a settings migration file. The file name extension must be .uev.|
|
||||
|
||||
## To export UE-V package settings and repair UE-V templates with Windows PowerShell
|
||||
|
||||
1. Open a Windows PowerShell window as an administrator.
|
||||
1. Use the following Windows PowerShell commands to configure the service.
|
||||
|
||||
|Windows PowerShell command|Description|
|
||||
|--- |--- |
|
||||
|`Export-UevPackage MicrosoftNotepad.pkgx`|Extracts the settings from a Microsoft Notepad package file and converts them into a human-readable format in XML.|
|
||||
|`Repair-UevTemplateIndex`|Repairs the index of the UE-V settings location templates.|
|
||||
|
||||
## To configure the UE-V service with WMI
|
||||
|
||||
1. User Experience Virtualization provides the following set of WMI commands. Administrators can use this interface to configure the UE-V service at the command line and automate typical configuration tasks.
|
||||
|
||||
Use an account with administrator rights to open a Windows PowerShell window.
|
||||
|
||||
1. Use the following WMI commands to configure the service.
|
||||
|
||||
|`Windows PowerShell command`|Description|
|
||||
|--- |--- |
|
||||
|`Get-WmiObject -Namespace root\Microsoft\UEV Configuration`|Displays the active UE-V service settings. User-specific settings have precedence over the computer settings.|
|
||||
|`Get-WmiObject -Namespace root\Microsoft\UEV UserConfiguration`|Displays the UE-V service configuration that is defined for a user.|
|
||||
|`Get-WmiObject -Namespace root\Microsoft\UEV ComputerConfiguration`|Displays the UE-V service configuration that is defined for a computer.|
|
||||
|`Get-WmiObject -Namespace root\Microsoft\Uev ConfigurationItem`|Displays the details for each configuration item.|
|
||||
|`$config = Get-WmiObject -Namespace root\Microsoft\UEV ComputerConfiguration`<p>`$config.SettingsStoragePath = <path_to_settings_storage_location>`<p>`$config.Put()`|Defines a per-computer settings storage location.|
|
||||
|`$config = Get-WmiObject -Namespace root\Microsoft\UEV UserConfiguration`<p>`$config.SettingsStoragePath = <path_to_settings_storage_location>`<p>`$config.Put()`|Defines a per-user settings storage location.|
|
||||
|`$config = Get-WmiObject -Namespace root\Microsoft\UEV ComputerConfiguration`<p>`$config.SyncTimeoutInMilliseconds = <timeout_in_milliseconds>`<p>`$config.Put()`|Sets the synchronization time-out in milliseconds for all users of the computer.|
|
||||
|`$config = Get-WmiObject -Namespace root\Microsoft\UEV ComputerConfiguration`<p>`$config.MaxPackageSizeInBytes = <size_in_bytes>`<p>`$config.Put()`|Configures the UE-V service 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.|
|
||||
|`$config = Get-WmiObject -Namespace root\Microsoft\UEV ComputerConfiguration`<p>`$config.SyncMethod = <sync_method>`<p>`$config.Put()`|Sets the synchronization method for all users of the computer: SyncProvider or None.|
|
||||
|`$config = Get-WmiObject -Namespace root\Microsoft\UEV ComputerConfiguration`<p>`$config.<setting name> = $true`<p>`$config.Put()`|To enable a specific per-computer setting, clear the setting, and use $null as the setting value. Use UserConfiguration for per-user settings.|
|
||||
|`$config = Get-WmiObject -Namespace root\Microsoft\UEV ComputerConfiguration`<p>`$config.<setting name> = $false`<p>`$config.Put()`|To disable a specific per-computer setting, clear the setting, and use $null as the setting value. Use User Configuration for per-user settings.|
|
||||
|`$config = Get-WmiObject -Namespace root\Microsoft\UEV ComputerConfiguration`<p>`$config.<setting name> = <setting value>`<p>`$config.Put()`|Updates a specific per-computer setting. To clear the setting, use $null as the setting value.|
|
||||
|`$config = Get-WmiObject -Namespace root\Microsoft\UEV ComputerConfiguration`<p>`$config.<setting name> = <setting value>`<p>`$config.Put()`|Updates a specific per-user setting for all users of the computer. To clear the setting, use $null as the setting value.|
|
||||
|
||||
When you're finished configuring the UE-V service with WMI and Windows PowerShell, the defined configuration is stored in the registry in the following locations.
|
||||
|
||||
`\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\UEV\Agent\Configuration`
|
||||
`\HKEY_CURRENT_USER\SOFTWARE\Microsoft\UEV\Agent\Configuration`
|
||||
|
||||
## To export UE-V package settings and repair UE-V templates by using WMI
|
||||
|
||||
1. UE-V provides the following set of WMI commands. Administrators can use this interface to export a package or repair UE-V templates.
|
||||
1. Use the following WMI commands.
|
||||
|
||||
|WMI command|Description|
|
||||
|--- |--- |
|
||||
|`Invoke-WmiMethod -Namespace root\Microsoft\UEV -Class UserSettings -Name ExportPackage -ArgumentList <package name>`|Extracts the settings from a package file and converts them into a human-readable format in XML.|
|
||||
|`Invoke-WmiMethod -Namespace root\Microsoft\UEV -Class SettingsLocationTemplate -Name RebuildIndex`|Repairs the index of the UE-V settings location templates. Must be run as administrator.|
|
||||
|
||||
## Related topics
|
||||
|
||||
[Administering UE-V with Windows PowerShell and WMI](uev-administering-uev-with-windows-powershell-and-wmi.md)
|
||||
[Administering UE-V](uev-administering-uev.md)
|
||||
[User Experience Virtualization in Windows PowerShell](/powershell/module/uev/)
|
||||
@ -1,35 +0,0 @@
|
||||
---
|
||||
title: Migrating UE-V settings packages
|
||||
description: Learn to relocate User Experience Virtualization (UE-V) user settings packages either when you migrate to a new server or when you perform backups.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Migrating UE-V settings packages
|
||||
|
||||
In the lifecycle of a User Experience Virtualization (UE-V) deployment, you might have to relocate the user settings packages either when you migrate to a new server or when you perform backups. Settings packages might have to be migrated in the following scenarios:
|
||||
|
||||
- Upgrade of existing server hardware to a more modern server
|
||||
- Migration of a settings storage location share from a test server to a production server
|
||||
|
||||
Simply copying the files and folders doesn't preserve the security settings and permissions. The following steps describe how to correctly copy the settings package along with their NTFS file system permissions to a new share.
|
||||
|
||||
**To preserve UE-V settings packages when you migrate to a new server**
|
||||
|
||||
1. In a new location on a different server, create a new folder, for example, MySettings.
|
||||
1. Disable sharing for the old folder share on the old server.
|
||||
1. To copy the existing settings packages to the new server with Robocopy
|
||||
|
||||
``` syntax
|
||||
C:\start robocopy "\\servername\E$\MySettings" "\\servername\E$\MySettings" /b /sec /secfix /e /LOG:D:\Robocopylogs\MySettings.txt
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> To monitor the copy progress, open MySettings.txt with a log viewer such as Trace32.
|
||||
1. Grant share-level permissions to the new share. Leave the NTFS file system permissions as they were set by Robocopy.
|
||||
|
||||
On computers on which the UE-V service is enabled, update the **SettingsStoragePath** configuration setting to the Universal Naming Convention (UNC) path of the new share.
|
||||
|
||||
## Related topics
|
||||
|
||||
[Administering UE-V](uev-administering-uev.md)
|
||||
@ -1,348 +0,0 @@
|
||||
---
|
||||
title: Prepare a UE-V Deployment
|
||||
description: Learn about the types of User Experience Virtualization (UE-V) deployment you can execute and what preparations you can make beforehand to be successful.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Prepare a UE-V Deployment
|
||||
|
||||
Before you deploy User Experience Virtualization (UE-V), review this article for important information about the type of deployment you're planning and for preparations you can make beforehand so that your deployment is successful. If you leave this page, be sure to come back and read through the planning information in this article.
|
||||
|
||||
## Plan your UE-V deployment
|
||||
|
||||
With UE-V, you can synchronize user-defined application and operating system settings across all the devices that a user works from. Use UE-V to synchronize settings for Windows applications and custom applications, such as third-party and line-of-business applications.
|
||||
|
||||
Whether you want to synchronize settings for only default Windows applications or for both Windows and custom applications, you'll need to first deploy the features required to use UE-V.
|
||||
|
||||
[Deploy required UE-V features](uev-deploy-required-features.md)
|
||||
|
||||
- [Define a settings storage location](uev-deploy-required-features.md)
|
||||
- [Enable the UE-V service](uev-deploy-required-features.md#enable-the-ue-v-service) on user computers
|
||||
|
||||
If you want to use UE-V to synchronize user-defined settings for custom applications (third-party or line-of-business), you'll need to install and configure these optional extra UE-V features:
|
||||
|
||||
[Deploy UE-V for custom applications](uev-deploy-uev-for-custom-applications.md)
|
||||
|
||||
- [Install the UE-V template generator](uev-deploy-uev-for-custom-applications.md#install-the-uev-template-generator) so you can create, edit, and validate the custom settings location templates required to synchronize custom application settings
|
||||
- [Create custom settings location templates](uev-deploy-uev-for-custom-applications.md) with the UE-V template generator
|
||||
- [Deploy a UE-V settings template catalog](uev-deploy-uev-for-custom-applications.md) to store your custom settings location templates
|
||||
|
||||
The workflow diagram below illustrates a typical UE-V deployment and the decisions you need to be prepared to make.
|
||||
|
||||
:::image type="content" alt-text="UE-V deployment preparation." source="images/uev-deployment-preparation.png":::
|
||||
|
||||
<!-- PRESERVING ^ORIGINAL IMAGE CODING JUST IN CASE
|
||||
<img src="media/image1.png" width="446" height="362" />
|
||||
-->
|
||||
|
||||
### Planning a UE-V deployment
|
||||
|
||||
Review the following articles to determine which UE-V components you'll be deploying.
|
||||
|
||||
- [Decide whether to synchronize settings for custom applications](#decide-whether-to-synchronize-settings-for-custom-applications)
|
||||
|
||||
If you want to synchronize settings for custom applications, you'll need to install the UE-V template generator. Use the generator to create custom settings location templates, which involve the following tasks:
|
||||
|
||||
- Review the [settings that are synchronized automatically in a UE-V deployment](#settings-automatically-synchronized-in-a-ue-v-deployment).
|
||||
- [Determine whether you need settings synchronized for other applications](#determine-whether-you-need-settings-synchronized-for-other-applications).
|
||||
|
||||
- Review [other considerations for deploying UE-V](#other-considerations-when-preparing-a-ue-v-deployment), including high availability and capacity planning.
|
||||
- [Confirm prerequisites and supported configurations for UE-V](#confirm-prerequisites-and-supported-configurations-for-ue-v)
|
||||
|
||||
## Decide whether to synchronize settings for custom applications
|
||||
|
||||
In a UE-V deployment, many settings are automatically synchronized. You can also customize UE-V to synchronize settings for other applications, such as line-of-business and third-party apps.
|
||||
|
||||
Deciding if you want UE-V to synchronize settings for custom applications is an essential part of planning your UE-V deployment. The articles in this section will help you make that decision.
|
||||
|
||||
### Settings automatically synchronized in a UE-V deployment
|
||||
|
||||
This section explains which settings are synchronized by default in UE-V, including:
|
||||
|
||||
- Desktop applications that are synchronized by default
|
||||
- Windows desktop settings that are synchronized by default
|
||||
- A statement of support for Windows applications setting synchronization
|
||||
|
||||
For downloadable UE-V templates, see: [User Experience Virtualization (UE-V) settings templates for Microsoft Office](https://www.microsoft.com/download/details.aspx?id=46367)
|
||||
|
||||
### Desktop applications synchronized by default in UE-V
|
||||
|
||||
When you enable the UE-V service on user devices, it registers a default group of settings location templates that capture settings values for these common Microsoft applications.
|
||||
|
||||
| Application category | Description |
|
||||
|--|--|
|
||||
| Microsoft Office 2016 applications | Microsoft Access 2016<br>Microsoft Lync 2016<br>Microsoft Excel 2016<br>Microsoft OneNote 2016<br>Microsoft Outlook 2016<br>Microsoft PowerPoint 2016<br>Microsoft Project 2016<br>Microsoft Publisher 2016<br>Microsoft SharePoint Designer 2013 (not updated for 2016)<br>Microsoft Visio 2016<br>Microsoft Word 2016<br>Microsoft Office Upload Manager<br>Microsoft Infopath has been removed (deprecated) from the Office 2016 suite |
|
||||
| Microsoft Office 2013 applications<br>[Download a list of all settings synced](https://www.microsoft.com/download/details.aspx?id=46367) | Microsoft Word 2013<br>Microsoft Excel 2013<br>Microsoft Outlook 2013<br>Microsoft Access 2013<br>Microsoft Project 2013<br>Microsoft PowerPoint 2013<br>Microsoft Publisher 2013<br>Microsoft Visio 2013<br>Microsoft InfoPath 2013<br>Microsoft Lync 2013<br>Microsoft OneNote 2013<br>Microsoft SharePoint Designer 2013<br>Microsoft Office 2013 Upload Center<br>Microsoft OneDrive for Business 2013 |
|
||||
| Microsoft Office 2010 applications<br>[Download a list of all settings synced](https://www.microsoft.com/download/details.aspx?id=46367) | Microsoft Word 2010<br>Microsoft Excel 2010<br>Microsoft Outlook 2010<br>Microsoft Access 2010<br>Microsoft Project 2010<br>Microsoft PowerPoint 2010<br>Microsoft Publisher 2010<br>Microsoft Visio 2010<br>Microsoft SharePoint Workspace 2010<br>Microsoft InfoPath 2010<br>Microsoft Lync 2010<br>Microsoft OneNote 2010<br>Microsoft SharePoint Designer 2010 |
|
||||
| Browser options: Internet Explorer 11 and 10 | Synchronize favorites, home page, tabs, and toolbars.<br>**Note**<br>UE-V doesn't roam settings for Internet Explorer cookies. |
|
||||
| Windows accessories | Microsoft NotePad, WordPad |
|
||||
|
||||
> [!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.
|
||||
> - UE-V doesn't synchronize settings between the Microsoft Calculator in Windows 10 and the Microsoft Calculator in previous operating systems.
|
||||
|
||||
### Windows settings synchronized by default
|
||||
|
||||
UE-V includes settings location templates that capture settings values for these Windows settings.
|
||||
|
||||
| Windows settings | Description | Apply on | Export on | Default state |
|
||||
|--|--|--|--|--|
|
||||
| Desktop background | Currently active desktop background or wallpaper | Log on, unlock, remote connect, Scheduled Task events | Log off, lock, remote disconnect, or scheduled task interval | Enabled |
|
||||
| Ease of Access | Accessibility and input settings, Microsoft Magnifier, Narrator, and on-Screen Keyboard | Log on only | Log off or scheduled task interval | Enabled |
|
||||
| Desktop settings | Start menu and Taskbar settings, folder options, default desktop icons, more clocks, and region and language settings | Log on only | Log off or scheduled task | Enabled |
|
||||
|
||||
> [!IMPORTANT]
|
||||
> UE-V roams taskbar settings between Windows 10 devices. However, UE-V doesn't synchronize taskbar settings between Windows 10 devices and devices running previous operating systems versions.
|
||||
|
||||
| Settings group | Category | Capture | Apply |
|
||||
|--|--|--|--|
|
||||
| **Application Settings** | Windows applications | Close application<br>Windows application settings change event | Start the UE-V App Monitor at startup<br>Open app<br>Windows application settings change event<br>Arrival of a settings package |
|
||||
| | Desktop applications | Application closes | Application opens and closes |
|
||||
| **Desktop settings** | Desktop background | Lock or log off | Log on, unlock, remote connect, notification of new package arrival, or scheduled task runs |
|
||||
| | Ease of Access (Common - Accessibility, Narrator, Magnifier, On-Screen-Keyboard) | Lock or Log off | Log on |
|
||||
| | Ease of Access (Shell - Audio, Accessibility, Keyboard, Mouse) | Lock or log off | Log on, unlock, remote connect, notification of new package arrival, or scheduled task runs |
|
||||
| | Desktop settings | Lock or log off | Log on |
|
||||
|
||||
### UE-V-support for Windows applications
|
||||
|
||||
For Windows applications, the application developer specifies which user settings are synchronized. You can specify which Windows apps are enabled for settings synchronization.
|
||||
|
||||
To display a list of Windows applications that can synchronize settings with their package family name, enabled status, and enabled source, open a Windows PowerShell window, type Get-UevAppxPackage, and press ENTER.
|
||||
|
||||
> [!NOTE]
|
||||
> Starting in Windows 10, version 1607, you can configure UE-V to not synchronize Windows applications settings if the device is configured to use Enterprise State Roaming.
|
||||
|
||||
### UE-V-support for roaming printers
|
||||
|
||||
Users can print to their saved network printers, including their default network printer, from any network device.
|
||||
|
||||
Printer roaming in UE-V requires one of these scenarios:
|
||||
|
||||
- The print server can download the required driver when it roams to a new device.
|
||||
- The driver for the roaming network printer is pre-installed on any device that needs to access that network printer.
|
||||
- The printer driver can be imported from Windows Update.
|
||||
|
||||
> [!NOTE]
|
||||
> The UE-V printer roaming feature doesn't roam printer settings or preferences, such as printing double-sided.
|
||||
|
||||
### Determine whether you need settings synchronized for other applications
|
||||
|
||||
After you've reviewed the settings that are synchronized automatically in a UE-V deployment, you'll need to decide whether to synchronize settings for other applications as your decision will determine how you deploy UE-V throughout your enterprise.
|
||||
|
||||
As an administrator, when you consider which desktop applications to include in your UE-V solution, consider which settings can be customized by users, and how and where the application stores its settings. Not all desktop applications have settings that can be customized or that are routinely customized by users. In addition, not all desktop applications settings can be synchronized safely across multiple devices or environments.
|
||||
|
||||
In general, you can synchronize settings that meet the following criteria:
|
||||
|
||||
- Settings that are stored in user-accessible locations. For example, don't synchronize settings that are stored in System32 or outside the HKEY\_CURRENT\_USER (HKCU) section of the registry.
|
||||
- Settings that aren't specific to the particular device. For example, exclude network shortcuts or hardware configurations.
|
||||
- Settings that can be synchronized between computers without risk of corrupted data. For example, don't use settings that are stored in a database file.
|
||||
|
||||
### Checklist for evaluating custom applications
|
||||
|
||||
If you've decided that you need to synchronize settings for custom applications, use this checklist to determine which applications you'll include.
|
||||
|
||||
| | 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 don't 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 shouldn't 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 shouldn't 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 extra 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. |
|
||||
|
||||
## Other considerations when preparing a UE-V deployment
|
||||
|
||||
You should also consider these things when you're preparing to deploy UE-V:
|
||||
|
||||
- [Managing credentials synchronization](#managing-credentials-synchronization-in-ue-v)
|
||||
- [Windows applications settings synchronization](#windows-applications-settings-synchronization)
|
||||
- [Custom UE-V settings location templates](#custom-ue-v-settings-location-templates)
|
||||
- [Unintentional user settings configurations](#prevent-unintentional-user-settings-configuration)
|
||||
- [Performance and capacity](#performance-and-capacity-planning)
|
||||
- [High availability](#high-availability-for-ue-v)
|
||||
- [Computer clock synchronization](#synchronize-computer-clocks-for-ue-v-settings-synchronization)
|
||||
|
||||
### Managing credentials synchronization in UE-V
|
||||
|
||||
Many enterprise applications, including Microsoft Outlook, Lync, and Skype for Business prompt users for their domain credentials when they log in. Users have the option of saving their credentials to disk to prevent having to enter them every time they open these applications. Enabling roaming credentials synchronization lets users save their credentials on one computer and avoid reentering them on every computer they use in their environment. Users can synchronize some domain credentials with UE-V.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Credentials synchronization is disabled by default. You must explicitly enable credentials synchronization after you enable the UE-V service to implement this feature.
|
||||
|
||||
UE-V can synchronize enterprise credentials, but doesn't roam credentials intended only for use on the local device.
|
||||
|
||||
Credentials are synchronous settings, meaning that they're applied to users' profiles the first time they sign in to their devices after UE-V synchronizes.
|
||||
|
||||
Credentials synchronization is managed by its own settings location template, which is disabled by default. You can enable or disable this template through the same methods used for other templates. The template identifier for this feature is RoamingCredentialSettings.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> If you're using Active Directory Credential Roaming in your environment, we recommend that you do not enable the UE-V credential roaming template. Instead, use PowerShell or Group Policy to enable credentials synchronization. Note that credentials are encrypted during synchronization.
|
||||
|
||||
[PowerShell](uev-administering-uev-with-windows-powershell-and-wmi.md)**:** Enter this PowerShell cmdlet to enable credential synchronization:
|
||||
|
||||
```powershell
|
||||
Enable-UevTemplate RoamingCredentialSettings
|
||||
|
||||
Copy
|
||||
```
|
||||
|
||||
Use this PowerShell cmdlet to disable credential synchronization:
|
||||
|
||||
```powershell
|
||||
Disable-UevTemplate RoamingCredentialSettings
|
||||
|
||||
Copy
|
||||
```
|
||||
|
||||
<!-- WATCH THE MDOP ADMX templates LINK IN THE NEXT PARAGRAPH. IS IT CURRENT? -->
|
||||
|
||||
[Group Policy](uev-configuring-uev-with-group-policy-objects.md)**:** You must edit the Group Policy administrative template for UE-V, which is included in Windows 10, version 1607, to enable credential synchronization through group policy. Credentials synchronization is managed in Windows settings. To manage this feature with Group Policy, enable the **Synchronize Windows** settings policy.
|
||||
|
||||
1. Open Group Policy Editor and navigate to **User Configuration > Administrative Templates > Windows Components > Microsoft User Experience Virtualization**.
|
||||
1. Double-click **Synchronize Windows settings**.
|
||||
1. If this policy is enabled, you can enable credentials synchronization by checking the **Roaming Credentials** check box, or disable credentials synchronization by unchecking it.
|
||||
1. Select **OK**.
|
||||
|
||||
### Credential locations synchronized by UE-V
|
||||
|
||||
Credential files saved by applications into the following locations are synchronized:
|
||||
|
||||
- %UserProfile%\AppData\Roaming\Microsoft\Credentials\
|
||||
- %UserProfile%\AppData\Roaming\Microsoft\Crypto\
|
||||
- %UserProfile%\AppData\Roaming\Microsoft\Protect\
|
||||
- %UserProfile%\AppData\Roaming\Microsoft\SystemCertificates\
|
||||
|
||||
Credentials saved to other locations aren't synchronized by UE-V.
|
||||
|
||||
### Windows applications settings synchronization
|
||||
|
||||
UE-V manages Windows application settings synchronization in three ways:
|
||||
|
||||
- **Sync Windows applications:** Allow or deny any Windows application synchronization
|
||||
- **Windows applications list:** Synchronize a list of Windows applications
|
||||
- **Unlisted default sync behavior:** Determine the synchronization behavior of Windows applications that aren't in the Windows applications list.
|
||||
|
||||
For more information, see the [Windows Application List](uev-managing-settings-location-templates-using-windows-powershell-and-wmi.md#win8applist).
|
||||
|
||||
### Custom UE-V settings location templates
|
||||
|
||||
If you're deploying UE-V to synchronize settings for custom applications, you'll use the UE-V template generator to create custom settings location templates for those desktop applications. After you create and test a custom settings location template in a test environment, you can deploy the settings location templates to user devices.
|
||||
|
||||
Custom settings location templates must be deployed with an existing deployment infrastructure, such as an enterprise software distribution method, including Microsoft Configuration Manager, with preferences, or by configuring a UE-V settings template catalog. Templates that are deployed with Configuration Manager or Group Policy must be registered using UE-V WMI or Windows PowerShell.
|
||||
|
||||
For more information about custom settings location templates, see [Deploy UE-V with custom applications](uev-deploy-uev-for-custom-applications.md). For more information about using UE-V with Configuration Manager, see [Configuring UE-V with Microsoft Configuration Manager](uev-configuring-uev-with-system-center-configuration-manager.md).
|
||||
|
||||
### Prevent unintentional user settings configuration
|
||||
|
||||
UE-V downloads new user settings information from a settings storage location and applies the settings to the local device in these instances:
|
||||
|
||||
- Each time an application is started that has a registered UE-V template
|
||||
- When a user signs in to a device
|
||||
- When a user unlocks a device
|
||||
- When a connection is made to a remote desktop device running UE-V
|
||||
- When the Sync Controller Application scheduled task is run
|
||||
|
||||
If UE-V is installed on computer A and computer B, and the settings that you want for the application are on computer A, then computer A should open and close the application first. If the application is opened and closed on computer B first, then the application settings on computer A are configured to the application settings on computer B. Settings are synchronized between computers on per-application basis. Over time, settings become consistent between computers as they're opened and closed with preferred settings.
|
||||
|
||||
This scenario also applies to Windows settings. If the Windows settings on computer B should be the same as the Windows settings on computer A, then the user should log on and log off computer A first.
|
||||
|
||||
If the user settings that the user wants are applied in the wrong order, they can be recovered by performing a restore operation for the specific application or Windows configuration on the computer on which the settings were overwritten. For more information, see [Manage Administrative Backup and Restore in UE-V](uev-manage-administrative-backup-and-restore.md).
|
||||
|
||||
### Performance and capacity planning
|
||||
|
||||
Specify your requirements for UE-V with standard disk capacity and network health monitoring.
|
||||
|
||||
UE-V uses a Server Message Block (SMB) share for the storage of settings packages. The size of settings packages varies depending on the settings information for each application. While most settings packages are small, the synchronization of potentially large files, such as desktop images, can result in poor performance, particularly on slower networks.
|
||||
|
||||
To reduce problems with network latency, create settings storage locations on the same local networks where the users' computers reside. We recommend 20 MB of disk space per user for the settings storage location.
|
||||
|
||||
By default, UE-V synchronization times out after 2 seconds to prevent excessive lag due to a large settings package. You can configure the SyncMethod=SyncProvider setting by using [Group Policy objects](uev-configuring-uev-with-group-policy-objects.md).
|
||||
|
||||
### High availability for UE-V
|
||||
|
||||
The UE-V settings storage location and settings template catalog support storing user data on any writable share. To ensure high availability, follow these criteria:
|
||||
|
||||
- Format the storage volume with an NTFS file system.
|
||||
- The share can use Distributed File System (DFS) replication, but Distributed File System Replication (DFSR) isn't supported. Distributed File System Namespaces (DFSN) are supported. For detailed information, see:
|
||||
- [Deploying Roaming User Profiles](/windows-server/storage/folder-redirection/deploy-roaming-user-profiles)
|
||||
- [Information about Microsoft support policy for a DFS-R and DFS-N deployment scenario](/troubleshoot/windows-server/networking/support-policy-for-dfsr-dfsn-deployment)
|
||||
|
||||
In addition, because SYSVOL uses DFSR for replication, SYSVOL can't be used for UE-V data file replication.
|
||||
|
||||
- Configure the share permissions and NTFS access control lists (ACLs) as specified in [Deploying the settings storage location for UE-V](uev-deploy-required-features.md).
|
||||
- Use file server clustering along with the UE-V service to provide access to copies of user state data if communications failures occur.
|
||||
- You can store the settings storage path data (user data) and settings template catalog templates on clustered shares, on DFSN shares, or on both.
|
||||
|
||||
### Synchronize computer clocks for UE-V settings synchronization
|
||||
|
||||
Computers that run the UE-V service must use a time server to maintain a consistent settings experience. UE-V uses time stamps to determine if settings must be synchronized from the settings storage location. If the computer clock is inaccurate, older settings can overwrite newer settings, or the new settings might not be saved to the settings storage location.
|
||||
|
||||
## Confirm prerequisites and supported configurations for UE-V
|
||||
|
||||
Before you proceed, ensure that your environment meets these requirements for using UE-V.
|
||||
|
||||
| Operating system | Edition | Service pack | System architecture | Windows PowerShell | Microsoft .NET Framework |
|
||||
|--|--|--|--|--|--|
|
||||
| Windows 10, version 1607 | Windows 10 for Enterprise | NA | 32-bit or 64-bit | Windows PowerShell 3.0 or higher | .NET Framework 4.5 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 or higher |
|
||||
| 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 |
|
||||
|
||||
> [!NOTE]
|
||||
> - Windows Server 2012 operating systems come with .NET Framework 4.5 installed. The Windows 10 operating system comes with .NET Framework 4.6 installed.
|
||||
> - The "Delete Roaming Cache" policy for mandatory profiles isn't supported with UE-V and shouldn't be used.
|
||||
|
||||
There are no special random access memory (RAM) requirements specific to UE-V.
|
||||
|
||||
### Synchronization of settings through the Sync Provider
|
||||
|
||||
Sync Provider is the default setting for users and synchronizes a local cache with the settings storage location in these instances:
|
||||
|
||||
- Log on/log off
|
||||
- Lock/unlock
|
||||
- Remote desktop connect/disconnect
|
||||
- Application open/close
|
||||
|
||||
A scheduled task manages this synchronization of settings every 30 minutes or through trigger events for certain applications. For more information, see [Changing the frequency of UE-V scheduled tasks](uev-changing-the-frequency-of-scheduled-tasks.md).
|
||||
|
||||
The UE-V service synchronizes user settings for devices that aren't always connected to the enterprise network (remote devices and laptops) and devices that are always connected to the network (devices that run Windows Server and host virtual desktop interface (VDI) sessions).
|
||||
|
||||
**Synchronization for computers with always-available connections** When you use UE-V on devices that are always connected to the network, you must configure the UE-V service to synchronize settings by using the *SyncMethod=None* parameter, which treats the settings storage server as a standard network share. In this configuration, the UE-V service can be configured to notify if the import of the application settings is delayed.
|
||||
|
||||
Enable this configuration using one of these methods:
|
||||
|
||||
- After you enable the UE-V service, use the Settings Management feature in Microsoft Configuration Manager or the UE-V ADMX templates (installed with Windows 10, version 1607) to push the SyncMethod = None configuration.
|
||||
- Use Windows PowerShell or Windows Management Instrumentation (WMI) to set the SyncMethod = None configuration.
|
||||
|
||||
Restart the device to allow the settings to synchronize.
|
||||
|
||||
> [!NOTE]
|
||||
> These methods do not work for pooled virtual desktop infrastructure (VDI) environments.
|
||||
|
||||
> [!NOTE]
|
||||
> If you set *SyncMethod = None*, any settings changes are saved directly to the server. If the network connection to the settings storage path is not found, 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 log off, settings changes are lost and the user must reapply the change when the computer is reconnected to the settings storage path.
|
||||
|
||||
**Synchronization for external sync engines** The *SyncMethod=External* parameter specifies that if UE-V settings are written to a local folder on the user device, 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 devices that users access.
|
||||
|
||||
**Support for shared VDI sessions** UE-V supports VDI sessions that are shared among end users. You can register and configure a special VDI template, which ensures that UE-V keeps all of its functionality intact for non-persistent VDI sessions.
|
||||
|
||||
> [!NOTE]
|
||||
> If you do not enable VDI mode for non-persistent VDI sessions, certain features do not work, such as [back-up/restore and last known good (LKG)](uev-manage-administrative-backup-and-restore.md).
|
||||
|
||||
The VDI template is provided with UE-V and is typically available here after installation: C:\ProgramData\Microsoft\UEV\InboxTemplates
|
||||
|
||||
### Prerequisites for UE-V template generator support
|
||||
|
||||
Install the UE-V template generator on the device that is used to create custom settings location templates. This device should be able to run the applications that you want to synchronize settings for. You must be a member of the Administrators group on the device that runs the UE-V template generator software.
|
||||
|
||||
The UE-V template generator must be installed on a device that uses an NTFS file system. The UE-V template generator software requires .NET Framework 1. For more information, see [Use UE-V with custom applications](uev-deploy-uev-for-custom-applications.md).
|
||||
|
||||
## Other resources for this feature
|
||||
|
||||
- [User Experience Virtualization overview](uev-for-windows.md)
|
||||
- [Get started with UE-V](uev-getting-started.md)
|
||||
- [Upgrade to UE-V for Windows 10](uev-upgrade-uev-from-previous-releases.md)
|
||||
- [Administering UE-V](uev-administering-uev.md)
|
||||
- [Troubleshooting UE-V](uev-troubleshooting.md)
|
||||
- [Technical Reference for UE-V](uev-technical-reference.md)
|
||||
@ -1,100 +0,0 @@
|
||||
---
|
||||
title: User Experience Virtualization (UE-V) Release Notes
|
||||
description: Read the latest information required to successfully install and use User Experience Virtualization (UE-V) that isn't included in the UE-V documentation.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# User Experience Virtualization (UE-V) Release Notes
|
||||
|
||||
This topic includes information required to successfully install and use UE-V that isn't included in the User Experience Virtualization (UE-V) documentation. If there are differences between the information in this topic and other UE-V topics, the latest change should be considered authoritative.
|
||||
|
||||
### Company Settings Center removed in UE-V for Windows 10, version 1607
|
||||
|
||||
In previous versions of UE-V, users could select which of their customized application settings to synchronize with the Company Settings Center, a user interface that was available on user devices. Additionally, administrators could configure the Company Settings Center to include a link to support resources so that users could easily get support on virtualized settings-related issues.
|
||||
|
||||
With the release of Windows 10, version 1607, the Company Settings Center was removed and users can no longer manage their synchronized settings.
|
||||
|
||||
Administrators can still define which user-customized application settings can synchronize (roam) with Group Policy or Windows PowerShell.
|
||||
|
||||
> [!NOTE]
|
||||
> With the removal of the Company Settings Center, the following group policies are no longer applicable:
|
||||
>
|
||||
> - Contact IT Link Text
|
||||
> - Contact IT URL
|
||||
> - Tray Icon
|
||||
|
||||
### Upgrading from UE-V 1.0 to the in-box version of UE-V is blocked
|
||||
|
||||
Version 1.0 of UE-V used Offline Files (Client-Side Caching) for settings synchronization and pinned the UE-V sync folder to be available when the network was offline, however, this technology was removed in UE-V 2.x. As a result, UE-V 1.0 users are blocked from upgrading to UE-V for Windows 10, version 1607.
|
||||
|
||||
WORKAROUND: Remove the UE-V 1.0 sync folder from the Offline Files configuration and then upgrade to the in-box version of UE-V for Windows, version 1607 release.
|
||||
|
||||
### UE-V settings location templates for Skype cause Skype to crash
|
||||
|
||||
When a user generates a valid settings location template for the Skype desktop application, registers it, and then launches the Skype desktop application, Skype crashes. An ACCESS\_VIOLATION is recorded in the Application Event Log.
|
||||
|
||||
WORKAROUND: Remove or unregister the Skype template to allow Skype to work again.
|
||||
|
||||
### Registry settings don't synchronize between App-V and native applications on the same device
|
||||
|
||||
When a device has an application that is installed through both Application Virtualization (App-V) and locally with a Windows Installer (.msi) file, the registry-based settings don't synchronize between the technologies.
|
||||
|
||||
WORKAROUND: To resolve this problem, run the application by selecting one of the two technologies, but not both.
|
||||
|
||||
### Unpredictable results when both Office 2010 and Office 2013 are installed on the same device
|
||||
|
||||
When a user has both Office 2010 and Office 2013 installed, any common settings between the two versions of Office are roamed by UE-V. This roaming could cause the Office 2010 package size to be large or result in unpredictable conflicts with 2013, particularly if Office 365 is used.
|
||||
|
||||
WORKAROUND: Install only one version of Office or limit which settings are synchronized by UE-V.
|
||||
|
||||
### Uninstallation and reinstallation of Windows 8 applications reverts settings to initial state
|
||||
|
||||
While UE-V settings synchronization is being used for a Windows 8 application, if the user uninstalls the application and then reinstalls the application, the application's settings revert to their default values. This result happens because the uninstall removes the local (cached) copy of the application's settings but doesn't remove the local UE-V settings package. When the application is reinstalled and launched, UE-V gathers the application settings that were reset to the application defaults and then uploads the default settings to the central storage location. Other computers running the application then download the default settings. This behavior is identical to the behavior of desktop applications.
|
||||
|
||||
WORKAROUND: None.
|
||||
|
||||
### UE-V doesn't support roaming settings between 32-bit and 64-bit versions of Microsoft Office
|
||||
|
||||
We recommend that you install the 32-bit version of Microsoft Office for both 32-bit and 64-bit operating systems. To choose the Microsoft Office version that you need, click [here](<https://office.microsoft.com/word-help/choose-the-32-bit-or-64-bit-version-of-microsoft-office-HA010369476.aspx>). UE-V supports roaming settings between identical architecture versions of Office. For example, 32-bit Office settings will roam between all 32-bit Office instances. UE-V doesn't support roaming settings between 32-bit and 64-bit versions of Office.
|
||||
|
||||
WORKAROUND: None
|
||||
|
||||
### Favicons that are associated with Internet Explorer 9 favorites don't roam
|
||||
|
||||
The favicons that are associated with Internet Explorer 9 favorites aren't roamed by User Experience Virtualization and don't appear when the favorites first appear on a new computer.
|
||||
|
||||
WORKAROUND: Favicons will appear with their associated favorites once the bookmark is used and cached in the Internet Explorer 9 browser.
|
||||
|
||||
### File settings paths are stored in registry
|
||||
|
||||
Some application settings store the paths of their configuration and settings files as values in the registry. The files that are referenced as paths in the registry must be synchronized when settings are roamed between computers.
|
||||
|
||||
WORKAROUND: Use folder redirection or some other technology to ensure that any files that are referenced as file settings paths are present and placed in the same location on all computers where settings roam.
|
||||
|
||||
### Long Settings Storage Paths could cause an error
|
||||
|
||||
Keep settings storage paths as short as possible. Long paths could prevent resolution or synchronization. UE-V uses the Settings storage path as part of the calculated path to store settings. That path is calculated in the following way: settings storage path + "settingspackages" + package dir (template ID) + package name (template ID) + .pkgx. If that calculated path exceeds 260 characters, package storage will fail and generate the following error message in the UE-V operational event log:
|
||||
|
||||
\[boost::filesystem::copy\_file: The system can't find the path specified\]
|
||||
|
||||
To check the operational log events, open the Event Viewer and navigate to Applications and Services Logs / Microsoft / User Experience Virtualization / Logging / Operational.
|
||||
|
||||
WORKAROUND: None.
|
||||
|
||||
### Some operating system settings only roam between like operating system versions
|
||||
|
||||
Operating system settings for Narrator and currency characters specific to the locale (that is, language and regional settings) will only roam across like operating system versions of Windows. For example, currency characters won't roam between Windows 7 and Windows 8.
|
||||
|
||||
WORKAROUND: None
|
||||
|
||||
**Additional resources for this feature**
|
||||
|
||||
- [UE-V Registry Settings](/troubleshoot/windows-client/ue-v/ue-v-registry-settings)
|
||||
- [How To Enable Debug Logging in Microsoft User Experience Virtualization (UE-V)](/troubleshoot/windows-client/ue-v/enable-debug-logging)
|
||||
- [User Experience Virtualization](uev-for-windows.md)
|
||||
- [Prepare a UE-V Deployment](uev-prepare-for-deployment.md)
|
||||
- [Upgrade to UE-V for Windows 10](uev-upgrade-uev-from-previous-releases.md)
|
||||
- [Administering UE-V](uev-administering-uev.md)
|
||||
- [Troubleshooting UE-V](uev-troubleshooting.md)
|
||||
- [Technical Reference for UE-V](uev-technical-reference.md)
|
||||
@ -1,119 +0,0 @@
|
||||
---
|
||||
title: Security Considerations for UE-V
|
||||
description: Learn about accounts and groups, log files, and other security-related considerations for User Experience Virtualization (UE-V).
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Security Considerations for UE-V
|
||||
|
||||
This topic contains a brief overview of accounts and groups, log files, and other security-related considerations for User Experience Virtualization (UE-V). For more information, follow the links that are provided here.
|
||||
|
||||
## Security considerations for UE-V configuration
|
||||
|
||||
> [!IMPORTANT]
|
||||
> When you create the settings storage share, limit the share access to users who require access.
|
||||
|
||||
Because settings packages might contain personal information, you should take care to protect them as much as possible. In general, do the following steps:
|
||||
|
||||
- Restrict the share to only those users who require access. Create a security group for users who have redirected folders on a particular share and limit access to only those users.
|
||||
- When you create the share, hide the share by putting a $ after the share name. This addition hides the share from casual browsers, and the share isn't visible in My Network Places.
|
||||
- Only give users the minimum number of permissions that they must have. The following tables show the required permissions.
|
||||
|
||||
1. Set the following share-level SMB permissions for the setting storage location folder.
|
||||
|
||||
|User account|Recommended permissions|
|
||||
|--- |--- |
|
||||
|Everyone|No permissions|
|
||||
|Security group of UE-V|Full control|
|
||||
|
||||
1. Set the following NTFS file system permissions for the settings storage location folder.
|
||||
|
||||
|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|
|
||||
|
||||
1. Set the following share-level SMB permissions for the settings template catalog folder.
|
||||
|
||||
|User account|Recommend permissions|
|
||||
|--- |--- |
|
||||
|Everyone|No permissions|
|
||||
|Domain computers|Read permission Levels|
|
||||
|Administrators|Read/write permission levels|
|
||||
|
||||
1. Set the following NTFS permissions for the settings template catalog folder.
|
||||
|
||||
|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|
|
||||
|
||||
### Use Windows Server as of Windows Server 2003 to host redirected file shares
|
||||
|
||||
User settings package files contain personal information that is transferred between the client computer and the server that stores the settings packages. Because of this process, you should ensure that the data is protected while it travels over the network.
|
||||
|
||||
User settings data is vulnerable to these potential threats: interception of the data as it passes over the network, tampering with the data as it passes over the network, and spoofing of the server that hosts the data.
|
||||
|
||||
As of Windows Server 2003, several features of the Windows Server operating system can help secure user data:
|
||||
|
||||
- **Kerberos** - Kerberos is standard on all versions of Microsoft Windows 2000 Server and Windows Server beginning with Windows Server 2001. Kerberos ensures the highest level of security to network resources. NTLM authenticates the client only; Kerberos authenticates the server and the client. When NTLM is used, the client doesn't know whether the server is valid. This difference is important if the client exchanges personal files with the server, as is the case with Roaming User Profiles. Kerberos provides better security than NTLM. Kerberos isn't available on the Microsoft Windows NT Server 4.0 or earlier operating systems.
|
||||
|
||||
- **IPsec** - The IP Security Protocol (IPsec) provides network-level authentication, data integrity, and encryption. IPsec ensures that:
|
||||
|
||||
- Roamed data is safe from data modification while data is en route.
|
||||
- Roamed data is safe from interception, viewing, or copying.
|
||||
- Roamed data is safe from access by unauthenticated parties.
|
||||
|
||||
- **SMB Signing** - The Server Message Block (SMB) authentication protocol supports message authentication, which prevents active message and "man-in-the-middle" attacks. SMB signing provides this authentication by placing a digital signature into each SMB. The digital signature is then verified by both the client and the server. In order to use SMB signing, you must first either enable it, or you must require it on both the SMB client and the SMB server. The SMB signing imposes a performance penalty. It doesn't consume any more network bandwidth, but it uses more CPU cycles on the client and server side.
|
||||
|
||||
### Always use the NTFS file system for volumes that hold user data
|
||||
|
||||
For the most secure configuration, configure servers that host the UE-V settings files to use the NTFS file system. Unlike the FAT file system, NTFS supports Discretionary access control lists (DACLs) and system access control lists (SACLs). DACLs and SACLs control who can perform operations on a file and what events trigger the logging of actions that is performed on a file.
|
||||
|
||||
### Don't rely on EFS to encrypt user files when they're transmitted over the network
|
||||
|
||||
When you use the Encrypting File System (EFS) to encrypt files on a remote server, the encrypted data isn't encrypted during transit over the network; it only becomes encrypted when it's stored on disk.
|
||||
|
||||
This encryption process doesn't apply when your system includes Internet Protocol security (IPsec) or Web Distributed Authoring and Versioning (WebDAV). IPsec encrypts data while it's transported over a TCP/IP network. If the file is encrypted before it's copied or moved to a WebDAV folder on a server, it remains encrypted during the transmission and while it's stored on the server.
|
||||
|
||||
### Let the UE-V service create folders for each user
|
||||
|
||||
To ensure that UE-V works optimally, create only the root share on the server, and let the UE-V service create the folders for each user. UE-V creates these user folders with the appropriate security.
|
||||
|
||||
This permission configuration enables users to create folders for settings storage. The UE-V service creates and secures a settings package folder while it runs in the context of the user. Users receive full control to their settings package folder. Other users don't inherit access to this folder. You don't have to create and secure individual user directories. The UE-V service that runs in the context of the user does it automatically.
|
||||
|
||||
> [!NOTE]
|
||||
> Additional security can be configured when a Windows Server is used for the settings storage share. UE-V can be configured to verify that either the local Administrators group or the current user is the owner of the folder where settings packages are stored. To enable additional security, use the following command:
|
||||
|
||||
1. Add the REG\_DWORD registry key RepositoryOwnerCheckEnabled to `HKEY_LOCAL_MACHINE\Software\Microsoft\UEV\Agent\Configuration`.
|
||||
1. Set the registry key value to *1*.
|
||||
|
||||
When this configuration setting is in place, the UE-V service verifies that the local Administrators group or current user is the owner of the settings package folder. If not, then the UE-V service doesn't grant access to the folder.
|
||||
|
||||
If you must create folders for the users, ensure that you have the correct permissions set.
|
||||
|
||||
We strongly recommend that you don't pre-create folders. Instead, let the UE-V service create the folder for the user.
|
||||
|
||||
### Ensure correct permissions to store UE-V 2 settings in a home directory or custom directory
|
||||
|
||||
If you redirect UE-V settings to a user's home directory or a custom Active Directory (AD) directory, ensure that the permissions on the directory are set appropriately for your organization.
|
||||
|
||||
### Review the contents of settings location templates and control access to them as needed
|
||||
|
||||
When a settings location template is being created, the UE-V generator uses a Lightweight Directory Access Protocol (LDAP) query to get username and email address of the current logged in user. This information is stored in the template as the template author name and template author email. (None of this information is sent to Microsoft.)
|
||||
|
||||
If you plan to share settings location templates with anyone outside your organization, you should review all the settings locations and ensure the settings location templates don't contain any personal or company information. You can view the contents by opening the settings location template files using any XML viewer. The following are ways you can view and remove any personal or company information from the settings location template files before sharing with anyone outside your company:
|
||||
|
||||
- **Template Author Name** - Specify a general, non-identifying name for the template author name or exclude this data from the template.
|
||||
- **Template Author Email** - Specify a general, non-identifying template author email or exclude this data from the template.
|
||||
|
||||
To remove the template author name or template author email, you can use the UE-V generator application. From the generator, select **Edit a Settings Location Template**. Select the settings location template to edit from the recently used templates or Browse to the settings template file. Select **Next** to continue. On the Properties page, remove the data from the Template author name or Template author email text fields. Save the settings location template.
|
||||
|
||||
## Related topics
|
||||
|
||||
[Technical Reference for UE-V](uev-technical-reference.md)
|
||||
@ -1,26 +0,0 @@
|
||||
---
|
||||
title: Sync Methods for UE-V
|
||||
description: Learn how User Experience Virtualization (UE-V) service sync methods let you synchronize users' application and Windows settings with the settings storage location.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Sync Methods for UE-V
|
||||
|
||||
The User Experience Virtualization (UE-V) service lets you synchronize users' application and Windows settings with the settings storage location. The *Sync Method* configuration defines how the UE-V service uploads and downloads those settings to the settings storage location. UE-V includes a SyncMethod called the *SyncProvider*. For more information about trigger events that start the synchronization of application and Windows settings, see [Sync Trigger Events for UE-V](uev-sync-trigger-events.md).
|
||||
|
||||
## SyncMethod Configuration
|
||||
|
||||
This table provides a description of each SyncMethod configuration:
|
||||
|
||||
| **SyncMethod Configuration** | **Description** |
|
||||
|--|--|
|
||||
| SyncProvider (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.<br>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.<br>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. |
|
||||
| External | 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 | This configuration setting is designed for the Virtual Desktop Infrastructure (VDI) and Streamed Application experience primarily. This setting should be used on computers running the Windows Server operating system in a datacenter, where the connection will always be available.<br>Any settings changes are saved directly to the server. If the network connection to the settings storage path isn't 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 isn't found and the user profile is removed from a pooled VDI environment on sign out, then these settings changes are lost, and the user must reapply the change when the computer can again reach the settings storage path.<br>Apps and OS will wait indefinitely for the location to be present. This waiting period could cause App load or OS sign-in time to dramatically increase if the location isn't found. |
|
||||
|
||||
You can configure the sync method in these ways:
|
||||
|
||||
- Through [Group Policy](uev-configuring-uev-with-group-policy-objects.md) settings
|
||||
- With the [Configuration Manager Pack](uev-configuring-uev-with-system-center-configuration-manager.md) for UE-V
|
||||
- With [Windows PowerShell or Windows Management Instrumentation (WMI)](uev-administering-uev-with-windows-powershell-and-wmi.md)
|
||||
@ -1,31 +0,0 @@
|
||||
---
|
||||
title: Sync Trigger Events for UE-V
|
||||
description: Learn how User Experience Virtualization (UE-V) lets you synchronize your application and Windows settings across all your domain-joined devices.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Sync Trigger Events for UE-V
|
||||
|
||||
User Experience Virtualization (UE-V) lets you synchronize your application and Windows settings across all your domain-joined devices. *Sync trigger events* define when the UE-V service synchronizes those settings with the settings storage location. For more information about Sync Method configuration, see [Sync Methods for UE-V](uev-sync-methods.md).
|
||||
|
||||
## UE-V Sync Trigger Events
|
||||
|
||||
The following table explains the trigger events for classic applications and Windows settings.
|
||||
|
||||
|UE-V Trigger Event|SyncMethod=SyncProvider|SyncMethod=None|
|
||||
|--- |--- |--- |
|
||||
|**Windows Logon**|<li>Application and Windows settings are imported to the local cache from the settings storage location.<li>[Asynchronous Windows settings](uev-prepare-for-deployment.md#windows-settings-synchronized-by-default) are applied.<li>Synchronous Windows settings will be applied during the next Windows logon.<li>Application settings will be applied when the application starts.|<li>Application and Windows settings are read directly from the settings storage location.<li>Asynchronous and synchronous Windows settings are applied.<li>Application settings will be applied when the application starts.|
|
||||
|**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.<p>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.<p>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**|Application and Windows settings are synchronized between the settings storage location and the local cache.<br><div class="alert">**Note** Settings changes are not cached locally until an application closes. This trigger will not export changes made to a currently running application.<p>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).</div><p>Settings are applied in these cases:<li>Asynchronous Windows settings are applied directly.<li>Application settings are applied when the application starts.<li>Both asynchronous and synchronous Windows settings are applied during the next Windows logon.<li>Windows app (AppX) settings are applied during the next refresh. See [Monitor Application Settings](uev-changing-the-frequency-of-scheduled-tasks.md#monitor-application-settings) for more information.|NA|
|
||||
|**Asynchronous Settings updated on remote store***|Load and apply new asynchronous settings from the cache.|Load and apply settings from central server|
|
||||
|
||||
## Related topics
|
||||
|
||||
[Technical Reference for UE-V](uev-technical-reference.md)
|
||||
[Changing the Frequency of UE-V Scheduled Tasks](uev-changing-the-frequency-of-scheduled-tasks.md)
|
||||
[Choose the Configuration Method for UE-V](uev-deploy-required-features.md)
|
||||
@ -1,45 +0,0 @@
|
||||
---
|
||||
title: Synchronizing Microsoft Office with UE-V
|
||||
description: Learn how User Experience Virtualization (UE-V) supports the synchronization of Microsoft Office application settings.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Synchronizing Office with UE-V
|
||||
|
||||
Microsoft User Experience Virtualization (UE-V) supports the synchronization of Microsoft Office application settings. The combination of UE-V and App-V support for Office enables the same experience on virtualized instances of Office from any UE-V-enabled device or virtualized desktop.
|
||||
|
||||
## Microsoft Office support in UE-V
|
||||
|
||||
UE-V includes settings location templates for Microsoft Office 2016, 2013, and 201. In previous versions of UE-V, settings location templates for Office 2013 and Office 2010 were distributed and registered when you installed the UE-V agent. Now that UE-V is a feature in Windows 10, version 1607, settings location templates are installed when you install or upgrade to the new operating system.
|
||||
|
||||
These templates help synchronize users' Office experience between devices. Microsoft Office 2016 settings roamed by Office 365 experience aren't included in these settings. For a list of Office 365-specific settings, see [Overview of user and roaming settings for Office](/previous-versions/office/office-2013-resource-kit/jj733593(v=office.15)).
|
||||
|
||||
## Synchronized Office Settings
|
||||
|
||||
Review the following tables for details about Office support in UE-V:
|
||||
|
||||
### Supported UE-V templates for Microsoft Office
|
||||
|
||||
|Office 2016 templates (UE-V for Windows 10 and Windows 10, version 1607, available in UE-V gallery)|Office 2013 templates (UE-V for Windows 10 and UE-V 2.x, available on UE-V gallery)|Office 2010 templates (UE-V 1.0 and 1.0 SP1)|
|
||||
|--- |--- |--- |
|
||||
|MicrosoftOffice2016Win32.xml<p>MicrosoftOffice2016Win64.xml<p>MicrosoftSkypeForBusiness2016Win32.xml<p>MicrosoftSkypeForBusiness2016Win64.xml|MicrosoftOffice2013Win32.xml<p>MicrosoftOffice2013Win64.xml<p>MicrosoftLync2013Win32.xml<p>MicrosoftLync2013Win64.xml|MicrosoftOffice2010Win32.xml<p>MicrosoftOffice2010Win64.xml<p>MicrosoftLync2010.xml|
|
||||
|
||||
### Microsoft Office Applications supported by the UE-V templates
|
||||
|
||||
|2016|2013|2010|
|
||||
|--- |--- |--- |
|
||||
|Microsoft Access 2016<p>Microsoft Lync 2016<p>Microsoft Excel 2016<p>Microsoft OneNote 2016<p>Microsoft Outlook 2016<p>Microsoft PowerPoint 2016<p>Microsoft Project 2016<p>Microsoft Publisher 2016<p>Microsoft SharePoint Designer 2013 (not updated for 2016)<p>Microsoft Visio 2016<p>Microsoft Word 2016<p>Microsoft Office Upload Manager|Microsoft Access 2013<p>Microsoft Lync 2013<p>Microsoft Excel 2013<p>Microsoft InfoPath 2013<p>Microsoft OneNote 2013<p>Microsoft Outlook 2013<p>Microsoft PowerPoint 2013<p>Microsoft Project 2013<p>Microsoft Publisher 2013<p>Microsoft SharePoint Designer 2013<p>Microsoft Visio 2013<p>Microsoft Word 2013<p>Microsoft Office Upload Manager|Microsoft Access 2010<p>Microsoft Lync 2010<p>Microsoft Excel 2010<p>Microsoft InfoPath 2010<p>Microsoft OneNote 2010<p>Microsoft Outlook 2010<p>Microsoft PowerPoint 2010<p>Microsoft Project 2010<p>Microsoft Publisher 2010<p>Microsoft SharePoint Designer 2010<p>Microsoft Visio 2010<p>Microsoft Word 2010|
|
||||
|
||||
## Deploying Office templates
|
||||
|
||||
You can deploy UE-V settings location template with the following methods:
|
||||
|
||||
- **Registering template with PowerShell**. If you use Windows PowerShell to manage computers, run the following Windows PowerShell command as Administrator to register this settings location template:
|
||||
```powershell
|
||||
Register-UevTemplate -Path <Path_to_Template>
|
||||
```
|
||||
|
||||
For more information about using UE-V and Windows PowerShell, see [Managing UE-V settings location templates using Windows PowerShell and WMI](uev-managing-settings-location-templates-using-windows-powershell-and-wmi.md).
|
||||
- **Registering template with Template Catalog Path**. If you use the Settings Template Catalog Path to manage templates on users' computers, copy the Office template into the folder defined in the UE-V service. The next time the Template Auto Update (ApplySettingsCatalog.exe) scheduled task runs, the settings location template will be registered on the device. For more information, see [Deploy a settings template catalog](uev-deploy-uev-for-custom-applications.md).
|
||||
- **Registering template with Configuration Manager**. If you use Configuration Manager to manage your UE-V settings storage templates, recreate the Template Baseline CAB, import it into Configuration Manager, and then deploy the baseline to user devices.
|
||||
@ -1,31 +0,0 @@
|
||||
---
|
||||
title: Technical Reference for UE-V
|
||||
description: Use this technical reference to learn about the various features of User Experience Virtualization (UE-V).
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Technical Reference for UE-V
|
||||
|
||||
This technical reference section includes additional technical documentation about the various features of User Experience Virtualization (UE-V). This information is provided to help the administrator better understand UE-V.
|
||||
|
||||
## Technical reference topics for UE-V
|
||||
|
||||
- [Sync Methods for UE-V](uev-sync-methods.md)
|
||||
Defines how UE-V synchronizes settings between computers and the settings storage location. Sync Provider is the default sync method for UE-V. This topic includes technical reference information for sync methods, including the Sync Provider.
|
||||
- [Sync Trigger Events for UE-V](uev-sync-trigger-events.md)
|
||||
Defines when the UE-V service synchronizes those settings with the settings storage location. This topic provides technical reference information about when synchronization takes place based upon the sync method deployed.
|
||||
- [Synchronizing Microsoft Office with UE-V](uev-synchronizing-microsoft-office-with-uev.md)
|
||||
Provides guidance for downloading and enabling the Microsoft-authored UE-V settings location templates that support Microsoft Office settings synchronization.
|
||||
- [Application Template Schema Reference for UE-V](uev-application-template-schema-reference.md)
|
||||
Details the XML structure of UE-V settings location templates and provides guidance for editing these files.
|
||||
- [Security Considerations for UE-V](uev-security-considerations.md)
|
||||
Provides a brief overview of accounts, groups, and other security-related considerations for UE-V.
|
||||
|
||||
## Other resources for this feature
|
||||
|
||||
- [User Experience Virtualization overview](uev-for-windows.md)
|
||||
- [Get Started with UE-V](uev-getting-started.md)
|
||||
- [Prepare a UE-V Deployment](uev-prepare-for-deployment.md)
|
||||
- [Administering UE-V](uev-administering-uev.md)
|
||||
- [Troubleshooting UE-V](uev-troubleshooting.md)
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: Troubleshooting UE-V
|
||||
description: Use this technical reference to find resources for troubleshooting User Experience Virtualization (UE-V) for Windows 10.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Troubleshooting UE-V
|
||||
|
||||
For information that can help with troubleshooting UE-V for Windows 10, see:
|
||||
|
||||
- [UE-V FAQ Wiki](https://social.technet.microsoft.com/wiki/contents/articles/35333.ue-v-important-changes-in-ue-v-functionality-after-the-windows-10-anniversary-update.aspx)
|
||||
- [UE-V: List of Microsoft Support Knowledge Base Articles](https://social.technet.microsoft.com/wiki/contents/articles/14271.ue-v-list-of-microsoft-support-knowledge-base-articles.aspx)
|
||||
- [User Experience Virtualization Release Notes](uev-release-notes-1607.md)
|
||||
- [Technical Reference for UE-V](uev-technical-reference.md)
|
||||
- [UE-V TechNet Forum](https://social.technet.microsoft.com/Forums/home?forum=mdopuev&filter=alltypes&sort=lastpostdesc)
|
||||
|
||||
## Other resources
|
||||
|
||||
- [User Experience Virtualization overview](uev-for-windows.md)
|
||||
- [Get Started with UE-V](uev-getting-started.md)
|
||||
- [Prepare a UE-V deployment](uev-prepare-for-deployment.md)
|
||||
- [Administering UE-V](uev-administering-uev.md)
|
||||
@ -1,86 +0,0 @@
|
||||
---
|
||||
title: Upgrade to UE-V for Windows 10
|
||||
description: Use these few adjustments to upgrade from User Experience Virtualization (UE-V) 2.x to the latest version of UE-V.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Upgrade to UE-V for Windows 10
|
||||
|
||||
If you're already using UE-V 2.x and you're planning to upgrade user devices to Windows 10, version 1607 or later releases, you need to make only a few adjustments to your existing environment. These steps are explained in more detail below.
|
||||
|
||||
1. Upgrade user devices to Windows 10, version 1607 or later release.
|
||||
1. Verify that UE-V settings were migrated correctly.
|
||||
1. Set the template storage path to your current template store.
|
||||
1. Enable the UE-V service on user devices.
|
||||
1. Install the UE-V template generator if you want to synchronize application settings for custom applications.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> You can upgrade your existing UE-V installation to Windows 10, version 1607 from UE-V versions 2.1 or 2.0 only. If you are using a previous version of UE-V, you'll need to upgrade from that version to UE-V 2.x before you upgrade to Windows 10, version 1607.
|
||||
|
||||
## Upgrade user devices to Windows 10, version 1607
|
||||
|
||||
Performing an in-place upgrade on user devices automatically installs the UE-V service, updates the settings location path, and migrates users' UE-V settings. See the [Windows 10 documentation for IT Pros](/windows/deployment/) for information about upgrading user devices to Windows 10.
|
||||
|
||||
## Verify that UE-V settings were migrated correctly
|
||||
|
||||
After upgrading a user device to Windows 10, version 1607, it's important to verify that UE-V settings and template registrations were migrated correctly during the upgrade. You can verify UE-V settings using Windows PowerShell or the device's registry.
|
||||
|
||||
**To verify UE-V settings using Windows PowerShell**
|
||||
|
||||
1. Run PowerShell as Administrator, type **Get-UEVConfiguration**, and press ENTER to view current configurations.
|
||||
1. Check that the settings were successfully updated.
|
||||
1. Type **Get-UEVTemplate** and press ENTER to check that your templates are still registered.
|
||||
|
||||
> [!NOTE]
|
||||
> You'll need to register the NotePad template again after you upgrade the device to Windows 1.
|
||||
|
||||
**To verify UE-V settings using the device's registry**
|
||||
|
||||
1. In a command prompt, run **Regedit** as Administrator.
|
||||
1. Navigate to **HKEY_LOCAL_MACHINE\Software\Microsoft\UEV\Agent\Configuration.**
|
||||
1. Verify that the settings storage path and the settings template catalog path are pointing to the same locations as before you upgraded the device to Windows 10.
|
||||
|
||||
## Set the template storage path to your current template store
|
||||
|
||||
Template Settings Storage Path will not automatically migrate. Run Set-UEVConfiguration in PowerShell or use the settings storage path Group Policy to configure and point to your current settings storage folder.
|
||||
|
||||
## Enable the UE-V service on user devices
|
||||
|
||||
The UE-V service is the client-side component that captures user-personalized application and Windows settings and saves them in settings packages. Settings packages are built, locally stored, and copied to the settings storage location.
|
||||
|
||||
With Windows 10, version 1607 and later, the UE-V service replaces the UE-V Agent and no longer requires a separate download and installation. Enable the service on user devices to start using UE-V. You can enable the service with the Group Policy editor or with Windows PowerShell.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The UE-V Agent used in prior releases of UE-V is replaced with the UE service. The UE-V service included with Windows 10, version 1607 and later releases, does not include the agent user interface and is configurable through cmdlets or registry settings only.
|
||||
|
||||
**To enable the UE-V service with Group Policy**
|
||||
|
||||
1. Open the device's **Group Policy Editor**
|
||||
1. Navigate to **Computer Configuration > Administrative Templates > Windows Components > Microsoft User Experience Virtualization**
|
||||
1. Run **Enable UEV**
|
||||
1. Restart the device
|
||||
|
||||
**To enable the UE-V service with Windows PowerShell**
|
||||
|
||||
1. Run PowerShell as Administrator, type **Enable-UEV**, and press ENTER
|
||||
1. Restart the device
|
||||
1. Type **Get-UEVStatus** and press ENTER to verify that the service was successfully enabled
|
||||
|
||||
## Install the UE-V template generator
|
||||
|
||||
The UE-V template generator is included in the Windows Assessment and Deployment Kit (ADK) for Windows 10.
|
||||
|
||||
**To install the UE-V template generator**
|
||||
|
||||
1. Select the **Get Windows ADK for Windows 10** button on this page to start the ADK installer. On the screen pictured below, select **Microsoft User Experience Virtualization (UE-V) Template Generator** and then select **Install**
|
||||
|
||||
1. To open the generator, open the **Start** menu and navigate to **Windows Kits** > **Microsoft User Experience Virtualization (UE-V) Template Generator**
|
||||
|
||||
## Other resources for this feature
|
||||
|
||||
- [UE-V Release Notes](uev-release-notes-1607.md)
|
||||
- [Prepare a UE-V Deployment](uev-prepare-for-deployment.md)
|
||||
- [Administer UE-V](uev-administering-uev.md)
|
||||
- [Migrating settings packages](uev-migrating-settings-packages.md)
|
||||
- [Technical Reference for UE-V](uev-technical-reference.md)
|
||||
@ -1,30 +0,0 @@
|
||||
---
|
||||
title: Using UE-V with Application Virtualization applications
|
||||
description: Learn how to use User Experience Virtualization (UE-V) with Microsoft Application Virtualization (App-V).
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Using UE-V with Application Virtualization applications
|
||||
|
||||
User Experience Virtualization (UE-V) supports Microsoft Application Virtualization (App-V) applications without any required modifications to either the App-V package or the UE-V template. However, another step is required because you can't run the UE-V template generator directly on a virtualized App-V application. Instead, you must install the application locally, generate the template, and then apply the template to the virtualized application. UE-V supports App-V for Windows 10 packages and App-V 5.0 packages.
|
||||
|
||||
## UE-V settings synchronization for App-V applications
|
||||
|
||||
UE-V monitors when an application opens by the program name and, optionally, by file version numbers and product version numbers, whether the application is installed locally or virtually by using App-V. When the application starts, UE-V monitors the App-V process, applies any settings that are stored in the user's settings storage path, and then enables the application to start normally. UE-V monitors App-V applications and automatically translates the relevant file and registry paths to the virtualized location as opposed to the physical location outside the App-V computing environment.
|
||||
|
||||
**To implement settings synchronization for a virtualized application**
|
||||
|
||||
1. Run the UE-V template generator to collect the settings of the locally installed application whose settings you want to synchronize between computers. This process creates a settings location template. If you use a built-in template such as a Microsoft Office template, skip this step. For more information about using the UE-V template generator, see [Deploy UE-V for custom applications](uev-deploy-uev-for-custom-applications.md).
|
||||
1. Install the App-V application package if you haven't already done so.
|
||||
|
||||
1. Publish the template to the location of your settings template catalog or manually install the template by using the `Register-UEVTemplate` Windows PowerShell cmdlet.
|
||||
|
||||
> [!NOTE]
|
||||
> If you publish the newly created template to the settings template catalog, the client does not receive the template until the sync provider updates the settings. To manually start this process, open **Task Scheduler**, expand **Task Scheduler Library**, expand **Microsoft**, and expand **UE-V**. In the results pane, right-click **Template Auto Update**, and then click **Run**.
|
||||
|
||||
1. Start the App-V package.
|
||||
|
||||
## Related topics
|
||||
|
||||
[Administering UE-V](uev-administering-uev.md)
|
||||
@ -1,111 +0,0 @@
|
||||
---
|
||||
title: What's New in UE-V for Windows 10, version 1607
|
||||
description: Learn about what's new in User Experience Virtualization (UE-V) for Windows 10, including new features and capabilities.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# What's new in UE-V
|
||||
|
||||
User Experience Virtualization (UE-V) for Windows 10, version 1607, includes these new features and capabilities compared to UE-V 2.1. For more information about the UE-V for Windows 10, version 1607 release, see [UE-V Release notes](uev-release-notes-1607.md).
|
||||
|
||||
## UE-V is a feature in Windows 10
|
||||
|
||||
With Windows 10, version 1607 and later releases, UE-V is included with Windows Enterprise. It's no longer part of the Microsoft Desktop Optimization Pack.
|
||||
|
||||
The changes in UE-V for Windows 10, version 1607 impact already existing implementations of UE-V in the following ways:
|
||||
|
||||
- The UE-V Agent is replaced by the UE-V service. The UE-V service is installed with Windows 10, version 1607 and no longer has to be deployed separately. Performing an in-place upgrade to Windows 10, version 1607, on user devices automatically installs the UE-V service, migrates users' UE-V configurations, and updates the settings storage path.
|
||||
- The UE-V template generator is available from the Windows 10 ADK. In previous releases of UE-V, the template generator was included in the Microsoft Desktop Optimization Pack. Although you'll need to use the new template generator to create new settings location templates, existing settings location templates will continue to work.
|
||||
- The Company Settings Center was removed and is no longer available on user devices. Users can no longer manage their synchronized settings.
|
||||
- The inbox templates such as Office 2016 and IE 10 are included as a part of Windows 10 and need to be manually registered with Powershell or Group policy before use.
|
||||
|
||||
For more information about how to configure an existing UE-V installation after upgrading user devices to Windows 10, see [Upgrade to UE-V for Windows 10](uev-upgrade-uev-from-previous-releases.md).
|
||||
|
||||
> [!IMPORTANT]
|
||||
> You can upgrade your existing UE-V installation to Windows 10 from UE-V versions 2.1 or 2.0 only. If you are using a previous version of UE-V, you'll need to upgrade from that version to UE-V 2.x before you upgrade to Windows 10.
|
||||
|
||||
## New UE-V template generator is available from the Windows 10 ADK
|
||||
|
||||
UE-V for Windows 10 includes a new template generator, available from a new location. If you're upgrading from an existing UE-V installation, you'll need to use the new generator to create settings location templates. The UE-V for Windows 10 template generator is now available in the [Windows 10 Assessment and Deployment Kit](https://developer.microsoft.com/windows/hardware/windows-assessment-deployment-kit) (Windows ADK).
|
||||
|
||||
## Company Settings Center removed in UE-V for Windows 10, version 1607
|
||||
|
||||
In previous versions of UE-V, users could select which of their customized application settings to synchronize with the Company Settings Center, a user interface that was available on user devices. Additionally, administrators could configure the Company Settings Center to include a link to support resources so that users could easily get support on virtualized settings-related issues.
|
||||
|
||||
With the release of Windows 10, version 1607, the Company Settings Center was removed and users can no longer manage their synchronized settings.
|
||||
|
||||
Administrators can still define which user-customized application settings can synchronize (roam) with Group Policy or Windows PowerShell.
|
||||
|
||||
>[!Note]
|
||||
>With the removal of the Company Settings Center, the following group policies are no longer applicable:
|
||||
|
||||
- Contact IT Link Text
|
||||
- Contact IT URL
|
||||
- Tray Icon
|
||||
|
||||
## Compatibility with Microsoft Enterprise State Roaming
|
||||
|
||||
With Windows 10, version 1607, users can synchronize Windows application settings and Windows operating system settings to Azure instead of to OneDrive. You can use the Windows 10 enterprise sync functionality together with UE-V for on-premises domain-joined devices only.
|
||||
|
||||
In hybrid cloud environments, UE-V can roam Win32 applications on-premises while [Enterprise State Roaming](/azure/active-directory/devices/enterprise-state-roaming-overview) (ESR) can roam the rest, for example, Windows and desktop settings, themes, colors, and so on, to an Azure cloud installation.
|
||||
|
||||
To configure UE-V to roam Windows desktop and application data only, change the following group policies:
|
||||
|
||||
- Disable "Roam Windows settings" group policy
|
||||
- Enable "Do not synchronize Windows Apps" group policy
|
||||
|
||||
For more information about using UE-V with Enterprise State Roaming, see [Settings and data roaming FAQ](/azure/active-directory/devices/enterprise-state-roaming-faqs#what-are-the-roaming-settings-options-for-existing-windows-desktop-applications-).
|
||||
|
||||
Additionally, to enable Windows 10 and UE-V to work together, configure these policy settings in the Microsoft User Experience Virtualization node:
|
||||
|
||||
- Enable "Do Not Synchronize Windows Apps"
|
||||
- Disable "Sync Windows Settings"
|
||||
|
||||
## Settings Synchronization Behavior Changed in UE-V for Windows 10
|
||||
|
||||
While earlier versions of UE-V roamed taskbar settings between Windows 10 devices, UE-V for Windows 10, version 1607 doesn't synchronize taskbar settings between devices running Windows 10 and devices running previous versions of Windows.
|
||||
|
||||
In addition, UE-V for Windows has removed support for the Windows calculator application.
|
||||
|
||||
The Windows modern apps settings (DontSyncWindows8AppSettings) group policy is enabled by default and therefore, modern apps won't roam unless this policy is changed to disabled.
|
||||
|
||||
> [!NOTE]
|
||||
> UE-V will roam any AppX apps that use the WinRT settings roaming API, if they've been opted in to roam at the time of development by the developer so there is no definitive list.
|
||||
|
||||
## Support Added for Roaming Network Printers
|
||||
|
||||
Users can now print to their saved network printers from any network device, including their default network printer.
|
||||
|
||||
Printer roaming in UE-V requires one of these scenarios:
|
||||
|
||||
- The print server can download the required driver when it roams to a new device.
|
||||
- The driver for the roaming network printer is pre-installed on any device that needs to access that network printer.
|
||||
- The printer driver can be imported from Windows Update.
|
||||
|
||||
> [!NOTE]
|
||||
> The UE-V printer roaming feature doesn't roam printer settings or preferences, such as printing double-sided.
|
||||
|
||||
## Office 2016 Settings Location Template
|
||||
|
||||
UE-V for Windows 10, version 1607 includes the Microsoft Office 2016 settings location template with improved Outlook signature support. We've added synchronization of default signature settings for new, reply, and forwarded emails. Users no longer have to choose the default signature settings.
|
||||
|
||||
> [!NOTE]
|
||||
> An Outlook profile must be created on any device on which a user wants to synchronize 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.
|
||||
|
||||
UE-V works with Office 365 to determine whether Office 2016 settings are roamed by Office 361. If settings are roamed by Office 365, they aren't roamed by UE-V. For more information, see [Overview of user and roaming settings for Microsoft Office](/previous-versions/office/office-2013-resource-kit/jj733593(v=office.15)).
|
||||
|
||||
To enable settings synchronization using UE-V, do one of the following steps:
|
||||
|
||||
- Use Group Policy to disable Office 365 synchronization
|
||||
- Don't enable the Office 365 synchronization experience during Office 2013 installation
|
||||
|
||||
UE-V includes Office 2016, Office 2013, and Office 2010 templates.
|
||||
|
||||
## Related topics
|
||||
|
||||
- [Microsoft User Experience Virtualization](uev-for-windows.md)
|
||||
- [Get Started with UE-V](uev-getting-started.md)
|
||||
- [Prepare a UE-V Deployment](uev-prepare-for-deployment.md)
|
||||
- [User Experience Virtualization (UE-V) Release Notes](uev-release-notes-1607.md) for Windows 10, version 1607
|
||||
- [Upgrade to UE-V for Windows 10](uev-upgrade-uev-from-previous-releases.md)
|
||||
@ -1,104 +0,0 @@
|
||||
---
|
||||
title: Working with Custom UE-V Templates and the UE-V Template Generator
|
||||
description: Create your own custom settings location templates by working with Custom User Experience Virtualization (UE-V) Templates and the UE-V Template Generator.
|
||||
ms.date: 1/25/2024
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Working with custom UE-V templates and the UE-V template generator
|
||||
|
||||
User Experience Virtualization (UE-V) uses XML files called ***settings location templates*** to monitor and synchronize application settings and Windows settings between user devices. By default, some settings location templates are included in UE-V. However, if you want to synchronize settings for desktop applications other than those settings included in the default templates, you can create your own custom settings location templates with the UE-V template generator. You can also edit or validate custom settings location templates with the UE-V template generator.
|
||||
|
||||
Use the UE-V template generator to monitor, discover, and capture the locations where Win32 applications store settings. The template generator doesn't create settings location templates for the following types of applications:
|
||||
|
||||
- Virtualized applications
|
||||
- Applications that are offered through Terminal Services
|
||||
- Java applications
|
||||
- Windows applications
|
||||
|
||||
## Standard and non-standard settings locations
|
||||
|
||||
The UE-V template generator helps you identify where applications search for settings files and registry settings that applications use to store settings information. The generator discovers settings only in locations that are accessible to a standard user. Settings that are stored in other locations are excluded.
|
||||
|
||||
Discovered settings are grouped into two categories: **Standard** and **Non-standard**. Standard settings are recommended for synchronization, and UE-V can readily capture and apply them. Non-standard settings can potentially synchronize settings but, because of the rules that UE-V uses, these settings might not consistently or dependably synchronize settings. These settings might depend on temporary files, result in unreliable synchronization, or might not be useful. These settings locations are presented in the UE-V template generator. You can choose to include or exclude them on a case-by-case basis.
|
||||
|
||||
The UE-V template generator opens the application as part of the discovery process. The generator can capture settings in the following locations:
|
||||
|
||||
- **Registry Settings** - Registry locations under **HKEY_CURRENT_USER**
|
||||
- **Application Settings Files** - Files that are stored under \ **Users** \ [User name] \ **AppData** \ **Roaming**
|
||||
|
||||
The UE-V template generator excludes locations, which commonly store application software files, but don't synchronize well between user computers or environments. The UE-V template generator excludes these locations. Excluded locations are as follows:
|
||||
|
||||
- HKEY_CURRENT_USER registry keys and files to which the logged-on user can't write values
|
||||
- HKEY_CURRENT_USER registry keys and files that are associated with the core functionality of the Windows operating system
|
||||
- All registry keys that are located in the HKEY_LOCAL_MACHINE hive, which requires administrator rights and might require to set a User Account Control (UAC) agreement
|
||||
- Files that are located in Program Files directories, which requires administrator rights and might require to set a UAC agreement
|
||||
- Files that are located under Users \ [User name] \ AppData \ LocalLow
|
||||
- Windows operating system files that are located in %Systemroot%, which requires administrator rights and might require to set a UAC agreement
|
||||
|
||||
If registry keys and files that are stored in these locations are required to synchronize application settings, you can manually add the excluded locations to the settings location template during the template creation process.
|
||||
|
||||
## <a href="" id="edit"></a>Edit settings location templates with the UE-V template generator
|
||||
|
||||
Use the UE-V template generator to edit settings location templates. When the revised settings are added to the templates with the UE-V template generator, the version information within the template is automatically updated to ensure that any existing templates that are deployed in the enterprise are updated correctly.
|
||||
|
||||
### To edit a UE-V settings location template with the UE-V template generator
|
||||
|
||||
1. Open the **Start** menu and navigate to **Windows Kits** > **Microsoft User Experience Virtualization (UE-V) Template Generator** to open the template generator.
|
||||
1. Click **Edit a settings location template**.
|
||||
1. In the list of recently used templates, select the template to be edited. Alternatively, click **Browse** to search for the settings template file. Click **Next** to continue.
|
||||
1. Review the **Properties**, **Registry** locations, and **Files** locations for the settings template. Edit as required.
|
||||
|
||||
- On the **Properties** tab, you can view and edit the following properties:
|
||||
|
||||
- **Application name** The application name that is written in the description of the program file properties.
|
||||
|
||||
- **Program name** The name of the program that is taken from the program file properties. This name usually has the .exe file name extension.
|
||||
|
||||
- **Product version** The product version number of the .exe file of the application. This property, together with the **File version**, helps determine which applications are targeted by the settings location template. This property accepts a major version number. If this property is empty, then the settings location template applies to all versions of the product.
|
||||
|
||||
- **File version** The file version number of the .exe file of the application. This property, along with the **Product version**, helps determine which applications are targeted by the settings location template. This property accepts a major version number. If this property is empty, the settings location template applies to all versions of the program.
|
||||
|
||||
- **Template author name** (optional) The name of the settings template author.
|
||||
|
||||
- **Template author email** (optional) The email address of the settings location template author.
|
||||
|
||||
- The **Registry** tab lists the **Key** and **Scope** of the registry locations that are included in the settings location template. You can edit the registry locations by using the **Tasks** drop-down menu. In the Tasks menu, you can add new keys, edit the name or scope of existing keys, delete keys, and browse the registry in which the keys are located. When you define the scope for the registry, you can use the **All Settings** scope to include all the registry settings under the specified key. Use **All Settings** and **Subkeys** to include all the registry settings under the specified key, subkeys, and subkey settings.
|
||||
|
||||
- The **Files** tab lists the file path and file mask of the file locations that are included in the settings location template. You can edit the file locations by using the **Tasks** drop-down menu. In the **Tasks** menu for file locations, you can add new files or folder locations, edit the scope of existing files or folders, delete files or folders, and open the selected location in Windows Explorer. To include all files in the specified folder, leave the file mask empty.
|
||||
|
||||
1. Click **Save** to save the changes to the settings location template.
|
||||
1. Click **Close** to close the Settings Template Wizard. Exit the UE-V template generator application.
|
||||
|
||||
After you edit the settings location template for an application, you should test the template. Deploy the revised settings location template in a lab environment before you put it into production in the enterprise.
|
||||
|
||||
### How to manually edit a settings location template
|
||||
|
||||
1. Create a local copy of the settings location template .xml file. UE-V settings location templates are .xml files that identify the locations where application store settings values.
|
||||
> [!NOTE]
|
||||
> A settings location template is unique because of the template **ID**. If you copy the template and rename the .xml file, template registration fails because UE-V reads the template **ID** tag in the .xml file to determine the name, not the file name of the .xml file. UE-V also reads the **Version** number to know if anything has changed. If the version number is higher, UE-V updates the template.
|
||||
1. Open the settings location template file with an XML editor.
|
||||
1. Edit the settings location template file. All changes must conform to the UE-V schema file that is defined in [SettingsLocationTempate.xsd](uev-application-template-schema-reference.md). By default, a copy of the .xsd file is located in \ProgramData\Microsoft\UEV\Templates.
|
||||
1. Increment the **Version** number for the settings location template.
|
||||
1. Save the settings location template file, and then close the XML editor.
|
||||
1. Validate the modified settings location template file by using the UE-V template generator.
|
||||
1. You must register the edited UE-V settings location template before it can synchronize settings between client computers. To register a template, open Windows PowerShell, and then run the following cmdlet: `update-uevtemplate [templatefilename]`. You can then copy the file to the settings storage catalog. The UE-V Agent on users' computers should then update as scheduled in the scheduled task.
|
||||
|
||||
## <a href="" id="validate"></a>Validate settings location templates with the UE-V template generator
|
||||
|
||||
It's possible to create or edit settings location templates in an XML editor without using the UE-V template generator. If you do, you can use the UE-V template generator to validate that the new or revised XML matches the schema that has been defined for the template.
|
||||
|
||||
To validate a UE-V settings location template with the UE-V template generator:
|
||||
|
||||
1. Open the **Start** menu and navigate to **Windows Kits** > **Microsoft User Experience Virtualization (UE-V) Template Generator** to open the template generator.
|
||||
1. Click **Validate a settings location template**.
|
||||
1. In the list of recently used templates, select the template to be edited. Alternatively, you can **Browse** to the settings template file. Click **Next** to continue.
|
||||
1. Click **Validate** to continue.
|
||||
1. Click **Close** to close the Settings Template Wizard. Exit the UE-V template generator application.
|
||||
|
||||
After you validate the settings location template for an application, you should test the template. Deploy the template in a lab environment before you put it into a production environment in enterprise.
|
||||
|
||||
## Related topics
|
||||
|
||||
[Administering UE-V](uev-administering-uev.md)
|
||||
[Use UE-V with custom applications](uev-deploy-uev-for-custom-applications.md)
|
||||
@ -68,7 +68,7 @@ Windows Enterprise edition has many features that are unavailable in Windows Pro
|
||||
|Device Guard|This feature is a combination of hardware and software security features that allows only trusted applications to run on a device. Even if an attacker manages to get control of the Windows kernel, they're much less likely to run executable code. Device Guard can use virtualization-based security (VBS) in Windows Enterprise edition to isolate the Code Integrity service from the Windows kernel itself. With VBS, even if malware gains access to the kernel, the effects can be severely limited, because the hypervisor can prevent the malware from executing code.<br><br>Device Guard protects in the following ways:<li>Helps protect against malware<li>Helps protect the Windows system core from vulnerability and zero-day exploits<li>Allows only trusted apps to run<br><br>For more information, see [Introduction to Device Guard](/windows/security/application-security/application-control/introduction-to-device-guard-virtualization-based-security-and-windows-defender-application-control).|
|
||||
|AppLocker management|This feature helps IT pros determine which applications and files users can run on a device. The applications and files that can be managed include executable files, scripts, Windows Installer files, dynamic-link libraries (DLLs), packaged apps, and packaged app installers.<br><br>For more information, see [AppLocker](/windows/security/threat-protection/windows-defender-application-control/applocker/applocker-overview).|
|
||||
|Application Virtualization (App-V)|This feature makes applications available to end users without installing the applications directly on users' devices. App-V transforms applications into centrally managed services that are never installed and don't conflict with other applications. This feature also helps ensure that applications are kept current with the latest security updates.<br><br>For more information, see [Getting started with App-V for Windows client](/windows/application-management/app-v/appv-getting-started).|
|
||||
|User Experience Virtualization (UE-V)|With this feature, user-customized Windows and application settings can be captured and stored on a centrally managed network file share.<br><br>When users sign in, their personalized settings are applied to their work session, regardless of which device or virtual desktop infrastructure (VDI) sessions they sign into.<br><br>UE-V provides the following features:<li>Specify which application and Windows settings synchronize across user devices<li>Deliver the settings anytime and anywhere users work throughout the enterprise<li>Create custom templates for line-of-business applications<li>Recover settings after hardware replacement or upgrade, or after reimaging a virtual machine to its initial state<br><br>For more information, see [User Experience Virtualization (UE-V) overview](/windows/configuration/ue-v/uev-for-windows).|
|
||||
|User Experience Virtualization (UE-V)|With this feature, user-customized Windows and application settings can be captured and stored on a centrally managed network file share.<br><br>When users sign in, their personalized settings are applied to their work session, regardless of which device or virtual desktop infrastructure (VDI) sessions they sign into.<br><br>UE-V provides the following features:<li>Specify which application and Windows settings synchronize across user devices<li>Deliver the settings anytime and anywhere users work throughout the enterprise<li>Create custom templates for line-of-business applications<li>Recover settings after hardware replacement or upgrade, or after reimaging a virtual machine to its initial state<br><br>For more information, see [User Experience Virtualization (UE-V) overview](/microsoft-desktop-optimization-pack/ue-v/uev-for-windows).|
|
||||
|Managed User Experience|This feature helps customize and lock down a Windows device's user interface to restrict it to a specific task. For example, a device can be configured for a controlled scenario such as a kiosk or classroom device. The user experience would be automatically reset once a user signs off. Access to services such as the Windows Store can also be restricted. For Windows 10, Start layout options can also be managed, such as:<li>Removing and preventing access to the Shut Down, Restart, Sleep, and Hibernate commands<li>Removing Log Off (the User tile) from the Start menu<li>Removing frequent programs from the Start menu<li>Removing the All Programs list from the Start menu<li>Preventing users from customizing their Start screen<li>Forcing Start menu to be either full-screen size or menu size<li>Preventing changes to Taskbar and Start menu settings|
|
||||
|
||||
## Deployment of Windows Enterprise E3 licenses
|
||||
@ -166,9 +166,9 @@ UE-V requires server and client-side components that need to be downloaded, acti
|
||||
|
||||
For more information about deploying UE-V, see the following resources:
|
||||
|
||||
- [User Experience Virtualization (UE-V) overview](/windows/configuration/ue-v/uev-for-windows)
|
||||
- [Get Started with UE-V](/windows/configuration/ue-v/uev-getting-started)
|
||||
- [Prepare a UE-V Deployment](/windows/configuration/ue-v/uev-prepare-for-deployment)
|
||||
- [User Experience Virtualization (UE-V) overview](/microsoft-desktop-optimization-pack/ue-v/uev-for-windows)
|
||||
- [Get Started with UE-V](/microsoft-desktop-optimization-pack/ue-v/uev-getting-started)
|
||||
- [Prepare a UE-V Deployment](/microsoft-desktop-optimization-pack/ue-v/uev-prepare-for-deployment)
|
||||
|
||||
### Managed User Experience
|
||||
|
||||
|
||||
@ -168,7 +168,7 @@ With User Experience Virtualization (UE-V), you can capture user-customized Wind
|
||||
|
||||
With the release of this version of Windows 10, UE-V is included with the Windows 10 for Enterprise edition. If you're new to Windows 10 and UE-V or upgrading from a previous version of UE-V, you'll need to download, activate, and install server- and client-side components to start synchronizing user-customized settings across devices.
|
||||
|
||||
[Learn how to synchronize user-customized settings with UE-V.](/windows/configuration/ue-v/uev-for-windows)
|
||||
[Learn how to synchronize user-customized settings with UE-V.](/microsoft-desktop-optimization-pack/ue-v/uev-for-windows)
|
||||
|
||||
## Microsoft Edge
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user