Install the API Agent Channel Add-on

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

Prerequisites

Before installing the API Agent Channel Add-on, ensure your implementation project is set up as a Bloomreach Content project.

You must also install the Relevance Module in your project before proceeding.

Installation Steps

Add Maven Dependency

1. In your project's root pom.xml, add the following properties and dependencies. Replace version-number with the appropriate version for your project. Refer to the Release Notes for the correct version.

  <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>
copy

2. In 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>
copy

Note: Starting from version 2.0.0, both dependencies above must be included in site/components/pom.xml.

3. Rebuild your project and restart the server.

After completing these steps, the API Agent Channel add-on is available in your project.