在用户界面中定义XDM字段

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

先决条件

本指南要求您对XDM系统有一定的了解。 请参阅XDM概述,了解XDM在Experience Platform生态系统中的角色以及架构组合的基础知识,了解类和字段组如何为XDM架构贡献字段。

虽然本指南并非必需,但建议您也学习有关在UI中撰写架构的教程,以熟悉Schema Editor的各种功能。

选择要向其添加字段的资源 select-resource

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

打开Schema Editor后,画布中会显示用于添加字段的控件。 这些控件显示在架构的名称旁边,以及在所选类或字段组下定义的任何对象类型字段旁边。

突出显示添加图标的架构编辑器。

WARNING
如果您尝试将字段添加到由标准字段组提供的对象,则该字段组将转换为自定义字段组,并且原始字段组将不再可用。 有关详细信息,请参阅架构UI指南中有关将字段添加到标准字段组的部分。

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

突出显示添加图标的架构编辑器。

根据您是将字段直接添加到架构还是其组成类和字段组,添加字段所需的步骤会有所不同。 本文档的其余部分侧重于如何配置字段的属性,而不管该字段在架构中的显示位置如何。 有关可向架构添加字段的不同方式的更多信息,请参阅架构UI指南中的以下部分:

定义字段的属性 define

选择​ 加号(+) ​图标后,Untitled field​占位符显示在画布中。

突出显示具有新无标题字段的架构编辑器。

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

字段属性
描述
Field name

字段的唯一描述性名称。 请注意,保存架构后,无法更改字段名称。 此值用于标识和引用代码和其他下游应用程序中的字段

最好以camelCase格式写入名称。 它可包含字母数字或下划线字符,但​ 不能 ​以下划线开头。

  • 正确fieldName
  • 可接受: field_name2fieldName_3
  • 不正确_fieldName
Display name
字段的显示名称。 该名称将用于表示架构编辑器画布中的字段。 可使用显示名称切换将字段名称更改为显示名称。
Type
字段将包含的数据类型。 从该下拉菜单中,您可以选择XDM支持的标准标量类型之一,或之前在Schema Registry中定义的多字段数据类型之一。
注意:如果选择Map数据类型,则会显示Map value type属性。

您还可以选择​ Advanced type search ​以搜索和筛选现有数据类型,并更轻松地找到所需类型。
Map value type
如果您选择Map作为字段的数据类型,该值是必需的。 映射的可用值为String和Integer。 从可用选项的下拉列表中选择一个值。
要了解有关特定于类型的字段属性的更多信息,请参阅定义字段概述。

您还可以选择为每个字段提供说明和注释。 使用​ Description ​字段添加上下文并描述映射数据类型的功能。 这有助于提高实施的可维护性和可读性。 您还可以添加注释以补充初始描述。 这应该提供更细粒度和更具体的信息,以帮助开发人员在代码库的上下文中有效理解、维护和利用映射。 |

NOTE
根据您为字段选择的​Type,右边栏中可能会显示其他配置控件。 有关这些控件的详细信息,请参阅特定类型的字段属性部分。
右边栏还提供了用于指定特殊字段类型的复选框。 有关详细信息,请参阅有关特殊字段类型的部分。

完成字段配置后,选择​Apply

架构编辑器的Field properties部分已突出显示。

画布更新以显示新添加的字段,该字段位于以您的唯一租户ID命名的对象中(如下面的示例所示_tenantId)。 添加到架构的所有自定义字段都会自动放置在此命名空间中,以防止与Adobe提供的类和字段组中的其他字段冲突。 现在,右边栏会列出字段的路径及其其他属性。

架构图中的新字段及其在Field properties部分中的相应路径突出显示。

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

NOTE
您对一个架构的字段组或类所做的任何更改都将反映在使用这些字段组或类的所有其他架构中。

特定于类型的字段属性 type-specific-properties

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

配置后,在引入期间强制使用诸如​PatternFormat​以及长度或数字范围之类的属性。 Default value​不同:它记录信息性架构元数据,不会验证或填充摄取的数据。 请参阅下面的​ Default value ​行以及表后面的注释。

字段属性
兼容类型
描述
Map value type
Map
仅当您从Type下拉选项中选择映射值时,Map value type属性才会显示在UI中。 您可以为Map在String和Integer值类型之间进行选择。
架构编辑器中的Type和Map值类型字段突出显示。 {width="100" modal="regular"}
注意:通过API创建的任何非String或Integer类型的映射数据类型将显示为“Complex”数据类型。 您无法通过UI创建“Complex”数据类型。
Pattern
String
此字段的值必须符合的正则表达式才能在摄取期间被接受。
Format
String

从预定义的字符串格式列表中选取值必须符合的格式。 可用的格式包括:

Minimum length
String
字符串必须包含的最小字符数才能在摄取期间接受该值。
Maximum length
String
字符串必须包含的最大字符数才能在摄取期间接受该值。
Minimum value
Double
摄取期间接受的Double的最小值。 如果摄取的值与此处输入的值完全匹配,则接受该值。 使用此约束时,“Exclusive minimum value”约束必须留空。
Maximum value
Double
摄取期间接受的Double的最大值。 如果摄取的值与此处输入的值完全匹配,则接受该值。 使用此约束时,“Exclusive maximum value”约束必须留空。
Exclusive minimum value
Double
摄取期间接受的Double的最大值。 如果摄取的值与此处输入的值完全匹配,则该值将被拒绝。 使用此约束时,“Minimum value”(非独占)约束必须留空。
Exclusive maximum value
Double
摄取期间接受的Double的最大值。 如果摄取的值与此处输入的值完全匹配,则该值将被拒绝。 使用此约束时,“Maximum value”(非独占)约束必须留空。
Default value
架构编辑器中支持JSON架构default的标量类型(如String和Boolean)
JSON架构 default语义一致的信息性元数据存储在架构定义中。 在摄取或数据准备流程期间,不会自动应用配置的值。 除非在数据流中显式映射或转换,否则忽略的字段仍然不存在。 请参阅定义必填字段

特殊字段类型 special

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

要了解有关这些特殊类型的更多信息,请参阅以下文档:

虽然从技术上讲不是特殊字段类型,但还建议您访问有关定义对象类型字段的指南,以了解有关在架构结构中定义嵌套子字段的更多信息。

后续步骤

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

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

recommendation-more-help
experience-platform-help-xdm