Last date modified: 2026-Jun-05

Imaging sets

An imaging set consists of an imaging profile and a saved search containing the documents you want to image. You run the imaging job from the imaging set console. In addition, on the Imaging Set Details page, you can view document-level error messages and rerun an imaging job if it failed.

The (Admin) Errors tab has been permanently removed from RelativityOne, and the ability to read errors through the API has been disabled. Job-specific errors are now addressable directly within your workspaces. For more information, see Errors tab deprecation.

Imaging set workflow

To image a group of documents using an imaging set, complete the following steps in order:

  1. Create a saved search containing the documents you want to image. You will select this saved search as the data source when creating the imaging set.
  2. Create an imaging profile that defines how the images are generated, or use an existing profile.
  3. Create an imaging set that references the saved search and the imaging profile.
  4. Run the imaging job from the imaging set console.

After the imaging job is complete, reviewers can view, redact, and apply markups to the images in the viewer.

Creating and editing an imaging set

To run an imaging set, you must install the Imaging Request and Imaging Response agents. The standard configuration is 4 Imaging Response agents. The maximum recommended number is 8; exceeding this limit can cause database issues. For installation and activation details, see Imaging.

To create or edit an imaging set:

  1. Navigate to the Imaging tab, and then click Imaging Sets in a workspace.
  2. Click New Imaging Set.
    The Imaging Set Form appears.
  3. Complete all required fields. See Fields for details.
  4. Click Save. The saved set layout provides the set details and the imaging set console, from which you run the imaging job. For more information, see Running an imaging set.

Fields

The imaging set form contains the following fields:

An image of Imaging Set Information and Imaging Status sections

Imaging Set Information

  • Name — The name of the imaging set.
  • Data Source — A saved search containing the documents to image. Only documents in the saved search are imaged.
  • Imaging Profile — A predefined set of parameters that controls how images are generated. The list that appears when you click the ellipsis includes both Native and Basic profiles.
  • Email Notification Recipients — The email addresses of users who should receive notification when the following processes complete within the imaging job. Separate multiple email addresses with a semicolon.
    • Imaging set completed successfully
    • Imaging set completed with errors

Imaging Status

  • Start Time — Appears when either of the following conditions is met:
    • The imaging set is in the Submitting status.
    • The imaging set is in the Imaging status and the job has started.
  • Status — The current state of the imaging job. This field refreshes automatically to show progress. The value changes based on issues encountered during the job. The possible values are:
    • Staging — The job has started, but no documents from the imaging set have been processed yet.
    • Preparing files — Relativity is preparing files for submission by splitting them into batches, creating data tables, and getting them ready for imaging. A percentage tracker reflects the progress of this status.
    • Submitting — Documents are being submitted to the queue and prepared for imaging. A percentage tracker reflects the progress of this status.
    • Imaging — The imaging job is currently running. A percentage tracker reflects the progress of this status.
    • Completed — The last document in the set has been processed and no job remains in the ImagingJob database table.
    • Completed with Errors — The last document in the set has been processed, errors occurred during the job, and no job remains in the ImagingJob database table. You can view document-level error details on the Imaging Set Details page.
    • Skipped — The document was not submitted for imaging. Documents may be skipped if they have unsupported file types that cannot be converted to images.
      In Automated Workflows, documents with a Skipped status due to unsupported file type errors are automatically excluded from subsequent imaging runs. This prevents redundant processing attempts on files that cannot be imaged. Manual imaging sets include all documents from the saved search, allowing you to retry if needed.
    • Stopped — The imaging set was stopped by Relativity.
    • Stopped by User — The imaging set was manually stopped by the user through the Stop Imaging button on the console.
  • Image Completion — Refreshes automatically to show progress. Lists the following information:
    • # documents pending submission — The number of documents from the imaging set that have not yet been submitted for imaging.
    • # documents submitted — The number of documents that have been submitted for imaging.
    • # documents remaining — The number of documents that do not yet have a status of Imaged, Errored, or Skipped. This number starts at the total document count and decreases as the imaging job progresses.
    • # documents successfully imaged — The number of documents imaged by the worker manager server without errors.
    • # documents with errors — The number of documents that were submitted to the worker manager server and received an error during imaging.
    • # documents skipped — The number of documents from the imaging set that were never submitted to the worker manager server for imaging.
  • Completion Rate — Lists the following information:
    • # documents submitted per hour — During the submission phase, the average number of documents submitted to the worker manager server per hour. This value is calculated by normalizing the number of documents submitted over a 10-minute interval and scaling up to an hour.
  • Image QC Review Status — The number of documents set to be hidden from QC review, based on your selection for the Hide Images for QC Review option after clicking Image Documents on the console. This field also lists the number of documents that currently have viewable images.
  • Last Run Error — The date and time of the last error.
Return to top of the page
Feedback