OC 5.5.4 2.1 Installation and Configuration
Office installation
To install the Office go to https://www.office.com/ under your Digizuite creds and download local version of Office365 as shown on the picture below.
Configure Add Ins
Create folder c:\OC and share Network access to it. Simply add new Access rights as "Everyone" with Permission Level "Read/Write" on Network access tab.
Copy manifest.xml and manifest-outlook.xml provided below to newly created folder. You can create as many as needed configuration files each of them will correspond to specific configuration by renaming them
For example you might have these files:
c:\OC\manifest-dev.xml
c:\OC\manifest-local.xml
Inside each of the file 3 parameters need to be changed and need to be unique
- Id. Please search for <id> tag and change id such way that it will be unique
2. DisplayName and Description. These names will be displayed as add ins in office.
3. SourceLocation, resideWebSite and Digizuite.GS.LearnMoreUrl
Search for <SourceLocation> tag and copy DefaultValue, replace all occurrence of this value with your interested mm site.
At least 3 places need to be changed.
Adding Add Ins
Open office. Choose Insert option where you can find "My Add-ins"
Choose "See All..." and choose Manage Other Add Ins
Choose Trust Center, Trust Center Settings, Trusted Add-in Catalogs and add your created shared folder.
After you can restart Office
Go to Insert, My Add-ins, See All and new option "SHARED FOLDER" should be visible.
If you can not see it, it could also be that you should login with Admin rights.
Choose any of your configuration it should be visible now at right side of menu.
Enabling Dev Tools
Right click on the area of add ins and choose inspect. Then switch to console, debug or network tab.
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.
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: "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 following:
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" 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/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 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