Install the API Agent Channel Add-on - BloomReach Experience - Open Source CMS
30-10-2019

Install the API Agent Channel 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 API Agent Channel Add-on, your implementation project must be set up as a Bloomreach Experience Manager project.

Also, before installing this plugin, you need to install Relevance Module module first in your project.

Instructions

Add Maven Dependency

In the root pom.xml of your project, add the following. For the correct version number for your project, check the Release Notes page.

  <properties>
    <!-- SNIP -->
    <bloomreach.api-agent-channel.version>version-number</bloomreach.api-agent-channel.version>
    <!-- SNIP -->
  </properties>

  <dependencies>
      <!-- SNIP -->

      <dependency>
        <groupId>com.onehippo.cms7</groupId>
        <artifactId>hippo-addon-api-agent-channel-delegates</artifactId>
        <version>${bloomreach.api-agent-channel.version}</version>
      </dependency>

      <dependency>
        <groupId>com.onehippo.cms7</groupId>
        <artifactId>hippo-addon-api-agent-channel-repository</artifactId>
        <version>${bloomreach.api-agent-channel.version}</version>
      </dependency>

      <!-- SNIP -->
    </dependencies>

  </dependencyManagement>

In the site/components/pom.xml, add the following dependencies:

    <dependency>
      <groupId>com.onehippo.cms7</groupId>
      <artifactId>hippo-addon-api-agent-channel-delegates</artifactId>
    </dependency>

    <dependency>
      <groupId>com.onehippo.cms7</groupId>
      <artifactId>hippo-addon-api-agent-channel-repository</artifactId>
    </dependency>
Note: Since v2.0.0, both dependencies shown above should be added in site/components/pom.xml.

After rebuilding the project and restarting the server, you will be able to use the API Agent Channel add-on right way.

 

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?