Install the Expressional Inference Rule Engine Add-on

Info: Bloomreach provides Enterprise support for this feature to Bloomreach Experience customers. The release cycle for this add-on may differ from the core product release cycle.

Prerequisites

Before installing the Expressional Inference Rule Engine add-on, ensure that:

Your project is set up as a Bloomreach Content project.
The Relevance Module is installed.

Add Maven Dependencies

Info: Starting with version 4.0.0 for Bloomreach 14, artifact coordinates changed from com.onehippo to com.bloomreach. For earlier versions, see the installation page for 13.

In your main pom.xml, add a property for the inference engine version in the properties section. Refer to the Release Notes for the correct version number.

    <bloomreach.inference-engine.version>version-number</bloomreach.inference-engine.version>

In the root pom.xml, add the following dependencies to the <dependencyManagement> section:

  <dependencyManagement>

    <dependencies>

      <!-- The -api dependency is included by default through -core. Add it only if you build customizations, such as extensions to AbstractInferenceCommand.
      <dependency>
        <groupId>com.bloomreach.cms.relevance-inference-engine</groupId>
        <artifactId>relevance-inference-engine-api</artifactId>
        <version>${bloomreach.inference-engine.version}</version>
      </dependency>
      -->

      <dependency>
        <groupId>com.bloomreach.cms.relevance-inference-engine</groupId>
        <artifactId>relevance-inference-engine-core</artifactId>
        <version>${bloomreach.inference-engine.version}</version>
      </dependency>

      <dependency>
        <groupId>com.bloomreach.cms.relevance-inference-engine</groupId>
        <artifactId>relevance-inference-engine-plugin</artifactId>
        <version>${bloomreach.inference-engine.version}</version>
      </dependency>

      <dependency>
        <groupId>com.bloomreach.cms.relevance-inference-engine</groupId>
        <artifactId>relevance-inference-engine-repository</artifactId>
        <version>${bloomreach.inference-engine.version}</version>
      </dependency>

      <dependency>
        <groupId>com.bloomreach.cms.relevance-inference-engine</groupId>
        <artifactId>relevance-inference-engine-data-collector</artifactId>
        <version>${bloomreach.inference-engine.version}</version>
      </dependency>

      <dependency>
        <groupId>com.bloomreach.cms.relevance-inference-engine</groupId>
        <artifactId>relevance-inference-engine-collector-plugin</artifactId>
        <version>${bloomreach.inference-engine.version}</version>
      </dependency>

    </dependencies>

  </dependencyManagement>

In cms-dependencies/pom.xml, add the following dependencies:

  <dependencies>

      <!-- The -api dependency is included by default through -core. Add it only if you build customizations, such as extensions to AbstractInferenceCommand.
      <dependency>
        <groupId>com.bloomreach.cms.relevance-inference-engine</groupId>
        <artifactId>relevance-inference-engine-api</artifactId>
        <scope>compile</scope>
      </dependency>
      -->

    <dependency>
      <groupId>com.bloomreach.cms.relevance-inference-engine</groupId>
      <artifactId>relevance-inference-engine-core</artifactId>
      <scope>runtime</scope>
    </dependency>

    <dependency>
      <groupId>com.bloomreach.cms.relevance-inference-engine</groupId>
      <artifactId>relevance-inference-engine-data-collector</artifactId>
      <scope>runtime</scope>
    </dependency>

    <dependency>
      <groupId>com.bloomreach.cms.relevance-inference-engine</groupId>
      <artifactId>relevance-inference-engine-plugin</artifactId>
      <scope>runtime</scope>
    </dependency>

    <dependency>
      <groupId>com.bloomreach.cms.relevance-inference-engine</groupId>
      <artifactId>relevance-inference-engine-collector-plugin</artifactId>
      <scope>runtime</scope>
    </dependency>

    <dependency>
      <groupId>com.bloomreach.cms.relevance-inference-engine</groupId>
      <artifactId>relevance-inference-engine-repository</artifactId>
      <scope>runtime</scope>
    </dependency>

  </dependencies>

Upgrade Note

Starting with Experience Manager 13, all inference engine dependencies are included in the CMS (platform). In versions 12 and 11, you needed to add site dependencies and install the relevance-inference-engine-api artifact in the shared library. When upgrading from those versions, remove these dependencies from the site WAR, the cargo.run profile, and the distribution configuration.

Rebuild

After you add the dependencies, rebuild and restart your project. You can then create "Inference Rules" documents in the CMS UI and use them with Relevance targeting collectors.