Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

The URL seems to be different

If you have any (hardcoded) link that points directly to a userview page (e.g. https://samplejoget.com/jw/web/userview/leaveApp/leaveUV//applicationInquiry) that is working in Joget Workflow v5. The same link will no longer work in v6. This is due to the upgrade of Spring framework in Joget Workflow v6.

There is double forward slash in the link. We will need to add a (userview key) value in between them (e.g. _ )

The new working link would be https://samplejoget.com/jw/web/userview/leaveApp/leaveUV/_/applicationInquiry with an extra underscore in it.

Custom CSS

If you have written any CSS before based on v5, you will need to check again to ensure a consistent look and feel across when upgraded to v6.

Check for Missing Plugin

If you have been using plugins from the marketplace, you may want to check if those custom plugins have been properly loaded into your new installation of Joget Workflow v6.

There are certain plugins that are first made available in the marketplace and have been incorporated into the official bundle of Joget Workflow v6.

These are the non-exhaustive list of plugins that are known:-

  • JDBC Load Binder
  • JDBC Store Binder
  • JDBC Form Options Binder
  • Form JSON POST Tool

Check for Plugins Compatibility

Upgrading From An Existing Joget v6 Folder

The following are the changes you need to run Joget DX if you are upgrading from Joget v6 folders:

  • Joget DX uses Glowroot for Java APM, so you need to add a new argument in the startup script, example below:
Code Block
set JAVA_OPTS=-Xmx768M -Dwflow.home=./wflow/ -javaagent:./wflow/aspectjweaver-1.8.5.jar -javaagent:./wflow/glowroot/glowroot.jar
  • Install Joget DX in a temporary folder and copy the whole content of folder "\wflow\glowroot\*" to your new Joget "\wflow\" folder.
  • Do also note the higher default maximum memory allocation pool for the JVM in @-Xmx768M@. Joget DX requires more heap space and if your server has the additional RAM, do allocate more @-Xmx@ memory for better performance.
  • Default Joget DX installation is running on @jre11.0.2@. However Joget DX can still run on Java 8.

The upgrade steps are as follows if you are upgrade to Joget DX in v6 folders:

  1. Backup your Joget v6 files and v6 database.
  2. Make the above changes in startup script and Glowroot folders.
  3. Delete ".\apache-tomcat-8.5.41\work\*" folder.
  4. Delete ".\apache-tomcat-8.5.41\webapps\jw" folder and jw.war file.
  5. Copy Joget DX @jw.war@ file into ".\apache-tomcat-8.5.41\webapps\".
  6. Edit ".\wflow\app_datasource-default.properties" to point to your existing v6 database.
  7. Start Joget Apache Tomcat and monitor the joget.log.

New Joget Installation

A second quicker solution where Joget DX is a new install:

  1. Backup your Joget v6 database or clone it for Joget DX use (Joget DX will automatically create the new tables and fields it needs).
  2. Install Joget DX in a new folder using the Windows or Linux Installer.
  3. Copy over all files from v6 ".\wflow\*" to the same folder in Joget DX.
  4. Ensure Joget DX can access the v6 database (check the "app_datasource-default.properties" settings).
  5. Edit the "./apache-tomcat-8.5.41/conf/server.xml" if you wish to run Joget DX on a different port.
  6. Edit to set a higher "-Xmx" memory setting in startup script @joget-start.bat or .sh@.
  7. Start Joget Apache Tomcat and monitor the joget.log.

Lastly, you can download and install new plugins specially for Joget DX from https://archives.joget.org/addons/ to try out.

Tip: To save time in the initial DX testing, you can delay the copying of the "./wflow/app_formuploads" folder (may have too many files) and "./wflow/app_plugins" folder (to first test Joget DX with zero custom plugin) until after everything is running smoothlyPlugins that have been working fine with Joget Workflow v5 are not always guaranteed to work with newer version. You should test it out by importing your plugins into the newer version and test them out.

Perform Cursory Test

We highly recommend that you spend some time to perform a cursory test on the Joget apps that you have created based on older versions. A quick test can quickly determine if your app is fully compatible with the new Joget Workflow v6. Be sure to check the server log also as it would generate error logs on possible missing/incompatible plugins.

Important

Starting from v6.0.15, JAVA 8 is required due to fixes for vulnerability issues of a dependent library.