Configure campaigns 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.

Beta

The Bloomreach Engagement connector is currently in beta. Contact your Amperity representative to learn more.

Use Amperity to send campaigns to Bloomreach Engagement. Build a campaign in Amperity to define the audience and attributes to send, then configure the destination to send customer profiles to Bloomreach Engagement for segmentation and personalization. Customer profiles are identified by a Bloomreach hard identifier such as email, cookie, Google Analytics ID, or external ID.

This destination uses the Bloomreach Engagement API .

Important

Bloomreach Engagement has no API for setting segment membership directly. Amperity records membership as segment-addition and segment-deletion events that carry the segment name. To act on this membership in Bloomreach Engagement–for example, to target it in a campaign–build a segmentation in your Bloomreach Engagement project over these segment-membership events. Until that segmentation exists, the membership data is present in Bloomreach Engagement but is not yet usable as a segment.

Caution

Bloomreach Engagement allows a limited number of attributes per customer–255 by default, though this may vary based on your Bloomreach Engagement contract. An orchestration or campaign that sends more attributes than the limit fails with an error before any data is sent.

Note

Amperity sends customer updates and segment membership changes to Bloomreach Engagement over the batch API and receives a result for each row in the same request. Rows that Bloomreach Engagement rejects are reported as failed, and the rejection reason is recorded as an error on the orchestration or campaign run in Amperity.

Warning

Attributes accumulate across everything sent to a Bloomreach Engagement project over time. If the project’s total number of distinct attributes would exceed Bloomreach Engagement’s per-customer attribute limit (255 by default), Bloomreach Engagement rejects the over-limit writes and Amperity reports them as errors on the run.

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’s API group must permit customer updates and event tracking.

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

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 sent to Bloomreach. When a customer’s membership changes, Amperity records a segment membership event in Bloomreach–segment-addition when a customer enters the audience and segment-deletion when a customer leaves it–with this name stored as the event’s segment_name property.

Detail 3.

A campaign 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’s API group must permit customer updates and event tracking.

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 Campaign.

Add destination

To configure a campaign 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”.

Campaign file settings

Under Campaign settings select one of the following:

  • Send audience list as separate files

    This option sends a standalone file for each treatment group sending an audience to Bloomreach Engagement.

  • Send audience lists as a single file

    This option consolidates all treatment groups into a single file before sending the audience to Bloomreach Engagement.

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 sent to Bloomreach. When a customer’s membership changes, Amperity records a segment membership event in Bloomreach–segment-addition when a customer enters the audience and segment-deletion when a customer leaves it–with this name stored as the event’s segment_name property.

Step five.

After configuring this destination users may send campaigns to Bloomreach Engagement.

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.