Back to home

Knowledge Base

Architecture, Security & Releases

OvalEdge Migration Process

Release6.3.4.2 Migration Process for VM Model

This document provides guidance on migrating from previous versions to the latest Release6.3.4.2 version.

Prerequisites for Migration

Before initiating the migration process, ensure that the following prerequisites are met:

Supporting Application Configurations

Upgrade Infrastructure (Optional)

Ensure that the applications and the operating system support the upgraded amount of RAM and have sufficient space on the new SSD for optimal performance.
Application Migration from 6.3.3 to 6.3.4.2

This document outlines the step-by-step procedure for upgrading OvalEdge application from 6.3.3 to 6.4.3.2

Please follow the instructions below to perform a successful upgrade:

Step 1: Stop Tomcat

Before initiating the upgrade process, it is crucial to take the backup of the database, Run pre migration scripts in MySQL/Mariadb to check row count and database size.

Note: Make sure software tools are upgraded first

Step 2: Copy the War File

After stopping Tomcat, copy the war file link provided by the OvalEdge team. This war file contains the necessary Migration scripts, to migrate the application to 6.3.4.2.

Step 3: Deploy the War File

Proceed to deploy the copied war file by following your standard deployment procedures.

Step 4: Liquibase Migration

Once the war file has been successfully deployed,start the tomcat, the Liquibase migration process will automatically be triggered. Liquibase will handle the necessary database schema changes and updates to ensure compatibility with latest tools.

Step 5: Validate the Application

Once Migration scripts are completed, check the application, it should be up and running. Validate the connectors for confirmation.

Step 6: Post Migration scripts

Finally, connect to the database and run the post-migration activities, i.e., row count and database size checks.
Upgrade Database Version
Upgrade the database to the below-mentioned versions for software performance and security. The previous versions of MySQL are no longer supported.

Upgrade MySQL Version to 8.0.36 or higher. For more information, refer to

Upgrade MariaDB Version to 10.6.16+ or 10.11.6+.

Pre Upgradation

Take Database Backup

Ensure a comprehensive backup of the Database (MySQL or MariaDB) is taken.

Please take a look at the following document for backup instructions.

OvalEdgeDB Backup Process

Table Row Count Validation

Validate the row count of all database entities to confirm the success of the migration process.

Detailed instructions are available in the provided document.

DB Migration Checklist

Externalizing oasis.properties

Externalizing oasis.properties on Windows involves configuring Tomcat as a service to enable external accessibility.
For more information, refer to the document below:
Externalizing Oasis Properties for Tomcat in Windows.
Externalizing oasis.properties on Linux: On Linux, the externalization of oasis.properties requires a strategic approach to key settings.
For more information, refer to the document below:
Externalizing Oasis Properties for Tomcat on Linux.

Externalizing log4j.properties

Externalizing of log4j.properties is mandatory to overcome the logs writing into Catalina. For some of the customers, the space accumulates in the Tomcat folder.

Refer to the document for detailed steps on Externalizing log4j.properties

Upgrade or Install ElasticSearch

Upgrade ElasticSearch to 7.17.x for improved search capabilities within the OvalEdge. Refer to the document for more information.

Upgrade Java Version (optional)

It is recommended that Java be upgraded to version 8U_422 for optimal performance and compatibility.

For more information, refer to Upgrading Java on Windows

Upgrade Tomcat Service Version

It is recommended that Tomcat be upgraded to version 9.0.x.

For more information, refer to

Upgrading Tomcat from 9.0.x to 9.0.98 with Step-by-Step Instructions.

Application Backups

Before commencing the migration, execute the following backup and validation procedures:

Take Application War, and Jars Backup

Take a backup of War files from Apache Tomcat > Webapps and Jars (csp libs). This step is critical to safeguard against any potential disruptions during the migration process.

Take a Backup of the Shared NFS Folder

Take a backup of the files present in the shared NFS repository.

Tomcat Server Backup & Preparation

Take a backup of the Tomcat server. Clearing these folders helps create a clean environment for the upcoming migration, minimizing the risk of conflicts. In the Tomcat server, empty the following folders:

Webapps folder
Temp folders (excluding Jar files). Please ensure that jar files are not removed by accident.
Logs folders

System Settings Backup

Take the backup of the system settings table from the OvalEdge database in XLSX format to ensure the configured default settings are available to reflect in the new version.

For detailed instructions on taking table backups to CSV/XLSX, refer to the MySQL Table Backup to CSV/XLSX Guide

Migration Process

For VM, the migration process involves downloading release artifacts links provided in the email. The procedure involves sequential tasks, such as downloading the war from the given link, configuring oasis.properties, and running the Tomcat service to reflect the latest changes. Furthermore, executing advanced jobs is necessary to observe the latest changes specific to certain functionalities.

War Replacement

Download the war files from the provided email link.
Once downloaded, go to the Tomcat directory, find the "Webapps'' folder, and copy the downloaded latest war file.
This ensures the integration of the latest functionalities, improvements, and gap resolutions addressed in Release6.3.4.2 so that the OvalEdge application can function properly.

Connectors & Lineage/Jars Upgrade

Download the Jar files using the link provided in the email.
Replace the existing csplib / jars within the External Jars Directory > third_party_jars.
1. Ensure that the csp library (csp-lib-6.3.4.2-RELEASE-with-dependencies.jar) for standard connectors is updated.
2. Ensure that the “oe-lineage.jar” is updated.
3. Update the csp library for big data connectors (client specific)

Advanced Job/Jars

Download the Jar files using the link provided in the email.
Replace the existing csplib / jars within the External Jars Directory > third_party_jars.
Ensure that the “oe-advancejob.jar” is updated.

Setting oasis.properties in Tomcat

Within the VM, users can customize the oasis.properties in the External Property Directory file to meet their specific requirements, including database connectivity, security, authentication (SSO), Elasticsearch, management of external dependencies, and configuration storage in key vaults.

Governance App Configurations

These configurations are crucial to redirect users to governance-related applications using email or direct links. Refer to the document to configure the Governance application. Governance App Configuration

Tomcat Service Restart

Restart the Tomcat services to apply and update the changes and initiate the migration successfully.

Post Migration Checks

Tables & Row Count Validation

Conduct a thorough verification of data row counts in the post-migration environment.

Ensure that the actual counts match the pre-upgradation counts to identify and rectify discrepancies. This will serve as a key indicator of a successful migration.

The SQL scripts can be used to validate row and table counts.

Download the scripts from the following S3 link: Tables and Row Count Validation Scripts.

Verify Application

Verify that the latest enhancements and features are successfully deployed in the application post-migration.

Verify Data Row Counts

Conduct a thorough verification of data row counts in the post-migration environment.

Ensure that the actual counts match the pre-migration counts to identify and rectify any discrepancies. This is a key indicator of a successful migration.