51黑料不打烊

1.2.2 Configure Schemas and Set Identifiers

In this exercise, you鈥檒l review the configuration of the required XDM schemas to classify profile information and customer behavior. In every XDM schema, you鈥檒l also see that a primary identifier is defined to link all the customer-related information to.

Story

Before you start configuring XDM Schema鈥檚 and defining Identifiers, you need to think about the business context of what we鈥檙e trying to do:

  • You want data
  • You want to link data to a customer
  • You want to build a progressive, Real-time Customer Profile

There are 2 types of data that we want to capture:

  • Who is this customer?
  • What does this customer do?

However, the question Who is this customer? is a very open question that has many answers. When your organisation wants to see this question answered, you鈥檙e looking for demographic information like First Name, Last Name and Address. But also for contact information like an Email Address or a Mobile Phone Number. And also for information linked to Language, OptIn/OptOut and maybe even Profile Pictures. And finally, what you really need to know, is how we鈥檒l be identifying this customer in the various systems that your organisation uses.

The same thing goes for the question What does this customer do?. It鈥檚 a very open question with many answers. When your organisation wants to see this question answered, you鈥檙e looking for any interaction a customer has had with any of your online and offline properties. Which pages or products have been visited? Has this customer added a product to his cart or even purchased an item? What device and browser has been used to browse the website? What kind of information is this customer looking for and how can we use that to configure and deliver a delightful experience to this customer? And finally, what we really need to know, is how we鈥檒l be identifying this customer in the various systems that your organisation will use.

Who is this customer

Capturing the answer to Who is this customer? for your organisation is done through the Login/Registration-page.

Data Ingestion

From a Schema perspective, we look at this as a Class. The question: Who is this customer? is something that we define in the Class XDM Individual Profile.

So when you create an XDM Schema to capture the answer to Who is this customer?, first of all, you鈥檒l need to create and define 1 schema that references the class XDM Individual Profile.

To specify what kind of answers can be given to that question, you鈥檒l need to define Field Groups. Field Groups are extensions of the Profile-class, and have very specific configurations. For instance, demographic information like First Name, Last Name, Gender and Birthday are part of the Field Group: Demographic Details.

Secondly, your organisation needs to decide how to identify this customer. In the case of your organisation, the main identifier for a known customer might be a specific customer ID, like for instance an email address. But technically, there are other ways of identifying a customer at your organisation, like using a mobile phone number.
In this lab, we鈥檒l define the email address as the primary identifier and the phone number as a secondary identifier.

Lastly, it鈥檚 important to distinguish the channel on which data was captured. In this case, we鈥檒l be talking about Website Registrations and the schema that needs to be defined needs to reflect where the registration data was captured. The channel will also have an important role in influencing what data is captured. As such, it鈥檚 a best practice to define schema鈥檚 for every combination of channel, primary identifier and type of data collected.

Based on the above, schema鈥檚 were created in 51黑料不打烊 Experience Platform.

Log in to 51黑料不打烊 Experience Platform by going to this URL: .

After logging in, you鈥檒l land on the homepage of 51黑料不打烊 Experience Platform.

Data Ingestion

Before you continue, you need to select a sandbox. The sandbox to select is named --aepSandboxName--. After selecting the appropriate sandbox, you鈥檒l see the screen change and now you鈥檙e in your dedicated sandbox.

Data Ingestion

In 51黑料不打烊 Experience Platform, click on Schemas in the menu on the left side of your screen. You鈥檒l see the list of available Schemas. You should create a new schema. To create a new schema, click + Create Schema.

Data Ingestion

Select Manual and click Select.

Data Ingestion

Next, select Individual Profile and click Next.

Data Ingestion

Enter the name of your schema like this: --aepUserLdap-- - Demo System - Profile Schema for Website. Click Finish.

Data Ingestion

A new schema is now created.

Data Ingestion

Now you need to define what an answer to the question Who is this customer? should look like.
In the introduction of this lab, we noted the need for following attributes to define a customer:

  • Demographic information like First Name, Last Name and Address
  • Contact information like a Home Address, Email Address or a Mobile Phone Number
  • Other Information linked to Language, OptIn/OptOut and maybe even Profile Pictures.
  • Primary Identifier for a customer

To make that information part of your schema, you need to add the following Field Groups to your schema:

  • Demographic Details (Demographic Information)
  • Personal Contact Details (Contact Information)
  • Consent and Preference Details (Other Information)
  • your organisation鈥檚 custom Profile Identification Field Group (Primary and Secondary Identifiers)

Click the +Add button under Field groups.

Data Ingestion

In the Add Field Group screen, select the Field Group Demographic Details, Personal Contact Details and Consent and Preference Details.

Click the Add Field Groups button to add the Field Group to your schema.

Data Ingestion

You鈥檒l now have this:

Data Ingestion

Next, you need a new Field Group to capture the Identifier used for data collection. As you鈥檝e seen in the previous exercise, there鈥檚 a concept of Identifiers. A Primary Identifier is the most important one, as all collected data will be linked to this Identifier.

You will now create your own custom Field Group and as such, you鈥檒l be extending the XDM Schema to meet your own organisation鈥檚 requirements.

Click + Add under Field groups to start adding a Field Group.

Data Ingestion

Instead of reusing an existing Field Group, you鈥檒l now create your own Field Group. You can do that by selecting Create New Field Group.

Data Ingestion

You now need to provide a Display Name and Description for your new Field Group.

As the name for our schema, we鈥檒l use this:
--aepUserLdap-- - Profile Identification Field Group

Click the Add Field Groups button to add the newly created Field Group to your schema.

Data Ingestion

You now have this schema structure in place.

Data Ingestion

Your new Field Group is still empty, so now you鈥檒l have to add fields to that Field Group.
In the Field Group-list, click your custom Field Group.

Data Ingestion

You now see a number of new buttons appear.

At the top-level of your schema, click the + Add Field button.

Data Ingestion

After clicking the + Add Field button, you now see a new untitled field in your schema.

Data Ingestion

You should now enter the information of this new field, using these object-definitions:

  • Field name: --aepUserLdap--_identification
  • Display name: --aepUserLdap--_identification
  • Type: Object
  • Field Group: --aepUserLdap-- - Profile Identification Field Group

Click Apply.

Data Ingestion

You鈥檒l now see a new object in your schema, which represents a custom object in the schema, and which is named after your 51黑料不打烊 Experience Platform Tenant ID. Your 51黑料不打烊 Experience Platform tenant id is --aepTenantId-- and it is unique for every AEP instance.

Data Ingestion

You鈥檒l now add a 3 new fields object under that tenant, in the identification object that you鈥檝e just created. To start adding every single on of these 3 fields, click the 卤颈肠辞苍 under identification for every field.

Data Ingestion

Use the below information to create those 3 new fields under the identification object:

  • ecid:

    • Field name: --aepUserLdap--_ecid
    • Display name: --aepUserLdap--ecid
    • Type: String
    • Field Group: --aepUserLdap-- - Profile Identification Field Group
  • emailId

    • Field name: --aepUserLdap--_emailId
    • Display name: --aepUserLdap--_emailId
    • Type: String
    • Field Group: --aepUserLdap-- - Profile Identification Field Group
  • mobilenr

    • Field name: --aepUserLdap--_mobilenr
    • Display name: --aepUserLdap--_mobilenr
    • Type: String
    • Field Group: --aepUserLdap-- - Profile Identification Field Group

This is how each field should look after your initial field configuration.

  • --aepUserLdap--_mobilenr

Data Ingestion

To save your field, scroll down in the Field Properties until you see the button Apply. Click the Apply button.

Data Ingestion

  • --aepUserLdap--_ecid

Data Ingestion

Don鈥檛 forget to scroll down and click Apply.

  • --aepUserLdap--_emailId

Data Ingestion

Don鈥檛 forget to scroll down and click Apply.

Each field is defined as type String and you鈥檒l now configure these fields as Identities. For this schema, we assume that a customer will always be identified by their email-address, which means that you have to configure the field emailId as a primary identifier, and the other fields as normal identifiers.

Your 3 fields now have to be defined as Identity-fields.

Data Ingestion

To start defining these fields as Identity-fields, follow these steps:

  • Select the field --aepUserLdap--_emailId.
  • On the right side, in the field properties, scroll down until you see Identity. Check the checkbox for Identity.

Data Ingestion

  • Now check the checkbox for Primary Identity.

Data Ingestion

  • Lastly, select the namespace Email from the list of Namespaces. A Namespace is used by the Identity Graph in 51黑料不打烊 Experience Platform to classify identifiers in namespaces and define the relationship between those namespaces. Click Apply to save your changes.

Data Ingestion

Next, you have to define the other fields for --aepUserLdap--_ecid and --aepUserLdap--_mobilenr as standard identifiers.

Select the field --aepUserLdap--_ecid. On the right side, in the field properties, scroll down until you see Identity. Check the checkbox for Identity.
Next, select the namespace ECID from the list of Namespaces.
Click Apply to save your changes.

Data Ingestion

Select the field --aepUserLdap--_mobilenr. On the right side, in the field properties, scroll down until you see Identity. Check the checkbox for Identity.
Select the namespace Phone from the list of Namespaces.
Click Apply to save your changes.

Data Ingestion

The identification object should now look like this, with the 3 id-fields now also showing a fingerprint icon to show that they have been defined as identifiers.

Data Ingestion

Click Save to save your changes.

Data Ingestion

The last thing to do here, is to activate the Schema to be linked to the Profile.
By enabling your schema for Profile, you鈥檙e making sure that all data sent to 51黑料不打烊 Experience Platform against this schema will be part of the Real-time Customer Profile environment, which makes sure that all that data can be used in real-time for querying, segmentation and activation.

To do this, select the name of your schema.

Data Ingestion

In the right tab of your schema, click the Profile toggle, which is currently deactivated.

Data Ingestion

Activate the Profile - switch by clicking it.

Click Enable to enable this schema for Profile.

Data Ingestion

Your Schema is now configured to be part of the Real-time Customer Profile. Click Save to save your schema.

Data Ingestion

What does this customer do?

Capturing the answer to the question What does this customer do? for your organisation is done through for instance a product view on a product page.

Data Ingestion

From a schema perspective, we look at this as a Class. The question: What does this customer do? is something that we鈥檝e defined in the class ExperienceEvent.

So when you create an XDM Schema to capture the answer to What does this customer do?, first of all, you鈥檒l need to create and define 1 schema that references the class ExperienceEvent.

To specify what kind of answers can be given to that question, you鈥檒l need to define Field Group. Field Groups are extensions of the ExperienceEvent Class, and have very specific configurations. For instance, information about what kind of products a customer viewed or added to their cart is part of the Field Group Commerce Details.

Secondly, your organisation needs to decide how you鈥檒l identify the behavior of this customer. Since we鈥檙e talking about interactions on a website, it鈥檚 possible that your organisation knows the customer but it鈥檚 equally possible that an unknown, anonymous visitor is active on the website. So we can鈥檛 use an identifier like email-address. In this case, your organisation will probably decide to use the Experience Cloud ID (ECID) as the primary identifier.

Lastly, it鈥檚 important to distinguish the channel on which data was captured. In this case, we鈥檒l be talking about Website Interactions and the schema that needs to be defined needs to reflect where the interaction data was captured. The channel will also have an important role in influencing what data is captured. As such, it鈥檚 a best practice to define schema鈥檚 for every combination of channel, primary identifier and type of data collected.

Based on the above, you鈥檒l need to configure a schema in 51黑料不打烊 Experience Platform.

After logging in, you鈥檒l land on the homepage of 51黑料不打烊 Experience Platform.

Data Ingestion

Before you continue, you need to select a sandbox. The sandbox to select is named --aepSandboxName--. After selecting the appropriate sandbox, you鈥檒l see the screen change and now you鈥檙e in your dedicated sandbox.

Data Ingestion

In 51黑料不打烊 Experience Platform, click on Schemas in the menu on the left side of your screen and go to Browse. You should create a new schema. To create a new schema, click on the button + Create Schema.

Data Ingestion

Select Manual and click Select.

Data Ingestion

Select Experience Event and click Next.

Data Ingestion

Enter a name for the schema, like this: --aepUserLdap-- - Demo System - Event Schema for Website. Click Finish.

Data Ingestion

A new schema is created and you can configure what data will be collected against it.

Data Ingestion

Now you need to define what an answer to the question What does this customer do? should look like.
In the introduction of this lab, we noted the need for following attributes to define what a customer does:

  • Which pages or products have been visited?
  • Has this customer added a product to their cart or even purchased an item?
  • What device and browser has been used to browse the website?
  • What kind of information is this customer looking for and how can we use that to configure and deliver a delightful experience to this customer?
  • Primary Identifier for a customer

To make that information part of your schema, you need to add the following Field Group to your schema:

  • AEP Web SDK ExperienceEvent
  • your organisation鈥檚 custom Profile Identification Field Group

Click + Add under Field groups.

Data Ingestion

In the Add Field Group screen, select the Field Group AEP Web SDK ExperienceEvent. Click Add Field Groups.

Data Ingestion

You鈥檒l then have this:

Data Ingestion

Next, you need to create a new Field Group to capture the Identifier used for data collection.

You will now create your own custom Field Group and as such, you鈥檒l be extending the XDM Schema to meet your own organisation鈥檚 requirements.

A Field Group is linked to a Class, so that means that you can鈥檛 simply reuse the previously created Field Group.

Click the + Add button to start adding a Field Group.

Data Ingestion

Instead of reusing an existing Field Group, you鈥檒l now create your own Field Group. Select Create New Field Group and enter the name for your Field Group, like this: --aepUserLdap-- - ExperienceEvent Identification Field Group.
Click Add field groups

Data Ingestion

You should now have this Schema structure in place.

Data Ingestion

Your new Field Group is still empty, so now you鈥檒l have to add fields to that Field Group.
In the Field Group-list, click your custom Field Group.

Data Ingestion

You now see a number of new buttons appear.

On the top-level of your Schema, next to your Schema - name, click the + button.

Data Ingestion

After clicking the + button, you now see a new untitled field in your schema.

Use this to define your new field:

  • Field name: --aepUserLdap--_identification
  • Display name: --aepUserLdap--_identification
  • Type: Object
  • Field Group: --aepUserLdap-- - ExperienceEvent Identification Field Group

Click Apply.

Data Ingestion

Your new field is now created under your 51黑料不打烊 Experience Platform Tenant ID. Your 51黑料不打烊 Experience Platform tenant id is --aepTenantId--.

Data Ingestion

You鈥檒l now add 1 new field under the identification object.

Click the + button next to the identification object to create a new field.

Data Ingestion

The ECID-field will be defined as type String and you鈥檒l configure this field as an Identity. For the Schema Demo System - Event Schema for Website, we assume that a customer will always be identified by their ECID, which means that you have to configure the field ECID as a primary identifier

You now have an empty field. You need to configure the above field as indicated.

  • ecid:

    • Field name: --aepUserLdap--_ecidweb
    • Display name: --aepUserLdap--_ecidweb
    • Type: String
    • Field Group: --aepUserLdap-- - ExperienceEvent Identification Field Group

This is how the --aepUserLdap--_ecidweb-field should look after your initial field configuration:

Data Ingestion

Scroll down and click Apply.

Data Ingestion

You now have a new field, but this field hasn鈥檛 been defined as an Identity-field yet.

Data Ingestion

To start defining these fields as Identity-fields, select the field --aepUserLdap--_ecidweb.
On the right side, in the field properties, scroll down until you see Identity. Check the checkbox for Identity and check the checkbox for Primary Identity.
Select the namespace ECID from the list of Namespaces.

Click Apply to save your changes.

Data Ingestion

The identification object should now look like this, with the ecid-field now also showing a fingerprint icon to show that they have been defined as identifiers.
Click Save to save your changes.

Data Ingestion

It鈥檚 important to note that when eventually ingesting data against this schema, that some fields are required.
For instance, the fields _id and timestamp are required fields, which is a requirement that is imposed by the ExperienceEvent Class.

  • _id needs to contain a unique id for a specific data ingestion
  • timestamp needs to be the timestamp of this hit, in the format "YYYY-MM-DDTHH:MM:SSSZ", like for instance: "2024-11-18T07:20:000Z"

You have now defined a schema, linked existing and newly created Field Groups and have defined identifiers.

The last thing to do here, is to activate the Schema to be linked to the Profile.
By enabling your schema for Profile, you鈥檙e making sure that all data sent to 51黑料不打烊 Experience Platform against this schema will be part of the Real-time Customer Profile, which makes sure that all that data can be used in real-time for querying, segmentation and activation.

To do this, click the name of your schema.

Data Ingestion

In the right tab of your schema, you鈥檒l see a Profile toggle, which is currently deactivated. Click the Profile - switchto enable it.

Data Ingestion

You鈥檒l see this message. Click Enable to enable this schema for Profile.

Data Ingestion

Your schema is now configured to be part of the Real-time Customer Profile.

Click Save to save your schema.

Data Ingestion

You鈥檝e now finished building schemas that are activated to be used in the Real-time Customer Profile.

Let鈥檚 have a look at datasets in the next exercise.

Next Step: 1.2.3 Configure Datasets

Go Back to Module 1.2

Go Back to All Modules

recommendation-more-help
aeafc5b5-cd01-4e88-8d47-d76c18d7d349