Oobe.xml Settings

  • Article

Applies To: Windows 8, Windows 8.1, Windows Server 2012, Windows Server 2012 R2

This topic describes the settings that can be set in Oobe.xml.

Oobe.xml Settings

The following tables show the available settings in the Oobe.xml file, by section, along with the description and the value for each setting.

HID Pairing

Setting Description Value

mouseImagePath

Absolute path to the mouse pairing instruction image.

The image must not be larger than 630 x 372 pixels. It's scaled to fit in portrait mode or on small form factors.

Absolute path to image

mouseText

Help text that displays at the bottom of the page if the mouse pairing instruction image cannot be opened. This text is also used by Narrator for accessibility.

String

mouseErrorImagePath

Absolute path to the mouse pairing error image.

The image must not be larger than 630 x 372 pixels. It will be scaled to fit in portrait mode or on small form factors.

Absolute path to the image

mouseErrorText

This error text is displayed if there are issues loading the mouse pairing error image. This text is also used by Narrator for accessibility.

String

keyboardImagePath

Absolute path to the first keyboard pairing instruction image.

The image must not be larger than 630 x 372 pixels. It will be scaled to fit in portrait mode or on small form factors.

Absolute path to the image

keyboardText

Help text that displays at the bottom of the page if the keyboard pairing instruction image cannot be opened. This text is also used by Narrator for accessibility.

String

keyboardPINImagePath

Absolute path to the second keyboard pairing instruction image.

The image must not be larger than 630 x 372 pixels. It's scaled to fit in portrait mode or on small form factors.

Absolute path to the image

keyboardErrorImagePath

Absolute path to the keyboard pairing error image.

The image must not be larger than 630 x 372 pixels. It's scaled to fit in portrait mode or on small form factors.

Absolute path to the image

keyboardErrorText

This error text is displayed if there are issues loading the keyboard pairing error image. This text is also used by Narrator for accessibility.

String

Registration page

The following table shows the Registration page settings and their allowed values in OOBE.xml.

Note

The ampersand symbol, '&', cannot be used in this section of OOBE.xml. Use the word 'and' instead.

Section Setting Description Value

title

Required. Text to title the Registration page.

String of up to 25 characters.

subtitle

Required. Text to describe the Registration page.

String of up to 200 characters.

textbox1

label

Text to label textbox1. Required for textbox1 to appear.

String of up to 20 characters.

inputscope

Value to set scope of touch keyboard.

Two supported scopes:

4 (IS_EMAIL_USERNAME)

29 (IS_NUMBERS)

textbox2

label

Text to label textbox2. Required for textbox2 to appear.

String of up to 20 characters.

inputscope

Value to set scope of touch keyboard.

Two supported scopes:

4 (IS_EMAIL_USERNAME)

29 (IS_NUMBERS)

checkbox1

label

Text to label checkbox1. Required for checkbox1 to appear.

String of up to 250 characters. We strongly recommend that you use no more than 100 characters because this length of text will fit on one line.

defaultvalue

Value to set checkbox1 as selected or not selected.

True or False. True means the check box default condition is selected. False means the check box default condition is not selected.

checkbox2

label

Text to label checkbox2. Required for checkbox2 to appear

String of up to 250 characters. We strongly recommend that you use no more than 100 characters because this length of text will fit on one line.

defaultvalue

Value to set checkbox2 as selected or not selected.

True or False. True means the check box default condition is selected. False means the check box default condition is not selected.

checkbox3

label

Text to label checkbox3. Required for checkbox3 to appear

String of up to 250 characters. We strongly recommend that you use no more than 100 characters because this length of text will fit on one line.

defaultvalue

Value to set checkbox3 as selected or not selected.

True or False. True means the check box default condition is selected. False means the check box default condition is not selected.

link1

label

Label for the link to the .rtf file. Required for link1 to appear.

String of up to 100 characters.

link

File must be named linkfile1.rtf. OOBE searches for files named linkfile1.rtf, linkfile2.rtf, or linkfile3.rtf under the oobe\info folder. OOBE searches for files under the appropriate locale and language specific subfolders of oobe\info.

linkfile1.rtf

link2

label

Label for the link to the .rtf file. Required for link2 to appear.

String of up to 100 characters.

link

File must be named linkfile2.rtf. OOBE searches for files named linkfile1.rtf, linkfile2.rtf, or linkfile3.rtf under the oobe\info folder. OOBE searches for files under the appropriate locale and language specific sub-folders of oobe\info.

linkfile2.rtf

link3

label

Label for the link to the .rtf file. Required for link3 to appear.

String of up to 100 characters.

link

File must be named linkfile3.rtf. OOBE searches for files named linkfile1.rtf, linkfile2.rtf, or linkfile3.rtf under the oobe\info folder. OOBE searches for files under the appropriate locale and language specific sub-folders of oobe\info.

linkfile3.rtf

EULA file and language, locale, and timezone default values.

Section Setting Description Value

eulafilename

Language- and location-specific version of manufacturer end-user license agreement (EULA).

.rtf file.

defaults

language

Decimal identifier for input locale.

Decimal identifier for input locale. These values can be found in the following topic, Default Input Locales for Windows Language Packs.

location

The location is specified by using a GEOID value that is converted to its decimal value.

For a list of GEOIDs, see this MSDN Web site.

locale

The locale is specified by using a locale identifier (LCID) value.

For a full list of LCIDs, see this Microsoft Global Development Web site. For a list of LCIDs and the versions of Windows in which they are available, download "Windows Language Code Identifier (LCID) Reference" from MSDN. In this paper, in the left pane, go to "Appendix A: Windows Behavior" to see a table that shows the LCID and the Windows release in which it is available.

keyboard

Specifies the keyboard layout.

Use the keyboard value that is listed in the registry under HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Control\Keyboard Layouts.

timezone

Specifies the time zone of the computer's end user. The time zone is set by a string that specifies the time zone for the computer. The maximum length is 256 characters. New time zones might appear in future releases. To add support for a new time zone, you must enter the exact time zone string.

For a full list of time zones, refer to the values listed in the registry under HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones on a computer running Windows® 7. On a computer running Windows 7 you can use the tzutil command-line tool to list the time zone for that computer. The tzutil tool is installed by default on Windows Server 2008 R2.

Warning
If the time zone is not specified, a default time zone value is used. The default time zone is based on the installed language and region specified in an answer file. If a region has more than one time zone, the time zone is set to the default time zone of that region. The default time zone for that region is specified by the location of the capital/major city. For example, if en-CA is specified, Eastern Standard Time is used as the default time zone because the Canadian capital, Ottawa, uses Eastern Standard Time. If en-US is specified as the UserLocale, the time zone of the Windows installation defaults to Pacific Standard Time.

adjustForDST

Specifies whether to adjust for Daylight Savings Time. This setting is effective only when used in combination with the timezone and hideTimeAndDate settings to specify the time settings for the end user.

True or False.

hideRegionalSettings

If this setting is not specified as True, then the Regional Settings page will be shown, even if all of the values for that page have been preconfigured.

True or False.

hideTimeAndDate

If this setting is not specified as True, then the Time and Date page will be shown, even if all of the values for that page have been preconfigured.

True or False.

How to Customize OOBE

To customize OOBE by using Oobe.xml

  1. Create a file named Oobe.xml and store this file in Windows\System32\Oobe\Info.

  2. By using an XML editor or a text editor, such as Notepad, update Oobe.xml with the appropriate files, paths, and content.

  3. Save your updated version of Oobe.xml in Windows\System32\Oobe\Info, or in the appropriate language- and locale-specific folders required for your customizations.

  4. Test OOBE.

    Test OOBE

    1. On the Start menu, point to All Programs, and then click Accessories.

    2. Right-click the command prompt shortcut, and click Run as administrator. Accept the User Account Control dialog box.

    3. Navigate to \Windows\System32\Sysprep

    4. Run sysprep /oobe.

    5. Start the computer.

See Also

Other Resources

Configure Oobe.xml