Axon.ivy now runs with a Java 11 runtime environment:
sunclasses are no longer available
We updated many shared project libraries to a Java 11 compatible version. Be aware that more APIs could have been deprecated by these libraries which could have side effects to projects built upon them.
Many prominent Java libraries released new version for Java 11. Check your projects for custom libraries and verify its compatibility with the latest Java LTS JRE.
Known issues with third-party libraries:
PowerMock: is known to produce NoClassDefFoundErrors as it accesses jdk classes in a non-standard way. However, you can configure PowerMock to avoid loading the problematic classes by setting the
For years internal Sun API was packed and accessible through the JRE. Now these packages can no longer be imported, which leads to compile and runtime failures.
Many developers imported these classes by accident. Therefore, check your projects for compile errors and fix them to avoid runtime errors for users.
In most cases there is an equivalent replacement class available. E.g.:
sun.misc.BASE64Encoder: can be replaced by
java.util.Base64.getEncoder()which is available since Java 8.
Openjdk-11-jre's are pre-installed on many recent Linux distributions. Unfortunately as of today, with OpenJDK 11.0.4, these JREs are known to crash when using legacy AWT UIs of the Designer [see Bug #1838740]. For instance, when using the configuration editor to add new environments.
However, AdoptOpenJDK releases seem not to be touched by these issues. Therefore, a switch to these VMs is recommended to use the Designer. Execute the
installDependencies.sh script in the root of the Designer to do so.
The User Dialog widget library PrimeFaces has been upgraded from 6.1 to 7.0.
Here is a list of the most common problems we encountered or changes we had to make:
pm:) widgets you will need to replace them, the Axon.ivy Designer will underline them with a warning. These widgets were used by default in mobile and offline dialogs.
setBoldWeight()anymore. You can directly call
!importantfor relative positioning.
autoUpdateattribute was removed from outputPanel, fragment, messages and growl. Use
jQueryhas been updated from version 1.11 to 3.3. Check your jQuery code if it is still valid.
org.primefaces.context.RequestContextis now deprecated.
We included the Apache
poi-ooxml-4.1.0 libraries in the Axon.ivy Classpath. This enables you to use them in your projects to write, read and export office documents.
Projects that used POI already must remove them now and apply API migrations.
Users of the PrimeFaces dataExporter features (e.g. in Portal) no longer must copy POI libraries to the Engine web libs (
Migrate POI Projects
If you included Apache POI already in your projects, you must remove them. First remove instances of
xmlbeans libraries from your project classpath. To do so:
If you were using a POI version prior to
4.1.0 you might encounter errors in your projects that must be fixed. We faced the following changes frequently:
CellStyleEnum has been replaced by
HSSFCellStyleEnum has been replaced by
setBoldWeight()anymore. You can directly call
Adjust Engine libs
If you want to use the Excel export in the Portal or PrimeFace's dataExporter, you don't have to manually add the
poi libraries anymore.
Verify that your engine setup does not enforce a manual coping of POI libraries to
Global app.yaml revoked
You are affected by this if you have used the global application configuration
[engineDir]/configuration/app.yaml which has been introduced in 7.2.0.
The global application configuration was removed again in 7.4.0, because we think this is more confusing than helpful. Now, you must manually configure each application in its own
app-<APPNAME>.yaml. For each application there is an
app-<APPNAME>.yaml in the
configuration directory. e.g. for application MyApp there is the file
[engineDir]/configuration/app.yaml(or move it to another location for backup)
Applications from ivy.yaml
ivy.yaml which starts with the prefix
Applications were specific to applications and are no longer supported.
You are automatically affected by this change if our
[engineDir]/configuration/ivy.yaml contains any application specific configurations. This is automatically the case if you have migrated from 7.2.0 to 7.3.0.
Application configurations now have to be transfered to specific
You must manually move all application specific configurations from
[engineDir]/configuration/ivy.yaml file to the corresponding
app-<APPNAME>.yaml in the
configuration directory without the application prefix. e.g. for application MyApp there is the file
Applications: AnotherApp: EMailNotification: OnNewTasks: false DailySummaryOn: never Language: en MyApp: SecuritySystem: ADOfMyCompany
This key can be used to declare an administrator with an environment variable. We renamed it to
You might have used this environment variable to declare an administrator in your
docker-compose.yaml to create an administrator user while creating a container. If you containerized your engine and used the
IVY_ADMINISTRATOR_NAME variable, you must rename it to
IVY_ADMINISTRATOR_USERNAME in your docker-compose.yaml or your administrator user won't be created. For an example visit our docker-samples on GitHub: docker-samples
Business Calendar definitions moved to
app-<APPNAME>.yaml We moved all business calendar configurations from the system database into each application's
This is done automatically during the system database conversion. Please review the
app-<APPNAME>.yaml files after the conversion.
Due to this migration some rarely used Public API's are now deprecated and may no longer work as expected.
See the Public API documentation of these methods to find out what methods you should use instead.
In case your projects use any of the methods above we suggest you refactor those before migrating your engine.
Please note that business calendar names in the
app-<APPNAME>.yaml are case insensitive. Never use the same (case insensitive) business calendar name within the same yaml file.
CaseTemplate has been deprecated.
User Dialogs that refer it should be migrated to use
We have updated Elasticsearch from 5.5 to 7.3.
If you operate the Axon.ivy Engine with an external Elasticsearch server, you must now upgrade this instance to an Elasticsearch server in version 7.3.
After upgrading you must remove your
elasticsearch/data folder for reindexing.
The OS specific launch configuration files
bin/AxonIvyEngine.conf (Linux) and
bin/AxonIvyEngine.ilc (Windows) are now streamlined into the platform independent file
If you made any specific launch configuration in the old launcher files you need to manually migrate your settings to the new
Due to platform-independent configuration setup we no longer consider the following launch configurations:
We introduced the platform-independent
configuration/jvm.options. You must migrate the settings in your
*.conf files to the JVM settings in this file.
Windows In the
Example.ilc file you find a documentation which JVM flags are modified by each setting. You need to set these JVM flags now in the
jvm.options file accordingly.
Linux All settings in the
AxonIvyEngine.conf file can be transparently moved to the
The Axon.ivy Engine Configuration binaries have been removed. Namely
bin/AxonIvyEngineConfigC.exe and its Linux equivalent
To initially setup an Axon.ivy Engine start the normal engine binary (e.g.
bin/AxonIvyEngine.exe). The engine is then started in Demo Mode and you can use the new Setup Wizard to do the initial setup of the engine. Use the new Engine Cockpit to change the configuration of your engine after the initial setup. If the engine is misconfigured so that it no longer starts then use the new Maintenance Mode to fix configuration problems.
The Keystore and Truststore format has changed and existing stores are no longer compatible.
Default Key- and Truststore
The default store type has changed from
You are affected by this if you have installed custom certificates or private keys in
keystore.jks of the
Import keys to the new
pkcs12 store or configure Axon.ivy to use the legacy key- and truststore.
Migrate to pkcs12
Preferred solution is to use the new pkcs12 key- and trustore located in
Export the existing certificates and private keys from
truststore.jks and import them into
You can adapt this command to convert a store from
jks format into
keytool -importkeystore -srckeystore truststore.jks -destkeystore truststore.p12 -srcstoretype JKS -deststoretype PKCS12 -deststorepass changeit
If you still want to use the legacy
jks based stores you can configure Axon.ivy to accept them.
These configuration changes can be made either in
ivy.yaml or by using the Engine Cockpit.
Set store type to
jks format for the following keys:
Furthermore, keys that define a keystore path must be re-located to
configuration/truststore.jks The following keys must be adjusted:
Legacy default keystore path
The legacy default keystore path (Axon.ivy 5.0 and prior) is not supported anymore.
Rename your existing keystore file in
keystore.jks. Afterwards legacy JKS type must be enabled (see previous).
The workflow Event Log API is now deprecated and will be removed in a future version.
Since this was never Public API, most projects should not be affected.
We deprecated this API because it is customer specific and of no value for generic customers.
The API consists of the following methods, interfaces and enums: