This page explains some of the key changes in Relativity 10.1 that you should be aware of before upgrading.
Note: You must install and configure the Relativity Secret Store before installing any other Relativity 10.1 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 to Relativity 10.1.
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:
|10.1.273.3||Workspace Portal||For new groups that you want to grant access to Workspace Portal, add item-level security permission to the SMTPPassword instance setting.|
|10.1.273.3||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.|
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:
|10.1.273.3||Relativity service bus||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.|
|10.1.273.3||System requirements||SQL 2017 is supported in Relativity 10.1.290.1.|
The following instance setting is new in Relativity 10.1.290.1:
ViewerShowsHelpfulTroubleshootingErrorMessage – If set to True, the Viewer will display full-length and descriptive, custom error messages for each error that you experience. If set to False, the Viewer will display the following error message you experience:
An Error Has Occurred.
An error has occurred while trying to view this document.
|10.0.318.5||Audit||Upon upgrade, you must download and install a new Audit RAP file in order for Pivots to work correctly. To download the RAP file, see the Relativity Community.|
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.
|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:
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||Review||The WebClientNativeViewerCacheAheadMaxSizeInBytes and HideProcessTranscriptsMassOperation instance settings have been deprecated.|
|18.104.22.168||Imaging||The Imaging Manager agent was added in Relativity 22.214.171.124. 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.|
|126.96.36.199||Imaging||The OCR Set Manager agent has been modified in Relativity 188.8.131.52. You now need at least one agent per resource pool, and the OCR Set Manager now recovers orphaned OCR jobs from dead agent servers.|
The following instance settings are new in Relativity 184.108.40.206:
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 220.127.116.11:
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 18.104.22.168:
|22.214.171.124||Secret Store||Beginning with Relativity 126.96.36.199, 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 188.8.131.52, the Secret Store is used only for installing and upgrading the system. For more information, see Relativity Secret Store.|
|184.108.40.206||Secret Store||Beginning in 220.127.116.11, all Relativity secrets are migrated to the Secret Store. For more information, see Relativity Secret Store.|
|18.104.22.168||Secret Store||Secret Store 1.0.314.5 is now available. Relativity 22.214.171.124 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.|
If you're upgrading to Relativity 10.1 from a version earlier than 9.2, note that the Textual Near Duplicate Identification algorithm is in place with the following benefits:
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.|
|126.96.36.199||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).|
Starting with Relativity 188.8.131.52, 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.
|184.108.40.206||Analytics||Starting with Relativity 220.127.116.11, Analytics indexes are now RDO's.|
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 18.104.22.168, 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 22.214.171.124, 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.
|126.96.36.199||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).|
|188.8.131.52||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.|
|184.108.40.206||Analytics||Analytics Index RDO instance permissions are copied from Search Index instance permissions.|
|220.127.116.11||Analytics||Cluster Set RDO workspace permissions are copied from Search Index workspace permissions.|
|18.104.22.168||Analytics||Cluster Set RDO instance permissions are copied from the multiple choice cluster field's item level permissions.|
|22.214.171.124||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 126.96.36.199 or higher.|
|188.8.131.52||Analytics||Beginning in Relativity 184.108.40.206, 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.|
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.
|220.127.116.11||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.|
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.
|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.|
A number of new objects have been introduced, such as Authentication Provider Type, Authentication Provider, and Login Method. Upon upgrading to Relativity 10.1, permissions are as follows:
|18.104.22.168||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.16||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.|
|22.214.171.124||Data Grid||If your environment uses Data Grid, you must also upgrade to Data Grid 126.96.36.199 or above when upgrading to Relativity 10.1. For more information, see Upgrading Data Grid.|
|188.8.131.52||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.|
|184.108.40.206||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 10.1, 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.|
|220.127.116.11||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 10.1 in the Relativity Community.|
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.
|9.4.284.1||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:
|18.104.22.168||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.|
|22.214.171.124||File share||Beginning in Relativity 126.96.36.199, 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.|
|9.4.284.1||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:
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.|
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.
For any imaging set with an imaging method set to Basic, the following changes occur:
If your environment is not set up for native imaging, the following changes occur upon upgrade to Relativity 9.6:
|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:
If upgrading to Relativity 10.1 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 10.1 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.
For any existing applications that reference the pre-10.1 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 10.1.
|188.8.131.52||Processing/Invariant||Support for .NET Version 3.5 on the worker was deprecated in Relativity 184.108.40.206.|
|220.127.116.11||Processing/Invariant||Support for Solidworks 2016 was deprecated in Relativity Relativity 18.104.22.168.|
|22.214.171.124||Processing/Invariant||Support for Solidworks 2018 was introduced in Relativity Relativity 126.96.36.199.|
|188.8.131.52||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 184.108.40.206, 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.|
|220.127.116.11||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.|
Beginning in 18.104.22.168, 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:
|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.|
Beginning in Relativity 9.5.309.48, the database installation component has been removed from the Invariant installer. Accordingly, note the following considerations:
For more information, see Installing the worker manager server.
|9.5.292.12||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.|
|9.5.292.12||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.|
|9.5.292.12||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.|
|9.5.292.12||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.|
|9.5.292.12||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.|
|9.5.292.12||Processing/Invariant||The DryRun validation doesn't work when you upgrade from a version below 9.5.292.12 to a version after 9.5.292.12, 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.|
|22.214.171.124||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.|
|126.96.36.199||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.|
|188.8.131.52||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.|
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.
|184.108.40.206||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.|
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 220.127.116.11 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.
|18.104.22.168||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.|
|22.214.171.124||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.|
|126.96.36.199||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.|
You can configure the number of concurrent threads dedicated to OCR, which can mitigate CPU bottlenecks. This is possible through the following changes:
|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.|
|188.8.131.52||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.|
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:
|184.108.40.206||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.|
|220.127.116.11||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.|
|18.104.22.168||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.|
|22.214.171.124||Processing/Invariant||Processing to Data Grid no longer requires the RabbitMQ server. To remove RabbitMQ from your Relativity environment, see Removing RabbitMQ.|
|126.96.36.199||Network load balancing||If you are using cookie-persisted load balancing configurations for Relativity 188.8.131.52 and higher, you must update the WebClientRequiredCookies instance setting to include the name of the load balancer cookie for the ActiveX viewer.|
|184.108.40.206||New UI framework||
The 10.1 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:
|220.127.116.11||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 10.1 can fail if the workspace you're upgrading already contains a Relativity field with the name Production. You must rename this field.|
|18.104.22.168||Production||An upgrade from Relativity 9.2 and below to 10.1 can fail if the workspace you're upgrading already contains a Relativity dynamic object with the name Production Placeholder. You must rename this object.|
|22.214.171.124||Production||An upgrade from Relativity 9.1 to 10.1 can fail if the workspace you're upgrading already contains a Relativity dynamic object with the name Production Data Source.|
|126.96.36.199||Production||An upgrade from Relativity 9.2 and below to 10.1 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.|
|188.8.131.52||Production||An upgrade from Relativity 9.2 and below to 10.1 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.|
|184.108.40.206||Production||Relativity deduces the First Bates Value and Last Bates Value for all imported and upgraded productions.|
|220.127.116.11||Production||If you upgrade from Relativity 9.2 to Relativity 10.1 and you were previously using the Production Tracker application, review the Production Tracker 10.1 considerations PDF in the Relativity Community.|
|18.104.22.168||Production||Beginning in 22.214.171.124, Productions includes an upgrade step to migrate data from the old ProductionInformation schema to the new schema introduced in 126.96.36.199.|
|188.8.131.52||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 10.1 environment.|
|184.108.40.206||Production||The Markup Set table is converted to the Markup Set dynamic object.|
|220.127.116.11||Production||The Production Object table is converted to the Production dynamic object.|
|18.104.22.168||Production||Any staged or errored productions in an environment are set to a status of New and you must restage the production before running.|
|22.214.171.124||Production||Productions migrated from Relativity 9.1 and 9.2 receive a legacy placeholder stating, "No Tiff Included For This Record."|
|126.96.36.199||Production||Productions migrated from Relativity 9.1 to Relativity 10.1 have a data source created containing the production documents for each produced and errored production.|
|188.8.131.52||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.|
|184.108.40.206||Production||The Production Error field no longer exists on the Production object.|
|220.127.116.11||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.|
|18.104.22.168||Production||On upgrade from 9.2 the Produced Documents field exists in the environment, but the field is not populated.|
|22.214.171.124||Production||The production document view no longer exists.|
|126.96.36.199||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.|
|188.8.131.52||Production||On upgrade from 9.x to 10.1 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.|
|184.108.40.206||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:
|220.127.116.11||Relativity Desktop Client (RDC)||The RDC installer now provides the option of enabling required firewall rules. For details, see Installing the RDC.|
|18.104.22.168||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.|
|9.5.292.12||Relativity Desktop Client (RDC)||
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 22.214.171.124 to 126.96.36.199 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:
|188.8.131.52||Relativity 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:
|184.108.40.206||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 10.1 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 10.1. 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.|
|220.127.116.11||Scripts||Beginning in 18.104.22.168, 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.|
|22.214.171.124||Searching||Upon upgrade to 126.96.36.199, 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.|
|188.8.131.52||System requirements||As of August 31, 2017, we no longer support Internet Explore (IE) 10. Please upgrade to a compatible version of IE 11.|
After you install Relativity 10.1, 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.
|184.108.40.206||User and group operations||
Relativity 220.127.116.11 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 18.104.22.168 and above:
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 22.214.171.124, 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 126.96.36.199 viewer with earlier versions of Relativity. Also, earlier versions of the ActiveX viewer aren't compatible with Relativity 188.8.131.52. 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.|
|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.|
|184.108.40.206||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.|
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:
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.
|220.127.116.11||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.|
|18.104.22.168||Worker manager server||Beginning in Relativity 22.214.171.124, 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: