Last date modified: 2026-Jun-29

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 depends on the archive function.

Considerations

Review the following before running a Restore job:

  • You can restore a workspace to newer versions of RelativityOne. You cannot restore to a previous version.
  • If you are restoring Legal Hold data, re-enter the PortalURL field immediately after the restore.
  • When you restore to RelativityOne, extracted text is automatically stored in Data Grid.
  • When you restore a workspace from Cold Storage, it is restored to review (active) state. You have 24 hours from completion of the job to move that workspace to Cold Storage to ensure that billing reflects Cold Storage status.
  • If an archive being restored has extracted text in SQL, Data Grid Text Migration application is run after the restore. Extracted text is unavailable until the Data Grid Text Migration completes. For more details on text migration, go to Data Grid Text Migration application page.
  • The BAK-only restore process is unavailable in RelativityOne.
  • ARM does not support Split Zip Archives.
  • If you have an ARM archive from Server where SQL server has security certification installed, you cannot restore it to RelativityOne. You must decrypt the database before the restore process.
  • The restore process does not support restoring sentiment analysis results. After restoring the workspace, we recommend re-running 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 are updated to reflect the destination file repository that is selected during Restore job creation. If the archive includes files, these are copied automatically into the destination repository. If files are not included in the archive, you must copy them manually into the repository location.
  • After restoring a workspace, Integration Point profiles are also restored but may not work. This is because they include old data on source and destination workspace and, after a restore, the source workspace may not exist and the destination workspace has a new artifact ID.
  • When using ARM for a workspace in repository mode, you need to select the Include Extended Workspace Data option for the ARM archive.

Creating a Restore job

Complete the following steps to create a new Restore job:

  1. Click New Restore at the top of the ARM Jobs page.
    New Restore job.
  2. Configure settings in Source & Destination fields, Options fields, and Notification fields sections.
  3. Click Save.

After saving, you can do any of the following:

  • Click Run Job in the console to run the job manually.
  • Click Delete Job 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.

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.

Source & Destination fields

Options fields

Notification fields

Archive Settings section

This section appears after you select an Archive Directory. It displays archive and Processing options that were defined for the selected archive.

Mapping groups

Mapping users

Restoring from archives stored outside the ARM directory

ARM only lists archives stored within a Client Domain ARM folder. If you previously placed archives in a different location—for example, in a folder that was configured manually on the legacy ARM Configuration tab—those archives do not appear in either the drop-down menu or the folder browser. You cannot use them as a restore source until they are moved.

To make these archives available again, use RelativityOne Staging Explorer to move the archive folder into the ARM directory of the appropriate client domain. The archive appears in the folder browser the next time you create a Restore job.

Restoring applications

All applications associated with the archived workspace are restored and upgraded to match the versions available in the Application Library.

Running a Restore job

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

Running a Restore job.

At the top of the page, you can view 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.

Each ARM job consist of three main phases, each containing 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:

  1. Job 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
  2. Restore
    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
  3. Reporting
    1. Statistic gathering

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

  • Cancel job—when you cancel a job, it continues executing tasks until it reaches a safe spot to cancel. Even if a job has 'Canceling' status, you can create a new job for the same source.
  • Download logs—click Download Logs 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—the job has been created but not run. You can run 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 encountered errors, but other tasks in a stage are still in progress. When all tasks complete, job status changes to Errored status and you can Retry it.
  • Errored—the job encountered an error. Click Retry Job to restart it or click Cancel Job to stop it.
  • Cancellation—when you cancel the job, initially the status changes to Cancellation Requested. When cancellation reaches a safe spot to cancel, the status changes to Cancellation Complete.

Summary page

You can review completed ARM jobs on the Summary page.

Restore job 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:

  • Structured Analytics—the sum of Structured Analytics files.
  • Review Center—the number of files restored for Review Center application.
  • dtSearch—the sum of dtSearch indexes.
  • Analytics Conceptual—the sum of Conceptual Analytics files.
  • Processing—the sum of Processing files.
  • Audit—the number of Audit records restored.
  • Data Grid File System—the number of Data Grid files archived. That includes files related to Data Grid enabled fields, such as Extracted text.
  • Document Files (Repository + Linked)—the sum of restored Document Repository and Linked Files. If Processing has been excluded from the Archive, the sum also includes Published files.

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 this 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—identification number of the job.
  • Job execution Guid—additional identification number for the job.
  • Archive Directory—location of the archive folder.
  • Restored Workspace—a link to the workspace that has been restored with the job.
  • Client—client selected for the job.
  • Matter—matter selected for the job.
  • Job Priority—priority selected for the job.

You can also view mappings in Groups & Users Mapping tab and review job settings on the 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 Download Malware File List 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 Download Missing File List to download a .csv file containing a list of the missing files.
  • Download Logs—click Download Logs to download a report on the job in .txt format.
Return to top of the page
Feedback