Creating and running a Restore job

Note: As of September 1, 2024, we’ve streamlined our Staging boundaries to more effectively separate staging data from workspace and system data. With this change, you will no longer be able to write to or access data outside of the four defined staging area folders. The four folders that comprise the Staging area are ARM, ProcessingSource, StructuredData, and TenantVM. Folders that were removed include FTA, Temp, Export, and dtSearch, in addition to any other folders that you manually created. Refer to the Staging Area topic and Staging Area FAQ in Community for more details.

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 cannot restore a workspace to any previous versions of Relativity, but you can restore to newer versions.
• 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.
• 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 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.
• The BAK-only restore process is not available in RelativityOne.
• ARM does not support Split Zip Archives.
• For ARM archive, if the SQL server has a security certificate installed, the archive can only be restored to an SQL Server with the same security certificate or to a database that has been encrypted 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.

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

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.

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

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).
• 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. Update the date and time information. You can schedule multiple jobs to run at the same time.

Note: 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.

Destination

• 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:
• 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.

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

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.

Note: 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.

Note: 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.

Note: 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

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.

Notes:
• Users must already exist in the target workspace (archive) 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.
• 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.

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

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

Click Save to proceed directly to the Restore Job Details page or click Next to select Application Restore options (if Include Extended Workspace Data was selected for the ARM archive) and refer to the next section for instructions.

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.

1. If the checkbox for Restore is selected, the application will be restored in the new workspace. 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.

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.

2. Click Save to save all your changes to the new Restore job. The Restore Job Details page appears.

At this point, you can: 

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

Note: 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.