Connect Azure Boards to an Office client
Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019
To support your work tracking efforts, you can use Microsoft Excel. You can either work in online mode, where you're connected to either Azure Boards or Azure DevOps Server. Or, work in offline mode, where you access the local computer and document.
Tip
For bulk import or to update work items, use the web portal or CSV import.
Supported Office clients and Azure DevOps versions
The following table indicates the Office clients supported for each Azure DevOps version. MacOS isn't supported. Even if you installed Visual Studio for Mac, connection to Azure DevOps from Excel or any other Office client isn't supported.
Azure DevOps/Visual Studio version
Excel
Project1
PowerPoint Storyboarding2
Azure DevOps Services
Azure DevOps Server 2020
Azure DevOps Server 2019
Visual Studio 2022
Visual Studio 2019
Azure DevOps Office Integration 2019
✔️
TFS 2018
Visual Studio 2017
✔️
✔️
✔️
Note
- Support for Project integration and the TFSFieldMapping command is deprecated for Azure DevOps Server 2019 and later versions. You might find support using one of the Marketplace extensions.
- Support for linking PowerPoint files to work items from within PowerPoint is deprecated starting with Visual Studio 2019 and Azure DevOps Office Integration 2019. You can still link to PowerPoint using the Storyboard link from within a work item. Also, the Visual Studio Gallery for PowerPoint Storyboarding is deprecated.
Prerequisites
Connection from an Office client to an Azure Boards project requires the following software and permissions.
- To connect Excel to Azure Boards, install Office Excel 2010 or later version, including Office Excel 365.
- All Office integration tasks require an installed version of Visual Studio or the free Azure DevOps Office Integration 2019.
- The only way to get the Azure DevOps Office Integration plug-in is to install one of the latest editions of Visual Studio or Azure DevOps Office Integration. The plug-in supports connection to Azure DevOps from Excel.
- To connect to an Azure Boards project, you need to be a member of the project. If you don't have an Azure Boards project yet, you can create one.
- To connect Excel to Azure Boards, you must install Office Excel 2010 or later version, including Microsoft 365.
- All Office integration tasks require that you install a version of Visual Studio or the free Azure DevOps Office Integration 2019
- The only way to get the Team Foundation plug-in is to install one of the latest editions of Visual Studio or Azure DevOps Office Integration 2019. The Azure DevOps Office Integration 2019 plug-in supports connection to Azure DevOps from Excel.
- To connect to an Azure Boards project, you need to be a member of the project. If you don't have an Azure Boards project yet, you can create one.
- Microsoft Excel 2010 or later version, including Microsoft Office Excel 365
- Visual Studio 2013 or later version or Team Foundation Server Standalone Office Integration (free)
- Permissions to connect to the project in Azure Boards.
For information about compatibility requirements, see Compatibility with Azure DevOps.
Important
You might receive the following error if you install Microsoft Office 2010 on the same computer as a previous version of Office.
Team Foundation Error, Interface not registered (Exception from HRESULT: 0x80040155)
You might resolve this error by repairing Office. Access the Repair option by opening the Control Panel, choose Uninstall or change a program, open the context menu for Office 2010, and then choose Change. For more information, see Azure DevOps-Office integration issues.
Publish and refresh work items
When you add or update work items from Excel, local copies of your work items are created. To keep data in sync, it's important to refresh your local file when you open it and publish and refresh frequently during a long online session.
At first, the data in the local document matches the data in the database. But you or other team members can change the data about work items and cause the two to differ. To view the most recent changes from the database, refresh the document. The refresh downloads the latest values in the data store to your local document. To write changes from the document to the database, publish the changes. Publishing uploads the changes you made to the work item tracking data store.
To keep work items in sync from your local data store and Azure Boards, publish and refresh often.
Azure DevOps and Excel
To work in Excel, see Bulk add work items with Excel.
Connect an Azure DevOps project to Excel
To add or modify work items by using Excel, connect your worksheet to a project. Establish this connection to bind the document to the Azure DevOps project to exchange information.
Note
- While this section illustrates how to connect Excel to an Azure Boards project, the steps to connect to PowerPoint are similar.
- When you connect to Azure Boards in the cloud, the Team Project Collection automatically gets selected, as there's only one collection associated with your Azure DevOps Services organization. When you connect to Azure Boards in an on-premises server, choose the Team Project Collection prior to choosing the project.
You can start work from the web portal, Excel, or Visual Studio/Team Explorer. Your worksheet is associated with either a list of work items or a work item query.
- Open query in Excel (web portal)
- Connect from client to Azure Boards
- Connect client to Azure DevOps on-premises
- Open Excel from Visual Studio
This connection method requires that you install Azure DevOps Open in Excel. It also requires Visual Studio 2017 or later version.
From your web browser, (1) check that you selected the right project, (2) choose Boards > Queries, and then (3) choose All.
Choose the query you want to open in Excel.
From the Results tab, choose the
actions icon.
For more information, see Bulk add work items with Excel.
Tip
You can use multiple worksheets within an Excel workbook to work with different input or query lists. But, you can only connect to one project per workbook.
If you move your Azure DevOps project to a different project collection in the same instance of Azure DevOps, your documents automatically reconnect. But, if the project moves to a different instance of Azure DevOps, you must manually reconnect your documents to the new server.
Work offline and reconnect to Azure Boards
One advantage of working in Excel is that you can work offline and add or modify work items. The following procedures show you how to disconnect an Excel work item list from Azure Boards. You can then reconnect later to synchronize the document with the work item database.
Note
If the project that contains work items for your Excel document is moved to a different organization or Azure DevOps Server instance, you must reconfigure the server to which the document connects. For more information, see Connect Azure DevOps project to Excel provided earlier in this article.
Disconnect a document file from the network
To disconnect an Excel document file from the network:
Open the document that you want to change while you're offline.
Refresh the work item list to retrieve the latest information from the work item database. In Excel, on the Team ribbon, in the Work Items group, choose Refresh.
Add to the work item list the columns for all fields that you want to modify. You can't add columns when the work item list is disconnected from the server.
Disconnect your computer from the network, or save the work item list file and copy it to another computer.
An error message might appear that tells you the Office program couldn't establish a connection with an Azure DevOps Server.
Modify or update the work item list as needed.
You can't create most types of links between work items when the work item document is disconnected from the system. The exceptions are parent-child links in an Excel tree list.
Reconnect a file to Azure Boards
To reconnect an Excel document file:
Reconnect your computer to the network, or copy the file to a computer that is connected to Azure Boards.
If you changed the document offline, in Excel, on the Team ribbon, in the Work Items group, choose Publish.
If you didn't change the document offline, in Excel, on the Team ribbon, in the Work Items group, choose Refresh.
Resolve any data validation errors or conflicts that occur.
Marketplace extensions
The following Marketplace extensions support integration between Azure DevOps and Office products.
- Azure DevOps Open in Excel: Opens a selected query in Excel.
- Office 365 Integration: Pushes notifications of configurable Azure DevOps events to an Office 365 Group.