在 UI 中定义枚举和建议值 enums-and-suggested-values

在Experience Data Model (XDM)中,可以为字符串字段提供一组预定义的接受或建议值,以便更好地控制哪些值被引入到该字段中,或者如何在分段中表现。

枚举 ​将可以为字符串字段摄取的值约束为预定义集。 如果您尝试将数据摄取到枚举字段,但值与其配置中定义的任何值都不匹配,则将拒绝摄取。

与枚举相反,建议值 ​选项允许为字符串字段表示一组建议值,这些建议值不会约束它可以摄取的值。 建议值反而会影响分段UI中哪些预定义值在将该字符串字段作为属性包含时可用。

在Adobe Experience Platform用户界面中定义新字段🔗并将类型设置为字符串时,为您提供了为该字段定义枚举建议值的选项。

图像显示UI中为字符串字段启用了“枚举和建议值”选项

本文档介绍如何在架构 UI工作区中定义枚举和建议值。 要快速了解枚举和建议值(包括如何在UI中配置它们及其下游影响),请观看以下视频:

定义枚举 enum

选择​ 枚举和建议值,然后选择​ 枚举。 将显示其他控件,允许您为枚举指定值约束。 要添加约束,请选择​ 添加行

显示在UI中选择的枚举选项的图像

在​ ​列下,必须提供要将该字段约束到的确切值。 您还可以选择为约束提供人性化的​ 显示名称,这会影响分段中值的表示方式。

继续使用​ 添加行 ​将所需的约束和可选标签添加到枚举中,或选择以前添加的行旁边的删除图标( 删除图标的图像 )以将其删除。 完成后,选择​ 应用 ​以将更改应用到架构。

显示为UI中的字符串字段填写的枚举值和显示名称的图像

画布将更新以反映这些更改。 当您以后探索此架构时,可以查看和编辑右边栏中枚举字段的约束。

定义建议值 suggested-values

选择​ 枚举和建议值,然后选择​ 建议值 ​以显示其他控件。 从此处选择​ 添加行 ​以开始添加建议值。

显示在UI中选择的“建议值”选项的图像

在​ 显示名称 ​列下,为值提供您希望在分段UI中显示的友好名称。 要添加更多建议值,请再次选择​ 添加行 ​并根据需要重复该过程。 要删除以前添加的行,请选择相关行旁边的 删除图标

完成后,选择​ 应用 ​以将更改应用到架构。

显示为UI中的字符串字段填写的枚举值和显示名称的图像

NOTE
字段的更新建议值大约有五分钟的延迟才能反映在分段UI中。

管理标准字段的建议值

标准XDM组件中的某些字段包含其自己的建议值,例如XDM ExperienceEvent类中的eventType。 虽然可以为标准字段创建其他建议值,但无法修改或删除任何未由组织定义的建议值。 在UI中查看标准字段时,其建议值会显示,但为只读。

显示为UI中的字符串字段填写的枚举值和显示名称的图像

要为标准字段添加新的建议值,请选择​ 添加行。 要删除贵组织以前添加的建议值,请选择相关行旁边的 删除图标

显示为UI中的字符串字段填写的枚举值和显示名称的图像

枚举和建议值的演化规则 evolution

使用具有枚举字段的架构将数据摄取到Platform后,对架构定义所做的任何进一步更改都必须符合系统中已存在的数据。 通常,对现有字段所做的更改只能使该字段​ 的限制更少。 不能使字段的限制比它已有的更严格。

对于枚举和建议值,以下规则适用于摄取后:

  • 您​ 可以 ​为具有现有建议值的标准和自定义字段添加建议值。
  • 您​ 可以 ​从具有现有建议值的自定义字段中删除建议值。
  • 您​ 可以 ​为现有的自定义枚举字段添加新枚举值。
  • 您​ 可以 ​将自定义字段的枚举值切换为仅建议值,或将其转换为没有枚举或建议值的字符串。 此开关应用后无法撤消。
  • 您​ 无法 ​从标准字段中移除枚举或建议值。
  • 您​ 无法 ​向没有现有枚举的字段添加枚举值。
  • 您​ 无法 ​删除的自定义字段枚举值少于所有现有枚举值。
  • 您​ 不能 ​从建议值切换到枚举。

枚举和建议值的合并规则 merging

如果多个架构使用具有不同配置的同一枚举字段,并且这些架构包含在合并中,则在如何协调枚举差异时将会应用某些规则。 确切的规则取决于架构是引用同一标准字段(如eventType),还是它们在不同字段组中引用同一自定义字段路径。

如果引用同一标准字段:

  • 任何其他建议值在合并中为​ APPENDED
  • 对同一枚举键的建议值进行的更新在联合中为​ UPDATED

如果在不同字段组中引用相同的自定义字段路径:

  • 任何其他建议值在合并中为​ APPENDED
  • 如果在多个架构中定义了相同的附加建议值,则这些值在合并中为​ MERGED。 换句话说,相同的建议值在合并后不会显示两次。

验证限制

由于当前系统的限制,在两种情况下,系统会在引入期间不验证枚举:

  1. 数组字段上定义了枚举。
  2. 枚举在架构层次结构中的多个级别上定义。

后续步骤

本指南介绍了如何在UI中定义字符串字段的枚举和建议值。 有关如何使用架构注册表API管理枚举和建议值的信息,请参阅以下教程

要了解如何在Schema Editor中定义其他XDM字段类型,请参阅在UI中定义字段的概述。

recommendation-more-help
62e9ffd9-1c74-4cef-8f47-0d00af32fc07