使用Schema Editor创建模式

Adobe Experience Platform用户界面允许您在称为Schema Editor的交互式可视画布中创建和管理Experience Data Model (XDM)模式。 本教程介绍如何使用Schema Editor创建模式。

注意

出于演示目的,本教程中的步骤包括创建一个描述客户忠诚度项目成员的示例模式。 虽然您可以使用这些步骤为自己创建不同的模式,但建议您首先创建示例模式,以了解Schema Editor的功能。

如果您希望使用Schema Registry API编写模式,请先阅读Schema Registry 开发人员指南,然后尝试使用创建模式时的教程

入门指南

本教程要求对Adobe Experience Platform在创建模式时涉及的各个方面有充分的了解。 在开始本教程之前,请查阅以下概念的文档:

打开模式工作区

Platform UI中的模式工作区提供了Schema Library的可视化,允许您视图管理组织可用的模式。 工作区还包括Schema Editor,在本教程中,您可以在该画布上构建模式。

登录Experience Platform后,在左侧导航中选择​模式​以打开​模式​工作区。 “浏览”选项卡显示一列表模式(Schema Library的表示形式),您可以对其进行视图和自定义。 列表包括模式所基于的名称、类型、类和行为(记录或时间序列),以及模式上次修改的日期和时间。

有关详细信息,请参阅探索UI中现有XDM资源的指南。

创建模式并命名

要开始合成模式,请选择​模式​工作区右上角的​创建模式。 此时将显示一个下拉菜单,允许您选择核心类XDM单个用户档案和XDM ExperienceEvent。 如果这些类不适合您的用途,您还可以选择​浏览​以从其他可用类中进行选择,或者创建新类

为本教程的目的,请选择​XDM单个用户档案

出现Schema Editor。 这是您将在其上合成模式的画布。 由于您选择了标准XDM类作为模式的基础,因此当您到达编辑器时,将在画布的​结构​部分自动创建未命名模式,并在基于该类的所有模式中包含标准字段。 该模式的分配类也列在​Composition​部分的​Class​下。

注意

在保存模式之前,您可以在初始合成过程中的任何时间点更改模式的类,但应非常小心。 Mixins仅与某些类兼容,因此更改类将重置画布和您添加的任何字段。

使用编辑器右侧的字段为模式提供显示名称和可选说明。 输入名称后,画布会随之更新,以反映模式的新名称。

在为模式确定名称时,需要考虑以下几个重要事项:

  • 模式名称应简短且描述性,以便以后可以轻松找到模式。
  • 模式名称必须是唯一的,这意味着它还应足够具体,以便将来不再重用它。 例如,如果您的组织有针对不同品牌的不同忠诚度项目,则最好将您的模式命名为“Brand A Loyalty Members”,以便与您稍后可能定义的其他与忠诚度相关的模式轻松区分。
  • 您还可以使用模式描述来提供有关模式的任何其他上下文信息。

本教程组成一个模式,用于收集与忠诚度项目成员相关的数据,因此该模式名为“忠诚度成员”。

添加混合

您现在可以通过添加混音开始向模式添加字段。 混音是一个或多个字段的组,这些字段通常一起用于描述特定的概念。 本教程使用mixins描述忠诚度项目的成员并捕获关键信息,如姓名、生日、电话号码、地址等。

要添加混音,请在​混音​子部分中选择​添加

此时将显示新对话框,显示可用混音的列表。 每个混音仅用于特定类,因此对话框仅列表与所选类(本例中为XDM Individual Profile类)兼容的混音。 如果您使用标准XDM类,将根据使用人气智能地对混合列表进行排序。

从列表中选择混音会导致混音显示在右侧边栏中。 您可以根据需要选择多个混音,在确认之前将每个混音添加到右侧边栏的列表。 此外,当前所选混音的右侧会显示一个图标,通过该图标可以预览其提供的字段的结构。

预览混音时,右边栏中提供了混音的模式的详细描述。 您还可以在提供的画布中浏览混音的字段。 当您选择不同的字段时,右侧边栏会更新,以显示有关该字段的详细信息。 在完成预览后选择​返回​以返回到混音选择对话框。

对于本教程,选择​人口统计详细信息​混音,然后选择​添加混音

将重新显示模式画布。 Mixins​部分现在列表“人口统计详细信息”,而​Structure​部分包括由mixin提供的字段。 您可以在​Mixins​部分下选择混音的名称,以突出显示它在画布中提供的特定字段。

此混音在顶级名称person下提供数据类型为“Person”的多个字段。 这组字段描述有关个人的信息,包括姓名、出生日期和性别。

注意

请记住,字段可能使用标量类型(如字符串、整数、数组或日期)以及Schema Registry中定义的任何数据类型(表示通用概念的一组字段)。

请注意,name字段的数据类型为“人名”,这意味着它也描述了一个通用概念,并包含与名称相关的子字段,如名、姓、名、字幕和后缀。

在画布中选择不同的字段,以显示它们贡献到模式结构的任何其他字段。

添加另一个混音

现在,您可以重复相同的步骤以添加另一个混音。 当您此次视图​添加mixin​对话框时,请注意,“人口统计详细信息”混音已灰显,且其旁边的复选框无法选中。 这样可以防止您意外复制已包含在当前模式中的混音。

对于本教程,从对话框中选择“Personal Contact Details” mixin,然后选择​添加mixin​将其添加到模式。

添加后,画布将重新显示。 "个人联系详细信息"现在列在​合成​部分的​Mixins​下,在​结构​下添加了用于家庭地址、移动电话等的字段。

name字段类似,您刚添加的字段表示多字段概念。 例如,homeAddress的数据类型为“邮政地址”,而mobilePhone的数据类型为“电话号码”。 您可以选择其中每个字段以展开它们,并查看数据类型中包含的其他字段。

定义新的混音

“忠诚度成员”模式用于捕获与忠诚度项目成员相关的数据,因此它需要一些特定的忠诚度相关字段。 没有包含必要字段的标准混音,因此您需要定义新混音。

此时,打开​添加混音​对话框时,请选择​创建新混音。 随后将要求您提供混音的显示名称和说明。

与类名一样,混音名称应简短,用于描述混音对模式的贡献。 这些名称也是唯一的,因此您将无法重用该名称,因此必须确保其足够具体。

在本教程中,将新混音命名为“忠诚度详细信息”。

选择​添加mixin​以返回到Schema Editor。 "忠诚度详细信息"现在应显示在画布左侧的​Mixins​下,但还没有与它关联的字段,因此在​Structure​下不显示新字段。

将字段添加到混音

现在您已创建“忠诚度详细信息”混音,现在应该定义混音将对模式贡献的字段。

要开始,请在​Mixins​部分选择混合名称。 执行此操作后,编辑器的右侧将显示mixin的属性,并且在​Structure​下模式名称旁边将显示一个​加号(+)​图标。

选择“Loyalty Members”旁边的​加号(+)​图标以在结构中创建新节点。 此节点(在此示例中称为_tenantId)表示您的IMS组织的租户ID,前面加下划线。 租户ID的存在表示您正在添加的字段包含在您组织的命名空间中。

换句话说,您添加的字段对您的组织而言是唯一的,将保存在Schema Registry中仅对您的组织可访问的特定区域。 您定义的字段必须始终添加到您的租户命名空间中,以防止与其他标准类、混音、数据类型和字段的名称发生冲突。

在该命名空间节点中是“新建字段”。 这是“忠诚度详细信息”混音的开始。

使用编辑器右侧的控件,通过创建类型为“Object”的loyalty字段来开始,该字段将用于保存您的忠诚度相关字段。 完成后,选择​应用

将应用更改,并显示新创建的loyalty对象。 选择对象旁边的​加号(+)​图标以添加其他与忠诚度相关的字段。 将显示“新建字段”,画布右侧将显示​字段属性​部分。

每个字段都需要以下信息:

  • 字段名: 以大小写混合写成的字段名称。示例:loyaltyLevel
  • 显示名称: 以标题大小写形式编写的字段名称。示例:忠诚度级别
  • 类型: 字段的数据类型。这包括基本标量类型和在Schema Registry中定义的任何数据类型。 示例:字符串、整数、布尔、人、地址、电话号码等。
  • 描述: 字段的可选描述应包括在内,以句子形式编写,最多包含200个字符。

Loyalty对象的第一个字段将是名为loyaltyId的字符串。 将新字段的类型设置为“String”时,Field属性​部分将填充几个用于应用约束的选项,包括默认值、格式和最大长度。

根据所选数据类型,可使用不同的约束选项。 由于loyaltyId将是电子邮件地址,请从​格式​下拉菜单中选择“email”。 选择​应用​以应用您的更改。

将更多字段添加到混音

现在,您已经添加了loyaltyId字段,可以添加其他字段来捕获与忠诚度相关的信息,例如:

  • 点(整数)
  • 会员自(日期)

要将每个字段添加到模式中,请选择loyalty对象旁的​加号(+)​图标并填写所需信息。

完成后,Loyalty对象将包含忠诚度ID、积分和成员 — 自的字段。

向混音添加枚举字段

在Schema Editor中定义字段时,可以对基本字段类型应用一些其他选项,以便对字段可包含的数据提供进一步约束。 下表说明了这些约束的用例:

约束 描述
必需 指示数据获取需要此字段。 在摄取时,任何基于此模式上载到不包含此字段的数据集的数据都将失败。
数组 指示字段包含一组值,每个值都指定了数据类型。 例如,对数据类型为“String”的字段使用此约束指定该字段将包含字符串数组。
枚举 指示此字段必须包含可能值的枚举列表中的值之一。
身份 指示此字段是标识字段。 本教程](#identity-field)的后面提供了有关标识字段的详细信息。[
关系 虽然可以通过使用模式模式和Real-time Customer Profile推断出合并关系,但这仅适用于共享同一类的模式。 Relationship约束表示此字段引用基于不同类的模式的主标识,这表示两个模式之间的关系。 有关详细信息,请参阅定义关系的教程。
注意

所有必填、标识或关系字段都显示在左边栏中,这样您便可以轻松定位这些字段,而不管模式的复杂性如何。

在本教程中,模式中的"loyalty"对象需要一个新枚举字段来描述客户的“忠诚度级别”,其中该值只能是四个可能选项之一。 要将此字段添加到模式,请选择loyalty对象旁边的​加号(+)​图标,并填写​字段名​和​显示名称​的必填字段。 对于​类型,选择“字符串”。

在选择字段类型后,将显示其他复选框,包括​ArrayEnum​和​Identity​的复选框。

选中​Enum​复选框以打开下面的​Enum值​部分。 在此,您可以为每个可接受的忠诚度级别输入​Value(在camelCase中)和​Label(在“标题大小写”中为可选、适合读者的名称)。

完成所有字段属性后,选择​应用​以将“loyaltyLevel”字段添加到loyalty对象。

将多字段对象转换为数据类型

loyalty对象现在包含多个特定于忠诚度的字段,并表示一个在其他模式中可能有用的通用数据结构。 Schema Editor允许您通过将这些对象的结构转换为数据类型来轻松应用可重用的多字段对象。

数据类型允许一致地使用多字段结构,并提供比混音更灵活的性能,因为它们可以在模式中的任何位置使用。 这是通过将字段的​Type​值设置为Schema Registry中定义的任何数据类型来实现的。

要将loyalty对象转换为数据类型,请在​Structure​下选择loyalty字段,然后在编辑器右侧的​Field properties​下选择​Convert to new data type。 出现绿色快显,确认对象已成功转换。

现在,当您查看​Structure​下时,您会发现loyalty字段的数据类型为“Loyalty”,并且这些字段旁边有小的锁图标,表明它们不再是单个字段,而是多字段数据类型的一部分。

在将来的模式中,您现在可以将字段指定为“Loyalty”类型,并自动包含ID、忠诚度级别、成员自身和积分的字段。

注意

您还可以创建和编辑自定义数据类型,而与编辑模式无关。 有关详细信息,请参阅创建和编辑数据类型的指南。

搜索和筛选模式字段

除了基类提供的字段外,您的模式现在还包含多个混音。 处理较大的模式时,您可以选中左边栏中混合名称旁边的复选框,以将显示的字段筛选为仅由您感兴趣的混合提供的字段。

如果您要在模式中查找特定字段,则还可以使用搜索栏按名称筛选显示的字段,而不管这些字段是在哪个混音中提供的。

重要

在显示匹配字段时,搜索函数会考虑任何选定的混音过滤器。 如果搜索查询未显示您期望的结果,您可能需要多次检查您是否未过滤掉任何相关混合。

将模式字段设置为标识字段

模式提供的标准数据结构可用于在多个源中识别属于同一个人的数据,从而允许不同的下游用例,如分段、报告、数据科学分析等。 要根据个人身份拼接数据,键字段必须标为适用模式中的Identity字段。

Experience Platform 通过使用中的“标识”复选框,可以轻松 ​地指示标识字 Schema Editor段但是,您必须根据数据的性质确定哪个字段是用作标识的最佳候选。

例如,可能有数千个忠诚度项目成员属于相同的“忠诚度级别”,但忠诚度项目的每个成员都有唯一的loyaltyId(在本例中为单个成员的电子邮件地址)。 loyaltyId是每个成员的唯一标识符这一事实使其成为标识字段的良好候选者,而loyaltyLevel则不是。

重要

下面介绍的步骤包括如何向现有模式字段添加标识描述符。 作为在模式本身的结构中定义标识字段的替代方法,您还可以使用identityMap字段来包含标识信息。

如果您计划使用identityMap,请记住,它将覆盖您直接添加到模式的任何主标识。 有关详细信息,请参阅模式合成指南基础知识中的identityMap部分。

在编辑器的​结构​部分中,选择loyaltyId字段,并在​字段属性​下显示​标识​复选框。 选中该框和选项,将其设置为​主标识。 也选择此框。

注意

每个模式只能包含一个主标识字段。 将模式字段设置为主标识后,如果您稍后尝试将模式中的其他标识字段设置为主标识,您将收到一条错误消息。

接下来,您必须从下拉菜单中预定义命名空间的列表中提供​标识命名空间。 由于loyaltyId是客户的电子邮件地址,请从下拉菜单中选择“电子邮件”。 选择​应用​以确认对loyaltyId字段的更新。

注意

有关标准命名空间及其定义的列表,请参阅Identity Service 文档

应用更改后,loyaltyId的图标会显示指纹符号,指示它现在是标识字段。

现在,收录到loyaltyId字段中的所有数据都将用于帮助识别该个人,并将该客户的单个视图拼接在一起。 要了解有关在Experience Platform中使用身份的更多信息,请查阅Identity Service文档。

启用模式以在Real-time Customer Profile中使用

Real-time Customer Profile 利用身份数据 Experience Platform 为每位客户提供整体视图。该服务构建了360°用户档案的客户属性以及客户在与Experience Platform集成的任何系统中拥有的每个交互的时间戳帐户。

要使模式能够与Real-time Customer Profile一起使用,必须定义主标识。 如果您尝试在未先定义主标识的情况下启用模式,将收到错误消息。


要启用在Profile中使用的“Loyalty Members”模式,请首先在编辑器的​结构​部分中选择“Loyalty Members”。

在编辑器的右侧,将显示有关模式的信息,包括其显示名称、说明和类型。 除此信息外,还有一个​用户档案​切换按钮。

选择​用户档案​并显示一个快显窗口,要求您确认是否要启用Profile模式。


警告

为Real-time Customer Profile启用模式并保存后,便无法禁用它。

选择​启用​以确认您的选择。 您可以根据需要再次选择​用户档案​切换键以禁用模式,但在Profile启用时保存模式后,便无法再禁用它。

后续步骤和其他资源

现在,您已完成模式的编写,您可以在画布中看到完整的模式。 选择​保存,模式将保存到Schema Library,使Schema Registry可访问。

您的新模式现在可用于将数据收录到Platform中。 请记住,一旦使用模式收录数据,只能进行附加更改。 有关模式版本控制的详细信息,请参阅模式合成基础知识

您现在可以按照上的教程定义UI](/docs/experience-platform/xdm/tutorials/relationship-ui.html?lang=zh-Hans)中的模式关系,在“Loyalty Members”模式中添加新关系字段。[

还可以使用Schema Registry API查看和管理“Loyalty Members”模式。 要开始使用API,请阅读Schema Registry API 开发人员指南进行开始。

视频资源

警告

以下视频中显示的Platform UI已过时。 有关最新的UI屏幕截图和功能,请参阅上述文档。

以下视频演示如何在Platform UI中创建简单模式。

以下视频旨在加深您对使用混音和类的理解。

附录

以下各节提供了有关使用Schema Editor的附加信息。

创建新类

Experience Platform 提供了根据组织特有的类定义模式的灵活性。要了解如何创建新类,请参阅有关在UI](…/ui/resources/classes.md#create)中创建和编辑类的指南。[

更改模式的类

在保存模式之前,您可以在初始合成过程中的任意点更改模式的类。

警告

重新分配模式的类应非常谨慎。 Mixins仅与某些类兼容,因此更改类将重置画布和您添加的任何字段。

要了解如何更改模式的类,请参阅有关在UI](…/ui/resources/schemas.md)中管理模式的指南。[

在此页面上

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now