Config.xml file in Office 2010

Syntax

<Configuration [Product="productID"] >

   ...

</Configuration>

Attributes

Remarks

The Product attribute identifies the product affected by this Config.xml file. The productID is defined in the Setup.xml file that is located in the core folder for the product, in the ID attribute of the Setup element.

The Product attribute is optional, unless you set the Display Level attribute to “basic” or “none”. In this case, the Product attribute is required. If the product specified by the Product attribute does not exist in the network installation point, Setup ends the installation.

Example

The productID for Microsoft Office Professional Plus 2010 is located in ProPlus.WW\Setup.xml in the following line:

<Setup Id="ProPlus" Type="Product"  ... >

You use this productID in Config.xml to specify Office Professional Plus 2010 by entering the following:

<Configuration Product="ProPlus">
   ...
</Configuration>

Syntax

<AddLanguage

   Id="ll-cc" | "match"

   [ShellTransform="Yes"]

/>

Attributes

Remarks

The language must be available on the network installation point.

You can have multiple elements for AddLanguage and RemoveLanguage. If both the RemoveLanguage and the AddLanguage element specify the same language, the AddLanguage element takes precedence and the language is installed.

There are three language concepts that you should know about when you install the Office 2010:

• Setup user interface (UI): the language of the installation.

• Shell UI: the language of shortcuts, right-click context menus, and tooltips.

• Office UI: the language of the Office user interface and menus.

When there are multiple Office languages, these three values are determined as follows:

By default, the Setup UI depends on the set of available resources for installation and the ability to match the user locale. By default, the Setup UI matches the user locale. The Shell UI depends on the set of languages that is being installed and, by default, follows the Setup UI. The default Office UI language depends on the user locale and current user settings. The default is to use the Windows user locale set on each user's computer. This means that in the default case, the Setup UI, Shell UI, and Office UI will all be the same.

A locale in the Windows operating system is a set of user preference information related to the user's language, environment, and cultural conventions. This information is represented as a list of values that are used to determine the correct input language, keyboard layout, sorting order, and the formats that are used for numbers, dates, currencies, and time. The user locale is a per-user setting that determines the formats that are used, by default, to display dates, times, currency, and numbers, and the sorting order of text. A user locale is specified for each account that is created on a computer.

If an administrator specifies multiple languages for installation in the Config.xml file, the Shell UI language must be selected from the set of languages that are being installed. To do this, administrators specify the ShellTransform attribute of the AddLanguage element in the Config.xml file. AddLanguage specifies the language that Setup uses for the Shell UI. However, this will not necessarily affect the choice of Setup UI or Office UI when it is installed on the user’s computer.

For example, if you have an Office image with English, French, German, and Spanish, to specify that Setup install full language support for all these languages and have the Shell UI follow the user’s default regional options, you add the following elements in the Config.xml file.

<AddLanguage Id="match" ShellTransform="yes"/> <AddLanguage Id="en-us" /> <AddLanguage Id="fr-fr" /> <AddLanguage Id="de-de" /> <AddLanguage Id="es-es" />

In the previous example, Setup installs all the specified languages and the Shell UI matches the language of the user's locale. If more languages were available in the source image, the match value in the previous example might install an additional language if the match language does not resolve to one of the other four explicitly called-out languages. For instance, if Japanese was also included in the source, this example would install Japanese in addition to the other four languages when it is installed on a computer that has the user locale set to Japanese.

Example

<AddLanguage Id="en-us" ShellTransform="Yes" />

Syntax

<ARP attribute =" value " [attribute**="value"**] ... />

Attributes

Syntax

<Command

   Path="path"

   [QuietArg="arguments"]

   [Args="args"]

   [ChainPosition="Before" | "After"(default)]

   [Wait="mseconds"]

   [Execute="Install"(default) | "Uninstall"]

   [Platform="x86"(default) | "x64"]

/>

Attributes

The following table describes the Command element attributes.

Remarks

The Command element in the Config.xml file and the Add installations and run programs option in the OCT (command-lines entered in the Add Program Entry and Modify Program Entry dialog boxes) are intended to be used only for initial product installations and uninstallations. The Command element commands are processed only during initial installations and uninstallations. If Command element commands are used for customizations after the initial installation, they are ignored.

The command line can be specified to run an arbitrary command or to run a lightweight executable that you want to run when this product is installed.

The Command element in Config.xml and the Add installations and run programs option in the OCT do not provide the software deployment capabilities that an enterprise software deployment and management tool provides, such as the ability to track deployment progress and troubleshoot problems. Therefore, it is recommended that you limit the use of Command element in Config.xml and Add installations and run programs in the OCT to running only lightweight executables or arbitrary commands that will not make changes to the computer or that do not require user input. For example, you can run a utility to copy logs or a command to launch a Welcome page at the end of installation.

The use of Args and QuietArg is as follows:

• The Args attribute is always appended to the command. This can include switches such as "/install" or **"Company=**MyCorporation".

• The QuietArg attribute is also appended if setup is running silently (with Display set as Display="none"). In such cases, you can specify the QuietArg attribute with the "/quiet" switch, for example, you can use: QuietArg="/quiet".

The following statements apply to the Wait attribute:

• Setting the Wait attribute to 0 milliseconds indicates no waiting after you run the program before you continue the installation; the command will execute and move on immediately.

  Return codes are only respected if the Wait value is nonzero. If you specify 0, Setup will not wait to continue the installation after running the specified program; therefore, there is no return code to report in that case.

• Setting the Wait attribute to any positive nonzero value will wait exactly the number of milliseconds you specify. If the process ends earlier than the specified time, setup will continue. If the process has not ended when the specified time is up, setup will fail.

• Setting the Wait attribute to -1 indicates to wait indefinitely. This can be problematic because if the command process stops responding (hangs), setup will stop responding and will wait indefinitely for the command to run.

If there are two or more Command elements in the Config.xml file, they run in the order in which they are specified in Config.xml.

Examples

<Command Path="\\server\share\myscript.exe" Args='/id "123 abc"' QuietArg="/q" Wait="30000" />

Syntax

<COMPANYNAME Value=" companyname " />

Attributes

Example

<COMPANYNAME Value="Microsoft Corporation" />

Syntax

<Display

   Level="None" | "Basic" | "Full"(default)

   CompletionNotice="Yes" | "No"(default)

   SuppressModal="Yes" | "No"(default)

   NoCancel="Yes" | "No"(default)

   AcceptEula="Yes" | "No"(default)

/>

Attributes

Remarks

If this element is not defined, the default settings are used. If an invalid value is specified, Setup ends the installation.

If the Level attribute is set to "basic" or “none” and you supply a product key by using the PIDKEY, Setup assumes that you also accept the license agreement on behalf of the user.

Example

<Display Level="none" CompletionNotice="no" SuppressModal="yes" AcceptEula="Yes" />

Syntax

<DistributionPoint Location=" path " />

Attributes

Remarks

If this is not specified, Setup assumes that the Setup.exe file is located at the root of the network installation point.

Example

<DistributionPoint Location="\\server1\office" />

Syntax

<INSTALLLOCATION Value=" path " />

Attributes

Remarks

You can use system environment variables in the path. If this element is not specified, Office is installed in %ProgramFiles%\Microsoft Office.

Example

<INSTALLLOCATION Value="%ProgramFiles%\MyApps" />

Syntax

<LIS

[CACHEACTION="CacheOnly" | "RemoveCacheOnly"]

[SOURCELIST=" semicolon-delimited-path-list "]

/>

Attributes

Remarks

By default, the LIS is created in the folder \MsoCache\All Users at the root of the drive on which Office is installed. Setup customization files and software updates in the Updates folder in the network installation point are also copied.

If you specify INSTALLLOCATION, the drive designation in the path is used to determine on what drive the LIS is created. For example, if the INSTALLLOCATION path is E:\office\files, the LIS is created on drive E. The sources listed by the SOURCELIST attribute are kept with the installed product and are used by Setup if the LIS on the user's computer is missing or corrupted.

Example

<LIS CACHEACTION="CacheOnly" />   
<LIS SOURCELIST="\\server1\office;\\server2\corpdata" />

Syntax

<Logging

   Type="Off" | "Standard"(default) | "Verbose"

   Path="path"

   Template="filename.txt"

/>

Attributes

Remarks

You can specify a * anywhere in the Template value. Setup inserts a string in that location that has the following format.

YYYYMMDDHHMMSS xxx

where:

1. YYYY = Year

2. MM = Month

3. DD = Day

4. HH = Hour

5. MM = Minute

6. SS = Seconds

7. xxx = a unique string generated by Setup

Example

<Logging Type="standard" Path="%temp%" 
   Template="MyLog(*).txt" 
/>

With this example, Setup creates a log file every time that it installs the product. Setup uses unique file names such as the following.

%temp%\MyLog(20060428110717CFC).txt
%temp%\MyLog(20060429113143C70).txt

Syntax

<MinOSRequirement

   VersionNT="version"

   WindowsBuild="number"

   ServicePackLevel="number"

/>

Attributes

The following values can be used.

Remarks

Setup does not continue with the installation if the user's computer has an operating system with a version earlier than what is specified here (or the Office default if this element is not specified). You cannot specify a version of Windows here that is earlier than the version required by Office 2010.

For information about system requirements, see What's new for IT professionals in Office 2010.

Syntax

<OptionState

   Id="optionID"

   State="Absent" | "Advertise" | "Local"

   [Children="force"]

/>

Attributes

Remarks

A feature is an item that the user can choose to install. The Id value for a feature is defined in the Option element of the Setup.xml file in the core product folder.

Example

<OptionState Id="ExcelAddinFiles" 
   State="Absent" 
   Children="force" 
/>

Syntax

<PIDKEY Value=" 25-character-key " />

Attributes

Remarks

When the PIDKEY value is set, users are not required to enter a product key when they install Office.

To enter a MAK key in the Config.xml file, add the following line to the file.

<PIDKEY Value="AAAAABBBBBCCCCCDDDDDEEEEE" />

Where AAAAABBBBBCCCCCDDDDDEEEEE is the 25-character product key. For more information about licensing for Office 2010, see the Volume activation overview for Office 2010.

Example

<PIDKEY Value="1234512345123451234512345" />

Syntax

<RemoveLanguage Id=" ll - cc " />

Attributes

Remarks

If the language is not installed on the user's computer, the RemoveLanguage element is ignored.

You can have multiple elements for AddLanguage and RemoveLanguage. If both RemoveLanguage and AddLanguage elements specify the same language, the AddLanguage element takes precedence and the language is installed.

Example

<RemoveLanguage Id="en-us" />

Syntax

<Setting Id=" name " Value=" value " />

Attributes

Remarks

Not all Windows Installer properties can be specified in the Setting element. If a blocked property is specified, Setup ends the installation process. If a supported property is specified, Setup passes the property directly to Windows Installer. For a complete list of Windows Installer properties, which includes an explanation of supported and blocked properties, see Setup properties in Office 2010.

The Setting element supports the following Key Management System (KMS) properties:

• KMSSERVICENAME — Specifies the KMS host name.

• KMSSERVICEPORT — Specifies the KMS host port.

For example, to use the KMS properties, use the following syntax:

<Setting Id="KMSSERVICENAME" Value="contoso.com" />

<Setting Id="KMSSERVICEPORT" Value="1234" />

where:

contoso.com is the name of the KMS host

1234 is the port number value

The Setting element supports the AUTO_ACTIVATE property for product key activation. This property specifies that product activation occur automatically during Office 2010 deployment and it uses the following syntax.

<Setting Id="AUTO_ACTIVATE" Value="1" />

The Setting element supports the REMOVEPREVIOUS property. This property removes the specified application from the installation and uses the following syntax.

<Setting Id="REMOVEPREVIOUS" Value="Option Id" />

where Option Id is the identifier value for the Office 2010 application. To specify multiple applications, use a comma-separated list to indicate the appropriate Option Id values.

If you specify REMOVEPREVIOUS with an Option Id value, only the specified applications are removed.

If you do not specify REMOVEPREVIOUS, any previously installed Office applications for which a replacement is being installed are removed. This is the default behavior.

If you specify REMOVEPREVIOUS with a blank value (REMOVEPREVIOUS=""), no applications are removed.

The Setting element also supports the SETUP_REBOOT property. SETUP_REBOOT begins a restart after installation. It uses the following syntax. You must use all uppercase letters for the SETUP_REBOOT property.

<Setting Id="SETUP_REBOOT" Value="value" />

where value can be one of the following:

• AutoAlways — Always begin a restart. Do not prompt the user.

• Always — Always prompt for a restart at the end of setup.

• IfNeeded — Prompt for a restart at the end of setup if setup requires a restart. (Default)

• AutoIfNeeded — Begin a restart if setup requires a restart. Do not prompt the user.

• Never — Never begin or prompt for a restart.

Examples

<Setting Id="SETUP_REBOOT" Value="Never" />
<Setting Id="REMOVEPREVIOUS" Value="WORDFiles" />

Syntax

<SetupUpdates

   [CheckForSUpdates="Yes"(default) | "No"]

   [SUpdateLocation="path-list"]

/>

Attributes

Remarks

Setup looks in all the specified folders for Setup customization files that were created for the product that is being installed, and applies them in alphabetical order by file name. If a Setup customization file was specified in the Setup command line, that file is applied first, followed by any files that are found in the folder that is specified by this element.

Example

<SetupUpdates
   CheckForSUpdates="Yes"
   SUpdateLocation="\\server1\office\updates;\\server2\corpdata\updates"
/>

Syntax

<USERINITIALS Value=" value " />

Attributes

Example

<USERINITIALS Value="JD" />

Syntax

< Value=" value " />

Attributes

Remarks

The Office 2010  Username element data is populated as follows.

If the user who runs Office is the same user who installed Office, the Username and Initials supplied during setup are used. The user is not prompted when Office first starts. This case is most popular for home users who install Office themselves.

If the user who is running Office is not the same user who installed Office, Office prompts the user to confirm his or her Username and Initials when Office first starts. This case is most popular in a corporate environment, where an administrator installs Office for the user.

The value for the Username element shown to the user at first start time might be pre-populated with a default value from a previously installed version of Office or from the currently logged-on user. Note that the default value is not used unless it is confirmed by the user. If an earlier version of Office is installed on the computer, the registry key that was created by the earlier version of Office is used. For example, if the previous Office installation is Microsoft Office 2003, the registry key is provided at HKEY_CURRENT_USER\Software\Microsoft\Office\11.0\Common\UserInfo.

Example

<USERNAME Value="John Doe" />