Upgrade PoolParty 6.0, 7.0, 7.1 to PoolParty 7.2. on Microsoft Windows

Introduction

To upgrade your PoolParty installation, follow the steps described below. PoolParty's automated upgrade process for Windows hosts makes this process a breeze.

Note

A 64-bit build of a Sun/Oracle Java 8 SE Development Kit is required to run PoolParty.

Note

These instructions assume you are upgrading a PoolParty default installation for Windows with the following default directories used, respectively:

  • Apache Tomcat C:/Programs/Apache Software Foundation/Tomcat 7.0/

  • PoolParty's data-files C:\Users\Public\PoolParty\

    • orC:\Users\poolparty\PoolParty\

Note

Password Change Policy (mandatory):

New users and legacy users have to change passwords on their first login. After logging in a user cannot execute any functions, until the password is changed. This way a password is less likely to be misused.

Upgrade Process

Note

On upgrade we replace SesameSetup.xml in the config folder. A backup of the original file is done and this is stored in C:\Users\poolparty\PoolParty\config\oldSesameSetup\SesameSetup.xml file.

STEP 1: Stop the PoolParty Server and Related Services

In order to upgrade you need to stop the PoolParty server as well as all related services of Tomcat and Solr. For details, refer to PoolParty's Windows Services.

STEP 2: Start the PoolParty Setup

Start the PoolPartySetup.exe. A dialogue with PoolParty upgrade information is displayed. Read the information carefully and acknowledge it before you proceed.

51735620.png
STEP 3: Confirm Correct Location of Data Directory

In the next step, the current location of the data directory of your existing PoolParty installation is displayed. e.g.

  • C:\Users\Public\PoolParty\

Check if the correct location is preselected. Click Install to proceed with the installation.

51735619.png
STEP 4: Finalise the PoolParty Upgrade

In the next step, a progress bar indicates the progress of your upgrade. Click Next to proceed with the installation.

PoolParty's integrated Solr server starts. Click Finish to close the installer.

23901651.png
STEP 6: Start the PoolParty Server and Related Services

Start the PoolParty server and the related services of Tomcat and Solr, similar to step 1 of these instructions. For details also refer to: PoolParty's Windows Services

Post-Upgrade Tasks

Clear Browser Cache

You have to clear your browser cache after the upgrade as changes to CSS and javascript used in the PoolParty UI were done.

Run Post Update Scripts

After you login into PoolParty for the first time after the upgrade, you have to run the PoolParty migration script:

  • https://<your-serverurl>/PoolParty/!/migrate/upgrade

The script lists all updates that is going to be done. Trigger the migration by clicking Start Migration. A progress bar and an info box show the progress and status of the migration.

When the process is finished an overview of the migration steps per project is provided.

Recalculate Extraction Models

Changes to the configuration of the PoolParty extraction model have been done. You have to recalculate all extraction models after the upgrade.

Note

You need to have the Superadministrator role assigned to be able to run those scripts.

Elasticsearch - Migration Procedure Version 7.0 to 7.1 (and 6.1 to 6.2)

The index of Elasticsearch has changed. When migrating PoolParty instances from version 7.0 to 7.1 and 6.1 to 6.2, you have to use the following procedure.

Corpusterm Index Update:

  • <PPAppDir>/poolparty/data/elasticsearch/corpusterm

Also delete the respective index in this folder: ${elasticsearch.home}/data

Conceptdata Index Update:

On Elasticsearch delete this folder:

  • <PPAppDir>/data/elasticsearch/conceptdata

Also delete the respective index in this folder: ${elasticsearch.home}/data

Elasticsearch API Call for Folder Deletion:

Elasticsearch has published an API call for deleting these folders, in the PoolParty compliant version find details on their website.

Index Migration for GraphSearch with PoolParty Semantic Integrator and Elasticsearch:

The GraphSearch Elasticsearch searchdata index changed. Follow this procedure for migrating it.

Export and Delete the Index:

  1. Open the GraphSearch Admin Dashboard and export the indices of all Search Spaces.

  2. Stop the GraphSearch and Elasticsearch servers and delete the searchdata index.

  3. Start Elasticsearch and GraphSearch. This will re-create the searchdata core.

  4. Import the indices you exported before, using the GraphSearch Admin Dashboard.

Change the Index Manually:

  1. Stop the GraphSearch and Elasticsearch server.

  2. Change the index as follows for Elasticsearch:

    • Download the settings.json file.

    • Replace the existing file in this folder with the new one: <PPAppDir>data/elasticsearch/searchdata

  3. Start Elasticsearch and GraphSearch.

  4. Migrate data using the API call: /GraphSearch/admin/migrate