Unable to clear side-loaded Word add-in from Word on Web

[jladbury]

I side-loaded two addins to Word on the Web by uploading them as documented at https://learn.microsoft.com/en-us/office/dev/add-ins/testing/sideload-office-add-ins-for-testing#manually-sideload-an-add-in-to-office-on-the-web
I tried to remove them using the instructions at https://learn.microsoft.com/en-us/office/dev/add-ins/testing/sideload-office-add-ins-for-testing#remove-a-sideloaded-add-in (clearing my browser cache). but they persist on the ribbon.

Your Environment

• Platform [Office on the web]: Running from https://www.microsoft365.com/launch/word?auth=1
• Host: Word
• Office version number: unknown - whatever Word on the Web is serving up
• Operating System: Windows 11 with all current updates
• Browser (if using Office on the web): Chrome Version 124.0.6367.207 (Official Build) (64-bit). Also occurs on Edge Version 124.0.2478.105 (Official build) (64-bit)

Expected behavior

Previously side-loaded add-ins should not be on the Ribbon when deleted as per instructions

Current behavior

Add-ins remain on Ribbon:

Steps to reproduce

Follow the steps mentioned in the description

Provide additional details

I also followed all the steps in https://learn.microsoft.com/en-gb/office/dev/add-ins/testing/clear-cache

[shanshanzheng-dev]

Hi @jladbury, Thanks for reporting this issue, If possible, could you share us manifest? Thanks.

[jladbury]

Here you go . . .

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<OfficeApp xmlns="http://schemas.microsoft.com/office/appforoffice/1.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bt="http://schemas.microsoft.com/office/officeappbasictypes/1.0" xmlns:ov="http://schemas.microsoft.com/office/taskpaneappversionoverrides" xsi:type="TaskPaneApp">

  <!-- Begin Basic Settings: Add-in metadata, used for all versions of Office unless override provided. -->

  <!-- IMPORTANT! Id must be unique for your add-in, if you reuse this manifest ensure that you change this id to a new GUID. -->
  <Id>88558cd5-91e3-47c4-9761-2faf405f75dc</Id>

  <!--Version. Updates from the store only get triggered if there is a version change. -->
  <Version>1.0.0.0</Version>
  <ProviderName>[Provider name]</ProviderName>
  <DefaultLocale>en-US</DefaultLocale>
  <!-- The display name of your add-in. Used on the store and various places of the Office UI such as the add-ins dialog. -->
  <DisplayName DefaultValue="c9wordExperiment04" />
  <Description DefaultValue="c9wordExperiment03 restructured as per c9 standards"/>

  <!-- Icon for your add-in. Used on installation screens and the add-ins dialog. -->
  <IconUrl DefaultValue="https://localhost/c9word-experiments/c9wordExperiment04/compiled/resources/icon-32.png" />
  <HighResolutionIconUrl DefaultValue="https://localhost/c9word-experiments/c9wordExperiment04/compiled/resources/icon-80.png"/>

  <!--If you plan to submit this add-in to the Office Store, uncomment the SupportUrl element below-->
  <!--<SupportUrl DefaultValue="[Insert the URL of a page that provides support information for the app]" />-->
  <SupportUrl DefaultValue="https://www.contoso.com/help"/>

  <!-- Domains that will be allowed when navigating. For example, if you use ShowTaskpane and then have an href link, navigation will only be allowed if the domain is on this list. -->
  <AppDomains>
    <AppDomain>AppDomain1</AppDomain>
    <AppDomain>AppDomain2</AppDomain>
    <AppDomain>AppDomain3</AppDomain>
  </AppDomains>
  <!--End Basic Settings. -->

  <!--Begin TaskPane Mode integration. This section is used if there are no VersionOverrides or if the Office client version does not support add-in commands. -->
  <Hosts>
    <Host Name="Document" />
  </Hosts>
  <DefaultSettings>
    <SourceLocation DefaultValue="https://localhost/c9word-experiments/c9wordExperiment04/compiled/taskpane.html" />
  </DefaultSettings>
  <!-- End TaskPane Mode integration.  -->

  <Permissions>ReadWriteDocument</Permissions>

  <!-- Begin Add-in Commands Mode integration. -->
  <VersionOverrides xmlns="http://schemas.microsoft.com/office/taskpaneappversionoverrides" xsi:type="VersionOverridesV1_0">

    <!-- The Hosts node is required. -->
    <Hosts>
      <!-- Each host can have a different set of commands. -->
      <!-- Excel host is Workbook, Word host is Document, and PowerPoint host is Presentation. -->
      <!-- Make sure the hosts you override match the hosts declared in the top section of the manifest. -->
      <Host xsi:type="Document">
        <!-- Form factor. Currently only DesktopFormFactor is supported. -->
        <DesktopFormFactor>
          <!--"This code enables a customizable message to be displayed when the add-in is loaded successfully upon individual install."-->
          <GetStarted>
            <!-- Title of the Getting Started callout. resid points to a ShortString resource -->
            <Title resid="GetStarted.Title"/>

            <!-- Description of the Getting Started callout. resid points to a LongString resource -->
            <Description resid="GetStarted.Description"/>

            <!-- Point to a url resource which details how the add-in should be used. -->
            <LearnMoreUrl resid="GetStarted.LearnMoreUrl"/>
          </GetStarted>
          <!-- Function file is a HTML page that includes the JavaScript where functions for ExecuteAction will be called.
            Think of the FunctionFile as the code behind ExecuteFunction. -->
          <FunctionFile resid="Commands.Url" />

          <!-- PrimaryCommandSurface is the main Office Ribbon. -->
          <ExtensionPoint xsi:type="PrimaryCommandSurface">
            <!-- Use OfficeTab to extend an existing Tab. Use CustomTab to create a new tab. -->
            <OfficeTab id="TabHome">
              <!-- Ensure you provide a unique id for the group. Recommendation for any IDs is to namespace using your company name. -->
              <Group id="CommandsGroup">
                <!-- Label for your group. resid must point to a ShortString resource. -->
                <Label resid="CommandsGroup.Label" />
                <!-- Icons. Required sizes 16,32,80, optional 20, 24, 40, 48, 64. Strongly recommended to provide all sizes for great UX. -->
                <!-- Use PNG icons. All URLs on the resources section must use HTTPS. -->
                <Icon>
                  <bt:Image size="16" resid="Icon.16x16" />
                  <bt:Image size="32" resid="Icon.32x32" />
                  <bt:Image size="80" resid="Icon.80x80" />
                </Icon>

                <!-- Control. It can be of type "Button" or "Menu". -->
                <Control xsi:type="Button" id="TaskpaneButton">
                  <Label resid="TaskpaneButton.Label" />
                  <Supertip>
                    <!-- ToolTip title. resid must point to a ShortString resource. -->
                    <Title resid="TaskpaneButton.Label" />
                    <!-- ToolTip description. resid must point to a LongString resource. -->
                    <Description resid="TaskpaneButton.Tooltip" />
                  </Supertip>
                  <Icon>
                    <bt:Image size="16" resid="Icon.16x16" />
                    <bt:Image size="32" resid="Icon.32x32" />
                    <bt:Image size="80" resid="Icon.80x80" />
                  </Icon>

                  <!-- This is what happens when the command is triggered (E.g. click on the Ribbon). Supported actions are ExecuteFunction or ShowTaskpane. -->
                  <Action xsi:type="ShowTaskpane">
                    <TaskpaneId>ButtonId1</TaskpaneId>
                    <!-- Provide a url resource id for the location that will be displayed on the task pane. -->
                    <SourceLocation resid="Taskpane.Url" />
                  </Action>
                </Control>
              </Group>
            </OfficeTab>
          </ExtensionPoint>
        </DesktopFormFactor>
      </Host>
    </Hosts>

    <!-- You can use resources across hosts and form factors. -->
    <Resources>
      <bt:Images>
        <bt:Image id="Icon.16x16" DefaultValue="https://localhost/c9word-experiments/c9wordExperiment04/compiled/resources/icon-16.png"/>
        <bt:Image id="Icon.32x32" DefaultValue="https://localhost/c9word-experiments/c9wordExperiment04/compiled/resources/icon-32.png"/>
        <bt:Image id="Icon.80x80" DefaultValue="https://localhost/c9word-experiments/c9wordExperiment04/compiled/resources/icon-80.png"/>
      </bt:Images>
      <bt:Urls>
        <bt:Url id="GetStarted.LearnMoreUrl" DefaultValue="https://go.microsoft.com/fwlink/?LinkId=276812" />
        <bt:Url id="Commands.Url" DefaultValue="https://localhost/commands.html" />
        <bt:Url id="Taskpane.Url" DefaultValue="https://localhost/c9word-experiments/c9wordExperiment04/compiled/taskpane.html" />
      </bt:Urls>
      <!-- ShortStrings max characters==125. -->
      <bt:ShortStrings>
        <bt:String id="GetStarted.Title" DefaultValue="Get started with your sample add-in!" />
        <bt:String id="CommandsGroup.Label" DefaultValue="Commands Group" />
        <bt:String id="TaskpaneButton.Label" DefaultValue="Show Taskpane" />
      </bt:ShortStrings>
      <!-- LongStrings max characters==250. -->
      <bt:LongStrings>
        <bt:String id="GetStarted.Description" DefaultValue="Your sample add-in loaded successfully. Go to the HOME tab and click the 'Show Taskpane' button to get started." />
        <bt:String id="TaskpaneButton.Tooltip" DefaultValue="Click to Show a Taskpane" />
      </bt:LongStrings>
    </Resources>
  </VersionOverrides>
  <!-- End Add-in Commands Mode integration. -->

</OfficeApp>

[Rick-Kirkham]

@jladbury

1. As a troubleshooting step, try opening the same document in desktop Word (logged in as the same user) and see if the buttons show up.

2. Since this is Word on the web, try clearing the browser cache.

3. Try using another browser to open the doc in Word on the web. Are the buttons there?

[jladbury]

Rick,
Thanks for taking a look at this. I have only just found time to consider your points.

Before I comment on them, I should say that, three days later, the add-ins have disappeared from the Ribbon. During those three days I have restarted the machine a couple of times, but sadly have no way of knowing if that was what made them go.

Taking your points in order:

1. The problem occurred whenever I created a new blank document. It might have occurred opening an existing one, but I did not check.
2. I cleared the browser cache in which Word was running, and also the cache of the add-in session. In both cases, I used the 'Application > Storage > Clear site data' function in the relevant Dev Tools, with all options checked
3. The problem occurred when running Word in Chrome and in Edge. I did not check any other browser.

[Wenjun-Gong]

@shanshanzheng-dev please help to take a look and see why clear cache did not work. Thanks.

[shanshanzheng-dev]

Hi @jladbury, We'll be looking into this problem, thanks for reporting this! Can't share timelines, but will report back here if if we have a suggestion for you. Thanks.

[shanshanzheng-dev]

Hi @jladbury They should refresh the page after clearing the cache. Does that work?

[jladbury]

No. From: shanshanzheng-dev ***@***.***> Sent: Tuesday, June 4, 2024 9:16 AM To: OfficeDev/office-js ***@***.***> Cc: Julian Ladbury ***@***.***>; Mention ***@***.***> Subject: Re: [OfficeDev/office-js] Unable to clear side-loaded Word add-in from Word on Web (Issue #4455) Hi @jladbury <https://github.com/jladbury> They should refresh the page after clearing the cache. Does that work? — Reply to this email directly, view it on GitHub <#4455 (comment)> , or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABFX6UGWFV64K37ZOKWSYDDZFVZUJAVCNFSM6AAAAABHXSA75OVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNBWHA4TINRTG4> . You are receiving this because you were mentioned. <https://github.com/notifications/beacon/ABFX6UC6MYUTJU5TXGKF4FLZFVZUJA5CNFSM6AAAAABHXSA75OWGG33NNVSW45C7OR4XAZNMJFZXG5LFINXW23LFNZ2KUY3PNVWWK3TUL5UWJTT764BS2.gif> Message ID: ***@***.*** ***@***.***> >