Skip to main content
Reference for Click-to-Run configuration.xml file
 

Applies to: Office 365 ProPlus

Topic Last Modified: 2014-12-15

Summary: Provides information about the Configuration.xml file for Click-to-Run for Office 365 products.

Audience: IT Professionals

The Click-to-Run for Office 365 Configuration.xml file is used to specify Click-to-Run installation and update options. The Office Deployment Tool is a downloadable tool that includes a sample Configuration.xml file. Administrators can modify the Configuration.xml file to configure installation options for Click-to-Run for Office 365 products.

The Click-to-Run Configuration.xml file is a necessary component of the Office Deployment Tool. Click-to-Run customizations are performed primarily by starting the Office Deployment Tool and providing a custom Configuration.xml file. The Office Deployment Tool performs the tasks that are specified by using the optional properties in the configuration file. For the Office 2013 release of the product, administrators can download the Office Deployment Tool from the Microsoft Download Center.

You use the Click-to-Run Configuration.xml file to perform the following tasks:

  • Add or remove products from the installation

  • Add or remove languages from the installation

  • Specify display options

  • Set logging options

  • Specify software updates behavior for Click-to-Run

ImportantImportant:
This article is part of the Getting started guide for deploying Office 365 ProPlus for IT Professionals. Use the roadmap as a starting point for articles that help you deploy Office 365 ProPlus in your organization.
Are you looking for help with installing Office with Office 365? You may be looking for Get started with Office 365 and Install Office with Office 365, which will help you learn how to set up and use Office 365 on your computer, phone, and tablet.

In this article:

NoteNote:
You cannot customize the installation location for Click-to-Run for Office 365 products. Click-to-Run can only be deployed to the system drive which is typically drive C.

For the latest information about known issues for Click-to-Run, see Office known issues on the office.com site.

Click-to-Run Configuration.xml quick reference

The following table lists the Click-to-Run Configuration.xml elements.

Configuration.xml reference

Element Description

Configuration element

Top-level element

Add element

Specifies products and languages to install

Display element

The level of UI that Setup displays to the user

ExcludeApp element

A Product element child. Specifies which Office programs not to install

Language element

A Product element child. Adds a language to the installation

Logging element

Options to specify the kind of logging that Setup performs

Product element

An Add or Remove element child. Specifies the product to install

Property element

Used for general properties.

Remove element

Specifies products and languages to remove

Updates element

Specifies how Office checks for and obtains product updates

Click-to-Run Configuration.xml file format

XML elements in Click-to-Run Configuration.xml begin with < and end with />.

The basic element format is as follows:

< element [attribute="value"] [attribute="value"] … />

The following example displays no user interface when the product is installed and accepts the license terms on behalf on the user:

<Display Level="None" AcceptEULA="TRUE" />
Click-to-Run Configuration.xml reference

The following table lists the conventions that are used in this reference.

Formatting conventions

Format Description

Bold

Element or attribute name

normal

Enter text as shown

Italic

Placeholder for a value

X | Y

Choose between values

{x}

Optional value

Configuration element

Top-level element. This element is required, and all other elements must appear within this element.

Syntax

<Configuration>

{0 or 1 Add element}

{0 or 1 Remove element}

{0 or 1 Updates element}

{0 or 1 Display element}

{0 or 1 Logging element}

</Configuration>

Add element

Specifies the products and languages to install.

Syntax

<Add

 SourcePath="\\server\share\"

 Version="15.1.2.3"

OfficeClientEdition=32 | 64

>

{0 or N Product elements}

</Add>

The following table describes Add element attributes and values.

Add element attributes and values

Attribute Value Description

SourcePath

\\server\share\

C:\Preload\Office

http://internalApps/Office/

Optional.

The SourcePath value can be set to a network, local, or HTTP path that contains a Click-to-Run source. Environment variables can be used for network or local paths.

SourcePath indicates the location to save the Click-to-Run installation source when you run the Office Deployment Tool in download mode.

SourcePath indicates the installation source path from which to install Office when you run the Office Deployment Tool in configure mode. If you don’t specify SourcePath in configure mode, Setup will look in the current folder for the Office source files. If the Office source files aren’t found in the current folder, Setup will look on Office 365 for them.

SourcePath specifies the path of the Click-to-Run Office source from which the App-V package will be made when you run the Office Deployment Tool in packager mode.

If you do not specify SourcePath, Setup will attempt to create an \Office\Data\... folder structure in the working directory from which you are running setup.exe.

Version

15.1.2.3

Optional. If a Version value is not set, the Click-to-Run product installation streams the latest available version from the source. The default is to use the most recently advertised build (as defined in v32.CAB or v64.CAB at the Click-to-Run Office installation source).

Version can be set to an Office 2013 build number by using this format: X.X.X.X

OfficeClientEdition

32 or 64

Required. Specifies the edition of Click-to-Run for Office 365 product to use: 32- or 64-bit. The action fails if OfficeClientEdition is not set to a valid value.

A configure mode action may fail if OfficeClientEdition is set incorrectly. For example, if you attempt to install a 64-bit edition of a Click-to-Run for Office 365 product on a computer that is running a 32-bit Windows operating system, or if you try to install a 32-bit Click-to-Run for Office 365 product on a computer that has a 64-bit edition of Office installed.

ForceDowngrade is no longer a supported attribute.

NoteNote:
The Product element specifies the products to install and also specifies languages (indicated by {1 or N Language elements}). See Language element.

The code in the following example installs Office 365 ProPlus 32-bit version 15.1.2.3 in English (US) from the specified \\server\share network share location.

<Add SourcePath="\\server\share\" Version="15.1.2.3" OfficeClientEdition="32"> 
      <Product ID="O365ProPlusRetail">
        <Language ID="en-us" />
      </Product>
</Add>
Display element

Specifies the level of user interface to display to users.

Syntax

<Display

 Level=None | Full

 AcceptEULA=TRUE | FALSE

/>

The following table describes Display element attributes and values.

Display element attributes and values

Attribute Value Description

Level

None

Full

Optional. Determines the user interface that the user sees when the operation is performed.

If Level is set to None, the user sees no UI. No progress UI, completion screen, error dialog boxes, or first run automatic start UI are displayed.

If Level is set to Full, the user sees the normal Click-to-Run user interface: Automatic start, application splash screen, and error dialog boxes.

AcceptEULA

TRUE

FALSE

Optional. We recommend that administrators set AcceptEULA to TRUE.

If this attribute 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 set, the user may see a Microsoft Software License Terms dialog box.

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

Example:

<Display Level="None" AcceptEULA="TRUE" />
ExcludeApp element

Specifies which Office programs not to install.

Syntax

<ExcludeApp ID= "Access" />

The following table describes ExcludeApp element attributes and values.

ExcludeApp element attributes and values

Attribute Value Description

ID

Access

Optional.

The following is a list of the supported values for ID:

  • Access

  • Excel

  • Groove

  • InfoPath

  • Lync

  • OneNote

  • Outlook

  • PowerPoint

  • Project

  • Publisher

  • SharePointDesigner

  • Visio

  • Word

The value “Groove” is used to exclude OneDrive for Business.

The following example shows how to install the 32-bit edition of Office 365 ProPlus in English, without Access or InfoPath.

<Add SourcePath="\\Server\share" Version="15.1.2.3" OfficeClientEdition="32">
    <Product ID="O365ProPlusRetail" >
      <Language ID="en-us" />
      <ExcludeApp ID="Access" />
      <ExcludeApp ID="InfoPath" />
    </Product>
</Add>

The minimum requirements to use the ExcludeApp element are the following:

  • Office programs   At least version 15.0.4615.1001, which was released in May 2014.

  • Office Deployment Tool   At least version 15.0.4619.1000, which was released in May 2014.

For more information about using the ExcludeApp element, see Exclude certain Office programs when deploying Office 365 ProPlus.

Language element

Specifies the languages to install.

Syntax

<Language ID= "ll-cc" />

The following table describes Language element attributes and values.

Language element attributes and values

Attribute Value Description

ID

ll-cc

Required. If the Language ID value is not set, the installation operation fails and indicates that the input is not valid.

The ID value can be set to a valid Office culture language (such as en-us for English US or ja-jp for Japanese). The ll-cc value is the language identifier.

For more information about language IDs (language tags), see Language identifiers.

NoteNote:
Language elements determine which product languages to install. Administrators must specify the languages they want to install. The first language determines the Shell UI culture. The Shell UI is the language of 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 Click-to-Run and reinstall. Add the language that you want to set for the Shell UI as the first language in the custom Configuration.xml file.

The following example shows how to install the 32-bit edition of Office 365 ProPlus in English, Japanese, and Spanish.

<Add SourcePath="\\Server\share" Version="15.1.2.3" OfficeClientEdition="32">
    <Product ID="O365ProPlusRetail" >
      <Language ID="en-us" />
      <Language ID="es-es" />
      <Language ID="ja-jp" />
    </Product>
</Add>
Logging element

Specifies the type of logging that Click-to-Run performs.

Syntax

<Logging

Level=Off | Standard

Path=UNC or local path

/>

The following table describes Logging element attributes and values.

Logging element attributes and values

Attribute Value Description

Level

Off

Standard

Optional. Specifies options for the logging that Click-to-Run Setup performs. The default level is Standard.

Path

%temp%\\server\share\userlogs\

Optional. Specifies the fully qualified path of the folder that is used for the log file. You can use environment variables. The default is %temp%.

Name is no longer a supported attribute.

Example:

<Logging Level="Standard" Path="%temp%" />
Product element

Specifies the Click-to-Run product to install.

Syntax

<Product

ID="O365ProPlusRetail"

PIDKEY="12345-12345-12345-12345-12345"

>

{1 or N Language elements}

</Product>

The following table describes Product element attributes and values.

Product element attributes and values

Attribute Value Description

ID

O365ProPlusRetail

Required. ID must be set to a valid ProductRelease ID.

The supported ProductRelease IDs for Click-to-Run for Office 365 products are as follows:

  • O365ProPlusRetail

  • VisioProRetail

  • ProjectProRetail

  • SPDRetail (SharePoint Designer)

If ID is not set, the operation fails and indicates that the input is not valid.

The order of Product elements determines the order in which the products are installed. The first Product ID is used to determine in which context the Microsoft Office First Run Experience application starts. Microsoft Office First Run Experience refers to the first time each Office application starts.

NoteNote:
For a list of non-Office 365 product IDs that are supported, see Microsoft Knowledge Base article Product IDs that are supported by the Office Deployment Tool for Click-to-Run.

PIDKEY

12345-12345-12345-12345-12345

Optional. If PIDKEY is set, the specified 25 character PIDKEY value is used for this product.

The following example specifies Office 365 ProPlus.

<Product ID="O365ProPlusRetail" />

The following example specifies Office 365 ProPlus and Visio Pro for Office 365 in English (US), Spanish, and Japanese.

<Add SourcePath="\\Server\share" Version="15.1.2.3" OfficeClientEdition="32">
  <Product ID="O365ProPlusRetail" >
      <Language ID="en-us" />
      <Language ID="es-es" />
      <Language ID="ja-jp" />
  </Product>
  <Product ID="VisioProRetail" >
      <Language ID="en-us" />
      <Language ID="es-es" />
      <Language ID="ja-jp" />
  </Product>
</Add>
Property element

Supports generic properties as described below.

Syntax

<Property Name=string Value=string />

where:

  • Name is a required attribute. It indicates the name of the Property.

  • Value is an optional attribute. The default is an empty string.

The following table describes Property element attributes and values.

Property element attributes and values

Attribute Value Description

AUTOACTIVATE

1

0

If AUTOACTIVATE is set to 1, the specified products will attempt to activate automatically. If AUTOACTIVATE is not set, the user may see the Activation Wizard UI.

NoteNote:
Office 365 Click-to-Run products are already set to activate automatically. You must not set AUTOACTIVATE for Office 365 Click-to-Run products.
This setting applies only to perpetual retail versions of Click-to-Run products.

FORCEAPPSHUTDOWN

TRUE

FALSE

An installation or removal action may be blocked if Office applications are running. Normally, such cases would start a process killer UI. Administrators can set FORCEAPPSHUTDOWN value to TRUE to prevent dependence on user interaction. When FORCEAPPSHUTDOWN is set to TRUE, any applications that block the action will be shut down. Data loss may occur. When FORCEAPPSHUTDOWN is set to FALSE (default), the action may fail if Office applications are running.

PACKAGEGUID

12345678-ABCD-1234-ABCD-1234567890AB

Optional. By default, all Office 2013 App-V packages created by using the Office Deployment Tool 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.

SharedComputerLicensing

1

0

Optional. 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.

Example

<Property Name="AUTOACTIVATE" Value="1" />
Remove element

Removes products and languages.

Syntax

<Remove

All=TRUE | FALSE

>

{0 or N Product elements}

</Remove>

The following table describes Remove element attributes and values.

Remove element attributes and values

Attribute Value Description

All

TRUE

FALSE

Optional. The default is FALSE. If All is set to TRUE, all Click-to-Run products are removed.

ImportantImportant:
If Product elements are specified and they include Language element IDs, Setup removes the language resources for that product. This applies unless doing this would remove all language resources for that product, or if the product and language combination is also specified in the Add element that is included in the Click-to-Run Configuration.xml file.
If Product elements are specified and they do not include a Language element, Setup removes that product and any associated language resources. This applies unless the same Product is also found in the Add element in the Click-to-Run Configuration.xml file.
If All is set to TRUE, Setup removes the complete installation, regardless of what is specified in the Add element.

The code in the following example removes Office 365 ProPlus.

<Remove>
    <Product ID="O365ProPlusRetail" />
</Remove>

The code in the following example removes Spanish language resources from the Office 365 ProPlus installation.

<Remove>
    <Product ID="O365ProPlusRetail" >
      <Language ID="es-es" />
    </Product>
</Remove>

The code in the following example removes the whole installation.

<Remove All="TRUE" />
Updates element

Specifies attributes for configuring updates.

Syntax

<Updates

Enabled=TRUE | FALSE

UpdatePath=UNC | local | http path

TargetVersion=X.Y.Z.W

Deadline=MM/DD/YYYY HH:MM

/>

The following table describes Updates element attributes and values.

Updates element attributes and values

Attribute Value Description

Enabled

TRUE

FALSE

Optional. If Enabled is set to TRUE, the Click-to-Run update system will check for updates. If it is set to FALSE, the Click-to-Run update system is dormant.

UpdatePath

\\server\share\

C:\Preload\Office

http://internalApps/Office/

""

Optional. If UpdatePath is not set, Click-to-Run installations obtain updates from the Microsoft Click-to-Run source (Content Delivery Network or CDN). This is by default.

If UpdatePath is set to empty (""), updates are obtained from the Microsoft Click-to-Run source, CDN.

UpdatePath can specify a network, local, or HTTP path of a Click-to-Run source.

Environment variables can be used for network or local paths.

If you use Group Policy and the Office 2013 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 2013 (Machine)\Updates.

TargetVersion

15.1.2.3

""

Optional. If TargetVersion is not set, Click-to-Run updates to the most recent version from the Microsoft Click-to-Run source.

If TargetVersion is set to empty (""), Click-to-Run updates to the latest version from the Microsoft Click-to-Run source.

TargetVersion can be set to an Office build number, for example, 15.1.2.3. When the version is set, Office attempts to transition to the specified version in the next update cycle.

If you use Group Policy and the Office 2013 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 2013 (Machine)\Updates.

Deadline

05/16/2014 18:30

Optional. Sets a deadline by when updates to Office 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) and you must use at least version 15.0.4595.1000 of the Office Deployment Tool.

If you use Group Policy and the Office 2013 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 2013 (Machine)\Updates.

In the following example, Office updates are enabled, an alternative update path is used, the product version is set to 15.1.2.3, and the deadline is set to May 16, 2014 at 6:30 PM UTC.

<Updates Enabled="TRUE" UpdatePath="\\Server\share\" TargetVersion="15.1.2.3" Deadline="05/16/2014 18:30"/>

In the following example, updates are disabled.

<Updates Enabled="FALSE" />
Click-to-run Configuration.xml example

The code in the following Click-to-Run Configuration.xml file example specifies to install 32-bit Office 365 ProPlus and Visio Pro for Office 365 in English (US). It sets updates to Enabled, and uses an alternative source. It also sets Display Level to None, and accepts the end user licensing agreement.

<Configuration>
  <Add SourcePath="\\Server\Share" OfficeClientEdition="32" >
    <Product ID="O365ProPlusRetail">
      <Language ID="en-us" />
    </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>