Difference between revisions of "MailStore Server to MailStore SPE Migration"

[unchecked revision]

[pending revision]

Latest revision as of 13:35, 3 December 2024

This guide explains how to turn a MailStore Server installation into a MailStore SPE Instance.

As the two products use a slightly different format of the master database (MailStoreMaster.fdb), which contains the configuration, it is not possible to move the entire MailArchive directory of MailStore Server onto a MailStore SPE Instance Host. However, it is possible to transfer all archive stores, which contain the actual messages, by following these simple steps:

Important Notice: The MailStore Server archive stores must be on Firebird 4 or higher. If this is not the case, the entire archive (MasterDatabase and Archive Stores) must be loaded once into a MailStore Server 24.4 before it can be migrated to the SPE. All archive stores must be manually upgraded to the latest version, because then some necessary database upgrades will be performed. The MailStore SPE version must be equal or higher than the MailStore Server version where the archive stores were attached to last.

If the customer does not want to share the product key to decrypt the archive store with the service provider, the recovery key can be set to a generated value before migrating.

First create a new MailStore SPE Instance. The instance must not be started yet.
Stop all archiving profiles in MailStore Server, either by setting the execution mode to manual, by disabling all Jobs or by disabling all scheduled tasks.
Stop the MailStore Server service.
Copy all archive store directories from MailStore Server into the instance's Data directory. Do not transfer the MailStoreMaster.fdb, the MailStoreMaster.key and MailStore.xml files. Make sure, there is no remaining .lock file in any of the archive store directories. If there is, the MailStore Server service has not been stopped completely yet. When there are identical folder names, do not merge them, but give them unique names instead.

Important Notice: After this step, do not run any of the archiving profiles in MailStore Server again, otherwise you might risk that emails are not getting archived by the MailStore SPE Instance (i.e. when a profile contains automatic deletion rules).

Start the MailStore SPE Instance.
Attach the archive stores that were previously transferred to the newly created instance. In case the archive store is migrated from MailStore Server 10 or newer the recovery key (product key or generated value) of the source MailStore Server installation is required. You have to use the UnlockStore command in the DEVELOPER > Management API window of the Management Console as described here.
Set the state of one archive store to Current.

Additional Steps

Depending on the previous configuration of MailStore Server, the following tasks are to be done to configure the MailStore SPE Instance accordingly:

Create users, either manually or by synchronizing with a directory service.
Configure compliance settings.
Create archiving profiles.
Verify the rest of the configuration, such as search index configuration, export profiles, permissions, etc.

@@ Line 1: / Line 1: @@
 __NOTOC__
+This guide explains how to turn a MailStore Server installation into a MailStore SPE Instance.
-This guide shows, how to migrate a MailStore Server installation into the MailStore SPE.
+As the two products use a slightly different format of the master database (''MailStoreMaster.fdb''), which contains the configuration, it is not possible to move the entire ''MailArchive'' directory of MailStore Server onto a MailStore SPE Instance Host. However, it is possible to transfer all archive stores, which contain the actual messages, by following these simple steps:
-This can be useful, if the customer has used MailStore Server before, but now he wants the archive to be stored in a service provider's datacenter.
+<p class="msnote">'''Important Notice:''' The MailStore Server archive stores must be on Firebird 4 or higher. If this is not the case, the entire archive (MasterDatabase and Archive Stores) must be loaded once into a MailStore Server 24.4 before it can be migrated to the SPE. All archive stores must be manually upgraded to the latest version, because then some necessary database upgrades will be performed. The MailStore SPE version must be equal or higher than the MailStore Server version where the archive stores were attached to last. <br/><br/>If the customer does not want to share the product key to decrypt the archive store with the service provider, the recovery key can be set to a generated value before migrating.</p>
+* First [[Creating_Instances| create a new MailStore SPE Instance]]. The instance must not be started yet.
+* Stop all archiving profiles in MailStore Server, either by setting the execution mode to ''manual'', by disabling all ''Jobs'' or by disabling all scheduled tasks.
+* [http://en.help.mailstore.com/MailStore_Server_Service_Configuration Stop the MailStore Server] service.
+* Copy all archive store directories from MailStore Server into the instance's ''Data'' directory. Do not transfer the ''MailStoreMaster.fdb'', the ''MailStoreMaster.key'' and ''MailStore.xml'' files. Make sure, there is no remaining ''.lock'' file in any  of the archive store directories. If there is, the MailStore Server service has not been stopped completely yet. When there are identical folder names, do not merge them, but give them unique names instead.
+<p class="msnote">'''Important Notice:''' After this step, do not run any of the archiving profiles in MailStore Server again, otherwise you might risk that  emails are not getting archived by the MailStore SPE Instance (i.e. when a profile contains automatic deletion rules).</p>
+* Start the MailStore SPE Instance.
+* [[Instance_Management#Attach_Existing_Archive_Store|Attach the archive stores]] that were previously transferred to the newly created instance. In case the archive store is migrated from MailStore Server 10 or newer the recovery key (product key or generated value) of the source MailStore Server installation is required. You have to use the ''UnlockStore'' command in the ''DEVELOPER'' > ''Management API'' window of the Management Console as described [[Instance_Management#Unlock_Archive_Stores|here]].
+* Set the state of one archive store to ''Current''.
-Also, when an on-premise mailserver or on-premise e-mail files, like PSTs, should be archive by an SPE instance, it might be a good decision to do the [http://en.help.mailstore.com/Archiving_Email intial archiving with MailStore Server] in the customer's infrastructure, and then migrating the resulting MailStore databases into the SPE. Usually a [https://my.mailstore.com/TrialLicense/RequestForm?lang=en MailStore Server Trial license] will do for that purpose.
+== Additional Steps ==
+Depending on the previous configuration of MailStore Server, the following tasks are to be done to configure the MailStore SPE Instance accordingly:
-Since the MailStore databases usually are considerable smaller then the uncrompressed e-mail volume, the amount of data to be transferred initially is significantly less.
+* Create users, either manually or by synchronizing with a directory service.
+* Configure compliance settings.
-The two product use a slightly different format of the ''MasterDatabase'', which holds the configuration items, therefore it is not possible just to move the entire ''MailArchive'' directory of MailStore Server into the SPE.
+* Create archiving profiles.
+* Verify the rest of the configuration, such as search index configuration, export profiles, permissions, etc.
-However, it is possible to transfer all the ''archive stores''.
-* First you have to [[Instance_Management_-_General_Administration#Creating_Instances| create an instance]]. The instance does not have to be started yet.
-* Stop all archiving profiles in MailStore Server, either by setting the execution mode to ''manual'' or by disabling all scheduled tasks.
-* [http://en.help.mailstore.com/MailStore_Server_Service_Configuration Stop] the MailStore Server service.
-<p class="msnote">'''Important Notice:''' Do not start any of the archiving jobs on MailStore Server again, or else you might risk that some mails will not be archived by the new instance in the SPE.</p>
-* Copy the ''archive store'' directories from MailStore Server into the instance's ''Data' directory. You do not need to transfer the ''MailStoreMaster.fdb'' and ''MailStore.xml''. Make sure, there is no remaining ''.lock'' file in of the ''archive store'' directories. If there is any, the service is not stopped yet completely. When there are identical folder names, do not merge them, rename them before, instead.
-* Start the SPE instance.
-* [Instance_Management_-_Instance_Administration#Attach_Existing_Archive_Store Attach] the transferred ''archive stores'' to the newly created instance.
-*: '''Hint:''' If there are lots of ''archive stores'' to be attached, you can use a Python script to attach them automatically. More about this option, can be found [[Migrate_from_MailStore_Server_to_SPE#Scripts|here]].
-* Depending on your setup:
-** Create users or synchronize the instance with a directory service.
-A [[Migrate_from_MailStore_Server_to_SPE#Scripts|script]] is able to migrate users and user settings.
-** Create archiving profiles.
-** Set compliance options.
-== Scripts ==
-The scripts can be found in the [https://ftp.mailstore.com/pub/Scripts/Python/v9/scripts.zip Python scripting package]. You have to open them in IDLE (or your preferred IDE) and adjust the values in the header of the script according to you installation. The scripts are well documented. Python and the [[Python_API_Wrapper_Tutorial|Python API Wrapper]] have to be installed on the computer, where you want to run the scripts. This is not necessarily a server, where the SPE is installed on.
-=== bulkAttachStores.py ===
-If there are lots of archive stores, you might want to use this script. It attaches all stores in the instance's ''Data'' directory, that are not already attached. The ''name'' of the store will be the folder name. Since the original ''name'' was stored in the ''MasterDataBase'', this name is lost. In most cases, the ''name'' was equal to the folder name.
-=== readConfigFromServer.py ===
-This scripts reads some of you configuration in a file, that can be transferred to your SPE. Then you are able to use the script's counterpart on the SPE to write the configuration into the SPE instance.
-=== writeConfigToSPE.py ===
-This script writes the configuration of a MailStore Server into an SPE instance. The configuration is read from a file, that has been created with the previous script.