Skip to main content
TechNet
Reference: Configuration options for the Office Deployment Tool
 

Applies to: Office 365 ProPlus

Topic Last Modified: 2016-08-16

Summary: Provides detailed information on the configuration options for the Office Deployment Tool.

Audience: IT Professionals who are deploying Office 365 ProPlus to hundreds or thousands of client computers in an enterprise environment

With the Office Deployment Tool (ODT), you can download and deploy Office 365 ProPlus to your client computers. The ODT gives you more control over an Office installation: you can define which products and languages are installed, how those products should be updated, and whether or not to display the install experience to your users. This article covers all the available options in the tool. To learn how to use the tool itself, see Overview: Office Deployment Tool.

In most cases, administrators use the ODT as part of a larger deployment, such as Deploy Office 365 ProPlus by using System Center Configuration Manager. This article does not cover all the deployment steps; for more information on those end-to-end scenarios, see Determine the deployment method to use for Office 365 ProPlus.

Example of a standard configuration file

The ODT consists of two files: setup.exe and configuration.xml. To work with the tool, you edit the configuration file to define what options you want, and then run setup.exe from the command line. For example, you can edit the configuration file to download the 32 bit English edition of Office, or you can edit the file to install the 32 bit English edition of Office with the EULA automatically accepted and without Publisher.

When creating the configuration file, we recommend starting with an example file and updating it with the appropriate options for your environment. You can start by copying and pasting the example below into a text file and saving it with a name of your choosing. Use the file to modify the XML elements and attributes and use the reference table in this article to learn more details about each of the elements and attributes.

This configuration file includes the most-commonly used elements and attributes, and can be used to download and install Office on a client computer

<Configuration>
  <Add SourcePath="\\Server\Share" OfficeClientEdition="32" Channel="Deferred" >
    <Product ID="O365ProPlusRetail">
      <Language ID="en-us" />
      <Language ID="ja-jp" />
    </Product>
    <Product ID="VisioProRetail">
      <Language ID="en-us" />
    </Product>
  </Add>  
  <Updates Enabled="TRUE" UpdatePath="\\Server\Share" /> 
  <Display Level="None" AcceptEULA="TRUE" />  
  <Logging Level="Standard" Path="%temp%" /> 
</Configuration>

 

Value Description

SourcePath="\\Server\Share"

Office will be downloaded to "\\server\share" on your network and deployed using installation files at that location.

OfficeClientEdition="32"

Downloads and installs the 32 bit edition of Office.

Channel="Deferred"

After installation, Office will be updated using the Deferred channel.

Product ID="O365ProPlusRetail"

Downloads and installs Office 365 ProPlus.

Language ID="en-us"

Language ID="ja-jp"

Downloads and installs English and Japanese versions of Office.

Updates Enabled="TRUE" UpdatePath="\\Server\Share"

After installation, Office checks for updates at "\\server\share" on your network.

Display Level="None" AcceptEULA="TRUE"

When installing Office, no user interface is displayed.

Logging Level=”Standard” Path="%temp%"

Log files are stored in the %temp% folder.

Configuration options for the Office Deployment Tool

The following options apply to running the ODT in download, configure, or packager mode.

 

Name Description Value

Add element

Defines the products and languages to download or install

SourcePath attribute (part of Add element)

Defines the location of the Office installation files. If the ODT is run in download mode, defines where to save the files.

Optional. If not included, the ODT will look for installation files in the same folder as the tool, and then use the Office Content Delivery Network (CDN). If not included and the ODT is run in download mode, the Office installation files are downloaded to the same folder as the tool.

Examples:

\\server\share\

c:\preload\office

Version attribute (part of Add element)

Optional. The default is the latest available version of Office is used.

Example:

16.0.6741.2056

OfficeClientEdition attribute (part of Add element)

Defines whether the 32-bit or 64-bit edition of Office 365 ProPlus is downloaded or installed.

Required.

32 or 64

Channel attribute (part of Add element)

Defines which channel to use for updating Office after it is installed.

Optional. The default is Deferred for Office 365 ProPlus and Current for Visio Pro and Project for Office 365.

For more information about update channels, see Overview of update channels for Office 365 ProPlus.

Current

Deferred

FirstReleaseDeferred

FirstReleaseCurrent

DownloadPath attribute (part of Add element)

Defines where the installation files are downloaded from. Most commonly used to distribute specific languages and products for Office from a central location on your network to another location.

To use this setting, run the ODT in download mode.

Optional. If not included, the files are downloaded from the Office CDN.

Example:

\\serverb\share>

Product element

Defines which products to download or install.

If you define multiple products, the products are installed in the order in the configuration file. The first product determines the context for the Microsoft Office First Run Experience.

ID attribute (part of Product element)

Defines the ID of the product to download or install.

Required.

Office 365 Product IDs:

O365ProPlus

VisioProRetail

ProjectProRetail

SPDRetail

For a list of all supported product IDs, see Product IDs that are supported by the Office Deployment Tool for Click-to-Run

Language element

Defines which languages to download or install.

If you define multiple languages, the first language in the configuration file determines the Shell UI culture, including shortcuts, right-click context menus, and tooltips.

If you decide that you want to change the Shell UI language after an initial installation, you have to uninstall and reinstall Office.

ID attribute (part of Language element)

Defines the ID of the language to download or install.

Required.

en-us

ja-jp

For a list of all languages, see Language identifiers.

Display element

Defines what the user sees when Office is installed.

Level attribute (part of Display element)

If Level is set to None, Office is installed with no user interface: no progress bars, completion screens, error messages, or other user interface are displayed.

If Level is set to Full, Office is installed with the normal installation experience.

Optional. Default is Full.

None

Full

AcceptEULA attribute (part of Display element)

If AcceptEULA is set to TRUE, the user does not see a Microsoft Software License Terms dialog box.

If this attribute is set to FALSE or is not included, the user may see a Microsoft Software License Terms dialog box.

We recommend that administrators set AcceptEULA to TRUE.

This setting only applies if you install with the user's account. If you use System Center Configuration Manager or other software distribution tool that uses the SYSTEM account to install, then the setting is not applied.

Optional. Default is FALSE.

TRUE

FALSE

ExcludeApp element

Defines which Office 365 ProPlus products should not be installed.

ID attribute (part of ExcludeApp element)

Defines the ID of the product that should not be installed.

Required.

Access

Excel

Groove

InfoPath

Lync

OneDrive

OneNote

Outlook

PowerPoint

Publisher

SharePointDesigner

Visio

Word

For OneDrive for Business, use Groove. For Skype for Business, use Lync.

Logging element

Defines options for ODT logging

Level attribute (part of Logging element)

Turns logging on or off.

Optional. Default is Standard

Off

Standard

Path attribute (part of Logging element)

Defines the location of the log files.

Optional. Default is %temp%.

%temp%

\\server\share\userlogs\

Property element

Defines certain Office behaviors and properties.

Name attribute (part of Property element)

Defines the specific property whose value you want to set.

Required.

FORCEAPPSHUTDOWN

Value attribute (part of Property element)

Defines the value of the named property.

TRUE

AUTOACTIVATE property (part of Property element)

Because Office 365 ProPlus is set to activate automatically, you should not set this property for Office 365 ProPlus products.

For other products, you can set AUTOACTIVATE to 1 to have the product activate automatically.

Optional. Default is 0.

1

0

FORCEAPPSHUTDOWN property (part of Property element)

When set to TRUE, forces any apps that are blocking the install of Office to shut down. Data loss may occur.

Optional. Default is FALSE.

TRUE

FALSE

PACKAGEGUID property (part of Property element)

By default, App-V packages created by the ODT share the same App-V Package ID. Administrators can use PACKAGEGUID to specify a different Package ID.

This allows you to publish multiple App-V packages of Office 2013 to an App-V Management Server. But, this doesn’t enable you to deploy more than one Office 2013 App-V package to a single computer.

Optional.

12345678-ABCD-1234-ABCD-1234567890AB

The Package ID must follow the format of the example and can only use these characters:

0, 1, 2, 3, 4, 5, 6, 7, 8, 9, A, B, C, D, E, F

If you use any other characters, the App-V package is created with the default Package ID.

SharedComputerLicensing property (part of Property element)

Set SharedComputerLicensing to 1 if you deploy Office 365 ProPlus to shared computers by using Remote Desktop Services.

For more information, see Overview of shared computer activation for Office 365 ProPlus.

Optional. Default value is 0.

1

0

PinIconsToTaskBar property (part of Property element)

Defines whether shortcut icons for Office products are added to the Windows taskbar in Windows 7, 8, and 8.1.

Optional. The default value is True.

TRUE

FALSE

Remove element

Defines which products and languages to remove from a previous installation of Office 365 ProPlus.

To remove an installed language, you must provide both the product and the language, as in the example above. For more information, see Overview: Office Deployment Tool.

All attribute (part of Remove element)

If set to TRUE, all Office 365 ProPlus products and languages will be removed.

Optional. The default value is FALSE.

TRUE

FALSE

Updates element

Defines how Office is updated after it's installed

Enabled attribute (part of Updates element)

If set to TRUE, Office will check for updates. If set to FALSE, Office won't check for updates.

Optional. The default value is TRUE.

TRUE

FALSE

UpdatePath attribute (part of Updates element)

Defines where the updates for Office come from.

If UpdatePath is not set or is set to empty (""), the location is set to the Office Content Delivery Network (CDN).

UpdatePath can specify a network, local, or HTTP path of a source for Office installation files. Environment variables can be used for network or local paths.

If you use Group Policy with the Office 2016 Administrative Template files (ADMX/ADML), you can set UpdatePath by using the Update Path policy setting. You can find this policy setting under Computer Configuration\Administrative Templates\Microsoft Office 2016 (Machine)\Updates.

Optional.

\\server\share\

C:\Preload\Office

http://internalApps/Office/

TargetVersion attribute (part of Updates element)

Defines which version Office updates to.

If TargetVersion is not set or is set to empty (""), Office updates to the most recent version from the specified update path.

If TargetVersion is set to a specific build number, Office attempts to update to that version..

If you use Group Policy with the or Office 2016 Administrative Template files (ADMX/ADML), you can set TargetVersion by using the Target Version policy setting. You can find this policy setting under Computer Configuration\Administrative Templates\Microsoft Office 2016 (Machine)\Updates.

Optional.

15.1.2.3

""

Deadline attribute (part of Updates element)

Defines a deadline by which updates must be applied. The deadline is specified in Coordinated Universal Time (UTC).

You can use Deadline with Target Version to make sure that Office is updated to a particular version by a particular date. We recommend that you set the deadline at least a week in the future to allow users time to install the updates.

Prior to the deadline, users receive multiple reminders to install the updates. If Office isn’t updated by the deadline, users see a notification that the updates will be applied in 15 minutes. This gives users the opportunity to save the Office documents that they are working on and to close any Office programs that are open. If users don’t close the Office programs, the programs are closed automatically when the 15 minutes are up, which might result in data loss. After the Office programs are closed, the updates are applied automatically.

The deadline only applies to one set of updates. If you want to use a deadline to make sure that Office is always up-to-date, you must change the deadline every time that a new update for Office is available.

To use this attribute, Office must be running at least Service Pack 1 (version 15.0.4569.1507).

If you use Group Policy with the Office 2016 Administrative Template files (ADMX/ADML), you can set Deadline by using the Update Deadline policy setting. You can find this policy setting under Computer Configuration\Administrative Templates\Microsoft Office 2016 (Machine)\Updates.

Optional.

05/16/2014 18:30

Channel attribute (part of Updates element)

Defines which channel to use for updating Office after it is installed. Note that there are two channel attributes: the channel for the Add element is used to specify an update channel while installing Office, and the channel for the Update element is used to change the channel for an existing installation of Office.

For more information about update channels, see Overview of update channels for Office 365 ProPlus.

If you use Group Policy with the Office 2016 Administrative Template files (ADMX/ADML), you can set Channel by using the Update Channel policy setting. You can find this policy setting under Computer Configuration\Administrative Templates\Microsoft Office 2016 (Machine)\Updates. If enabled, this Group Policy setting takes precedence over the Channel value set by using the Office Deployment Tool.

Optional. The default is Deferred for Office 365 ProPlus and Current for Visio Pro and Project for Office 365.

Current

Deferred

FirstReleaseDeferred

FirstReleaseCurrent