Configure destinations for Bloomreach

Bloomreach Engagement (formerly Exponea) is a customer data and marketing automation platform. Use Bloomreach Engagement to create personalized customer experiences across multiple channels.

Use Amperity to manage customer profiles in Bloomreach Engagement. Build a query or segment, and then send customer data to Bloomreach Engagement for segmentation, campaigns, and personalization. Customer profiles are identified by a Bloomreach hard identifier such as email, cookie, Google Analytics ID, or external ID.

Note

This destination uses the Bloomreach Engagement API .

Note

New imports replace existing imports in Bloomreach Engagement that have the same import name. Use a unique import name for each orchestration or campaign to avoid overwriting data unintentionally.

Caution

Bloomreach limits each project to 25 active import definitions. When the limit is reached, Amperity automatically deletes the oldest Amperity-created import to make room for the new one. If all 25 imports were created outside of Amperity, the send will fail with a message asking the user to delete unused imports in Bloomreach to free a slot.

Caution

Bloomreach allows at most 255 attributes per customer. The connector adds a segment-membership attribute to every customer, so a single orchestration or campaign can send at most 254 attributes. A send with more than 254 attributes fails with an error before any data is sent.

Note

Bloomreach Engagement processes imports asynchronously after Amperity sends the data. Amperity reports rows as succeeded once the import is triggered. There is no import status tracking. To confirm a send or troubleshoot missing customer data, check the import in the Bloomreach Engagement dashboard.

Note

Attributes accumulate across all imports in a Bloomreach project. If a project exceeds 255 attributes, Bloomreach discards the over-limit import; Amperity does not track this cumulative total, so the failure appears only in the Bloomreach Engagement dashboard.

Get details

Review the following details before configuring credentials for Bloomreach Engagement and before configuring Amperity to send customer profiles to Bloomreach Engagement.

Detail 1.

Credential settings

API base URL

Required

The API base URL for your Bloomreach Engagement project.

Project token

Required

The project token for your Bloomreach Engagement project.

API key ID

Required

The public API key ID for your Bloomreach Engagement project.

API secret

Required

The private API secret for your Bloomreach Engagement project. The API key must have the “Imports > Allow to Create new Imports” permission enabled.

You can find the API base URL and project token in your Bloomreach Engagement project settings. The API key ID and API secret are available in the API access section of your project settings.

Detail 2.

Required configuration settings

Import name

Required

The name of the import definition that will be created in Bloomreach Engagement. Amperity manages import definitions with this name.

Bloomreach identifier

Required

The Bloomreach hard identifier to use as the primary key. Options include email, cookie, google_analytics, or external_id. Map a dataset attribute to a destination attribute with the same name as the identifier you select. If no dataset attribute matches, the run fails with an error before any data is sent.

Segment name

Required

A name for the segment being sent to Bloomreach. Every customer sent through this destination is tagged in Bloomreach with a boolean Is <segment name> member? attribute set to true.

Detail 3.

A query that outputs the fields that must be sent to the Bloomreach Engagement customer table.

Configure credentials

Configure credentials for Bloomreach Engagement before adding a destination.

An individual with access to Bloomreach Engagement should use SnapPass to securely share “API base URL”, “Project token”, “API key ID”, and “API secret” details with the individual who configures Amperity.

To configure credentials for Bloomreach

Step one.

From the Settings page, select the Credentials tab, and then click the Add credential button.

Step two.

In the Credentials settings dialog box, do the following:

From the Plugin dropdown, select Bloomreach Engagement.

Assign the credential a name and description that ensures other users of Amperity can recognize when to use this destination.

Step three.

The settings that are available for a credential vary by credential type. For the “bloomreach” credential type, configure settings, and then click Save.

API base URL

Required

The API base URL for your Bloomreach Engagement project.

Project token

Required

The project token for your Bloomreach Engagement project.

API key ID

Required

The public API key ID for your Bloomreach Engagement project.

API secret

Required

The private API secret for your Bloomreach Engagement project. The API key must have the “Imports > Allow to Create new Imports” permission enabled.

You can find the API base URL and project token in your Bloomreach Engagement project settings. The API key ID and API secret are available in the API access section of your project settings.

Add destination

Use a sandbox to configure a destination for Bloomreach Engagement. Before promoting your changes, send a sample audience, and then verify the results in Bloomreach Engagement. After verifying the end-to-end workflow, push the destination from the sandbox to production.

To add a destination for Bloomreach

Step one.

Open the Destinations page, select the New destinations button, and then select Orchestration.

Add destination

To configure a destination for Bloomreach Engagement, do one of the following:

  1. Click the row in which Bloomreach Engagement is located. Destinations list alphabetically and you can scroll up and down the list.

  2. Search for Bloomreach Engagement. Start typing “blo”. The list filters to show only matching destinations. Select “Bloomreach”.

Step two.

Select the credential for Bloomreach Engagement from the Credential dropdown, and then click Continue.

Tip

Amperity validates the connection when the destination is saved. If the connection cannot be validated, an error is shown and the destination is not saved.

Step three.

In the “Destination settings” dialog box, assign the destination a name and description that ensures other users of Amperity can recognize when to use this destination.

Configure business user access

By default a destination is available to all users who have permission to view personally identifiable information (PII).

Enable the Admin only checkbox to restrict access to only users assigned to the Datagrid Operator and Datagrid Administrator policies.

Enable the PII setting checkbox to allow limited access to PII for this destination.

Use the Restrict PII access policy option to prevent users from viewing data marked as PII anywhere in Amperity and from sending data to downstream workflows.

Step four.

Configure the following settings, and then click “Save”.

Import name

The name of the import definition that will be created in Bloomreach Engagement. Amperity manages import definitions with this name.

Bloomreach identifier

The Bloomreach hard identifier to use as the primary key. Options include email, cookie, google_analytics, or external_id. Map a dataset attribute to a destination attribute with the same name as the identifier you select. If no dataset attribute matches, the run fails with an error before any data is sent.

Segment name

A name for the segment being sent to Bloomreach. Every customer sent through this destination is tagged in Bloomreach with a boolean Is <segment name> member? attribute set to true.

Step five.

After configuring this destination users may use:

  • Orchestrations to send query results

  • Orchestrations and campaigns to send audiences

  • Orchestrations and campaigns to send events

Step six.

Validate the audience with Bloomreach Engagement by using a sample audience with a very small membership. For example: 10 or 100 members or the minimum audience size recommended by Bloomreach Engagement. Send the sample audience to Bloomreach Engagement and verify the sample audience is correct in Bloomreach Engagement. Make adjustments if necessary. Only send full audiences after validation is complete.