Installation Overview

Archive Shuttle requirements

Before starting an Archive Shuttle installation, we strongly advise that you read this whole article to get an overview and clear understanding of the installation process. In addition, we advise that you read the Archive Shuttle Planning Guide.

Archive Shuttle hardware requirements

Hardware requirements for Archive Shuttle servers

The following components are normally installed on separate servers in a production environment:

  • The Archive Shuttle Core Server
  • The Archive Shuttle Modules
  • SQL Server databases

For pilot or demonstration purposes only, some or all of these can be installed on the same server.

Note: For performance reasons, this is not supported on a production environment.

Hardware requirements for Archive Shuttle Core Server

The table below indicates the requirements for the Archive Shuttle Core Server.

Component Configuration
Processors (cores) Minimum 4, Recommended 8
CPU Speed 2 GHz
Memory Minimum 4 GB, Recommended 8 GB
Hard disk Minimum 2 GB of free space

The Archive Shuttle Server is supported on an Enterprise-ready virtualization platform. For example, VMware ESX, Microsoft Hyper-V. Desktop products are not supported (for example, VMware Workstation, Oracle Virtualbox).

Hardware requirements for Archive Shuttle modules

Archive Shuttle modules are supported on servers where the software vendor’s own minimum requirements are met (for example, Veritas Enterprise Vault / Microsoft Exchange).

Additionally, most export/import modules require a buffer or cache area for temporary storage of exported files. This is called the Staging Area. The minimum recommended size for the Staging Area is 100 GB, and should be on fast, direct attached disk for maximum performance.

Note: The size of the Staging Area does not need to match the source data size.

Hardware requirements for Archive Shuttle modules on standalone servers

If the Archive Shuttle modules are installed on separate standalone servers, then the requirements are as follows:

Component Configuration
Processors (cores) Minimum 4, Recommended 8
CPU Speed 2 GHz
Memory Minimum 4 GB, Recommended 8 GB
Hard disk Minimum 2 GB of free space

Note: Improve performance of the Office 365 and Exchange modules by adding more CPUs and memory.

The following are suggested requirements where Exchange / Office 365 modules are installed:

Component Configuration
Processors (cores) Minimum 4, Recommended 8
CPU Speed 2 GHz
Memory Minimum 16 GB, Recommended 32 GB
Hard disk Minimum 2 GB of free space

Hardware requirements for SQL Server

Archive Shuttle requires a number of SQL databases:

  • The Archive Shuttle Directory database holds the configuration information.
  • Each Archive Shuttle Item database holds item information for a link. For every source link, there needs to be an item database.

The SQL Server that manages these databases must reside on a separate server than the Archive Shuttle core and modules. The only exception is for a non-production pilot/demonstration system. It’s also recommended that it has a dedicated SQL Server instance that’s not shared with other applications.

The table below indicates the requirements for SQL Server for a small Archive Shuttle migration (less than 5 Tb).

Component Configuration
Processors (cores) Minimum 4, Recommended 8
Memory Minimum 16 GB, Recommended 32 GB
Hard disk Disks should be configured as per Microsoft SQL Server best practices with TempDB, databases and logs on separate disks.
Virtualization Supported, however performance may be impacted if resources mentioned above are not dedicated

The table below indicates the requirements for SQL Server for a medium Archive Shuttle migration (less than 20 Tb).

Component Configuration
Processors (cores) Minimum 8, Recommended 16
Memory Minimum 32 GB, Recommended 64 GB
Hard disk Disks should be configured as per Microsoft SQL Server best practices with TempDB, databases and logs on separate disks.
Virtualization Supported, however performance may be impacted if resources mentioned above are not dedicated

The table below indicates the requirements for SQL Server for a large Archive Shuttle migration (more than 20 Tb).

Component Configuration
Processors (cores) Minimum 16, Recommended 32
Memory Minimum 64 GB, Recommended 128 GB
Hard disk Disks should be configured as per Microsoft SQL Server best practices with TempDB, databases and logs on separate disks.
Virtualization Not normally supported. Contact Quadrotech if virtualization is the only possibility.

Archive Shuttle keeps track of every item it exports/imports for auditing purposes. It places a reliance on SQL Server for this task. An adequately prepared SQL Server that meets the recommended specification is essential for a fast migration.

Note: Performance of the migration will be impacted if the SQL Server environment is not sufficient for the needs of the migration.

Network requirements

Archive Shuttle can generate a considerable amount of network traffic. For optimal performance, we recommend a 1 Gbps below 10ms latency network.

For “offline” functionality (offline data shipping), it is still necessary to have a network connection for metadata transmission.

We recommend that you have at least 2 Mbps below 50ms latency network connection from the Archive Shuttle Modules to the Archive Shuttle Core, and a 100 Mbps below 10ms latency network connection for the Archive Shuttle Core to SQL Server communication.

Storage requirements

The following components of Archive Shuttle require storage:

  • Cache for export/import modules
  • PST Staging Area
  • SQL Server databases, including the Archive Shuttle Directory database and Item databases

Storage requirements for export/import modules cache location

The cache location for export/import modules must be accessible through CIFS (network share) and should be located on an NTFS formatted volume. It should have a minimum capacity of 100 GB. We recommend that you have fast disks in order to ensure the best migration performance.

Note: Export will stop if the free space on the staging area drops to 20 GB or lower. Free disk space can be reviewed on the Health Dashboard.

Storage requirements for PST Staging Area location

If migration is taking place to PST files, then an additional area is needed for that link. This area is where the final PST files will be placed by Archive Shuttle. The size of this area will be dependent on the source data size. For example, if the source data size shown in the Vault Store Usage Report totals 2 TB, then a staging area of approximately twice this size is required.

Storage requirements for SQL databases

Storage is required for the following SQL databases:

  • Archive Shuttle Directory database
  • Item databases

The directory database size requirement is 500 MB. However, to allow for temporary transaction log growth, it is recommended to ensure at least 5 GB is available for the database.

Each item database has an initial storage requirement of 2 GB; 1 GB for the data file, and 1 GB for the transaction log.

A basic sizing guide for each item database is 1024 – 1500 bytes for each item collected plus 1 GB for static data, transaction logs and temporary data fluctuations.

Archive Shuttle software requirements

The following sections cover information relating to the minimum tested configurations of Archive Shuttle. If these requirements do not match the environment where Archive Shuttle is being installed, then the differences should first be discussed with Quadrotech Support.

Operating System

For a list of supported operating systems, see the Archive Shuttle Compatibility Guide.

Install the components below on this server.

Note: The Archive Shuttle installer will check for pre-requisites and assist with information about next steps.

*Not part of pre-requisites checks due to the fact this is required for Cargo Bay.

Internet Information Services (IIS) 7.5 or later

IIS 7.5 or later is required on the Archive Shuttle core server.

The Archive Shuttle installer will install two new Web Applications to the Default Website and create two new Application Pools. It is not necessary to configure these manually.

The following Web Server (IIS) Role services are required by Archive Shuttle:

Group Role / Service
Common HTTP Features
  • Static Content
  • Default Document
  • Directory Browsing
  • HTTP Errors
  • HTTP Redirection
Application Development
  • ASP.NET
  • .NET Extensibility
  • ISAPI Extensions
  • ISAPI Filters
Health and Diagnostics
  • HTTP Logging
  • Request Monitor
Security
  • Windows Authentication
  • Request Filtering
Performance
  • Static Content Compression
  • Dynamic Content Compression
Management Tools
  • IIS Management Console

The simplest way to install these components is to select the options to install:

  • Application Server
  • Web Server

The details of how to do this for different operating systems is described below:

Windows Server 2012

To ensure the required components are installed, perform the following steps in Server Manager:

  • In Server Roles, select “Web Server (IIS)”. When “Web Server (IIS)” is selected, a pop-up will appear describing additional components that will be installed.
  • In “Features” ensure that .Net Framework 4.5 > WCF Services > HTTP Activation is selected; a pop-up will appear showing additional components that will also be installed
  • For “Web Server Role (IIS)” > “Role Services”, make sure that the following options are selected in addition to those already shown:
    • Common HTTP Features > HTTP Redirection
    • Performance > Dynamic Content Compression
    • Security > Windows Authentication

Server Manager will then need to be run a second time in order to add .Net Framework 3.5. This is necessary because the installation path specification for Windows 2012 legacy components is not the same as new Windows 2012 components.

When running Server Manager for the second time, make the following selections:

  • It is not necessary to make any changes to the Server Roles; Web Server (IIS) should still be selected.
  • In “Features”, make sure that “.Net Framework 3.5 Features” is selected, and inside that option, also select “HTTP Activation”. When that option is selected, a pop-up will appear showing additional components that will be installed.

Finally .Net Framework needs to be activated within IIS. To enable this feature, perform the following steps in Server Manager:

  • In “Server Roles” navigate to “Web Server (IIS)”, expand that section to locate ASP.NET 3.5, and select it as shown below:

In Windows 2012, it is possible to install these required components using the following PowerShell command:

Install-WindowsFeature Web-Server -Source WIM:D:\Sources\Install.wim:4 ; Install-WindowsFeature Net-Framework-Features, NET-Framework-45-Features -Source D:\Sources\SxS ; Install-WindowsFeature Web-Asp-Net, Web-Net-Ext45, Web-Mgmt-Tools, Web-Windows-Auth, Web-Dyn-Compression, Web-Http-Redirect, NET-HTTP-Activation -Source WIM:D:\Sources\Install.wim:4 ;

Note: Ensure you adjust the command line to the correct paths required for the media on your system.

Windows Server 2012 R2

To ensure the required components are installed, perform the following steps in Server Manager:

  • In Server Roles, select “Web Server (IIS)”. When “Web Server (IIS)” is selected, a pop-up will appear describing additional components that will be installed.
  • In “Features”, make sure that .Net Framework 4.5 > WCF Services -> HTTP Activation is selected; a pop-up will appear showing additional components that will also be installed
  • For “Web Server Role (IIS)” > “Role Services”, make sure that the following options are selected in addition to those already shown:
      • Common HTTP Features > HTTP Redirection
      • Performance > Dynamic Content Compression
    • Security > Windows Authentication

Server Manager will then need to be run a second time in order to add .Net Framework 3.5. This is necessary because the installation path specification for Windows 2012 legacy components is not the same as new Windows 2012 components.

When running Server Manager for the second time, make the following selections:

  • It is not necessary to make any changes to the Server Roles; Web Server (IIS) should still be selected.
  • In “Features”, make sure that “.Net Framework 3.5 Features” is selected, and inside that option, also select “HTTP Activation”. When that option is selected, a pop-up will appear showing additional components that will be installed.

Finally .Net Framework needs to be activated within IIS. To enable this feature, perform the following steps in Server Manager:

  • In “Server Roles” navigate to “Web Server (IIS)”, expand that section to locate ASP.NET 3.5, and select it as shown below:

In Windows 2012 R2, it is possible to install these required components using the following PowerShell command:

Install-WindowsFeature Web-Server -Source WIM:D:\Sources\Install.wim:4 ; Install-WindowsFeature Net-Framework-Features, NET-Framework-45-Features -Source D:\Sources\SxS ; Install-WindowsFeature Web-Asp-Net, Web-Net-Ext45, Web-Mgmt-Tools, Web-Windows-Auth, Web-Dyn-Compression, Web-Http-Redirect, NET-HTTP-Activation -Source WIM:D:\Sources\Install.wim:4 ;

Note: Ensure you adjust the command line to the correct paths required for the media on your system.

Windows Server 2008 R2

To ensure the required components are installed, perform the following steps in Server Manager:

  • In “Roles”, add the following:
      • “Application Server”
    • “Web Server (IIS)”.

When “Application Server” is selected, a pop-up will appear that lists some additional components and features that will be installed.

  • For the Application Server “Role Services”, make sure “Web Server (IIS)” is selected.

When Web Server (IIS) is selected, a pop-up will appear which lists some additional components and features that will be installed. After that selection is confirmed, “HTTP Activation” will be automatically selected under “Windows Process Activation Service Support”.

  • For the Web Server (IIS) “Role Services”, no additional selections are needed.

Note: When installing the required Windows 2008 R2 components, make sure that you have the installation media available and configured/specified in Server Manager if required.

.Net Framework 4.5 or later should then be installed. A link to this is provided in the Archive Shuttle Core installer.

Following the installation of these components on Windows 2008 R2, a system restart may be needed.

Internet Explorer 9 or later

We recommend that you have Internet Explorer 9 or higher installed in order to successfully configure and use Archive Shuttle.

Note: If Internet Explorer is to be used to manage Archive Shuttle, then the machine names and IP addresses that will be used should be added to the Internet Explorer Trusted Sites.

ASP.NET State Service

The ASP.NET State Service needs to be set to “Automatic” start. The default setting for this service is manual.

SQL Server

For a list of supported versions of SQL Server, see the Archive Shuttle Compatibility Guide.

Note: It is recommended to have the latest SQL Server service pack installed.

SQL Server Editions

Although Enterprise Edition of Microsoft SQL Server is recommended, Standard Edition may be used if the SQL instance uses the recommended (not minimum) resources associated with the size of migration you are performing. Planning for additional time will be required to accommodate regularly required offline maintenance.

SQL Collation

The collation for the SQL Server installation must be case-insensitive, accent-sensitive (CI, AS); case-sensitive and accent-insensitive installations are not supported.

We recommend using latin1_General_CI_AS.

SQL Server CLR Types

Install a supported version of the Microsoft SQL Server CLR Types (64-bit) using the Microsoft supplied installation files. The Archive Shuttle installer has a download option for a supported version.

The download link used in the installer is:

http://go.microsoft.com/fwlink/?LinkID=239644&clcid=0x409

SQL Server Management Objects

Install a supported version of the Microsoft SQL Server Management Objects (64-bit) using the Microsoft supplied installation files. The Archive Shuttleinstaller has a download option for a supported version.

The download link used in the installer is:

http://go.microsoft.com/fwlink/?LinkID=239659&clcid=0x409

Note: The links are given in the sections above in case the files are to be downloaded to a staging area. For example, when the Archive Shuttle server will not have direct internet access.

SQL Server Software Configuration

Both Windows Authentication mode and Mixed Mode Authentication are supported.

The SQL installation must be case-insensitive; case-sensitive SQL installations are not supported.

Permission Requirements

In general, requirements relating to permissions can be split into two categories:

  • Accounts / Permissions needed for running the Core
  • Accounts / Permissions needed for running the modules

Each of those can use independent permissions. In fact, if required, each module can use independent permissions from each other module. And that account can be different from the one running the Core.

Installing the Core typically requires a plain domain service account with Local Admin permissions on the machine and the dbcreator role on SQL. Installing Modules requires a plain domain service account with Local Admin permissions (for the install only) and then different permissions, depending on the role of the module.

  • Core: Local Admin
  • Module: Local Admin
  • SQL: DBCreator
  • Staging: Full rights for Module users

Sources/targets:

  • Enterprise Vault: EV Service Account
  • Exchange / O365: Domain service account with Local Admin rights (to run the module)
  • Exchange: Multiple accounts with Application Impersonation will be added to our Credentials Editor
  • O365: 5 Office 365 service accounts will be added to our Credentials Editor. All 5 accounts need Application Impersonation rights and 1 needs a custom admin role.

Pre-installation tasks for Archive Shuttle

Before starting the installation of Archive Shuttle, make sure that the following is available:

  • Installation MSI files
  • License file
  • Login credentials for each of the servers where components are to be installed

Installing Archive Shuttle

The following section explains how to install Archive Shuttle Core and the Archive Shuttle Modules.

Overview of Archive Shuttle licensing

Archive Shuttle uses a license file that is bound to the domain name where the Archive Shuttle Core Server is installed. A license file must be obtained that covers the features and user/data amounts that are to be migrated.

The following types of Archive Shuttle license are available:

  • Production license: This license has no time limits associated with it and has the amount of user licenses / data extraction licenses that have been purchased.
  • Trial license: This license is time limited and allows testing the full functionality of Archive Shuttle for a limited time only. When the license expires, the software continues to run in a restricted, read-only mode, which allows for many Archive Shuttle activities to be performed except export/import of data.

Obtaining a license file

License files are issued by e-mail from Quadrotech upon purchase. If a trial license is needed, please contact Quadrotech Support.

Installing Archive Shuttle license files

The license file has to be installed on the Archive Shuttle Core Server.

The license file is requested during the Archive Shuttle Core installation.

Obtaining the software

A download link will be provided by Quadrotech.

Installing Archive Shuttle Core Server

Note: Before installing Archive Shuttle, check that all the prerequisites for the planned installation have been fulfilled

To install Archive Shuttle:

  1. Log in to the designated Archive Shuttle Core Server
  1. Double-click the ArchiveShuttle.xx-x.x.xxxx.x.msi file to start the installation.

Note: Setup scans the server to determine whether it meets the prerequisites and displays a report. Install any missing prerequisites, and restart setup

  1. Install the required Archive Shuttle components for this computer.

The requirements for an Archive Shuttle Core server are as follows:

  • Core Service: Installs the Archive Shuttle Service that periodically executes Archive Shuttle tasks.
  • Web Service: Installs the Archive Shuttle Web Services. These communicate with the Archive Shuttle modules by HTTP(S).
  • Web Interface: Install the Archive Shuttle Web Interface. This is a web-based interface that enables administrators to manage Archive Shuttle.

4. Enter the account under which the components to be installed should run.

5. Enter the Archive Shuttle SQL Instance where the Archive Shuttle databases will be created. This can be:

Default instance: mySqlServerName.MyDomain.com

Named instance: mySqlServerName.MyDomain.com\MyInstanceName

6. Enter the folder where the Archive Shuttle logs should be stored.

7. Select the Archive Shuttle license file.

Note: It is essential to verify that the license information is correct. Otherwise, Archive Shuttle functionality may be disabled

Post-Installation tasks

After installation, open the Web Interface in Internet Explorer using one of the following URLs:

  • http://<hostname>/ArchiveShuttle
  • http://<hostname>/ArchiveShuttle
  • http://<ipaddress>/ArchiveShuttle

<hostname> is the name of the server where Archive Shuttle Core was installed. This can either be the fully qualified name, or just the hostname.

<ipaddress> is the IP Address of the server where Archive Shuttle Core was installed.

  • For example, IPv4: 192.168.0.1
  • For example, IPv6: [2001:db8:85a3::8a2e:370:7334]

Note: You may need to add the IP address of the Archive Shuttle server to the trusted zones in Internet Explorer.

The Archive Shuttle Web Interface Homepage should be displayed.

Installing Archive Shuttle Modules

Note: Before installing any Archive Shuttle Modules, check that all the prerequisites for the planned installation have been fulfilled.

To determine which modules to install on which servers, refer to the Planning Guide. Archive Shuttle modules are 32 Bit and can be installed on Windows 2003 servers if required (for example, when extracting data from older versions of Enterprise Vault).

For a list of supported operating systems for the Archive Shuttle modules, see the Archive Shuttle Compatibility Guide.

The following modules require .NET Framework 4.6.1:

  • EVCollectorModule40
  • ExchangeExportModule
  • ExchangeImportModule
  • ImageMasterModule
  • ImapModule
  • Office365Module
  • NativeformatImportModule
  • NativeFormaMapiImportModule
  • PowerShellModule
  • PowerShellScriptExecutionModule
  • ShortcutProcessModule40

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: The Office 365 Module requires PowerShell v3. This may need to be installed on certain Operating Systems.

If the module installer does not find this prerequisite on the system where it is being run it will provide an option to connect to the Internet in order to download it.

Configuring Outlook for Modules

This section contains general guidance relating to the configuration of Outlook for the modules that require it (see above).

Supported Versions

Archive Shuttle has several modules requiring Outlook. For a list of supported Outlook versions, see the Archive Shuttle Compatibility Guide.

Note: There are special situations where 64-bit modules, using 64-bit Outlook may be used. Contact Support for more information.

Note: 32-bit Outlook 2013 has been shown by some customers to not work too well when migrating data to PST file. If this is a target for the migration, use Outlook 2010 instead.

Outlook Profile

The Outlook Profile should be configured as follows:

  • The profile should be for the appropriate mailbox (e.g., if ingesting to Exchange 2010/2013, then the profile should be for the user account that is running the service and performing the ingestion)
  • The profile should be created for the appropriate user (if different accounts are used for different modules, make sure the profile is created after logging into Windows as that user)
  • The profile should be an online profile (not cached mode)

Max Recipients and Max Attachments

We recommend that the following registry key be configured:

HKEY_CURRENT_USER\Software\Microsoft\Office\<version>\Outlook\Options\Mail

Key Type Value
RecipientMax DWORD 0xffffffff
AttachmentMax DWORD 0xffffffff

This will enable MAPI to better handle messages with many recipients and many attachments.

Additional information on this setting is available from the Microsoft Knowledgebase.

SharedMemMaxSize

We recommend that the following registry key be configured:

HKEY_LOCAL_MACHINE\Software\Microsoft\Windows Messaging Subsystem\Applications\Outlook

Key Type Value
SharedMemMaxSize DWORD 800000

This will enable better memory handling for MAPI.

Additional information on this setting is available from the Microsoft Knowledgebase.

Exchange Import – Additional Permissions

Note: This section is for ingesting data into Exchange 2010 SP 2 or later.

The Archive Shuttle Exchange Import module ingests data in to Exchange mailboxes or Personal Archives using MAPI. However, certain messages may fail to ingest using this mechanism even after a number of retries. By default the module will fall back to use Exchange Web Services (EWS) when this situation arises.

In order to support this failback, the service account that is being used to ingest the data must be granted an additional role within Exchange.

An example of the PowerShell command that can be used to grant this extra permission is shown below:

[PS] C:\>New-ManagementRoleAssignment -Name:VaultAdminImpersonization -Role:ApplicationImpersonation -User: ADomain\TheUser

It is recommended to use 64 bit modules when ingesting data into Microsoft Exchange. In many environments an ingest bridgehead server is used to perform the ingest, and whilst the machine (physical or virtual) may have 16 Gb or more RAM, out of memory errors may be observed from time to time if the regular, 32 bit modules are used.

To use the 64 bit modules it will be necessary to install 64 bit Outlook, and then the 64 bit modules. These modules will utilize RAM beyond the normal 2 Gb Windows process limit allow for faster and more reliable migrations to take place.

Exchange Import – Exchange 2010 SP 1 and earlier

Ingestion to versions of Exchange 2010 SP 1 or earlier can be done by using EWS only. This means that the ingest provider order, on the System Configuration page, should be updated to show just EWS.

In order to support this feature, the service account that is being used to ingest the data must be granted an additional role within Exchange.An example of the PowerShell command that can be used to grant this extra permission is shown below:

[PS] C:\>New-ManagementRoleAssignment -Name:VaultAdminImpersonization -Role:ApplicationImpersonation -User: ADomain\TheUser

Office 365 Module – Additional Notes

The Archive Shuttle Office 365 module ingests data into Office 365 mailboxes or Personal Archives using the Advanced Ingestion Protocol (AIP) and optionally Exchange Web Service (EWS), utilizing Office 365 ‘service accounts’.

Configure the Office 365 Module

The Office 365 module needs credentials supplying to it in order to be able to connect to Office 365. To provide these credentials, follow the steps below:

    1. Log in to the server or workstation where the Office 365 Module is currently deployed using the account that is used to run the Archive ShuttleOffice 365 Service.
    1. Click “Start” and locate the “Credentials Editor” and click it to launch the editor.
    1. In the small application that launches, click “Add” and enter the account UPN and password for the account described in the prerequisites section.
    1. Click OK on the UPN/Password dialog
  1. Click Save in the Credentials Editor, and close the application

These credentials will be used by the module when it connects to Office 365.

Note: By default Archive Shuttle will ingest into 5 containers simultaneously; therefore, we recommend you have at least 5 service accounts.

Configure Application Impersonation

In order for the Global Admin account specified above to be used to ingest data into Office 365 mailboxes of Personal Archives, the Application Impersonation role needs to be assigned to the user. This can be done in the Office 365 Portal or via PowerShell. To do the required steps using PowerShell, follow the steps below:

    1. Log in to a server that has Windows PowerShell installed
  1. Issue the following commands in PowerShell, comments and responses are noted below each command:

$User-Credential = Get-Credential

Supply values for the following parameters:

Credential

A pop-up will appear asking for a username and password. The Global Administrator that needs to have Application Impersonation granted to them should be input

$Session = New-PSSession –ConfiguratioName Microsoft.Exchange –ConnectionUri https://outlook.office365.com/powershell-liveid/ -Credential $UserCredential –Authentication Basic –AllowRedirection

This connects a PowerShell session to Office 365 using the credentials that were just entered.

Import-PSSession $Session

This activates the above session. It may take a few seconds for this to return to the command prompt.

New-ManagementRoleAssignment –Name:VaultAdminImpersonation –Role:ApplicationImpersonation –User:<upn>

This grants the user specified the Application Impersonation role.

Note: Customers may have a standard system for naming role assignments. That naming convention can be used, but the required role is fixed by Office 365 – Application Impersonation.

Configure Office 365 Connection Rather Than Autodiscover

Normally the Office 365 Module will use the default configuration and be able to contact Office 365. In some situations it might be necessary to configure a specific URL to access Office 365. This can be done on the System Configuration page as follows:

  1. Go to the System Configuration page in Archive Shuttle.
  1. Click on Office 365 Module
  1. Locate the Connection URL entry near the bottom, and update it to show the required value.
  1. Click on Save to commit the changes.

Configure Access to Office 365 Through a Proxy Server

If the migration environment needs to use a web proxy to access HTTP or HTTPS sites on the internet, then the Office 365 module needs to be configured to also route traffic that way.

  1. Log in to the server or workstation where the Office 365 Module is currently deployed using the account that is used to run the Archive ShuttleOffice 365 Service.
  1. Browse to the folder where the module is installed, and locate the file ‘ArchiveShuttle.Module.Office365.exe.config’ and open it in a text edit.
  1. Remove the <!—and –> from the line containing the ‘defaultProxy’ and set the value to be one of:

IEConfig

AutoDetect

WinHttpConfig

NoProxyServer

  1. Save and close the file.

Restart the Office 365 Module service using Windows Service Control Manager.

Configuring Modules to use HOTS

HOTS is a feature with Archive Shuttle which allows for less bandwidth usage for migrations to Office 365 by combining a highly-optimised transfer system with storage of extracted data taking place in Microsoft Azure. The following diagram presents an overview of HOTS:

Requirements

For migrations from legacy archives to Office 365 using HOTS the following needs to be considered:

    • Using HOTS is supported for all currently supported sources, when migrating to Office 365 mailboxes or Personal Archives.
    • More CPU uses might be needed on the source environment in order to create the HOTS-format data
    • An Azure Storage Account must be configured and used for storing the extracted data
    • All export and import modules must have been configured with the connection string to the Azure Storage Account
  • A bridgehead server running the ingest and shortcut processing module should be deployed in Azure to facilitate the ingestion of the data from the Azure Storage Account.

Bridgehead Server

The bridgehead server in Azure should consist of a virtual machine with the following specification:

Component Configuration
Processors (cores) Minimum 4, Recommended 8
CPU Speed 2 GHz
Memory Minimum 16 GB, Recommended 32 GB
Hard disk Minimum 2 GB of free space

Note: Microsoft Azure machine classes change frequently so a specific machine class is not specified here.

Configure the Office 365 Module

The Office 365 module needs credentials supplying to it in order to be able to connect to Office 365. To provide these credentials, follow the steps below:

    1. Log in to the server or workstation where the Office 365 Module is currently deployed using the account that is used to run the Archive ShuttleOffice 365 Service.
    1. Click “Start” and locate the “Credentials Editor” and click it to launch the editor.
    1. In the small application that launches, click “Add” and enter the account UPN and password for the account described in the prerequisites section.
    1. Click OK on the UPN/Password dialog
  1. Click Save in the Credentials Editor, and close the application

These credentials will be used by the module when it connects to Office 365.

Note: By default Archive Shuttle will ingest into 5 containers simultaneously; therefore, we recommend you have at least 5 service accounts

Configure Application Impersonation

In order for the Global Admin account specified above to be used to ingest data into Office 365 mailboxes of Personal Archives, the Application Impersonation role needs to be assigned to the user. This can be done in the Office 365 Portal or via PowerShell. To do the required steps using PowerShell, follow the steps below:

    1. Log in to a server that has Windows PowerShell installed
  1. Issue the following commands in PowerShell, comments and responses are noted below each command:

$User-Credential = Get-Credential

Supply values for the following parameters:

Credential

A pop-up will appear asking for a username and password. The Global Administrator that needs to have Application Impersonation granted to them should be input

$Session = New-PSSession –ConfiguratioName Microsoft.Exchange –ConnectionUri https://outlook.office365.com/powershell-liveid/ -Credential $UserCredential –Authentication Basic –AllowRedirection

This connects a PowerShell session to Office 365 using the credentials that were just entered.

Import-PSSession $Session

This activates the above session. It may take a few seconds for this to return to the command prompt.

New-ManagementRoleAssignment –Name:VaultAdminImpersonation –Role:ApplicationImpersonation –User:<upn>

This grants the user specified the Application Impersonation role.

Note: Customers may have a standard system for naming role assignments. That naming convention can be used, but the required role is fixed by Office 365 – Application Impersonation.

PowerShell Execution Module

This module is responsible for executing PowerShell commands in the Stage 2 Workflow for a mapping. It is recommended to have one of these installed in the environment.

It is not necessary to associate this module with a particular link, that process is done automatically, and is controlled by the Core.

Note: This module requires .Net Framework 4.5.2

Silent/Unattended Installation

Archive Shuttle Core and the Archive Shuttle modules can be installed using a silent / unattended method. The general format of the command line is as follows:

msiexec /i <package> /quiet /l*v <msilog.file> PARAMETER1=”Param1 value” PARAMETERx….

There is a special parameter called ADDLOCAL where it is possible to either specify ALL (for all features to be installed), or list the ones that are required from the tables below.

Unattended Installation of Archive Shuttle Core

  Modules Installer
Features ASAdminModuleFeature
ADCollectorModuleFeature
EVCollectorModuleFeature
EVExportModuleFeature
EVImportModuleFeature
EVProvisioningModuleFeature
ExchangeImportModuleFeature
ShortcutPostprocessModuleFeature
NativeFormatImportModuleFeature
Office365ModuleFeature
Parameters APPLICATIONFOLDER Modules root installation path, single module can be overridden
ASADMINMODULEFOLDER
ADCOLLECTORMODULEFOLDER
EVCOLLECTORMODULEFOLDER
EVEXPORTMODULEFOLDER
EVIMPORTMODULEFOLDER
EVPROVISIONINGMODULEFOLDER
EXCHANGEIMPORTMODULEFOLDER
SHORTCUTPOSTPROCESSMODULEFOLDER
NATIVEFORMATIMPORTMODULEFOLDER
OFFICE365MODULEFOLDER
SERVICEACCOUNT Service account to be used
SERVICEPASSWORD Service account password to be used
ASWEBSERVER Archive Shuttle web server
LOGFOLDER Log file folder
USE_HTTPS USE_HTTPS=1 to enable HTTPS
ALLOW_OVERRIDE_DATABASE_NAME This enables an option in the installer to allow the Archive Shuttle Database name to be specified.
MAINDBNAME Can be used to specify a different Archive Shuttle Directory Database name.

Unattended Installation of Archive Shuttle Modules

  Modules Installer
Features CoreFeature
WebserviceFeature
WebUIFeature
Parameters APPLICATIONFOLDER Archive Shuttle Core root installation path, specific features can be overridden.
ASSERVICEFOLDER
ASWEBSERVICEFOLDER
ASWEBUIFOLDER
SERVICEACCOUNT Service account to be used
SERVICEPASSWORD Service account password to be used
LOGFOLDER Log file folder
LICENSE_FILE Path to license file to user
ASWEBSERVER Archive Shuttle Web Server
MAINSQLINSTANCE SQL instance of Archive Shuttle Directory database
USE_HTTPS USE_HTTPS=1 to enable HTTPS instead of HTTP
DONT_CHECK_WEBSERVICE Set DONT_CHECK_WEBSERVICE=1 if it is not required for the installer to check that the modules can communicate with the Archive Shuttle Core.
SKIP_TRY_START_SERVICES If specified it will prevent the installer from trying to start the services at the end of the installation

Examples of unattended installation

The following are provided as examples of how to perform an unattended installation:

Install the AD Collector Module

msiexec /i ArchiveShuttleModulesInstall-7.x.xxxxx.y /quiet /l*v C:\Temp\ADColl.log ADDLOCAL=ASAdminModuleFeature,ADCollectorModuleFeature APPLICATIONFOLDER=”D:\Modules” SERVICEACCOUNT=EV\VaultAdmin SERVICEPASSWORD=xyz123 ASWEBSERVER=SRV001.EV.LOCAL LOGFOLDER=”D:\Logs”

Install EV Export Module

msiexec /i ArchiveShuttleModulesInstall-7.x.xxxxx.y /quiet /l*v C:\Temp\ADColl.log ADDLOCAL=ASAdminModuleFeature,EVExportModuleFeature EVEXPORTMODULEFOLDER=\\file001\exportimport APPLICATIONFOLDER=”D:\Modules” SERVICEACCOUNT=EV\VaultAdmin SERVICEPASSWORD=xyz123 ASWEBSERVER=SRV001.EV.LOCAL LOGFOLDER=”D:\Logs”

Installation Examples

The following sections give some example installations showing which components are installed on which servers.

Enterprise Vault to Enterprise Vault – Cross Site

The diagram shows one possibility of where the Archive Shuttle modules can be installed in order to support the migration of Enterprise Vault archives between Enterprise Vault sites. This scenario can also be used to migrate archived data between Enterprise Vault servers and Vault Stores in the same Enterprise Vault site.

The migration configuration shown will also support migration between different versions of Enterprise Vault. This is possible because the EV Export Module is installed on a source EV server, and the EV Import Module is installed on a target EV server.

Enterprise Vault to Enterprise Vault – Cross Forest/Org/Geography

The diagram above shows a slightly more complex migration scenario that also involves more data than the first scenario.

In the above example, the dotted red line shows the possibility that the data is manually shipped between the two environments. There are several ways that this can be achieved, for example:

Physically ship the data on tape or other media between the environments. The import modules used in the target environment then need to be configured to point to the location where the copy is mounted.

Copy the data through restricted ports or firewalls. Again, the import modules used in the target environment need to be configured to point to the location where the copy is mounted.

NFS and CIFS in tandem. With this approach, the Staging Area needs to be shared via a generic username/password using NFS and again shared as a normal CIFS share. If appropriate to the environment, firewall ports for NFS then need to be opened to allow the export module to write to the NFS share. For this reason, this approach normally means that the Staging Area is located on the target environment. This is shown in the diagram below:

Note that the same approach can be used for migration to other target environments.

Reference:

http://technet.microsoft.com/en-us/library/dd758767%28v=ws.10%29.aspx

http://blogs.technet.com/b/filecab/archive/2012/09/14/server-for-nfs-in-windows-server-2012.aspx

Enterprise Vault to Exchange 2010

In the above diagram, Archive Shuttle is being used to migrate data from Enterprise Vault to Exchange 2010 (either primary mailbox or secondary mailbox/personal archive). The data involved is not particularly large; therefore, many of the modules are installed on regular, already-deployed, servers. The Archive Shuttle application server in many ways is operating as a plug-and-play appliance and also houses the data location used for export and import of the data involved in the migration.

Note: This same configuration can be used to migrate to Exchange 2013.

Enterprise Vault to Office 365

In the above diagram, Archive Shuttle is being used to migrate data from Enterprise Vault to Office 365. The communication to Office 365 allows mapping of Enterprise Vault archives to mailboxes in the cloud. The migration can be performed to either primary mailboxes or Personal Archives.

The example below illustrates a more complex environment where the environment is split across two geographies US and Europe. Each of those geographies has it’s own internet connection, and there is a corporate wide-area network joining the locations also.

In this situation, one Core can still be deployed. The modules will receive commands and transmit metadata over the corporate network. The export/import is done within each geography.

Enterprise Vault to Office 365 using Archive Shuttle.cloud

In the above diagram, Archive Shuttle.cloud is being used to migrate data from Enterprise Vault to Office 365 mailboxes. This new option with Archive Shuttle gives a cloud-based instance of Archive Shuttle (and the necessary SQL databases). This leaves customers to simply install the modules required to perform the migration and to provide a Network Share to house the Staging Area.

Another option is to use a bridgehead server as shown below:

Change Archive Shuttle Module Deployment

From time to time it may be necessary to add additional modules to servers that have already had some Archive Shuttle modules deployed. To do this, perform the following steps:

    1. From Windows Control Panel, select Programs.
    1. Select Uninstall a program.
    1. From the list of programs, select Quadrotech Archive Shuttle Modules.
    1. Right click the entry and choose Change.
  1. Follow the onscreen prompts to add/remove the required components.

Uninstalling Archive Shuttle

To uninstall Archive Shuttle, perform the following steps:

    1. From Windows Control Panel, select Programs.
    1. Select Uninstall a program.
  1. From the list of programs, select Quadrotech Archive Shuttle 64-bit.

Note: The uninstaller does not delete any data, or databases.

Appendix A: Ports used by Archive Shuttle

The following table shows the network communication ports used by Archive Shuttle. These ports are provided for reference for the situation where a firewall exists between the source and target environments in the archive migration.

SOURCE Destination Port(s) Description
Module Servers Archive ShuttleServer TCP 80 (HTTP)

TCP 443 (HTTPS)

HTTP/S Communication from Modules to Archive Shuttle Servers (*1)
Export / Import Module Servers Storage Servers (CIFS Shares) TCP 445 (CIFS) Access to CIFS Shares
Archive ShuttleServer SQL Server TCP 1433 (MSSQL) Access to Microsoft SQL Server
Archive ShuttleServer DNS Servers UDP 53 (DNS) Access to DNS for Windows
Archive ShuttleServer Domain Controllers TCP 88 (Kerberos)

TCP 445 (CIFS)

Access to Domain Controllers for Windows
Enterprise Vault Module Servers Enterprise Vault Servers Please see your Enterprise Vault documentation on what ports are needed for the Enterprise Vault API to talk to Enterprise Vault
Exchange Module Servers Exchange Servers Please see your Microsoft Exchange documentation on what ports are needed to talk to Microsoft Exchange (MAPI/EWS)
Office 365 Module Servers Office 365 TCP 443 (HTTPS) HTTPS communication from Archive Shuttle Office 365 Module to Office 365

(*1) If the Archive Shuttle core is configured to use HTTPS, then port 443 needs to be open on any firewalls. If the core is configured to use HTTP, then port 80 needs to be open on any firewalls.

Print Friendly, PDF & Email
Updated on October 3, 2019

Was this article helpful?

Related Articles