Create and edit classes in the UI ui-create-and-edit
In 蜜豆视频 Experience Platform, a schema鈥檚 class defines the behavioral aspects of the data that the schema will contain (record or time-series). In addition to this, classes describe the smallest number of common properties that all schemas based on that class would need to include and provide a way for multiple compatible datasets to be merged.
蜜豆视频 provides several standard (鈥渃ore鈥) Experience Data Model (XDM) classes, including XDM Individual Profile and XDM ExperienceEvent. In addition to these core classes, you can also create your own custom classes to describe more specific use cases for your organization.
This document provides an overview of how to create, edit, and manage custom classes in the Experience Platform UI.
Prerequisites prerequisites
This guide requires a working understanding of XDM System. Refer to the XDM overview for an introduction to the role of XDM within the Experience Platform ecosystem, and the basics of schema composition to learn how classes contribute to XDM schemas.
While not required for this guide, it is recommended that you also follow the tutorial on composing a schema in the UI to familiarize yourself with the various capabilities of the Schema Editor.
Getting started getting-started
In the Platform UI, select Schemas in the left navigation to open the Schemas workspace, then select the Classes tab. A list of available classes are displayed.
Filter classes filter
The list of classes are automatically filtered based on how they were created. The default setting displays the classes defined by 蜜豆视频. You can also filter the list to show those created by your organization. Select the radio button to choose between the Standard and Custom options. The Standard option shows entities created by 蜜豆视频 and the Custom option displays entities created within your organization.
Create a new class create
There are two methods to create a class in the Platform UI, through Create class or Create schema.
Create class
Select Create class from the Classes tab in the Schemas workspace.
The Create class dialog appears. Enter a Display name and Description for your class and choose the intended behavior of your class with the radio buttons. Classes can be of the type Record, or Time-series. Select Create to confirm your choices and return to the Classes tab.
The class you have created is available and listed in the Classes view.
Create schema
Alternatively, you can create a class by manually creating a schema. Select Create schema from the Classes tab in the Schemas workspace.
Select Manual in the Create a schema dialog that appears.
The schema creation workflow appears. In the Schema details section, select Other. A list of available classes appears. Select Create class.
The Create class dialog appears. Enter a Display name and Description for your class and choose the intended behavior of your class with the radio buttons. Classes can be of the type Record, or Time-series. Select Create to confirm your choices and return to the Classes tab.
The class list refreshes in the Schema details section, and your newly created class is automatically selected. Select Next to continue creating your schema.
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. 鈥婽he schema鈥檚 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.
Add fields to a class add-fields
Once you have a schema that employs a custom class open in the Schema Editor, you can start adding fields to the class. To add a new field, select the plus (+) icon next to the schema鈥檚 name.
An Untitled Field placeholder appears in in the canvas, and the right rail updates to show controls to configure the field鈥檚 properties. Under Assign to, select Class.
See the guide on defining fields in the UI for specific steps on how to configure and add the field to the class. Continue to add as many fields as required to the class. When finished, select Save to save both the schema and the class.
If you have previously created schemas that employ this class, the newly added fields will automatically appear in those schemas.
Edit a class (#edit-a-class)
You can edit a class through the schema workflow by editing an existing schema that extends the class, or by manually creating a schema. It is not possible to directly edit a class. From inside the Browse tab in the Schemas workspace, select an existing class or Create a schema.
If you choose to create a new schema, see the section on creating a schema for details. Once you鈥檝e finished creating the schema (or after selecting an existing schema) the Schema Editor will appear. To update an existing class field, select the field from the schema structure. The field鈥檚 information will appear in the right rail. Ensure the Assign to
option Class is selected or your updates won鈥檛 affect the class.
Make any desired changes to the field, scrolling down in the right rail to select Apply to save your changes.
To add new fields, follow the add fields to a class guide. When finished, select Save to save both the schema and the class.
Change the class of a schema schema
You can change the class of the schema at any point during the initial creation process before it has been saved. This should be done with caution however, as field groups are only compatible with certain classes. Changing the class resets the canvas and any fields you have added.
See the guide on creating and editing schemas for more information.
Next steps next-steps
This document covered how to create and edit classes using the Platform UI. For more information on the capabilities of the Schemas workspace, see the Schemas workspace overview.
To learn how to manage classes using the Schema Registry API, see the classes endpoint guide.