diff --git a/.openpublishing.redirection.windows-configuration.json b/.openpublishing.redirection.windows-configuration.json index e791302494..b5f046f434 100644 --- a/.openpublishing.redirection.windows-configuration.json +++ b/.openpublishing.redirection.windows-configuration.json @@ -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 } ] -} \ No newline at end of file +} diff --git a/windows/configuration/toc.yml b/windows/configuration/toc.yml index 27cec371e7..97c229350a 100644 --- a/windows/configuration/toc.yml +++ b/windows/configuration/toc.yml @@ -22,4 +22,4 @@ items: - name: Windows Configuration Designer href: wcd/toc.yml - name: User Experience Virtualization (UE-V) - href: ue-v/toc.yml \ No newline at end of file + href: /microsoft-desktop-optimization-pack/ue-v/uev-for-windows \ No newline at end of file diff --git a/windows/configuration/ue-v/images/uev-adk-select-uev-feature.png b/windows/configuration/ue-v/images/uev-adk-select-uev-feature.png deleted file mode 100644 index 1556f115c0..0000000000 Binary files a/windows/configuration/ue-v/images/uev-adk-select-uev-feature.png and /dev/null differ diff --git a/windows/configuration/ue-v/images/uev-archdiagram.png b/windows/configuration/ue-v/images/uev-archdiagram.png deleted file mode 100644 index eae098e666..0000000000 Binary files a/windows/configuration/ue-v/images/uev-archdiagram.png and /dev/null differ diff --git a/windows/configuration/ue-v/images/uev-checklist-box.gif b/windows/configuration/ue-v/images/uev-checklist-box.gif deleted file mode 100644 index 8af13c51d1..0000000000 Binary files a/windows/configuration/ue-v/images/uev-checklist-box.gif and /dev/null differ diff --git a/windows/configuration/ue-v/images/uev-deployment-preparation.png b/windows/configuration/ue-v/images/uev-deployment-preparation.png deleted file mode 100644 index b665a0bfea..0000000000 Binary files a/windows/configuration/ue-v/images/uev-deployment-preparation.png and /dev/null differ diff --git a/windows/configuration/ue-v/images/uev-generator-process.png b/windows/configuration/ue-v/images/uev-generator-process.png deleted file mode 100644 index e16cedd0a7..0000000000 Binary files a/windows/configuration/ue-v/images/uev-generator-process.png and /dev/null differ diff --git a/windows/configuration/ue-v/toc.yml b/windows/configuration/ue-v/toc.yml deleted file mode 100644 index 8da6a3d8d4..0000000000 --- a/windows/configuration/ue-v/toc.yml +++ /dev/null @@ -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 diff --git a/windows/configuration/ue-v/uev-administering-uev-with-windows-powershell-and-wmi.md b/windows/configuration/ue-v/uev-administering-uev-with-windows-powershell-and-wmi.md deleted file mode 100644 index 1c79ab5948..0000000000 --- a/windows/configuration/ue-v/uev-administering-uev-with-windows-powershell-and-wmi.md +++ /dev/null @@ -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) diff --git a/windows/configuration/ue-v/uev-administering-uev.md b/windows/configuration/ue-v/uev-administering-uev.md deleted file mode 100644 index 40669d9a7a..0000000000 --- a/windows/configuration/ue-v/uev-administering-uev.md +++ /dev/null @@ -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) - diff --git a/windows/configuration/ue-v/uev-application-template-schema-reference.md b/windows/configuration/ue-v/uev-application-template-schema-reference.md deleted file mode 100644 index 33f11ea8eb..0000000000 --- a/windows/configuration/ue-v/uev-application-template-schema-reference.md +++ /dev/null @@ -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) - -### 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: - -`` - -### 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 - -``` - -### Data types - -These data types are the ones for the UE-V application template schema. - -**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. - -**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). - -**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 (\[^\\\\\\?\\\*\\|<>/:\]+). - -**TemplateVersion** -TemplateVersion is an integer value used to describe the revision of the settings location template. Its value may range from 0 to 2147483647. - -**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. - -**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. - -**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. - -**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. - -**Architecture** -Architecture enumerates two possible values: **Win32** and **Win64**. These values are used to specify process architecture. - -**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| - -**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. - -**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. - -**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. - -**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**. - -**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. - -**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.| - -### 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 `My Application` rather than `My Application 1.1`. - -> [!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 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. - -### 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 `MicrosoftOffice2016Win64`. - -### 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 `2.5` aren't allowed. - -> [!TIP] -> You can save notes about version changes using XML comment tags ``, for example: - -```xml - -4 -``` - -> [!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 - -### 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. - -### Processes and Process Element - -**Mandatory: True** -**Type: Element** - -Processes contain at least one `` 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 - - MyApplication.exe - Win64 - MyApplication - MyApplication.exe - - - - - - - - - - - - - -``` - -### 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, `MyApplication.exe` should be specified instead of `MyApplication`. 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 - - MyApplication.exe - My Application 6.x by Contoso.com - - - - -``` - -### 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 - - - - MyApplication.exe - My Application Main Engine - - - - - - MyApplicationHelper.exe - My Application Background Process Executable - - - - - -``` - -### 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 - - - - -``` - -**Example 2:** - -File version: 5.0.2.1000 specified in the UE-V template generator produces the following XML: - -```xml - - - - - - -``` - -**Incorrect Example 1 - incomplete range:** - -Only the Minimum attribute is present. Maximum must be included in a range as well. - -```xml - - - -``` - -**Incorrect Example 2 - Minor specified without Major element:** - -Only the Minor element is present. Major must be included as well. - -```xml - - - -``` - -### 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 - - MSACCESS.EXE - Win32 - - - - - - - - - -``` - -### 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)".| - -### 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).| - -### 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.| - -### Appendix: SettingsLocationTemplate.xsd - -Here's the SettingsLocationTemplate.xsd file showing its elements, child elements, attributes, and parameters: - -```xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -``` - -## 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) diff --git a/windows/configuration/ue-v/uev-changing-the-frequency-of-scheduled-tasks.md b/windows/configuration/ue-v/uev-changing-the-frequency-of-scheduled-tasks.md deleted file mode 100644 index 6a92f5dd46..0000000000 --- a/windows/configuration/ue-v/uev-changing-the-frequency-of-scheduled-tasks.md +++ /dev/null @@ -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) diff --git a/windows/configuration/ue-v/uev-configuring-uev-with-group-policy-objects.md b/windows/configuration/ue-v/uev-configuring-uev-with-group-policy-objects.md deleted file mode 100644 index c238ec602f..0000000000 --- a/windows/configuration/ue-v/uev-configuring-uev-with-group-policy-objects.md +++ /dev/null @@ -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.
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).
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.
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) diff --git a/windows/configuration/ue-v/uev-configuring-uev-with-system-center-configuration-manager.md b/windows/configuration/ue-v/uev-configuring-uev-with-system-center-configuration-manager.md deleted file mode 100644 index 6aa403bde3..0000000000 --- a/windows/configuration/ue-v/uev-configuring-uev-with-system-center-configuration-manager.md +++ /dev/null @@ -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** - -**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: - - **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. - - **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. - - **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**. - - **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. - - **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. - -## 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. - -### 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) diff --git a/windows/configuration/ue-v/uev-deploy-required-features.md b/windows/configuration/ue-v/uev-deploy-required-features.md deleted file mode 100644 index a349f9b2a3..0000000000 --- a/windows/configuration/ue-v/uev-deploy-required-features.md +++ /dev/null @@ -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) diff --git a/windows/configuration/ue-v/uev-deploy-uev-for-custom-applications.md b/windows/configuration/ue-v/uev-deploy-uev-for-custom-applications.md deleted file mode 100644 index 6018becc89..0000000000 --- a/windows/configuration/ue-v/uev-deploy-uev-for-custom-applications.md +++ /dev/null @@ -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. - - - -![Selecting UE-V features in ADK.](images/uev-adk-select-uev-feature.png) - -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) diff --git a/windows/configuration/ue-v/uev-for-windows.md b/windows/configuration/ue-v/uev-for-windows.md deleted file mode 100644 index e65d123596..0000000000 --- a/windows/configuration/ue-v/uev-for-windows.md +++ /dev/null @@ -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. - -UE-V architecture, with server share, desktop, and UE-V service - - - -| **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.
The setting values for **desktop applications** are stored when the user closes the application.
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.
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).
**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.
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.
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).
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.
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). | - - - -![UE-V template generator process.](images/uev-generator-process.png) - -## 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). diff --git a/windows/configuration/ue-v/uev-getting-started.md b/windows/configuration/ue-v/uev-getting-started.md deleted file mode 100644 index 03d142d4b2..0000000000 --- a/windows/configuration/ue-v/uev-getting-started.md +++ /dev/null @@ -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) diff --git a/windows/configuration/ue-v/uev-manage-administrative-backup-and-restore.md b/windows/configuration/ue-v/uev-manage-administrative-backup-and-restore.md deleted file mode 100644 index 48e3c7c959..0000000000 --- a/windows/configuration/ue-v/uev-manage-administrative-backup-and-restore.md +++ /dev/null @@ -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 -Profile -``` - -- <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 -``` - -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 -` |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 `|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) diff --git a/windows/configuration/ue-v/uev-manage-configurations.md b/windows/configuration/ue-v/uev-manage-configurations.md deleted file mode 100644 index 8dbec4a9b6..0000000000 --- a/windows/configuration/ue-v/uev-manage-configurations.md +++ /dev/null @@ -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) diff --git a/windows/configuration/ue-v/uev-managing-settings-location-templates-using-windows-powershell-and-wmi.md b/windows/configuration/ue-v/uev-managing-settings-location-templates-using-windows-powershell-and-wmi.md deleted file mode 100644 index a87fb622e4..0000000000 --- a/windows/configuration/ue-v/uev-managing-settings-location-templates-using-windows-powershell-and-wmi.md +++ /dev/null @@ -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 `|Lists all the settings location templates that are registered on the computer where the application name or template name contains.| - |`Get-UevTemplate -TemplateID `|Lists all the settings location templates that are registered on the computer where the template ID contains.| - |`Get-UevTemplate [-ApplicationOrTemplateID] `|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]