Creating and running an Archive job

The archive function assesses a workspace’s primary and critical components and packages those components into an archive. ARM includes everything that is in a workspace database including:

  • coding decision
  • layouts
  • views
  • saved searches

This archive can serve multiple purposes that vary for each organization. For example, you can use this archive to migrate a workspace from one SQL Server to another.

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

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

Source

  • Workspace – select the workspace(s) from the drop-down list, or enter a workspace name in the search box that displays. You can also enter a few letters from a workspace name, and the list will filter based on your input. You can select multiple workspaces simultaneously from the drop-down list. When you select multiple workspaces, each job will be run with the same settings for database, files, indexes, archive path, etc. If you schedule a start time with multiple workspaces selected, each job shares the same start time.
  • Note: Only a single job can exist for a single archive at a given time.

  • Job Priority – select a priority of High, Medium, or Low for the job from the drop-down list. The job priority determines the order in which the ARM agents attempt to complete tasks for jobs that are running concurrently with other jobs.

    Note: If multiple jobs are run at the same time, with the same priority, the job with the earliest creation date will be prioritized. Even if you create multiple archive jobs simultaneously, they do not share a simultaneous creation date. If two jobs do share a creation date, the priority is determined alphabetically.

  • 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, and then select a date and time from the calendar. You can schedule multiple jobs to run at the same time.

      Scheduled start time calendar

        Notes:
      • Beginning in ARM 10.3, the Recurring Jobs option will not be available for customers who do not have any recurring jobs already scheduled.
      • Existing recurring jobs will execute normally at scheduled recurrence until ARM 11.0.0.3012 (1/4 - 1/18/2020).
      • Customers with scheduled recurring jobs will no longer be able to edit their recurring jobs.

    • Recurring – run the job automatically on a recurring basis. When you select this option, the following fields appear:
      • Recurring Schedule – select whether to run the job every day, week, month, or year. When you select every week, month, or year, an additional field appears. In this field, select the day(s) or date(s) of the month on which the Archive job should run. You can make multiple selections. Finally, select a time of day for the recurring job to run.
      • Recurring Schedule End Time – on the calendar, select a date and time at which the recurring Archive job will end.
      • History Length – enter or select the number of backups to be stored in Relativity.
  • Perform validation - select whether to perform a file validation on files copied to archive locations and database validation.
  • Note: Perform validation is selected by default, if unselected the following warning appears

Destination

  • Archive Directory – the file path to the archive directory. These locations are pre-configured and are displayed for selection. There may be one or many locations configured for archive storage.

Options

  • Include Database Backup – select this option to include the workspace database in the archive. The database will be backed up, compressed, and placed in the archive directory. If you do not select this option, the database is not archived, and in order to restore the archive, you must manually restore the database on the target SQL Server.
  • Include Repository Files – select this checkbox to include all files in the workspace file repository, including files on file fields, in the archive directory.
  • Include Linked Files – select to include files that are linked to the workspace, but that are not located in the workspace file repository, in the archive directory.
      Notes:
      • Linked files included in the archive will be placed into the restored workspace repository after a successful restore.
      • Linked files will be any files marked as InRepository=0 in the File table which include files loaded with pointers as well as documents loaded via Processing.
  • Missing File Behavior – select from the drop-down menu whether to skip missing files and complete the job or to stop the job when a missing file is encountered.

    Selecting the option to skip missing files to keep the job running even when it encounters multiple missing files. After the job has completed, an CSV file is provided to review the files that were skipped.

    If the job is set to stop on missing files, the first missing file will immediately stop the job, and that file must be placed in the expected location before the job can resume.

    Note: To enable or disable Skip Missing Files for Processing, clients need to toggle the Instance Setting, MigrationFailOnFileCopyErrors, to True or False. The default value is set to True.

  • Include Processing – select this checkbox to include Invariant/Processing data in the archive directory.
    • When you enable this, ARM takes all information from both the Store database and the master Invariant database relevant to the jobs in the Store. It also packages all discovered files, including non-repository files, from the Invariant data source location.
    • You must have the Processing Migration Agent installed and enabled in order to use this option. If that agent is disabled, you'll receive an error when you attempt to archive.
    • To archive processing data, the Temporary directory field on the Worker Manager Server object in Relativity associated with the workspace in which you're processing data must display the BCP path and a server name (not just local host).
    • You should not have any processing jobs (inventory, discovery, or publish) running in the workspace you're archiving while performing the processing archive job.
    • If you receive an authentication error during the archive job, verify that the IdentityServerURL entry in the Invariant AppSettings table contains a valid address with a fully qualified domain name.
    • If processing is not included in the ARM archive, you will not be able to process any data into the restored workspace.
  • Include Processed Files - If selected, all the files and containers that have been discovered by Processing will be archived and placed in the invariant directory.
  • Include dtSearch – select this checkbox to include dtSearch indexes in the archive directory.

    Note: If dtSearch indexes exist in the workspace, but you do not select the option to include them, when the workspace is restored, those indexes will cease to function and will need to be removed and recreated from scratch.

    It is very important to archive dtSearch indexes if you want to keep them.

  • Include Analytics Indexes – select this checkbox to include Analytics indexes in the archive directory.
      Notes:
    • 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 Analytics indexes or Structured Analytics sets exist in the workspace, but you do not select the option to include them, when the workspace is restored, these will cease to function and will need to be removed and recreated. It is very important to archive these if you want to keep them.
  • Include Structured Analytics - select this checkbox to include compressed structured analytics sets such as email threading, language identification, etc.
  • Include Data Grid - select this checkbox to include Data Grid application data if present. If you are using any of the Data Grid features such as Audit or storing long text, we recommend selecting this checkbox.
  • Note: When Include Data Grid is unselected the following warning will appear:

    Notes:
  • You can't use ARM to move a Data Grid text-enabled workspace from a Relativity instance older than 9.5.196.102 to a Relativity instance version 9.5.196.102 or above.
  • As of ARM 9.6.2, if a workspace is Data Grid enabled on the archive that setting is persistent to the restore even if the Data Grid checkbox isn’t selected.
  • Include Extended Workspace Data - select this checkbox to include all admin scripts, non-core applications, and standalone resource files as exports in the archive directory.
    • When Include Extended Workspace Data is selected, the Application Error Export Behavior drop-down option appears.
      • Select Skip Application to keep running the job even if it encounters multiple errored applications. After the job has completed, an CSV file is provided to review the applications that errored and were skipped.
      • Select Stop Job to stop the job on the first errored application.
    • Note: The default value for Application Error Export Behavior is Skip Application.

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 (for example, if you are the job executor, you will not receive the Job Started notification).

When you’ve finished configuring settings for the Archive job, click Save.

The Archive 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 Delete Job to delete the job.
  • Click the ARM Jobs tab to navigate back to the Job list and view the newly created Archive job.