Upgrading Enterprise Data Quality with Apache Tomcat

10 Upgrading Enterprise Data Quality with Apache Tomcat

These are the steps required to upgrade a Tomcat-based installation of EDQ to version 14.1.2.0.0.

Note:

Upgrades to Enterprise Data Quality with Apache Tomcat 14c (14.1.2.0.0) are supported from versions 12.2.1.4.0 and later. If you are using an earlier version, then you must upgrade to Enterprise Data Quality 12.2.1.4.0 first.

Prerequisites for these Procedures

Before you begin the upgrade, review the following prerequisites:

Oracle Database versions 19c and later are supported
Migration from PostgreSQL is not supported. You must migrate EDQ configuration schemas to Oracle first.
Java versions 17 or 21 are required

Understand the conversion from Lucene to Oracle Text for Case Management, and verify that you are ready to proceed.
If conversion to Oracle TEXT searching in Case Management has not already been performed, grant the required permissions to the EDQ configuration schema user:
```
GRANT CTXAPP TO user;
GRANT CREATE ANY JOB TO user;
```
Note:

This does not apply if you are using a Derby database.
Install new versions of Tomcat and Java.

Earlier versions of EDQ required additional configuration in the Tomcat install - for example adding additional jars to the classpath and setting some system properties. These changes are not required in 14.1.2.0.0 and the recommended approach is to install a fresh version of Tomcat. Tomcat versions 9.0.x and later are supported. Details of the install mechanism and Tomcat startup are operating system dependent and cannot be covered in detail here.
In Linux systems using systemd this is an example of a unit file which can be used to start Tomcat automatically at system boot:
```
Tomcat systemd unit file
[Unit]
Description=Apache Tomcat - instance %i
After=syslog.target network.target
 
[Service]
Type=forking
 
User=tomcat
Group=tomcat
 
WorkingDirectory=/var/tomcat/%i
 
Environment="JAVA_OPTS=-Djava.security.egd=file:///dev/urandom"
 
Environment="CATALINA_PID=/var/tomcat/%i/run/tomcat.pid"
Environment="CATALINA_BASE=/var/tomcat/%i/"
Environment="CATALINA_HOME=/opt/tomcat/"
Environment="CATALINA_OPTS=-Xmx8192M"
 
ExecStart=/opt/tomcat/bin/startup.sh
ExecStop=/opt/tomcat/bin/shutdown.sh
 
[Install]
WantedBy=multi-user.target
```
In this example the Tomcat home location is /opt/tomcat and the Tomcat base location is/var/tomcat/INSTANCE. To start an instance named edq, for example, use:
```
sudo systemd start tomcat@edq.service
```
Note:

EDQ 14.1.2.0.0 requires Java versions 17 or 21, so ensure that the new Tomcat install is configured to use either of these versions.
Install EDQ 14.1.2.0.0 as described in Installing Enterprise Data Quality.

Run the installer and select the Installation for Other Platforms option.
Upgrade the EDQ configuration schema.

Back up the EDQ schemas and then use the migration.jar tool shipped with EDQ to upgrade the configuration schema to 14.1.2.0.0.
For Oracle installs use:
```
$ java -jar migration.jar migrate oracle:#SERVICE@HOST:PORT/USER/PASSWORD
```
Replace SERVICE, HOST, PORT, USER and PASSWORD with the correct values for your Oracle schemas.

For Derby use:
```
$ java -jar migration.jar migrate 'derby:(/path/to/db)'
```
Where /path/to/db is the directory containing the Derby database files.
Deploy EDQ war file.

Copy the EDQ war file to the Tomcat webapps directory. For Tomcat version 9.0.x use edq.war. For Tomcat versions 10.1.x and later use jakartaee/edq.war.

Verify the Tomcat configuration directories.

The EDQ configuration directories used with 12.2.1.4.x can be used for 14.1.2.0.0 without any changes. There are some configuration properties which are no longer relevant and can be removed if desired:

Property	Note
launch.activemq	EDQ no longer includes an embedded ActiveMQ broker
launch.ftpserver	EDQ no longer includes an embedded FTP server
cm.filter.sql	Oracle TEXT for Case Management is used always
launchpad.mode	Support for Java WebStart has been removed and the EDQ launcher application is used always
adf.headerextra	ADF was removed in EDQ 12.2.1.4.1

Note:

Ensure that Tomcat is configured with the correct path to the home and local configuration directories. This can be done by setting the EDQ_CONFIG_PATH environment variable in the systemd unit file shown above or by setting the edq.config.path system property. This can be done by creating a setenv.sh script in the Tomcat bin directory.

Install the EDQ launcher application.

EDQ 14.1.2.0.0 does not use Java WebStart to launch the client applications. A new EDQ launcher application must be installed on client systems. This application can be downloaded from the link at the bottom right of the EDQ launchpad. Versions for Windows, Mac, Intel Linux .rpm and Intel Linux .deb are available.

Note:

Versions of the Launcher shipped with EDQ 12.2.1.4.x are supported but it is recommended to update to the version shipped with 14.1.2.0.0.
Clean up the Lucene index directories.

EDQ 14c (14.1.2.0.0) does not use Lucene for Case Management filter execution. After the upgrade is complete the Lucene index directories can be deleted from the file system. The default location for these indexes is localhome/casemanagement/indexes.