Installing brX Content Search

Overview

You can install the brX Content Search Add-on using Bloomreach Essentials or by performing a manual installation. This page describes both methods.

Install with Essentials

To install the Content Search Add-on using Essentials:

1. Open Essentials at http://localhost:8080/essentials/.
2. Click the Install feature button on the Content Feed Add-on module card.

Manual Installation

Manual installation requires editing your project’s Maven configuration files and ensuring all dependencies are present.

Prerequisites

• Use Bloomreach Content enterprise version 14.3.1 or higher.
• Install and configure the CRISP Add-on before proceeding.

Configure Add-on Version

In your main pom.xml, add a property for the Content Feed Add-on version. Use the version that matches your Bloomreach Content project. For example:

<hippo.addon-content-feed.version>14.3.1</hippo.addon-content-feed.version>
copy

Add Maven Dependency to CMS

Add the following dependency to cms-dependencies/pom.xml to install the add-on in the CMS application:

<dependency>
   <groupId>com.onehippo.cms7</groupId>
   <artifactId>hippo-addon-content-feed-dependencies-cms</artifactId>
   <version>${hippo.addon-content-feed.version}</version>
   <type>pom</type>
</dependency>
copy

Additional Dependencies

If your project uses the Selections or Taxonomy plugins, verify that the required dependencies are present in cms-dependencies/pom.xml. Add them if they are missing.

For the Taxonomy plugin:

<dependency>
   <groupId>org.onehippo.cms7</groupId>
   <artifactId>hippo-plugin-taxonomy-hst-api</artifactId>
   <version>${hippo.plugin.taxonomy.version}</version>
</dependency>

<dependency>
   <groupId>org.onehippo.cms7</groupId>
   <artifactId>hippo-plugin-taxonomy-hstclient</artifactId>
   <version>${hippo.plugin.taxonomy.version}</version>
</dependency>
copy

For the Selections plugin:

<dependency>
   <groupId>org.onehippo.cms7</groupId>
   <artifactId>hippo-plugin-selections-hst-client</artifactId>
   <version>${hippo.plugin.selections.version}</version>
</dependency>
copy

Installing the Content Search Module

To use the Fluent Query API in your site application, you must install the Content Search module in the site webapp.

Add Maven Dependency to Site

Add the following dependency to site/components/pom.xml:

<dependency>
   <groupId>com.onehippo.cms7</groupId>
   <artifactId>hippo-addon-content-feed-dependencies-site</artifactId>
   <version>${hippo.addon-content-feed.version}</version>
   <type>pom</type>
</dependency>
copy

Deploy Content Search API as a Shared Module

The Content Feed Search API (com.onehippo.cms7:hippo-addon-content-feed-search-api) must be available to both web applications. Configure it as a shared dependency.

Modify the cargo.run profile

Configure the JAR as a shared dependency in your cargo.run Maven profile. This ensures the JAR is provided to the Tomcat container when running with mvn -Pcargo.run.

Add the dependency with the shared classpath setting:

<profile>
  <id>cargo.run</id>
  <dependencies>
    <!-- SNIP -->
  </dependencies>
  <build>
    <plugins>
      <plugin>
        <groupId>org.codehaus.cargo</groupId>
        <artifactId>cargo-maven3-plugin</artifactId>
        <configuration>
          <configuration>
            <!-- SNIP -->
          </configuration>
          <deployables>
            <!-- SNIP -->
          </deployables>
          <container>
            <systemProperties>
              <!-- SNIP -->
            </systemProperties>
            <dependencies>
              <!-- SNIP -->
              <dependency>
                <groupId>com.onehippo.cms7</groupId>
                <artifactId>hippo-addon-content-feed-search-api</artifactId>
                <classpath>shared</classpath>
              </dependency>
              <!-- SNIP -->
            </dependencies>
          </container>
        </configuration>
      </plugin>
    </plugins>
  </build>
</profile>
copy

Modify the dist profile

When creating a tar.gz file using the dist profile, package the shared JAR into the shared/lib directory.

Add the dependency to src/main/assembly/shared-lib-component.xml as shown below:

<component xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/component/1.1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/component/1.1.2 http://maven.apache.org/xsd/component-1.1.2.xsd">
  <dependencySets>
    <dependencySet>
      <useProjectArtifact>false</useProjectArtifact>
      <outputDirectory>shared/lib</outputDirectory>
      <scope>provided</scope>
      <includes>
        <!-- SNIP -->
        <include>com.onehippo.cms7:hippo-addon-content-feed-search-api</include>
        <!-- SNIP -->
      </includes>
    </dependencySet>
  </dependencySets>
</component>
copy