Sideloading unified manifest Add-ins - Required office app versions?

Question

Sideloading unified manifest Add-ins - Required office app versions?

Mikael Nilsson 0

The documentation at
https://learn.microsoft.com/en-us/office/dev/add-ins/develop/convert-xml-to-json-manifest
states:
"Add-ins that use the unified manifest can be sideloaded only on Office Version 2304 (Build 16320.20000) or later."**
**
We are running later versions of for example Word
Microsoft® Word for Microsoft 365 MSO (Version 2501 Build 16.0.18429.20132) 32-bit
But sideloading a unified manifest app created with "yo office" does only sideload in outlook, no other office apps works.

Can anyone clarify the requirements sideloading for unified manifest add-ins during development?

And... when can we expect to see full support across all the office applications for this?

Rick Kirkham 281 Reputation points Microsoft Employee

2025-03-26T21:12:26.36+00:00
Please provide some clarification:

Are you following the instructions at [Sideload with a system prompt, bash shell, or terminal]?

What exactly goes wrong when you sideload a non-Outlook add-in? For example, is there an error message? What do you expect to see and what do you actually see?

Also, see if upgrading to Version 2504 xxxxx.xxxxx has any effect.
Mikael Nilsson 0 Reputation points

2025-03-26T21:20:22.4666667+00:00
Effectively yes. Running the add-in from VS code > npm
"start": "office-addin-debugging start manifest.xml

I don't know. There is no error message, or any form of feedback. It just does nothing.
I Expect to see a ribbon button and a taskpane add-in.

Office version is centrally contolled by organization so i can't install other versions at the moment.

Rick Kirkham 281 Microsoft Employee

I think I see the problem. You converted a project that used the XML manifest to the unified manifest, but the scripts in the package.json are still the scripts for the XML manifest. Take these steps and if it works, I'll update the documentation.

Open the package.json file in the root of the project.

Replace the "devDependencies" section with the following:

   "devDependencies": {
    "@babel/core": "^7.24.0",
    "@babel/preset-typescript": "^7.23.3",
    "@types/office-js": "^1.0.377",
    "@types/office-runtime": "^1.0.35",
    "babel-loader": "^9.1.3",
    "copy-webpack-plugin": "^12.0.2",
    "eslint-plugin-office-addins": "^3.0.2",
    "file-loader": "^6.2.0",
    "html-loader": "^5.0.0",
    "html-webpack-plugin": "^5.6.0",
    "office-addin-cli": "^1.6.3",
    "office-addin-debugging": "^5.1.4",
    "office-addin-dev-certs": "^1.13.3",
    "office-addin-lint": "^2.3.3",
    "office-addin-manifest": "^1.13.4",
    "office-addin-prettier-config": "^1.2.1",
    "os-browserify": "^0.3.0",
    "process": "^0.11.10",
    "source-map-loader": "^5.0.0",
    "ts-loader": "^9.5.1",
    "typescript": "^5.4.2",
    "webpack": "^5.90.3",
    "webpack-cli": "^5.1.4",
    "webpack-dev-server": "5.0.3"
   },

In the "scripts" section, go to the "start" script and change the extension of the manifest file to "json". It should say "start": "office-addin-debugging start manifest.json",.
Save the file and then in the root of the project, run npm install.
Now try to sideload with npm run start.

Mikael Nilsson 0

No, sorry. I copied the start script from wrong addin.

This is what is used:

"start": "office-addin-debugging start manifest.json"

  "devDependencies": {
    "@babel/core": "^7.24.0",
    "@babel/preset-env": "^7.25.4",
    "@types/office-js": "^1.0.377",
    "@types/office-runtime": "^1.0.35",
    "acorn": "^8.11.3",
    "babel-loader": "^9.1.3",
    "copy-webpack-plugin": "^12.0.2",
    "eslint-plugin-office-addins": "^4.0.3",
    "file-loader": "^6.2.0",
    "html-loader": "^5.0.0",
    "html-webpack-plugin": "^5.6.0",
    "office-addin-cli": "^2.0.3",
    "office-addin-debugging": "^6.0.3",
    "office-addin-dev-certs": "^2.0.3",
    "office-addin-lint": "^3.0.3",
    "office-addin-manifest": "^2.0.3",
    "office-addin-prettier-config": "^2.0.1",
    "os-browserify": "^0.3.0",
    "process": "^0.11.10",
    "source-map-loader": "^5.0.0",
    "webpack": "^5.95.0",
    "webpack-cli": "^5.1.4",
    "webpack-dev-server": "5.1.0"
  },

Rick Kirkham 281 Reputation points Microsoft Employee

2025-03-26T22:23:01.6966667+00:00

So, did you create a new project with the unified manifest or did you convert a project that used the old XML manifest?

1 answer

Your answer

Rick Kirkham 281 Reputation points Microsoft Employee

2025-03-26T21:12:26.36+00:00

Please provide some clarification:

Are you following the instructions at [Sideload with a system prompt, bash shell, or terminal]?

What exactly goes wrong when you sideload a non-Outlook add-in? For example, is there an error message? What do you expect to see and what do you actually see?

Also, see if upgrading to Version 2504 xxxxx.xxxxx has any effect.
Mikael Nilsson 0 Reputation points

2025-03-26T21:20:22.4666667+00:00

Effectively yes. Running the add-in from VS code > npm
"start": "office-addin-debugging start manifest.xml

I don't know. There is no error message, or any form of feedback. It just does nothing.
I Expect to see a ribbon button and a taskpane add-in.

Office version is centrally contolled by organization so i can't install other versions at the moment.
Rick Kirkham 281 Reputation points Microsoft Employee

2025-03-26T21:59:00.0566667+00:00

I think I see the problem. You converted a project that used the XML manifest to the unified manifest, but the scripts in the package.json are still the scripts for the XML manifest. Take these steps and if it works, I'll update the documentation.

Open the package.json file in the root of the project.

Replace the "devDependencies" section with the following:
"devDependencies": { "@babel/core": "^7.24.0", "@babel/preset-typescript": "^7.23.3", "@types/office-js": "^1.0.377", "@types/office-runtime": "^1.0.35", "babel-loader": "^9.1.3", "copy-webpack-plugin": "^12.0.2", "eslint-plugin-office-addins": "^3.0.2", "file-loader": "^6.2.0", "html-loader": "^5.0.0", "html-webpack-plugin": "^5.6.0", "office-addin-cli": "^1.6.3", "office-addin-debugging": "^5.1.4", "office-addin-dev-certs": "^1.13.3", "office-addin-lint": "^2.3.3", "office-addin-manifest": "^1.13.4", "office-addin-prettier-config": "^1.2.1", "os-browserify": "^0.3.0", "process": "^0.11.10", "source-map-loader": "^5.0.0", "ts-loader": "^9.5.1", "typescript": "^5.4.2", "webpack": "^5.90.3", "webpack-cli": "^5.1.4", "webpack-dev-server": "5.0.3" },

In the "scripts" section, go to the "start" script and change the extension of the manifest file to "json". It should say "start": "office-addin-debugging start manifest.json",.

Save the file and then in the root of the project, run npm install.

Now try to sideload with npm run start.
Mikael Nilsson 0 Reputation points

2025-03-26T22:03:48.5766667+00:00

No, sorry. I copied the start script from wrong addin.

This is what is used:

"start": "office-addin-debugging start manifest.json"

"devDependencies": { "@babel/core": "^7.24.0", "@babel/preset-env": "^7.25.4", "@types/office-js": "^1.0.377", "@types/office-runtime": "^1.0.35", "acorn": "^8.11.3", "babel-loader": "^9.1.3", "copy-webpack-plugin": "^12.0.2", "eslint-plugin-office-addins": "^4.0.3", "file-loader": "^6.2.0", "html-loader": "^5.0.0", "html-webpack-plugin": "^5.6.0", "office-addin-cli": "^2.0.3", "office-addin-debugging": "^6.0.3", "office-addin-dev-certs": "^2.0.3", "office-addin-lint": "^3.0.3", "office-addin-manifest": "^2.0.3", "office-addin-prettier-config": "^2.0.1", "os-browserify": "^0.3.0", "process": "^0.11.10", "source-map-loader": "^5.0.0", "webpack": "^5.95.0", "webpack-cli": "^5.1.4", "webpack-dev-server": "5.1.0" },
Rick Kirkham 281 Reputation points Microsoft Employee

2025-03-26T22:23:01.6966667+00:00

So, did you create a new project with the unified manifest or did you convert a project that used the old XML manifest?

Answer 1

Rick Kirkham 281 Microsoft Employee

There is an extra step to sideloading a Word add-in that uses the unified manifest. On the Home ribbon, select Add-ins, and then select the add-in that you are sideloading. I will update the documentation to add this.

User's image

Mikael Nilsson 0 Reputation points

2025-03-27T07:54:53.42+00:00
The addin was created with "yo office", selecting the unified manifest option.

When i run

"start:desktop:word": "office-addin-debugging start manifest.json desktop --app word"

This is what i get in Word:
Rick Kirkham 281 Reputation points Microsoft Employee

2025-03-27T18:07:58.58+00:00

Try running npm run start.
Mikael Nilsson 0 Reputation points

2025-03-28T06:54:34.55+00:00
I've tried that. Opens Excel, still no add-in or error messages.

"start": "office-addin-debugging start manifest.json",
Rick Kirkham 281 Reputation points Microsoft Employee

2025-03-28T17:05:26.6266667+00:00

I cannot reproduce your issue. I will inquire internally whether you need a more recent version of Office.
Rick Kirkham 281 Reputation points Microsoft Employee

2025-03-28T18:58:22.9+00:00

I've got confirmation that the information in the article that you linked to is correct: "Office Version 2304 (Build 16320.20000) or later." should support sideloading Word, Excel, and PowerPoint add-ins that use the unified manifest.

I'm hoping to get some suggestions about how you can troubleshoot you problem, which as I mentioned, I cannot reproduce.
Bruno Carvalhal 0 Reputation points

2025-04-10T06:47:33.03+00:00

Hi, I experienced the same issue. For me it turned to be necessary to be on the Beta Channel of Office. Even though my version on Current Channel was high enough, it didn't work until I switched to the Beta Channel

Share via

Sideloading unified manifest Add-ins - Required office app versions?

1 answer

Your answer