Upgrade considerations for Relativity Server 2021

• 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.

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.

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.

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.

Notes:
• * 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.

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.

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.

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.170.1

10.3.170.1

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.170.1

• 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.

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

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.

SQL 2017 will be support in Relativity 10.1.xxx.x.

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

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.

• 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.
•  

The following instance settings are new in Relativity 9.7.229.5:

• 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.

• Support for .NET Version 3.5 on the worker was deprecated in Relativity 9.7.229.5
• Support for the Solidworks eDrawings Viewer 2016 was deprecated in Relativity 9.7.229.5.
• Support for the Solidworks eDrawings Viewer 2018 was introduced in Relativity 9.7.229.5.

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

The following instance setting is new in Relativity 9.6.202.10:

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.

The following instance settings were modified in Relativity 9.6.202.10:

• 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.

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.

Starting with Relativity 9.5.133.118, 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.

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.

Starting with Relativity 9.5.196.102, 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).

Starting with Relativity 9.5.196.102, 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.

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.

Upon upgrade to Relativity 9.5.292.12, 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.

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.

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.

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.

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.

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.

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.

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.

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.

Beginning in 9.6.134.78, 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 9.6.134.78 from an earlier version requires you to run the Invariant installer on your worker machines one time.

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.

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.

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 9.5.133.118 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.

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.

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.

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

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

Beginning in Relativity 9.5.292.12, 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 9.5.292.12.

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 9.5.292.12 with Relativity versions 9.5.41.87 to 9.5.219.30 but you must create a new RDC OAuth2 client to do so. For more information, see Relativity Desktop Client.

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.
  Notes:
  • 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.

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

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.

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.

Relativity 9.6.50.31 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 9.6.50.31 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.

Beginning in Relativity 9.5.196.102, 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 9.5.196.102 viewer with earlier versions of Relativity. Also, earlier versions of the ActiveX viewer aren't compatible with Relativity 9.5.196.102. 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.

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.

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.

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.