This page contains information you should be aware of when upgrading to Magnolia 6.2.x from any previous and currently supported version. Before starting the upgrade process, we recommend you read:
- Release notes for the version you are updating to as well as for all intermediate versions.
- Certified stack
If you are migrating from a Magnolia release which has already reached end of life, please contact us for migration support.
What to update
- Advanced Cache 2.3
- Backup 2.4
- Barebones Tomcat Bundle 1.2
- Blossom 3.3.1
- Cache 5.9.0
- Campaign Publisher 1.3.2
- Categorization 2.7.1
- Community Edition 6.2
- Contacts App 1.8
- Content Dependencies 2.0
- Content Editor 1.3.3
- Content Tags 2.0
- Content Translation Support 2.4.2
- Content Types 1.1.1
- DAM 3.0
- Definitions App 2.1
- Demo Projects 1.5
- Diff 2.2
- DX Core 6.2
- External Forms 1.5.1
- Freemarker Templating Samples 6.0.2
- Groovy 3.0
- Icons 22
- Language Bundles 1.1
- Machine Learning 1.2
- Magnolia 6.2
- Mail 5.5.3
- Marketing Tags Manager 1.4.3
- Multisite 2.1
- Observation 2.2
- Pages 6.2
- Password Manager 1.2.3
- Periscope 1.2
- Personalization 2.0
- Privacy 2.0
- Public User Registration 2.7.3
- Publishing 1.2
- Publishing Transactional 1.0.5
- Resources 3.0
- REST Client 2.0
- REST Client UI 1.0
- REST Framework 2.2
- RSS Aggregator 2.6.3
- Scheduler 2.3.3
- Site 1.2.4
- SiteMesh 1.2
- Soft Locking 3.0
- Task Management 1.2.7
- Third-party library BOM 6.2
- UI 6.2
- Usage Metrics 1.1
- Vaadin Compatibility Addons 1.3.3
- Workflow 6.0
When upgrading Magnolia, it is always worth comparing your
magnolia.properties file with the one from the newly released Magnolia bundles. Below are the latest versions of the
magnolia.properties files for Magnolia 6.2.
Magnolia CEMagnolia DX Core
If you use Apache Tomcat, note that we have upgraded to version 9.0.31. We recommend this update since it fixes some possible security vulnerabilities.
If you use another servlet container, check out the certified stack for supported versions.
Server configuration with relaxedQueryChars
Tomcat 9 has become less tolerant of special characters when compared to some of its previous versions. To bring back support for special characters as it was in Tomcat 8 (for instance, to query the
delivery endpoint API with filters), we have added the characters
| to the
relaxedQueryChars attribute on the
Connector element in the
server.xml configuration file.
All changes in third-party libraries are managed via the BOM for third-party libraries . If you manage your bundles via Maven using the BOM, all updates will be handled automatically. Among the most notable third-party library updates in the Magnolia 6.2 release are:
- Vaadin 8.9.4
- Guava 28.2-jre
- Tika 1.23
- Jackrabbit 2.20.0
- Ehcache 3.7.1
Note: Due to an incompatibility issue, the items that remain on disk will be deleted after updating.
How to upgrade
You should be able to upgrade to the latest release in the Magnolia 6 branch directly from any previous Magnolia release that has not reached end of life. Only if you have UI or style customizations, we recommend that you first upgrade to the latest release in the Magnolia 5 branch and then to the latest release in the Magnolia 6 branch. For example: 5.6.8 → 5.7.7 → 6.2.
- Update all external libraries required by the Magnolia release to which you intend to upgrade.
- Because the upgrade process takes time and is vulnerable to incidents, we recommend you minimize the risk by cleaning up your system, removing unused data, reindexing everything and doing a full backup first.
Once Magnolia is running, check the Definitions app for deprecated or problematic definitions.
Migrating to the new 6 UI framework
The UI in Magnolia 6.2 comes with a number of changes and new implementations. For their impact and more details, see Changes in Magnolia 6 UI.
Automatic conversions and the compatibility layer
To provide a smooth transition from Magnolia 5 UI to Magnolia 6 UI, the 6.2.x comes with the compatibility layer ItemProviderStrategy (
magnolia-ui-framework-compatibility), introduced to make the old 5 UI definitions work in the new 6 UI framework.
- Start by using the compatibility layer. It will try to convert the fields and forms on-the-fly to the effect that:
- The old dialog definitions can be referenced by actions of the updated apps and attempts will be made to convert the definitions on the fly.
The old 5 UI apps can still be used.
Note: The 5 UI and 6 UI app definitions differ considerably. Compare, for example, the following definition snippets of the Contacts app, including the Add contact action definition:Click to see the definition snippet in 5 UI.Click to see the definition snippet in 6 UI.
Then, convert the old definitions if you want to get rid of all deprecated code or to get the benefits of the new 6 UI features such as:
- Column filtering.
- Default Cancel and Save actions.
- IUX slots.
- Vaadin 8 with simplified data binding.
- Improved UI composition patterns.
- Sharing state with UI component context.
For example, see the following dialog and its 5 UI and 6 UI configurations:
Click here to see the definition in 5 UI.Click here to see the definition in 6 UI.
Migrating fields and field validators
A number of field converters have been introduced since the release of Magnolia 6.2. For more details, see the Field converters page.
Migrating the definitions or using definition converters?
There is no simple answer to this question. It depends on a situation. Using definition converters can be considered a short-term remedy for the move from the old UI framework to 6 UI.
Definition converters that we ship do not migrate everything. The converters just adapt the old definitions to the new format at runtime.
Converters won't work on custom fields and custom validators, which you must migrate to Magnolia 6 UI.
Migrating field transformers
The Magnolia 5 UI field transformer classes no longer exist in the Magnolia 6 UI framework. Their functionality has been replaced by the
ItemProviderStrategy interface. For details, see Magnolia 6 UI ports of 5 UI field transformer classes.
Migrating custom modules
If you have custom modules that rely on the previous UI modules:
- Pre-built JAR files of your custom modules will be binary compatible with Magnolia 6.x. You can add them to your
WEB-INF/libsfolder without further changes.
- If you want to compile and rebuild your custom modules:
The composition of submodules of the UI project has changed, and some submodules have been removed.
Several of the stock Magnolia apps have already been migrated to the 6 UI. Many of the legacy 5 UI apps have been moved to the
-compatibilitymodules, for example
Migrating content type based definitions
In Magnolia 6.2.x, the
!content-type directive generates a Magnolia 6 UI app. This means that any overriding or decoration of a content-type based app needs to be updated to match the 6 UI. As an alternative, you can use the new
!content-type-m5 directive, which generates a 5 UI app.
In this case, the app will be interpreted as a 5 UI app and you don't have to update its descriptor to conform to the 6 UI definition.
Upgrading customized Pages and Assets apps
With the 6.2 release, the Pages and Assets apps have been migrated to the 6 UI framework. If in code you refer to any of these apps through app ID, be aware that under 6 UI, the ID is different.
|App name||5 UI ID||6 UI ID|
Due to module dependencies, most of the old 5 UI apps are still included in our webapps but are hidden in the UI. They are now part of the
/modules/ui-admincentral/config/appLauncherLayout/hiddenApps group. An exception is the 5 UI Pages app, which has been removed from the CE webapps. To bring it back to a CE webapp, you need to add
magnolia-pages-app-compatibility to your webapp project.
Restoring the legacy 5 UI apps for authors
If you wish to let the editors use the old 5 UI apps instead of the new ones, the most straightforward procedure is:
- In the Configuration app, go to
- Go to
- Delete the
Restoring the legacy 5 UI apps during migration development
If you need to use the legacy apps during migration development, often side-by-side with the new 6 UI apps, consider some of these options:
- Configure a role based setup.
- Rename or decorate an app with a different label. See Changing the title and icon of an app.
- Reconfigure the App launcher layout of groups through
/modules/ui-admincentral/config/appLauncherLayout/groups. For example, add a new Edit group for the legacy apps:
Changes in the REST Client module
As of REST Client module version 2.0, released with Magnolia 6.2, the Magnolia RESTEasy Client module (
magnolia-resteasy-client) has been deprecated and merged into the Magnolia REST Client module. A relocation is in place which relocates
magnolia-resteasy-client to the
magnolia-rest-client module, see https://git.magnolia-cms.com/projects/MODULES/repos/rest-client/browse/magnolia-resteasy-client-maven-relocate/pom.xml.
If your projects have a dependency to
magnolia-resteasy-client, we recommend that you:
- Either update and rebuild the projects without the dependency.
- Or add an older version of the dependency.
Additionally in this version of the module,
ClientServiceDefinition has been deprecated as well and
ProxyDefinition should be used instead.
push in AdminCentral
push functionality is now provided in AdminCentral. For this to work, you must update your
WEB-INF/web.xml file. It must declare async support on Magnolia's main filter.
Since Magnolia does not support
push operations over WebSockets, you must also add the following new context parameters:
Solr module needs an additional dependency
If you are migrating from Magnolia 5.x and you are using the Solr module, you need to add the following dependency to your bundle:
Upgrading Maven-managed webapps
In this section, we assume that you use Maven to manage your (custom) webapp. How you do this depends on how you have organized your POM files.
Upgrading the versions of inherited BOM files
The most typical use case is that your custom webapp is based on one of Magnolia's preconfigured webapps. The structure of the Maven project that manages your webapp may look like this:Line 3:
custom-project/custom-project-webapp/pom.xmlis the POM file of your custom webapp.
custom-project/pom.xml is the parent POM file of your custom webapp. This file manages the dependencies and their versions.
Note that the parent POM (
custom-project/pom.xml) manages all versions for Magnolia modules as well as for third-party libraries. It imports
info.magnolia.dx:magnolia-dx-core-parent, which manages Magnolia Enterprise module versions and imports the following:
info.magnolia.bundle:magnolia-bundle-parentto manage Magnolia CE module versions.
info.magnolia.boms:magnolia-external-dependenciesto manage third-party library versions.
If the POM files for your custom webapp are organized as shown in this example, you will only need to change one property. In the
<properties> tag of your parent POM, change the version of the
magnoliaBundleVersionto your required version. That is all you need to change in the POM files of your webapp.
Checking the Maven dependency tree
Regardless of how your Maven project is organized, building the Maven dependency tree helps you analyze the versions of all the Magnolia modules and all the third-party libraries of your custom webapp.
Open a shell, go to the directory of your webapp and execute the Maven command for the dependency tree:
- Stop the application server.
- Extract the new Magnolia bundle.
- Replace the JAR files in the
WEB-INF/libfolder of your old Magnolia instances with the new ones from the bundle.
Magnolia 6.2 updates numerous third-party libraries.
- Remove any module JARs you previously removed from your instances. Add any modules you previously added.
- Add new Magnolia modules.
- Optional: delete all indexes to give them a boost. Delete the
indexfolder under each workspace directory:
repositories/magnolia/workspaces/<workspace>/index. Indexes are re-created on startup, which might take a while depending on the size of your repository.
- If you customized your
magnolia.propertiesfile, compare the changes to the file in the new bundle. Properties may have been added or removed.
- Read the release notes for all intermediate versions for any additional update tasks. See the Releases page.
- Restart the application server.
- In your browser, go to the Magnolia instances and run the web update.
See the Known issues page.