Skip to main content

Upgrade PoolParty 9.2.0 to PoolParty 9.2.1 on Microsoft Windows

Prerequisites

The following requirements have to be satisfied before you can upgrade your PoolParty installation running on a Microsoft Windows system:

  • you are running a 64-bit Windows Server 2016 or 2019

  • you have a valid PoolParty license for the version you want to upgrade to

  • OpenJDK 17 installed

  • If you have no OpenJDK installed, then install OpenJDK 17 and correctly configure JAVA_HOME; To validate that your installation is successful, enter on the command line echo %JAVA_HOME% to display the Java version ( C:\jdk17 ), then enter %JAVA_HOME%\bin\java -version which then returns all the JDK version details.

pp9_2_win-3.png

  • the PoolParty installer (poolparty.zip) which can be downloaded from our download area

  • you already run a full backup of your existing PoolParty installation (both system and data)

Note

You will have to incrementally upgrade your installation including minor releases. For instance, if you are currently running an 8.0 PoolParty version on your system, you will have to upgrade to PoolParty 8.1, then to 9.0 and then to 9.1.

Note

In this description we assume that you want to upgrade a PoolParty version installed in the default installation directory: C:\opt\poolparty. If your PoolParty is installed in a different directory you will have to correspondingly adjust the paths during the upgrade process.

PoolParty requires OpenJDK 17 to run.

Keycloak

PoolParty comes with Keycloak as an authentication and authorization service. A relational database is recommended to run Keycloak. Keycloak comes with H2 as an embedded database.

Tip

PoolParty 9.2.1 installation includes Keycloak version 22.0.5.

Important

In accordance with the Keycloak documentation, we recommend using a proper database service instead of the default database Keycloak comes with. For more information on how to migrate to a proper database service, refer to the Keycloak documentation,

Upgrade

Tip

The subsequent steps require administrator rights. You can carry these either on the Command Prompt and/or using the SC management console.

To upgrade PoolParty for Windows, do the following:

  1. Stop the Apache Tomcat, Keycloak and Solr services. To do so either call up the management console services.mcs or enter the following commands on the Command Prompt: sc stop keycloak, sc stop SolrPoolParty, sc stop pptomcat9.

  2. Now set the Startup type of these services to Manual and reboot your Windows server to make sure that none of these services are running.

  3. Create a temporary folder in your PoolParty folder: C:\opt\poolparty\tmp (or <yourdrive>poolparty-installation\tmp)

  4. Extract the contents of the poolparty.zip archive to this temporary folder: C:\opt\poolparty\tmp (or <yourdrive>poolparty-installation\tmp)

  5. Open Command Prompt in the Run as administrator mode and navigate to the C:\opt\poolparty\tmp\bin directory (or <yourdrive>poolparty-installation\tmp\bin).

  6. Run upgrade_poolparty.ps1 file.

  7. Start services.

    1. Open the management console services.msc and navigate to the PoolParty Services.

    2. Start the PoolParty Tomcat, Solr and Keycloak services either using the management console or Command Prompt: sc start keycloak, sc start SolrPoolParty, sc start pptomcat9

    3. Now set the Startup type of these services back to Automatic to make sure that they will be always restarted whenever the Windows server is rebooted.

Screenshot_from_2022-10-24_10-38-11.png
Post-Upgrade Tasks
Provide GraphDB Licenses

If you want to use GraphDB add a valid grahpdb.oem.license file to the <PoolPartyHome>\config\licenses folder.

Clear browser cache

You have to clear your browser cache after the upgrade as changes to the CSS and other dynamic content used in the PoolParty UI have been done.

Run Post Update Scripts

Upgrade from version 8.1.x to 9.0 requires running a post-installation PoolParty migration script; this script is not required for upgrades from version 9.0 or higher.

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

The script lists all updates that will 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 has been finished an overview of the migration steps per project is provided.

For more information, refer to Migrate Data From PoolParty 8 or Higher to 9.0 or Higher.Migrate Data From PoolParty 8 or Higher to 9.0 or Higher

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.

For more information, refer to:

In this section: