Key (Standard 8 Module Reference)

Article
09/29/2016

7/8/2014

Review the applicable Embedded Core modules and any examples for the Key setting in Windows Embedded 8 Standard (Standard 8).

This setting contains an IP address, firewall name, domain name, or volume.

Do not create an empty value for this setting.

Modules

The following table shows the modules that you can apply this setting to. In Image Configuration Editor (ICE), you can follow the corresponding path to set this setting for a module.

Module	Path	Setting Description
Windows 8 Application Launcher	Features/Branding/Windows 8 Application Launcher/UserSettings/User/Key	Contains a positive integer that identifies a User configuration for Windows 8 Application Launcher. Each User item must have a unique key. Keys are often assigned to each User item sequentially beginning with 1.
Enhanced Write Filter Management Tool	Features/Lockdown/Compatibility Write Filters/Enhanced Write Filter Management Tool/ProtectedVolumes/Volume/Key	Contains a positive integer that identifies a Volume protected by Enhanced Write Filter (EWF) within ProtectedVolumes. Each Volume item must have a unique key. Keys are often assigned to each Volume item sequentially beginning with 1.
Enhanced Write Filter	Features/Lockdown/Compatibility Write Filters/Enhanced Write Filter/ProtectedVolumes/Volume/Key	Contains a positive integer that identifies a Volume protected by EWF within ProtectedVolumes. Each Volume item must have a unique key. Keys are often assigned to each Volume item sequentially beginning with 1.
File Based Write Filter Management Tool	Features/Lockdown/Compatibility Write Filters/File Based Write Filter Management Tool/ProtectedVolumes/Volume/Key	Contains a positive integer that identifies a Volume protected by File-Based Write Filter (FBWF) within ProtectedVolumes. Each Volume item must have a unique key. Keys are often assigned to each Volume item sequentially beginning with 1.
File Based Write Filter	Features/Lockdown/Compatibility Write Filters/File Based Write Filter/ProtectedVolumes/Volume/Key	Contains a positive integer that identifies a Volume protected by FBWF within ProtectedVolumes. Each Volume item must have a unique key. Keys are often assigned to each Volume item sequentially beginning with 1.
Shell Launcher	Features/Shell/Shell Launcher/UserSettings/User/Key	Contains a positive integer that identifies a User configuration for Shell Launcher. Each User item must have a unique key. Keys are often assigned to each User item sequentially beginning with 1.
Setup	Products/Embedded Core/Setup/ImageInstall/DataImage/InstallFrom/MetaData/Key	Specifies whether to use the image index, name, or description to identify the Windows image (.wim) file to install. Use this setting with Value. The following table shows the possible values. ValueDescription /IMAGE/INDEXUses the index number to identify the image to install. /IMAGE/NAMEUses the name to identify the image to install. /IMAGE/DESCRIPTIONUses the description to identify the image to install.
Setup	Products/Embedded Core/Setup/ImageInstall/OSImage/InstallFrom/MetaData/Key	Specifies whether to use the image index, name, or description to identify the Windows image (.wim) file to install. Use this setting with Value. The following table shows the possible values. ValueDescription /IMAGE/INDEXUses the index number to identify the image to install. /IMAGE/NAMEUses the name to identify the image to install. /IMAGE/DESCRIPTIONUses the description to identify the image to install.
Setup	Products/Embedded Core/Setup/UserData/ProductKey/Key	Contains the 29-character product key to apply to an installation of Standard 8. You must always specify a value for this setting. The product key that you use to activate the installation must match the number on the Certificate of Authenticity (COA) sticker that accompanies the retail product or that is physically attached to the device case by the OEM. Standard licensing agreements specify that you can use a product key only to activate one installation of Standard 8 on one device. Windows Activation enforces this requirement.
Shell-Setup	Products/Embedded Core/Shell-Setup/StartTiles/RegionalOverrides/RegionalOverride/Regions/Region/Key	Specifies a unique value for each region within a regional override. Use this setting when specifying a set of region-specific apps that appear on the Start and Lock screens.

XML Example

These examples show how to specify a key value.

Device Driver Paths

The following XML example shows how to specify a location for Microsoft device drivers. If you configure this setting in the PnpCustomizationsWinPE module, drivers in this path are copied to the Standard 8 image during the windowsPE configuration pass. If you configure this setting in thePnpCustomizationsNonWinPE module, they are copied during the auditSystem configuration pass.

<PathAndCredentials wcm:action="add" wcm:keyValue="1">
    <Path>\\myFirstDriverPath\DriversFolder</Path>
</PathAndCredentials>

For XML examples that show how to set the key values for multiple paths, see PnpCustomizationsWinPE XML Example and PnpCustomizationsNonWinPE XML Example.

Shell Launcher

The following XML example shows how to specify a key for a user.

<Key>1</Key>

Setup ProductKey

For an XML example that shows how to set user data, including how to set the product key to activate the installation,see User Data XML Example.

Write Filter ProtectedVolumes

The following XML example shows how to assign the volume with a key value. You can assign a volume with a key value in the Enhanced Write Filter and File Based Write Filter modules.

<Volume wcm:action="add">
   <key>2</key>
</Volume>

Networking Firewall Groups

The following XML example shows how to assign a Windows Firewall group with a key value.

<FirewallGroups>
   <FirewallGroup wcm:action="add" wcm:keyValue="WindowsMediaPlayer">
      <Active>true</Active>
       <Group>Windows Media Player</Group>
       <Profile>all</Profile>
    </FirewallGroup>
   <FirewallGroup wcm:action="add" wcm:keyValue="RemoteDesktop">
      <Active>true</Active>
       <Group>@FirewallAPI.dll,-28752</Group>
       <Profile>all</Profile>
    </FirewallGroup>
</FirewallGroups>

To see an XML example that shows how to set multiple Windows Firewall groups, see Firewall Groups XML Example.

Regional Overrides

The following XML example shows how to shows how to configure a set of apps that apply to only in France and Italy.

<RegionalOverrides>
    <RegionalOverride>
        <Order>1</Order>
        <Regions>
            <Region>
                <CountryOrRegionID>IT</CountryOrRegionID>
                <Key>1</Key>
            </Region>
            <Region>
                <CountryOrRegionID>FR</CountryOrRegionID>
                <Key>2</Key>
            </Region>
        </Regions>
        <!-- Square tiles, Wide Tiles, and LockScreen apps are specified here -->
    </RegionalOverride>
<RegionalOverrides>

For more information, see also CountryOrRegionID and Order.

DataImage MetaData Key

The following example shows how to configure the MetaData setting to install a specific data image by using the image index value.

<InstallFrom>
    <MetaData wcm:action="add">
        <Key>/IMAGE/INDEX</Key>
        <Value>1</Value>
    </MetaData>
</InstallFrom>

The following example shows how to configure the MetaData setting to install a specific data image by using the image name.

<InstallFrom>
    <MetaData wcm:action="add">
        <Key>/IMAGE/NAME</Key>
        <Value>FNB2Drivers</Value>
    </MetaData>
</InstallFrom>

The following example shows how to configure the MetaData setting to install a specific data image by using the image description.

<InstallFrom>
    <MetaData wcm:action="add">
        <Key>/IMAGE/DESCRIPTION</Key>
        <Value>FabriKam Model FNB3 Drivers</Value>
    </MetaData>
</InstallFrom>

For an XML example that shows how to set the ImageInstall setting to install both an operating system image and a data image, see Setting the ImageInstall Setting XML Example.

Windows 8 Application Launcher