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 its own 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 one for MM. To use the MM configuration, set the"VersionId" parameter to be the lowest level MM config version. It is possible to create a separate configuration for the OC by creating a new child configuration 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" should be changed 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.
Admin Configuration
...
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:
- Word, PowerPoint and Excel: Configure and install the file "manifest.xml".
- Outlook: Configure and install the file "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 following:
| View file | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| View file | ||||||||
|---|---|---|---|---|---|---|---|---|
|
The following steps must be done for each file separately.For each manifest file do the following:
- Replace all references to localhost with the OC site reference. E.g. if OC is installed at oc.digizuite.com, then replace localhost with oc.digizuite.com.
- Change the ID to a new, random GUID.
...
- Change the "DisplayName" (title) and the "Description"
...
The ID should be changed to a random GUID.
To check if your manifest file is valid, you can use the following tool: https://github.com/OfficeDev/office-addin-validator. If you get an error regarding "no platforms fulfilling the requirements specified in the manifest", you can disregard this.
If Centralized Deployment is possible (see Digizuite™ Office Connector 2.0 - 0. Requirements), follow the instructions for "Centralized Deployment" below.
Otherwise, the OC must be installed separately on all client computers. This can be done for one client computer at a time.
- For Windows users, follow the instructions at appropriately. The "DisplayName" is the title in the top of the add-in pane (red line below),
- 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/
...
...
...
If this approach is used, the "Centralized Deployment" section below can be skipped.
Please note that it might be possible to avoid having to install the OC separately on all client computers. However, this approach has not been tested. The approach can be tried by following the instructions at https://docs.microsoft.com/en-us/office/dev/add-ins/publish/publish-task-pane-and-content-add-ins-to-an-add-in-catalog. It involves publishing the OC to an app catalog with an on-premises SharePoint Server. Note that this approach will not make the OC available for Mac users.
Centralized deployment
With an Office 365 admin account, follow the installation steps at: https://docs.microsoft.com/en-us/office/dev/add-ins/publish/centralized-deployment.
To install the OC on client computers, do the following steps for each client.
Installing on client computers
First of all, make sure that you are logged in with your organizational ID in the Office applications.
There are two options for logging in - one is for the licensing of the Office product itself, whereas the other one is for your account.
Go to File → Account and login. The image below shows which is the correct option to login with:
| Note | ||
|---|---|---|
| ||
Logging it with the "wrong option" above, will not have any effect on the OC. Just be aware that, only the option to the left will grant you access to the OC. |
Click the Insert tab in the top of your Office program.
Now click My Add-ins (See image)
In the following dialog, go to ADMIN MANAGED. In here, the OC should now be an option
The Open button will then be available on the insert ribbon page.
You should now have a button called Digizuite to the far right. Press this button
Login using a user set up to use OC.
Now you should be able to use the OC as you'd like to see fit.
Once you have installed OC on a device for one Office product (e.g. Word), the OC will automatically be available for the two remaining Office products (e.g. Excel and PowerPoint). 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 in 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
Include crops in the asset list
It is possible to configure the OC to show asset crops in the asset list, alongside the original assets:
...
...