Skip to main content

Side-load (deprecated)

Overview​

The side-load method allows you to bypass the Microsoft Store and still use web add-ins.

Note: Side-load setups only work on Windows clients.

How does the Add-in Store work​

To install a web add-in from the store, Microsoft Word downloads its manifest.xml, a file containing the end-points of the web application and UI enhancements to Word.

When the end-user interacts with the UI enhancements, Microsoft Word will load the web application in a sandboxed web view that will access the JS API.

Using the add-in store to load manifest.xml can be an issue if we want to prevent end-users from installing any web add-ins that are publicly listed.

How does side-loading work​

Side-loading also uses a manifest.xml.

Microsoft will allow the end-user to download any manifest.xml from a trusted catalog.

In this setup, the trusted catalog will be a network location. The trusted catalog cannot be a local folder; it has to be a network location.

A Side-load setup is the only way to load a manifest.xml without publishing it to the store or using it.

Steps to follow​

To side-load a web addin in Microsoft Word, you will need to:

  1. Download the manifest.xml from TermLynx and put it on a file share
  2. Add the network location of the file share as a trusted catalog within Microsoft Word on the end-user computer
  3. Add the web add-in to the end-users Microsoft Word

Microsoft Documentation​

If you would like additional information regarding side-loading, you can find some from Microsoft on this link:

https://docs.microsoft.com/en-us/office/dev/add-ins/testing/create-a-network-shared-folder-catalog-for-task-pane-and-content-add-ins

Side-load Overview​

graph TD W[Microsoft Word] --Registry Configurations--> TM M[manifest.xml] --End points configurations--> TL[TermLynx WebApp] TM[Trusted Catalog] --Network share--> M

1. Catalog configuration​

  1. Download the TermLynx manifest.xml
  2. Move the manifest.xml on a file share
  3. Make sure that the end-user will have the authorization to read the file share

2. Adding a trusted Catalog​

The next step is to add the network path of the file share as a trusted add-in catalog on the end-user computer.

Step by Step (using the UI)​

  1. Open Microsoft Word from the end-user computer
  2. Click on File
  3. Click on Options
  4. Click on Trust Center
  5. Click on Trust Center Settings
  6. Click on Trusted Add-in Catalogs
  7. Add the network location of the directory containing your manifest.xml
  8. Click OK
  9. Open a new document
  10. Click Insert on the ribbon
  11. Click Get Add-ins
  12. Click Shared Folder
  13. Click on TermLynx
  14. Click Add at the lower right corner of the dialog

Using scripts​

To add the catalogue, you will add entries to the registry. You can do it with a PowerShell script or execute a REG file.

Powershell​
# Path to the network folder holding the manifest.xml
$networkPath = "\\some-server\some-network-path"

# Can be any GUID
$guid = New-Guid

# Path for trusted catalogues
$entryPath = HKCU:\\Software\Microsoft\Office\16.0\WEF\TrustedCatalogs 

# Creating the registry item and setting values
$entry = New-Item -Path $entryPath -Name $guid  -Force
$entry.SetValue("Id", $guid)
$entry.SetValue("Url", $networkPath)
$entry.SetValue("Flags", 1)
REG file​
Windows Registry Editor Version 5.00

[HKEY_CURRENT_USER\Software\Microsoft\Office\16.0\WEF\TrustedCatalogs\{GUID}]
"Id"="{GUID}"
"Url"="{NETWORK_PATH}"
"Flags"=dword:00000001

3. Install the web add-in​

Finally, once you have added the trusted catalog to Microsoft Word, you will need to load the TermLynx web add-in.

Step by Step​
  1. Open Microsoft Word
  2. Open an empty document
  3. Open the Insert ribbon
  4. Click on My Add-ins
  5. Click on FILE SHARE
  6. Click Refresh in the upper right corner
  7. Click on TermLynx and then click on Add

If the "insert" button is disabled in your Microsoft Word, please make sure to enable Web Add-ins.