The following notes are for deploying the Office 365 Click-to-Run (C2R) suite of applications in an enterprise environment. Most of the information here leans towards an Office 2016 Professional Plus deployment.
[Update] This post was updated 14-Oct-2017 to reflect the new Update Channel names. According to Microsoft, the old update channel names are still supported in the latest version of the deployment tool. Test before you deploy.
Office 365 Deployment Tool
The Office 365 Deployment Tool (ODT) is used to download Office products and language files to your local network. You can then deploy those Office products and languages to computers from a network share, or push the installation files to a machine with a management tool, and install locally.
There are two different versions of the Office Deployment Tool available – one for Office 2013 and a different one for Office 2016. Each one works only with that specific version of Office. You can download them from the Microsoft Download Center by using the following links:
The file that you download is just an archive that contains two files:
- Setup.exe
- Configuration.xml
Setup.exe
Setup.exe is a standalone executable that requires one of 4 switches to operate.
/download Downloads files to create an Office installation source /configure Adds, removes, or configures an Office installation /packager Produces an Office App-V package from an Office installation source /help Displays the help information
Setup.exe also requires a path to an XML file in the command. Here are some examples:
setup.exe /download "C:\O365-Install\2016\ProPlus\download.xml" setup.exe /configure "C:\O365-Install\2016\ProPlus\install.xml" setup.exe /download "\\FileServer\FileShare\2016\ProPlus\download.xml" setup.exe /configure "\\FileServer\FileShare\2016\ProPlus\install.xml"
Configuration.xml
Configuration.xml is an example XML file. The XML files are used to define how “setup.exe” downloads an Office installation source, or how it configures an Office installation. It can also create an Office App-V package, but that is not covered here.
Downloading Office 365 ProPlus
When downloading the Office C2R source bits, the XML defines the following:
Source Path
The path to where the Office folder is created by setup.exe. The Office C2R source bits will be downloaded into the Office folder. If no path is given, the Office folder is created in the same location as setup.exe.
Office Client Edition
The bit architecture to download: 32-bit or 64-bit.
Update Channel
The Office 2016 update channel to download from (Insiders, Monthly, Targeted or Broad).
Product ID
The Office product suite to download. You cannot download individual Office suite applications.
Languages
One or more languages to include in the download.
Example XML for downloading Office 2016 Pro Plus, 32-bit, English-US:
<!-- DOWNLOAD Office 2016 ProPlus 32 English-US --> <Configuration> <Add SourcePath="C:\Path\to\save\files" OfficeClientEdition="32" Channel="Broad"> <Product ID="O365ProPlusRetail"> <Language ID="en-us" /> </Product> </Add> </Configuration>
Example XML for downloading Office 365 Pro Plus, Visio Pro, Project Pro, 32-bit, English-US
<!-- DOWNLOAD Office 2016 ProPlus, Visio Pro, Project Pro, 32 English-US --> <Configuration> <Add SourcePath="C:\Path\to\save\files" OfficeClientEdition="32" Channel="Broad"> <Product ID="O365ProPlusRetail"> <Language ID="en-us" /> </Product> <Product ID="VisioProRetail"> <Language ID="en-us" /> </Product> <Product ID="ProjectProRetail"> <Language ID="en-us" /> </Product> </Add> </Configuration>
Installing Office 365 ProPlus
When installing Office, or re-configuring an existing installation, the XML defines the following:
Source Path
The path to where the Office folder is located. The path can be a local file path, a UNC path to a file share, or an HTTP URL to a website. For the local and UNC paths, the path must contain a trailing “\” at the end of the path, and none of the paths should include the Office folder.
Office Client Edition
The bit architecture being installed: 32-bit or 64-bit.
Product ID
The Office product suite to install. You can also define exclusions for individual Office applications.
Languages
One or more languages to include. The first language listed will become the primary language.
Display Level & EULA
The display level during installation (None or Full), and if the EULA is accepted (True or False).
Logging
The logging level (Off or Standard), and the file path for the log file (local path or UNC).
Updates
Define if updates are enabled and the update path. If the update path is not defined, the Office apps will download and install their updates from Microsoft’s CDN. Additional update parameters include the update channel, target version, and deadline. Whenever possible, all of the update parameters should be controlled using group policy, which is done at the machine level.
Example XML for installing Office 2016 Pro Plus, 32-bit, English-US:
<!-- INSTALL Office 2016 ProPlus 32 English-US --> <Configuration> <Add SourcePath="\\Server\Share\ProPlus\" OfficeClientEdition="32"> <Product ID="O365ProPlusRetail"> <Language ID="en-us" /> </Product> </Add> <Updates Enabled="TRUE" UpdatePath="\\Server\Share\ProPlus\" /> <Display Level="None" AcceptEULA="TRUE" /> <Logging Level="Standard" Path="%temp%" /> </Configuration>
XML Resources
Microsoft has provided a website that can be used to generate the XML code
http://officedev.github.io/Office-IT-Pro-Deployment-Scripts/XmlEditor.html
TechNet Reference for the XML Code
https://technet.microsoft.com/en-us/library/jj219426.aspx
Update Channels & Group Policy ADMX/ADML
Microsoft Support Article for the Office 365 ProPlus Update Channels
https://support.office.com/en-us/article/Overview-of-update-channels-for-Office-365-ProPlus-9ccf0f13-28ff-4975-9bd2-7e4ea2fefef4
Download the Office 2016 Administrative Template files (ADMX/ADML)
https://www.microsoft.com/en-us/download/details.aspx?id=49030
Excluding Office Applications
Use the ExcludeApp XML element to exclude Office applications from an installation. When the ExcludeApp XML element is not used, all of the Office applications included in the suite are installed on the computer.
<ExcludeApp ID="Access" /> <ExcludeApp ID="Excel" /> <ExcludeApp ID="Groove" /> <ExcludeApp ID="InfoPath" /> <ExcludeApp ID="Lync" /> <ExcludeApp ID="OneDrive" /> <ExcludeApp ID="OneNote" /> <ExcludeApp ID="Outlook" /> <ExcludeApp ID="PowerPoint" /> <ExcludeApp ID="Publisher" /> <ExcludeApp ID="Word" />
- “Groove” is used to exclude OneDrive for Business when deploying Office 2013, and early versions of Office 2016.
- “OneDrive” is used to exclude the next generation OneDrive for Business sync client deployed with the newest versions of Office 2016, and the personal online storage service.
- “Lync” also applies to Skype for Business.
- Microsoft includes InfoPath in Office 2013 ProPlus, but they removed it from Office 2016.
Example XML for installing Office 2016 ProPlus without OneDrive & Publisher:
<!-- INSTALL Office 2016 ProPlus 32 English-US -->
<!-- EXCLUDE OneDrive, Publisher -->
<Configuration>
<Add SourcePath="\\Server\Share\ProPlus\" OfficeClientEdition="32">
<Product ID="O365ProPlusRetail">
<Language ID="en-us" />
<ExcludeApp ID="OneDrive" />
<ExcludeApp ID="Publisher" />
</Product>
</Add>
<Updates Enabled="TRUE" UpdatePath="\\Server\Share\ProPlus\" />
<Display Level="Full" AcceptEULA="TRUE" />
<Logging Level="Standard" Path="C:\O365-Logs\" />
</Configuration>
Multi-Language Downloads & Installations
The language XML elements specify which languages will be downloaded or installed.
- Include all required language IDs when downloading the Office bits, and then use this download as a single source for installing one or more of those languages to the user base.
- Each additional language adds approximately 150-200 MB to the size of the Office bits.
- MatchOS tells the installer to install the same language as the client’s operating system.
- When installing, the first language listed becomes the primary language, and determines the Shell UI language.
- The Shell UI is the language that is used to display shortcuts, right-click context menus, and tooltips.
- If the user changes languages in the app, the right-click menus remain with the primary language.
- If you decide that you want to change the Shell UI language after an initial installation, you have to uninstall Office, and then reinstall it.
- You cannot use the .msi installers to add language packs to Office 2016 click to run installations.
A list of language IDs can be found here: https://technet.microsoft.com/EN-US/library/cc179219(v=office.16).aspx
Example XML for downloading multiple languages in Office 2016
<!-- DOWNLOAD Office 2016 ProPlus 32 Multi --> <Configuration> <Add SourcePath="C:\Path\to\download\files" OfficeClientEdition="32" Channel="Broad"> <Product ID="O365ProPlusRetail"> <Language ID="MatchOS" /> <Language ID="fr-fr" /> <Language ID="es-es" /> <Language ID="hi-in" /> </Product> </Add> </Configuration>
Example XML for installing two languages in Office 2016
<!-- INSTALL Office 2016 ProPlus 32 Multi --> <Configuration> <Add SourcePath="\\Server\Share\ProPlus\" OfficeClientEdition="32"> <Product ID="O365ProPlusRetail"> <Language ID="hi-in" /> <Language ID="en-us" /> </Product> </Add> <Updates Enabled="TRUE" UpdatePath="\\Server\Share\ProPlus\" /> <Display Level="Full" AcceptEULA="TRUE" /> <Logging Level="Standard" Path="%temp%" /> </Configuration>
Installing Multiple Products & Languages
Example XML for a silent install of Office 2016 Pro Plus (excluding OneDrive), and Visio Pro, with both using multiple languages.
<!-- INSTALL Office 2016 ProPlus 32 Multi --> <!-- EXCLUDE OneDrive --> <!-- INSTALL Visio 2016 Pro Multi --> <Configuration> <Add SourcePath="\\Server\Share\ProPlus\" OfficeClientEdition="32"> <Product ID="O365ProPlusRetail"> <Language ID="en-us" /> <Language ID="es-es" /> <ExcludeApp ID="OneDrive" /> </Product> <Product ID="VisioProRetail"> <Language ID="en-us" /> <Language ID="es-es" /> </Product> </Add> <Updates Enabled="TRUE" UpdatePath="\\Server\Share\ProPlus\" /> <Display Level="None" AcceptEULA="TRUE" /> <Logging Level="Standard" Path="C:\O365-Logs\" /> </Configuration>
Shared Computer Licensing
Shared computer licensing lets you deploy Office 365 Professional Plus to a computer in your organization that is accessed by multiple users (Terminal Services, RDS, VDI, etc.). This is only supported with Office 365 Professional Plus.
To turn on shared computer licensing, include the following XML element:
<Property Name="SharedComputerLicensing" Value="1" />
Example XML for installing Office 2016 Pro Plus on a terminal server:
<!-- INSTALL Office 2016 ProPlus 32 English-US --> <Configuration> <Add SourcePath="\\Server\Share\ProPlus\" OfficeClientEdition="32"> <Product ID="O365ProPlusRetail"> <Language ID="en-us" /> </Product> </Add> <Updates Enabled="TRUE" UpdatePath="\\Server\Share\ProPlus\" /> <Display Level="Full" AcceptEULA="TRUE" /> <Logging Level="Standard" Path="C:\O365-Logs\" /> <Property Name="SharedComputerLicensing" Value="1" /> </Configuration>
More information about Shared Computer Licensing can be found here: https://support.office.com/en-us/article/Overview-of-shared-computer-activation-for-Office-365-ProPlus-836f882c-8ff6-4f19-8b24-0212e0111c94
Removing an Office Installation
The XML can be used to remove any combination of Office C2R products and/or the installed languages.
- To remove an installed language in a multi-language installation of a product, you must specify the Product ID and the Language ID that you want to remove.
- To remove a product completely, you must specify the Product ID and all of the Language IDs that are installed.
- It is recommended to include the Force App Shutdown XML element to make sure all Office apps are closed before removing.
Example XML to remove all Office C2R products
<!-- REMOVE ALL Office C2R Products --> <Configuration> <Remove All="TRUE"></Remove> <Property Name="FORCEAPPSHUTDOWN" Value="TRUE"/> </Configuration>
Example XML to remove French-FR from a multi-language installation of Office 2016 Pro Plus
<!-- REMOVE French-FR from Office 2016 ProPlus --> <Configuration> <Remove> <Product ID="O365ProPlusRetail"> <Language ID="fr-fr"/> </Product> </Remove> <Property Name="FORCEAPPSHUTDOWN" Value="TRUE"/> </Configuration>
Example XML to remove Visio Pro (English-US) and Project Pro (English-US)
<!-- REMOVE Visio & Project Pro English-US --> <Configuration> <Remove> <Product ID="VisioProRetail"> <Language ID="en-us"/> </Product> <Product ID="ProjectProRetail"> <Language ID="en-us"/> </Product> </Remove> <Property Name="FORCEAPPSHUTDOWN" Value="TRUE"/> </Configuration>
Re-configuring an Office Installation
Re-configuring is used for making changes to an Office installation. For example, an administrator may need to add/remove specific Office applications or languages.
- Use a combination of the XML ExcludeApp elements to add/remove Office Applications
- Use a combination of the XML Language IDs to add/remove language packs.
- If you are changing the primary language (the first language ID listed), you have to uninstall Office before installing with a new primary language.
- Use the Force App Shutdown XML element to make sure all Office apps are closed before re-configuring.
Repairing an Office Installation
If an Office application isn’t working properly, sometimes restarting it will fix the problem. If that doesn’t work, you can try repairing it. When the repair is done, the computer may need to be restarted.
- Performing a full online repair of Office will install any excluded applications.
- The quick repair does not install excluded Office applications.
Repair Using Programs & Features
Control Panel > Programs > Programs and Features
- Click the Office product you want to repair, and then click Change
- For a Quick Repair: Quick Repair > Repair
- For a Full Online Repair: Online Repair > Repair
Repair from the Command Line
Office Click-to-Run from Office 365 allows you to automate either a quick repair or an online full repair.
OfficeClicktoRun.exe is the executable that will allow you to automate a repair in Office 2016. This executable needs to run with elevated permissions, and it resides in the following location:
%Program Files%\Common Files\Microsoft Shared\ClickToRun\OfficeClicktoRun.exe
Example Command
OfficeClicktoRun.exe scenario=Repair platform=x86 culture=en-us RepairType=QuickRepair forceappshutdown=True DisplayLevel=False
List of Available Variables
Variable Possible Values Required -------- --------------- -------- scenario Repair Yes platform x86 | x64 Yes culture ll-cc Yes forceappshutdown True | False No RepairType QuickRepair | FullRepair No DisplayLevel True | False No
Skype for Business Client (SFB)
General Info
- The SFB client included with an Office suite (e.g. ProPlus) requires an activation.
- The SFB Basic client is free to download and install from Microsoft, and it does not require an activation.
- The XML Product IDs for SFB are used for installation only. If you try to use an SFB product ID for a download, setup.exe will just download the entire suite of applications (~1.2 GB with a single language).
- The free SFB Basic versions cannot be used in shared computer deployments (Terminal Services, RDS, VDI, etc.). This includes both C2R and MSI installations.
Multi-Language Installations
- Multiple XML language IDs can be included with the SFB Product ID when installing SFB as a stand-alone application.
- The SFB 2016 GUI does not include an option to change languages like the other Office applications.
- In a stand-alone installation, language changes are made using the Office 2016 Language Preferences, which is located in the Microsoft Office Tools folder of the Start menu.
XML Product IDs
Product Name Deployment Tool XML Product ID ------------ --------------- -------------- Skype for Business 2016 Office 2016 SkypeforBusinessRetail Skype for Business Basic 2016 Office 2016 SkypeforBusinessEntryRetail Skype for Business 2015 Office 2013 LyncRetail Skype for Business Basic 2015 Office 2013 LyncEntryRetail