[all hosts] (Event based activation) Update debugging articles to reflect cross-host support (#5284)

AlexJerabek · samantharamon · web-flow · commit 521f12b022ee · 2025-07-15T15:16:11.000-07:00
* Update article to reflect general debugging steps for autorun

* Style fixes

* Apply suggestions from code review

Co-authored-by: Sam Ramon &lt;15154970+samantharamon@users.noreply.github.com&gt;

---------

Co-authored-by: Sam Ramon &lt;15154970+samantharamon@users.noreply.github.com&gt;
diff --git a/docs/includes/office-bundle-js.md b/docs/includes/office-bundle-js.md
@@ -0,0 +1,9 @@
+> [!TIP]
+>
+> - For readability, this article refers to the file name as **bundle.js**, but exact name depends on the Office application.
+>   - Excel: **bundle_excel.js**
+>   - Outlook: **bundle.js**.
+>   - PowerPoint: **bundle_powerpoint.js**
+>   - Word: **bundle_word.js**
+> - There's no direct method to determine the Office profile GUID and account encoding used in the **bundle.js** file path. The most effective approach to locate your add-in's **bundle.js** file is to manually inspect each folder until you locate the **Javascript** folder that contains your add-in's ID.
+> - The **bundle.js** file is downloaded to the local **Wef** folder when the add-in is first installed. It's refreshed every time the Office application starts or is restarted. If the **bundle.js** file doesn't appear in the **Wef** folder and your add-in is installed or sideloaded, restart Office. For Outlook, you may need to [remove your add-in](../outlook/sideload-outlook-add-ins-for-testing.md#remove-a-sideloaded-add-in), then [sideload](../outlook/sideload-outlook-add-ins-for-testing.md) it again.
diff --git a/docs/includes/outlook-bundle-js.md b/docs/includes/outlook-bundle-js.md
diff --git a/docs/testing/debug-autolaunch.md b/docs/testing/debug-autolaunch.md
@@ -1,7 +1,7 @@
 ---
 title: Debug event-based or spam-reporting add-ins
 description: Learn how to debug your Office Add-ins that implement event-based activation or integrated spam reporting.
-ms.date: 01/28/2025
+ms.date: 07/15/2025
 ms.topic: how-to
 ms.localizationpriority: medium
 ---
@@ -18,7 +18,7 @@ Use your preferred browser's developer tools to debug your event-based add-in in
 
 # [Windows (new)](#tab/new-windows)
 
-To debug your add-in in [new Outlook on Windows desktop client](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627), you must run the following command to open Microsoft Edge DevTools.
+To debug your add-in in [new Outlook on Windows desktop client](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627), run the following command to open Microsoft Edge DevTools.
 
 ```command&nbsp;line
 olk.exe --devtools
@@ -51,14 +51,14 @@ If you used the [Yeoman generator for Office Add-ins](../develop/yeoman-generato
 
         [!include[Developer registry key](../includes/developer-registry-key.md)]
 
-1. In the registry key `HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\[Add-in ID]`, where `[Add-in ID]` is your add-in's ID from the manifest, create a new `DWORD` value with the following configuration.
+1. In the registry key `HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\Developer\[Add-in ID]`, where `[Add-in ID]` is your add-in's ID from the manifest, create a new `DWORD` value with the following configuration.
 
     - **Value name**: `DebuggerPort`
     - **Value data (hexadecimal)**: `00002407`
 
    This sets the debugger port to `9223`.
 
-1. Start Outlook or restart it if it's already open.
+1. Start your Office application or restart it if it's already open.
 1. Perform the action to initiate the event you're developing for, such as creating a new message to initiate the `OnNewMessageCompose` event or reporting spam messages. The **Debug Event-based handler** dialog should appear. Do *not* interact with the dialog yet.
 
     ![The Debug Event-based handler dialog in Windows.](../images/outlook-win-autolaunch-debug-dialog.png)
@@ -77,10 +77,14 @@ You can debug your add-in using the Microsoft Edge Inspect tool or Visual Studio
     > [!NOTE]
     > It may take some time for your add-in to appear in the **Remote Target** section. You may need to refresh the page for the add-in to appear.
 
-1. In the **Sources** tab, go to **file://** > **Users/[User]/AppData/Microsoft/Office/16.0/Wef/{[Outlook profile GUID]}/[Outlook mail account encoding]/Javascript/[Add-in ID]\_[Add-in Version]_[locale]** > **bundle.js**.
+1. In the **Sources** tab, go to **file://** > **Users/[User]/AppData/Local/Microsoft/Office/16.0/Wef/{[Office profile GUID]}/[Office account encoding]/Javascript/[Add-in ID]\_[Add-in Version]_[locale]** > **bundle.js**. For readability, this article refers to the file name as **bundle.js**, but exact name depends on the Office application.
+    - Excel: **bundle_excel.js**
+    - Outlook: **bundle.js**
+    - PowerPoint: **bundle_powerpoint.js**
+    - Word: **bundle_word.js**
 
     > [!TIP]
-    > There's no direct method to determine the Outlook profile GUID or mail account encoding used in the **bundle.js** file path. If you're debugging multiple add-ins simultaneously, the easiest way to access an add-in's **bundle.js** file from the DevTools window is to locate the add-in's ID in the file path.
+    > There's no direct method to determine the Office profile GUID or mail account encoding used in the **bundle.js** file path. If you're debugging multiple add-ins simultaneously, the easiest way to access an add-in's **bundle.js** file from the DevTools window is to locate the add-in's ID in the file path.
 
 1. In the **bundle.js** file, place breakpoints where you want the debugger to stop.
 1. [Run the debugger](#run-the-debugger).
@@ -118,7 +122,7 @@ Configure the debugger in Visual Studio Code. Follow the steps applicable to you
 
 1. Create a new folder called **Debugging** (perhaps in your **Desktop** folder).
 1. Open Visual Studio Code.
-1. Go to **File** > **Open Folder**, navigate to the folder you just created, then choose **Select Folder**.
+1. Go to **File** > **Open Folder**, navigate to the folder you created, then choose **Select Folder**.
 1. On the Activity Bar, select **Run and Debug** (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>D</kbd>).
 
     ![The Run and Debug icon on the Activity Bar.](../images/vs-code-debug.png)
@@ -143,15 +147,15 @@ Configure the debugger in Visual Studio Code. Follow the steps applicable to you
 
 #### Attach the debugger
 
-The **bundle.js** file of an add-in contains the JavaScript code of your add-in. It's created when classic Outlook on Windows is opened. When Outlook starts, the **bundle.js** file of each installed add-in is cached in the **Wef** folder of your machine.
+The **bundle.js** file of an add-in contains the JavaScript code of your add-in. It's created when an Office on Windows application is opened. When Office starts, the **bundle.js** file of each installed add-in is cached in the **Wef** folder of your machine.
 
-1. To find the add-in's **bundle.js** file, navigate to the following folder in File Explorer. The text enclosed in `[]` represents your applicable Outlook and add-in information.
+1. To find the add-in's **bundle.js** file, navigate to the following folder in File Explorer. The text enclosed in `[]` represents your applicable Office and add-in information.
 
     ```text
-    %LOCALAPPDATA%\Microsoft\Office\16.0\Wef\{[Outlook profile GUID]}\[Outlook mail account encoding]\Javascript\[Add-in ID]_[Add-in Version]_[locale]
+    %LOCALAPPDATA%\Microsoft\Office\16.0\Wef\{[Office profile GUID]}\[Office account encoding]\Javascript\[Add-in ID]_[Add-in Version]_[locale]
     ```
 
-    [!INCLUDE [outlook-bundle-js](../includes/outlook-bundle-js.md)]
+    [!INCLUDE [office-bundle-js](../includes/office-bundle-js.md)]
 
 1. Open **bundle.js** in Visual Studio Code.
 1. Place breakpoints in **bundle.js** where you want the debugger to stop.
@@ -161,29 +165,29 @@ The **bundle.js** file of an add-in contains the JavaScript code of your add-in.
 
 ## Run the debugger
 
-After confirming that the debugger is attached, return to Outlook. In the **Debug Event-based handler** dialog, choose **OK** .
+After confirming that the debugger is attached, return to the Office application. In the **Debug Event-based handler** dialog, select **OK**.
 
-You can now hit your breakpoints to debug your event-based activation or spam-reporting code.
+You can now reach your breakpoints to debug your event-based activation or spam-reporting code.
 
 > [!IMPORTANT]
 > Starting in Version 2403 (Build 17425.20000), event-based and spam-reporting add-ins use the [V8 JavaScript engine](https://v8.dev/) to run JavaScript, regardless of whether debugging is turned on or off. In earlier versions, the Chakra JavaScript engine is used when debugging is off, but the V8 engine may be used when debugging is turned on.
 
 ## Stop the debugger
 
-To stop debugging the rest of the current Outlook on Windows session, in the **Debug Event-based handler** dialog, choose **Cancel**. To re-enable debugging, restart Outlook.
+To stop debugging the rest of the current Office on Windows session, in the **Debug Event-based handler** dialog, choose **Cancel**. To re-enable debugging, restart the Office application.
 
-To prevent the **Debug Event-based handler** dialog from popping up and stop debugging for subsequent Outlook sessions, delete the associated registry key, `HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\[Add-in ID]\UseDirectDebugger`, or set its value to `0`.
+To prevent the **Debug Event-based handler** dialog from popping up and stop debugging for subsequent sessions, delete the associated registry key, `HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\Developer\[Add-in ID]\UseDirectDebugger`, or set its value to `0`.
 
 ## Stop the local server
 
 [!include[Instructions to stop web server and uninstall dev add-in](../includes/stop-uninstall-outlook-dev-add-in.md)]
 
 # [Mac](#tab/mac)
 
-Event-based add-ins that run in Outlook on Mac use the browser runtime. Because of this, you can debug your add-in using Safari Web Inspector.
+Event-based add-ins that run in Office on Mac use the browser runtime. Because of this, you can debug your add-in using Safari Web Inspector.
 
-1. To use the Safari Web Inspector in Outlook, follow the steps in [Debugging with Safari Web Inspector on a Mac](debug-office-add-ins-on-ipad-and-mac.md#debugging-with-safari-web-inspector-on-a-mac).
-1. Open Outlook, then [sideload your add-in](../outlook/sideload-outlook-add-ins-for-testing.md).
+1. To use the Safari Web Inspector in Office, follow the steps in [Debugging with Safari Web Inspector on a Mac](debug-office-add-ins-on-ipad-and-mac.md#debugging-with-safari-web-inspector-on-a-mac).
+1. Open Office, then [sideload your add-in](../testing/test-debug-office-add-ins.md#sideload-an-office-add-in-for-testing).
 1. Perform an action that will initiate the event your add-in handles. For example, create a new message to initiate the `OnNewMessageCompose` event. This opens an empty Developer Window. The name of your add-in appears in the title bar of the window.
 1. Right-click (or select and hold) anywhere in the Developer Window, then select **Inspect Element**. This opens the Inspector, where you can set breakpoints and debug your add-in.
 
diff --git a/docs/testing/troubleshoot-event-based-and-spam-reporting-add-ins.md b/docs/testing/troubleshoot-event-based-and-spam-reporting-add-ins.md
@@ -1,7 +1,7 @@
 ---
 title: Troubleshoot event-based and spam-reporting add-ins
 description: Learn how to troubleshoot development errors in Office Add-ins that implement event-based activation or integrated spam reporting.
-ms.date: 07/02/2025
+ms.date: 07/15/2025
 ms.topic: troubleshooting
 ms.localizationpriority: medium
 ---
@@ -44,9 +44,9 @@ As you develop your [event-based](../develop/event-based-activation.md) or [spam
 
 - As you make changes to your add-in, be aware that:
   - If you update the manifest, remove the add-in, then sideload it again. For information on how to remove a sideloaded add-in from Outlook, see [Sideload Outlook add-ins for testing](../outlook/sideload-outlook-add-ins-for-testing.md#remove-a-sideloaded-add-in). If you're using Outlook on Windows, you must also close and reopen Outlook.
-  - If you make changes to files other than the manifest, close and reopen the Outlook client on Windows or on Mac, or refresh the browser tab running Outlook on the web.
+  - If you make changes to files other than the manifest, close and reopen the Office client on Windows or on Mac, or refresh the browser tab running Office on the web.
   - If you're still unable to see your changes after performing these steps, [clear your Office cache](../testing/clear-cache.md).
-- As you test your add-in in classic Outlook on Windows:
+- As you test your add-in in Office on Windows (excluding the new Outlook on Windows):
   - For event-based add-ins, check [Event Viewer](/shows/inside/event-viewer) for any reported add-in errors.
     1. In Event Viewer, select **Windows Logs** > **Application**.
     1. From the **Actions** panel, select **Filter Current Log**.
@@ -57,13 +57,13 @@ As you develop your [event-based](../develop/event-based-activation.md) or [spam
 
     :::image type="content" source="../images/outlook-event-based-logs.png" alt-text="A sample of Event Viewer's Filter Current Log settings configured to only show Outlook errors with event ID 63 that occurred in the last hour.":::
 
-  - Verify that the **bundle.js** file is downloaded to the following folder in File Explorer. The text enclosed in `[]` represents your applicable Outlook and add-in information.
+  - Verify that the **bundle.js** file is downloaded to the following folder in File Explorer. The text enclosed in `[]` represents your applicable Office and add-in information.
   
     ```text
-    %LOCALAPPDATA%\Microsoft\Office\16.0\Wef\{[Outlook profile GUID]}\[Outlook mail account encoding]\Javascript\[Add-in ID]_[Add-in Version]_[locale]
+    %LOCALAPPDATA%\Microsoft\Office\16.0\Wef\{[Office profile GUID]}\[Office account encoding]\Javascript\[Add-in ID]_[Add-in Version]_[locale]
     ```
 
-    [!INCLUDE [outlook-bundle-js](../includes/outlook-bundle-js.md)]
+    [!INCLUDE [office-bundle-js](../includes/office-bundle-js.md)]
 
 - As you test your add-in on desktop clients (excluding new Outlook on Windows) enable runtime logging to identify possible manifest and add-in installation issues. For guidance on how to use runtime logging, see [Debug your add-in with runtime logging](../testing/runtime-logging.md).
 - Set breakpoints in your code to debug your add-in. For platform-specific instructions, see [Debug event-based and spam-reporting add-ins](debug-autolaunch.md).
