Migrate setup and configuration
Note: Please note that this should be performed under the guidance of your RelativityOne Customer Enablement specialist. Use the table below to configure the DNS and Blob names for the specific region in which the instance is located. For example, if the instance is in East Asia, use the columns in the table listed for East Asia.
This page contains the following information:
Migrate network setup
Refer to RelativityOne network access for comprehensive information on RelativityOne network setup information.
If you plan to use Relativity Migrate, you must allow port 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 Agent Server only.
|
Region |
Region short |
Cosmos DB DNS name |
File share DNS name |
File share Blob name |
|---|---|---|---|---|
| Australia East | auea |
dm-cosmos-db-prod-auea.documents.azure.com dm-cosmos-db-prod-auea-australiaeast.documents.azure.com dm-cosmos-db-prod-auea-australiasoutheast.documents.azure.com |
dmsafsprodauea09alf6.file.core.windows.net | dmsafsprodauea09alf6.blob.core.windows.net |
| Brazil South | brso |
dm-cosmos-db-prod-brso.documents.azure.com dm-cosmos-db-prod-brso-brazilsouth.documents.azure.com dm-cosmos-db-prod-brso-southcentralus.documents.azure.com |
dmsafsprodbrso4j71lb.file.core.windows.net | dmsafsprodbrso4j71lb.blob.core.windows.net |
| Canada Central | cact |
dm-cosmos-db-prod-cact.documents.azure.com dm-cosmos-db-prod-cact-canadacentral.documents.azure.com dm-cosmos-db-prod-cact-canadaeast.documents.azure.com |
dmsafsprodcact1j4qrq.file.core.windows.net | dmsafsprodcact1j4qrq.blob.core.windows.net |
| Switzerland North | chno |
dm-cosmos-db-prod-chno.documents.azure.com dm-cosmos-db-prod-chno-switzerlandnorth.documents.azure.com dm-cosmos-db-prod-chno-switzerlandwest.documents.azure.com |
dmsafsprodchnoc79zmm.file.core.windows.net | dmsafsprodchnoc79zmm.blob.core.windows.net |
| Central US | ctus |
dm-cosmos-db-prod-ctus.documents.azure.com dm-cosmos-db-prod-ctus-centralus.documents.azure.com dm-cosmos-db-prod-ctus-eastus2.documents.azure.com |
dmsafsprodctuszezqxk.file.core.windows.net | dmsafsprodctuszezqxk.blob.core.windows.net |
| Germany West Central | dect |
dm-cosmos-db-prod-dect.documents.azure.com dm-cosmos-db-prod-dect-germanywestcentral.documents.azure.com dm-cosmos-db-prod-dect-switzerlandnorth.documents.azure.com |
dmsafsproddectil29ua.file.core.windows.net | dmsafsproddectil29ua.blob.core.windows.net |
| East Asia | esas |
dm-cosmos-db-prod-esas.documents.azure.com dm-cosmos-db-prod-esas-southeastasia.documents.azure.com dm-cosmos-db-prod-esas-eastasia.documents.azure.com |
dmsafsprodesaskigrwz.file.core.windows.net | dmsafsprodesaskigrwz.blob.core.windows.net |
| East US | esus |
dm-cosmos-db-prod-esus.documents.azure.com dm-cosmos-db-prod-esus-eastus.documents.azure.com dm-cosmos-db-prod-esus-westus.documents.azure.com |
dmsafsprodesusfz7kos.file.core.windows.net | dmsafsprodesusfz7kos.blob.core.windows.net |
| Korea Central | krct |
dm-cosmos-db-prod-krct.documents.azure.com dm-cosmos-db-prod-krct-koreacentral.documents.azure.com dm-cosmos-db-prod-krct-koreasouth.documents.azure.com |
dmsafsprodkrcthxep4x.file.core.windows.net | dmsafsprodkrcthxep4x.blob.core.windows.net |
| Southeast Asia | seas |
dm-cosmos-db-prod-seas.documents.azure.com dm-cosmos-db-prod-seas-eastasia.documents.azure.com dm-cosmos-db-prod-esas-eastasia.documents.azure.com |
dmsafsprodseasaog6hz.file.core.windows.net | dmsafsprodseasaog6hz.blob.core.windows.net |
| UK South | ukso |
dm-cosmos-db-prod-ukso.documents.azure.com dm-cosmos-db-prod-ukso-uksouth.documents.azure.com dm-cosmos-db-prod-ukso-ukwest.documents.azure.com |
dmsafsproduksomwqkfp.file.core.windows.net | dmsafsproduksomwqkfp.blob.core.windows.net |
| West Europe | wseu |
dm-cosmos-db-prod-wseu.documents.azure.com dm-cosmos-db-prod-wseu-westeurope.documents.azure.com dm-cosmos-db-prod-wseu-northeurope.documents.azure.com |
dmsafsprodwseusbp5bo.file.core.windows.net | dmsafsprodwseusbp5bo.blob.core.windows.net |
| UAE North | aeno |
dm-cosmos-db-prod-aeno.documents.azure.com dm-cosmos-db-prod-aeno-uaenorth.documents.azure.com dm-cosmos-db-prod-aeno-uaecentral.documents.azure.com |
dmsafsprodaenoh3hm08.file.core.windows.net | dmsafsprodaenoh3hm08.blob.core.windows.net |
| North Europe | noeu |
dm-cosmos-db-prod-noeu.documents.azure.com dm-cosmos-db-prod-noeu-northeurope.documents.azure.com dm-cosmos-db-prod-noeu-westeurope.documents.azure.com |
dmsafsprodnoeubwkqm1.file.core.windows.net | dmsafsprodnoeubwkqm1.blob.core.windows.net |
| Central India | inct |
dm-cosmos-db-prod-inct.documents.azure.com dm-cosmos-db-prod-inct-centralindia.documents.azure.com dm-cosmos-db-prod-inct-southindia.documents.azure.com |
dmsafsprodinctxob00a.file.core.windows.net | dmsafsprodinctxob00a.blob.core.windows.net |
| Japan East | jpes |
dm-cosmos-db-prod-jpes.documents.azure.com dm-cosmos-db-prod-jpes-japaneast.documents.azure.com dm-cosmos-db-prod-jpes-japanwest.documents.azure.com |
dmsafsprodjpeswspu04.file.core.windows.net | dmsafsprodjpeswspu04.blob.core.windows.net |
| South Africa North | zano |
dm-cosmos-db-prod-zano.documents.azure.com dm-cosmos-db-prod-zano-southafricanorth.documents.azure.com dm-cosmos-db-prod-zano-southafricawest.documents.azure.com |
dmsafsprodzanoayx9at.file.core.windows.net | dmsafsprodzanoayx9at.blob.core.windows.net |
Installing and configuring Migrate (RelativityOne)
- 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: If you need help configuring your Migrate application instance settings in RelativityOne, please contact the RelativityOne Customer Enablement team. If you experience technical issues or Migrate is not working as expected, please contact Customer Support.
- Resource Pool(RelativityOne)—To locate Artifact ID for ResourcePoolID , check the Server & Agent Management > Resource Pools tab.
- 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: You may need to add ArtifactID column to your view.
Note: To locate Artifact ID for the CacheLocationID, DatabaseServerID, and FileRepositoryID fields, check the Server & Agent Management > Servers tab.
- 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) - for Relativity Server versions below 12.1
Note: 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 June 30, 2022, so Migrate will support Relativity Server 10.3 until September 30, 2022. Starting October 1, 2022, customers using Relativity Server 10.3 will still be able to use Migrate however, with no Relativity support.
-
Download the following latest RAP files located in the Relativity Applications folder from the Community site.
- Install the following RAP files to your Relativity Server instance:
- Migrate.Server
- Archive Tool
- Add the following agents (one agent required for each; any additional ones will not improve performance).
Migrate - Supervisor Agent
Migrate - Workspace Crawler Agent
Migrate - Archive Builder Agent
Migrate - Migration Data Sender Agent
- Archive Tool Agent
-
Set the following Migrate instance setting:
-
Name—ArchiveFileSharePath
-
Section—Relativity.Migrate
-
Field Type—Text
-
Value—represents the file location for your ARM archives.
-
-
Add the following credentials on the Credential tab:
-
Type—AFS
-
Name format—Migrate_[any name] (for example, 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.
-
-
Set the BCP path to the SQL Primary server, by navigating to the Servers tab of your on-premise instance.
-
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 Enablement 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.
Installing and configuring Migrate (Relativity Server) - for Relativity Server versions 12.1 and above
Note: 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 June 30, 2022, so Migrate will support Relativity Server 10.3 until September 30, 2022. Starting October 1, 2022, customers using Relativity Server 10.3 will still be able to use Migrate, however, with no Relativity support.
-
Download the latest RAP file located in the Relativity Applications folder from the Community site for Migrate.Server
- Install the Migrate.Server RAP file to your Relativity Server instance.
- 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
-
Set the following Migrate instance setting:
-
Name—ArchiveFileSharePath
-
Section—Relativity.Migrate
-
Field Type—String
-
Value—represents the file location for your ARM archives.
-
-
Add the following credentials on the Credential tab:
-
Type—AFS
-
Name format—Migrate_[any name] (for example, 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.
-
-
Set ARM configuration by entering the following instance setting:
-
Name—Diagnostics
-
Section—kCura.ARM
-
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 Enablement 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.
Note: As Migrate uses ARM APIs to archive workspaces, make sure you have the latest version of ARM (12.2.9.11+) installed and properly configured on your Relativity Server instance.
