Migrate setup and configuration

This page contains the following information:

Note: Please note that this should be performed under the guidance of your CX data migration specialist.

Migrate network setup

Refer to RelativityOne network access for comprehensive information on RelativityOne network setup information.

If you plan to use Migrate, you must allow port 445, 443 traffic to relevant DNS URL (the specific URL you allow should correspond to the Azure region your RelativityOne instance is in). The ports need to be opened on On-Prem side on both Web and Agent Server.

Installing and configuring Migrate (RelativityOne)

1. You need to set the Migrate restore locations by entering values into Value fields for the following instance settings in the Relativity.Migrate section:

   Note: When configuring your Migrate application instance settings in RelativityOne, contact CX to assist.

   • Resource Pool(RelativityOne) -To locate Artifact ID for ResourcePoolID , check the Server & Agent Management > Resource Pools tab.

   Note: You may need to add ArtifactID column to your view.

   • CacheLocationId- Use the Cache Location Server artifactId associated to the Resource Pool selected above.
   • DatabaseServerId- Use the SQL - Distributed artifactId associated to the Resource Pool selected above.
   • FileRepositoryId- Use the Fileshare artifactId associated to the Resource Pool selected above.

   Note: To locate Artifact ID for CacheLocationID / DatabaseServerID / FileRepositoryID, check the Server & Agent Management > Servers tab.

2. Add an OAuth2 Client for the Migrate application.
   • Navigate to the OAuth2 Client tab in RelativityOne.
   • Click Create New OAuth2 Client.
     • Name- Please note this field only supports alpha-numeric characters.
     • Flow Grant Type- Client Credentials
     • Context User- this must be an active system administrator
     • Access Token Lifetime- 100
   • Click Save.
   • Copy the Client ID value and the Client Secret values as they will be needed later in the configuration.

Installing and configuring Migrate (Relativity Server)

Note: Migrate will support Relativity Server 9.6 until 09/30/2021 and Relativity Server 9.7, 10.0 and 10.1 until 12/31/2021. Starting 1/1/2022 the minimum Relativity Server version supported by Migrate will be Relativity Server 10.3. Migrate will continue to be compatible with unsupported Relativity Server versions for 3 months after the version support ends. For example, Relativity Server 10.3 version support ends on March 24, 2022, so Migrate will support Relativity Server 10.3 until June 24, 2022. Starting June 25, 2022 customers using Relativity Server 10.3 will not be able to use Migrate. They would either need to upgrade to a newer Relativity Server version or use ARM and RelativityOne Staging Explorer for data migration.

1. Download the latest following RAP files located in the Relativity Applications folder from the Community site.

   • Migrate.Server
   • Archive Tool
2. Install the Migrate.Server RAP file to your Relativity Server instance.
3. Add the following agents (one agent required for each as any additional one will not improve performance).

   • Migrate - Supervisor Agent

   • Migrate - Workspace Crawler Agent

   • Migrate - Archive Builder Agent

   • Migrate - Migration Data Sender Agent

4. Set the following Migrate instance setting:

   • Name - ArchiveFileSharePath

   • Section - Relativity.Migrate

   • Field Type - String

   • Value - represents the file location for your ARM archives.

5. Add the following credentials on the Credential tab:

   • Type - AFS

   • Name format – Migrate_[any name] (e.g., Migrate_test)

   • URL - URL from RelativityOne instance

   • Account Name - Client Id from when you created RelativityOne OAuth2 client for Migrate

   • Account Key - Client Secret from when you created RelativityOne OAuth2 client for Migrate

   Note: If the Credential tab is not visible, go to Tabs permissions and set the Is Visible toggle.

   

6. Install the Archive Tool application to your Relativity Server instance from the provided RAP file.

7. Create the Archive Tool Agent agent.

8. Set the BCP path to the SQL Primary server, by navigating to the Servers tab of your on-premise instance.

   

9. Set archive tool configuration by entering the following Migrate instance setting:

   • Name - Diagnostics

   • Section - Relativity.ArchiveTool

   • Field Type - True/False

   • Value - True

Note: Downloading, installing and configuring the Migrate Server RAP file is only needed during the first installation. Relativity will auto-update the Migrate Server RAP file whenever a newer version is available. The auto-update function can be disabled on request by contacting the RelativityOne Customer Experience team. If this function is disabled, Migrate may become inaccessible when a newer version is available. In order to use Migrate, a manual installation will be needed as per the instruction above.