Office Plugin Installation Manual for Microsoft Intune

Introduction

This manual describes how to install the Office plugin, and how to deploy it to users with Microsoft Intune. The manual also describes the process to configure and deploy optional, but recommended, settings related to the plugin in the registry using Intune.


Technical requirements

To install the Office plugin via Intune, you will need the following:

  • Administrator access to Microsoft Intune.
  • ZIVVER Office plugin installation file. The latest version is available for download via this link.
  • The users’ computers must meet the following requirements:
    • Outlook 2010 or higher
    • Windows 7 or higher
    • .NET Framework 4.5 or higher
    • Must be able to connect to https://*.zivver.com over TLS v1.2 via port 443

To configure the optional settings in the registry, you will need the following:

  • Administrator access to Microsoft Intune.
  • IExpress Wizard, a default component of Windows (2000 and higher).
  • Microsoft Win32 Content Prep Tool, available for download via this link.

Installation

Follow the steps below to configure the Office plugin within Intune:

  1. Log in to the Azure admin center.
  2. Go to Intune by searching Intune in the field at the top, or directly by following this link.
  3. Click Client apps.
  4. Click Apps.
  5. Click addAdd to add a new add-in.
  6. Select Line-of-business app as the App type.
  7. Click App package file - Select file.
  8. Select the Office plugin installation file. The latest version is available for download via this link.
  9. Select OK to confirm and close the App package file pane.
  10. Click App information - Configure.
  11. Enter the following information in the App information pane:
    • Name: ZIVVER Office Plugin (should be filled automatically)
    • Description: ZIVVER Office plugin for Outlook (example)
    • Publisher: ZIVVER B.V.
    • App install context: Select either User context (Just for me installation) or Device context (For all users installation).
    • Additional optional information can be configured, but this is not required.
  12. Click OK to close the App information pane.
  13. Click Add to finish the configuration and add the plugin to Intune.
  14. Wait a moment until the plugin has finished uploading, as indicated by the notification at the top in Intune.
  15. Click Assignments.
  16. Click Add group.
  17. Select the preferred Assignment type:
    • Available for enrolled devices: Assign the app to groups of users who can install the app from the Company Portal app or website.
    • Required: The app is installed on devices in the selected groups.
  18. Click Included groups.
  19. Click Select groups to include and choose the Azure AD group(s) to assign the app to, or select Yes next to Make this app available to all users with enrolled devices te deploy the app to all users.
  20. Click OK to confirm the selection and close the Assign pane.
  21. Click OK to close the Add group pane.
  22. Click Save.

The configuration is now complete. Users will be able to install the Office plugin from the Company Portal app or website, or it will be installed automatically for them, depending on the Assignment type selected during step 17.

Updating the plugin

When a new version of the Office plugin is released, it must be updated through Intune. Follow the steps below to update the plugin:

  1. Log in to the Azure admin center.
  2. Go to Intune by searching Intune in the field at the top, or directly by following this link.
  3. Click Client apps.
  4. Click Apps.
  5. Select the ZIVVER Office Plugin app.
  6. Click Properties.
  7. Click App package file - Zivver.OfficePlugin.Installer.msi.
  8. Click Select a file.
  9. Select the new version of the Office plugin installation file. The latest version is always available for download via this link.
  10. Click OK to confirm the new installer file.
  11. Click Save.

The version of the plugin is now updated in Intune. Users will be able to install the new version of the Office plugin from the Company Portal app or website, or it will be installed automatically for them, depending on the Assignment type selected during step 17 of the installation.


Several additional settings for the ZIVVER Office Plugin are configured in the registry. It is strongly recommended that these settings are applied (more on this in the setting descriptions below). This section of the manual describes how to deploy these settings to users, using Intune.

The following additional settings are available:

  • LoadBehavior - This setting determines whether the plugin is loaded or not when Outlook starts, and is required to properly implement the plugin. For example, use this setting to activate the plugin for ZIVVER users, while keeping it disabled for others.
  • AddinList - This setting prevents users from disabling the plugin in Outlook 2013 and higher. This setting does not work with Outlook 2010. This setting is highly recommended, because it ensures that the plugin remains active in Outlook.
  • DoNotDisableAddinList - This setting prevents Outlook (2013 and higher) from automatically disabling the plugin in case of a delay. This setting does not work with Outlook 2010. This setting is highly recommended, because it ensures that the plugin remains active in Outlook.
  • AutoEnableSsoAccounts - This setting automatically activates accounts via Single Sign-On (SSO) in the plugin. This setting is strongly recommended, because users will have to activate their accounts manually otherwise. This setting only works if SSO is configured and enabled for ZIVVER.
  • TryAutoReloginSso - This setting will automatically keep users logged in via SSO in the plugin. This setting is strongly recommended, because users will have to log in manually otherwise (at least once every 30 days). This setting only works if SSO is configured and enabled for ZIVVER.

The process to deploy these settings consists of the following steps:

  1. Creating a batch script to add the registry keys and values.
  2. Packaging the script for deployment.
  3. Converting the format of the package, so that it can be deployed using Intune.
  4. Deploying the package through Intune.

Batch script

The first step is to create a batch script. This script creates the registry values in the corresponding keys, so that the settings are applied for users.

Below is an example of the batch script for Outlook 2016/2019/O365 with all of the settings described above:

@Echo off
reg add HKCU\Software\Zivver\OfficePlugin\Settings /f
reg add HKCU\Software\Zivver\OfficePlugin\Settings\ /v AutoEnableSsoAccounts /t REG_DWORD /d 1 /f
reg add HKCU\Software\Zivver\OfficePlugin\Settings\ /v TryAutoReloginSso /t REG_DWORD /d 1 /f
reg add HKCU\Software\Policies\Microsoft\office\16.0\outlook\resiliency\AddinList /f
reg add HKCU\Software\Policies\Microsoft\office\16.0\outlook\resiliency\AddinList\ /v ZivverOfficePlugin.AddinModule /t REG_SZ /d 1 /f
reg add HKCU\Software\Policies\Microsoft\office\16.0\outlook\resiliency\DoNotDisableAddinList /f
reg add HKCU\Software\Policies\Microsoft\office\16.0\outlook\resiliency\DoNotDisableAddinList\ /v ZivverOfficePlugin.AddinModule /t REG_DWORD /d 1 /f
reg add HKCU\Software\Microsoft\Office\Outlook\Addins\ZivverOfficePlugin.AddinModule /f
reg add HKCU\Software\Microsoft\Office\Outlook\Addins\ZivverOfficePlugin.AddinModule\ /v LoadBehavior /t REG_DWORD /d 3 /f

The values of several variables in this script can be changed, depending on preferences or environment. These are as follows:

  • HKCU may be changed to HKLM, to set the registry values on a system level, instead of on a user level. Note: If LoadBehavior is set on a system level, it supersedes any value set for LoadBehavior on a user level.
  • 16.0 relates to Office 2016, 2019, and the Office365 version. If you use Outlook 2013, change 16.0 to 15.0.
  • The LoadBehavior value is set to 3 in this example, as indicated by /d 3. The LoadBehavior setting can have the following values:
    • LoadBehavior = 0 - The plugin is not loaded automatically when Outlook starts. If the user starts the plugin manually, the value will remain 0. Therefore, the plugin needs to be activated manually after each startup. Change /d 3 to /d 0 if you choose this option.
    • LoadBehavior = 2 - The plugin is not loaded automatically when Outlook starts. If the user starts the plugin manually and there are no problems with starting, the value is changed to 3 (see below). Therefore, after one successful startup, the plugin will be activated by default. Change /d 3 to /d 2 for this option.
    • LoadBehavior = 3 - The plugin is loaded automatically when Outlook starts. If a problem with the plugin is detected, the value will be automatically changed to 2 (see above). This option is used in the example, and must be used for users that will work with the plugin.
  • If a 32-bit version of Outlook is used on a 64-bit system, then the LoadBehavior value must be set in the Wow6432Node key. In this case, change Software\Microsoft\Office\Outlook\Addins\ZivverOfficePlugin.AddinModule to Software\Wow6432Node\Microsoft\Office\Outlook\Addins\ZivverOfficePlugin.AddinModule.

Prepare the script

Follow these steps to prepare the script for deployment via Intune:

  1. Copy the example script above into any text editor, such as Notepad.
  2. Change any of the variables, depending on your preferences and environment.
  3. Save the script in the .cmd format. For example, zivver_settings.cmd.

The script is now ready to be packaged.

Packaging the script

This section describes the process to package the batch script that was created in section 4.1 of this manual. Follow the steps below to package the script into an executable:

  1. Go to C:\Windows\System32 in File Explorer, or run %windir%.
  2. Run IExpress.exe to start the IExpress Wizard.
  3. Select Create new Self Extraction Directive file.
  4. Click Next.
  5. Select Extract files and run an installation command.
  6. Click Next.
  7. Enter a title for the package. For example, ZIVVER Office Plugin Settings.
  8. Click Next.
  9. Select No prompt.
  10. Click Next.
  11. Select Do not display a license.
  12. Click Next.
  13. Click Add to add a file to the package.
  14. Select the script that you saved as a .cmd file in section 4.1.
  15. Click Next.
  16. Next to Install Program, enter the name and file format of the batch script. _For example, zivver_settings.cmd._
  17. Leave Post Install Command set to .
  18. Click Next.
  19. Select Hidden in the Show window pane.
  20. Click Next.
  21. Select No message.
  22. Click Next.
  23. Click Browse and enter a target path and filename for the package.
  24. Select the option Hide File Extracting Progress Animation from User.
  25. Select the option Store files using Long File Name inside Package.
  26. Click Yes in the dialog window to confirm.
  27. Click Next.
  28. Select No restart.
  29. Click Next.
  30. (Optional) Choose a location to save the Self Extraction Directive (SED) file. This file can be used to easily modify this package later, so that you don’t have to go through all the options again. Select Don’t save if you don’t want to save the SED file.
  31. Click Next.
  32. Click Next to create the package. This may take several minutes to finish.
  33. Click Finish to close the IExpress Wizard.

The package is now created, and is stored as a .EXE file in the path that was specified in step 23. This executable will be used in the next section of the guide.

Converting the package

This section of the manual describes the process to convert the package that was created in Packaging the script. It is not possible to deploy packages in the .EXE format via Intune, so the package must be converted to a different format. In this case, the package will be converted to a .intunewin format, so that it can be deployed through Intune. The package is converted using the Microsoft Win32 Content Prep Tool. See this Microsoft article for more information regarding this tool.

Follow these steps to convert the package:

  1. Visit the Microsoft Win32 Content Prep Tool download page via this link.
  2. Click Clone or download.
  3. Click Download ZIP.
  4. Extract the contents of the ZIP file.
  5. Run IntuneWinAppUtil.exe.
  6. Next to Please specify the source folder, enter the file path to the package (.EXE) that was created in section 4.2. _For example, C:\Users\Zivver_User\Documents._
  7. Next to Please specify the setup file, enter the filename (including format) of the package. _For example, ‘zivversettings.exe’.
  8. Next to Please specify the output folder, enter the file path where the converted package will be stored. _For example, ‘C:\Users\Zivver_User\Documents\IntunePackage’ could be used.
  9. Hit the Enter key to confirm and convert the package.

The package is converted to the intunewin format, and is stored in the output folder, as specified in step 8. The package should have the same name as the setup file, in this example: zivver_settings.intunewin

Troubleshooting

If the converted package is not available in the output folder, make sure that the tool has access to the source folder, the setup file, and the output folder. If the tool does not have access to any of these, the process can not be completed. By using the User folders, as was done in the examples, it is ensured that the tool has proper access.

If you are experiencing other problems, then run the tool within PowerShell. PowerShell displays more detailed error information, which the tool itself does not. This information should contain a clear indication regarding the cause of the problem.

Follow these steps to run the tool in PowerShell:

  1. Start PowerShell.
  2. Change directory to the file path of the Win32 Content Prep Tool. For example, cd C:\Users\Zivver_User\Downloads\Microsoft-Win32-Content-Prep-Tool-master
  3. Run the tool from this location: .\IntuneWinAppUtil.exe (command may vary if the name of the executable was changed).
  4. Use the tool by following the process from step 6 in section 4.3.

If an error appears during these steps, it should contain a reason for what went wrong exactly. Use this information to address the problem, and then run the tool again.

Deploying the package

This section of the manual describes the process to deploy the converted package within Intune, so that the settings are applied to the user groups of your choice.

Follow these steps to configure and deploy the package in Intune:

  1. Log in to the Azure admin center.
  2. Go to Intune by searching Intune in the field at the top, or directly by following this link.
  3. Click Client apps.
  4. Click Apps.
  5. Click addAdd to add a new add-in.
  6. Select Windows app (Win32) as the App type.
  7. Click App package file - Select file.
  8. In the App package file pane, select the converted package from section 4.3. _For example, C:\Users\Zivver_User\Documents\Intune_Package\zivver_settings.intunewin_.
  9. Select OK to confirm and close the App package file pane.
  10. Click App information - Configure.
  11. Enter the following information in the App information pane:
    • Name: ZIVVER Registry Settings (For example)
    • Description: Additional settings relating to the ZIVVER Office Plugin (For example)
    • Publisher: ZIVVER B.V.
    • Additional optional information can be configured, but this is not required.
  12. Click OK to close the App information pane.
  13. Click Program - Configure.
  14. The Install command is the filename of the original .exe, before it was converted to .intunewin. For example, zivver_settings.exe.
  15. The Uninstall command can not be empty, so enter a placeholder. For example, zivver_uninstall_command. Note: Since this is a custom package with no actual installation, there is no registry entry in SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall, and therefore no (GUID for the) uninstall command. See this section of the manual for a solution to remove the deployed registry values.
  16. Set the Install behavior to either System or User, to deploy the settings on a system or user level.
  17. Click OK to confirm and close the Program pane.
  18. Click Requirements - Configure.
  19. Next to Operating System Architecture, select both 32-bit and 64-bit.
  20. Next to Minimum operating system, select the build of Windows that is used in your environment. For example, Windows 10 1903 or Windows 10 1809.
  21. Click OK to confirm and close the Requirements pane.
  22. Click Detection rules - Configure.
  23. For Rules format, select Manually configure detection rules.
  24. Click Add.
  25. Enter the following information for the Detection rule:
    • Rule type: Registry
    • Key path: Enter a path that was used in your script. For example, HKCU\Software\Zivver\OfficePlugin\Settings
    • Value name: Enter the name of a value that was used in your script. For example, AutoEnableSsoAccounts
    • Detection method: Key exists
    • Associated with 32-bit app on 64-bit clients: No
  26. Click OK to close the Detection rule pane.
  27. Click OK to close the Detection rules pane.
  28. Click Add to finish configuring the app.
  29. Wait a moment until the plugin has finished uploading, as indicated by the notification at the top in Intune.
  30. Click Assignments.
  31. Click Add group.
  32. Select the preferred Assignment type:
    • Available for enrolled devices: Assign the app to groups of users who can install the app from the Company Portal app or website.
    • Required: The app is installed on devices in the selected groups.
  33. Click Included groups.
  34. Click Select groups to include and choose the Azure AD group(s) to assign the app to, or select Yes next to Make this app available to all users with enrolled devices.
  35. Click OK to confirm the selection and close the Assign pane.
  36. Click OK to close the Add group pane.
  37. Click Save.

The configuration is now complete. Users will be able to install the additional settings from the Company Portal app or website, or it will be installed automatically for them, depending on the Assignment type selected in step 31.

Uninstallation

Uninstall the Office plugin

Follow the steps below to uninstall the Office plugin using Intune.

  1. Log in to the Azure admin center.
  2. Go to Intune by searching Intune in the field at the top, or directly by following this link.
  3. Click Client apps.
  4. Click Apps.
  5. Select the ZIVVER Office plugin.
  6. Click Assignments.
  7. Select the group the app is currently assigned to.
  8. Click Remove and then Yes to confirm.
  9. Click Add group.
  10. Select Uninstall as the Assignment type.
  11. Click Included groups.
  12. Click Select groups to include and choose the groups for whom the plugin should be uninstalled, or select Yes next to Uninstall this app for all users or Uninstall this app for all devices, depending on your preference.
  13. Click OK to confirm the selection and close the Assign pane.
  14. Click OK to close the Add group pane.
  15. Click Save.

The Office plugin will now be uninstalled automatically for the selected user groups.

Uninstall the additional settings

This final section of the manual describes how to uninstall the addition settings that were deployed. Since there is no proper uninstall method, repeat the process in Additional recommended settings, but instead use the script below. This script removes all of the registry values that were previously deployed via Intune.

The example batch script below contains all of the possible registry values that may have been deployed while using this guide. You can use this script as is, or change it in accordance with the specific registry keys and values that you deployed in Additional recommended settings.

@echo off
reg delete HKCU\Software\Zivver\OfficePlugin\Settings\ /v AutoEnableSsoAccounts /f
reg delete HKCU\Software\Zivver\OfficePlugin\Settings\ /v TryAutoReloginSso /f
reg delete HKCU\Software\Policies\Microsoft\office\16.0\outlook\resiliency\AddinList\ /v ZivverOfficePlugin.AddinModule /f
reg delete HKCU\Software\Policies\Microsoft\office\16.0\outlook\resiliency\DoNotDisableAddinList\ /v ZivverOfficePlugin.AddinModule /f
reg delete HKCU\Software\Policies\Microsoft\office\15.0\outlook\resiliency\AddinList\ /v ZivverOfficePlugin.AddinModule /f
reg delete HKCU\Software\Policies\Microsoft\office\15.0\outlook\resiliency\DoNotDisableAddinList\ /v ZivverOfficePlugin.AddinModule /f
reg delete HKCU\Software\Microsoft\Office\Outlook\Addins\ZivverOfficePlugin.AddinModule\ /v LoadBehavior /f
reg delete HKCU\Software\Wow6432Node\Microsoft\Office\Outlook\Addins\ZivverOfficePlugin.AddinModule\ /v LoadBehavior /f
reg delete HKLM\Software\Zivver\OfficePlugin\Settings\ /v AutoEnableSsoAccounts /f
reg delete HKLM\Software\Zivver\OfficePlugin\Settings\ /v TryAutoReloginSso /f
reg delete HKLM\Software\Policies\Microsoft\office\16.0\outlook\resiliency\AddinList\ /v ZivverOfficePlugin.AddinModule /f
reg delete HKLM\Software\Policies\Microsoft\office\16.0\outlook\resiliency\DoNotDisableAddinList\ /v ZivverOfficePlugin.AddinModule /f
reg delete HKLM\Software\Policies\Microsoft\office\15.0\outlook\resiliency\AddinList\ /v ZivverOfficePlugin.AddinModule /f
reg delete HKLM\Software\Policies\Microsoft\office\15.0\outlook\resiliency\DoNotDisableAddinList\ /v ZivverOfficePlugin.AddinModule /f
reg delete HKLM\Software\Microsoft\Office\Outlook\Addins\ZivverOfficePlugin.AddinModule\ /v LoadBehavior /f
reg delete HKLM\Software\Wow6432Node\Microsoft\Office\Outlook\Addins\ZivverOfficePlugin.AddinModule\ /v LoadBehavior /f

Was this article helpful?

thumb_up thumb_down