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. This function is dependent upon the archive function.

You cannot restore a workspace to any previous versions of Relativity, but you can restore to newer versions.
If you are restoring Legal Hold data, the PortalURL field in Legal Hold should be re-entered immediately after performing a restore.
When you restore to RelativityOne, extracted text is automatically stored in Data Grid.
If an archive being restored has extracted text in SQL, Data Grid Text Migration application is run after the restore. Extracted text will not be available until the Data Grid Text Migration job is not completed. For more details on text migration, go to Data Grid Text Migration application page.
The BAK-only restore process is not available in RelativityOne.
ARM does not support Split Zip Archives
If you have an ARM archive from Server where SQL server had security certification installed, you cannot restore it to RelativityOne. Database needs to be decrypted before the restore process.
The restore process does not support restoring sentiment analysis results. We recommend after restoring the workspace that you re-run sentiment analysis on any documents for which you would like to see the results in the viewer.
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.

When using ARM for a workspace in repository mode, you need to select the Include Extended Workspace Data option for the ARM archive.

If you encounter a Processing related error during the restore process indicating Processing will be reset on the restored workspace in order to complete the restore, see the Community article Processing Reset Message on ARM Restore for details.

Creating a Restore job

Complete the following steps to create a new Restore job:

Click New Restore at the top of the ARM Jobs page.
Configure settings in Source & Destination fields, Options fields, and Notifications fields sections.
Click Save.

restored workspace in order to complete the restore, see the Community article Processing Reset Message on ARM Restore for details.

At this point, you can:

Click the Run Job button in the console to run the job manually.
Click the Delete Job button in the console to delete the job.
Click the ARM Jobs tab on the page to navigate back to the ARM Jobs list and view the newly created Restore job.

Source & Destination fields

See the fields to complete in the Source & Destination section

Complete the following fields:

Archive Directory—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).
When you select an archive to be restored, a new section with Archive Settings appears. You can verify which options were selected for creating that archive.
If your archive folder is not displayed, verify the following:
- Archive folder was added to ARM folder in the Staging area.
- ARM Staging location is added as Location on ARM Configuration page.
- Archive folder is not zipped.
- Archive folder has archiveinformation.xml. ARM application opens folder under ARM folder first and looks for archiveinformation.xml file to display it as available in restore. If this file is missing or is nested under another folder, ARM will not recognize that archive as a valid archive.
Client—select the client that the restored workspace will use, or enter a client name in the search box that appears. 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.
- 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 you choose a client from Client Domain, ARM will restore the workspace to the dedicated Client Domain Resource Pool.
Matter—select the matter that the restored workspace will use, or enter a matter name in the search box that appears. 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.
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.
Job Priority—select High, Medium, or Low priority 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. Update the date and time information. You can schedule multiple jobs to run at the same time. You do not need to click Run Job, the system will run it automatically. Clicking Run Job before the specified date and time will instantly start the job.

Options fields

Notifications fields

In the new ARM UI, User/Group mapping and Select application screens are not available. Users/Groups will be automapped and all applications will be included in the Restore. If you need custom configuration, switch to the old ARM UI view.

Mapping groups

Expand to map users in the old ARM UI view

During the Archive process, ARM created a database backup. All groups that existed in the original workspace were archived with their permissions. The process of Mapping groups allows you to review all archived groups from the original workspace and assign them, along with their permissions, to respective groups in the current environment or to a new group.

The Map Groups page displays a list of groups from the archived backup in the Archived Groups section and a list of groups that exist in the system in the System Groups section. You can use the search bar to look for specific groups and the up/down arrow buttons next to it to sort from A-Z or Z-A.

You must map at least one group during the restore process due to Customer lockbox, otherwise you will not be able to access the workspace.

If you would like to add a new system group at this time, you must go to the Relativity Groups tab to do so.

To automatically map the groups from the archive to matching groups in the system, click Map Groups. The following image shows the groups from the Archived Groups section mapped to matching groups from the System Groups section.

During the restore process, all workspace permissions from the Archived Group will overwrite any permissions that exist in the matching System Group.

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. In the example screen above, "New Group" was created in the system to map to the RelativityOne Support group in the archive .

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. For example, new groups will be created for Level 1 and Level 2. Since these groups already exist in the system, the new names for the created groups will be Level 1 (0) and Level 2 (0). If Level 1 (0) and Level 2 (0) also already exist, they will be renamed as Level 1 (1) and Level 2 (1).

Confirm that all group names are in the proper position to be mapped correctly.

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.

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

Selecting applications to restore

Running a Restore job

After you click the Run Job button for an already existing Restore job, ARM will display job in progress screen with main status of the job, detailed stage part, archive settings, and actionable panel on the right.

On the top of the page, you can see the job's phase overall status with the following information:

Status—status of the job.
Time Elapsed—the time elapsed since the job was started.
Phase—displayed if the archive job is in Validation, Restoring or Reporting phase.

ARM job is divided into three main phases that are comprised of multiple stages. You can click on a phase to expand all stages inside. Stages in a phase are executed simultaneously.

Job phases and stages

When running a restore job, phases and stages are as follows:

Validation—ARM verifies different workspace and environment components to establish if archive is ready to be restored.
1. Environment validation
2. Restore preparation
3. Application Data Migration - Validation
Execution
1. Files' paths update
2. Repository file validation
3. User and Group mapping
4. Post-restore database update
5. Workspace preparation for data restore
6. File migration
7. Restore: Rename Database
8. Applications installing
9. Workspace upgrade
10. Application Data Migration
Reporting
1. Statistic gathering

In the actionable panel on the right, you can do the following with a currently running job:

Pause job—status of the job will change to Pause Requested. When pause is requested, job will continue executing tasks and will pause after the stage is completed. This provides a stable location to continue processing from if you retry the job.
Cancel job—when a job is canceled, it will continue executing tasks until it reaches a safe spot to cancel. If a job is in 'Canceling' status, you can already create a new job from the same workspace.
Download logs—click the Download Logs button to download a report on the job in .txt format.

When a Restore job finishes, ARM displays a summary page. For details, see Summary page.

Job statuses

A Restore Job can have several statuses:

Not Started—job has been created but not run. You can run the job or delete it from ARM.
Execution Requested—the job has been initialized, and it is waiting for resources to be picked up.
In Progress—the job is running, and detailed progress can be reviewed on the page.
Processing with Errors—one or many tasks in the job errored but other tasks in a stage are still in progress. When all tasks complete, job status will change to Errored status and you can Retry it.
Errored—the job encountered an error, you can Retry Job to restart it or click Cancel Job to stop it.
Cancellation—when you cancel the job, initially job status will change to Cancellation Requested. When it reaches the save spot to cancel, the status will change to Cancellation Complete.
Paused—when you pause the job, initially job status will change to Pause Requested. When it is safe for the job to be paused, the status will change to Paused. You can re-submit the job, and it will continue from the moment it was paused.

Summary page

Completed ARM jobs can be reviewed on the Summary page.

Job Statistics section—presents the number of workspace, archive, skipped, and malware items in the restore job. These items are displayed for the following file types:

Document Files (Repository + Linked)—the sum of restored Document Repository and Linked Files. If Processing has been excluded from the Archive, it will also include Published files.
Processing—the sum of Processing files.
Analytics Conceptual—the sum of Conceptual Analytics files.
Structured Analytics—the sum of Structured Analytics files.
dtSearch Indexes—the sum of dtSearch indexes.
Review Center—the number of files restored for Review Center application.
Audit ECE—the number of Audit records restored.

The OCR folders within the Processing folder are no longer copied. This only happens during processing to generate the extracted text and it is not needed for the Archive and the Restore. That may result in difference in the number of Processing Files between Archive Content and Workspace Repository. See the following Community article for more details.

Source & Destination section—displays the following information for each job:

Status—jobs can have the following statuses:
- Cancellation Complete—a successfully canceled job cannot be retried.
- Complete
Job ID—the identification number of the job.
Job execution guid—additional identification number for the job.
Archive Directory—location of the archive folder.
Client—client selected for the job.
Matter—matter selected for the job.
Job Priority—priority selected for the job.

Also, you can display job settings in Options and Notification tabs.

Action History section—displays history and detailed information on users’ interaction with the job.

In the actionable panel on the right, you can:

Download Malware File List—if ARM detects Malware Files during Restore, you can click the Download Malware File List button to download a .csv file containing a list of the malware files.
Download Missing File List—for Restore jobs, if any of the files in the job were missing, you can click the Download Missing File List button to download a .csv file containing a list of the missing files.
Download Logs—click the Download Logs button to download a report on the job in .txt format.