2.3 Upgrading from 3.5.1.1 (or 3.5.1) to 4.5

2.3.1 Preparing to Upgrade to 4.5

Table 2-7 Preparing for Retain 4.5

Task

Details

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 upgrade Java to the correct version.

    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.5 software

  1. Download the Retain 4.5 .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

Decide which Indexer to Use

  1. Decide whether to use the standard indexer or high-availability, cluster-based index servers (separate license required).

    NOTE:For most Retain deployments including large enterprises, the standard indexer is more than adequate.

    If your organization requires a high-availability, clustered index-server deployment, visit the Micro Focus Gwava Customer Center and contact your Micro Focus Sales Consultant.

Get 4.0 Licenses

  1. Using the Micro Focus Gwava Customer Center, obtain licenses for Retain 4.x and the 4.x modules, etc. that your Retain deployment uses.

Ensure Adequate Disk Space for Reindexing

  1. Deploying the new indexer requires enough empty disk space to allow for 4 times the current index size.

    The installer checks this and warns if the empty space is lower, but it doesn’t stop you from proceeding at your own risk.

    If you need assistance identifying where the index and other Retain components are stored, see Finding Retain’s Storage Paths.

Ensure Adequate RAM

  1. Make sure that the Retain server has at least 12 GB RAM.

GroupWise Storage Flags

  1. If you archive GroupWise, note which storage flags Retain is currently using. You will nave an opportunity to set them after the upgrade completes and before you reindex the Retain archive.

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.3.2 Upgrading to 4.5 (SLES)

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

Table 2-8 Upgrading to 4.5 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-tomcat7 stop

Run the Retain 4.5 Installation

  1. At the terminal prompt, navigate to the folder that you prepared in Get the 4.5 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.5 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 Java 8 and Tomcat 8. If they are not installed, it installs and configures them for Retain.

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.5. Then it starts the required processes.

A message thanks you for installing Retain and reminds you to consult the documentation.

When the system prompt displays, wait a few moments to make sure all the components are running, then continue with Completing the Upgrade to Retain 4.5.

2.3.3 Upgrading to 4.5 (Windows)

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

Table 2-9 Upgrading to 4.5 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 Apache Tomcat 7.0 tomcat7 service.

Run the Retain 4.5 Installation

  1. In the folder that you prepared in Get the 4.5 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.5 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 Java 8 and Tomcat 8. If they are not installed, it indicates that they will be.

  2. Click Next.

    The install runs the Java 8 and Tomcat 8 installations and configurations.

    Click through or run any security alerts or other dialogs to complete the installation.

Choose a Web Server

  1. Select the Web server that Retain uses.

  2. If you use IIS, click Next and continue with the next row in this table.

  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.5. Then it starts the required system processes.

Information

The install reminds you to consult the documentation.

  1. Wait a few moments for all of the components to finish 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 Completing the Upgrade to Retain 4.5.

2.3.4 Completing the Upgrade to Retain 4.5

You must complete the tasks in the following sections in order to have a fully functional Retain 4.5 System

Updating the Schema and Installing Retain 4 Licenses

Table 2-10 Completing the Upgrade to 4.5

Dialog/Section

Details

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

Configuration 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 8 service.

    SLES 11: On the server at a terminal prompt, enter

    rcretain-tomcat8 restart.

    Windows: On the server at a terminal prompt, enter

    In the Services manager, restart Retain Tomcat 8.

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

Database Schema Enhanced

IMPORTANT:At first glance, the refreshed screen might look like the previous prompt has looped back.

However, this refers to the schema of the SQL database that tracks the message store archive. The previous item dealt with the SQL database that tracks Retain’s configuration settings, etc.

  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 8 service as before.

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

Retain Login Dialog

  1. Log in as the Retain admin user.

Licensing

  1. In the web administration console under Configuration, click Licensing.

    The Licensing page opens.

  2. Under Submit License, choose and submit each of your Retain 4.0 licenses.

  3. Although not required, you might consider removing the expired licenses to clean up the page and make it easier to manage your current licenses going forward.

  4. Continue with If Your System Began at Version 3.0 or Earlier.

If Your System Began at Version 3.0 or Earlier

If your initial Retain system was version 3.0 or earlier, do the following:

Item

Action

Server Logging Level

  1. In the browser-based administrative console, navigate to Configuration > Server Configuration > Logging.

  2. Set the Server Logging Level to Diagnostic, unless your root partition disk space is limited.

  3. Save the change.

Worker Logging Level

  1. In the browser-based administrative console, navigate to Data Collection > Workers > Worker object > Logging.

  2. Set to Diagnostic, unless your root partition disk space is limited.

Indexing

  1. Be aware that the Retain 4.5 default is to index all content.

    If you don’t want all content indexed, adjust the settings before running the tasks in Reindexing Retain.

Worker Performance

  1. In the browser-based administrative console, navigate to Data Collection > Workers > Worker object > Connection tab.

  2. Make sure the port is set to 48080. Older systems defaulted to 80, which routes through the web server and slows the system down.

  3. Avoid using SSL if your organization security policies allow it.

    SSL cuts worker performance in half.

  4. If you change any of your Workers’ configuration settings, make sure that you copy new Bootstrap files to /opt/beginfinite/retain/RetainWorker/WEBINF/cfg and restart the worker.

GroupWise Storage Flags

  1. If you archive GroupWise, as part of the planning process you noted which storage flag Retain uses in GroupWise Storage Flags.

  2. Access the GroupWise module and set the storage flags to match the previous settings.

Reporting & Monitoring Server and System Resources

  1. If applicable to your deployment, you can prevent the server from draining system resources by selecting Core Settings > Disable the disk usage statistic option.

  2. Also set the port under the Connection tab to 48080.

Reindexing Retain

NOTE:The instructions in this section assume that you are using the Retain 4 Standard Indexer. If you are deploying a high-availability cluster for indexing, your Sales representative is working with you on that deployment and you can ignore this section.

Table 2-11 Reindexing with the Retain 4 Indexing Engine

Dialog/Section

Details

Reindexing

After the system is running with updated licenses, it’s time to create new indexes of all the message store metadata, using the Retain 4 indexers.

  1. In the web administrative console, go to Configuration > Server Configuration > Index.

  2. Under Indexing Engine, click the Migrate to 4.0 Indexer button.

    The Configure New Indexer subpanel opens.

  3. Type the Retain Admin password.

  4. Click Save Changes.

    The reindexing process begins and the screen refreshes regularly to show progress.

    All user services are still functional during this time.

    WARNING:Do not interrupt the reindexing process.

General Information

  1. When the reindexing of all message store meta data is complete, Retain sends an email.

2.3.5 Removing Old Indexes after Retain 4.5 Has Completed Re-indexing

  1. In the browser-based management console, go to Configuration > Server Configuration > the Storage tab.

  2. In the Storage panel, click Advanced Settings. and if the Derive all file locations … option is selected, deselect it.

  3. Note the Index path.

  4. Delete all of the files in the location shown except the solrhome directory.