Configure Relevance for Bloomreach Cloud

Overview

This page describes how to configure the Relevance Module for deployment in Bloomreach Cloud.

When to Use

Configure the Relevance Module if you plan to use targeting, experiments, or trends features in Bloomreach Experience Manager on Bloomreach Cloud.

Prerequisites

Access to Bloomreach Cloud support
Knowledge of your stack's Elasticsearch version (if required)
Access to your implementation project's configuration files

Enable Elasticsearch in Your Stack

Some Relevance features require Elasticsearch. Before your first deployment, submit a request to Bloomreach Cloud support to enable Elasticsearch in your stack. Confirm the Elasticsearch version used and ensure your project's Elasticsearch data store is configured for that version.

Note: For Bloomreach Experience Manager versions up to 13.4.1 and 14.0.0, all Relevance features require Elasticsearch. Starting with versions 13.4.2 and 14.0.1, only the Experiments and Trends features require Elasticsearch.

Configure SQL Data Store `maxAgeDays`

The Relevance Module uses an SQL data store to persist data. To optimize backup size and performance, set the maxAgeDays property to 30 days for the following nodes:

/targeting:targeting/targeting:datastores/targeting:targetingdata:
  maxAgeDays: 30
/targeting:targeting/targeting:datastores/targeting:requestlog:
  maxAgeDays: 30

Note: The Elasticsearch data store maxAgeDays property is set to 30 days by the platform and cannot be changed at runtime.

Note: If you need to retain records for more than 30 days, contact Bloomreach Cloud Support.

By default, the Relevance Module uses the cookie name _visitor. This can cause issues with some single-page application (SPA) frontends due to the underscore. Configure a visitorCookieName without an underscore. For example:

/targeting:targeting:
  targeting:visitorCookieName: visitor

For more details, see visitorCookieName documentation.

Configure Client's Originating IP Address Resolution with a CDN

If your application uses a CDN, configure the Relevance Module to resolve the client's originating IP address from CDN-specific HTTP headers. Set the http-forwarded-for-header context parameter in your site's web.xml. You can specify multiple headers as a comma-separated list. The module uses the first available header.

<context-param>
  <description>The remote ip address header</description>
  <param-name>http-forwarded-for-header</param-name>
  <param-value>X-Real-IP,X-Forwarded-For</param-value>
</context-param>

Verification

Confirm that Elasticsearch is enabled if required by your features.
Check that the maxAgeDays property is set to 30 for both SQL data store nodes.
Ensure the visitor cookie name does not contain an underscore.
Verify the correct client IP address is resolved when using a CDN.