在用户界面中定义XDM字段

上次更新: 2023-11-14
  • 主题:
  • Schemas
    查看有关此主题的更多信息
  • 创建对象:
  • Developer
    User
    Admin
    Leader

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

先决条件

本指南要求您对XDM系统有一定的了解。 请参阅 XDM概述 介绍XDM在Experience Platform生态系统中的作用,以及 模式组合基础 了解类和字段组如何向XDM架构贡献字段。

虽然本指南并非必需,但建议您也按照以下内容阅读本教程: 在UI中组合架构 熟悉 Schema Editor.

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

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

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

警告

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

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

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

定义字段的属性

选择 加(+) 图标,一个 无标题的字段 占位符显示在画布中。

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

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

理想情况下,名称应以camelCase编写。 它可包含字母数字、短划线或下划线字符,但它 可能不会 从下划线开始。
  • 正确fieldName
  • 可接受: field_name2Field-Namefield-name_3
  • 不正确_fieldName
显示名称 字段的显示名称。 该名称将用于表示架构编辑器画布中的字段。 可使用将字段名称更改为显示名称 显示名称切换.
类型 字段将包含的数据类型。 从该下拉菜单中,您可以选择以下任一项 标准标量类型 受XDM或多字段之一支持 数据类型 之前在中定义的 Schema Registry.

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

您还可以提供易于用户阅读的可选内容 描述 到字段以提供有关字段预期用例的更多上下文。

注意

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

右边栏还提供了用于指定特殊字段类型的复选框。 请参阅以下部分 特殊字段类型 以了解更多信息。

配置完字段后,选择 应用.

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

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

注意

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

特定于类型的字段属性

定义新字段时,其他配置选项可能会显示在右边栏中,具体取决于 类型 为字段选择。 下表概述了这些附加字段属性及其兼容类型:

字段属性 兼容类型 描述
默认值 字符串, 多次, 长, 整数, 短, 字节, 布尔型 如果在摄取期间没有提供其他值,则分配给此字段的默认值。 此值必须符合字段的选定类型。

默认值在摄取时不会保存在数据集中,因为它们可能会随着时间的推移而更改。 从数据集中读取数据时,下游平台服务和应用程序会推断架构中设置的默认值。 例如,在使用查询服务查询数据时,如果属性的值为NULL,但缺省值设置为 5 在架构级别,查询服务应返回 5 而不是NULL。 请注意,此行为当前在所有AEP服务中并不一致。
模式 字符串 A 正则表达式 此字段的值必须符合以便在摄取期间被接受。
格式 字符串 从预定义的字符串格式列表中选取值必须符合的格式。 可用的格式包括:
最小长度 字符串 字符串必须包含的最小字符数才能在摄取期间接受该值。
最大长度 字符串 字符串必须包含的最大字符数才能在摄取期间接受该值。
最小值 双精度 摄取期间接受的Double的最小值。 如果摄取的值与此处输入的值完全匹配,则接受该值。 使用此约束时, “独占最小值”约束必须留空。
最大值 双精度 摄取期间接受的Double的最大值。 如果摄取的值与此处输入的值完全匹配,则接受该值。 使用此约束时, “独占最大值”约束必须留空。
独占最小值 双精度 摄取期间接受的Double的最大值。 如果摄取的值与此处输入的值完全匹配,则该值将被拒绝。 使用此约束时, “最小值“(非独占)约束必须留空。
独占最大值 双精度 摄取期间接受的Double的最大值。 如果摄取的值与此处输入的值完全匹配,则该值将被拒绝。 使用此约束时, “最大值“(非独占)约束必须留空。

特殊字段类型

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

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

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

后续步骤

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

欲知关于 架构 工作区,请参见 架构 工作区概述.

在此页面上