在UI中定义XDM字段

Adobe Experience Platform用户界面中的Schema Editor允许您在自定义体验数据模型(XDM)类和模式字段组中定义您自己的字段。 本指南介绍了在UI中定义XDM字段的步骤,包括每个字段类型的可用配置选项。

先决条件

本指南要求对XDM系统有充分的了解。 有关Experience Platform生态系统中XDM角色的介绍,请参阅XDM概述以及模式合成🔗基础知识,了解类和字段组如何将字段贡献给XDM模式。

虽然本指南不是必需的,但建议您也要按照有关在UI🔗中编写模式的教程来熟悉Schema Editor的各种功能。

选择要向添加字段的资源

要在UI中定义新的XDM字段,必须首先在Schema Editor中打开模式。 根据Schema Library中当前可用的模式,您可以选择创建新模式选择现有模式以编辑

打开Schema Editor后,使用左边栏选择要为其定义字段的类或字段组。 如果资源是您的组织定义的自定义资源,则用于添加或编辑字段的控件将显示在画布中。 这些控件显示在模式名称旁边,以及在选定类或字段组下定义的任何对象类型字段。

注意

如果您选择的类或字段组是Adobe提供的核心资源,则无法编辑它,因此将不显示上面显示的控件。 如果要向中添加字段的模式基于核心XDM类,并且不包含任何自定义字段组,则可以创建新字段组以添加到模式。

要向资源添加新字段,请在画布中模式名称旁边或要定义字段的对象类型字段旁边选择加号(+)图标。

为资源定义字段

在选择​加号(+)​图标后,画布中会出现一个​New field,它位于根级对象中,该对象与您的唯一租户ID同名(在以下示例中显示为_tenantId)。 通过自定义类和字段组添加到模式的所有字段将自动放置在此命名空间中,以防止与Adobe提供的类和字段组中的其他字段发生冲突。

在​Field properties​下的右边栏中,您可以配置新字段的详细信息。 每个字段都需要以下信息:

字段属性 描述
Field name 字段的唯一描述性名称。 请注意,保存模式后,无法更改字段的名称。

最好用camelCase写入该名称。它可能包含字母数字、短划线或下划线字符,但​不能​带下划线的开始。
  • 正确: fieldName
  • 可接受 field_name2: Field-Namefield-name_3
  • 不正确: _fieldName
Display name 这个领域的人性化名称。
Type 字段将包含的数据类型。 从此下拉菜单中,您可以选择XDM支持的标准标量类型之一,或之前在Schema Registry中定义的多字段数据类型之一。

您还可以选择以 Advanced type search 搜索和筛选现有数据类型,并更轻松地查找所需类型。

您还可以为字段提供可选的人可读​Description,以提供有关字段预期用例的更多上下文。

注意

根据您为字段选择的​Type,其他配置控件可能会显示在右边栏中。 有关这些控件的详细信息,请参见类型特定字段属性的部分。

右边栏还提供用于指定特殊字段类型的复选框。 有关详细信息,请参阅特殊字段类型一节。

配置完字段后,选择​Apply

画布会更新以显示字段的名称和类型,除了其他属性,右边栏现在还列表字段的路径。

您可以继续执行上述步骤,向模式添加更多字段。 保存模式后,如果对基类和字段组进行了任何更改,也会保存基类和字段组。

注意

您对某个模式的字段组或类所做的任何更改都将反映在雇佣这些字段组或类的所有其他模式中。

类型特定字段属性

定义新字段时,根据您为该字段选择的​Type,其他配置选项可能显示在右边栏中。 下表概述了这些附加字段属性及其兼容类型:

字段属性 兼容类型 描述
Default value String, Double, Long, Integer, Short, Byte, Boolean 一个默认值,如果在摄取期间未提供其他值,则将分配给此字段。 此值必须与字段的选定类型一致。
Pattern String 一个常规表达式,该字段的值必须符合它,才能在摄取期间被接受。
Format String 从列表预定义格式中选择值必须符合的字符串。 可用格式包括:
Minimum length String 字符串必须包含的最小字符数,才能在摄取过程中接受该值。
Maximum length String 字符串必须包含的最大字符数,才能在摄取过程中接受该值。
Minimum value Double 在摄取期间接受的多次的最小值。 如果摄取的值与此处输入的值完全匹配,则接受该值。 使用此约束时,“Exclusive minimum value”约束必须留空。
Maximum value Double 在摄取期间接受的多次的最大值。 如果摄取的值与此处输入的值完全匹配,则接受该值。 使用此约束时,“Exclusive maximum value”约束必须留空。
Exclusive minimum value Double 在摄取期间接受的多次的最大值。 如果摄取的值与此处输入的值完全匹配,则该值将被拒绝。 使用此约束时,“Minimum value”(非独占)约束必须留空。
Exclusive maximum value Double 在摄取期间接受的多次的最大值。 如果摄取的值与此处输入的值完全匹配,则该值将被拒绝。 使用此约束时,“Maximum value”(非独占)约束必须留空。

特殊字段类型

右边栏提供了多个复选框,用于为选定字段指定特殊角色。 其中一些选项的使用案例涉及有关数据建模策略以及您打算如何使用下游平台服务的重要考虑事项。

要进一步了解这些特殊类型,请参阅以下文档:

虽然从技术上讲不是特殊字段类型,但还建议您访问定义对象类型字段的指南,进一步了解如果您的模式结构,定义嵌套子字段。

后续步骤

本指南概述了如何在UI中定义XDM字段。 请记住,只能通过使用类和字段组将字段添加到模式。 要进一步了解如何在UI中管理这些资源,请参阅有关创建和编辑字段组的指南。

有关Schemas工作区功能的详细信息,请参阅Schemas工作区概述

On this page

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