Exact Synergy Enterprise

How-to: Installing Synergy Office Integration via MSI

Introduction

Note: The Federated Identity feature is only available for the controlled release participants.

Synergy Office Integration (SOI) allows for closer integration between Exact Synergy Enterprise and Microsoft Office. When you install SOI, you will be able to access Exact Synergy Enterprise using Microsoft Outlook. On top of that, you will be able to perform other functions such as saving and viewing documents, saving presentations, and spreadsheets directly and easily to Exact Synergy Enterprise.

There are two ways to install SOI on end-user machines, which are on a single machine or on multiple machines.

This document explains the prerequisites for running SOI and describes the installation steps for SOI on an end-user machine (on a single machine) via MSI.

SOI can also be installed simultaneously on several machines.

The installation of SOI can be done on a terminal server environment and is normally performed by a system administrator.

This document is divided into the following sections:

Requirements and prerequisites
How do I install Synergy Office Integration via MSI on a single machine?
How do I configure Synergy Office Integration?
How do I use Synergy Office Integration for the first time?
How do I update Synergy Office Integration?

Requirements and prerequisites

For a system administrator, there are certain preparations that need to be carried out before installing SOI. For this list of preparations, see Synergy Office Integration Pre-Installation Checklist for System Administrators.

For the end-user, the prerequisite for installing SOI is:

Microsoft Office 2016 onwards - SOI does not support the earlier versions.

Note: Users who are using Microsoft Office with Windows XP might encounter issues with the SOI menu. To solve this problem, install the Microsoft Office 2010: Primary Interop Assemblies Redistributable (for Microsoft Office 2010).

Some required softwares will need to be installed as well before installing the latest version of SOI. The required softwares are as follows:

Windows Installer 3.1 or above. Download
Microsoft .NET Framework 4.0. Download
Visual Studio 2010 Tools for Office Runtime. Download

For installation of SOI version 5.0357.0 and below, for product updates 248 and earlier. The required softwares are as follows:

Windows Installer 3.1 or above. Download
Microsoft .NET Framework 3.5 with Service Pack 1. Download
Microsoft Visual Studio Tools for the Microsoft Office system (Version 3.0 Runtime) (x86). Download

ExactWebGuest must be created in Exact Synergy Enterprise if Auth0 is used.

Top

How do I install Synergy Office Integration via MSI on a single machine?

Go to Modules > System > Setup > Settings – General > Preferences, click the General tab followed by Synergy Office Integration under the Office: Installations section. Alternatively, you can also go to Modules > System > Setup > Other > Installation: Synergy Office Integration.
Click Download. You will see the following message:

Click Run to begin the installation process immediately or Save to save the file to a specified location. If you clicked Save, locate the file that you have saved. Double click the file. You will see the following:

If the version of Microsoft Office that you have installed has yet to be officially supported by ESE, the following message will be displayed:

Click OK, and then click Next.
Then, select the check box to accept the license terms, and then click Next.
Click Install to begin the installation.
Finally, click Finish when the installation process is completed.

Keep in mind: After the SOI installation, you need to complete the configuration before you can use the SOI features. See How do I configure Synergy Office Integration?.

Top

How do I configure Synergy Office Integration?

Before you use SOI for the first time, it has to be configured correctly. This is to ensure that no problems are encountered when you save documents or e-mails to ESE.

a) Default document type

The default document types need to be determined for the different usage within the different applications. To do this, go to Modules > System > Setup > Settings – General > Preferences, click the Office Integration tab, and then define the fields under the Default document type MS Office section. For more information, see Customising Exact Synergy Enterprise.

b) SOI Configuration Wizard

The first time when you open a Microsoft Office application after the SOI installation, a welcome screen will be displayed, followed by the configuration wizard. You can opt to skip the configuration at that moment, but you will have to complete it before you can use the SOI features. The configuration wizard will be displayed again if you have clicked on any SOI feature.

Open Microsoft Word, Microsoft Excel, Microsoft Outlook, or Microsoft PowerPoint. You will see the following screen:

Click Next. The following screen is displayed:

At Web address, fill in the website URL of the ESE software that you want to connect to.
At Authentication Mode, select one of the following token-based authentication models for the connection to ESE: Windows Authentication, Basic Authentication, WAAD Authentication, or Auth0 Authentication.
Then, fill in your ESE user name (for example: "domain\username") and login password, and click Next.
A check is done to see if your system fulfils all prerequisites needed for the configuration. If the system fulfils all prerequisites, the configuration process will proceed. Once it is completed, click Finish to exit the configuration wizard.

As of product update 261, the WAAD authentication and Auth0 authentication no longer requires for the user name and password to be defined in the SOI configuration wizard screen. See the following configuration steps for the WAAD authentication and Auth0 authentication:

WAAD authentication

In the following screen, select WAAD Authentication at the Authentication Mode field.
Define the Authority, ClientID, and APP ID URI fields.
Click Next.
The following multi-factor authentication login screen will be displayed:
Type the authentication code.
Click Verify.
The standard screens will be displayed and you can proceed with the configuration accordingly.

Auth0 authentication

In the following screen, select Auth0 Authentication at the Authentication Mode field.
Define the Authority and ClientID fields.
Click Next.
The following multi-factor authentication login screen will be displayed:
Type the authentication code.
Click . The standard screens will be displayed and you can proceed with the configuration accordingly.

Keep in mind: If your system does not meet any of the prerequisites, you will need to modify some settings or contact your system administrator to do so. For more information on the prerequisites, click the More information hyperlink.

Top

How do I use Synergy Office Integration for the first time?

Once the configuration wizard is completed successfully, you will need to restart the Microsoft Office application before you can use the SOI features. When you access any features under the Synergy ribbon or toolbar for the first time, a login screen will be displayed for you to type your username and password, as displayed below:

If you have selected the Remember me check box, you do not need to login again the next time you use SOI until the password expires.

Note: Should the corporate default web site be changed while a user is logged in to SOI, the user will be prompted again to re-login to the new web site. For more information, see Customizing Exact Synergy Enterprise.

Top

How do I update Synergy Office Integration?

Click to show/hide.

Top