2.2 Upgrading from 23.2 or 23.3 to 23.4 and Later

Use the instructions in the following sections to upgrade from Retain 23.2 or later to Retain 23.4 and later.

2.2.1 Preparing to Upgrade to 23.4 and Later

Table 2-1 Preparing for Retain 23.4 and Later

Task	Details
Ensure that the Retain server is connected to the Internet	Verify that the Retain server is connected to the Internet, so that the installer can install OpenJDK 17. If your server isn’t connected to the Internet, see Installing Java on a Server with no Internet Connection.
Ensure that SMTP Is Working in Retain	The installer must be able to email status messages to the configured SMTP account. Otherwise, it will stop and display an error message.
Get the 23.4 and later software	Using your OpenText Customer Center account, download the latest version of the Retain installation.zip file. NOTE:If you are upgrading to 24.1.1, click here to download the Retain installation.zip file Copy the file and unzip/extract it on the following: The Retain server that you are upgrading. Every server that is running a Retain Worker or other component. (SLES) Open a terminal, navigate to the extracted folder, run the following command to make the script files executable: chmod +x *.sh
Ensure Adequate RAM	Make sure that the Retain server has at least 12 GB RAM.
Back up the Database and the Retain Server	The upgrade should run smoothly. However, best practice always dictates backing up systems before making major changes. Back up your database and the Retain server immediately before starting the upgrade.

2.2.2 Upgrading to 23.4 and Later (SLES)

If you are upgrading Retain on a Windows server, go to Upgrading to 23.4 and Later (Windows)

Table 2-2 Upgrading to 23.4 on SLES

Installation Section	Details
Stop Retain before Upgrading	On the Retain server, open a terminal prompt. Stop Retain by stopping the Apache Tomcat service. For example, on SLES 12 or SLES 15 enter the following command: systemctl stop retain-tomcat.service
Run the Retain 23.4 and later Installation	At the terminal prompt, navigate to the folder that you prepared in Get the 23.4 and later software, then enter the following command: ./RetainInstall.sh
License Agreement	Scroll through the license agreement, then type 1 and press Enter.
Software and RAM Requirements	The Linux install lists the 23.4 and later software and RAM requirements. Press Enter to continue.
Retain Components Selection Page	The install displays the Retain components that are already installed on the server. If you want to upgrade only the listed components, enter 1. If you want to also install additional components, enter 2, then enter y for the components you wish to add to the server.
Pre-requirements Status	The install checks for OpenJDK 17 and an updated version of Tomcat 9. If they are not installed, it installs and configures them for Retain. NOTE:The Java and Tomcat verification/installation process can take a while, so be patient while the installation works in the background. The installation process extracts and installs Retain 23.4 and later. Next, it starts the system processes that Retain requires. Finally, a message reminds you to consult the documentation. When the system prompt displays, wait a few moments to make sure all the components are running.

2.2.3 Upgrading to 23.4 and Later (Windows)

If you are upgrading Retain on a SLES server, go to Upgrading to 23.4 and Later (Windows)

Table 2-3 Upgrading to 23.4 on Windows

Dialog/Section	Details
Stop Retain before Upgrading	On the Retain server, click Start > Administrative Tools > Services (or the equivalent on your version of Windows Server). Stop Retain by stopping the Retain Tomcat service.
Run the Retain 23.4 and later Installation	In the folder that you prepared in Get the 23.4 and later software, right click RetainInstall.exe and select Run as Administrator.
Welcome to the Retain Setup Wizard	Click Next.
Software Requirements	The install lists the 23.4 software and hardware requirements along with the software that it will install Click Next.
License Agreement	Accept the agreement and click Next.
Select Destination Location	If you want to install the upgraded Retain components in a non-default location, use the Browse button to change the path. Click Next.
Retain Components Selection Page	The install displays the components that are already installed on the server. If desired, you can select additional components for installation. Click Next.
Pre-requirements Status	The install checks for OpenJDK 17 and an updated Tomcat 9. If they are not installed, it indicates that they will be. Click Next. If needed, the install runs the OpenJDK 17 installation and updates Tomcat 9. Click through any security alerts or other dialogs to allow the process to run to completion.
Information	The install reminds you to consult the documentation. Wait a few moments to make sure all components have finished installing. Click Next.
General Information	A message shows the Retain access URL. Click Next.
Completing the Retain Setup Wizard	Click Finish.

2.2.4 Updating to the Solr 9 Indexing Engine

After Retain 23.4 or later is updated, update the Indexing Engine to Solr 9. You can do this at any time after the upgrade, but if you have Manage Server rights, you are prompted to perform the Index Engine update.

In Admin Console, when it is prompted to update the indexing engine, click Ok.

NOTE:It can take some time for the Server Configuration page to load.
In Server Configuration > Index, click Configure in the Indexing Mode column.

IMPORTANT:When you configure Solr 9, all delete jobs are disabled until Solr 8 clean-up is completed.
You are prompted to select a Port and Index Path. The default Port is 1 more than the port used for Solr 9. For example, if the port for Solr 8 index engine is 8081, then on upgrading Retain, the default port for Solr 9 will be 8082. The index path is the new path for index files. If the index directory is using a symlink, another symlink needs to be created for the new index folder so that the new index files are stored in an appropriate storage location.
NOTE:
- If you are running Retain on a Windows Server, Solr 9 restricts the use of Windows SMB shares on the UNC format, such as\\myhost\myshare\mypath. For the indexer storage path, you can use a drive and mount it later. As a workaround, map the storage path in UNC format to a symbolic link folder on the local drive:
  On the server where Retain is running, run the following command in the Windows Command Prompt: mklink /D C:\myLink \\IP address\c\Retain\Index In the above command, C:\myLink corresponds to the linked folder on the local drive and \\IP address\c\Retain\Index corresponds to the storage path in UNC format.
  
  Ensure that the Retain Tomcat service is running as a user who has access to the shared folder. If not, please update the service and restart Tomcat.
- If you are running Retain on a Linux Server, using a different path than the default, you need to make sure the ownership is set to tomcat:www.
A disk check will run to make sure that there is enough space on your server to migrate the indexer. The free space needed for the migration is 3 times the size of the current index. The recommended free space is 3.5 times the current index size.

When the check passes, Solr 9 is configured and starts indexing. At this point, you can continue with the next steps to switch to Solr 9 or you can wait for Solr 9 to finish indexing.

IMPORTANT:Once Solr 9 is configured, index optimization and backup are disabled until Solr 8 clean-up is completed.
After Solr 9 is configured, click Switch to Solr 9 and restart the Tomcat service.

IMPORTANT:If you switch to Solr 9 when the re-indexing is in progress, the search results in Retain will not be accurate.

Ensure that Solr 9 works as expected. If not, select Re-index All Items and switch back to Solr 8.
Click Clean up Solr 8.

IMPORTANT:This deletes Solr 8 and all the Solr 8 data from the system. Before you perform Solr 8 clean up, ensure that the Solr 9 is working as expected.
Click Ok to confirm.