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

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

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

ARM New Archive Job page

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.
      Notes:
      • Workspaces in Cold Storage can be archived directly from the Workspace drop-down and do not have to be moved to an active state before archiving.
      • 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.
  • Perform validation—select whether to perform a file validation on files copied to archive locations and database validation.After repository and linked files are copied to the archive location, ARM will verify if those files are present in the archive location and the missing file list is completed if needed.

    • Note: If you clear (unselect) this field, a warning message appears alerting you that additional verification steps will not be performed. We recommend leaving Perform validation selected to ensure ARM archive integrity.

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 checkbox 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 this checkbox 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.

    • Skip File—if you select to skip missing files encountered to keep the job running, a CSV file is provided after the job has completed so that you can review the skipped files.

  • Stop Job—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.
  • 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.
  • 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:
    • 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.
    • When archiving Analytics data, a folder is created on the Analytics server at /.../<CAAT_INSTALLATION_DIRECTORY>/filedata/<INDEX_NAME>/. After the job completes successfully, the CSV files located in this location can be manually removed to reclaim space. These files will not be removed automatically.
  • Corrupted Analytics Indexes Behavior—if Include Analytics Indexes was selected, this field displays. Select from the drop-down menu whether to skip corrupted analytics index files and complete the job or to stop the job when a corrupted file is encountered.
    • Skip File—if you select to skip corrupted files encountered to keep the job running, a CSV file is provided after the job has completed so that you can review the skipped files.
  • Stop Job—if the job is set to stop on corrupted files, the first corrupted file will immediately stop the job, and that file must be corrected before the job can resume.
  • Include Structured Analytics—select this checkbox to include structured analytics sets such as email threading, language identification, etc.

Processing Options

  • 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 primary 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 will 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 are 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.

Note: When "Include Processing" is not selected, be aware that ARM will not archive Invariant database or discovered files, and published files will be treated as "Linked files." Also, you will not be able to process any data (such as documents, sets, profiles) from the source workspace in the restored workspace because it was not included when archived. Additionally, if you do not plan to use Processing after restoring, but you need a copy of published files, then do not select "Include Processing" and select "Include Linked Files" under the Options section.

  • Include Processed Files—if this option is selected, all the files and containers that have been discovered, that are not published, and that reside in the <FileRepository\EDDSnnn\Processing\...> will be archived and placed in the invariant directory by the Processing Migrator. If the option is not selected, processed but unpublished files that reside in the <FileRepository\EDDSnnn\Processing\...> directory are not copied.
  • 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.

    • Skip File—if you select to skip missing files encountered to keep the job running, a CSV file is provided after the job has completed so that you can review the skipped files.

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.

  • Stop Job—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.

Extended Workspace Data Options

  • 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. This option should be selected to preserve the status of a Repository workspace when restored.
  • Application Error Export Behavior—if Include Extended Workspace Data is selected, this field appears.
    • Skip Application—this is the default selection. This option keeps running the job even if it encounters multiple errored applications. After the job has completed, a CSV file is provided so you can review the applications that errored and were skipped.
    • Stop Job—select to stop the job on the first errored application.

Notifications

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).

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

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

The Archive Job Details page appears with the Job Actions console.

ARM job details page

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 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 Archive job.