| title | description | ms.date | localization_priority |
|---|---|---|---|
Test and debug Office Add-ins |
Learn how to test and debug your Office Add-in |
05/19/2021 |
Priority |
This article contains guidance about testing, debugging, and troubleshooting issues with Office Add-ins.
Office Add-ins run across major platforms, so you need to test an add-in in all the platforms where your users might be running Office. This usually includes Office on the web, Office on Windows (both subscription and one-time purchase), Office on Mac, Office on iOS, and (for Outlook add-ins) Office on Android. However, there may be some situations in which you can be sure that none of your users will be working on some platforms. For example, if you are making an add-in for a company that requires its users to work with Windows computers and subscription Office, then you don't need to test for Office on Mac or one-time purchase Windows.
Note
On Windows computers, the version of Windows and Office will determine which browser control is used by add-ins. For more information, see Browsers used by Office Add-ins.
Important
Add-ins marketed through AppSource go through a validation process that includes testing on all platforms. In addition, add-ins are tested for Office on the web with all major modern browsers, including Microsoft Edge (Chromium-based WebView2), Chrome, and Safari. Accordingly, you should test on these platforms and browsers before you submit to AppSource. For more information about validation, see Commercial marketplace certification policies, especially section 1120.3, and the Office Add-in application and availability page.
AppSource does not use Internet Explorer or the legacy version of Microsoft Edge (WebView1) to test add-ins in Office on the web. But if a significant number of your users will use these two browsers to open Office on the web, then you should test with them. For more information, see Support Internet Explorer 11 and Troubleshooting Microsoft Edge issues. Office still supports these browsers for add-ins, so if you think you've encountered a bug in how add-ins run in them, please create an issue for the office-js repo.
You can use sideloading to install an Office Add-in for testing without having to first put it in an add-in catalog. The procedure for sideloading an add-in varies by platform, and in some cases, by product as well. The following articles each describe how to sideload Office Add-ins on a specific platform or within a specific product.
The procedure for debugging an Office Add-in varies by platform as well. Each of the following articles describes how to debug Office Add-ins on a specific platform.
For information about how to validate the manifest file that describes your Office Add-in and troubleshoot issues with the manifest file, see Validate and troubleshoot issues with your manifest.
For information about how to resolve common issues that users may encounter with your Office Add-in, see Troubleshoot user errors with Office Add-ins.