Install the Expressional Inference Rule Engine Add-on - Bloomreach Experience - Open Source CMS

This article covers a Hippo CMS version 13. There's an updated version available that covers our most recent release.

13-01-2020

Install the Expressional Inference Rule Engine Add-on

Bloomreach offers Enterprise support for this feature to Bloomreach Experience customers. The release cycle of this feature may differ from our core product release cycle. 

Prerequisites

To be able to use the Expressional Inference Rule Engine add-on, your implementation project must be set up as a Bloomreach Experience Manager project, and you must install the Relevance Module first.

Add Maven Dependencies

In the main pom.xml of your project, add a new property in the properties section. For the correct version number for your project, check the Release Notes page.

    <hippo-addon-inference-engine.version>version-number</hippo-addon-inference-engine.version>

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

  <dependencyManagement>

    <dependencies>

      <!-- the -api is by default pulled in through -core but needed when customizations are built, 
           e.g. when adding extensions to AbstractInferenceCommand 
      <dependency>
        <groupId>com.onehippo.cms7</groupId> 
        <artifactId>hippo-addon-inference-engine-api</artifactId> 
        <version>${hippo-addon-inference-engine.version}</version> 
      </dependency>
      -->

      <dependency>
        <groupId>com.onehippo.cms7</groupId>
        <artifactId>hippo-addon-inference-engine-core</artifactId>
        <version>${hippo-addon-inference-engine.version}</version>
      </dependency>

      <dependency>
        <groupId>com.onehippo.cms7</groupId>
        <artifactId>hippo-addon-inference-engine-plugin</artifactId>
        <version>${hippo-addon-inference-engine.version}</version>
      </dependency>

      <dependency>
        <groupId>com.onehippo.cms7</groupId>
        <artifactId>hippo-addon-inference-engine-repository</artifactId>
        <version>${hippo-addon-inference-engine.version}</version>
      </dependency>

      <dependency>
        <groupId>com.onehippo.cms7</groupId>
        <artifactId>hippo-addon-inference-engine-data-collector</artifactId>
        <version>${hippo-addon-inference-engine.version}</version>
      </dependency>

      <dependency>
        <groupId>com.onehippo.cms7</groupId>
        <artifactId>hippo-addon-inference-engine-collector-plugin</artifactId>
        <version>${hippo-addon-inference-engine.version}</version>
      </dependency>

    </dependencies>

  </dependencyManagement>

Add the following dependencies in the cms-dependencies/pom.xml:

  <dependencies>

     <!-- the -api is by default pulled in through -core but needed when customizations are built, 
           e.g. when adding extensions to AbstractInferenceCommand 
      <dependency>
        <groupId>com.onehippo.cms7</groupId> 
        <artifactId>hippo-addon-inference-engine-api</artifactId> 
        <scope>compile</scope> 
      </dependency>
      -->

    <dependency>
      <groupId>com.onehippo.cms7</groupId>
      <artifactId>hippo-addon-inference-engine-core</artifactId>
      <scope>runtime</scope>
    </dependency>

    <dependency>
      <groupId>com.onehippo.cms7</groupId>
      <artifactId>hippo-addon-inference-engine-plugin</artifactId>
      <scope>runtime</scope>
    </dependency>

    <dependency>
      <groupId>com.onehippo.cms7</groupId>
      <artifactId>hippo-addon-inference-engine-data-collector</artifactId>
      <scope>runtime</scope>
    </dependency>

    <dependency>
      <groupId>com.onehippo.cms7</groupId>
      <artifactId>hippo-addon-inference-engine-collector-plugin</artifactId>
      <scope>runtime</scope>
    </dependency>

    <dependency>
      <groupId>com.onehippo.cms7</groupId>
      <artifactId>hippo-addon-inference-engine-repository</artifactId>
      <scope>runtime</scope>
    </dependency>

  </dependencies>

Upgrade Note

Since the version for Experience Manager 13, all dependencies have moved to the CMS (platform). In the version for 12 and 11, there were site dependencies and the relevance-inference-engine-api artifact needed to be installed in the shared lib. When upgrading, please remove those from site war, from cargo.run profile and from the distribution configuration.

Rebuild

That's it! After rebuild and restart, you can now create "Inference Rules" documents through CMS UI to create inference rules and combine them with Relevance targeting collectors!

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?