Bloomreach

Bloomreach Documentation version

Relevant Changes in Bloomreach Experience Manager 17

This page describes the relevant changes between Bloomreach Experience Manager 16 and Bloomreach Experience Manager 17.

Major changes

Java 21

Bloomreach Experience Manager 17 requires Java 21. If you make use of the Bloomreach Cloud hosting platform, the appropriate Java version to run your uploaded project distribution is auto-detected.

Spring Boot 4

Bloomreach Experience Manager 17 uses Spring Boot 4 with Spring Framework 7 and Spring Security 7. If your project includes custom Spring configuration, Spring beans, or Spring Security customizations, review the Spring Boot 4 migration guide and the Spring Security 7 migration guide for required changes.

Spring AI has been upgraded to version 2.0. If your project uses the AI Content Assistant and has custom AI extensions (custom AIModelFactory, VectorStoreFactory, or ClientToolPackage implementations), review the Spring AI 2.0 release notes for API changes.

No more RMI support in Jackrabbit

Bloomreach Experience Manager 17 uses Jackrabbit 2.22.2, in which RMI support has been removed. See JCR-4972 for details.

If your project connects to the repository over RMI, you must switch to an alternative connection method before upgrading.

JUnit Jupiter 6

JUnit 4 has been migrated to JUnit Jupiter 6.0.3. The parent POM (hippo-cms7-project) no longer includes junit:junit in <dependencyManagement>. JUnit Jupiter libraries (junit-jupiter-api, junit-jupiter-engine, junit-jupiter-params) are now managed at version 6.0.3.

If your project test code uses JUnit 4 annotations (@RunWith, org.junit.Test), migrate to JUnit Jupiter before upgrading.

OpenTelemetry integration

Bloomreach Experience Manager 17 adds native OpenTelemetry support. Distributed traces are collected automatically via the standard Java auto-instrumentation agent and can be sent to any OTLP-compatible backend. This is an opt-in feature that requires no code changes. See the OpenTelemetry setup documentation for configuration instructions.

Content REST API Workflow Fields Removed

The following internal workflow fields are no longer returned by the Content REST API as of v17.0:

  • hippostdpubwf:publishedBy

  • hippostdpubwf:depublishedBy

  • hippostdpubwf:publicationReason

  • hippostdpubwf:depublicationReason

These fields were never part of the documented public API contract, but were visible in API responses. Removing them prevents user identity leakage in delivery applications.

Impact: Delivery applications that read any of these fields from the Content REST API response will silently receive no value after upgrading. There is no error or warning. Review your delivery-layer code before upgrading and remove any references to these fields.

Essentials Setup Wizard Rebuilt on Angular 21

The Essentials setup wizard has been rebuilt from AngularJS to Angular 21. For most projects, no action is required. However, if your project includes custom Essentials plugins with a frontend component, specifically, an AngularJS controller registered to the hippo.essentials module and an HTML fragment packaged as a web fragment under META-INF/resources — those frontend components will no longer work and must be rewritten for the new Angular 21 implementation before upgrading.

Removed modules

The following modules have been removed from the Bloomreach Experience Manager repository:

Targeting demo support (com.onehippo.cms7:hippo-addon-targeting-demo-support): The data-loader and data-generator demo submodules have been removed. Remove any references to these artifacts from your project before upgrading:

  • com.onehippo.cms7:hippo-addon-targeting-demo-support-data-loader

  • com.onehippo.cms7:hippo-addon-targeting-demo-support-data-generator

Frontend theme: The frontend-theme module has been removed from the repository. If your project references any files from this module directly, update accordingly.

Minor changes

  • Chinese (Simplified) UI translation files (_zh variants) have been removed. The CMS UI will fall back to English for any labels that previously had a Chinese translation. Custom project translations are not affected.

  • HikariCP upgraded to 7.0.0+. No action required; this resolves a reliability issue in earlier versions.

  • Deprecated APIs marked forRemoval in earlier releases have been removed as part of this major release. Review your project for usages of previously-deprecated APIs before upgrading.

  • Third-party libraries updated. 

See the detailed release notes for the full list.

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?