Creating and running a Restore job

The restore function restores a fresh workspace in the target installation of Relativity using an archive created with ARM or a SQL restored database. This function is dependent upon the archive function. You can use this function to restore an existing workspace on a different server.

    Notes:
  • You can't restore a workspace to any previous versions of Relativity, but you can restore to newer versions. For example, you can restore an archived Relativity 9.1.137.12 workspace to Relativity 9.1.172.5 or 9.3.549.1, but you cannot restore an archived Relativity 9.1.137.12 workspace to Relativity 9.1.112.9 or Relativity 8.2.601.84.
  • For Relativity Server you can only restore a workspace to the same version of SQL Server or a higher version (this rule applies to both major and minor SQL version differences). SQL versioning is not an issue in RelativityOne. Customers can restore any workspace from Server to RelativityOne.
  • If you are moving to RelativityOne, you must migrate from a Relativity Server version 9.5.196.102 or above if you want to include Analytics data. If you do not need to restore the underlying Analytics Engine data, you can restore from older versions.
  • You can restore an archive from a version before 9.5.196.102, but the Analytics Engine data is not restored. You will need to rebuild your indexes or repopulate your structured staging areas and indexes from scratch.
  • You cannot archive a workspace from RelativityOne to Relativity Server.
  • If your archived workspace contains dtSearch archives, the target workspace must have a dtSearch index.
  • If the archived workspace uses RAR, the RAR Manager agent may need to be restarted after the restore job completes before RAR can be used in the restored workspace.
  • If you are restoring Legal Hold data, the PortalURL field in Legal Hold should be re-entered immediately after performing a restore.
  • In RelativityOne, you must be a member of at least one group that has been added to a workspace before you can access it. Because an ARM Restore job creates a new workspace when you restore an ARM archive folder, you want to ensure that your Administrator group in the RelativityOne instance is mapped to one of the groups in the ARM archive before the ARM restore job is run. This will ensure that all members of your Administrator group can access the workspace once the ARM restore job completes. See Mapping groups.
  • When you ARM restore to RelativityOne, extracted text is automatically stored in Data Grid.
  • The BAK-only restore process is not available in RelativityOne.

Note: When an archive is restored, all repository file references will be updated to reflect the destination file repository that is selected during restore job creation. If files are included in the archive, these will be copied automatically into the destination repository. If files are not included in the archive, these must be copied manually into the repository location. To override this behavior, ARM provides an advanced option to skip the file reference update. This grants additional flexibility for workflows in which repository files are not moved.

Creating and running a Restore job

To create a new restore job, click New Restore Job at the top of the ARM Jobs page. The New Restore Job page appears.

Select the Restore job type:

  • Restore Type- select from the following options:
    • Archive - run a Restore job from an Archive.
    • Database - run a Restore job from a Database.

Configure the following settings in each section on the New Restore Job page:

Note: Depending on the Restore Type selected, the settings available in each section may differ.

Source

  • Archive File – select the filepath to the archive directory from the drop-down list. This drop-down list includes all the archives from the configured archive location(s) and displays them as [Workspace Name] (Case ID - Date Archived).
  • Database - select the database from the drop-down list.
  • Job Priority – select a priority of High, Medium, or Low for the job from the drop-down list.
  • Execution Type – select from the following options:
    • Manual – run the job manually from the Job List page.
    • Scheduled – run the job automatically at a specified date and time. When you select this option, the Scheduled Start Time field appears. Click inside the field, then select a date and time from the calendar. You can schedule multiple jobs to run at the same time.

      Scheduled start time calendar

Destination

  • Resource Pool – select the resource pool in which the restored workspace will reside.
  • Database Server – select the database server that will be used by the restored workspace. All database servers in the environment are listed.
  • Client - select the client that the restored workspace will use, or enter a client name in the search box that displays. You can also enter a few letters from a client name, and the list will filter based on your input. This field ensures client domains in the target Relativity environment are respected.
  • Matter – select the matter that the restored workspace will use, or enter a matter name in the search box that displays. You can also enter a few letters from a matter name, and the list will filter based on your input. This field ensures client domains in the target Relativity environment are respected.
    Notes:
  • As of ARM 10, all new archives will contain the client and matter of the archived workspace.

  • As of ARM 10, when you select an archive with existing client and matter information the client and matter will automatically be selected. The matter name needs to be identical, and the existing matter must be associated with a client of the correct name. Additionally, if an older archive is selected that does not have this information, the default value will be selected.

  • If a matching client is not detected but the selected archive has client information, ARM will add a new option to the list of available clients reflecting the archived client. This option will be displayed on the page with (New) at the end to distinguish it from existing objects. Creating the restore job will also create this client object.

  • If a matching matter is not detected but the selected archive has matter information, ARM will add a new option to the list of available matters reflecting the archived matter. This option will be displayed on the page with (New) at the end to distinguish it from existing objects. Creating the restore job will also create this matter object.

  • File Repository – select the file repository that the restored workspace will use. All files in the archive will be placed in this repository.
  • Cache Location – select the cache location that the restored workspace will use.
  • Structured Analytics Server - select which Structured Analytics server to restore. All Analytics servers in the selected resource pool will be available for selection when the selected archive contains Analytics.
  • Conceptual Analytics Server - select which Conceptual Analytics server to restore. All Analytics servers in the selected resource pool will be available for selection when the selected archive contains Analytics.
  • Dt Search Location - select which dtSearch location in the archive to restore. All dtSearch locations in the selected resource pool will be available for selection when the selected archive contains dtSearch data.

Advanced Restore Options

These options will only be displayed if the AdvancedOptionsEnabled instance setting is set to True.

  • Reference Files As Archive Links – The current archive location will be set as the location of all records in the File table. These files will not be copied to the destination file repository, but will instead be referenced as linked files. File field data will always be transferred to the file repository. The archive location must reside within the selected file repository. This setting cannot be used if the archive is compressed.
  • Note: ARM will update the file table to reference the ARM Archive Location as the file share. If using this option, the ARM Archive Location must exist as a Fileshare Server with appropriate credentials associated to it.

  • Update Repository File Paths – The destination file repository will be set as the location of all repository records in the File table. Records that are not flagged as in-repository will not be affected. File field table records will always be updated. This setting cannot be used when "Reference Files as Archive Links" is enabled.
  • Note: ARM will update files marked as InRepository = 1

  • Update Linked File Paths – The destination file repository will be set as the location of all non-repository records in the File table. Records that are flagged as in-repository will not be affected. This setting cannot be used when "Reference Files as Archive Links" is enabled.
  • Note: ARM will update files marked as InRepository = 0

Notifications

  • Notify Job Creator – select this checkbox to notify the job creator by email when the job is started, paused, or canceled, or when the job completes successfully or fails in error.
  • Notify Job Executor – select this checkbox to notify the job executor by email when the job completes successfully or fails in error.

Note: Specific email notification settings can be configured on the Configuration page; however, selecting these two options will register the Job Creator or Job Executor for all of them. You will not receive redundant alerts (e.g., if you are the job executor, you will not receive the Job Started notification).

Once you’ve configured settings, click Next at the top of the screen. The Map Groups page appears.

Mapping groups

The Map Groups page displays a list of groups from the archive in the Archived Groups section and a list of groups that exist in the system in the System Groups section.

Map Groups page

ARM automatically maps the groups from the archive to matching groups in the system. Click Map Groups to perform the automatic mapping. The following image shows the groups from the Archived Groups section mapped to matching groups from the System Groups section.

Automatic group mapping

Confirm that all group names are in the proper position to be mapped correctly, and then click Save to save the new Restore job, or click Next to map users from the archive to the users that exist in the system.

Note: Every group must be mapped to perform the restore. If a group is not mapped, or if there are more Archived Groups in the archived workspace than System Groups in the target workspace, a new group is automatically created and mapped to during the restore. If you create a new group with the same name as an existing group, the new group name is appended with a note indicating that it was created by ARM.

Note: In RelativityOne, you must be a member of at least one group that has been added to a workspace before you can access it. Because an ARM Restore job creates a new workspace when you restore an ARM archive folder, you want to ensure that your Administrator group in the RelativityOne instance is mapped to one of the groups in the ARM archive before the ARM restore job is run. This will ensure that all members of your Administrator group can access the workspace once the ARM restore job completes.

Please contact Support for assistance if the Administrator group has not been mapped to a group from the ARM archive.

Restoring to a client domains (tenancy) enabled client

When you attempt to restore a workspace to a client domains (tenancy)-enabled client (which is determined by the selected matter), a message appears on the Map Groups page indicating that the client domain (tenant)admin account for the associated client will be given access to the workspace.

Mapping users

The Map Users page displays a list of users from the archive in the Archived Users section and a list of users that exist in the target workspace in the System Users section. ARM can automatically map users from the archive to matching users in the target workspace.

Note: Users must already exist in the target workspace to be available for automatic mapping. If you have archived users that you want to map, but the matching users haven't yet been created in the target workspace, you must create the users in the target workspace before they can be mapped. Once the users have been created in the target workspace, they will appear in the System Users section.

Note: ARM user mapping does not associate users to groups. It only maps users for audit purposes and for private saved searches. Linking users to groups must be done outside of ARM.

Map Users page

Click Map Users to perform the automatic mapping. The following image shows the users from the Archived Users section mapped to matching groups from the System Users section.

Note: For ARM 9.4.1 and above, archived users are automatically mapped to users in Relativity when the user's email address matches exactly. These users will not appear on the Map Users page.

Auto mapped users

Confirm that all group names are in the proper position to be mapped correctly, and then click Next to select Application Restore options (if Include Extended Workspace Data was selected for the ARM archive). Alternately, click Save to proceed directly to the Restore Job Details page.

Selecting applications to restore

The Select Applications screen lets you see the applications that will be restored to the new workspace and upgraded to match the version found in the application library. If the checkbox for Restore is selected, the application will be restored in the new workspace. 

Note: Required and system applications will always be installed/upgraded as part of the workspace upgrade. Additionally, if the environment you're restoring to has the same version or higher version of the application than what was archived, it will also automatically be installed/upgraded to the latest version. The Restore option will be automatically checked and grayed out in these scenarios.

You may also click Install All to select all the listed applications to restore them or click Skip All to de-select all the listed applications to specify that they will not be restored.

Click Save to save all your changes to the new Restore job and launch the Restore Job Details page.

The Restore Job Details page appears with a console on the right side of the page.

ARM job details page

From this console, you can: 

  • Click Run Job to run the job manually. See Job statuses and options.
  • Click Cancel Job to cancel the job.
  • Click the ARM Jobs tab to navigate back to the Job list and view the newly created Restore job.