Bloomreach Forge Breadcrumb Plugin

Prerequisites

These instructions assume that you have a Bloomreach Experience project based on the archetype, i.e. a Maven multi-module project consisting of at least three submodules: cms, site and repository-data.

Add the Forge repository configuration

In the main pom.xml of the project, in the repositories section, add this repository if it is not configured there yet.

    <repository>
      <id>bloomreach-forge</id>
      <name>Bloomreach Forge Maven 2 repository.</name>
      <url>https://maven.bloomreach.com/repository/maven2-forge/</url>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
      <releases>
        <updatePolicy>never</updatePolicy>
      </releases>
      <layout>default</layout>
    </repository>
        

Installation in Site

1. Add the plugin version to the main pom.xml of the project

   <forge.breadcrumb.version>version.number</forge.breadcrumb.version>

   Note: always check for the latest version number and compatibility with the project on the Release Notes page.

2. Add the following dependency to the site components pom.xml

   <dependency>
     <groupId>org.bloomreach.forge.breadcrumb</groupId>
     <artifactId>breadcrumb</artifactId>
     <version>${forge.breadcrumb.version}</version>
   </dependency>

   Note: before version 4.0.0, the artifacts' groupId was org.onehippo.forge

3. Add the following dependency to your cms-dependencies pom.xml

   <dependency>
     <groupId>org.bloomreach.forge.breadcrumb</groupId>
     <artifactId>breadcrumb-repository</artifactId>
     <version>${forge.breadcrumb.version}</version>
   </dependency>

   Note: this artifact exists since version 4.1.0.

4. Make sure your project bootstraps after 'bloomreach-forge' group. Typically, add it in file repository-data/application/src/main/resources/hcm-module.yaml:

   group:
     name: <your-group-name>
     after: [hippo-cms, bloomreach-forge]
   

5. Rebuild your project using Maven and go to configuration.