OC 5.9.0 Installation and Configuration

Owned by Kasper Svane
Last updated: Mar 06, 2024
2 min read

Manifest configuration

You should now have a working OC website. Please visit the URL of the installed site in a browser and check that the OC loads.

A central configuration artifact for the OC is the manifest file.

A separate manifest file must be configured for each of following the sets of applications:

  1. Word, PowerPoint and Excel: "manifest.xml".

  2. Outlook: "manifest-outlook.xml".

Note that it is not required to configure both manifest files.

The manifest files must follow the format as follows:

For each manifest file do the following:

  • Replace all references to [MM_URL] with the MM site reference. E.g. if MM is installed at mm.digizuite.com, then replace [MM_URL] with mm.digizuite.com. (Make sure to append /oc add the end of the mm site reference)

  • Change the ID to a new, random GUID.

  • Change the "DisplayName" (title) and the "Description" appropriately. The "DisplayName" is the title in the top of the add-in pane (red line below),

  • Change each “bt:Image" element if the user wants to use a different icon than the default provided (Make sure to append the image extension to the MM site reference e.g. https://mm.digizuite.com/icon.png)

  • Go through the labels in the manifest file and ensure that they have the desired values. In particular, the "residOpenButtenText" is the displayed title for the ribbon (blue line below).

Manifest deployment

To deploy the manifest and thus make the OC available for users, go through the following steps with an Office 365 admin account: https://docs.microsoft.com/en-us/microsoft-365/admin/manage/manage-deployment-of-add-ins?view=o365-worldwide

Note that the add-in should automatically be pushed to the user for Word, PowerPoint, and Excel. This is also possible for Outlook by choosing the "Fixed" deployment method.

Thus, the OC should automatically appear on the "Insert" ribbon page:

If the OC is not found for a user which has been granted access to the add-in, please ensure that the user is logged in with his/her organizational ID in the Office applications.

This can be checked by going to: File → Account and login.

Two logins are available. Ensure that the user is logged in with his/her organizational ID in the correct location:

If an issue is encountered while deploying, please validate your manifest file with the tool at: https://github.com/OfficeDev/Office-Addin-Scripts/tree/master/packages/office-addin-manifest

Updating the manifest file

After updating the manifest file (NOTE: not after updating the website itself), a user might not see the effects of the update immediately.

To fix this, try following the steps under "Remove an add-in from local cache" on the user's computer: https://docs.microsoft.com/en-us/office365/enterprise/use-the-centralized-deployment-powershell-cmdlets-to-manage-add-ins?redirectSourcePath=%252farticle%252f94f4e86d-b8e5-42dd-b558-e6092f830ec9#delete-an-add-in