Upgrading or installing your Analytics server

Note: Make sure you review the Analytics upgrade considerations before upgrading Analytics. For more information, see Upgrade considerations for Relativity 10.3.

An upgrade of your Analytics server is required for Relativity 10.3. Follow these steps to upgrade your analytics server(s). Before upgrading the Analytics server(s), make sure you've completed the steps contained in the following sections:

  1. Install or upgrade your Relativity instance by performing the required steps (see Relativity installation).
  2. Perform a Pre-installation check of the Analytics server.

This topic contains the following sections:

Installing / Upgrading Relativity Analytics

You need the following items in order to successfully run the Relativity Analytics upgrade or installation:

  • The primary database server instance name and corresponding EDDSDBO password. If your SQL Server uses SSL encryption, see Installing Analytics server when SQL Server uses SSL encryption before beginning the Analytics server installation.
  • The Relativity Service Account username and password.
  • All SQL Servers must be active and accessible at the time of the installation.
  • A self-signed or a trusted SSL certificate with the certificate's private key is required by Relativity Analytics. If you do not have a SSL certificate, see Updating the default SSL/TLS certificate.

    Note: We recommend that you use a certificate from a trusted authority rather than a self-signed certificate.

Special considerations

  • Before attempting an upgrade, stop all Relativity Analytics engine processes (i.e., ensure that all Java and Postgres processes are stopped). In versions previous to 9.5.133.118, the Windows Service will be called Content Analyst CAAT. In Relativity 9.5.133.118 and above, the service will be called Relativity Analytics Engine. After you do this, back up the CAAT install directory and the CAAT data directory. If something goes wrong with the upgrade, this will greatly reduce any downtime spent to fix the problem.
  • The Analytics Index Share houses all of your Analytics data for a particular Analytics server, and it can grow to be very large. We have found that NTFS file systems work for small environments, but if you anticipate running sets of 10 million or more documents through your Analytics Engine, you should use a file system that supports larger files such as exFAT or ReFS. We do not have a recommendation for either file system, so you must determine which is the better fit for you.
  • An optional hotfix exists for Relativity 10.3.287.3 and above. This hotfix includes an updated version of Postgres; there are no CAAT changes being made with this package. For more information, see (Optional) Hotfix for 10.3 and above.

This section contains the following content:

Installing Analytics for the first time to Relativity 9.6.50.31 and above

Upgrading from Relativity 9.3.362.9 (CAAT 3.19) and above

(Optional) Hotfix for 10.3 and above

An optional hotfix exists for Relativity 10.3.287.3 and above. This hotfix includes an updated version of Postgres; there are no CAAT changes being made with this package. To apply this hotfix, download the new CAAT package from the Relativity Community and then follow the upgrade steps in Upgrading from Relativity 9.3.362.9 (CAAT 3.19) and above.

Note the following considerations: 

  • Ensure the Users group has Full Control permissions on the install directory.
  • After applying the upgrade hotfix, we recommend running the Structured Analytics portion of the Post-installation verification test document. For more information, see Post-installation verification test.
  • As a new pgsql folder is created as part of the upgrade, disk usage will temporarily be doubled while both versions of Postgres are installed on the server.
  • The upgrade may take a little longer than normal as the existing Postgres data needs to be converted.

After you apply the upgrade hotfix and verify all Analytics components are functioning correctly, delete the old Postgres install directory from the following location to complete the uninstall:

${install_dir}/CAAT/pgsql_9.3

Upgrading from Relativity 9.3.332.21 (CAAT 3.17) or prior

Note: If you are upgrading from Relativity 9.3.332.21 (CAAT 3.17) or lower, contact Relativity Support at support@relativity.com.

Updating the default SSL/TLS certificate

Note: The below section is required if you are installing Relativity for the first time or if you are upgrading from Relativity 9.3.332.21 (CAAT 3.17) or lower.

As of Relativity 9.3, Relativity requires a trusted certificate for all HTTPS traffic, including the internal traffic for the Analytics server. We recommend placing the certificate and testing it prior to the day of the upgrade to Relativity 9.3. By default, the Content Analyst (CAAT®) service runs over an untrusted SSL/TLS certificate. There are several options for getting a trusted certificate in place. You most likely already have a certificate for your externally facing web servers. However, it’s likely that the domain name for that certificate doesn’t match the internal fully qualified domain name (FQDN) of the Analytics server(s). If it DOES match, you may use the same certificate currently on your web server.

For example, if the external certificate is *company.com but your domain is *.company.corp, then this does not match and cannot be used. If it does not, we strongly recommend purchasing one from a trusted certificate authority and placing it on the Analytics server before the upgrade. If you choose not to purchase a certificate, it is possible to use a self-signed certificate as a temporary measure. Should you choose to do this, we recommend using the fully qualified domain name when creating the self-signed certificate so that it can be swapped for a real certificate from a trusted authority later on.

To check the fully qualified domain name (FQDN) of the Analytics server:

  1. Open the Control Panel.
  2. Navigate to Control Panel\System and Security\System.
  3. Under the Computer name section, find the entry for Full Computer Name.
  4. If you have an existing certificate, verify that it matches the FQDN of the Analytics server.
    • If it does not, you must either purchase a new certificate or generate a self-signed certificate.

Overview of how to update the SSL / TLS certificate

Perform the following steps to use a certificate. The detailed substeps under each major step are outlined in the section below.

  1. Delete the default, unsigned certificate.
  2. If you have a trusted certificate (that uses the FQDN), proceed directly to step 3 (importing a certificate). Otherwise, Create a self-signed certificate first before proceeding to step 3.
  3. Note: It is recommended that you use a certificate from a trusted authority (if possible). For workgroup environments, a self-signed certificate is necessary.

  4. Import a certificate (trusted or self-signed) that uses the FQDN.
  5. Verify the Analytics server in Relativity.

1) Deleting the default, unsigned certificate

2) Creating a self-signed certificate (no trusted certificate) - optional step

3) Importing a certificate (trusted or self-signed)

4) Verifying the Analytics server in Relativity

Disabling TLS 1.0 and 1.1 (optional)

Installing Analytics server when SQL Server uses SSL encryption

Changing the REST password

Uninstalling the Relativity Analytics server

We don't recommend uninstalling the Relativity Analytics Server application for any reason as it causes data loss. If you uninstall the Relativity Analytics Server application from the analytics server, all structured analytics sets created in Relativity 8.2 and above can't be used with another installation. There is no way to merge a previous Relativity Analytics Server installation with a new installation. As a result, structured analytics sets created in Relativity 8.2 and above become unusable.

You shouldn't uninstall the application from the server unless you're certain you won't use the server for Analytics functionality in the future, and you understand that uninstalling Relativity Analytics renders structured analytics sets created in Relativity 8.2 and higher unusable.

If you still need to uninstall the Relativity Analytics components from the server, complete the following steps: