Plan the upgrade
Use this section to plan your Nuix Discover upgrade.
Recently added features that require environmental changes
The following are recently added features that require environmental changes, organized by release.
Nuix Discover 10.19
Login Service updates: If your deployment uses the Login Service, the Login Service MUST be upgraded to 2.7.23 prior to upgrading to Nuix Discover 10.19.005. The new version of the Login Service includes various security enhancements. To learn how to upgrade the Login Service, see Install the Login Service (optional).
Update Audit Log Service version: The following updates have been made to the User Audit Log Service:
The User Audit Log Service is version 2.2.2.
This version of the service supports Elasticsearch version 8.x.
Nuix Discover 10.18
There are no new features that require environmental changes.
Nuix Discover 10.17
There are no new features that require environmental changes.
Nuix Discover 10.16
There are no new features that require environmental changes.
Nuix Discover 10.15
There are no new features that require environmental changes.
Nuix Discover 10.14
There are no new features that require environmental changes.
Nuix Discover 10.13
There are no new features that require environmental changes.
Nuix Discover 10.12
There are no new features that require environmental changes.
Nuix Discover 10.11
There are no new features that require environmental changes.
Nuix Discover 10.10
During upgrade, the compatibility mode is automatically set to the maximum supported compatibility mode for the version of SQL Server that is used during the upgrade process.
Nuix Discover 10.9
Database Utility enhancements: The Database Utility now retrieves both active and inactive cases. The Cases list has a new column to identify active and inactive cases.
Nuix Discover 10.8
Login Service updates: If your deployment uses the Login Service, the Login Service MUST be upgraded to 2.5.7 prior to prior to upgrading to Nuix Discover 10.8.005. The new version of the Login Service includes various security enhancements. To learn how to upgrade the Login Service, see Install the Login Service (optional).
Note: If the Portal API is not available, visit the Nuix Support portal at https://nuix.service-now.com/support.
Update Audit Log Service version and eliminate system variables: The following updates have been made to the User Audit Log Service:
The User Audit Log Service is now version 1.4.3.
This version of the service now also supports Elasticsearch version 7.x.
The service now dynamically detects the Elasticsearch version and no longer requires an environment variable setting.
An upgrade to this version of the service is optional.
Nuix Discover 10.7
The Login Service installation steps are now included in this guide. If you have never installed the Login Service before, please see the Nuix Discover 10.7 – Installation and Configuration Guide for more information.
Nuix Discover 10.6
There are no new features that require environmental changes this version.
Nuix Discover 10.5
There were no new features that require environmental changes this version.
Nuix Discover 10.4
Below are the recently added Nuix Discover 10.4 features that require environmental changes.
Case Decommissioning: Nuix Discover 10.4 adds a feature to allow portal administrators to archive an entire case. The Case Decommission feature requires an Archive File Repository to be configured. The archive file repository will contain database backups, contents of the case image/index/transfer repositories, and the Elasticsearch index snapshot.
If you previously deployed and configured Elasticsearch for Coding History, you must make the following changes to enable the feature:
Create an Archive File Repository file share if it does not already exist. For information about how to set up and configure the Archive File Repository, see the Nuix Discover 10.4 - Installation and Configuration Guide.
Make sure the Archive File Repository contains a folder named esBackups for the Elasticsearch Snapshot Repository Location.
Update the Elasticsearch YML configuration file with the path to the esBackups Elasticsearch Snapshot Repository Location.
Modify the Elasticsearch service to run as the Nuix Discover Active Directory (AD) Service Account.
Update the Nuix Discover Audit Service config.local file to include the path to the esBackups Elasticsearch Snapshot Repository Location under the Archive File Repository.
Add a configuration string to Portal Options that defines the esBackups Elasticsearch Snapshot Repository Location.
Review your existing Installation
Before upgrading, contact Nuix Support or an account manager if any of the following apply:
You are using versions other than Windows 2019, SQL Server 2017 CU5 (Build version 14.0.3023.8) or higher.
Note: As of Nuix Discover 10.0, SQL Server 2014 is no longer supported.
You have existing performance or other issues with the application. You are experiencing any performance degradation, such as slow search results, slow document display, poor user interface performance, or other issues.
You are migrating your SQL Server to new hardware with new host names as part of the upgrade. There are many considerations in this type of migration, which are beyond the scope of this upgrade document.
You do not know how to identify the components of your existing installation.
Note: If any of the previous apply, you can request a phone consultation with the Professional Services team to discuss your upgrade path. The Professional Services team can help you understand the scope of the upgrade work for your environment and discuss how they can assist you. This one-hour phone consultation is free of charge.
To begin, confirm that you are upgrading from a version that has a supported upgrade path. To check the application version number for Ringtail 8.6 and higher, look at the lower left corner of the application window.
Plan the administrative access for upgrading
Upgrading requires Administrator access (either a local administrator account or a domain account added to a local administrator group) on all servers. Additionally, upgrading requires System Administrator (SA) privileges for the SQL databases.
Document server host names and roles
In the following table, record the existing server host names for each server by their server role. Be sure to include all servers, including each node, if your SQL Server is clustered. Confirm that you have Administrator access (either a local administrator account or a domain account added to a local administrator group) and System Administrator access to SQL Server.
Note: Not all installations will have a separate analysis server.
Server role |
Host names |
SQL database servers |
|
SQL analysis servers |
|
Web servers |
|
Content search service server |
|
Office Online Server (OOS) |
|
RPF coordinator servers |
|
RPF supervisor servers |
|
Document URLs
Before upgrading the application, determine the virtual directories that will host the Nuix Discover application(s), and then record the URL information in the following table. You must have this information to upgrade the application.
Always use the same URL format and note if the URL is http or https. The URLs must be in one of the following formats:
http://servername/ OR https://servername/
http://IPAddress/ OR https:/IPAddress
http://DNS alias OR https://DNS alias
This document will reference URLs as http(s)://<address>/ You must replace this with a proper URL, using one of the above formats.
If you are using Domain Name System (DNS) redirection, before installing the application, configure and provide DNS details for the application to use during the installation. You must specify the URLs shown in the following table during the installation.
Web site |
URL |
Nuix Discover |
/Ringtail |
Nuix Discover STS |
/RingtailSTS |
UIStatic |
/UIStatic |
Online help |
/RingtailHelp |
RPF coordinator |
/Coordinator |
Content search service |
/Content-Search |
Connect API |
/Portal-API |
Hit highlight service |
/Hit-Highlight |
Beginning with Nuix Discover version 10.5, the default web application names for the Content Search, Hit highlight, and Connect API have changed. Prior to the upgrade, verify which URLs are configured on the Portal Management > Settings > Portal Options page. After you complete your upgrade, update the settings on the Portal Options page to reflect the new URLs.
Web site |
URL |
Connect API URL |
|
Content search service URL |
|
Hit highlight service URL |
|
The default application name changes, depending on the version you are on, as shown in the following table.
Service |
Pre-10.5 app name |
10.5 and later app name |
Example Portal Options to update |
Content Search Service |
Ringtail-Svc-ContentSearch |
Content-Search |
Content search service URL http(s)://<address>/Content-Search/api/search |
Hit highlight Service |
Ringtail-Svc-HitHighlight |
Hit-highlight |
Hit highlight service URL http(s)://<address>/Hit-Highlight/api/HitHighlight |
Connect API Service |
Ringtail-Svc-Portal |
Portal-API |
Connect API URL http(s)://<address>/Portal-API/api/query |
Document Nuix Discover STS certificate details
During the installation process, you must confirm the following details from the STS certificate, as indicated in the following table.
To find this information, run the following command from PowerShell:
Get-ChildItem -Path Cert:\LocalMachine\My
Note: There may be more than one certificate.
Details required |
Comments |
|
|
Nuix Discover STS Certificate Thumbprint |
Thumbprint (without leading or trailing spaces) |
|
Certificate name |
Subject (everything after “CN =”) |
|
Certificate issuer name |
Issuer (everything after “CN =”) |
Document user and database accounts
Upgrading requires access to user accounts for the various Nuix Discover components. These accounts may already be established for the current installation. Before you upgrade, prepare by recording the following details about the user accounts, as well as existing databases that you are going to upgrade in the following table. You must provide these details when upgrading the system and case databases.
Account |
Details |
|
|
SQL Server and Instance Name |
|
|
SQL Server Port |
|
|
Portal Database Name |
|
|
RPF Database Name |
|
|
SQL System Administrator (SA) equivalent account |
User name: Password: |
|
SQL Webuser account |
User name: Password: |
|
Active Directory service account |
DOMAIN\User name: Password: |
Note: The Active Directory service account was known as the Ringtail service account in previous versions of the application.
For more information about the different types of Nuix Discover accounts and databases, see the Nuix Discover Installation and Configuration Guide.