Using Migrate (workflow)

Managing the migration source

Registering your Relativity Server instance with RelativityOne for the first time

Before creating a new migration, you must first register your Relativity Server instance to define a migration source. This will allow you to view all the workspaces from the given Relativity Server instance in Migrate.

  1. When you launch Migrate for the very first time, the following modal displays so that you can register your Relativity Server instance.

  1. Enter the Server GUID. You can find this in your Relativity Server instance within the InstanceIdentifier Instance Setting under the Value column.
  2. Enter a user-friendly name in Server Name.
  3. Click Register Relativity Server Instance.

    During the registration process (may take several minutes), the Registering Relativity Server Instance modal will be visible. It will close after a successful registration. All the workspaces from registered Relativity Server instances will be visible in the list (see example).

    Graphical user interface, application, table, Excel

Description automatically generated

Adding an additional migration source

  1. To add a new Migration Source, click theAdd new link.

  2. Register your new Relativity Server instance with RelativityOne. See Registering your Relativity Server instance with RelativityOne for the first time.

Editing a migration source

  1. To edit Migration Source name just chose the proper Relativity Server instance from the drop-down and click on the Edit icon (pencil).

  2. Enter a new name, and then click Save.

Deleting registration of a migration source

Note: You cannot delete an instance which has been already used as migration source for any migration (regardless of the status of the migration).

  1. To delete the registration of migration source, choose the proper Server instance from the drop-down, and then click the Delete icon (trash).

  2. To delete the registration of a migration source, click Yes, Delete Registration on this informational modal.

Primary migration workflow

Step 1 - Creating a new migration

Migrate can handle one migration at a time. When there is no migration in In Progress or Completed With Errors status you can start a new migration.

  1. Launch Migrate.

    Note: When any migration is In Progress or has Completed With Errors there will be a warning message displayed when assigning workspaces.

  2. When on View All Migrations page, click New Migration button in the upper left corner.

Step 2 – Selecting and assigning workspaces for migration

This step allows you to browse the workspaces you need to migrate, select them and assign to one of the pre-defined migration profiles. Depending on the profile selected you can either migrate all the workspace data or only a specific portion (see Profiles description). Currently, there is no ability to create a custom Profile.

Note: Assigning workspace to a Profile also assigns a workspace to a migration.

This step consists of three tabs:

  • Unassigned Workspaces— a list and count of all unassigned workspaces from selected migration source.
  • Assigned Workspaces—a list and count of all assigned workspaces to migration from selected migration source.
  • All—list and count of all the workspaces both assigned and unassigned from selected migration source.

Profiles description

Profile Details All Data No Files No Processing No Linked Files DataGrid, Processing
and Files
Include DB Backup ü ü ü ü ü
Include Conceptual ü ü ü ü False
Include DataGrid ü ü ü ü ü
Include Linked Files ü False False False False
Include Processing ü ü False ü ü
Processing Missing File Skip Skip Skip Skip Skip
Application Error Export Skip Skip Skip Skip Skip
Include dtSearch ü ü ü ü False
Include Structural Analytics ü ü ü ü False
Include Repository Files ü False ü ü ü
MissingFile Skip
Skip Skip Skip Skip
Include Processing Files ü False False ü ü
Include Extended Workspace Data ü ü ü ü False
  • All Data
    • Include DB Backup - True
    • Include Conceptual - True
    • Include DataGrid - True
    • Include Linked Files - True
    • Include Processing - True
    • Processing Missing File - Skip
    • Application Error Export - Skip
    • Include dtSearch - True
    • Include Structured Analytics - True
    • Include Repository Files - True
    • MissingFile - Skip
    • Include Processing Files - True
    • Include Extended Workspace Data – True
  • No Files
    • Include DB Backup - True
    • Include Conceptual - True
    • Include DataGrid - True
    • Include Linked Files - False
    • Include Processing - True
    • Processing Missing File - Skip
    • Application Error Export - Skip
    • Include dtSearch - True
    • Include Structured Analytics - True
    • Include Repository Files - False
    • MissingFile - Skip
    • Include Processing Files - False
    • Include Extended Workspace Data – True
  • No Processing
    • Include DB Backup - True
    • Include Conceptual - True
    • Include DataGrid - True
    • Include Linked Files - False
    • Include Processing - False
    • Processing Missing File - Skip
    • Application Error Export - Skip
    • Include dtSearch - True
    • Include Structured Analytics - True
    • Include Repository Files - True
    • MissingFile - Skip
    • Include Processing Files - False
    • Include Extended Workspace Data – True
  • No Linked Files
    • Include DB Backup - True
    • Include Conceptual - True
    • Include DataGrid - True
    • Include Linked Files - False
    • Include Processing - True
    • Processing Missing File - Skip
    • Application Error Export - Skip
    • Include dtSearch - True
    • Include Structured Analytics - True
    • Include Repository Files - True
    • MissingFile - Skip
    • Include Processing Files - True
    • Include Extended Workspace Data – True
  • DataGrid, Processing and Files
    • Include DB Backup - True
    • Include Conceptual - False
    • Include DataGrid - True
    • Include Linked Files - False
    • Include Processing - True
    • Processing Missing File - Skip
    • Application Error Export - Skip
    • Include dtSearch - False
    • Include Structured Analytics – False
    • Include Repository Files - True
    • MissingFile - Skip
    • Include Processing Files - True
    • Include Extended Workspace Data – False

Assigning a workspace to a migration profile

To assign workspace to a migration, select a workspace (from either Unassigned Workspaces or All tab), clickAssign to Profile, and then choose the proper profile.

To assign workspace to a migration, select a workspace (from either Unassigned Workspaces or All tab), click the Assign to Profile drop-down list, and then choose the proper profile.

Note: The Assign to Profile button is disabled when no workspace is selected.

You can select/unselect your workspace(s) in on of three ways:

  • Using Select all [count] workspaces / Unselect all workspaces buttons, select all / unselect all the workspaces from selected migration source.
  • Using a check box next to Name column, select/unselect all the workspaces viewed on a page.

Unassigning a workspace from a migration profile

To unassign workspace from migration profile, select a workspace (from either Assigned Workspaces or All tab), and then click the Unassign button.

Note: The Unassign button is disabled when no workspace is selected. Unassigning workspace from a profile also unassigns a workspace from a migration.

Step 3 – Previewing your migration

Note: While on the Preview step, workspaces are filtered in ascending order based on file count (the workspace with the lowest file count displays first). Since file count has significant impact on performance, Migrate starts the migration based on this order to make migration jobs quicker and more efficient.

The Preview step provides all the necessary information about migration size, workspace count and files count. In addition, you can name a migration to be more meaningful to you and manage email notifications to keep your team informed about ongoing migrations.

To preview your migration, when all appropriate workspaces have been assigned to migration profile, click Preview Migration.

Graphical user interface, application

Description automatically generated

When on the Preview step, you can easily learn about migration scope by looking at Total Workspaces count, Total Data Size and Total Files count. Hover over the tooltip to learn more about data scope.

Step 4 – Migration

The Migrate step is where you execute your migration. This screen enables you to track your migration in a single place. Regardless as to whether a workspace is being archived on Relativity Server, transferred to Staging or restored to RelativityOne – all these steps are being tracked here.

You can either track the migration progress from the wave (entire migration) or at the workspace level.

  1. Begin your migration by clicking on Migrate Workspaces in the Preview step.

  2. Basic information about the migration is displayed. To proceed, click Migrate Workspaces.

    Graphical user interface, text, application, chat or text message

Description automatically generated

    Note: Migration will start immediately after clicking Migrate Workspaces. You will be able to cancel workspace migration only when a workspace is in In Queue, Archiving, or Transferring status.

Once your migration is in progress, you can track it. See Using Migrate (workflow) for this information.

Step 5 - Tracking migrations

You can track migrations in the following ways:

Viewing all migrations

View All Migrations is a list of all in progress or completed (regardless of the status) migrations on RelativityOne instance.

To view all migrations, during workspace assignment or migration step, click View All Migrations(upper right corner).

Note: When on the Select & Assign step, View All Migrations is only available before selecting a workspace. When at least one workspace is selected View All Migrations is not available.

Viewing migration status

Migration statuses include the following:

  • Scheduled—the first migration status right after clicking Migrate Workspaces.
  • In Progress—when migration is in progress.
  • Completed—all the workspaces are successfully migrated or some workspaces are canceled
  • Completed With Warnings—failed workspaces are abandoned (see Abandon Failed Workspace Migrations).
  • Completed With Errors—(at least one workspace is in any failed status) and all the others are in Migrated status.
  • Canceled—all the workspaces are canceled

Example for migration In Progress

Viewing migration wave progress information

Migration wave progress information includes the following:

  • Total Workspaces—presents current migrated workspaces count out of the total workspaces count
  • Total Data Size—presents current migrated data size out of the total data size
    • MDF File Size
    • LDF File Size
    • Image File Size
    • Native File Size
    • Production File Size
  • Total Files—presents current migrated files count out of the total files count
    • Processing Files
    • Repository Files
  • Failed Workspaces—presents failed workspaces count
  • Abandon Workspaces—presents abandon workspaces count

Graphical user interface, text, application, chat or text message

Description automatically generated

Viewing workspace status

Workspace status properties include the following:

  • In Queue— workspace is scheduled and waiting to be archived
  • Cancel Requested—workspace was requested to be cancel
  • Cancel Request Failed—workspace failed on cancel request
  • Canceling—workspace is being canceled
  • Canceling Failed—workspace failed on cancel
  • Canceled—workspace is successfully canceled
  • Archive Requested—workspace was requested to be archived
  • Archive Request Failed—workspace failed on archive request
  • Archiving—workspace is being archived
  • Archiving Failed—workspace failed on archive
  • Archive Created—workspace has been archived
  • Transfer Requested—workspace was requested to be transferred
  • Transfer Request Failed—workspace failed on transfer request
  • Transferring—workspace is being transferred
  • Transfer Failed—workspace failed on transfer
  • Transfer Completed—workspace has been transferred
  • Restore Requested—workspace was requested to be restored
  • Restore Request Failed—workspace failed on restore request
  • Restoring—workspace is being restored
  • Restoring Failed—workspace failed on restore
  • Migrated—workspace is successfully migrated
  • Abandon Requested—failed workspace was requested to be abandoned
  • Abandoned—failed workspace has been abandoned
  • Abandon Failed—failed workspace failed on abandon

Graphical user interface, application

Description automatically generated

Viewing workspace progress details

To see detailed information about workspace progress

  1. Click the details icon (within Details column).

    The following Workspace Progress Details modal opens.

    Graphical user interface, application

Description automatically generated

    You can track migration progress on each step of its migration workflow (e.g., archiving, transferring, restoring).

    Move between the tabs to learn more detailed information about a step. The content of the tabs can vary workspace by workspace.

  2. Click Download Report to download a detailed report of Workspace Progress details.

    Note: Currently this is a JSON format. The report file will be in the following format: <workspace name>_details_<timestamp>.json (e.g., Sample Workspace_details_2020-12-01-10-28-27.json).

Other available actions

Changing the migration name

You can change the migration name on Preview, Migrate and View All Migrations page.

  1. To edit the migration name, click the Edit icon (pencil) next to Migration.

    Graphical user interface, application

Description automatically generated

  2. Edit the name as needed, then click Save.

    Graphical user interface, text, application

Description automatically generated

Note: The default migration name is “Migration[migration consecutive number]”, example Migration, Migration1, Migration2, etc.

Canceling migration setup

You can cancel a migration setup at Select & Assign and Preview step.

  1. To cancel migration setup, do one of the following:
    • Click Cancel on the Select & Assign step.        

    • Click Cancel on the Preview step    

      The following modal will appear.

      Graphical user interface, text, application

Description automatically generated

  2. Click Yes, Cancel Setup.You will start over from the assigning workspaces step.

Canceling workspace migration

You can cancel a migration of a workspace at In Queue,Archiving, and Transferring status.

  1. Click the circled X icon next to the workspace status on the Migrate step.
  2. The following Cancel Workspace modal will appear.

  3. Click Confirm. The status of the workspace will change to Canceled and the workspace will not be migrated.

Managing email notifications

You can use email notifications to keep your team informed about ongoing migrations. To manage email notifications:

  1. Click Manage Notifications during the Preview step. The following modal will appear.

  1. Insert any email addresses separating them with comma, then click Save.

    Note: The Migration creator is added to notifications for the migration by default. A maximum of 25 email addresses can be added.

The following statuses will trigger the email notifications:

  • Migration Status: In Progress (right after the start of migration)
  • Migration Status: Completed
  • Workspace Status: Failed
  • Migration Status: Completed With Errors
  • Migration Status: Completed With Warnings

Troubleshooting errored workspace migrations

When migration is in Completed With Errors status and there are workspaces in Failed status, you cannot start a new migration. In addition, a warning message will be displayed in a notification bar.

There are two options to solve this issue:

  • Retry failed workspace migrations to retry migration of selected workspaces (one at a time). See Retrying failed workspace migrations.
  • Abandon failed workspace migrations to complete the migration without workspaces with errors. All the workspaces in any failed status will be changed into Abandoned and migration will be completed without errors (status Completed With Warnings). This will allow to set up another migration if needed. See Abandoning failed workspace migrations .

Retrying failed workspace migrations

You can retry failed workspace migration after migration has completed with errors. You can only run one retry at a time. To retry other failed workspace migrations, you must wait for the retry of the previous workspace to complete.

  1. To retry a workspace migration, click the Retry icon next to workspace Status.

    Graphical user interface, application, website

Description automatically generated

    The following confirmation displays.

    Graphical user interface, text, application, email

Description automatically generated

  2. Choose Yes, Retry Workspace.The migration status will change from Completed With Errors to In Progress, and workspace migration will resume from the place it has failed.

    Note: When retrying a workspace migration, Retry icons for other failed workspaces will not be available until the retry of the migration is completed.

Abandoning failed workspace migrations

  1. Click Abandon Failed Workspace Migrations.

    The following modal appears.

    Graphical user interface, text, application, email

Description automatically generated

  2. All the workspaces in any Failed status will be requested to be abandoned. When successful, their status will be changed into Abandoned and migration will be completed without errors (status of Completed With Warnings).