Breaking Changes
This page gives an overview over breaking changes that come with this release. Just click on the links to get more details.
Please read carefully and plan/manage the necessary todos to ensure that the application and all its extensions still work as expected.
Server oriented
OMN6 migration liquibase error keyword link [OMN-11159]
Problem: KEYWORD_LINK entries with FK_STORAGE_ELEMENT_META_GUID values that do not exist in STORAGE_ELEMENT table
-
before the update, there was no foreign key on the FK_STORAGE_ELEMENT_META_GUID column, so entries without an existing STORAGE_ELEMENT entry were allowed
-
the update implemented the foreign key, but without checking for existing entries, so it can fail if any exist
-
To prevent that this error occures, such entries must have to be deleted before updating via DB call
DELETE FROM keyword_link WHERE id IN ( SELECT kl.id FROM keyword_link kl left JOIN storage_element se ON kl.FK_STORAGE_ELEMENT_META_GUID = se.FK_META_TAG_GUID WHERE se.id IS NULL);
OMN6 migration liquibase error storage element [OMN-11160]
Problem: STORAGE_ELEMENT entries with FILE_NAME values which have more than 16 characters behind the last dot
-
there are some system files without extensions, but because they are hidden (dot in front of filename) this logic uses the whole name
-
these files are not critical for the customer, as they are some old/broken system files not shown in MAM
-
-
the limit of 16 characters can lead to errors in these cases
-
To prevent that this error occures, such entries must have to be deleted before updating via DB call
DELETE FROM storage_element
WHERE length(substring(file_name, LENGTH(file_name) - strpos(reverse(file_name), '.') + 2)) > 16
AND discriminator NOT IN ('DIR', 'PRD', 'RND');
UI-ConfigClient oriented
Modules - Plugin Instances - Function - Import of Plugins [OUCC-271]
It is not possible to import multiple plugin instances at once. Referenced plugin instances that are contained in the uploaded plugin must be checked for their identifiers (must have the same name as the corresponding plugin instances on the system) so that they work correctly.
Data - Generic Configuration - Generic Configuration overview - Function - Import generic configuration [OUCC-1295]
When importing the Generic Configuration XML, all existing configurations on the system are overwritten. Multiple import strategies (overwrite, only add new, import all,…) are currently not supported.
OMN Workflow and Integrations oriented
Update Camunda Version to 7.20 [OW-881]
The Camunda BPM Platform has been updated from 7.16 (since OMN Component release 5.9.0) to the latest available version 7.20.
Reason
-
Keep in sync with the Camunda BPM Platform
-
Profit from the latest features and improvements
-
Receive Bug-Fixes
-
Minimize migration cost between OMN Component releases
-
Support of PostgreSQL 15.x (Same version as OMN)
For more details about the new features in Camunda version 7.20 please refer to Camunda 7 Docs.
Migration Steps
The underlying database will not be updated automatically to the latest schema version and needs to be either migrated manually or set up from scratch. The Camunda database can be migrated by running the DBMS-specific SQL-Scripts provided by Camunda for the used DBMS.
WARNING:
Make sure to back up the database before running the migration scripts! For postgreSQL databases (which is commonly used in the apollon environment) the following SQL-Script can be used.
-
When updating Camunda from 7.16 to 7.20 (OMN >= 5.9.0) please run: update_camunda_7_20.sql
-
When updating from an older version (OMN < 5.9.0) please refer to the migration guide to Camunda 7.16
-
For other DBMS please refer to the official Camunda Migration Guide.
Alternative: Delete and Create The DB From Scratch (for dev- or test systems)
CAUTION:
All data will be lost using this method! If you are not 100% sure, execute the manual DB Migration instead.
In the case Camunda is not running in a production environment and the existing data can be removed, you might want to delete the entire DB (Container), its data volume / volume mounts on the host system and create a new DB from scratch.
docker-compose will create a new database in the correct version.
Update PostgreSQL from 13.x to 15.x
-
With the latest version of the WFL-Extensions, the old PostgreSQL-Container needs to be replaced by a newer Version.
-
Please consult DevOps in oder to migrate from PostgreSQL 13 to 15.
Note
-
History Time-To-Live now required for new Deployments:
-
For each new BPMN deployment a Time-To-Live must be set, otherwise the Camunda engine won’t accept the deplyoment
-
The Time-To-Live defines the amount of days until a finished process is deleted from the Camunda database.
-
Default value = 180 Days
-
-
JDK8 support has been dropped
EAI/Core-API oriented
Pim2_peo_project order_number should be exported [XR-1263]
The "nodes" tag has been completely removed from the XSD and replaced with the "links" tag in the "peo" tag. This means that implementations regarding Peo links need to be adjusted in all projects. Additionally, the logic has been expanded to include the order number of a PEO on the channel, which can now be output or specified.
Persist Keywords on Asset [XR-1263]
a new EAI Import format is available
The old format is deprecated and won’t work on newer dependencies or in the Core API persist/assets endpoints.
Add Java implementation for XML to CSV transformation for= AssetType [XR-1275]
Enumeration attributes are now handled as MULTI_LOC_DOMAIN (in case it is language dependend) or MULTI_DOMAIN.
Path attribute was added to the asset type element. In addition all asset type objects will now have the rnc and path. Before, the value was only always available in the meta type section.
To have the possibility to work with old implementation, a fallback is introduced which try to look for the values inside meta type (rnc and path can be required in some cases).