Working with ARM

As a system admin, you can configure settings and leverage ARM functionality. The ARM tab appears in the tab list when you are in Home mode. It is not visible in the workspace in which it was installed, and it is only visible to system admins.

To work with ARM, select one of the subtabs. Clicking ARM Jobs takes you to the Job list screen, and clicking Configuration takes you to the ARM Configuration page.

Note: It is recommended that the maximum number of ARM jobs running in parallel must be less or equal to the number of enabled ARM Agents.

Job list screen

The Job list screen displays all workspace jobs with the following statuses:

  • Not Started—the job has been created but not started.
  • Paused—the job has been created and was started, then paused.
  • Processing—the job has been created and is in the process of running.
  • Errored—the job has been created and was started, then encountered an error.

The Job list screen includes the job’s name, type, priority, and status, as well as the name of the user who submitted the job and the job’s creation date. Click the name of any job to view more details for that job. If a job has been created but not yet run, you can click the Edit link to edit the job from the Job list screen.

ARM Job list page example

Job Details pages

The content of the Job Details page varies with each type of job. Click on a job to view its details.

Archive Job Details page

The Archive Job Details page lists the details for the job based on the settings when the job was created and provides additional options through the Archive Job console based on the job’s status.

Archive Job Details

Job statuses and options

The Job Details pages display different content and options based on the status of each job.

Not Started

For jobs that have not yet been run, you can run or cancel the job from the Job Actions console. Canceling the job stops the job if it is already running, and then removes the job from the job list whether or not it has started running. When you click Run Job or Cancel Job, a confirmation dialog appears. Click OK to proceed with running or canceling the job.

Errored

When a job encounters an error, you can click Retry Job to restart it or click Cancel Job to stop the job. In ARM, each stage is broken into a set of tasks. The tool makes note of the tasks that failed during the job so that you can resolve the error and retry the job.

For jobs with a status of Errored, the Stage column on the Job history page displays the stage the job was in when the error was encountered. With this information, you can attempt to resolve the error. Once the error is resolved, click Retry Job.

Processing

For jobs that are currently running, a Progress Bar pane appears. This pane identifies the stage that the job is currently along with a visual display of the stages and percent completed.

The stage name is displayed with the progress bar. The timer next to the progress bar indicates the amount of time since that particular stage was started. The Time Elapsed timer indicates the amount of time since the job was started.

Job Progress bar

Processing a Restore job

When running a Restore job, after the workspace upgrade has been complete the following warning message will appear above the Progress Bar pane.

Processing a restore job's progress bar displaying warning message

Note: ARM will also send an email notification with the same warning message if you are subscribed to receive them.

This warning message indicates that the archived workspace is available with limited accessibility while the job is still processing.

More job statuses and options

Refer to the Console buttons under Job Actions and Error and Status sections for additional options based on the status of each job.

Job Actions

For currently running jobs, you have the option to Pause or Cancel the job from Job Actions console.

  • Pause job—When a job is paused, it will continue to execute tasks and pause it after the stage is completed. Status of the job will change to Pause Requested.
  • Cancel job—When a job is canceled, it will continue to execute tasks until it reaches a safe spot to cancel. This provides a stable location to continue processing from if you retry the job.
  • Terminate job—When a job is terminated, it will permanently remove it from database, and it will no longer be available for any action.

When a job has finished running, a new Job Status pane appears. This pane displays the status, the Job Id, the Time Elapsed, and the name of the user who submitted the job.

Job status pane

Error and Status

  • Download Log—click the Download Log button in the console to download a report, in .txt format, of the job. When a job has a status of Errored, you can click the Download Log button in the console to download a text file log showing details about each step in the job.
  • Download Malware File List—if ARM detects Malware Files during Archive or Restore, you can click the Download Malware File List button in the console to download a .CSV file containing a list of the malware files.
  • Download Missing File List—for Archive jobs, if any of the files in the job were missing, you can click the Download Missing File List button in the console to download a .CSV file containing a list of the missing files.
  • Download Failed Exported Application List—for Restore jobs, if any application failed to restore, you can click the Download Failed Exported Applications List button in the console to download a report containing a list failed applications.

Recurring Jobs list

Note: The Recurring Jobs option is only available if you have recurring jobs already scheduled.

To access the Recurring Jobs list, click the ARM tab and select ARM Jobs. Next, select Recurring Jobs from the Jobs List drop-down list.

Job History screen

To access the Job History screen, click the ARM tab, and then select ARM Jobs. Next, select Job History from the Jobs List drop-down list.

The Job History screen shows all jobs that have been run from the ARM application. Click the name of a job to view the Job History page for that job.

Note: During the Archive or Restore job, if malware files are detected, a Job Warning message appears. Errors with specific files considered as malware can be found under the Errors tab. The Job Statistics table will display the files excluded from the archive or restore.

Job Status 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
    • Errored
    Note: When a job has a status of Cancellation Complete or Complete, the Download Log button appears active. However, the log file is currently empty and does not display information on the steps taken in the job.
  • Job Id—the identification number for the job.
  • Time Elapsed—the total time the job took to complete.

Job Statistics section:

  • For Archive jobs—displays the following information for each job in the Workspace Statistic, Archive Content, Skipped Files, and Malware Files columns:
    • Document Repository Files—the number of repository files archived.
    • Document Linked Files—the number of linked files archived.
    • Non Document Repository Files—the number of non-repository files archived. Files attached to Relativity objects in the workspace but not to documents are called non-repository files, such as placeholder and file type icon.
    • Processing Files—for RelativityOne, you may see this field. This is the number of Processing files archived.
    • Conceptual Analytics—the number of conceptual analytics files archived.
    • Structured Analytics—the number of structured analytics files archived.
    • dtSearch Indexes—the number of dtSearch indexes archived.
    • Extracted Text Files—the number of Data Grid files archived.
  • For Restore jobs—displays the following information for each job in the Archive Content, Workspace Repository, and Malware Files columns:
    • Document Files (Repository + Linked)—sum of restored Document repository and linked files.
    • Processing Files—the sum of Processing files.
    • Conceptual Analytics—the sum of Conceptual Analytics files.
    • Structured Analytics—the sum of Structured Analytics files.
    • dtSearch Indexes—the sum of dtSearch indexes.
    • Extracted Text Files—the sum of Data Grid files.

Note: During an archive job, if ARM cannot find a file in File repository, the file will be reported as Skipped. During an archive and restore job, if Relativity detects a file as a potential malware file, ARM will report the file as Malware File.

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

Application Restored Options section—restore statuses include: 

  • Completed—application was successfully upgraded/installed.
  • Errored—application failed to install. You can manually repair it in Application Library and/or Workspace Upgrade.
  • Not Started—application is in archive, but it is core application which ARM doesn’t have to install.
  • Skipped—user chosen to skip application.

Application Restore Options

Additionally, the Job History page lists the details for the job based on the settings when the job was created. It also includes Record History and User Action History sections to provide information on users’ interaction with the job.

Using the console, you can view additional options based on the job’s status.