Upgrade 14.6 to 14.7

Overview

This guide describes how to upgrade a Bloomreach Content project from version 14.6.x to 14.7.y.

Key Changes in 14.7

Improved file upload validation
Bulk workflow UI fix requires updates to custom bulk workflow implementations

Upgrade Procedure

1. Complete Generic Minor Upgrade Steps

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

2. Update File Upload Validation Configuration

brXM 14.7.0 introduces enhanced file upload validation. The mimetypes.allowed property, previously described in Image and Asset Upload Validation, is no longer supported. Any existing configuration for this property is ignored after the upgrade. The previous behavior allowed certain MIME types to bypass validation, which is no longer permitted.

The new validation mechanism compares the MIME type provided by the browser with the MIME type detected by the backend. If these values do not match, the upload is rejected.

Bloomreach tested over 200 MIME types. In some cases, browsers may report a MIME type that differs from the backend-detected type, especially for uncommon file types. If you encounter issues uploading a file type that previously worked, refer to Image and Asset Upload Validation for instructions on allowing additional MIME types. To permit a specific file type, configure the extension.mimetype.allowed.mappings property as described in Allow Extra MIME Types.

3. Update Custom Bulk Workflow Implementations

Version 14.7.0 resolves a UI issue in the advanced search app's bulk workflow menu. If your implementation includes any custom bulk workflow logic, update it to benefit from this fix. Existing custom workflows will continue to function but will not include the UI improvement until updated.

To update your custom bulk workflow implementation:

Add the following import to your Java source:

import com.onehippo.cms7.search.frontend.workflow.PublicationWorkflowPlugin;

Override the getSubMenu method in your class:

@Override
public String getSubMenu() {
    return PublicationWorkflowPlugin.SUB_MENU;
}

For a complete implementation guide, see Use a Custom Bulk Workflow.

4. Replace Deprecated #isCmsRequest Usage

The deprecated method HstRequestContext#isCmsRequest has been removed. If your project references this method, typically in Freemarker templates, replace it with #isChannelManagerPreviewRequest. For more details, see the 14.0 upgrade guide.

5. Remove Universal Pixel Integration Addon Maven Properties and Dependencies

Starting with 14.7.0, the enterprise release POM includes the Maven dependencies for the Universal Pixel Integration Addon. You no longer need to define a version property or dependency in your root POM.

Remove the following property from the <properties> section in your root pom.xml:

 <hippo-addon-universal-pixel-integration.version>${essentials.version}</hippo-addon-universal-pixel-integration.version>

Remove the following dependency definitions from the <dependencyManagement> section in your root pom.xml:

      <dependency>
        <groupId>com.onehippo.cms7</groupId>
        <artifactId>hippo-addon-universal-pixel-integration-api</artifactId>
        <version>${hippo-addon-universal-pixel-integration.version}</version>
        <scope>provided</scope>
      </dependency>

      <dependency>
        <groupId>com.onehippo.cms7</groupId>
        <artifactId>hippo-addon-universal-pixel-integration-repository</artifactId>
        <version>${hippo-addon-universal-pixel-integration.version}</version>
      </dependency>

      <dependency>
        <groupId>com.onehippo.cms7</groupId>
        <artifactId>hippo-addon-universal-pixel-integration-frontend</artifactId>
        <version>${hippo-addon-universal-pixel-integration.version}</version>
      </dependency>

      <dependency>
        <groupId>com.onehippo.cms7</groupId>
        <artifactId>hippo-addon-universal-pixel-integration-frontend-ng</artifactId>
        <version>${hippo-addon-universal-pixel-integration.version}</version>
      </dependency>

      <dependency>
        <groupId>com.onehippo.cms7</groupId>
        <artifactId>hippo-addon-universal-pixel-integration-hst</artifactId>
        <version>${hippo-addon-universal-pixel-integration.version}</version>
      </dependency>

Refer to the current installation instructions for the Universal Pixel Integration Addon.

6. Update Spring Boot Exclusion Artifact Name

If you previously resolved conflicting Spring contexts by excluding the artifact org.onehippo.cms7:**spring-boot** (see 14.5 to 14.6 upgrade instructions), update the artifact ID to **xm-spring-boot-integration** when upgrading to 14.7.

7. Upgrade Text Find & Replace Plugin

If your project uses the Text Find & Replace plugin, update its version to 2.1.0. See the Text Find & Replace plugin release notes for details.

8. Changes in Release 14.7.17

In 14.7.17, the artifact javax:mail:mail was replaced with com.sun.mail:jakarta.mail. This change affects the distribution configuration. Update your codebase accordingly, typically in src/main/assembly/common-lib-component.xml:

<dependencySets>
  <dependencySet>
    <includes>
      ...
      <include>com.sun.mail:jakarta.mail</include>  // change from javax.mail:mail

Verification

Confirm that the application starts successfully after the upgrade.
Validate file uploads for all required MIME types.
Test custom bulk workflow actions in the advanced search app.
Check that Universal Pixel Integration Addon dependencies are managed by the platform.
Verify that Spring context exclusions use the updated artifact name.
Ensure the Text Find & Replace plugin functions as expected.
Confirm that mail dependencies reference com.sun.mail:jakarta.mail in 14.7.17 and later.

Troubleshooting

If you encounter issues with file uploads or custom workflows after upgrading, review the relevant configuration changes described above. For additional support, consult the linked documentation pages for each feature.