Skip to main content

Upgrading PoolParty from version 2024 R2 to 20025 R2

30/09/2025

Upgrading between PoolParty versions 9.5 through 9.7 is handled by an upgrade script and shares some common steps and prerequisites. Upgrading between these versions must be done version by version — in other words, you can for instance only upgrade to PoolParty 9.6 from PoolParty 9.5, and not any earlier version of PoolParty.

Note

This document uses several environmental variable shorthands:

  • $PP_HOME — the PoolParty installation directory

  • $DIR_BACKUP — the backup directory used for any possibly custom files being replaced, resolves to $PP_HOME/backup/upgrade-from-X.Y.Z-to-A.B.C.$TIMESTAMP

Prerequisites

Before you upgrade to PoolParty 9.5, there are a couple of prerequisites that differ from previous versions of PoolParty:

  • You need to have previously upgraded PoolParty to version 9.4 before upgrading to 9.5.

  • The required Java version is Java 21.

  • From version 20024 R2 (9.4), PoolParty now uses Elasticsearch. The index must be manually migrated from Solr to Elasticsearch. The configuration to use Elasticsearch is automatically updated by the PoolParty installer and requires no manual action.

Some of the prerequisites are handled automatically by the upgrade script and require no manual intervention:

  • GraphDB.ttl is replaced.

  • The GraphDB license is updated.

  • Tomcat is upgraded to version 10, the first version to use Jakarta API.

    • Old applications, which are not yet compatible with Tomcat 10 are automatically moved to $PP_HOME/tomcat/webapps-javaee, and will be converted to work with Tomcat 10.

    • Any applications still using the Javax API added after the upgrade have to be added to the $PP_HOME/tomcat/webapps-javaee directory.

Common steps in the upgrade script

The steps below are performed by the script when upgrading between each version of PoolParty from 9.4 to 9.7; you only need to verify that they were completed:

  • Replace frontendRoot

    • On the first startup of PoolParty, the script copies $PP_HOME/data/frontendRoot to $DIR_BACKUP, and deletes and recreates $PP_HOME/data/frontendRoot/default.

    • The default files are automatically recreated.

    • If you use custom LDF templates, it is advisable to replace the custom files with the new default files after the installation, and then modify the new default files, applying the same changes as the ones that were applied on the old files. You can leave your custom LDF templates as they are, but you will need to test them after the upgrade to see if they are still compatible, and might miss out on updates made to the LDF.

  • Replace ConfigPathSetup.xml

    • During the update process, the script moves $PP_HOME/config/ConfigPathSetup.xml to $DIR_BACKUP, and then recreates it.

Upgrading from PoolParty 2025 R1 (9.5) to 2025 R2 (9.6)

Starting with PoolParty 9.6, GraphSearch search user interface has been deprecated. A UI for search space administration is still available.

You can use the PoolParty Application Development Framework, which provides the same functionality and expands upon it, to replace the search user interface.

The searchdata index mappings are changed. If you have customized the Elasticsearch index mappings you will have to delete the index and restart PoolParty; no further migration will be required..

Upgrading from PoolParty 2025 R2 (9.6) to 2025 R2 (9.7)

The process is the same as upgrading from PoolParty 2025 R1 (9.5) to 2025 R1 (9.6).

In this section: