Upgrade considerations for Relativity Server 2021

This page explains some of the key changes in Relativity Server 2021 that you should be aware of before upgrading.

In order to upgrade to or install Relativity 9.5 or above, you MUST complete new pre-installation steps. You now need to install Service Bus for Windows Service 1.1 BEFORE installing or upgrading to Relativity 9.5 or above.For more information, see Pre-installation.

Note: You must install and configure the Relativity Secret Store before installing any other Relativity Server 2021 components. For more information, see Relativity Secret Store.

Refer to this page to learn more about changes in your environment from a previous version of Relativity 9.x or 10.x to Relativity Server 2021.

Note: If you are upgrading from a 6.x, 7.x, or 8.x version of Relativity, please contact your Customer Success Manager.

In the following table, click on any column heading to sort the column in alphanumeric order:

Version Feature Upgrade consideration
Version Feature Upgrade consideration
Server 2021 Mass PDF In Server 2021, we introduced a new optional PDF application that you can use to replace the Save as PDF functionally that comes out of the box in Relativity: Save as PDF mass operation and the Save as PDF on-the-fly operations on the Viewer. This new application includes the following benefits:
  • Is an agent-based based application. This resolves many of the stability, performance, and scalability limitations of the Save as PDF functionality that comes out of the box in Relativity Sever 2021.
  • By having its own agents, it has dedicated resources. The previous version shared resources with Imaging and Processing. This eliminates the problem of having PDF jobs queued behind a Processing or Imaging job. For more information on the new PDF agents, see What's new in the infrastructure.
  • Maximum supported mass PDF jobs size is now 10,000 documents or 1,000,000 images.
  • If a single document errors during a mass PDF jobs, the new application will skip that document and work on the next one. In the previous version, that job would had failed.
  • It has new features such as a new PDF profile, a new progress and status bar, error reports, enhancement to production order, and new naming and content options.


  • PDFs created from the viewer are named with a unique ID instead of the document control number.
  • The options defined on the PDF profile cannot be modified from the Mass Operation or from the Viewer.
  • If you install this application, the Save as PDF mass operation is not available in the related items pane in the Review Interface.
  • To uninstall the new PDF application on Sever 2021, you must contact Relativity Support.
  • You cannot use mass operations on Data Grid-enabled fields.
  • PDF does not integrate with the Password bank. If you try to convert a native document that is password protected, an error occurs.
Server 2021 Analytics In Server 2021, the Analytics Engine's new postgres version will fail to upgrade when the single-data-dir.properties file is a UNC path. To complete the upgrade, temporarily change the SDD to a mapped drive (e.g. caat.single.data.directory=D:/ContentAnalyst). Once the upgrade completes, you can revert the SDD to the original UNC path.
Server 2021 Analytics

In Relativity Server 2021, the PostgreSQL database used by Analytics is upgraded to version 12.5. During the CAAT upgrade, a new process updates the PostgreSQL data, which necessitates new installation requirements and introduces new properties in the response-file.properties file. Review the following upgrade guidelines:

  • Verify that you have the Microsoft Visual C++ version (Redistributable x86 and x64) for 2010, 2012, 2013, and 2015. For more information, see Analytics server setup.
  • Verify that the Users group has Full Control permissions on the install and data directories.
  • Verify that you have adequate disk space for the upgrade. A new pgsql folder is created as part of the upgrade, which temporarily doubles the disk usage while both versions of Postgres are installed on the server.
  • Optionally, set the new caat.pg.upgrade-in-place and caat.overrideDiskSpaceCheck properties in the response-file.properties file.

    Note: Thoroughly review the guidelines for these new properties before modifying their default values. For more information, see Upgrading to Relativity Server 2021 from Relativity 9.3.362.9 (CAAT 3.19) and above.

Server 2021 Agents

The following agents were added in Relativity Server 2021.

  • Conversion Agent - Convert Ahead* - works with the service bus to complete document conversion when the user is on the document viewer. Deploy each Conversion agent on its own server. Don't use the server for any other purpose but running this agent.
  • Conversion Agent - Mass Convert* - works with the service bus to complete document conversion when using the mass convert action. Deploy each Conversion agent on its own server. Don't use the server for any other purpose but running this agent.
  • Conversion Agent - On the Fly* - works with the service bus to complete document conversion for the current document opening. Deploy each Conversion agent – On the fly on its own server. Don't use the server for any other purpose but running this agent.
  • * these conversion agents are optional, the previous conversion agent has not been deprecated.
  • * you do not need a dedicated conversion agent server for each conversion agent, you only need one for all three.
Server 2021 Instance settings

The following instance settings were added in Relativity Server 2021.

  • UseAgentBasedConversion - change the value to true to use conversion agents on cloud instance.
  • ConversionOnTheFlyThreadCounts - the maximum amount of threads that a Conversion Agent - On the Fly will use on its agent server.
  • ConversionConvertAheadThreadCounts - the maximum amount of threads that a Conversion Agent - Convert Ahead will use on its agent server.
  • ConversionMassConvertThreadCounts - the maximum amount of threads that a Conversion Agent - Mass Convert will use on its agent server.
Server 2021 Legal Hold The Project object uses Relativity Forms by default.
Server 2021 ECA and Investigation The ECA and Investigation application has been deprecated and is no longer available for Server customers.
Server 2021 Processing/Invariant

Starting in Server 2021, Invariant requires worker server installation on each worker to function properly. This ensures workers have the appropriate Microsoft Visual C++ 2019 redistributables necessary.

When installing the RPC, the username must be EDDSDBO for Relativity Servercustomers.

Server 2021 Relativity mobile platform The Relativity mobile application is being deprecated and will be removed from the Apple App Store. Beginning with Server 2021, all instances and versions of Relativity Server will no longer be able to log in and gain access on the mobile application.
Server 2021 Imaging Imaging no longer requires the Relativity Application - View object security permission.
Relativity Server Relativity mobile platform The Relativity mobile application is being deprecated and will be removed from the Apple App Store. Starting January 1, 2020 all instances and versions of Relativity Server will no longer be able to log in and gain access on the mobile application. Relativity Desktop Client In the web.config file for the Relativity.Distributed site, the value for the executionTimeout setting is now updated to 20 minutes. During upgrade, the current value for this setting will be overwritten, and set to the new value of 20 minutes. Analytics

Entities with the same first and last name values are automatically merged instead of being created with a number suffix, e.g. Doe, John (1). Analytics Entities identified by name normalization are automatically merged with those created by Legal Hold, Processing, or Case Dynamics when their first and last name values match.

Imaging The Print / Save as PDF permission on the Document object is now called Create PDF.


The following instance setting was added in Relativity

  • NativeImagingTimeout - the amount of time, in seconds, that the native imaging process waits for a single document to be imaged before killing the export process and moving to the next document.

  • The processing profile now includes a new text extraction failover method for Excel, Word, and PowerPoint files. When you select the new Native (failover to dtSearch) method, Relativity uses the native program to extract text from the file with dtSearch as a backup text extraction method if the native program fails. Analytics To allow other applications to make use of the Entity object, the Entity classification Communicator has been updated to Communicator - Analytics. Entities created or impacted by name normalization now receive the Communicator - Analytics classification.
Blazingstar Analytics Accessing the Analytics Engine directly instead of through the Analytics APIs will result in error or unreliable results. Directly accessing the Analytics Engine has long been prohibited, but beginning in this release will result in errors.
Blazingstar Data Grid

Lucene search has been deprecated. You can use dtSearch to search on long text fields stored in Data Grid.

Blazingstar Processing/Invariant

Note the following details regarding our support of Office 2016:

  • You must install a version no earlier than 16.0.4783.1000 (the December 2018 update for Microsoft Office).
  • We recommend that you upgrade Invariant prior to upgrading Microsoft Office. If you upgrade Microsoft Office first, your workers will fail to validate, and Invariant won't run until you upgrade it.
  • We recommend that you uninstall Microsoft Office 2013 before installing Office 2016.
  • OneNote 2016 can't export files containing more than 300 pages to PDF. Processing extracted text will fail in this case, as well.
  • With the introduction of Office 2016 support, the font used to image text files is now Google's Noto Sans; previously, this was Microsoft's Arial Unicode.
  • Click-to-Run installations of Office are not supported due to issues caused by registry differences between the Windows Installer (MSI) version and Click-To-Run version which causes images to not show up.
  • The new LongRunningRetryJobTimeout setting in the AppSettings table controls the amount of time (in milliseconds) to run a non-publish retry job before the worker terminates the worker process. If blank, the value used will be equal to LongRunningJobTimeout setting.
  • The new SkipDocumentAuditDuringPublish instance setting allows you to choose whether the document Created and Native Created events are recorded in the Document History. Setting this value to True will prevent these events from being recorded and will boost your publish performance.
  • The default value for the ProcessingExportBatchSize instance setting is now 4000 as a result of improved publish performance.
  • The new UseExtractedTextPathOnlyforPublish instance setting lets you control whether extracted text is included as a path or as plain text. Including the text as a path will boost your publish performance.
  • The new LongRunningTimeoutForPublish instance setting lets you to determine the amount of time you want to allow before a worker terminates an unresponsive publish job.
  • The new LongRunningTimeoutForRetryPublish instance setting lets you determine the amount of time you want to allow before a worker terminates an unresponsive publish retry job. Relativity service bus The Relativity 10.1.xxx.x infrastructure now includes RabbitMQ. RabbitMQ is the most widely deployed open source message broker, with more than 35,000 production deployments. Additionally, RabbitMQ is fully supported on the latest Windows and Linux operating systems, features full support for TLS 1.2, and includes superior monitoring, administration, and performance capabilities. System requirements

SQL 2017 will be support in Relativity 10.1.xxx.x. System requirements Microsoft Visual C++ 2017 isn't compatible with versions below 10.2 of the Relativity Installer. If Microsoft Visual C++ 2017 is installed, uninstall and re-install Microsoft Visual C++ 2015. Instance settings Starting in 10.0, the instance setting Relativity Instance URL is used for more functionality than in previous versions. Ensure that the link/URL in the instance setting is set and correct. Instance settings Starting in 10.1, the instance setting DefaultUseRelativityFormsValue is used to enable or disable the rendering of Relativity Dynamic Object pages in a modern architecture.
10.0.318.5 Imaging

The Relativity.Productions.Domain.Toggles.BrandingOverlayToggle is a new toggle that defines whether the branding agents wrap text and affects the entire Relativity instance. By default, the toggle is set to on, so text wraps by default if the content of two adjacent footers or headers are likely to overlap with each other. To keep text from wrapping, add the toggle to the Toggle table in the Admin (EDDS) database with the values listed below.

  • Name = Relativity.Productions.Domain.Toggles.BrandingOverlayToggle
  • IsEnabled = 0
10.0.318.5 Analytics Relativity no longer supports structured analytics sets that were created in Relativity versions earlier than 8.2 and where the repopulation of data (full analysis) has not been performed in a later version (≥8.2). Dropped support is due to legacy staging areas being stored on disk rather than in our PostgreSQL database. To update these sets, re-run Structured Analytics after upgrade with Update: All Documents and Repopulate Text selected, which will create the staging area in PostgreSQL and produce new supported results.
10.0.318.5 Custodian object rename

The rename of the Custodian object to the Entity object may have an impact on previously developed custom applications and features that were dependent on the Custodian object. You should review the following areas to ensure compatibility with the new Entity object:

  • Any custom application which leverages the Custodian object by name and not by GUID.
  • Any script that references the Custodian object.
  • Any workspace with an Entity or Alias object. These objects will conflict with the introduction of Entity and Alias.
  • Custom workflows that reference the Custodian object, or database table, by name.

Scripts are available to help you detect a number of potential conflicts due to this change. You can find the scripts and more information about potential conflicts on the Relativity Community.

10.0.318.5 Processing/Invariant
  • Lotus Notes is no longer required and is now an optional installation.
  • The JungUm Global Viewer is no longer required and is now an optional installation.
10.0.318.5 System Requirments The Service Bus certificate needs to be in the trusted and private root on the Analytics server. Imaging The Imaging Manager agent was added in Relativity It 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. You need at least one agent per environment. Imaging The OCR Set Manager agent has been modified in Relativity You now need at least one agent per resource pool, and the OCR Set Manager now recovers orphaned OCR jobs from dead agent servers. Production

The following instance settings are new in Relativity

  • BrandingManagerTimoutCount - The number of times branding managers can timed out for a single production before all incomplete branding jobs are marked as errored. Set to 0 to disable.
  • StuckBrandingManagerTimeout - The amount of time, in seconds, that must elapsed from the last message sent by a branding manager until it times out. Set to 0 to disable. Processing/Invariant
  • Support for .NET Version 3.5 on the worker was deprecated in Relativity
  • Support for the Solidworks eDrawings Viewer 2016 was deprecated in Relativity
  • Support for the Solidworks eDrawings Viewer 2018 was introduced in Relativity Searching

The <All Documents in Workspace> Searchable Set selection is no longer available to select when building a new dtSearch index. Processing/Invariant

The following instance setting is new in Relativity

HideProcessTranscriptMassOperation - this setting controls the default visibility of the Process Transcripts mass operation. If set to True, the Process Transcripts option will be hidden by default in the Mass Operations menu. Processing/Invariant

The following instance settings were modified in Relativity

  • The default value of the ProcessingMaxPublishSubJobCountPerWorkspace setting has changed from 3 to 5.
  • The default value of the EnablePublishErrorAutoRetry setting has changed from False to True. Secret Store Beginning with Relativity, the Secret Store is a required component. It provides secure auditable storage for Relativity secrets. It is recommended to install the secret store on a dedicated server. In the initial release of Relativity, the Secret Store is used only for installing and upgrading the system. For more information, see Relativity Secret Store. Secret Store Beginning in, all Relativity secrets are migrated to the Secret Store. For more information, see Relativity Secret Store. Secret Store Secret Store 1.0.314.5 is now available. Relativity requires that you upgrade your installation of Secret Store to this version. For more information, see Secret Store.
All upgrades Agent service All Windows services now have Recovery Properties. If the Agent service should ever crash due to an unhandled exception, it recovers and immediately restarts. Analytics

If you're upgrading to Relativity Server 2021 from a version earlier than 9.2, note that the Textual Near Duplicate Identification algorithm is in place with the following benefits:

  • The new algorithm greatly improved performance for both large and complex data sets.
  • With the new algorithm you can scale your Analytics server by adding CPU cores and RAM in order to achieve faster performance.

Prior to Relativity 9.2, scaling environments did not impact performance. Without scaling past eight cores, you should experience performance comparable to pre-Relativity 9.2 on most data sets. The Textual Near Duplicate Identification algorithm in Relativity 9.2 uses different, more efficient methods to obtain similar results. However, results may differ slightly from pre-Relativity 9.2 results if a Full Analysis is run against a preexisting structured analytics set. If you need preexisting results use an Incremental Analysis instead. The incremental analysis keeps the pre-Relativity 9.2 results for all preexisting documents, but the newly added documents use the new algorithm to match with existing groups.

9.3.376.35 Analytics You must update the default SSL/TLS certificate on your Analytics server because Relativity requires a certificate signed by a trusted certificate authority (CA). By default, the CAAT service runs over an untrusted SSL/TLS certificate. For more information, see Updating the default SSL/TLS. Analytics As part of upgrading (post-upgrade), you must have a valid URL value entered for the UriForCAAT instance setting. This is the FQDN URL to the web server hosting your Kepler services (e.g., https://client.domain.name/Relativity.REST/API). Analytics

Starting with Relativity, the Relativity Analytics engine installer now uses a response file to install Analytics on a server. You can use the installer for new installations and upgrades. The response file installer replaces the setup wizard for the Analytics server. See Installing / Upgrading Relativity Analytics.

Note: If you are upgrading from Relativity 9.3.332.21 (CAAT 3.17) or lower, contact Support. Analytics Starting with Relativity, Analytics indexes are now RDO's. Analytics

You will no longer get shell indexes when importing an application that contains saved searches with Analytics search index conditions. Instead, the saved search will have the analytics condition stripped from it. A new index can be created, and a new condition can be manually associated with the saved search. Analytics

Starting with Relativity, Analytics indexes are now RDO's. Indexes will no longer have the default saved searches available to set as the training and searchable set sources. For legacy indexes that are upgraded, the saved search must be set when editing the index. If you do not set the searches, you will only be able to build and activate / deactivate the index (provided it was already populated with the default searches). Analytics

Starting with Relativity, Analytics indexes are now RDO's. After the upgrade, you will no longer have the option to preserve cluster multiple choice and coherence score fields when deleting the cluster set. They will always be deleted. Analytics OCR and Go Word filter support has been deprecated from Analytics Indexes. On subsequent populations after upgrading, any OCR or Go Word filter set on the Analytics profile will no longer be applied. If the legacy index was populated with these filters, migrated to an RDO, and then rebuilt or activated, the filters still apply (they are set on population). Analytics When you upgrade, the Analytics Core install event handlers will create a new RDO for each existing index and a new RDO for each existing cluster set. These new object types and instances inherits permissions from their analogous source objects. For example: Analytics Index RDO workspace permissions are copied from Search Index workspace permissions. Analytics Analytics Index RDO instance permissions are copied from Search Index instance permissions. Analytics Cluster Set RDO workspace permissions are copied from Search Index workspace permissions. Analytics Cluster Set RDO instance permissions are copied from the multiple choice cluster field's item level permissions. Analytics Users must have the Analytics application installed in the workspace, and the Email Author Date ID must be present for the emails. The Email Author Date ID is only available for emails run through a full analysis using structured analytics in. The email thread visualization pane will not work for email threads from previous versions unless a full analysis is run against the structured analytics set containing the emails after upgrading to Relativity or higher. Analytics Beginning in Relativity, you can easily store the results for multiple structured analytics sets and set up views that capture the email threading or repeated content identification results of those operations. We recommend you set new relational fields (e.g., Destination Email Thread Group, Destination Email Duplicate ID, and Destination Textual Near Duplicate Group) when creating new structured analytics sets for email threading or textual near duplicate identification to allow you to easily set up views that make use of a relational field for each of these sets. Analytics

Upon upgrade, email threading and textual near duplicate results are written to new results fields that is only created upon running a Structured Analytics Set. These fields can't be manually created before running the set. This means that it's not possible to create any views, searches, layouts, etc. that reference these fields prior to completing a set. Additionally, views and searches which reference these newly created fields don't carry over on workspace creation because Structured Analytics Sets don't carry over.

Note: This upgrade consideration impacts any Relativity templates that reference the legacy Structured Analytics results fields. Analytics Upon upgrade, previous inclusive information may change when performing an incremental analysis on an existing email threading set due to the newly created structured Analytics results fields.
All upgrades Applications The Solution Snapshot application helps you identify compatibility issues with custom applications in your environment so you can resolve them prior to upgrade. Using the Solution Snapshot application, you can view a list of the applications currently installed in your Application Library and review the application owner's recommendation for upgrade. For more information, see the Solution Snapshot documentation. Audit

Upon upgrade to Relativity, the Audit application is now available at the instance level to report on admin-level audits. You must have Elasticsearch installed and configured to use the Audit tab. If you don't have Elasticsearch installed, you can hide this tab. For more information, see Audit.

9.5.342.116 Audit

Relativity includes a change to the Audit template. Before upgrading to Relativity 9.5.342.116, you must edit the ESIndexCreationSettings instance setting with the new Audit template and incorporate any of your customized settings.

9.3.452.1 Authentication You no longer see the Authentication Data field in the Users User Information section. You now enter the information you previously entered here in the individual authentication methods. This permits more versatile and detailed method implementations.
9.3.452.1 Authentication Note that when you upgrade, Relativity creates a copy of the eddsdbo.User table before making any modifications. The table is for reference only, and the copy is named based on the Relativity version being ungraded from, such as 9_2_AuthenticationUserTableBackupRecord or 9_3_AuthenticationUserTableBackupRecord. If after upgrading and making sure all users converted successfully, you may delete the copy table.
9.3.452.1 Authentication Use the Authentication Profile system to enable only the protocols you need in an environment. In some cases the upgrade process may enable more protocols than you want. This is due to the parsing rules for the AuthenticationData column. Specifically, if you are using Active Directory or Client Certificate authentications in your environment, the upgrade process may also enable Integrated Authentication. If you don't want the Integrated Authentication, you can remove that provider from the Authentication Profile after upgrade.
9.3.452.1 Authentication

A number of new objects have been introduced, such as Authentication Provider Type, Authentication Provider, and Login Method. Upon upgrading to Relativity Server 2021, permissions are as follows:

  • A user, who has the permissions to view the user objects before an upgrade, post upgrade can view users, authentication provider types, authentication providers, and login methods.
  • A user, who has the permissions to edit (or delete, a higher level of permission than edit) the user objects before an upgrade, post upgrade can edit users and login methods. They can also view authentication provider types, and authentication providers. -After upgrade only users in the System Administrators group will have access to view and edit OAuth2Client objects. Conversion Conversion occurs on dedicated conversion agents instead of Invariant workers. You must configure conversion agents to ensure document conversion works properly in Relativity. Your agent servers should also have one conversion complete agent. For more information, see Configuring your conversion agents.
9.5.370.136 Conversion Complete Conversion Agent: Writes to cache documents converted by the Conversion Agent and notifies the Relativity front end when conversion jobs are ready. This agent is created after a new Relativity installation. Upon upgrade, you must create the agent manually. We do not recommend putting this agent on the Conversion Agent server, as that server should be dedicated to the Conversion Agent, not the Conversion Complete Agent. Data Grid If your environment uses Data Grid, you must also upgrade to Data Grid or above when upgrading to Relativity Server 2021. For more information, see Upgrading Data Grid. Data Grid Relativity 9.5 introduces the Data Grid Ingestion Management tab to manually retry or cancel Data Grid write requests that failed as a result of infrastructure problems. This feature includes a new agent, the Data Grid Worker Agent, that must be installed and configured upon upgrade. There is also a new instance setting, IngestionTemporaryFileCacheLocation. Data Grid You no longer need to install the DataGridRESTService on the Analytics server to integrate Relativity Analytics with Relativity Data Grid. If you are upgrading to Relativity Server 2021, uninstall the DataGridRESTService from your Analytics server(s). For more information, see Uninstalling the Data Grid service. We also recommend uninstalling the client node from the Analytics server if that server is only dedicated to Analytics in order to free up resources. Data Grid The Instance Settings table and corresponding Relativity tab now includes the AuditDeleteBatch Size and AuditMigrateBatchSize instance settings to specify deletion and migration batch sizes for Data Grid for Audit.
All upgrades Database schema A number of EDDS and Workspace database tables have been changed, added, or removed to accommodate new functionality in Relativity. For more information, see Database schema updates for Relativity Server 2021 in the Relativity Community. Database schema

We have now deprecated the EDDSResource database. Any custom code that writes to the EDDSResource database is subject to breaking changes in future releases. If you have implemented any custom code that writes to the EDDSResource database, update it as soon possible to ensure proper functionality of your applications. Tables formerly created in this database are now added to the workspace database associated with a specific operation under the new [Resource] schema. The EDDS and all case databases now include this new [Resource] schema. It is used for short-lived scratch tables that used to exist on the EDDSResource database. Additionally, table names haven't been modified.

Note: Mass Operation handlers that reference tables in this database won't function properly. You need to update these handlers to reference the new location under the workspace database with the [Resource] schema qualifier. ECA and Investigation

The ECA and Investigation and Field Catalog applications are now synchronized, which means that when you install the ECA and Investigation application, Relativity automatically maps all of the ECA fields to those 127 corresponding processing fields found in the Field Catalog. For a list of these fields, see Mapping processing fields. Note the following details:

  • A number of processing fields were renamed in the Field Catalog. Renamed fields will cause naming conflicts. You can address these conflicts through the standard application framework, which is to either rename the fields or modify their mapping. If you previously processed data into a field that was renamed, you will have the same data in two different fields. You can address this through a Mass Replace operation on the affected fields.
  • The All Custodians field was renamed to All Custodians_Script in the ECA and Investigation application. The All Custodians_Script field is a long text field and acts as a another piece of metadata for de-duplicated documents. You should select the new All Custodians_Script field when running the Update Duplicate Status script, as this will ensure that no de-duplicated documents make it into review. Fields For any existing fields with the Allow HTML value set to Yes, you must set the new instance setting SanitizeHTMLOutputSanitizeHTMLOutput to False in order to add HTML alerts and links when a user opens a document for review. File share Beginning in Relativity, file share choices are now file share resource server objects. Upon upgrade, all file share choices are mapped to resource servers. For more information, see Fileshare. Foreign key removal

In order to improve the performance and usability of document deletion in Relativity, we've removed the foreign keys from the Document and non-system RDO database tables. This includes artifact, single object, and multi-object table relationships. Doing this resolves the previous issues involved with globally locking the Artifact and other tables for the entire duration of a deletion job, which could be lengthy and could subsequently delay document review. As a result of removing these foreign keys, the delete process will execute without applying a global lock, and thus no longer interrupts document review in Relativity. There are three classifications of foreign keys, all of which are affected by this change:

  • Keys from the object (Document or RDO) table to the Artifact table.
  • Keys on the object table that go to a single object field.
  • Keys on multi-object relational f-tables. An f-table stores the link between the objects that are connected by a multi-object field in Relativity. In this way, the only columns in an f-table are those that store the Artifact ID's of the objects that are linked to each other by that field.

Note: System objects aren't subject to foreign key removal. If the Document object has a foreign key to the Folder object, that foreign key will remain because Folder is a system object.

9.4.378.21 IIS Relativity Web servers no longer require the HTMLArea Application/Virtual Directory. You can safely remove the HTMLArea application/virtual directory from IIS on all web servers after the upgrade is complete.
9.4.378.21 IIS When running Relativity on IIS 7.5 and older, the SignalR protocol may exhibit performance issues, including slow responses and connection failures as it falls back to other supported connection protocols. To resolve this issue, disable dynamic content compression for the Relativity.REST application in the Compression section in IIS. For more information, see Upgrading your web server.
9.5.370.136 Imaging The Imaging Response Agent is required to run any imaging job in your environment. This agent is responsible for properly picking up imagine set, mass imaging and image-on-the-fly messages from Service Bus (as published by the workers) and directing them to the proper finalization logic in Relativity. For initial installations of Relativity 9.5.370.136, an Imaging Response Agent is automatically installed and enabled in your environment. If you're upgrading to Relativity or if at any point you need to install an additional agent, you need to do so manually. For details, see Installing imaging agents.
9.5.342.116 Imaging Beginning in Relativity 9.5.342.116, the Imaging Request Agent is required to run any imaging job in your environment. This agent is responsible for performing background tasks when any imaging request is submitted via mass imaging, image on the fly, or imaging set. For initial installations of Relativity 9.5.342.116, an Imaging Request Agent is automatically installed and enabled in your environment. If you're upgrading to Relativity 9.5.342.116 or if at any point you need to install an additional agent, you need to do so manually. For more information, see Installing imaging agents. Imaging

Existing imaging profiles received the following updates based on their imaging method when upgrading to Relativity 9.6:

If your environment is set up for native imaging, the following changes occur upon upgrade: -Relativity renames the default imaging profile to Native Default.

  • The imaging method is set to Native for all current imaging profiles including Native Default.
  • Relativity creates a new basic default imaging profile with the following settings:    
    • Imaging Method: Basic    
    • Basic Image Output Quality (DPI): 300    
    • Basic Image Format: TIFF    
    • Basic Image Height: Original Setting

For any imaging set with an imaging method set to Basic, the following changes occur:

  • The imaging profile previously linked to the imaging set is copied.
  • Relativity sets the imaging method for the copied profile to Basic.
  • The copied basic imaging profile is linked to the imaging set and Basic is prepended to the profile name.

If your environment is not set up for native imaging, the following changes occur upon upgrade to Relativity 9.6:

  • Relativity renames the default imaging profile to Basic Default.
  • The imaging method is set to basic for all current imaging profiles including Basic Default.
All upgrades Database server

A certificate called RelativityIdentityCertificate is added to the EDDS database on your primary database during a first time installation or an upgrade. The authentication framework uses the thumbprint of the certificate to sign identity tokens, which are JSON web tokens (JWTs). The IdentityCertificateThumbprint instance setting stores the thumbprint associated with your certificate. For more information, see Instance settings' descriptions.

You also have the option to use your own authentication token-signing certificate. For information about the instance setting process, see Optionally configure an authentication token-signing certificate.

For a clustered environment, you need to export a copy of your RelativityIdentityCertificate from the primary database server, and install the certificate to each database server hosting the EDDS. See the following instructions for more information:

  • Import or export certificates and private keys on the Microsoft Windows website.
  • Optionally configure an authentication token-signing certificate - These instructions describe the process for configuring your own custom token-signing certificate, but you can follow these basic steps to install RelativityIdentityCertificate to each database server in a distributed environment. Instance settings

If upgrading to Relativity Server 2021 from a version prior to 9.3, note that configuration table values are now referred to as instance settings. Upon upgrade, configuration table values convert to instance settings. Likewise, the eddsdbo.Configuration table becomes the eddsdbo.InstanceSetting table in SQL Server.

Note: If a new Server 2021 install or upgrade fails, a back up table, edds.Configuration_backup, exists as a record of all the instance settings in SQL. Do not use this table for any purpose other than a record in the event of an install/upgrade failure.

Backwards compatibility

For any existing applications that reference the pre-Server 2021 EDDS.Configuration table, a SQL view, Configuration, exists to act as a layer on top of the Instance Setting table. This view contains the same columns as the old Configuration table and you can use it to examine the information as it was pre-Relativity Server 2021. Processing/Invariant Support for .NET Version 3.5 on the worker was deprecated in Relativity Processing/Invariant Support for Solidworks 2016 was deprecated in Relativity Relativity Processing/Invariant Support for Solidworks 2018 was introduced in Relativity Relativity Processing/Invariant The configured value for the previously deprecated ProcessingExportMaxThreads instance setting has been migrated to the new ProcessingDedupeOverlayMaxThreads instance setting. This means that, when you upgrade to Relativity, if you had the ProcessingExportMaxThreads instance setting in your environment, it is preserved and displayed as ProcessingDedupeOverlayMaxThreads. If you didn't have the ProcessingExportMaxThreads setting, you won't see the ProcessingDedupeOverlayMaxThreads setting. Processing/Invariant The new EnablePublishErrorAutoRetry instance setting determines whether Processing publishing will automatically reduce the number of threads in use. This only occurs in deadlock or timeout scenarios during publish. Setting the value to True can impact publish performance. The recommended value is False. Processing/Invariant

Beginning in, the Invariant queue manager requires the Secret Store to be accessible and unsealed in order to run. Accordingly, you should note the following considerations prior to installation or upgrade:

  • Before running the Invariant installer, you are required to first whitelist and then register any processing-related machines for the Secret Store so that those machines can read and write to and from the store. This includes the Invariant queue manager, all workers, and all machines on which the RPC is installed. See Secret Store for more information on configuring servers for the Secret Store.
  • Once you register all servers, the Invariant installer automatically redacts all username and password values you enter into the Invariant response file and then populates those values in the Secret Store. This is the final step of the installation process.
  • If the server on which the Secret Store is installed gets restarted, you'll need to unseal the Secret Store before you run any processing job or run the Invariant installer.
  • Upgrading to from an earlier version requires you to run the Invariant installer on your worker machines one time.
9.5.411.4 Processing/Invariant To improve performance of worker processes, the default value of the LongRunningJobTimeout entry in the AppSettings table is now 180,000 milliseconds (30 minutes).
9.5.342.116 Processing/Invariant Beginning in Relativity 9.5.342.116, ICS/VCF files are deduplicated not as emails but as loose files based on the SHA256 hash. Since the system now considers these loose files, Relativity is no longer capturing the email-specific metadata that it used to get as a result of ICS/VCF files going through the system's email handler. For a detailed list of all the metadata values populated for ICS and VCF files, see ICS and VCF file considerations.
9.5.309.48 Processing/Invariant

Beginning in Relativity 9.5.309.48, the database installation component has been removed from the Invariant installer. Accordingly, note the following considerations:

  • There is no longer a database install log, and all of the log files that used to be found there are now found in the queue manager log file.
  • The queue manager installation is now responsible for creating the database.
  • The queue manager now communicates with the database upgrader to update all databases during an Invariant upgrade.
  • The database directory that was deployed during the installation is no longer needed, so there will no longer be a database directory deployed on the database server.
  • The database component no longer holds registry entries; all registry entries that aren't duplicates are now on the queue manager machine.
  • If you previously installed the Invariant database component on its own machine, it's highly recommended that you uninstall the database before upgrading to Relativity 9.5.309.48. If you uninstall the database after upgrading, you'll delete all Invariant files from the Invariant network share.
  • There is a new installation log file called UninstallLegacyDatabasePackage.log, which appears only once after an upgrade to Relativity 9.5.309.48.

For more information, see Installing the worker manager server. Processing/Invariant ProcessingMaxPublishSubJobCountPerSQLServer - the new default value of this instance setting is 7. For information on configuring this setting, see Throttle settings for distributed publish. Processing/Invariant ProcessingMaxPublishSubJobCountPerWorkspace - the new default value of this instance setting is 3. For information on configuring this setting, see Throttle settings for distributed publish. Processing/Invariant Microsoft Project is no longer a required application to install for Invariant. Processing or Imaging a project file when it is not installed will result in a detailed error. Processing/Invariant Microsoft Visio is no longer a required application to install for Invariant. Processing or Imaging a visio file when it is not installed will result in a detailed error. Processing/Invariant The default value of the WorkerFileCheckTimespanInMinutes entry in the AppSettings table has changed from 2 to 15 (minutes) to reduce how often the Queue Manager needs to check the file share for changes. Processing/Invariant The DryRun validation doesn't work when you upgrade from a version below to a version after, and certain folders and files in processing databases might be deleted if you attempt to run it. For this reason, we recommend that you not run the DryRun validation. Processing/Invariant You can now host Invariant Kepler services in HTTPS if you install a certificate on the queue manager. Note that the default port for the Invariant Kepler services is 8092. For details, see Enabling HTTPS for Invariant Kepler Services. Processing/Invariant The Service Bus certificate generation key is required on the queue manager and worker servers as part of the connection between Invariant and Service Bus. For more information see Fields in Service Bus Configuration wizard in the Pre-installation topic. Processing/Invariant Invariant stores are now deleted automatically when the Relativity workspaces associated with them are deleted. For more information, see Deleting a data store. Processing/Invariant

Publish is no longer a single long-running process and instead is a distributed process that is broken up into separate jobs, which leads to more stability by removing this single point of failure and allowing the distribution of work across multiple workers. These changes enable publish to operate more consistently like the other processing job types in the worker manager server, where batches of data are processed for a specific amount of time before completing each transactional job and moving on. For more information, see Publishing files. Processing/Invariant To accommodate multiple communication protocols and to simplify how you configure the worker manager server in Relativity, the URL field on the Worker Manager Server layout is now called "Server Name," and it no longer requires a net.tcp reference that includes a port number. It also doesn't require a domain unless the worker manager server and Relativity are on different domain. For more information, see Worker manager server. Processing/Invariant

You have the option of using the Invariant.Handlers installer to update only the file handlers in your Invariant instance without having run the entire Invariant installer. The handlers installer is available for upgrades only. Note that this installer stops and starts workers automatically during the file syncing process, which means that no manual worker stoppage is required. For more information, see Using the handlers installer.

Note: A full upgrade to Relativity is required before you can use the handlers installer to upgrade to a newer set of handlers. Going forward, you won't be required to upgrade your Relativity version in order to use the handlers installer. Processing/Invariant Each Invariant component has a machine-specific encryption for its connection strings. These are now found in a folder called LocalSettings, rather than the previous Settings folder, which holds other config files. The installer now automatically creates the workers' connection strings, and they are no longer created in the network share. Note that you will still see a placeholder folder on the network share that doesn't contain any data. Processing/Invariant There is a new parameter in the Invariant response file called DATABASEINSTALLPATH, which is the local folder where the Invariant.DBUpdater.exe, Invariant.NIST.InstallUtility.exe, and Invariant.Deployment.exe utilities were automatically installed during database installation. These three executables have been moved out of the network share to the local machine where the database is installed. Processing/Invariant After the database and queue manager upgrades are complete, you must run the Invariant installer on all workers. This is only applicable for upgrades from Relativity 9.4.398.62 (December 21, 2016) or lower to the full release of Relativity 9.5 (January 25, 2017) and above, meaning all monthly product updates of 9.5. If you're performing a fresh installation of Relativity 9.5, you will need to run the installer on each Worker Manager and Worker server; however, any subsequent upgrade will only require you to run the installer from the Worker Manager server, which will upgrade all worker servers automatically, thus eliminating the need to run the installer on each server individually.
9.4.378.21 Processing/Invariant

You can configure the number of concurrent threads dedicated to OCR, which can mitigate CPU bottlenecks. This is possible through the following changes:

  • The MaxConversionThreads column has been removed from the Invariant.dbo.Workstations table, as it was longer in use since conversion became a separate service.
  • The Invariant.dbo.Workstations table now includes a MaxOcrThreads column, which stores the number of concurrent threads that are allowed to perform an OCR job at a single time. A value of "0" means unlimited, and any other value limits to that number. The default and recommended value is 0. You should only change this value if the Worker CPU is at 100%, and a performance degradation during text extraction.
9.4.398.62 Processing/Invariant The Invariant.DBUodater.exe upgrades both the main Invariant database and RPC stores. It also handles Relativity stores by setting the stores to Pending, which tells the Workspace Upgrade Worker agent to pick them up and execute scripts on them. It also produces a detailed XML log file, which gets created in the install directory and provides information on what happened during the database upgrade.
9.4.398.62 Processing/Invariant The IDENTITYSERVERURL setting is new in the Invariant response file. This is where you enter the identity server of the environment used for RPC authentication. Processing/Invariant When you change the URL for the queue manager, you're required to perform an IIS reset on the Relativity server in order to clear the cache. Processing/Invariant

You no longer map processing fields through the processing profile. You now map through a new Source field on the Field layout, which takes you to a catalog containing the most common fields that are discovered during processing. Note the following details regarding this change:

  • Relativity provides 46 new processing fields, in addition to the 81 fields previously provided, bringing the total number of fields that are available to map to 127.
  • The processing profile no longer contains the Processing Fields associative object list view.
  • If you don't install the Processing application, Relativity still allows you to map fields as long as you've added the worker manager server to the resource pool.
  • Relativity transfers any fields mapped in the processing profile named "Default" to the field mapping table. If the name of the original Default profile has been changed, that profile is still used. If you haven't mapped any fields on the Default profile in 9.3, and one or more other profiles do have fields mapped, Relativity doesn't automatically transfer fields when you upgrade to 9.5. Processing/Invariant You can now install Microsoft Office 2013 on your worker servers; however, due to a performance degradation in text extraction when using Office 2013, we recommend that you continue to use Office 2010 with Relativity 9.5. When you upgrade from Office 2010 to 2013, it's recommended that you uninstall 2010 and then install 2013. If you don't uninstall 2010 prior to installing 2013, you may need to do a repair on 2013 in order to get it working properly. Processing/Invariant If you are upgrading from Relativity 9.3 (or a lower version) to 9.5 you may be required to manually install Visual C++ redistributable packages on the worker servers before running the Invariant upgrade. For details, see Upgrading a worker manager server installation. Processing/Invariant The WebAPI setting in IIS is now set to Anonymous Authentication by default and is no longer set to Windows Authentication. You must keep this set to Anonymous Authentication in order to publish documents to a workspace using the worker manager server. Network load balancing If you are using cookie-persisted load balancing configurations for Relativity and higher, you must update the WebClientRequiredCookies instance setting to include the name of the load balancer cookie for the ActiveX viewer. New UI framework

The Server 2021 release provides a single Modernized UI that combines all of the features of the Classic UI, plus many additional features not available in the Classic UI that make it perform better. For more information, see Navigation. When using the new UI framework, the following Relativity features have been enhanced:

  • Cluster visualization
  • Dashboards
  • Document list and tabs throughout Relativity
  • Pivot
  • Sampling
  • Search panel and search browser Production Beginning in Relativity 9.3 you can choose to upgrade only your Production application using a RAP file.
All upgrades Production An upgrade from Relativity 9.x to Server 2021 can fail if the workspace you're upgrading already contains a Relativity field with the name Production. You must rename this field. Production An upgrade from Relativity 9.2 and below to Server 2021 can fail if the workspace you're upgrading already contains a Relativity dynamic object with the name Production Placeholder. You must rename this object. Production An upgrade from Relativity 9.1 to Server 2021 can fail if the workspace you're upgrading already contains a Relativity dynamic object with the name Production Data Source. Production An upgrade from Relativity 9.2 and below to Server 2021 can fail if the workspace you're upgrading already contains a Relativity dynamic object with the name Relativity Color Map. You must rename this object. Production An upgrade from Relativity 9.2 and below to Server 2021 can fail if the workspace you're upgrading already contains a Relativity dynamic object with the name Field Catalog. You must rename this object.
All upgrades Production If you have a full-text index populating the production upgrade stops. Try upgrading again once the full-text index is finished populating. Production Relativity deduces the First Bates Value and Last Bates Value for all imported and upgraded productions. Production If you upgrade from Relativity 9.2 to Relativity Server 2021 and you were previously using the Production Tracker application, review the Production Tracker Server 2021 considerations PDF in the Relativity Community. Production Beginning in, Productions includes an upgrade step to migrate data from the old ProductionInformation schema to the new schema introduced in Production The Relativity.Core agents for production and branding are upgraded to ADS Deployed agents. The Relativity.Core agents for production and branding are not available in a Relativity Server 2021 environment. Production The Markup Set table is converted to the Markup Set dynamic object. Production The Production Object table is converted to the Production dynamic object. Production Any staged or errored productions in an environment are set to a status of New and you must restage the production before running. Production Productions migrated from Relativity 9.1 and 9.2 receive a legacy placeholder stating, "No Tiff Included For This Record." Production Productions migrated from Relativity 9.1 to Relativity Server 2021 have a data source created containing the production documents for each produced and errored production. Production If any produced productions contain native files with their Bates numbers previously stored in the Document table, the Bates numbers for the native files are moved to the Production object, and may not reflect actual Bates values if those values were overwritten. Production The Production Error field no longer exists on the Production object. Production If you upgrade from an earlier version of Relativity 9.3 and your custom placeholders contain square brackets, you may see an error the next time you run the production or re-save the custom placeholder. To correct the error, escape the square brackets using a blackslash and re-run the production. Production On upgrade from 9.2 the Produced Documents field exists in the environment, but the field is not populated. Production The production document view no longer exists. Production The multi-object field Produced Documents is replaced with the Production Information RDO when upgrading from Relativity 9.2. The field is not deleted from the workspace, but is disassociated from the production application. Production On upgrade from 9.x to Server 2021 the Add Image Placeholder field changes to Use Image Placeholder. If the Add Image Placeholder field was set to No, it updates to Never Use Placeholders. If the Add Image Placeholder field was set to Yes, it updates to Always Use Image Placeholders. Production Users with full permissions to the Production object prior to upgrading to Relativity 9.3 do not automatically gain permissions to the new Production Data Source object, unless they also have the Manage Object Types permission under Admin Operations. Users need rights to the new Production Data Source object to add or edit production data sources after upgrading to Relativity 9.3+.
9.5.342.116 Relativity admin and service account email addresses

Relativity includes the Relativity admin and service account users by default. With the Relativity 9.5.342.116, the default email addresses for these accounts have been updated as follows:

  • Relativity admin
    • Previous email address: relativity.admin@kcura.com
    • New email address: relativity.admin@relativity.com
  • Relativity service account
    • Previous email address: relativity.serviceaccount@kcura.com
    • New email address: serviceaccount@relativity.com Relativity Desktop Client (RDC) The RDC installer now provides the option of enabling required firewall rules. For details, see Installing the RDC. Relativity Desktop Client (RDC) In accordance with technical improvements made to how the RDC handles batches during import and export, the Import Load File Progress window now provides a more detailed display of how many files are being processed. In addition, the Progress tab provides detailed information for jobs that were stopped by the user. For more information, see Importing document metadata, files, and extracted text and Stopping an import or export job. Relativity Desktop Client (RDC)

Beginning in Relativity, the Relativity Desktop Client uses the same login page process as the standard website. You must configure the RDC to use a RelativityWebAPI in the Web Service URL settings. Any legacy Windows-Authentication WebAPIs won't work once the environment is upgraded to

Additionally, if you previously set up an IIS application pool for automatic logins, you no longer need it. You can configure the RDC to use a /RelativityWebAPI URL set to anonymous authentication in IIS. This will still pass end users through using Windows Authentication. For more information, see Relativity Desktop Client.

Note: You can use the RDC downloaded from Relativity with Relativity versions to but you must create a new RDC OAuth2 client to do so. For more information, see Relativity Desktop Client.

9.5.309.48 Relativity installer updates

For Relativity 9.5.309.48 and above, you can now set the following options in the RelativityResponse.txt file used for the primary SQL server during a new installation or an upgrade:

  • Email addresses for the Relativity admin and Relativity service accounts - The RelativityResponse.txt file used for the primary SQL server installation includes the ADMIN_EMAIL and SERVICEACCOUNT_EMAIL parameters that you can set with these email addresses. If you don’t specify a value for the Relativity admin or service account, they are set to the default values of relativity.admin@relativity.com and serviceaccount@relativity.com respectively.
    • If you want to use a specific email address for the default Relativity admin or service account, you must enter it for each Relativity upgrade that you perform. If you entered a custom email address during a previous installation, it is overwritten by current email address that you entered or by the default email address when this parameter is blank.
    • Use different email addresses for the ADMIN_EMAIL and SERVICEACCOUNT_EMAIL parameters. If you use the same email address for both parameters, the installation fails.
    • The ADMIN_EMAIL parameter functions as the username for the default admin account. If you leave the ADMIN_EMAIL value blank, this username defaults to relativity.admin@relativity.com.
  • Passwords for the the Relativity admin and Relativity service accounts - The RelativityResponse.txt file used for the primary SQL server installation includes the ADMIN_PASSWORD and SERVICEACCOUNT_PASSWORD parameters that you can set with new passwords.

    Note: To change the ADMIN_PASSWORD or SERVICEACCOUNT_PASSWORD password, you must also update the associated email address. If you enter a new password but don’t update the email address, then new password is ignored. For example, if you use an existing or default email address, then the password remains unchanged. However, you can change the email addresses for the admin and service accounts without updating the password.

For more information, see Relativity installation and Upgrading your SQL Server. Processing Console

Beginning in Relativity 9.5, the RPC installer has been reconfigured to request that you enter database credentials, which it will then validate to create a working connection string.

Specifically, the installer includes a new window in which you'll enter the following:

  • Invariant SQL Server name with an optional port number
  • Relativity SQL Server name with an optional port number
  • EDDSDBO password Relativity service bus

The Relativity 9.5 infrastructure now includes a new component called the Relativity service bus. This component uses Service Bus for Windows Service as its underlying framework. Before you upgrade Relativity, you must now install Service Bus for Windows Server on a server or VM that is accessible throughout your Relativity instance. You must then configure a Service Bus for Windows Server farm in your environment. For information about prerequisites, see Service Bus for Windows Server.If you have a proxy server or firewall setup in the environment, you must allow communication to the FQDN of the Windows Service Bus server from the servers you are installing the Relativity Service Bus or else the installer will fail to upgrade the server.

After installing Service Bus for Windows Server, you can upgrade your primary SQL Server. You can then install the Relativity service bus by running the upgrade installer on the machine where you installed Service Bus for Windows Server. Finally, follow the standard instructions for upgrading other Relativity components. For more information, see Relativity service bus.

All upgrades Required certificates for Relativity Relativity Server 2021 now verifies that all HTTPS services running in your environment have a trusted certificate. You need to verify the certificates to components of your Relativity installation running HTTPS services to avoid error messages and insecure-connection icons. For more information, see Required certificates for Relativity. We recommend placing the new Analytics server certificate and testing it prior to the day of the upgrade to Relativity Server 2021. For more information, see Updating the default SSL/TLS certificate.
9.4.398.62 Scripts You must enable the AllowAddOrEditScripts instance setting in order for users to create or edit scripts. This setting enables or disables the ability to create and edit scripts for all users, including system admins. For more information, see AllowAddOrEditScripts. Scripts Beginning in, the Set extracted text size script is no longer available in the Relativity Script Library. If you have this script installed in a workspace, it is removed upon upgrade. You can use the Set long text size mass operation in place of this script. For more information, see Set long text size. Searching Upon upgrade to, Relativity interprets straight quotes and curly quotes in searching the same. Previously, if you searched using curly quotes in a long text field using the CONTAINS filter, Relativity searched for the quote itself instead of grouping terms together. Now, Relativity groups terms between double quotes together regardless of the quote type. This may mean the number of results in your searches may change. System requirements As of August 31, 2017, we no longer support Internet Explore (IE) 10. Please upgrade to a compatible version of IE 11.
All upgrades Telemetry

After you install Relativity Server 2021, complete the steps to enable telemetry in your environment. Telemetry collects metrics for performance, usage, and billing. For more information, see Telemetry and metrics.

Note: Failure to transmit telemetry billing data to Relativity causes Relativity access to be disabled after seven (7) days. Telemetry lockout is similar to Case Statistics Manager lockout. If your security setup doesn't allow access to public internet, contact Relativity support to configure offline-billing. User and group operations

Relativity and above now include enhanced operations for adding users to groups, or removing them from groups. By default, user and group operations are disabled. Contact Client Services for information about enabling this functionality in your Relativity environment.

The enhanced user and group operations run as jobs handled by agents. They require that you manually add the following agents on a first-time upgrade to Relativity and above:

  • Distributed Job Manager - add only one of these agents to your Relativity environment.
  • Distributed Job Worker - scale the number of the agent as necessary. In general, you may want to add three agents per 1,000 workspaces.

Be sure to enable the agents after you add them to your environment. For detailed steps, see Adding and editing agents.

Relativity can also provide notifications about the status of a completed job using the Relativity service bus. In environments running an SMTP server, Relativity sends an email message notifying you when a job is completed. This message contains a link that you can use to retry the job if an error occurs. You must be logged into Relativity before you click the retry link. Additionally, you can obtain the retry link on the Errors tab when a job fails.

You must also set the RelativityInstanceURL instance setting if you want to users to receive email notifications. Ensure that the value for this setting is the URL for your Relativity instance. For example, the URL would have the format: https://example.relativity.com/Relativity. The user receiving the notification must have access to this URL. For more information, see Instance settings' descriptions.

Note: To troubleshoot these distributed jobs, see Relativity service bus entities. Viewer (ActiveX)

Beginning in Relativity, you must install Microsoft .NET 4.6.2 on all of the machines that need access to the ActiveX viewer. You must also install the new ActiveX viewer installation kit, which includes the Visual C++ 2015 redistributable, from the Workspace Details tab. You can't use the Relativity viewer with earlier versions of Relativity. Also, earlier versions of the ActiveX viewer aren't compatible with Relativity For more information, see Legacy viewer installation.

Note: If you have a client machine that accesses multiple instances of Relativity that require different versions of the ActiveX viewer, the corresponding ActiveX viewers must be installed. To ensure proper viewer functionality, you must close their browsers before they switch from one version to the next.

9.5.309.48 Viewer (ActiveX and HTML) Beginning in 9.5.309.48 the default instance setting called HideDownloadNativeFileRadioButton disables the native file radio button in the document viewer toolbar. This setting hides the Native radio button regardless if you have permission to download documents or not. If you have the right permissions, click the file icon next to the document identifier in the viewer to download the native file to your device.
9.2.337.3 Viewer (ActiveX and HTML) When viewing documents with an .HTM, .HTML, or .XML extension in Native mode, the viewer displays the raw file markup instead of rendering the content. You can control this option with the TreatHtmlAndXmlAsText instance setting, which is set to True by default. When set to True, this prevents JavaScript from executing when viewing these documents in the Native mode in the viewer.
All upgrades Windows or Integrated Windows authentication If your Relativity installation currently uses Windows authentication or Integrated Windows authentication, you must set the UseWindowsAuthentication instance setting to True after upgrading your environment. For more information, see Instance settings' descriptions. You may want to configure your environment so that some servers use Windows authentication, while others don't use it. In this case, you need to add another row for this instance setting to the Instance setting table, update the machine name in this new row, and then set the value to True or False based on the Windows authentication requirements for the server. In addition, you can set the WindowsAuthIpRange instance setting, which specifies a group of IP addresses that Relativity uses to validate the address of the user during login. If a request originates from an IP address added to the WindowsAuthIpRange instance setting, the server uses Windows Authentication to log the user in to Relativity. Relativity uses forms authentication to log in the user, when the IP address is outside the specified range. For more information, see Instance settings' descriptions. Windows Service Bus 1.1 with TLS 1.2 Support You can upgrade your Service Bus for Windows Server to use Transport Layer Security (TLS) 1.2. For more information, see Service Bus with TLS support.
9.4.321.2 Workers

The LongRunningJobTimeout setting enables Invariant to terminate some stuck jobs. Specifically, this value determines the amount of time (in milliseconds) that a worker will work on a job before Invariant terminates that job. The default value is 180,000 milliseconds (30 minutes).

You may want to adjust this value if you have large documents that need additional time for processing, or if you need a shorter feedback loop. If you need to adjust this value, you can manually go into the AppSettings table and increase it accordingly. Previously, Invariant workers could get into a state in which they no longer reported progress and no longer completed work, which then required manual intervention to terminate those processes. When Invariant uses the LongRunningJobTimeout setting to stop a job, Relativity provides an error message to the processing user informing them that the timeout limit was reached.

9.4.361.1 Workers The Conversion Threads in Use column no longer appears on the Worker Status tab. Additionally, on the worker server page, you can no longer designate a worker for conversion work. To configure your environment for conversion, see Configuring your conversion agents.
9.2.337.3 Worker manager queue

Revisions in the queue manager code have led to the following enhancements:

  • A reduction in the volume of connections to the SQL Server
  • A reduction in lock waits and thread pool waits
  • A general increase in queue parallelism
  • A reduction in the number of queries per second hitting the SQL Server

There is no reduction or change in actual queue functionality as a result of these changes. Likewise, the user experience with the queue manager hasn't changed, with the exception of potential performance increases, depending on the size of your environment. Worker manager server Document conversion no longer occurs on the worker manager server. You cannot modify the priority of the following conversion jobs on the worker manager server: Pre-convert, Conversion on-the-fly, Mass conversion, and Conversion. Instead, you must install Service Bus for Windows Server and configure conversion agents. For more information, see Configuring your conversion agents.
9.4.361.1 Worker manager server The Worker manager page no longer displays the following conversion fields: pre-convert, conversion on-the-fly, mass conversion, and conversion. Worker manager server Beginning in Relativity, the URL field on the Worker Manager Server is now called Server Name and displays the fully-qualified server name as the location of the Invariant API on the server.
9.4.398.62 Workspace upgrade queue

The Workspace Upgrade Queue includes the following columns:

  • Store Upgrade Status - the status of the upgrade of the Invariant store, as completed by the Workspace Upgrade Worker agent. The possible values in this column are the same as for the workspace upgrade. This field is empty if you don't have Processing installed.
  • Current Store Version - the version of Invariant you are upgrading to.