Exception and error overview

You may encounter exceptions and errors from time to time while running processing jobs. exceptions and errors can occur during any processing phase, affecting single files or the entire job. This topic provides a high-level overview of the types of exceptions and errors you may encounter and where to find exception and error details in RelativityOne.

For information on resolving processing exceptions, see Processing exception resolution.

Types of processing exceptions and errors

There are two types of processing issues that may affect the outcome of you processing job: file exceptions and job errors.

• File exceptions—affect a single file. Overall, the processing job continues, even if file exceptions exist. File exceptions are resolvable and have a status of Not Resolved in the Files tab. An example of a file exception might is a password-protected file where Relativity cannot find the password. By supplying the password you can retry the exception.
• Job errors—affect the entire processing job and block publishing. You must resolve job errors before you can continue processing.

Exception levels

Discover and publish exceptions are further defined by the exception level, which indicates severity of the issue. Each phase has two exception levels:

• Discover
  • Warning—the job continues; however, metadata may be missing.
  • Error—the job is blocked from completing.
• Publish
  • Warning—the job continues; however, metadata may be missing.
  • Error—the job is blocked from completing.

Processing phases where exceptions and errors may occur

Exceptions and errors can occur during any processing phase, such as Inventory, Discover, and Publish.

• Inventory—all Inventory errors are unresolvable, and you cannot retry them. To address inventory errors, rerun Inventory from the same processing set.
• Discover—the Discover phase covers file discovery and text extraction.
  • Discover—job errors that occur during discovery are unresolvable, and you cannot retry them. You should always address unresolvable discover job errors. Not addressing unresolvable errors may result in missing documents or incomplete metadata in published documents. Address these errors by creating a new processing set (or sets) and rediscovering the data.
  • Text-extraction—job exceptions that are resolvable have an error status of Ready to retry. Retry the error from the same processing set.
• Publish—job exceptions during the publishing phase that are resolvable have an error status of Ready to retry. Retry the error from the same processing set.

Processing exception tabs

Use the Files tab and Job Exceptions tab to view exceptions and errors that occurred during processing. Relativity notifies you of exceptions and errors on the processing set page when the job completes.

Files tab

The Files tab displays a list of all documents within your workspace. The Files tab has two views related specifically to file exceptions and errors:

• Current Files with Exceptions—displays all outstanding exceptions from processing jobs. This is the primary location for workflows like exception retry, ignore, and file replacement.
• All Files with Exceptions—displays a historical report of exceptions from all processing sets, regardless of exception resolution.
  

For more information on the Files tab, see the Files topic.

File exception fields

The Current Files with Exceptions and All Files with Exceptions views display the following fields:

• Details—click this icon to open a dialog containing information on the file properties and exceptions. See Viewing file exception details for more detailed information.
• File ID—the unique identifier assigned to an instance of a file.
• Storage ID—the unique identifier assigned to a file.
  Note: Differentiating between the File ID and the Storage ID. Every file is assigned a unique Storage ID. Every instance of a file is assigned a unique File ID. For example, you may have a Word document with a unique Storage ID. If that document is attached to two different emails, then each instance of the document attachments is assigned a unique File ID. Therefore, a single file with a Storage ID, may have multiple instances, each with their own unique File ID.
• File Name—the original name of the file.
• Exception Level—this field displays the type of exception Relativity encountered. There are two levels:
  • Warning—the job continues; however, metadata may be incomplete.
  • Error—the job is blocked from completing. You must address the error and retry the job.
• Exception Message—displays a message about the exception, along with possible resolution.
• Exception Phase—displays the processing phase in which the exception occurred. Processing phases include Inventory, Discover, and Publish.
• Exception Category—displays the exception category such as a password protected file where Relativity cannot find the password. See the table below the image for a complete list of exception categories.

The following table provides a listing of values for the Exception Category field, along with a description of the issues associated with the exception.

Category name	Description
Corrupt Container	These exceptions are exclusive to container files that have encountered corruption when attempting to open and locate files within the container itself. When containers have these exceptions associated to them, you will not see any extracted loose files. The exceptions are either ignored or downloaded offline for you to investigate whether the corruption is fixable, then subsequently replaced and retried.
Corrupt File	These exceptions are exclusive to non-container files that have found elements of corruption during Processing. The exceptions are either ignored or downloaded offline for you to investigate whether the corruption is fixable, then subsequently replaced and retried.
Could Not Identify	Relativity Processing could not identify the file during discovery. The file may be corrupt, but an exact cause was not known at the time of discovery.
Environmental	Environmental exceptions are a result of issues in the Relativity Processing environment. Retry and resolve these exceptions when encountered.
File Read / Write Error	These exceptions are a subset of Environmental issues specifically caused by file system issues. Retry and resolve these exceptions when encountered.
Missing Attachment	Relativity could not extract an attachment from a document or email from its file.
Missing File Metadata	A file is missing a piece of metadata.
Missing Extracted Text	These exceptions represent issues that occurred during Text Extraction jobs that have caused a file to be missing some or all associated text. Relativity could not identify a root cause. Retry and resolve the exceptions where possible.
Partially Corrupted Container	These exceptions are exclusive to container files that have encountered corruption during extraction of specific records. When containers have these exceptions associated to them, you may see some files extracted, but not all. The exceptions are either ignored or downloaded offline for you to investigate whether the corruption is fixable, then subsequently replaced and retried.
Password Protected Container	These exceptions are exclusive to container files that have encountered some form of password protection or encryption security measures. You must add the password or encryption key to the Password Bank to resolve the exception. For more information, see Password Bank. Note: When investigating publish exceptions, if you see five password protected exceptions associated with an .msg file, but the email and all its contents opens and displays correctly in the viewer, the email had a password-protected container attached.
Password Protected File	These exceptions are exclusive to non-container files that have encountered some form of password protection or encryption security measures. You must add the password or encryption key to the Password Bank to resolve the exception. For more information, see Password Bank.
Relativity Field Configuration	These exceptions represent issues with Field Mapping during publish jobs. They are usually associated to a specific setting like length or an Associative Object Type. Resolve the field settings exceptions according to the exception message.
Unsupported	Relativity Processing cannot obtain metadata or text from unsupported files. You can publish the files to your workspace, but they may not be accessible from the viewer.

• Exception Status—provides information on where the file is in exception remediation. The exception status value helps in determining if you need to take action on a file, or to see if the file had previous exceptions. When a file has all its exceptions resolved, the Exception Message, Exception Category, and Exception Phase fields no longer display any content. However, the Exception Status field displays Resolved to indicate that the file had issues that are now resolved. Exception status values include:
  • Not Resolved—the exception is still outstanding.
  • Resolving—the exception is in the process of being retried.
  • Resolved—exception resolved.
  • Ignored—exception ignored.
  Note: In some cases, the Exception Status field on the Files tab may not be in sync with the Exception Status field on the Documents tab. The mismatch occurs when you resolve an exception but do not republish the file. For example, after discovery, you notice a file exception due to a missing password. The Exception Status fields on the Files and Documents tabs show the same Exception Status. At some point, you fix the password and retry the exception. The exception status on the Files tab now shows resolved, while the Documents tab still shows an exception. Republishing syncs the fields once again.

Viewing file exception details

You can view file details by clicking the Show details for this file icon ( .) Details include file data, file metadata, and content metadata.

Click the Processing Exceptions tab to view a summary of errors, and the error history.

• The Exception History section represents all exceptions> that have ever occurred on a file. This acts as a timeline of the record’s exceptions, showing when they occurred, what they were about, and if any are still active. This includes exceptions resulting from retries of previous exceptions and contains category, phase, date/time, and message information. All times are kept in UTC format.

• The Exception Summary section displays a count of all active exceptions along with their associated category and phase. This is especially important when investigating exceptions> relating to container files, as there can be many associated to the parent container during file extraction. This helps determine the level of impact the issue has as it may affect many files originating from it.

Job Errors tab

The Job Errors tab displays a list of job errors that occurred on processing sets run in your workspace. These errors are usually not associated with any specific files within a processing set, but rather the entire set itself. The Job Errors tab has two views:

• Current Job Errors—displays all unresolved job errors.
• All Job Errors—displays job errors that occurred throughout the lifecycle of the matter.

Job error fields

The Current Job Errors and All Job Errors views display the following fields:

• Error Identifier—the unique identifier of the error as it occurs in the database. When you click this message, you are taken to the error details layout, where you can view the stack trace for detailed error information. Note that for Unresolvable , the console is disabled because you cannot take any actions on that error from inside Relativity.
• Error Status—provides the status of the error.
  
• The most common error status values include:
  • Unresolvable—errors that you cannot retry.
  • Ready to Retry—resolvable errors that you can retry.
  • Retried—errors that have been retried and are unresolvable.
  • In Progress—the error is currently being retried.
• Message—displays an overview of the error.
  
• Custodian—the custodian associated with the data source containing the file on which the error occurred.
• Processing Set—the name of the processing set in which the error occurred.
• Data Source—the data source containing the file on which the error occurred.
• Error Created On—the date and time at which the error occurred during the processing job.
• Republish Required—the error must be retried in order to be successfully published.
• Notes—any manually added notes associated with the error.

Viewing job error details

Click the Error Identifier to open the Job Error Details dialog.

Note that the Error Actions console is not available for unresolvable job , since you cannot retry or ignore job as you can with document .

To see the job error stack trace, click the Advanced tab. Here, you can parse through even more detailed information about the error, including timestamps, messages, and error phase.

Viewing exceptions from a processing set

From within your processing set, use the links in the Process Files console to view job exceptions and file exceptions. Click the Job Errors link to open the Job Errors tab > Current Job Errors view. Click the File Exceptions link to open the Files tab > Current Files with Exceptions view.

Retrying exceptions after making changes to the processing profile

When you retry exceptions, Relativity attempts to reprocess exceptioned files using the processing profile settings associated with the processing set. If you change a field setting in the processing profile and then retry exceptions, some changes will be respected (or recognized,) and some will not. In other words, after changing the processing profile, Relativity uses the new settings for some fields during retry and ignores new settings for others. In the table below, fields marked Yes are fields where changes override the original setting. Fields marked No are fields where the original setting precedes any changes.

Front-End Setting	Respected on retry?
Inventory | Discover Settings
DeNIST and DeNIST Mode	Yes
Default OCR languages	No
Default time zone	No
Include/Exclude and Inclusion/Exclusion	Yes
Mode	Yes
File Extensions	Yes
Extraction Settings
Extract children	No
When extracting children, do not extract	No
Roll up image text	No
Email Output	Yes
Excel Text Extraction Method	Yes
Excel Header/Footer Extraction	Yes
PowerPoint Text Extraction Method	Yes
Word Text Extraction Method	Yes
OCR	Yes
OCR Accuracy	Yes
OCR Text Separator	Yes
Short Message Conversion Settings
Slice by	Yes
Slack	Yes
Download attachments	Yes
Teams	Yes

Required security permissions

The following security permissions are required to perform actions on file errors:

Object Security	Tab Visibility
Discovered File - View, Edit Download and Replace files with processing errors	Processing Files

For more information on permissions, see Workspace permissions.