Create an XDM schema to use with your Customer Journey Analytics Web SDK implementation

NOTE
Follow the steps on this page only after you complete all previous upgrade steps. You can follow the recommended upgrade steps, or you can follow the upgrade steps that were dynamically generated for your organization with the Adobe Analytics to Customer Journey Analytics upgrade questionnaire.
After you complete the steps on this page, continue following the recommended upgrade steps or the dynamically generated upgrade steps.
IMPORTANT
Before you begin creating your XDM schema, work with your data team and other stakeholders throughout your organization to identify your organization’s ideal schema design for Customer Journey Analytics and the other Adobe Experience Platform applications you use. For more information, see Architect your schema for use with Customer Journey Analytics.

Adobe recommends creating an Experience Data Model (XDM) schema when upgrading to Customer Journey Analytics. An XDM schema allows for a streamlined schema that is tailored to the needs of your organization and the specific Platform applications that you use. When changes to the schema are required, you don’t have to sift through thousands of unused fields to find the field that requires updating.

Create the schema

The XDM schema you define represents the model of the data that you collect into Adobe Experience Platform.

To create a schema:

  1. In Adobe Experience Platform, in the left rail, select Schemas within DATA MANAGEMENT.

  2. Select Create schema.

  3. In the Select a class step of the Create schema wizard:

    1. Select Experience Event.

      Create a schema highlighting Experience Event

      note info
      INFO
      An Experience Event schema is used to model the behavior of a profile (like scene name, push button to add to cart). An Individual Profile schema is used to model the profile attributes (like name, email, gender).
    2. Select Next.

  4. In the Name and review step of the Create schema wizard:

    1. Enter a Schema display name for your schema and (optional) a Description.

      Create schema window showing the Name your schema fields

    2. Select Finish.

  5. Add all field groups that contain any fields that you want to include in your schema.

    Field groups are reusable collections of objects and attributes that allow you to easily extend your schema.

    1. In the Field groups section, select + Add.

      Add field group

    2. In the Add fields groups dialog, select the AEP Web SDK ExperienceEvent field group from the list.

      AEP Web SDK ExperienceEvent fieldgroup

      You can select the preview button, to see a preview of the fields that are part of this field group, like web > webPageDetails > name.

      AEP Web SDK ExperienceEvent fieldgroup preview

      Select Back to close the preview.

    3. (Optional) Select any additional field groups that you want to include.

    4. Select Add field groups.

  6. (Optional) If you have custom fields that you want to include in your schema, create a custom field group and add the custom fields to the field group.

    1. In the Field groups section, select + Add.

      Add field group

    2. In the Add fields groups dialog, select Create new field group.

    3. Specify a display name and optional description, then select Add field groups.

  7. Select + next to your schema name in the Structure panel.

    Example Schema Add Field button

  8. In the Field Properties panel, enter Identification as the name, Identification as the Display name, select Object as the Type and select ExperienceEvent Core v2.1 as the Field Group.

    note note
    NOTE
    If that field group is not available, look for another field group containing identity fields. Or create a new field group and add new identity fields (like ecid, crmId, and others you need) to the field group and select that new field group.

    Identification Object

    The identification object adds identification capabilities to your schema. In your case, you want to identify profiles visiting your site using the Experience Cloud ID and email address. There are many other attributes available to track your person’s identification (for example customer id, loyalty id).

    Select Apply to add this object to your schema.

  9. Select the ecid field in the identification object you just added, and select Identity and Primary Identity and ECID from the Identity namespace list in the right panel.

    Specifiy ECID as identity

    You are specifying the Experience Cloud Identity as the primary identity the Adobe Experience Platform Identity service can use to combine (stitch) the behavior of profiles with the same ECID.

    Select Apply. You see that a fingerprint icon appears in the ecid attribute.

  10. Select the email field in the identification object you just added, and select Identity and Email from the Identity namespace list in the Field Properties panel.

    Specifiy email as identity

    You are specifying the email address as another identity the Adobe Experience Platform Identity service can use to combine (stitch) the behavior of profiles.

    Select Apply. You see that a fingerprint icon appears in the email attribute.

    Select Save.

  11. (Optional) If you want to integrate Customer Journey Analytics with RTCDP, select the root element of your schema displaying the name of the schema, then select the Profile switch.

    You are prompted to enable the schema for profile. Once enabled, when data is ingested into datasets based on this schema, that data is merged into the Real-Time Customer Profile.

    See Enable the schema for use in Real-Time Customer Profile for more information.

    note important
    IMPORTANT
    After you enable a schema for profile, it cannot be disabled for profile.

    Enable schema for profile

  12. Select Save to save your schema.

    You have created a minimal schema that models the data you can capture from your website. The schema allows profiles to be identified using the Experience Cloud Identity and email address. By enabling the schema for profile, you ensure data captured from your website is added to the Real-Time Customer Profile.

    Next to behavior data, you can also capture profile attribute data from your site (for example details of profiles subscribing to a newsletter).

    To capture this profile data, you would:

    • Create a schema based on the XDM Individual Profile class.

    • Add the Profile Core v2 field group to the schema.

    • Add an identification object based on the Profile Core v2 field group.

    • Define Experience Cloud ID as primary identifier and email as identifier.

    • Enable the schema for profile

    See Create and edit schemas in the UI for more information on adding and removing field groups and individual fields to a schema.

  13. Continue following the recommended upgrade steps or the dynamically generated upgrade steps.

recommendation-more-help
080e5213-7aa2-40d6-9dba-18945e892f79