Processing Console

The Relativity Processing Console is a desktop application that lets you control complex processing jobs on a granular level. The Processing Console offers power processing users to extend the full capabilities of Relativity Processing.

This page contains the following information:

See these related topics:

Processing Console features

The Processing Console includes, but is not limited to the following features:

  • Granular worker and job control – prioritize worker servers into work groups, which you can allocate to work on specific jobs or processing functions.
  • Selective import of data – choose specific folders and files to import for a given custodian, import or exclude specific files by extension, De-NIST documents.
  • Extract text - able to extract text directly from documents, images, or files with embedded images OCR’d automatically.
  • Indexing options - uses the dtSearch as its full-text search engine, automatically indexes all metadata along with extracted text to ensure nothing is overlooked.
  • Filter options - multiple filtering options, including date/time, de-dupe with extremely flexible options, cross reference, expression, and full text.
  • Reporting – create several reports, including de-dupe filter, error, summary, search filter.
  • Generate images – render documents as PDFs without the need for print drivers, significantly improving performance. Imaging jobs are also multi-threaded, and you can monitor worker activities.
  • QC Functionality – preview all images and extracted text - or a random sample - track progress, auto-advance images, and flag them for further review or replacement.
  • Full metadata access – all extracted metadata fields are identified and stored in individual fields for potential use.
  • Robust export options:
    • Numerous filtering options, including date/time, cross reference, expression, and full text.
    • Customize and brand/endorse the images for export.
    • Select metadata fields.
    • Format fields – for example, specify date or date/time for date fields.
    • Variable substitution – for example, specifying the return of a variable in a specific field.
    • Build switch statements – for example, similar to a v-lookup, "when x is found return y".
    • Track status.

Running an RPC job

There are many ways to run a job using the RPC. Below is a typical workflow. Note that you're free to deviate from it as necessary to meet your own needs. Click a step to navigate to a topic.

RPC job workflow

Depending on your needs, you can re-order or skip some of these steps completely. For example, if the filtering you require doesn't include keyword searching, you have the option of skipping indexing. You can also skip extracting text, indexing, and filtering and jump directly to imaging, and you'll still be able to export text. Image generation also creates page-level text by default, which you can export either on a page or document level, as needed.

It's important, however, to know the prerequisite steps for the tasks you intend to perform. The following table breaks down those prerequisites.

Desired RPC task Prerequisite
Extracting text

Imported data

  • Can be done immediately after import
Generating images

Imported data

  • Can be done immediately after import
Indexing data Either text extraction or image generation
Full-text search filtering An indexed import
All other filtering

Imported data

  • Can be done immediately after import
  • No text extraction or imaging is required
Exporting metadata

Imported data

  • Can be done immediately after import
Exporting images or page level text Image generation
Exporting doc level text Either text extraction or image generation
Exporting native files

Imported data

  • Can be done immediately after import
Exporting PDF files Image generation

Special considerations

You can use the RPC in conjunction with Relativity Processing, or as a standalone tool. For example, you might use the Processing Console to monitor and troubleshoot jobs that you kick off from Relativity Processing, or run disparate jobs solely in the Processing Console.

However, consider the following when using the Processing Console in conjunction or disparately from Relativity Processing.

  • The Inventory feature only exists in Processing.
  • The ingestion filtering feature only exists in Processing because Inventory only exists in Processing. However, it is still possible to De-NIST an import or include/exclude specific file extensions from an import job using the Processing Console.
  • You can't direct export to Relativity for review at this time.
  • Reports are different than Relativity Processing reports.
  • You can't cancel a job in the Processing Console.
  • You can use the Processing Console to track a processing job in Processing, however, the Processing Console doesn't capture the following in Relativity:
    • Re-leveling
    • Retrying and/or clearing errors
    • Altering document extracted text
    • Changing the parent/child document relationship
  • Changing the following Processing Console settings on a processing job may cause unexpected behavior in Processing as there may be conflicting settings on the same data sets:
    • Adding store-level settings
    • Adding project-level settings

Logging in to the Processing Console

To provide visibility into who has accessed the Processing Console and for how long, Relativity requires you to provide user authentication to log in to the Processing Console. Any active Relativity user can log in to the Processing Console with their Relativity credentials.

This functionality was introduced in Relativity 9.4.398.62.

To log in, click on your instance of the Processing Console to bring up the login screen, enter your Relativity username, and click Continue.

Username login screen

Enter your password and click Login. If you use RSA authentication to log in to the Processing Console, make sure that the server on which the Processing Console is installed is configured for RSA, or you won't be able to log in.

Note: If you don't see the login screen, or your login attempt(s) fail, go to the machine on which the Processing Console is installed, get the identity server URL, open a browser on the machine where the Processing Console is installed, enter the identity server URL, and attempt to log in again. The identity server URL is case sensitive.

Password login screen

You now have access to all Processing Console functionality.

To log out of the Processing Console, navigate to the File tab and click Logout & Exit.

Logout and Exit button in File tab

Note: Relativity records Processing Console logins and logouts in the user's audit history; however, it doesn't designate those actions as being Processing Console-specific. In this case, you could see duplicate records for "Login" and "Logout" in your audit history, one for Relativity and another for the Processing Console.