在 UI 中创建和编辑架构 create-edit-schemas-in-ui

本指南概述了如何在Adobe Experience Platform UI中为您的组织创建、编辑和管理Experience Data Model (XDM)架构。

IMPORTANT
XDM架构极具可自定义性,因此,创建架构所涉及的步骤可能会因您希望架构捕获的数据类型而异。 因此,本文档仅介绍您可以在UI中使用架构进行的基本交互,并排除自定义类、架构字段组、数据类型和字段等相关步骤。
有关架构创建过程的完整导览,请随架构创建教程一起创建完整的示例架构并熟悉Schema Editor的多种功能。

先决条件 prerequisites

本指南要求您对XDM系统有一定的了解。 请参阅XDM概述,了解XDM在Experience Platform生态系统中的角色简介,并参阅架构组合基础知识,了解架构的构建方式。

创建新架构 create

NOTE
本节介绍如何在UI中手动创建新架构。 如果您正在将CSV数据摄取到Platform,则可以使用机器学习(ML)算法​ 从示例CSV数据生成架构。 此工作流可匹配您的数据格式,并根据CSV文件的结构和内容自动创建新架构。 有关此工作流的详细信息,请参阅ML辅助模式创建指南

在架构工作区中,选择右上角的​ 创建架构

突出显示具有创建架构的架构工作区。

出现创建架构对话框。 在此对话框中,您可以选择通过添加字段和字段组手动创建架构,也可以上传CSV文件并使用ML算法生成架构。 从对话框中选择架构创建工作流。

使用工作流选项创建架构对话框并选择高亮显示。

[Beta]{class="badge informative"}手动或ML辅助的架构创建 manual-or-assisted

要了解如何使用ML算法推荐基于csv文件的架构结构,请参阅机器学习辅助架构创建指南。 本UI指南重点介绍手动创建工作流。

手动创建模式 manual-creation

出现创建架构工作流。 您可以通过选择​ 个人资料体验事件 ​或​ 其他 ​为架构选择基类,然后依次选择​ 下一步 ​以确认您的选择。 有关这些类的详细信息,请参阅XDM个人配置文件XDM ExperienceEvent文档。

使用三个类选项并突出显示下一步的创建架构工作流。

选择类后,将显示名称和审阅部分。 在此部分中,您会提供用于标识架构的名称和描述。​AEM架构的基本结构(由类提供)显示在画布中,供您查看和验证选定的类和架构结构。

在文本字段中输入人性化的架构显示名称。 接下来,输入适当的描述以帮助识别您的架构。 当您查看了架构结构并且满意您的设置时,请选择​ 完成 ​以创建您的架构。

高亮显示创建架构工作流的名称和审核部分,该工作流具有架构显示名称、描述和完成。

出现架构 浏览选项卡。 您最近创建的架构现已列在架构库中,并且可在Schema Editor中编辑。

架构工作区的“浏览”选项卡显示您最近创建的架构。

编辑现有架构 edit

NOTE
一旦架构被保存并用于数据摄取,则只能对其执行额外的更改。 有关详细信息,请参阅架构演变规则

要编辑现有架构,请选择​ 浏览 ​选项卡,然后选择要编辑的架构的名称。 您还可以使用搜索栏缩小可用选项列表的范围。

架构工作区中突出显示了架构。

TIP
您可以使用工作区的搜索和筛选功能来帮助更轻松地查找架构。 有关详细信息,请参阅浏览XDM资源指南。

选择架构后,Schema Editor即会显示,画布中显示架构的结构。 您现在可以将字段组添加到架构中(或添加这些组中的单个字段)、编辑字段显示名称编辑现有的自定义字段组(如果架构使用了任何组)。

更多操作 more

在架构编辑器中,您还可以执行快速操作以复制架构的JSON结构,或者删除架构(如果尚未为实时客户配置文件启用)或者具有关联的数据集。 选择视图顶部的更多以显示包含快速操作的下拉列表。

复制JSON结构功能允许您查看在仍在构建架构和数据管道时样本有效负载的外观。 对于模式中存在复杂的对象映射结构(如标识映射)的情况,此变量特别有用。

突出显示了“更多”按钮并显示下拉选项的架构编辑器。

显示名称切换 display-name-toggle

为方便起见,架构编辑器在原始字段名称和更易于用户识别的显示名称之间提供了切换开关。 这种灵活性可提高字段可发现性和架构的编辑。 此切换开关位于架构编辑器视图的右上角。

NOTE
从字段名称到显示名称的更改纯粹是修饰性的,不会更改任何下游资源。

架构编辑器显示高亮显示的字段的显示名称。

标准字段组的显示名称由系统生成,但可以自定义,如显示名称部分中所述。 显示名称会反映在多个UI视图中,包括映射和数据集预览。 默认设置为off,并按其原始值显示字段名。

将字段组添加到架构 add-field-groups

NOTE
本节介绍如何将现有字段组添加到架构。 如果要创建新的自定义字段组,请改为参阅创建和编辑字段组指南。

在Schema Editor中打开架构后,可通过使用字段组向架构添加字段。 若要开始,请选择左边栏中​ 字段组 ​旁边的​ 添加

突出显示字段组分区中具有添加的架构编辑器。

此时将显示一个对话框,其中显示了可为架构选择的字段组的列表。 由于字段组仅与一个类兼容,因此将仅列出与架构的选定类关联的字段组。 默认情况下,列出的字段组将根据其在您组织内的使用流行程度排序。

突出显示了添加字段组对话框并突出显示了热门程度列。

如果您知道要添加字段的常规活动或业务领域,请在左边栏中选择一个或多个垂直行业的类别,以筛选显示的字段组列表。

突出显示了添加字段组对话框,其中使用了行业筛选器,突出显示了行业列。

NOTE
有关XDM中特定于行业的数据建模的最佳实践的更多信息,请参阅有关行业数据模型的文档。

您还可以使用搜索栏帮助查找所需的字段组。 名称与查询匹配的字段组显示在列表顶部。 在​ 标准字段 ​下,将显示包含描述所需数据属性的字段的字段组。

突出显示具有标准字段搜索功能的添加字段组对话框。

选中要添加到架构的字段组名称旁边的复选框。 您可以从列表中选择多个字段组,每个选定的字段组都显示在右边栏中。

突出显示复选框选择功能的添加字段组对话框。

TIP
对于任何列出的字段组,您可以将光标悬停在信息图标( 信息图标 )上或集中在该图标上,以查看字段组捕获的数据类型的简短说明。 您还可以选择预览图标( 预览图标 )以查看字段组提供的字段结构,然后再决定将其添加到架构中。

选择字段组后,选择​ 添加字段组 ​以将其添加到架构中。

已选定字段组且已突出显示添加字段组的添加字段组对话框。

Schema Editor重新出现,画布中显示了字段组提供的字段。

显示具有示例架构的Schema Editor。

NOTE
在架构编辑器中,标准(Adobe生成的)类和字段组以挂锁图标( A挂锁图标)表示。 的问题。挂锁显示在左边栏中的类或字段组名称旁边,以及架构图中作为系统生成资源一部分的任意字段旁边。
带有挂锁图标的架构编辑器突出显示

将字段组添加到架构后,您可以选择根据您的需要删除现有字段将新的自定义字段添加到这些组。

移除从字段组添加的字段 remove-fields

将字段组添加到架构后,您可以删除任何不需要的字段。

NOTE
从字段组中删除字段仅影响正在处理的架构,不影响字段组本身。 如果删除一个架构中的字段,则这些字段在使用相同字段组的所有其他架构中仍然可用。

在以下示例中,标准字段组​ 人口统计详细信息 ​已添加到架构中。 要删除单个字段,如taxId,请在画布中选择该字段,然后在右边栏中选择​ 删除

突出显示了 带有移除的Schema Editor。 此操作删除单个字段。

如果要删除多个字段,则可以整体管理字段组。 在画布中选择属于该组的字段,然后在右边栏中选择​ 管理相关字段

突出显示具有管理相关字段的Schema Editor。

此时将显示一个对话框,其中显示了相关字段组的结构。 在此,您可以使用提供的复选框选择或取消选择所需的字段。 如果满意,请选择​ 确认

包含选定字段的管理相关字段对话框和确认突出显示。

画布会重新显示,架构结构中仅显示选定的字段。

已添加 个字段

将自定义字段添加到字段组 add-fields

将字段组添加到架构后,您可以为该组定义其他字段。 但是,在一个架构中添加到字段组的任何字段也将出现在使用该字段组的所有其他架构中。

此外,如果将自定义字段添加到标准字段组,则该字段组将转换为自定义字段组,并且原始标准字段组将不再可用。

如果要将自定义字段添加到标准字段组,请参阅下面的部分以了解具体说明。 如果要向自定义字段组添加字段,请参阅字段组UI指南中编辑自定义字段组的部分。

如果不想更改任何现有的字段组,您可以创建新的自定义字段组来定义其他字段。

将单个字段添加到架构 add-individual-fields

如果要避免为特定用例添加整个字段组,可使用架构编辑器将单个字段直接添加到架构。 您可以添加来自标准字段组的单个字段添加您自己的自定义字段

IMPORTANT
尽管架构编辑器在功能上允许您直接将单个字段添加到架构,但这不会更改XDM架构中的所有字段必须由其类或与该类兼容的字段组提供的事实。 如以下各节所述,作为添加到架构的关键步骤,所有单个字段仍与类或字段组关联。

添加标准字段 add-standard-fields

您可以将标准字段组中的字段直接添加到架构中,而无需预先知道其对应的字段组。 要将标准字段添加到架构,请在画布中选择架构名称旁边的加号(+)图标。 架构结构中出现​ 无标题字段 ​占位符,右边栏更新显示用于配置该字段的控件。

字段占位符

在​ 字段名称 ​下,开始键入要添加的字段名称。 系统会自动搜索与查询匹配的标准字段,并在​ 推荐的标准字段 ​下列出它们,包括它们所属的字段组。

推荐的标准字段

虽然某些标准字段具有相同的名称,但它们的结构可能会因它们来自的字段组而异。 如果标准字段嵌套在字段组结构的父对象中,则添加子字段时,该父字段也将包含在架构中。

选择标准字段旁边的预览图标( 预览图标 )可查看其字段组的结构,并更好地了解其嵌套方式。 要将标准字段添加到架构,请选择加号图标( 加号图标 )。

添加标准字段

画布将更新以显示添加到架构的标准字段,包括嵌套在字段组结构下的任何父字段。 字段组的名称还列在左边栏中的​ 字段组 ​下。 如果要从同一字段组添加更多字段,请选择右边栏中的​ 管理相关字段

已添加 标准字段

添加自定义字段 add-custom-fields

与标准字段的工作流类似,您还可以将自己的自定义字段直接添加到架构。

要将字段添加到架构的根级别,请在画布中选择架构名称旁边的加号(+)图标。 架构结构中出现​ 无标题字段 ​占位符,右边栏更新显示用于配置该字段的控件。

根自定义字段

开始键入要添加的字段的名称,系统会自动开始搜索匹配的标准字段。 要创建新的自定义字段,请选择附加了​ (新字段) ​的顶部选项。

新字段

提供显示名称和数据类型后 for 字段,下一步是将该字段分配给父XDM资源。 如果您的架构使用自定义类,则可以选择将该字段添加到分配的类字段组。 但是,如果您的架构使用标准类,则只能将自定义字段分配给字段组。

将字段分配给自定义字段组 add-to-field-group

NOTE
本节仅介绍如何将字段分配给自定义字段组。 如果要改用新的自定义字段扩展标准字段组,请参阅将自定义字段添加到标准字段组一节。

在​ 分配给 ​下,选择​ 字段组。 如果您的架构使用标准类,则这是唯一可用的选项,默认情况下处于选中状态。

接下来,必须为要关联的新字段选择字段组。 在提供的文本输入中开始键入字段组的名称。 如果您有任何与输入匹配的现有自定义字段组,则它们将显示在下拉列表中。 或者,您可以键入 a 用于创建新字段组的唯一名称。

选择字段组

WARNING
如果选择现有的自定义字段组,则采用该字段组的任何其他架构在保存更改后也将继承新添加的字段。 因此,如果您希望使用此类型,请仅选择现有字段组 of 传播。 否则,您应该选择创建新的自定义字段组。

从列表中选择字段组后,选择​ 应用

应用字段

新字段已添加到画布中,并且已在您的租户ID下命名,以避免与标准XDM字段冲突。 与新字段关联的字段组也显示在左边栏中的​ 字段组 ​下。

租户ID

NOTE
默认情况下,所选自定义字段组提供的其余字段将从架构中删除。 如果要将其中一些字段添加到架构,请选择属于该组的字段,然后在右边栏中选择​ 管理相关字段

将字段分配给自定义类 add-to-class

在​ 分配给 ​下,选择​ 。 下面的输入字段被替换成当前架构的自定义类的名称,这表示新字段将被分配给此类。

正在为新字段分配选择类选项。

继续根据需要配置该字段,并在完成后选择​ 应用

正在为新字段选择 应用。

新字段已添加到画布中,并且已在您的租户ID下命名,以避免与标准XDM字段冲突。 在左边栏中选择类名称会显示作为类结构一部分的新字段。

应用于自定义类结构的新字段,在画布中显示。

向标准字段组的结构中添加自定义字段 custom-fields-for-standard-groups

如果您正在处理的架构具有对象类型 field 由标准字段组提供,您可以将自己的自定义字段添加到该标准对象。

WARNING
在一个架构中添加到字段组的任何字段也将出现在使用该字段组的所有其他架构中。 此外,如果将自定义字段添加到标准字段组,则该字段组将转换为自定义字段组,并且原始标准字段组将不再可用。
如果您参加了此功能的Beta版,您将看到一个对话框,告知您之前自定义的标准字段组。 选择​ 确认 ​后,列出的资源将转换为自定义字段组。
转换标准字段组的确认对话框

要开始,请选择标准字段组提供的对象根旁边的加号(+)图标。

将字段添加到标准对象

出现警告消息,提示您确认是否要转换标准字段组。 选择​ 继续创建字段组 ​以继续。

确认字段组转换

画布会重新显示,新字段的占位符无标题。 请注意,标准字段组的名称已附加“(Extended)”,以表示已从原始版本修改了该名称。 从此处,使用右边栏中的控件来定义字段的属性。

字段已添加到标准对象

应用更改后,新字段将显示在标准对象内的租户ID命名空间下。 此嵌套命名空间可防止字段组自身内的字段名称冲突,以避免破坏使用同一字段组的其他架构中的更改。

字段已添加到标准对象

为实时客户轮廓启用架构 profile

实时客户档案合并来自不同来源的数据,以构建每个客户的完整视图。 如果希望架构捕获的数据参与此过程,则必须启用架构以便在Profile中使用。

IMPORTANT
为了为Profile启用架构,它必须定义主标识字段。 有关详细信息,请参阅定义标识字段指南。

要启用架构,请先在左边栏中选择架构的名称,然后在右边栏中选择​ 配置文件 ​切换开关。

此时会出现一个弹出窗口,警告您一旦启用并保存架构,就无法禁用该架构。 选择​ 启用 ​以继续。

画布将重新显示,并启用配置文件切换功能。

IMPORTANT
由于架构尚未保存,如果您改变主意,让架构参与Real-time Customer Profile,则无法返回此值:保存启用的架构后,无法再禁用它。 再次选择​ 配置文件 ​切换可禁用架构。

要完成该过程,请选择​ 保存 ​以保存架构。

该架构现已启用以用于Real-time Customer Profile。 当Platform根据此架构将数据摄取到数据集时,该数据将合并到您的合并用户档案数据中。

编辑架构字段的显示名称 display-names

分配类并将字段组添加到架构后,可以编辑架构中任何字段的显示名称,无论这些字段是由标准资源还是自定义XDM资源提供。

NOTE
请记住,属于标准类或字段组的字段的显示名称只能在特定架构的上下文中编辑。 换句话说,在一个架构中更改标准字段的显示名称不会影响使用相同关联类或字段组的其他架构。
更改架构字段的显示名称后,这些更改将立即反映在基于该架构的任何现有数据集中。

要编辑架构字段的显示名称,请在画布中选择该字段。 在右边栏中,在​ 显示名称 ​下提供新名称。

在右边栏中选择​ 应用,画布将更新以显示字段的新显示名称。 选择​ 保存 ​以将更改应用于架构。

更改架构的类 change-class

在保存架构之前,您可以在初始构成过程中随时更改架构的类。

WARNING
为架构重新分配类应极其谨慎。 字段组仅与某些类兼容,因此更改该类将重置画布和您已添加的所有字段。

要重新分配类,请在画布左侧选择​ 分配

出现一个对话框,其中显示所有可用类的列表,包括您的组织定义的任何类(所有者为“Customer”)以及Adobe定义的标准类。

从列表中选择一个类以在对话框的右侧显示其说明。 您还可以选择​ 预览类结构 ​以查看与该类关联的字段和元数据。 选择​ 分配类 ​以继续。

此时将打开一个新对话框,要求您确认是否分配一个新类。 选择​ 分配 ​以进行确认。

确认类更改后,画布将重置,并且所有合成进度都将丢失。

后续步骤 next-steps

本文档介绍了在Platform UI中创建和编辑架构的基础知识。 强烈建议您查看架构创建教程,了解有关在UI中构建完整架构(包括创建自定义字段组和数据类型)的综合工作流 for 独特用例。

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

要了解如何管理Schema Registry API中的架构,请参阅架构端点指南

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