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.
The OC has its own appsettings.json file, identical to 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 based on the MM configuration. This makes it possible to change e.g. searches and configuration parameters independently of MM. If this is done, the "VersionId" should be changed 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
The single OC installation can be used for two different configurations:
- Word, PowerPoint and Excel: Configure and install the file "manifest.xml".
- Outlook: Configure and install the file "manifest-outlook.xml".
The two files are both located in the "wwwroot"-folder of the installed OC. Alternatively, the files are similar to the following:
The following steps must be done for each file separately.
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.
The "DisplayName" (title) and the "Description" should also be changed appropriately. If there are any labels that need to be changed in the ribbon, they are found in the bottom of the XML file, and can be replaced as one sees fit.
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: https://docs.microsoft.com/en-us/office/dev/add-ins/testing/create-a-network-shared-folder-catalog-for-task-pane-and-content-add-ins.
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:
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).
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:
- Create a new child configuration of MM5, specifically for the OC. This is described in more detailed at the top of this page. Failing to do this will result in MM5 being affected too.
- Find the search “DigiZuite_System_Framework_Search” in the newly created child configuration.
- Remove the "asset.prevref" field from the search input.
- Save the search.