Upgrade 16.1 to 16.2

Overview

This guide describes how to upgrade a Bloomreach Content project from version 16.1.x to 16.2.y.

Notable Changes in 16.2

• The Content perspective now provides an improved referring documents dialog. It displays both documents that refer to the current document, as well as content referenced by the document and channel references.
• The Universal Pixel Integration plugin has been removed.
• Several core libraries have been updated, including Spring Boot 3.4, Spring 6.2, Wicket 10.3, Jackson 2.18, Gson 2.11, and others.
• The unmaintained net.sf.json-lib:json-lib library has been removed and replaced with org.json:json.
• Hippo CKEditor 4 has been updated. Community projects now use version 4.22.1-h1, and Enterprise projects use version 4.25.0-lts-h1.
• The Derived Data Engine now supports easier retrieval of path information.
• Resolved a CMS freeze issue when switching perspectives in recent browsers (Chrome/Chromium-based 131, Firefox 133).

For the complete list of changes, see the 16.2.0 release notes.

Upgrade Procedure

1. Complete Generic Minor Upgrade Steps

Follow the generic instructions for minor upgrades before proceeding with version-specific changes.

2. Review Project Code for Library Compatibility

Upgraded third-party libraries may introduce breaking changes. If your project fails to build or run, review the affected areas and update your code to comply with the new library versions. Pay particular attention to the removal of the json-lib library, as described below.

3. Update Code Using the Json-lib Library

The net.sf.json-lib:json-lib dependency has been removed and replaced with org.json:json.

• Search your project for any usage of net.sf.json.* classes.
• Refactor code to use org.json.* instead, or explicitly add the json-lib dependency to your project if you require it.
• If you have forked or extended internal product classes, update your custom code to match the new implementations.

Specific changes include:

• In the hippo-cms-api module, classes in the org.hippoecm.frontend.plugins.yui package now return String instead of JsFunction or YuiId objects for JavaScript configuration getters.
• In the hippo-addon-eforms-hst module (Enterprise Forms delivery), the following methods now return org.json.JSONObject instead of net.sf.json.JSONObject:
  1. com.onehippo.cms7.eforms.hst.model.Form#getConditionsAsJson
  2. com.onehippo.cms7.eforms.hst.model.condition.JsonConditionalElement#getConditionAsJson
  3. The same methods in the subclasses AbstractField, FieldGroup, and Page.

4. Verify Hippo CKEditor Version

• Community projects must include the hippo-ckeditor-4.22.1-h1.jar artifact in the CMS.
• Enterprise projects using the hippo-enterprise-package-cms-dependencies POM must include both hippo-ckeditor-4.25.0-lts-h1.jar and hippo-enterprise-cms-richtext-repository.jar. These provide a more secure, licensed version. Enterprise customers receive a license key by default.

If your project does not reflect these changes, review your dependencies and update them as needed. Compare with a new 16.2 archetype-based project if necessary.

Additional Information

For more details, see the detailed release notes.