Migrating from 12.0 to 13.1

Upgrade to 13.1 is only supported from an Axon Ivy Engine 10.0 and higher. If you have an Axon Ivy Engine older than version 10.0 you need to first migrate to a version between 10.0 and 12.0.

License

tag-ops-changed

You need to request a new license for Axon Ivy Engine 13.1.

Axon Ivy Public API Maven dependency

tag-project-auto-convert

We now include the Axon Ivy Public API as Maven dependency in the project’s pom.xml file. To do this, we update the POM by adding ivy-project-parent as parent and inserting the ivy-api dependency. This setup allows you to develop the Java part of an Axon Ivy project outside the Eclipse-based PRO Designer - for example with Visual Studio Code. The conversion only takes place if no parent is defined in the pom.xml of the project. Currently, this Maven dependency is not required if you continue developing with the Eclipse-based PRO Designer.

Multiple responsibles for a task and multiple roles for process starts

tag-project-changed

It’s now possible to assign multiple responsibles to a task. There is no need to create dynamic roles anymore. You can simply assign a task to different roles if needed. You will notice that you can configure on the task tab multiple responsibles e.g. Task Tab. The same is also true for the expiry task configuration.

All API’s have been deprecated, which handles only one responsible. They were previously named activator, therefore we have streamlined the naming to responsible from deep in the core to the user interface, everywhere. Use the new API`s:

  • ch.ivyteam.ivy.workflow.ITask.responsibles()

  • ch.ivyteam.ivy.workflow.ITask.expiry()

The same applies to process starts. It’s now possible to define multiple roles on a process start. You will notice that you can configure on the request tab of a start multiple roles e.g. Start Event.

Support for Case Scope Override removed

tag-project-removed

Case scope overriding has been deprecated in LTS 8.0 and has now been removed. Use Strict Overriding if you rely on case scope overriding.

Removal of Serenity PrimeFaces themes

tag-project-removed

We removed the Serenity themes, including the serenity-ivy theme. Please use the freya-ivy theme instead.

Removal of session role

tag-project-removed

It was possible to assign a role directly to a session. This feature was intended primarily for unauthenticated sessions. In authenticated sessions (i.e., when a user is logged in), roles can and should be assigned directly to the user. The original idea behind this feature was to support edge cases where developers implemented their own authentication mechanisms—bypassing the platform’s built-in user management—and needed to assign a role to the session manually. This was made possible via the ISession#assignRole method. Roles are now only supported for authenticated sessions backed by a user who has roles assigned, which means you now need to assign roles to a user.

Removal of Server Control Center for Windows

tag-ops-changed

The Server Control Center for Windows has been removed. Prefer using Docker for Windows to run the Axon Ivy Engine. If you still want to run the Axon Ivy Engine on Windows without Docker, you can use AxonIvyEngineService.exe to register the Axon Ivy Engine as a Windows Service.

Changed Runtime logger name

tag-ops-changed

We changed the Runtime logger name from runtime.[app name].[pm name].[category] to runtime.[security context name].[category].[app name].[pm name].

Detail

We added the security context name to the Runtime logger name and moved the category after the security context name. This is to make the logger name more unique and to be able to filter by security context name. The new logger name is: runtime.[security context name].[category].[app name].[pm name].

In case you have a custom log4j2.xml configuration, you need to adapt the occurrences of the runtime logger name in your configuration.

From something like this:

<Logger name="runtimelog.myapp.hrm.rest_client" level="DEBUG">
  <AppenderRef ref="RuntimeLog"/>
</Logger>

To something like this:

<Logger name="runtimelog.securitycontext.rest_client.myapp.hrm" level="DEBUG">
  <AppenderRef ref="RuntimeLog"/>
</Logger>

Tag Legend:

tag-ops-wizard

This migration is handled by the Migration Wizard.

tag-ops-changed

This migration will change something in the engine operation. If you are responsible for the operation of an engine, check if this change affects you.

tag-ops-deprecated

This migration highlights behaviors or features that are deprecated. That functionality will be removed soon. If you are responsible for the operation of an engine, you should check if this change affects you.

tag-ops-removed

This migration will remove a behavior or feature that has been available for the engine operation. If you are responsible for the operation of an engine, check if this change affects you.

tag-project-auto-convert

This migration is handled by the Project Conversion automatically.

tag-project-changed

This migration will change a certain behavior in the projects. If you are a project developer, check if this change affects you.

tag-project-deprecated

This migration will mark features or APIs as deprecated in projects. That functionality will be removed soon. If you are a project developer, check if this change affects you.

tag-project-removed

This migration will remove a behavior or feature of a project. If you are a project developer, check if this change affects you.