Upgrading to Joget DX 8

If you are already using an older version of Joget, such as V5, V6, or DX 7, It's possible to upgrade it to the newest Joget DX 8. There are three options to do so:

• Install Joget DX 8 in my existing installation folder
• Install Joget DX 8 in a new folder with an existing database
• Run a fresh installation of Joget DX 8

This page will provide step-by-step guides on performing the upgrade using the above options.

For more information about the newest version of Joget, see What's New in Joget DX 8 and Download Joget DX 8 from https://www.joget.org/download/.

Changes in Joget DX installation files

If you are using Joget V5 or Joget V6, please read the following changes that were introduced in Joget DX 7 and 8:

• Joget DX uses Glowroot for Application Performance Management thus, a new -javaagent argument is needed in the startup joget-start.bat or .sh script. See the example below: 

  set JAVA_OPTS=-Xmx768M -Dwflow.home=./wflow/ -javaagent:./wflow/aspectjweaver-1.8.5.jar -javaagent:./wflow/glowroot/glowroot.jar

• Joget DX has new runtime Glowroot files in .\wflow\glowroot\. The new Application Performance Management feature in uses the Glowroot runtime. You can retrieve these files from a fresh install of Joget DX 8.
• Joget DX has a higher default maximum memory allocation pool for the JVM in -Xmx768M. Joget DX requires more Java heap space, and if your server has additional RAM, allocate more -Xmx@ memory for better performance.
• Joget DX 8 installation is running on apache-tomcat-9.0.71.
• Joget DX installation is running on Java jre11.0.18.

Run Joget DX 8 in my existing v5-v7 folder 

You can install Joget DX 8 in the folder of your current Joget version. Follow the steps below:

1. First, Back up your current Joget installation files and database.
2. Download Joget DX 8 from Joget's Website and install it in a new folder using the Windows or Linux Installer. We will copy some files from here to your current Joget folders.
3. Add the changes described in the previous section in the startup script.
   1. Add the new -javaagent argument and -Xmx value.
   2. Copy in the Glowroot files to .\wflow\glowroot\ (Only if you are upgrading from V5 or V6).
4. Delete all the files in .\work and .\apache-tomcat-9.x.x folders. These are cache files and can be safely deleted.
5. Delete the .\jw and .\jwdesigner folders in .\apache-tomcat-9.x.x\webapps . Joget will re-create the /jw folder on startup.
6. Delete the older jw.war and jwdesigner.war files.
7. Copy Joget DX 8 jw.war file into .\apache-tomcat-9.x.x\webapps\ folder. The source jw.war file is in the same path as in v5-v7.
8. If necessary, edit the configuration file .\wflow\app_datasource-default.properties to your existing v5-v7 database.
9. In Joget DX 8 folder, go to apache-tomcat-9.x.x\webapps\jw\WEB-INF\classes\setup\sql and open your respective database type (jwdb-mysql.sql)
10. Find and run the following CREATE TABLE statements from the respective SQL script in your current database:

• • wf_process_link_history
  • wf_history_process
    

Now you can start Joget Apache Tomcat and monitor the joget.log and catalina.log for errors. After these steps, your Joget is upgraded to DX 8 and stays in the same folder as your previous Joget installation.

Run Joget DX 8 in a new folder with an existing database

A second quicker option where Joget DX 8 is done in a new installation folder but using the existing database. Follow the steps below:

1. First, back up your Joget v5, v6, or DX 7 database or clone it for Joget DX 8 use (Joget DX 8 will automatically create the new tables and fields it needs).
2. Download Joget DX 8 from Joget's Website and install it in a new folder using the Windows or Linux Installer.
3. Copy all files from your V5, V6, or DX 7 .\wflow\* folder to the same one in Joget DX 8.
4. Ensure Joget DX 8 can access your current database (check the database settings in the app_datasource-default.properties file using a text editor).

5. Edit the joget-start.bat or .sh file using a text editor to set a higher -Xmx memory for better performance.

Now you can start Joget Apache Tomcat and monitor the joget.log and catalina.log For errors. After these steps, your Joget is upgraded to DX 8 in a new folder but still using the previous database.

Run Joget DX 8 in a new folder and use the default new database

This is the fastest upgrade option, especially for a development server. Follow the steps below:

1. Download Joget DX 8 from Joget's Website and install it in a new folder using the Windows or Linux Installer.
2. Run the installer if you are using Windows or unzip the joget-enterprise-setup-8.0.x.tar.gz if you are using Linux.
3. Follow the on-screen installer prompt if you are on Windows.
4. Click on joget-start.bat or joget-start.sh to start Joget DX 8.
5. In your browser, type in the URL address http://localhost:8080/jw to run Joget DX 8.
6. Export all the apps from V5/V6 and import them into Joget DX 8.

Once finished, your Joget is upgraded to DX 8 with a new database and the apps of your previous Joget installation.

Post installation notes

Use this guide Troubleshooting - Common Errors to learn how to solve start up errors in your Joget DX 8.

Download and install new plugins specially for Joget DX 7-DX 8 from https://archives.joget.org/addons/ and https://marketplace.joget.com/ to try out:

• Process Enhancement Plugin
• Report Builder
• API Builder

To save time in the initial DX 8 testing, you can delay the copying of the ./wflow/app_formuploads folder (may be too many files) and ./wflow/app_plugins folder (to first test Joget DX with zero custom plugin) until after everything is running smoothly.

Additional documentation

General upgrade flow

1. Prepare a test server that mimics the production server as close as possible in all possible aspects (e.g. user setup, networking environment, cpu/memory capabilities, database) without cloning the production's database server. Start with a fresh new database.
2. Once you are ready with the test server, you may try to start with a fresh database without the data but just the Apps loaded in. Run through all the functionalities of your Apps to see if everything works as expected.
3. If Step 2 goes well, you may then try to clone the existing production database to see how your Apps fare with the existing production data. Run through all the functionalities of your Apps again to see if everything works as expected.
4. If you have integrated Joget Workflow with other solutions, you will also need to test them accordingly.
5. When you are ready, please continue to the next step.

DX 8 database table changes over DX 7

These are the new tables that will be automatically created upon initial start-up of Joget DX 8 over the existing database used by Joget DX 7:

1. wf_history_activity
2. wf_history_process
3. wf_process_link_history

In the unlikely case that you need to create the tables manually, you can locate the CREATE script in exploded jw.war file at /jw/WEB-INF/classes/setup/sql/.

For MySQL database, if you are setting it over a new database using the Set Up Database wizard, the default collate is now utf8mb4_unicode_ci instead of utf8_unicode_ci in Joget DX 7.

-Dwflow.collationChecking=false

Upgrading Joget DX 8 using jw.war

1. Locate the new jw.war file from either the:
   1. Downloadable Installers (in the /apache-tomcat-x.x.x/webapps directory); or 
   2. The Enterprise Support Site for Enterprise Software Subscribers.
2. Stop Apache Tomcat / Joget.
3. Backup the existing installation data (See Deployment Best Practices)
4. Delete the existing jw.war file and jw folder in [Joget Installation Directory]/apache-tomcat-x.x.x/webapps. 
5. Delete the Apache Tomcat working directories i.e. the jw folder in "[Joget Root]/apache-tomcat-x.x.x/work/Catalina/localhost".
6. Copy the new jw.war file into the Apache Tomcat webapps directory [Joget Root]/apache-tomcat-x.x.x/webapps/.
7. Delete the temp \jw and \work folders before running the new jw.war.
8. Start Apache Tomcat / Joget Workflow.

Transitioning from Professional to Enterprise edition

Joget DX Professional Edition will no longer be available starting October 2024. This decision was made to streamline Joget product lineup and focus Joget efforts on delivering the best possible solutions to meet the evolving needs of our customers and partners.

This step will guide you to transition from Professional to Enterprise Edition

Follow through this steps:

1. Update Joget.
2. Run the Enterprise version to get the system key, and apply for a new license.
3. Head over here on acquiring New License