Dotdigital Contact Profile Data Adapter

The Dotdigital Contact Profile Data Adapter enables you to retrieve a contact profile attributes for use in MXO eligibility, prioritization, and data structures.

To create a Dotdigital Contact Profile Data Adapter

  1. In MXO, choose Collect.

  2. Select External Data, click Create.

  3. Choose Dotdigital Contact Profile as the type of Data Adapter you want to add.

  4. Enter a name for the Data Adapter you are adding. Using a descriptive name makes it easier for you and your team members to know when to use the Data Adapter.

  5. Enter a brief description of the Data Adapter you are adding and when it should be used.

  6. Enter the configuration details that define the adapter's behavior:

    FieldDescription
    Select the attribute to use as a keySelect the captured data attribute you want to use as the key for looking up data in Salesforce. Captured data attributes are stored in the Customer Metadata Data Adapter.
    Test keyThe existing customer key to use when testing and validating the Data Adapter configuration.
    RegionThe regional instance of your Dotdigital subscription.
    UsernameThe username of the configured Dotdigital API account.
    PasswordThe password for the configured Dotdigital API account.
    StructureThe custom properties from the contact data fields to include in the response. For more details about defining the structure, see {{< link title="Defining Dynamic Profile Attributes" src="one_data_adapters_dot_digital_profile.md#defining-dynamic-profile-attributes" >}}.
  7. Click Test configuration. This tests and verifies that the new configuration details are valid.

  8. Click Apply.

  9. Click Save.

Defining Dynamic Profile attributes

The Dotdigital solution enables you to define additional attributes within the Contact Data Fields object. You can then make those additional attributes available to MXO .

The Structure configuration setting in the data adapter is designed to provide MXO with information about those attributes. You define the schema using simple YAML syntax.

Example Data Schema

name: dataFields
displayName: Data Fields
description: the custom attributes from the data fields collection
properties:
  - name: GENDER
    displayName: Gender
    description: the specified gender of the customer
    type: SYMBOLIC  
  - name: LASTSUBSCRIBED
    displayName: Last Subscribed
    description: the last known date/time when the cutomer subscribed
    type: DATETIME

To define your structure

Start with the heading, as shown in the example above, that defines the profile attribute structure.

name: dataFields
displayName: Data Fields
description: the custom attributes from the data fields collection
properties:

The properties setting is the collection (array) of properties you want to include in the profile attributes made available to MXO .

For each property, add an indented (2 spaces) list starting with a dash ( - ).

properties:
  - name: LASTSUBSCRIBED
    displayName: Last Subscribed
    description: the last known date/time when the cutomer subscribed
    type: DATETIME

Provide the following settings for each property:

FieldDescription
nameName of the schema attribute as defined in the customer schema. This value is case sensitive.
displayNameHuman-readable name of the schema attribute.
descriptionDetailed description of the attribute.
defaultValueOptional. The value to return if data for the current customer does not contain a value.
typeThe datatype of the attribute in MXO . One of: - SYMBOLIC (used to represent all string values) - NUMBER - BOOLEAN - DATETIME