Upgrade 14.0 to 14.1

Overview

This guide describes how to upgrade a Bloomreach Content implementation from version 14.0.x to 14.1.y.

Upgrade Steps

1. Complete Generic Minor Upgrade Steps

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

Starting with brXM 14.1.0, the login page no longer supports captcha functionality. If your project sets either of the following properties at /hippo:configuration/hippo:frontend/login/login/loginPage, remove them to prevent bootstrap errors after upgrading:

use.captcha
show.captcha.after.how.many.times

If your project includes customizations to the login page, review and update them as needed for 14.1.0 compatibility.

In 14.1.0, the SimpleLoginPlugin was removed. The DefaultLoginPlugin, which previously extended SimpleLoginPlugin, now extends LoginPlugin directly. If you have custom code extending SimpleLoginPlugin, update it to extend DefaultLoginPlugin instead.

4. (SPA) Upgrade SPA Integration SDKs

If your project uses the Bloomreach SPA Integration SDKs, update your SPA project to the latest versions of these SDKs:

5. (Page Model API) Update SPA Code for Fully Qualified External and Resource Links

In version 14.1.0, the Page Model API returns "external" and "resource" links as fully qualified URLs. If your SPA consumes the Page Model API, review and update your code to handle these URLs as needed.

6. (Relevance) Add GeoLite2/GeoIP2 Database

The GeoLite2 database is no longer included with the Relevance module as of 14.1.0. In 14.0, it was provided via a transitive Maven dependency. For 14.1.0 and later, you must manually add the database. Follow the steps in Add the GeoIP2/GeoLite2 Database to a Project.

7. (Optional) Use Relevance Without Elasticsearch

brXM 14.1.0 allows you to use Relevance without Elasticsearch, but this disables the Experiments and Trends features.

If you do not require Experiments and Trends, or no longer want to use Elasticsearch, you can remove the Elasticsearch requirement as part of the upgrade. If you still use these features, skip this step.

8. (Commerce Accelerator) Upgrade Commerce Accelerator

If your project uses Bloomreach Commerce Accelerator, follow the Commerce Accelerator 14.1.0 Upgrade Notes for detailed instructions.