2.5 Upgrading from 4.7.0.1 to 4.9.2

Use the instructions in the following sections to upgrade from Retain 4.8.1 or later to Retain 4.9.2.

2.5.1 Preparing to Upgrade to 4.9.2

Table 2-15 Preparing for Retain 4.9.2

Task

Details

If you archive Office 365 using Basic Authentication

Be aware of the following points:

  • Basic Authentication is no longer supported, beginning with Retain 4.9.2.

    The upgrade will succeed with Basic Authentication still in place. However, you should switch to OAuth as soon as possible.

  • Each time you log in to the administrative console, a pop up message displays reminding you that an O365 module is using basic authentication and that you need to switch OAuth authentication to ensure continued data archiving.

  • If the system uses Retain’s SMTP notification system, when you run a maintenance job, the system sends an alert email to the designated recipient with the subject Retain Alert - Basic Authentication Not Supported.

Ensure that the Retain index has been optimized

By default, Retain optimizes its index at 1 a.m. every Sunday morning.

To make sure that your system’s index has been optimized since upgrading to version 4.7.0.1, do the following:

  1. In the web administrative console, go to Configuration > Server Configuration > Maintenance tab > Maintenance/Caching panel.

  2. Check the Last Index Optimization date.

  3. If the last optimization occurred before the upgrade to Retain 4.7.0.1, click the Optimize Now button and wait until the date changes before proceeding.

Ensure that the Retain server is connected to the Internet

  1. Verify that the Retain server is connected to the Internet, so that the installer can install OpenJDK 11.

    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

  1. 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 4.9.2 software

  1. Download the Retain 4.9.2 .zip file.

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

  3. (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

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

  1. Back up your database and the Retain server immediately before starting the upgrade.

2.5.2 Upgrading to 4.9.2 (SLES)

If you are upgrading Retain on a Windows server, go to Upgrading to 4.7.0.1 (Windows)

Table 2-16 Upgrading to 4.9.2 on SLES

Installation Section

Details

Stop Retain before Upgrading

  1. On the Retain server, open a terminal prompt.

  2. Stop Retain by stopping the Apache Tomcat service.

    For example, on SLES 11 enter the following command:

    rcretain-tomcat stop

Run the Retain 4.9.2 Installation

  1. At the terminal prompt, navigate to the folder that you prepared in Get the 4.9.2 software, then enter the following command:

    ./RetainInstall.sh

License Agreement

  1. Scroll through the license agreement, then type 1 and press Enter.

Software and RAM Requirements

The Linux install lists the 4.9.2 software and RAM requirements.

  1. Press Enter to continue.

Retain Component Selection

The install displays the Retain components that are already installed on the server.

  1. If you want to upgrade only the listed components, enter 1.

  2. If you want to also install additional components, enter 2, then enter y for the components you wish to add to the server.

Java, Tomcat, and Apache

The install checks for OpenJDK 11 and an updated version of Tomcat 8.5. 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 install then verifies that a supported version of Apache is installed.

NOTE:If desired, you can review the actions just taken by scrolling through the displayed text before continuing.

Overwrite or Upgrade Retain

The install displays the location of the existing Retain installation and gives three options. You want to upgrade Retain and keep the current configuration

  1. Type 1 and press Enter.

Upgrade the Retain Components

The installation process extracts and installs Retain 4.9.2.

Next, it starts the system processes that Retain requires.

Finally, a message reminds you to consult the documentation.

  1. When the system prompt displays, wait a few moments to make sure all the components are running.

  2. Then continue with Updating the 4.9.2 Database Schema

2.5.3 Upgrading to 4.9.2 (Windows)

If you are upgrading Retain on a SLES server, go to Upgrading to 4.9.2 (SLES)

Table 2-17 Upgrading to 4.9.2 on Windows

Dialog/Section

Details

Stop Retain before Upgrading

  1. On the Retain server, click Start > Administrative Tools > Services (or the equivalent on your version of Windows Server).

  2. Stop Retain by stopping the Retain Tomcat service.

Run the Retain 4.9.2 Installation

  1. In the folder that you prepared in Get the 4.9.2 software, right click RetainInstall.exe and select Run as Administrator.

Welcome to the Retain Setup Wizard

  1. Click Next.

Software Requirements

The install lists the 4.9.2 software and hardware requirements along with the software that it will install

  1. Click Next.

License Agreement

  1. Accept the agreement and click Next.

Select Destination Location

  1. If you want to install the upgraded Retain components in a non-default location, use the Browse button to change the path.

  2. Click Next.

Retain Components Selection Page

The install displays the components that are already installed on the server.

  1. If desired, you can select additional components for installation.

  2. Click Next.

Pre-requirements Status

  1. The install checks for OpenJDK 11 and an updated Tomcat 8.5. If they are not installed, it indicates that they will be.

  2. Click Next.

    The install runs the OpenJDK 11 installation and updates Tomcat 8.5.

    Click through any security alerts or other dialogs to allow the process to run to completion.

Choose a Web Server

  1. Select the Web server that Retain uses.

  2. If you use IIS, click Next and skip to the next row.

  3. If you use Apache,

    1. Browse to and select where it is installed.

    2. Click Next.

    3. If needed, adjust the AJP port.

    4. Click Next.

Overwrite or Upgrade Retain

  1. Leave the Upgrade option selected.

  2. Click Next.

Ready to Install

  1. Click the Install button.

    The installation process extracts and installs Retain 4.9.2. Then it starts the required system processes.

Information

The install reminds you to consult the documentation.

  1. Wait a few moments to make sure all components have finished installing.

  2. Click Next.

General Information

A message shows the Retain access URL.

  1. Click Next.

Completing the Retain Setup Wizard

  1. Click Finish.

  2. Continue with Updating the 4.9.2 Database Schema

2.5.4 Updating the 4.9.2 Database Schema

Table 2-18 Completing the Upgrade to 4.9.2

Dialog/Section

Details

  1. In your administrative browser, open Retain’s web admin console and log in as the Retain admin.

Database Schema Enhanced

A message displays stating that the Configuration Database schema requires updating.

  1. Click the Enter Credentials button.

  2. Log in as the Retain admin user.

    Red text displays with a progress indicator.

  3. When green text indicates that the schema is updated, restart the Retain Tomcat service.

  4. Wait a few moments for Tomcat to restart, then refresh the browser.

Retain Login Dialog

  1. Log in as the Retain admin user.