Upgrade 17.0 to 17.1

Overview

This guide describes how to upgrade a Bloomreach Content project from version 17.0.x to 17.1.y.

Significant Changes

Version 17.1 introduces new Content AI features, expanded Search Agent functionality, and several product updates. Key changes for developers and users upgrading from 17.0 to 17.1 include:

• Conversational repository-wide search:
  The Search Agent now supports repository-wide, natural language search. It matches on semantic meaning, allowing editors to find relevant documents even when terminology differs or content is stored in various locations. This feature helps editors check for existing coverage, track content changes, and add context to chat interactions. The Search Agent is now available to all Bloomreach Content customers, including those on Bloomreach Cloud. For details, see the Content AI Assistant documentation.

• PostgreSQL (PgVector) vector store support:
  PgVector is now supported as a vector store option in addition to Redis. For setup instructions, see the Vector Store and Ingestion guide.

• Configurable Search Agent result depth:
  You can now control the number of results returned by the Search Agent per query using the brxm.ai.tools.search.max-results property (default: 5, range: 1–20). If you do not set this property, the default applies. For configuration details, see Initialize and configure via Properties files.

• AI feature setup via Essentials:
  You can now configure the LiteLLM connector, custom completions paths, and the vector store from the Essentials application. See Initialize and configure via Essentials.

• MimeTypeMapper removal:
  The deprecated MimeTypeMapper utility has been removed. Projects that use it must now obtain the MIME type mapping service from the HippoServiceRegistry.

• Custom value list providers in Experience Manager:
  Selection fields that use a custom valuelistProvider now render in both the Experience Manager and the legacy document editor. Both editors use a shared registry. Existing registrations continue to work. Providers that extend Wicket's Plugin require a minor update to appear in the Experience Manager. For implementation details, see Custom Value List Providers.

For a complete list of changes, see the 17.1.0 release notes.

Upgrade Steps

Repository Node Type (CND) Changes

This release introduces the following changes to node type definitions (CND):

• Added property hst:deferpreviewload (boolean) to the node type hst:channel
• Added property hippostdpubwf:rejectedBy (String) to the node type hippostdpubwf:request

Important:
You cannot roll back to 17.0.x by redeploying the previous distribution or swapping binaries or containers after upgrading the repository to 17.1.0. To downgrade, restore a full repository backup created before the upgrade.

Perform Generic Minor Upgrade Steps

Follow the generic instructions for minor upgrades.

Migrate Direct MimeTypeMapper Usage (If Applicable)

If your project references the deprecated MimeTypeMapper directly, update your code to obtain the MIME type mapping service from the HippoServiceRegistry. No action is required if your project does not use MimeTypeMapper.

Custom Value List Providers

Existing custom value list providers continue to function in the legacy document editor.

To render custom value list fields in the Experience Manager:

• If your provider is a plain class with a public no-argument constructor and is registered under /hippo:configuration/hippo:modules/valuelist-service/hippo:moduleconfig/providers, it works in both editors.
• If your provider extends org.hippoecm.frontend.plugin.Plugin (including subclasses of DocumentValueListProvider), it cannot be instantiated by the Experience Manager and will render an empty list. The system logs this at startup as "not Experience Manager compatible". To make it compatible, update the class and adjust the bootstrap configuration as described in Custom Value List Providers.

Check Custom Project Code for Incompatibilities With Upgraded Libraries

Upgrading third-party libraries may introduce backward compatibility issues. If your project code fails to build or run, review the specific errors and update your code to work with the latest library versions.

Detailed Release Notes

For more information, see the detailed release notes.