Mimecast for Outlook - SQL Databases

This article contains information on using SQL databases with Mimecast for Outlook in multi-user environments, including prerequisites, recommendations, installation steps, and the impact of not using roaming profiles or a central SQL server.

Using a SQL Database 

Administrators can decide whether to utilize an SQL database with Mimecast for Outlook in multi-user environments. Previous versions of Mimecast for Outlook required a centralized SQL database when deployed in environments such as Terminal Services and Citrix. This SQL database stored end-user data including:

• Authentication tokens.
• Message cache.
• Personal user settings.

Mimecast for Outlook can operate without the requirement for a central SQL database when the prerequisites outlined below are met:

• Roaming user profiles must be in use.
• The ..\AppData\Roaming folder must be included as part of this profile.
• Roaming profiles must be redirected to a network share.

Mimecast for Outlook may be deployed without the use of the Configuration Tool if no customizations are required.

User Experience if Roaming Profiles Aren't Used

We strongly recommend operating within the outlined support requirements. The guidance below is provided as information regarding the consequences of operating outside the requirements.

Should administrators deploy Mimecast for Outlook in a multi user environment without deploying a centralized SQL database, where roaming user profiles are not in place, the following will be experienced:

• The cached authentication tokens will no longer be present, causing users to reauthenticate each time a new session is started.
• Personal user settings will be cleared.
• Active Large File Send uploads will be lost between sessions. These will not be listed in the Large File Send Manager.

Moving Away from Using a Central SQL Server

As the new deployment won't have access to the data stored in the SQL database, the cached authentication token won't be present. As such, users will be required to re-authenticate the first time they access Mimecast for Outlook. Personal settings (e.g. setting sort orders and view widths) will also be cleared.

Using a SQL Database With Roaming Profiles

Mimecast for Outlook maintains backward compatibility. As such it can be used with an SQL database if you are using roaming profiles. Deploy and configure Mimecast for Outlook, by following the below steps.

This section applies to customers looking to undertake multi-user deployments of Mimecast for Outlook which require a SQL database. MySQL Community Server provides a cost-effective database platform for use with multi-user installations of Mimecast for Outlook. This is especially so where customers would otherwise not have cause to use Microsoft SQL Server.

Prerequisites

• Mimecast for Outlook.
• Mimecast for Outlook Configuration Tool.
• MySQL Installer - Community Server 5.6.21 or higher.
• MySQL Workbench 6.2 CE.
• MySQL Connector/Net connector configured for .NET or Windows on both the client machine and server.

  The MySQL Community Server connector must be configured before installing Mimecast for Outlook. Mimecast is not able to distribute this with the add-in.

Recommendations

When installing MySQL Community Server, consider the following points:

• Choose a suitable server on which to install MySQL Server.
• If the host is dedicated to running MySQL Community Server, select Dedicated Machine as the Config Type (Recommended option). Alternatively select the Server Machine option as the Config Type, where MySQL Server is expected to co-exist with server applications on the same host.
• Ensure the root password at the time of configuring adheres to your organization's password policy. The root password should to be stored in a secure location, and will be required to create the Database Login and Database for the Mimecast for Outlook Add-in later on.

Installation Steps

Step 1: Installing MySQL Community Server

To install MySQL Community Server, download and install MySQL Server as instructed. Use the relevant instructions relating to your specific version of MySQL.

Step 2: Configuring MySQL for Client Connections

Once MySQL Server has been successfully installed, you will need to configure MySQL Server to allow client connections from the network. By default, MySQL Server will only allow local connections (i.e. connections originating from the local machine).

You can configure MySQL for client connections, by using the following steps:

1. Install MySQL Workbench.
2. Connect to your local instance of MySQL Server.
3. Click on the Server | User Privileges menu item.
4. Click on Add Account.
5. Complete the dialog as follows:

   Field / Option	Description
   Login Name	Root
   Limit to Host Matching	%
   Password	Root Password
   Confirm Password	Root Password

6. Click on Apply.
7. Close MySQL Workbench.

At this point you should now have a successful installation of MySQL Community Server, which is also accessible from your internal network.

Step 3: Configuring Mimecast for Outlook

You can configure Mimecast for Outlook, by using the following steps:

1. Download and open the Mimecast for Outlook Configuration Tool.
2. Click the File | Open menu item and load the Mimecast for Outlook installation MSI.
3. Navigate to the SQL Settings section of the tool.
4. Select the Override and Customize SQL Settings.
5. Change the Database Provider drop down to MySQL.
6. Select Browse.
7. Navigate to and select the MySQL Database Connector.
8. Customize the Mimecast for Outlook installer as required.
9. Click on File | Save As, to save the customized package.

Step 4: Deploying the Mimecast for Outlook Clients to Use MySQL Community Server

You can deploy the Mimecast for Outlook clients, by using the following steps:

1. Deploy the customized installer for Mimecast for Outlook, created in Step 3, using your preferred deployment technology.
2. Test that data is populated into the database when client machines connect.
3. Open MySQL Workbench.
4. Select the relevant Schema.
5. Query the useroption table and validate that the table contains data.

   From v6.0 onwards, database upgrades are now handled automatically.
   Customers should use the SQL Settings area of the Config Tool to connect to their database and create a custom MSI.