# HSQL Upgrade

## Upgrade Rationale

To address potential security vulnerabilities, we have upgraded the HSQL library from version 1.8.1 to version 2.7.2. 

As a result of this upgrade, customers will be able to set up and run batch jobs as usual after installing Harmony Suite 3.0. 

However, it's important to note that existing Harmony databases cannot be used with the new HSQL 2.7.2 due to lack of support for older database versions. Therefore, upgrading the database structure is necessary.

## Note: 

Before proceeding with the HSQLDB database upgrade, please ensure the migration of all existing Harmony Suite Batch job roles from the current Harmony\_Home/config/scrubbing folder to the latest 3.0 folder.

1. Rename the scrubbing\_pdp.xml file located in the latest 3.0 installed folder at HARMONY\_HOME/config/scrubbing to scrubbing\_pdp.xml.orig.
2. Copy the existing scrubbing\_pdp.xml file to the 3.0 HARMONY\_HOME/config/scrubbing directory.

If you are using Matching features like key generation, please ensure that you also copy any modified XML files from your HARMONY\_HOME/config/matching folder.

## Upgrade Process for Windows:

1. Ensure the latest 3.0 HSQL database is not up and running.
2. Create a backup folder containing all the three Harmony 3.0 files: harmony.data, harmony.properties and harmony.script that's available in HARMONY\_HOME/hsqldb folder.
3. Carry over existing database setups by copying the harmony.\* files from previous HARMONY\_HOME/hsqldb folder for e.g. 2.14 hsqldb folder into 3.0 hsqldb.
4. Open a command prompt.
5. Go to HARMONY\_HOME, Execute the command **upgradeDb.bat.**
6. Follow the on-screen prompts to proceed with the database upgrade process. As indicated in the screenshot, press any key, such as "Enter," to continue with the upgrade.

{% hint style="info" %}
Note : To exit, press Ctrl+C. The process will prompt the user to confirm if they wish to terminate the upgrade process.

       Type 'N' to proceed with hsqldb database upgrade.

       Type 'Y' to terminate the hsqldb database upgrade.
{% endhint %}

<figure><img src="/files/zShO08I9GiRLdjUKHwt0" alt=""><figcaption></figcaption></figure>

7. Once the upgrade process is complete.&#x20;

&#x20;At this point the hsqldb folder should contain the two files highlighted along with a backup folder for the old database files copied.

<div align="left"><figure><img src="/files/BouwNbo6sw4xIKa0yeWy" alt=""><figcaption></figcaption></figure></div>

8. Execute runServerMode.bat.

When hsqldb server is started up the user should see the right version of HSQL i.e. 2.7.2.

<figure><img src="/files/m2DfVgyf8SANc6Br9oLt" alt=""><figcaption></figcaption></figure>

9. &#x20;After successful database upgrade, you can continue using Harmony Suite 3.0 with the upgraded database. Verify the integrity of the database and ensure that all data has been successfully migrated. Verify the batch job set ups and user profiles migrated.  &#x20;

## Upgrade Process for Unix/Linux:

1. Ensure the latest 3.0 HSQL database is not up and running.
2. Carry over existing database setups by copying the harmony.\* files from previous HARMONY\_HOME/hsqldb folder for e.g. 2.14 hsqldb folder into 3.0 hsqldb.
3. Open a command prompt.
4. Go to HARMONY\_HOME, Execute the command **upgradeDb.sh**

<figure><img src="/files/pFpBaw8hvzPD91AJyRL9" alt=""><figcaption></figcaption></figure>

5. &#x20;Once the upgrade process is complete.&#x20;

&#x20;At this point the hsqldb folder should contain the two files highlighted along with a backup folder for the old database files copied.&#x20;

<figure><img src="/files/sfgLQs2NWcPzmaZtSlao" alt=""><figcaption></figcaption></figure>

6. Execute runServerMode.sh.

When hsqldb server is started up the user should see the right version of HSQL i.e. 2.7.2.

<figure><img src="/files/CDRcMA4aBHygnH1wFovH" alt=""><figcaption></figcaption></figure>

7. After successful database upgrade, you can continue using Harmony Suite 3.0 with the upgraded database. Verify the integrity of the database and ensure that all data has been successfully migrated. Verify the batch job set ups and user profiles migrated.  &#x20;


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mastersoftgroup.com/harmony-suite/user-guides/version-3.0.0/upgrades/hsql-upgrade.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.