Upgrade considerations for Relativity

This page lists the key system updates for Server 2022 that all customers should be aware of before upgrading. Also included are changes introduced in the two other supported Server versions, 10.3 and Server 2021. To learn more about Aero specific release considerations, visit Upgrade Considerations for Aero UI.

Note: If you are upgrading to Server 2022 from Relativity 6.x-10.2 , contact your Customer Success Manager.

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

Version Feature Upgrade consideration
Version Feature Upgrade consideration
Server 2022 Conversion Cache Manager

The new Relativity Document Conversion application and associated public RESTful API endpoints replaces the Cache Manager agent as the solution for clearing conversion cache files. Relativity Document Conversion will only support time-based cache deletion, and the clear cache button will no longer be available on the Cache Location Server page. Although the Cache Manager Agent will still appear on the Agents tab, it is not operational as long as the Relativity Document Conversion application is active. The Cache Manager Agent will be removed altogether in a future release.

There are three agents for the Relativity Document Conversion application:

  • Conversion Cache Manager - generates jobs per active Cache Location Server during off hours, which kicks off the cleanup process.
  • Conversion Cache Delete File Discovery – executes the first phase of the cleanup process (Discovery), identifies and batches up old/expired cache files for each workspace of Cache Location Server on a particular job.
  • Conversion Cache Delete File Worker – executes the second phase where all cached files that were batched up in Discovery phase are deleted.

See the Relativity.Conversion.Cache filter group in the instance settings descriptions topic for information on the settings for these agents.

Server 2022 Browser compatibility Beginning in Server 2022, we now support Microsoft Edge.
Server 2022 Service Bus Server 2022 is the last Relativity version that supports Service Bus, as we will be deprecating Service Bus in Server 2023. We recommend that you begin converting from Service Bus to RabbitMQ beginning in Server 2022. You must use RabbitMQ version 3.9.x. Relativity does not support RabbitMQ version 3.10.x.
Server 2022 Service Host Manager

You can now enable HTTPS on the dtSearch service, which is a self-hosted webservice that runs on any agent server on which the dtSearch Search Manager agent is enabled. Like Service Host, this service is not TLS-encrypted out of the box, but you can now enable this service. For details see HTTPS setup for dtSearch service.

Server 2022 Disaster recovery There is a new version of the Disaster Recovery guide for Server 2022 available here on the Relativity Community.
Server 2022 Aero UI The Aero UI is now present in your Server environment. For a list of the key changes introduced with this new UI, see Aero upgrade considerations.
Server 2022 Database schema A number of database schema updates have been made since Server 2021 and you can find those on the Database schema updates table.
Server 2022 .NET 4.7.2 Beginning in Server 2022, we now require .NET 4.7.2. For details, see Upgrading to .NET 4.7.2.
Server 2022 Internet Explorer support Beginning in Server 2022, Relativity no longer supports Internet Explorer. This change is reflected in our Compatibility matrix.
Server 2022 Analytics server We now recommend that you use Single Data Directory (SDD) mode only when installing the Analytics server for Server 2022. SDD mode provides for easier data management, a more seamless upgrade path, and fewer incidents for Relativity customers and Support to troubleshoot. For details, see Upgrading or installing your Analytics server.
Server 2022 Viewer The Active X viewer has been deprecated.
Server 2022 Agents

The following agents are new:

  • Relativity Forms Metrics Collector - runs once a day during Off Hours and collects data about Object Types and their usage of Relativity Forms.

  • Mass Operation Manager - works with Service Bus to complete mass operations within the environment.

Server 2022 Instance Settings

The following instance settings are new:

  • CustomPageDeletionDelay - the amount of time, in seconds, that the system will wait before removing previous versions of a deployed custom page.

  • CustomPageDeploymentPath - the server path that a Custom Pages will be deployed to. The MachineName should be set for each web server. If not set, Custom Pages will be deployed relative to the Relativity Web installation path.

  • CustomPageDeploymentManagerSleepTime - the number of seconds the Custom Page Deployment Manager Agent will wait for a new version to become available.

  • EnableCustomPageReadinessCheck - when true, the Custom Page Deployment Manager will attempt to invoke an application's custom page readiness endpoint before routing requests to its web pages. The optional readiness endpoint can be configured by application developers to provide a way of performing start up tasks.

  • MassOperationManagerThreadCount - the maximum number of threads for each Mass Operation Manager. If 0 or less, defaults to Agent server processor count * 2.

  • MigrationMaxParallelFileCopyThreads - the maximum number of parallel threads ARM for Processing will use during the file repository copy operation.

  • ScriptRunManagerMaxConcurrentThreads - determines the max amount of concurrent script run threads each agent can use, defaults to 10.

Server 2022 Load balancing APIs The process for load balancing the APIs has changed due to the migration from the RSAPI to the newer Services APIs. In Relativity Server environments, the newer Services APIs don't require dedicated servers for load balancing. In these environments, any servers dedicated to load balance RSAPI services can be removed from the network. The newer Services APIs use the same base URL for every API. This eliminates the need to toggle base URLs based on your target endpoint.
Server 2022 Mass PDF
  • If you have Server 2021 PDF installed you need to upgrade to the Server 2022 PDF release.
  • Legacy PDF functionality is removed, you need to install the new PDF RAP file.
    • To ensure your PDF Mass operation permissions are migrated, install the Server 2021 PDF app before upgrading to Relativity Server 2022.
    • If installing PDF for the first time in Server 2022 without migrating permissions, only System Admins will have PDF Mass Operation permission by default.

Limitations:

  • 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 2022, 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 Mass PDF In Server 2021, we introduced a new optional PDF application that you can use to replace the built-in Save as PDF functionality. 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.
  • 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.

Limitations:

  • 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 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.
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.
  • ConversionOnTheFlyExporterPoolSize - the maximum amount of threads that a Conversion Agent - On the Fly will use on its agent server.
  • ConversionConvertAheadExporterPoolSize - the maximum amount of threads that a Conversion Agent - Convert Ahead will use on its agent server.
  • ConversionMassConvertExporterPoolSize - the maximum amount of threads that a Conversion Agent - Mass Convert will use on its agent server.
 
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 2022 Processing/Invariant

Processing leverages OutsideIn as a new text extraction method for Excel, Word, and Powerpoint. OutsideIn does not utilize Microsoft Office APIs to extract text.

Server 2021 Mobile platform The mobile application is being deprecated and will be removed from the Apple App Store. Beginning with 10.x.xxx.x, all instances and versions of Relativity Server will no longer be able to log in and gain access on the mobile application.
10.3.287.3 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.
10.3.287.3 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).

10.3.287.3 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.
10.3.287.3 Imaging The Print / Save as PDF permission on the Document object is now called Create PDF.
10.3.287.3 Imaging

The following instance setting was added in Relativity 10.3.287.3:

  • 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.
10.3.287.3 Processing/Invariant
  • 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.