在UI中定义XDM字段

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

先决条件

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

虽然本指南不是必需的,但建议您也按照在UI中合成架构的教程,熟悉Schema Editor的各种功能。

选择要向添加字段的资源

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

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

注意

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

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

为资源定义字段

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

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

字段属性 描述
字段名称 字段的唯一描述性名称。 请注意,保存架构后,无法更改字段名称。

理想情况下,该名称应使用camelCase写入。它可能包含字母数字、短划线或下划线字符,但​不能​以下划线开头。
  • 正确: fieldName
  • 可接受: field_name2Field-Namefield-name_3
  • 错误: _fieldName
显示名称 字段的人类易记名称。
类型 字段将包含的数据类型。 从此下拉菜单中,您可以选择XDM支持的标准标量类型之一,或选择之前在Schema Registry中定义的多字段数据类型之一。

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

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

注意

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

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

配置完字段后,选择​Apply

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

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

注意

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

类型特定的字段属性

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

字段属性 兼容类型 描述
默认值 字符串、 双精度类型、 长度、 整数、 短、 字节、 布尔值 一个默认值,如果在摄取期间未提供任何其他值,则将分配给此字段。 此值必须符合字段的选定类型。
图案 字符串 正则表达式,此字段的值必须符合该表达式,才能在摄取期间被接受。
格式 字符串 从值必须符合的字符串的预定义格式列表中进行选择。 可用格式包括:
最小长度 字符串 要在摄取期间接受值,字符串必须包含的最小字符数。
最大长度 字符串 要在摄取期间接受值,字符串必须包含的最大字符数。
最小值 双精度 在摄取期间接受的双精度类型的最小值。 如果摄取的值与此处输入的值完全匹配,则接受该值。 使用此约束时,“排他最小值”约束必须留空。
最大值 双精度 在摄取期间接受的双精度类型的最大值。 如果摄取的值与此处输入的值完全匹配,则接受该值。 使用此约束时,“排他最大值”约束必须留空。
唯一最小值 双精度 在摄取期间接受的双精度类型的最大值。 如果摄取的值与此处输入的值完全匹配,则该值会被拒绝。 使用此约束时,“最小值”(非独占)约束必须留空。
唯一最大值 双精度 在摄取期间接受的双精度类型的最大值。 如果摄取的值与此处输入的值完全匹配,则该值会被拒绝。 使用此约束时,“最大值”(非独占)约束必须留空。

特殊字段类型

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

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

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

后续步骤

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

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

在此页面上