Configuring UE-V with Microsoft Configuration Manager

  • Article
  • Applies to:
    ✅ Windows 10

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
  2. 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:
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.
  2. Run this command on a machine running the ConfigMgr Admin Console: 
    C:\Program Files (x86)\Microsoft User Experience Virtualization\ConfigPack\UevAgentPolicyGenerator.exe -Site ABC -CabFilePath "C:\MyCabFiles\UevPolicyItem.cab" -ConfigurationFile "c:\AgentConfiguration.xml"
  3. 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.
  2. Run the command from Step 3 in Create the First UE-V Policy Configuration Item. If you changed the name with the PolicyName parameter, make sure you enter the same name.
  3. 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.
  2. 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
  3. 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:
 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
  2. Copy the template to your master template directory
  3. Run the command in the .bat file that you created in Step 3 in Create the First UE-V Template Baseline
  4. Import the generated CAB file into ConfigMgr using the console or PowerShell Import-CMBaseline

Manage Configurations for UE-V