Exact Synergy Enterprise

How-to: Installing Synergy Office Integration on terminal server environment

Introduction

Synergy Office Integration (SOI) allows for closer integration between Exact Synergy Enterprise and Microsoft Office.

This document describes the installation steps required for SOI to be successfully installed and operational in a terminal server environment. Once SOI is installed successfully, you will be able to perform actions such as saving and uploading documents from a terminal server. The SOI user settings can also be retrieved for subsequent logging in to the terminal server.

The setting up a terminal server is not in the scope of this document.

If you want to know the installation steps for SOI on an end-user machine, click on any of the relevant hyperlink to display a different document:

This document is divided into the following sections:

Network infrastructure
How do I install Synergy Office Integration via command line for "per machine" installation scope?
How do I install Synergy Office Integration via command line for "per machine" installation scope in multiple Exact Synergy Enterprise environments?
How do I configure the Roaming Profile and Folder Redirection?
How do I uninstall Synergy Office Integration via command line for "per machine" installation scope?
How do I uninstall Synergy Office Integration via command line for "per machine" installation scope in multiple Exact Synergy Enterprise environments?

Network infrastructure

The infrastructure that needs to be set up includes the following:

Domain controller
Terminal server
Client machines to remote into the terminal server

Top

How do I install Synergy Office Integration via command line for “per machine” installation scope?

It is mandatory for SOI to be installed as the “per-machine” installation scope. When SOI is installed as the “per-machine” installation scope, the SOI client runtime component will be deployed to the following locations:

1. C:\Program Files\Exact Synergy Enterprise\Client – runtime targets

2. C:\ProgramData – runtime configuration file

Keep in mind: The installation must be done on the terminal server machine and requires administrator privilege to be able to install files in the ProgramData folder.

The parameters and their values are as follows:

To install for this user or all users

ALLUSERS=1 (per machine installation, this is the default)
ALLUSERS=2 (per user installation)

Determine the installation directory

EXACTWIXAPPFOLDER="exactWixPerMachineFolder" (default value is "exactWixPerUserFolder" for per user installation. Leave out this parameter for PerUser installation)

Determine the Synergy URL

SYNERGYURL=http://www.synergy.com

Determine the Welcome screen and Configuration Wizard

FIRSTRUN = 1 (when set to 1, the Welcome screen will be shown for the first time use of Office after an installation of SOI. Set to 0 to suppress and bypass the Welcome screen)
SETPREREQS = 1 (when set to 1, it will bypass and suppress the Configuration Wizard. Set to 0 to display and follow the Configuration Wizard dialogs)

Determine the Silent Mode installation

SILENT = 1 (when set to 1, all pop-up messages will be suppressed. If set to other value or leave out this parameter, the error and/or warning messages, if any, will be prompted during installation)

If you are using product update 243, use the following command line to install the SOI installer for “per-machine” installation scope:

msiexec /i D:\SynergyOfficeIntegration.msi /qn ALLUSERS=1 FULLSYNERGYURL=https://<Exact Synergy Enterprise Server>

Keep in mind: Ensure that the MSI is placed in the directory defined in the command, for this example, in “D:\”.

If you are using product update 245, use the following command line to install the SOI installer for “per-machine” installation scope:

msiexec /i D:\SynergyOfficeIntegration.msi /qn EXACTWIXAPPFOLDER="exactWixPerMachineFolder" SYNERGYURL=http://<Exact Synergy Enterprise Server>/<Virtual Directory Name> FIRSTRUN=0 SETPREREQS=1 USEROAMINGFOLDER=1 ALLUSERS=1 SILENT=1 /l*v D:\MSI.log

Keep in mind: The "/l*v D:\MSI.log" parameters are used to generate an install log that would be stored in the MSI.log file in the specified path. Ensure that the MSI is placed in the directory defined in the command, for this example, in “D:\”.

Top

How do I install Synergy Office Integration via command line for "per machine" installation scope for multiple Exact Synergy Enterprise environments?

Users can install SOI on the terminal server for multiple Exact Synergy Enterprise environments; for example, a hosting company hosting multiple Exact Synergy Enterprise environments for different customers. Users only need to perform an initial installation on the terminal server for multiple Exact Synergy Enterprise environments.

The parameters and their values are as follows:

To install for this user or all users

ALLUSERS=1 (per machine installation, this is the default)
ALLUSERS=2 (per user installation)

Determine the installation directory

EXACTWIXAPPFOLDER="exactWixPerMachineFolder" (default value is "exactWixPerUserFolder" for per user installation. Leave out this parameter for PerUser installation)

Determine the Synergy URL

SYNERGYURL=""

Determine multiple Exact Synergy Enterprise environments

HOSTEDENVIRONMENT=1

Determine the Welcome screen and Configuration Wizard

FIRSTRUN = 1 (when set to 1, the Welcome screen will be shown for the first time use of Office after an installation of SOI. Set to 0 to suppress and bypass the Welcome screen)
SETPREREQS = 1 (when set to 1, it will bypass and suppress the Configuration Wizard. Set to 0 to display and follow the Configuration Wizard dialogs)

Determine the Silent Mode installation

SILENT = 1 (when set to 1, all pop-up messages will be suppressed. If set to other value or leave out this parameter, the error and/or warning messages, if any, will be prompted during installation)

For example: msiexec /i D:\SynergyOfficeIntegration.msi /qn EXACTWIXAPPFOLDER="exactWixPerMachineFolder" SYNERGYURL="" FIRSTRUN=0 SETPREREQS=1 USEROAMINGFOLDER=1 ALLUSERS=1 HOSTEDENVIRONMENT=1 SILENT=1 /l*v D:\MSI.log

Top

How do I configure the Roaming Profile and Folder Redirection?

In the Active Directory Domain Controller, the Roaming Profile and Folder Redirection need to be configured correctly.

Roaming Profile

Creating a Roaming Profile requires the following:

· Creating a shared folder on the server and a folder for the user within the share.

Note: The correct NTFS security permissions must be defined for the shared folders.

· Defining the user’s profile location via group policy.

Note: The network path for each user will have to be filled in the Profile and Terminal Services Profile tabs.

Folder Redirection

Folder Redirection allows you to save portions of the user’s profile in a different location on the network. We cannot redirect every folder in a user’s profile. The folders that can be redirected are Application Data, Desktop, My Documents, and Start Menu. SOI reads and copies the configuration files to the Application Data folder, so ensure this folder is configured for folder redirection.

Creating folder redirection requires the following:

· Creating a shared folder on the server and giving everyone full control at the share level.

· Redirecting the folders via the group policy.

Note: Folder redirection is not mandatory.

To redirect a folder via the group policy:

1. Open Group Policy Editor.

2. Go to User Settings, Windows Settings, and then Folder Redirection.

Note: The group policy requires redirecting each of the four folders separately, but the procedure for doing so is the same for each folder.

3. Set the folder’s Setting option to Basic – Redirect Everyone’s Folder To The Same Location.

4. Next, select Create A Folder For Each User Under The Root.

Accessing the Group Policy Management Console

Creating and linking a GPO to the domain

Navigating to the User configuration -> Windows Settings -> Folder Redirection

Providing the correct configuration setting for the “AppData” folder when redirecting it

Top

How do I uninstall Synergy Office Integration via command line for "per machine" installation scope?

If you are using product update 245, use the following command line to uninstall the SOI installer for “per-machine” installation scope:

msiexec /x D:\SynergyOfficeIntegration.msi /qn EXACTWIXAPPFOLDER="exactWixPerMachineFolder" SYNERGYURL=http://<Exact Synergy Enterprise Server>/<Virtual Directory Name> FIRSTRUN=0 SETPREREQS=1 ALLUSERS=1 /l*v D:\MSIUninstall.log

How do I uninstall Synergy Office Integration via command line for "per machine" installation scope in multiple Exact Synergy Enterprise environments?

Use the following command line to uninstall the SOI installer for “per-machine” installation scope in Exact Synergy Enterprise environments:

msiexec /x D:\SynergyOfficeIntegration.msi /qn EXACTWIXAPPFOLDER="exactWixPerMachineFolder" SYNERGYURL="" FIRSTRUN=0 SETPREREQS=1 USEROAMINGFOLDER=1 ALLUSERS=1 HOSTEDENVIRONMENT=1 /l*v D:\MSI.log