Create a schema using the Schema Editor

The Adobe Experience Platform user interface allows you to create and manage Experience Data Model (XDM) schemas in an interactive visual canvas called the Schema Editor. This tutorial covers how to create a schema using the Schema Editor.

For demonstration purposes, the steps in this tutorial involve creating an example schema that describes members of a customer loyalty program. While you can use these steps to create a different schema for your own purposes, it is recommended that you first follow along with creating the example schema to learn the capabilities of the Schema Editor.

Getting started

This tutorial requires a working understanding of the various aspects of Adobe Experience Platform involved in schema creation. Before beginning this tutorial, please review the documentation for the following concepts:

Open the Schemas workspace browse

The Schemas workspace in the Platform UI provides a visualization of the Schema Library, allowing you to view manage the schemas available for your organization. The workspace also includes the Schema Editor, the canvas on which you can compose a schema throughout this tutorial.

After logging into Experience Platform, select Schemas in the left navigation to open the Schemas workspace. The Browse tab displays a list of schemas (a representation of the Schema Library) for you to view and customize. The list includes the name, type, class, and behavior (record or time-series) on which the schema is based, as well as the date and time the schema was last modified.

See the guide on exploring existing XDM resources in the UI for more information.

Create and name a schema create

To begin composing a schema, select Create schema in the top-right corner of the Schemas workspace.

The Create a schema dialog appears. In this dialog, you can choose to either manually create a schema by adding fields and field groups, or you can upload a CSV file and use ML algorithms to generate a schema. Select a schema creation workflow from the dialog.

[Beta]{class="badge informative"} Manual or ML-assisted schema creation manual-or-assisted

To learn how you can use a ML algorithm to recommend a schema structure based on an uploaded file, see the machine learning-assisted schema creation guide. This UI guide focusses on the manual creation workflow.

Choose a base class choose-a-class

The Create schema workflow appears. Next, choose a base class for the schema. You can choose between the core classes of XDM Individual Profile and XDM ExperienceEvent, or Other if these classes do not suit your purposes. The Other classes option allows you to either create a new class or choose from other pre-existing classes.

See the XDM individual profile and XDM ExperienceEvent documentation for more information on these classes. For the purposes of this tutorial, select XDM Individual Profile followed by Next.

Name and review name-and-review

After you have selected a class, the Name and review section appears. In this section, you provide a name and description to identify your schema. There are several important considerations to make when deciding on a name for your schema:

This tutorial composes a schema to ingest data related to the members of a loyalty program, and therefore the schema is named “Loyalty Members”.

​The schema’s base structure (provided by the class) is shown in the canvas for you to review and verify your selected class and schema structure.

Enter a human-friendly Schema display name in the text field. Next, enter a suitable description to help identify your schema. When you have reviewed your schema structure and are happy with your settings, select Finish to create your schema.

Compose your schema compose-your-schema

The Schema Editor appears. This is the canvas upon which you will compose your schema. The self-titled schema is automatically created in the Structure section of the canvas when you arrive in the editor, along with the standard fields included in the base class that you selected. The assigned class for the schema is also listed under Class in Composition section.

Add a field group field-group

You can now begin to add fields to your schema by adding field groups. A field group is a group of one or more fields that are often used together to describe a particular concept. This tutorial uses field groups to describe the members of the loyalty program and capture key information such as name, birthday, phone number, address, and more.

To add a field group, select Add in the Field groups sub-section.

A new dialog appears, displaying a list of available field groups. Each field group is only intended for use with a specific class, therefore the dialog only lists field groups that are compatible with the class you selected (in this case, the XDM Individual Profile class). If you are using a standard XDM class, the list of field groups will be intelligently sorted based on usage popularity.

You can select one of the filters in the left rail to narrow down the list of standard field groups to specific industries like retail, financial services, and healthcare.

Selecting a field group from the list causes it to appear in the right rail. You can select multiple field groups if desired, adding each one to the list in the right rail before confirming. In addition, an icon appears on the right side of the currently selected field group which allows you to preview the structure of the fields it provides.

When previewing a field group, a detailed description of the field group’s schema is provided in the right rail. You can also navigate through the field group’s fields in the provided canvas. As you select different fields, the right rail updates to show details about the field in question. Select Back when you are finished previewing to return to the field group selection dialog.

For this tutorial, select the Demographic Details field group, then select Add field group.

The schema canvas reappears. The Field groups section now lists “Demographic Details” and the Structure section includes the fields contributed by the field group. You can select the field group’s name under the Field groups section to highlight the specific fields it provides within the canvas.

NOTE

Within the Schema Editor, standard (Adobe-generated) classes and field groups are indicated with the padlock icon ( . The padlock appears in the left rail next to the class or field group name, as well as next to any field in the schema diagram that is a part of a system-generated resource.

This field group contributes several fields under the top-level name person with the data type “Person”. This group of fields describes information about an individual, including name, birth date, and gender.

Notice that the name field has a data type of “Full name”, meaning it too describes a common concept and contains name-related sub-fields such as first name, last name, courtesy title, and suffix.

Select the different fields within the canvas to reveal any additional fields they contribute to the schema structure.

Add more field groups field-group-2

You can now repeat the same steps to add another field group. When you view the Add field group dialog this time, notice that the “Demographic Details” field group has been greyed out and the checkbox next to it cannot be selected. This prevents you from accidentally duplicating field groups that you have already included in the current schema.

For this tutorial, select the standard field groups Personal Contact Details and Loyalty Details from the list, then select Add field groups to add them to the schema.

The canvas reappears with the added field groups listed under Field groups in the Composition section, and their composite fields added to the schema structure.

Define a custom field group define-field-group

The Loyalty Members schema is meant to capture data related to the members of a loyalty program, and the standard Loyalty Details field group that you added to the schema provides most of these, including the program type, points, join date, and more.

However, there may be a scenario where you want to include additional custom fields not covered by standard field groups in order to achieve your use cases. In the case of adding custom loyalty fields, you have two options:

To create a new field group, select Add in the Field groups sub-section like before, but this time select Create New Field group near the top of the dialog that appears. You are then asked to provide a display name and description for the new field group. For this tutorial, name the new field group “Custom Loyalty Details”, then select Add field groups.

“Custom Loyalty Details” should now appear under Field groups on the left side of the canvas, but there are no fields associated with it yet and therefore no new fields appear under Structure.

Add fields to the field group field-group-fields

Now that you have created the “Custom Loyalty Details” field group, it is time to define the fields that the field group will contribute to the schema.

To begin, select the plus (+) icon next to the name of the schema in the canvas.

An “Untitled Field” placeholder appears in the canvas, and the right rail updates to reveal configuration options for the field.

In this scenario, the schema needs to have an object-type field that describes the person’s current loyalty tier in detail. Using the controls in the right rail, start creating a loyaltyTier field with type “Object” that will be used to hold your related fields.

Under Assign to, you must select a field group to assign the field to. Remember that all schema fields belong to either a class or a field group, and since this schema uses a standard class, your only option is to select a field group. Start typing in the name “Custom Loyalty Details”, then select the field group from the list.

When finished, select Apply.

The changes are applied and the newly created loyaltyTier object appears. Since this is a custom field, it is automatically nested within an object namespaced to your organization’s tenant ID, preceded by an underscore (_tenantId in this example).

Select the plus (+) icon next to the loyaltyTier object to start adding sub-fields. A new field placeholder appears and the Field properties section is visible on the right side of the canvas.

Each field requires the following information:

The first field for the loyaltyTier object will be a string called id, representing the ID of the loyalty member’s current tier. The tier ID will be unique for each loyalty member, since this company sets different loyalty tier point thresholds for each customer based on different factors. Set the new field’s type to “String”, and the Field properties section becomes populated with several options for applying constraints, including default value, format, and maximum length. See the documentation on best practices for data validation fields to learn more.

Since id will be a randomly generated freeform string, no further constraints are necessary. Select Apply to apply your changes.

Add more fields to the field group field-group-fields-2

Now that you have added the id field, you can add additional fields to capture loyalty tier information such as:

To add each field to the schema, select the plus (+) icon next to the loyalty object and fill in the required information.

When complete, the loyaltyTier object will contain fields for id, currentThreshold, nextThreshold, and effectiveDate.

Add an enum field to the field group enum

When defining fields in the Schema Editor, there are some additional options that you can apply to basic field types in order to provide further constraints on the data the field can contain. The use cases for these constrains are explained in the following table:

For this tutorial, the loyaltyTier object in the schema requires a new enum field that describes the tier class, where the value can only be one of four possible options. To add this field to the schema, select the plus (+) icon beside the loyaltyTier object and fill in the required fields for Field name and Display name. For Type, select “String”.

Additional checkboxes appear for the field after its type has been selected, including checkboxes for Array, Enum & Suggested Values, Identity, and Relationship.

Select the Enum & Suggested Values checkbox, then select Enum. Here you can input the Value (in camelCase) and Display Name (an optional, reader-friendly name in Title Case) for each acceptable loyalty tier class.

When you have completed all field properties, select Apply to add the tierClass field to the loyaltyTier object.

Convert a multi-field object into a data type datatype

The loyaltyTier object now contains several fields and represents a common data structure that could be useful in other schemas. The Schema Editor allows you to readily apply reusable multi-field objects by converting the structure of those objects into data types.

Data types allow for the consistent use of multi-field structures and provide more flexibility than a field group because they can be used anywhere within a schema. This is done by setting the field’s Type value to that of any data type defined in the Schema Registry.

To convert the loyaltyTier object to a data type, select the loyaltyTier field in the canvas, then select Convert to new data type on the right side of the editor under Field properties.

A notification appears, confirming that the object has been successfully converted. In the canvas you can now see that the loyaltyTier field now has a link icon, and the right rail indicates it has a data type of “Loyalty Tier”.

In a future schema, you could now assign a field as a “Loyalty Tier” type and it would automatically include fields for ID, tier class, point thresholds, and effective date.

Search and filter schema fields

Your schema now contains several field groups in addition to the fields provided by its base class. When working with larger schemas, you can select the checkboxes next to field group names in the left rail to filter the displayed fields to only those provided by the field groups you are interested in.

If you are looking for a specific field in your schema, you can also use the search bar to filter displayed fields by name, regardless of which field group they are provided under.

Set a schema field as an identity field identity-field

The standard data structure that schemas provide can be leveraged to identify data belonging to the same individual across multiple sources, allowing for various downstream use cases such as segmentation, reporting, data science analysis, and more. In order to stitch data based on individual identities, key fields must be marked as Identity fields within applicable schemas.

Experience Platform makes it easy to denote an identity field through the use of an Identity checkbox in the Schema Editor. However, you must determine which field is the best candidate to use as an identity, based on the nature of your data.

For example, there may be thousands of loyalty program members belonging to the same loyalty level, and several that may share the same physical address. In this scenario, however, on enrollment each member of the loyalty program provides their personal email address. Since personal email addresses are usually managed by one person, the field personalEmail.address (provided by the Personal Contact Details field group) is a good candidate for an identity field.

Select the personalEmail.address field in the canvas, and the Identity checkbox appears under Field properties. Check the box and the option to set this as the Primary identity appears. Select this box as well.

Next, you must provide an Identity namespace from the list of pre-defined namespaces in the dropdown. Since this field is the customer’s email address, select “Email” from the dropdown. Select Apply to confirm the updates to the personalEmail.address field.

After applying the change, the icon for personalEmail.address shows a fingerprint symbol, indicating that it is now an identity field. The field is also listed in the left rail under Identities.

Now all data ingested into the personalEmail.address field will be used to help identify that individual and stitch together a single view of that customer. To learn more about working with identities in Experience Platform, please review the Identity Service documentation.

Enable the schema for use in Real-Time Customer Profile profile

Real-Time Customer Profile leverages identity data in Experience Platform to provide a holistic view of each individual customer. The service builds robust, 360° profiles of customer attributes as well as timestamped accounts of every interaction customers have had across any system integrated with Experience Platform.

In order for a schema to be enabled for use with Real-Time Customer Profile, it must have a primary identity defined. You will receive an error message if you attempt to enable a schema without first defining a primary identity.

To enable the “Loyalty Members” schema for use in Profile, begin by selecting the schema title in the canvas.

On the right side of the editor, information is shown about the schema including its display name, description, and type. In addition to this information, there is a Profile toggle button.

Select Profile and a popover appears, asking you to confirm that you wish to enable the schema for Profile.

Select Enable to confirm your choice. You can select the Profile toggle again to disable the schema if you wish, but once the schema has been saved while Profile is enabled, it can no longer be disabled.

More actions more

Within the Schema Editor you can also conduct quick actions to copy the JSON structure of the schema or delete the schema. Select More at the top of the view to display a drop down with quick actions.

Delete a schema delete-a-schema

A schema can be deleted within the UI from the Schema Editor using More actions and also from the schema details in the Browse tab. There are certain conditions that prevent a schema from being deleted. A schema cannot be deleted if:

Copy JSON structure copy-json-structure

Select Copy JSON structure to generate an export payload for any schema in the Schema Library. This action copies the JSON structure to your clipboard. Your exported JSON can then be used to import the schema, and any related resources, into a different sandbox or organization. This makes sharing and reusing schemas between different environments simple and efficient.

Next steps and additional resources

Now that you have finished composing the schema, you can see the complete schema in the canvas. Select Save and the schema will be saved to the Schema Library, making it accessible by the Schema Registry.

Your new schema can now be used to ingest data into Platform. Remember that once the schema has been used to ingest data, only additive changes may be made. See the basics of schema composition for more information on schema versioning.

You can now follow the tutorial on defining a schema relationship in the UI to add a new relationship field to the “Loyalty Members” schema.

The “Loyalty Members” schema is also available to be viewed and managed using the Schema Registry API. To begin working with the API, start by reading the Schema Registry API developer guide.

Video resources

The following video shows how to create a simple schema in the Platform UI.

The following video is intended to reinforce your understanding of working with field groups and classes.

Appendix

The following sections provide addition information information regarding the use of the Schema Editor.

Create a new class create-new-class

Experience Platform provides the flexibility to define a schema based on a class that is unique to your organization. To learn how to create a new class, see the guide on creating and editing classes in the UI.

Change the class of a schema change-class

You can change the class of a schema at any point during the initial composition process before the schema has been saved.

To learn how to change the class of a schema, see the guide on managing schemas in the UI.