Oobe.xml Settings
This topic describes the settings that can be set in Oobe.xml. A sample of Oobe.xml is provided with the Windows OPK and the Windows AIK in the \Samples directory. This sample uses the fictitious company Fabrikam and Fabrikam graphics and offers.
To view the sample files in Windows Welcome and the Welcome Center
- Copy the \Info folder to \Windows\System32\Oobe, and copy the \Fabrikam folder to the root of the C: drive, where C is the letter of the drive on which you have installed Windows Vista.
To view Windows Welcome with the sample content
- On the Start menu, point to All Programs, and then click Accessories.
- Right-click the command prompt shortcut and click Run as administrator.
- Accept the User Account Control dialog box.
- Navigate to \Windows\System32\Sysprep.
- Run sysprep /oobe.
- Start the computer.
To view the Welcome Center with the sample content
- On the Start menu, point to Control Panel, and then click System and Maintenance.
- Launch Welcome Center.
To use this sample in a production environment, replace the Fabrikam content with your company's content.
Windows Welcome
<oem> Section
The following table shows the available Oobe.xml settings and their allowed values for the <oem> section of Oobe.xml.
| Setting | Description | Value | ||
|---|---|---|---|---|
name |
Name of the manufacturer. |
string |
||
logopath |
Absolute path to the OEM logo. |
Absolute path to the logo file, a 32-bit .png file. 240x100 pixels. |
||
eulafilename |
Language and location-specific version of manufacturer end-user license agreement. |
Name of the .rtf file. |
||
wallpaper |
Absolute path to the wallpaper files. |
Absolute path to three named 32-bit .png files.
|
.gif)
Note<offer> Section
The following table shows the available Oobe.xml settings and their allowed values for the <offer> section of Oobe.xml.
| Setting | Description | Value | ||
|---|---|---|---|---|
offerheader |
Initial description of OEM offer. |
String with a maximum of 40 characters. |
||
title |
Title of OEM offer. |
String |
||
imagepath |
Absolute path to .bmp file. |
Absolute path to 32-bit .bmp or .gif file. 32x32 pixels. PNG files are not supported. |
||
details |
Fuller description of OEM offers. |
String with a maximum of 128 characters. |
||
detailsfilename |
File containing details about the OEM offer. |
Absolute path to .rtf file. Embedded graphics cannot be displayed. |
||
shellexecute |
Path to the executable file for the OEM offer. |
Absolute path to setup program for offer.
|
The <offer> node itself contains a type parameter. This is used to specify whether the offer is displayed in a list or as a billboard. Only one type of offer can be used within an Oobe.xml file; the two types cannot be combined.
Additionally, “list” type offers can be displayed only in Windows Welcome and in ISP Signup. This is determined by using the parameter showin.
The following XML sample output shows the two choices of values for the <offer> node:
<offer type="billboard">
…
</offer>
-or-
<offer type="list" showin=”oobe”>
…
</offer>
<defaults> Section
The following table shows the available Oobe.xml settings and their allowed values for the <defaults> section of Oobe.xml.
| Setting | Description | Value | ||
|---|---|---|---|---|
language |
Decimal identifier of the default language. |
For possible values, see Supported Language Packs and Default Settings. |
||
location |
The location is specified by using a GEOID value that is converted to its decimal value. |
For a full list of GEOIDs, see this MSDN Web site. |
||
Locale |
The locale is specified by using a LCID value.
|
For a full list of LCIDs, see this Microsoft Global Development Web site. |
||
keyboard |
The keyboard layout is specified by the input locale identifier (formerly named "keyboard layout") format, a combination of the hexadecimal value of the language identifier and a device identifier. |
Use the keyboard value that is listed in the registry under HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Control\Keyboard Layouts and prepend the LCID appropriate for the keyboard. If you are unsure of which LCID to use with a specific keyboard identifier, contact your account manager. These are also listed in Supported Language Packs and Default Settings. |
||
timezone |
The time zone is specified 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. |
String. For possible values, see the "Time Zones" section. |
Language
There are many more LCIDs than available languages. A few LCIDs map to languages that can be released with Windows Vista. For more information about which languages release with Windows Vista, at what level of localization, and their decimal identifiers, see Supported Language Packs and Default Settings.
Time Zones
The following table shows the time zones that are valid for the Windows Vista operating system, the GMT offsets for each time zone, and the resource that is displayed for each time zone.
| Time Zone | Display |
|---|---|
Afghanistan Standard Time |
(GMT+04:30) Kabul |
Alaskan Standard Time |
(GMT-09:00) Alaska |
Arab Standard Time |
(GMT+03:00) Kuwait, Riyadh |
Arabian Standard Time |
(GMT+04:00) Abu Dhabi, Muscat |
Arabic Standard Time |
(GMT+03:00) Baghdad |
Atlantic Standard Time |
(GMT-04:00) Atlantic Time (Canada) |
AUS Central Standard Time |
(GMT+09:30) Darwin |
AUS Eastern Standard Time |
(GMT+10:00) Canberra, Melbourne, Sydney |
Azerbaijan Standard Time |
(GMT +04:00) Baku |
Azores Standard Time |
(GMT-01:00) Azores |
Canada Central Standard Time |
(GMT-06:00) Saskatchewan |
Cape Verde Standard Time |
(GMT-01:00) Cape Verde Islands |
Caucasus Standard Time |
(GMT+04:00) Baku, Tbilisi, Yerevan |
Cen. Australia Standard Time |
(GMT+09:30) Adelaide |
Central America Standard Time |
(GMT-06:00) Central America |
Central Asia Standard Time |
(GMT+06:00) Astana, Dhaka |
Central Europe Standard Time |
(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague |
Central European Standard Time |
(GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb |
Central Pacific Standard Time |
(GMT+11:00) Magadan, Solomon Islands, New Caledonia |
Central Standard Time |
(GMT-06:00) Central Time (US and Canada) |
Central Standard Time (Mexico) |
(GMT-06:00) Guadalajara, Mexico City, Monterrey |
China Standard Time |
(GMT+08:00) Beijing, Chongqing, Hong Kong SAR, Urumqi |
Dateline Standard Time |
(GMT-12:00) International Date Line West |
E. Africa Standard Time |
(GMT+03:00) Nairobi |
E. Australia Standard Time |
(GMT+10:00) Brisbane |
E. Europe Standard Time |
(GMT+02:00) Bucharest |
E. South America Standard Time |
(GMT-03:00) Brasilia |
Eastern Standard Time |
(GMT-05:00) Eastern Time (US and Canada) |
Egypt Standard Time |
(GMT+02:00) Cairo |
Ekaterinburg Standard Time |
(GMT+05:00) Ekaterinburg |
Fiji Islands Standard Time |
(GMT+12:00) Fiji Islands, Kamchatka, Marshall Islands |
FLE Standard Time |
(GMT+02:00) Helsinki, Kiev, Riga, Sofia, Tallinn, Vilnius |
Georgian Standard Time |
(GMT +04:00) Tblisi |
GMT Standard Time |
(GMT) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London |
Greenland Standard Time |
(GMT-03:00) Greenland |
Greenwich Standard Time |
(GMT) Casablanca, Monrovia |
GTB Standard Time |
(GMT+02:00) Athens, Istanbul, Minsk |
Hawaiian Standard Time |
(GMT-10:00) Hawaii |
India Standard Time |
(GMT+05:30) Chennai, Kolkata, Mumbai, New Delhi |
Iran Standard Time |
(GMT+03:30) Tehran |
Israel Standard Time |
(GMT+02:00) Jerusalem |
Korea Standard Time |
(GMT+09:00) Seoul |
Mid-Atlantic Standard Time |
(GMT-02:00) Mid-Atlantic |
Mountain Standard Time |
(GMT-07:00) Mountain Time (US and Canada) |
Mountain Standard Time (Mexico) |
(GMT-07:00) Chihuahua, La Paz, Mazatlan |
Myanmar Standard Time |
(GMT+06:30) Yangon (Rangoon) |
N. Central Asia Standard Time |
(GMT+06:00) Almaty, Novosibirsk |
Namibia Standard Time |
(GMT +02:00) Windhoek |
Nepal Standard Time |
(GMT+05:45) Kathmandu |
New Zealand Standard Time |
(GMT+12:00) Auckland, Wellington |
Newfoundland Standard Time |
(GMT-03:30) Newfoundland and Labrador |
North Asia Standard Time |
(GMT+07:00) Krasnoyarsk |
North Asia East Standard Time |
(GMT+08:00) Irkutsk, Ulaanbaatar |
Pacific SA Standard Time |
(GMT-04:00) Santiago |
Pacific Standard Time |
(GMT-08:00) Pacific Time (US and Canada); Tijuana |
Romance Standard Time |
(GMT+01:00) Brussels, Copenhagen, Madrid, Paris |
Russian Standard Time |
(GMT+03:00) Moscow, St. Petersburg, Volgograd |
SA Eastern Standard Time |
(GMT-03:00) Buenos Aires, Georgetown |
SA Western Standard Time |
(GMT-04:00) Caracas, La Paz |
SA Pacific Standard Time |
(GMT-05:00) Bogota, Lima, Quito |
Samoa Standard Time |
(GMT-11:00) Midway Island, Samoa |
SE Asia Standard Time |
(GMT+07:00) Bangkok, Hanoi, Jakarta |
Singapore Standard Time |
(GMT+08:00) Kuala Lumpur, Singapore |
South Africa Standard Time |
(GMT+02:00) Harare, Pretoria |
Sri Lanka Standard Time |
(GMT+06:00) Sri Jayawardenepura |
Taipei Standard Time |
(GMT+08:00) Taipei |
Tasmania Standard Time |
(GMT+10:00) Hobart |
Tokyo Standard Time |
(GMT+09:00) Osaka, Sapporo, Tokyo |
Tonga Standard Time |
(GMT+13:00) Nuku'alofa |
US Eastern Standard Time |
(GMT-05:00) Indiana (East) |
US Mountain Standard Time |
(GMT-07:00) Arizona |
Vladivostok Standard Time |
(GMT+10:00) Vladivostok |
W. Australia Standard Time |
(GMT+08:00) Perth |
W. Central Africa Standard Time |
(GMT+01:00) West Central Africa |
W. Europe Standard Time |
(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna |
West Asia Standard Time |
(GMT+05:00) Islamabad, Karachi, Tashkent |
West Pacific Standard Time |
(GMT+10:00) Guam, Port Moresby |
Yakutsk Standard Time |
(GMT+09:00) Yakutsk |
Welcome Center
<useroobe> Section
The following table shows the available Oobe.xml settings for the <oemStrip> section of Oobe.xml and their allowed values.
| Setting | Description | Value |
|---|---|---|
task |
GUID for each offer. |
A GUID. For more information about how to generate GUIDs, see this Microsoft Web site. |
oemLogo |
Path to the OEM logo to appear in the Computer Details preview pane. This setting must contain the namespace, xmlns="https://schemas.microsoft.com/windows/oobetasks/v1". This setting is a peer to <oemStrip>. |
Path to a .png file. Maximum size is 250 x 30 pixels. |
name |
Name of an OEM offer. Appears in the title section of the preview pane. |
String with a maximum length of 255 characters. |
icon |
Absolute path to offer icon. |
Absolute path to an .ico file. Required. |
description |
Short description of the offer. |
String with a maximum length of 255 characters. |
command |
Path to an executable file. |
Absolute path to executable file. |
sortPriority |
Numeric value to determine order of OEM offer. Higher numbers have higher priority. Therefore, an item with a higher sortPriority number (such as 94) will appear before an item with a lower number (such as 7). |
Numeric value between 1 and 99 inclusive. Default is 1. |
infotip |
Short description of OEM offer that is displayed on mouse hover. |
String with a maximum length of 255 characters. |
keywords |
Keywords used for search purposes. |
String delimited by semicolon (;). |
previewPicture |
Path to a .png file for an OEM offer. |
Absolute path to .png file. 128x128 pixels. If this value is omitted, the .ico file specified for the <icon> value for the offer will be displayed in its place (if the .ico can be scaled to 126x126). |
previewBackground |
Path to a .png file for an OEM offer background. |
Absolute path to .png file. Maximum size is 800x178 pixels. |
startText |
Short description of getting started task. |
String with a maximum length of 64 characters. |
title |
Title text for an OEM offer. |
String with a maximum length of 255 characters. |
bullet |
Creates a bullet in front of the paragraph of text. |
Absolute path to a .png file. |
text |
Text describing an OEM offer. |
String with a maximum length of 255 characters. |
Conditions
Each task can be displayed or hidden to users by setting certain conditional parameters. Conditions are interpreted every time the Welcome Center is started. If no condition is expressed, then the Welcome Center displays the task by default. Conditions are cumulative, meaning that the sum of all conditions expressed is used as display logic.
Conditions are expressed by a name and can contain a set of parameters. Each condition belongs to the shcond://v1 namespace. They are, therefore, expressed as <condition name="shcond://v1#%conditionName%">.
Each condition can also be inverted by using the invert="true" attribute. For example, to display a task in all versions of Windows Vista except Windows Vista Ultimate, use the following condition.
<condition name="shcond://v1#SkuEquals" invert="true">
<parameter name="Sku" value="Ultimate" />
</condition>
The following table shows available condition names, parameters, values, and descriptions.
| Condition Name | Parameters | Values | Description |
|---|---|---|---|
RegvalEquals |
Regkey Regval RegvalExpected |
Registry key path Registry value name Expected registry value |
Registry value is the expected value. |
RegvalExists |
Regkey Regval |
Registry key path Registry value name |
Registry value exists. |
RegkeyExists |
Regkey |
Registry key path |
Registry key exists. |
IsMachineOnDomain |
None |
None |
Computer is on a network domain. |
IsUserAdmin |
None |
None |
User is an administrator. |
IsAuxDisplayConnected |
None |
None |
An auxiliary display (Windows SideShow) is connected. |
IsMobilePC |
None |
None |
Computer is a mobile PC. |
IsOfflineFilesEnabled |
None |
None |
Offline Files has been enabled. |
SkuEquals |
1. Sku |
1. Sku Name For a full list of Windows Vista SKUs, see this Microsoft Web site. |
When setting this condition, do not use the full SKU name. Instead, use the values that corresponds to the desired SKU. Windows Vista Starter: starter Windows Vista Home Basic: homebasic Windows Vista Home Premium: homepremium Windows Vista Business: business Windows Vista Enterprise: enterprise Windows Vista Ultimate: ultimate |
IsTabletPC |
None |
None |
Computer is a Tablet PC. |
IsTouchAvailable |
None |
None |
Computer has a touch-enabled digitizer. |
DateInRange |
1. Before 2. After |
1. Date and time 2. Date When combined these two make an offer valid for a certain range. |
Set up a date range Use an invariant local date format (for example, 1/1/1977 5:00a.m.). |
ISP Sign Up Offers
<oem> Section
The following table shows the available Oobe.xml settings and their allowed values for the <oem> section of Oobe.xml as they are used for ISP sign-up offers.
| Setting | Description | Value | ||
|---|---|---|---|---|
name |
Name of the manufacturer. This is used as the title of the offer. |
string |
||
offer type |
Must be list type for ISP offers. |
list |
||
showin |
Parameter that determines where the offer is displayed. |
both |
||
details |
Fuller description of OEM offer. |
String with a maximum of 60 characters. |
||
imagepath |
Absolute path to a .bmp file. |
Absolute path to 32-bit .bmp or .gif file. 32x32 pixels. PNG and ICO files are not supported. |
||
detailsfilename |
File containing details about the OEM offer. If this tag is omitted, the contents of the <details> tag are re-displayed on the details page. |
Absolute path to an .rtf file. Embedded graphics cannot be displayed. |
||
shellexecute |
Path to the executable file for the OEM offer. |
Absolute path to setup program for offer.
|