Segment CDP extension

Customer data Unbundled: Extension

Issues

Git

Latest

1.1.1

Compatible with Magnolia 6.2.

The Segment CDP extension enables Magnolia Authors to create multichannel personalized experiences based on insights from Segment without ever leaving the Magnolia UI. This module leverages the personlization feature in Magnolia.

You should be familiar with Personalization before continuing.

Security considerations

You should use the Segment CDP extension to encapsulate rest-based calls of a frontend to third party systems through Magnolia. This way passwords and other critical security information are hidden the browser.

Installing with Maven

Maven is the easiest way to install the module. Add the following to your bundle:

<dependency>
  <groupId>info.magnolia.cdp</groupId>
  <artifactId>magnolia-cdp-segment</artifactId>
  <version>1.1.1</version>
</dependency>

Configuration

The configuration consists of two parts:

A Rest Endpoint that can be called from the desired frontend
A Rest Client that controls the call to the third party system.

Rest Endpoint

<light-module-name>/restEndpoints/<restEndpointName>

class: info.magnolia.cdp.common.rest.service.ConfiguredRestProxyEndpointDefinition
implementationClass: info.magnolia.cdp.common.rest.service.RestProxyEndpoint
restClientName: <restClientName>
restCallName: <restClientMethodName>

Rest Client

<light-module-name>/restClients/<restClientName>

baseUrl: <URL to the external Service>
securitySchemes:
  b1:
    $type: basic
    username: <username to the third party system>
    password: ''
restCalls:
  <restClientMethodName>:
    method: get
    path: /<path of the method>/${idProperty}
    securityScheme: b1

Frontend call example

await fetch('/.rest/<restClientName>', {
    method: 'POST', (1)
    headers: { 'Content-Type': 'application/json' },
    body: `{"idProperty":"${idProperty}"}`
});

1	The Rest Client can be both `GET` and `POST`, but the Rest Endpoint must be called with `POST`.

Usage

Here, we provide some basic examples of using the CDP integration framework.

Create a content variant

The variant can be configured completely differently in terms of copy or images.

On your desired page, click the Component you want to edit.
Click Edit component and change something to create a component variant.

Example

In the example here, we are choosing a different image for the particular component.

For more on components in Magnolia, see Editing pages.

Choose the variant audience

Select the variant you just created, and click Choose audience.
Define your audience and select the traits. Here, you’ll see traits that are taken directly from Segment. Cool, huh?