Imaging

You can use imaging to convert a group of documents to images using imaging profiles and sets. You can fine-tune how your images generate by creating reusable profiles that use specific image settings.

With imaging sets, you can image a group of documents by selecting a saved search and a specific imaging profile. Imaging sets also provide error-handling functionality you can use to view error messages and rerun imaging on specific documents or jobs.

Beginning in Relativity 9 the worker manager server is required to perform both basic and native imaging.

Note: Beginning in Relativity 9.0, Oracle is no longer built into the Relativity agent framework, but is instead built into the Invariant worker. The required Worker Manager Server/Invariant component actually does the work of basic imaging by using Oracle's imaging capabilities.

Note: Starting in Relativity 8, when you upgrade the Imaging application, your default native imaging settings aren't over-written, which means that you aren't required to re-set them.

This page contains the following information:

See these related pages:

Required security permissions for imaging

The following security permissions are required to image documents in Relativity. These apply to all imaging options, including image-on-the-fly, mass image, and imaging sets, unless otherwise noted.

Object Security Tab Visibility Other Settings
  • Document - Add, View
    • Add Image
  • Imaging Profile - View, Edit, Add
  • Imaging Set - View, Edit, Add
    • You can still use mass imaging and image-on-the-fly even if you don't have the Edit permission on the Imaging Set object.
  • Relativity Application - View
  • Documents
  • Imaging Profiles
  • Imaging Sets
  • Mass Operations
    • Images

Note: When you run imaging on a specific saved search used in an Imaging set, documents that don't have the "Add Image" permission will be skipped.

Installing imaging agents

To run any imaging job in your environment, you need the following agents:

  • Imaging Manager Agent - ensures that Imaging is functioning properly. This includes tasks such as cleaning up stuck imaging jobs and deleting Imaging Warnings that are no longer linked to documents. For more information, see Imaging Response Agent.
  • Imaging Request Agent - performs background tasks when any imaging request is submitted via mass imaging, image on the fly, or imaging set. For more information, see Imaging Manager Agent.
  • Imaging Response Agent - picks up imaging set, mass imaging, and image-on-the-fly messages from Service Bus (as published by Workers) and directing them to the proper finalization logic in Relativity. For more information, see Imaging Request Agent.

These agents are automatically installed and enabled in your environment.

To install an additional agent:

  1. Navigate to the Agents tab.
  2. Click New Agent and complete the following required fields:
    Select Agent Type
    • Agent Type - access the list of agents, filter for the Imaging Request/Response Agent, select it, and click OK.
    • Number of agents - enter the number of agents you want to add.
    • Agent Server - select a server and click OK.
    • Run interval - enter the interval, in seconds, at which the agent should check for available jobs.
    • Logging level of event details - select Log critical errors only (recommended), Log warnings and errors, or Log all messages.
    • Enabled - select Yes.
  1. Click Save.

Verify the Enable column displays Yes for the Imaging Request and Response agents.

Agents tab

You won't be able to start any imaging jobs in your workspace if this agent becomes disabled. To re-enable a disabled Imaging Request/Response Agent, click Edit on the appropriate agent, set the Enabled field to Yes, and click Save.

Edit agent

Troubleshooting imaging

In the event a user reports missing Image commands (in the Viewer or mass operations menu), or the Imaging Sets Run button is disabled, address the following potential causes:

  • The Imaging application was uninstalled from Relativity Applications
  • The user is a member of a group that doesn't have one or both of the following security permissions granted:
    • Mass Images (Mass Actions permissions)
    • Add Image (Document security permissions)

Image on the fly

By using the Imaging option in the Viewer, you can image a single document on the fly with any imaging profile you have permissions to. For more information, see Imaging on the fly.

Mass image

You can image multiple documents at the same time by using the Mass Image operation in the document list. Select an Imaging Profile to use when imaging a group of documents. For more information on mass imaging, see Mass image.