4 out of 7 rated this helpful - Rate this topic

Reference for Click-to-Run configuration.xml file

Office 365

Updated: April 16, 2013

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

Applies to: Office 365 ProPlus

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

Important:
This article is part of the Content roadmap for 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.

Important:

This article is part of the Content roadmap for 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:

Click-to-Run Configuration.xml quick reference
Click-to-Run Configuration.xml file format
Click-to-Run Configuration.xml reference
Click-to-run Configuration.xml example

Note:
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. Click-to-Run is not customizable at the application level. However, there are some options: Administrators can use AppLocker to prevent an application from running. For more information about AppLocker, see: Windows 7 AppLocker Executive Overview and AppLocker. Delete the shortcuts to the applications that you don’t want to install on the client computers. Purchase the Windows Installer-based (MSI) version of Office 2013. For more information, please visit the Volume Licensing Service Center.

Note:

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.

Click-to-Run is not customizable at the application level. However, there are some options:

Administrators can use AppLocker to prevent an application from running. For more information about AppLocker, see: Windows 7 AppLocker Executive Overview and AppLocker.
Delete the shortcuts to the applications that you don’t want to install on the client computers.
Purchase the Windows Installer-based (MSI) version of Office 2013. For more information, please visit the Volume Licensing Service Center.

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
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"

ForceDowngrade= TRUE | FALSE

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. It indicates the installation source path from which to install Office when you run the Office Deployment Tool in configure mode. SourcePath specifies the path of the Click-to-RunOffice 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-RunOffice installation source). Version can be set to an Office 2013 build number by using this format: X.X.X.X
ForceDowngrade	TRUE or FALSE	Optional. If ForceDowngrade is not set, it is interpreted as FALSE. When you add products, new files will be downloaded only when the files are newer than those that are already installed on the client. If ForceDowngrade is set to TRUE and a Version attribute is specified, the product that is being downloaded will download all the product files for the specified version, even if newer files are installed on the client.
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.

Note:
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.

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.

Example:

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

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.

Attribute

Value

Description

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.

Note:
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.

Note:

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

Name = valid file name

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		Optional. Specifies the name of the log file. The name may contain a special asterisk ‘’ character. If you use an ‘’ character, it is dynamically replaced with a time stamp.

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

Optional. Specifies the name of the log file. The name may contain a special asterisk ‘*’ character. If you use an ‘*’ character, it is dynamically replaced with a time stamp.

Example:

<Logging Level="Standard" Path="%temp%" 
   Name="C2RLog(*).txt" 
/>

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

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.

Note:
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

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.

Note:

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.

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.

Attribute

Value

Description

All

TRUE

FALSE

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

Important:
If Product element 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 element 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.

Important:

If Product element 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 element 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

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

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.

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.

In the following example, Office updates are enabled, an alternative update path is used, Internet fallback is allowed, and the product version is set to 15.1.2.3.

<Updates Enabled="TRUE" UpdatePath="\\Server\share\" TargetVersion="15.1.2.3" />

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, accepts the end user licensing agreement, and specifies the name of the log file.

<Configuration>
  <Add SourcePath="\\Server\Share\Office\" 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\Office\" /> 
  <Display Level="None" AcceptEULA="TRUE" />  
  <Logging Name="OfficeSetup.txt" Path="%temp%" /> 
</Configuration>

Change History

Date	Description
April 16, 2013	Updated information about the FORCEAPPSHUTDOWN attribute for the Property element.
February 19, 2013	Updated information about the Language element and the SourcePath description. Added information about the Property element (new), and provided a new Click-to-run Configuration.xml example.
July 16, 2012	Initial publication

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)