We support the two previous versions of Archive Shuttle. So, when Archive Shuttle 10.1 is released, we support versions 10.0 and 9.9 (in addition to 10.1). This article describes how to upgrade an Archive Shuttle migration environment from Archive Shuttle 10.x.
We strongly advise you read through this article in its entirety before performing any kind of production environment upgrade.
There are three components that will be upgraded:
- Archive Shuttle Core: An MSI will be run to perform this upgrade.
- Archive Shuttle Modules: An MSI will be run to perform this upgrade.
- Archive Shuttle databases: Archive Shuttle Core will upgrade the Archive Shuttle Directory Database, and each Item Database when the Windows services start, following the upgrade.
Note: See the Compatibility Guide to determine what version of .Net is required for the Archive Shuttle Core server.
Supported upgrade paths
Upgrade to Archive Shuttle 10.1 is supported from Archive Shuttle 10.0 or Archive Shuttle 9.9. The specific build that is running will not affect the upgrade.
Note: Administration of Archive Shuttle using Internet Explorer 8 is no longer supported.
Note: It’s NOT possible to upgrade Archive Shuttle to version 10.1 when existing JournalTransformation mappings are present in the database, as Archive Shuttle 10.1 contains breaking database changes. Please remove the appropriate mappings prior to your update, or finish your Journal Transformation migration in version 9.9.
If you are not sure which mapping you need to remove, run a SQL query to get a list of created Journal Transformation ContainerMappingIds.
SELECT cm.ContainerMappingId FROM dbo.ContainerMapping cm
INNER JOIN dbo.Container c ON c.ContainerId = cm.TargetContainerId
WHERE c.ContainerTypeId IN (19,20,21)
We recommend that, whenever possible, you perform the upgrade in a lab environment first. This gives you some familiarity of the upgrade process and allows you to fine-tune the upgrade steps to suit the particular customer, environment, policies, and procedures.
Having access to a lab environment also enables the exploration of the new features that are delivered in the newer version of Archive Shuttle. More information relating to the new features is available in the Release Notes and the Revision Notes.
Before starting the upgrade, it is essential to have the following:
- New Archive Shuttle 10.1 Core MSI
- New Archive Shuttle 10.1 Modules MSI
- Access to the username/passwords used during the installation for the Archive Shuttle Core and Modules
Note: Any username used during the original installation is remembered. However, the password must be re-entered.
In order for the upgrade to succeed, we recommend that there is sufficient free space on the SQL server locations for both the database and log files. The space available should be as follows:
|Archive Shuttle Directory||2x current size of database|
|Archive Shuttle Directory Logs||1x current size of log file|
|Archive Shuttle Item Database||2x current size of database|
|Archive Shuttle Item Database Logs||1x current size of log file|
Sufficient time should also be allocated to the upgrade. Upgrading a large Archive Shuttle Item Database can take several hours. We recommend you monitor the Core log files after deployment to verify the process has completed when working with large deployments.
If a problem is encountered when upgrading the Archive Shuttle database, there are manual steps that can be performed to resume the upgrade. These are available from Quadrotech Support.
Performing the upgrade
We advise you to perform the upgrade on the Archive Shuttle environment when migration activity is not actively running. Prior to performing the steps below, we recommend that you disable the Archive Shuttle modules that have been deployed and then allow some time to pass for the modules to complete their queued work before proceeding.
We also advise you to review the Archive Shuttle Dashboard. If the needles on the activity gauges are showing 0, then exports and imports are not currently running. Other background activity might still be in progress, so it is advised to perform the step of disabling the modules and reviewing the module log files to ensure work has stopped.
The following steps should be performed in order to upgrade the environment:
- Stop the Archive Shuttle Modules on all servers.
- Stop the Archive Shuttle Core service on the Archive Shuttle Core Server.
- Perform a full SQL database backup of:
- Archive Shuttle Directory Database, and
- Every Archive Shuttle Item Database
- Run the new Archive Shuttle 10.1 Core MSI on the Archive Shuttle Core Server.
- Verify that the installation/upgrade completes without errors. When the installation has been completed, open the Archive Shuttle Admin Interface and navigate to some of the pages.
- Run the Archive Shuttle 10.1 Module MSI on each server which have modules installed.
Note: If the migration target is Exchange or Office 365 and the server running the ingestion module is Windows 2008 R2, there is an additional Microsoft component to install: http://www.microsoft.com/en-us/download/details.aspx?id=34595
Note: If the Office 365 Leavers functionality is to be used within Archive Shuttle, then there are additional requirements described in this link: https://msdn.microsoft.com/en-us/library/azure/jj151815.aspx
Note: For the Office 365 module to process licensing for Leavers, the PowerShell execution policy needs to be set to RemoteSigned or Unrestricted.
Verify that the installation/upgrade completes without errors. After the installation the Archive Shuttle modules page in the Admin Interface should show all modules without a red background. This indicates that they are properly communicating with the Archive Shuttle Core.
Note: If any changes have been made with regards to the logging levels for the Archive Shuttle Core or Modules, those changes will need to be implemented again once the upgrade has completed.
When the upgrade has been completed, perform the following post upgrade checks and ensure the step relating to Environment Sync is performed.
Post upgrade checks
Following the installation and upgrade of the migration environment, verify the upgrade by performing the followings tasks:
- Open the Archive Shuttle administration page, and verify that the page opens without errors.
- Verify the build number in the lower left hand corner of the administration page. It should be: 10.1.0.NNNNN (NNNNN will be five digits indicating the exact build number)
- Go to the EV Environment page, and perform a Sync All EV Environments operation. This will take a few minutes to run, and is an essential post-upgrade step.
- Open the Modules page from the Archive Shuttle administration page, and verify that all of the modules are accessible (none should show red, indicating that the Archive Shuttle Core has had issues contacting the module).
- Verify that all the Archive Shuttle services are started using the Windows Service Control Manager on each server in the environment.
- In each of the Archive Shuttle databases (Directory Database, and each Item Database) there is a table called SchemaVersion. The versions reported should be as follows:
- Archive Shuttle Directory Database: 10.1.0.0
- Archive Shuttle Item Database: 10.1.0.0
Note: If the SchemaVersion tables do not show these versions, contact Quadrotech Support.
We also recommend that you perform another full database backup prior to using Archive Shuttle for further archive migrations.