...
| Table of Contents |
|---|
...
Website installation
To install the Office Connector (henceforth referred to as "OC"), install an OC the exact same way you would install a Media Manager 5 site (MM).
- Create a new website folder and copy the content from SWInstall into the created website folder.
Website configuration
The OC has it own appsettings.json file, identical to the appsettings.json file for MM. Some parameters are of particular interest in the OC.
VersionId
Note that the OC does not have a separate entry in the ConfigManager in the DC. If an OC entry exists, it belongs to the old OC and it will not affect the new one.
Instead, the OC uses an MM configuration, which can be found as a child of the Media Manager 5 node in the ConfigManager. The following options are available:
- Use an existing MM configuration. If you choose this option, be aware that changing e.g. searches and configuration parameters in the chosen MM configuration will affect the OC.
- Use this option for new installations
- (Recommended by RND) Create a new child configuration for the OC based on the MM configuration. This makes it possible to change e.g. searches and configuration parameters independently of MM.
Create or choose a configuration to use, and then change the "VersionId" parameter in the appsettings.json for the OC appropriately.
SSO
If you want to enable SSO, change "UseFederatedAuthentication" to "true" in the appsettings.json file.
If you also want to enable normal login, change "EnableNormalLogin" to "true" in the appsettings.json file.
PortalName
Ensure that PortalName is set to be the MM5 site's URL
Define PortalName which could be found withing appsettings.json "ProductConfiguration" section to be either:
- The MM’s URL if the MM does not have this defined
The same as the MM’s if the MM has it defined
The required value for Portalname could be found within table:
...
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 separate manifest file must be configured for each of following the sets of applications:
Word, PowerPoint and Excel: "manifest.xml".
Outlook: "manifest-outlook.xml".
Note that it is not required to configure both manifest files.
The two files are both located in the "wwwroot"-folder of the installed OC. Alternatively, the files are similar to the followingmanifest files must follow the format as follows:
| View file | ||||
|---|---|---|---|---|
|
| View file | ||||
|---|---|---|---|---|
|
For each manifest file do the following:
Replace all references to
localhost[MM_URL] with the MM site reference. E.g. if MM is installed at mm.digizuite.com, then replace
localhost with[MM_URL] with mm.digizuite.com
/oc. (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
...
Thus, the OC should automatically appear in on the "Insert" ribbon page:
...
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
...
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
...