Installing / Upgrading the Mimecast Synchronization Engine

Document created by user.oxriBaJeN4 Employee on Nov 23, 2015Last modified by user.oxriBaJeN4 Employee on Apr 2, 2019
Version 17Show Document
  • View in full screen mode


This guide describes how to:

  • Install the Mimecast Synchronization Engine v4.x or later.
  • Upgrade an Mimecast Synchronization Engine version 3.x to version 4.x or later.


Upgrading from a Mimecast Synchronization Engine version 2.9.x or earlier is not supported. If you're upgrading from one of these legacy versions, uninstall the existing installation, and follow the instructions in the "Installing the Mimecast Synchronization Engine" section below.

Before proceeding, we recommend reading the Mimecast Synchronization Engine Requirements page.

Installing the Mimecast Synchronization Engine


To install the Mimecast Synchronization Engine:

  1. Download the Mimecast Synchronization Engine installer from the Application Downloads page.
  2. Run the .EXE file to start the installation wizard. A welcome page is displayed.
  3. Click Next to proceed with the installation.
  4. Read the End User License Agreement.
  5. Click the I accept the terms of the License Agreement option.
  6. Click the Next button. The installer checks that all required components are present on the host.
  7. Click the Next button.
  8. If required, change the default path for State Files and Logs folders. 
    This can only be performed during a clean installation.
  9. Click the Install button. The installation starts.
  10. Click the Finish button once the installation is complete. You don't have to reboot the host server.
    The installer creates a log file in the same directory as the .EXE file. This file is useful to troubleshoot failed installations.

Installation Troubleshooting


If any of the required component(s) are shown with a red X, make a note of the name and version of any missing component(s) and follow the process below:

  1. Close the installation wizard.
  2. Install the required component(s).
  3. Restart the installation wizard.


Upgrading the Mimecast Synchronization Engine


When upgrading an Mimecast Synchronization Engine version, the following must be considered:

  • If you're upgrading a Mimecast Synchronization Engine version 3.0.x or later, the new version can be installed over the top of your current installation. You don't need to uninstall the older 3.0.x version first. Follow the instructions in the "Installing the Mimecast Synchronization Engine" section above.
  • The default path for state files (task data) and logs folders cannot be changed during an upgrade. To change the default path for these folders, a fresh install is required. Uninstall the existing installation, and follow the instructions in the "Installing the Mimecast Synchronization Engine" section above.
  • Configuration keys provided to override default behavior must be verified with Mimecast Support. This ensures they are still supported prior to upgrading.
After an upgrade, you'll need to assign the Synchronization Engine Administrator Role to a user, and do a binding to secure the connection between the Microsoft Synchronization Engine and Mimecast. We recommend following the steps on the Mimecast Synchronization Engine: Synchronization Engine Administrator Role page. 

Installation / Upgrade Changes


Following an installation or upgrade, the following can be observed on the server:

  • A Mimecast Synchronization Engine Windows service has been installed.
  • The Mimecast Synchronization Engine service is configured to run under the NETWORK SERVICE security context.
  • The folders listed below are created:
    FolderDefault Location
    Mimecast Synchronization Engine%systemdrive%:\Program Files
    The folder's location cannot be changed.
    Logs%programdata%\Mimecast Synchronization Engine
    State%programdata%\Mimecast Synchronization Engine
    Temp%programdata%\Mimecast Synchronization Engine
    The folder's location cannot be changed.


Following an upgrade the following behavior should be observed for each feature:


Mimecast Synchronization Engine serviceService is shown as running in the Windows Services MMC.
Cloud Archive for Lync IMTasks run as normal and continue with diff syncs.
Cloud Archive for FilesTasks run as normal and continue with diff syncs.
Calendar ReplicationTasks run as normal and continue with diff syncs.
Archive Power Tools:  Mailbox Folder ReplicationTasks run as normal and continue with diff syncs.
Archive Power Tools:  Exchange Managed FoldersTasks run as normal.
Archive Power Tools:  Mailbox Storage ManagementTasks run as normal.
Active Directory SynchronizationTask runs as normal.


See Also...


8 people found this helpful