在 UI 中创建和编辑架构 create-edit-schemas-in-ui
使用Adobe Experience Platform UI为您的组织创建、编辑和管理Experience Data Model (XDM)架构。 本指南向您展示如何创建标准和关系架构、自定义架构结构、从浏览工作区管理架构以及准备架构以供生产使用。
先决条件 prerequisites
本指南要求您对XDM系统有一定的了解。 请参阅XDM概述,了解XDM在Experience Platform生态系统中的角色简介,并参阅架构组合基础知识,了解架构的构建方式。
创建新架构 create
在架构工作区中,选择右上角的创建架构。 出现“选择架构类型”下拉菜单,其中包含标准或关系架构的选项。
创建关系架构 create-relational-schema
选择 关系 以定义对记录具有细粒度控制的结构化关系样式架构。 关系架构通过主键和外键支持主键强制、记录级版本控制和架构级关系。 它们还针对使用变更数据捕获的增量摄取进行了优化,并支持在Campaign Orchestration、Data Distiller和B2B实施中使用的多个数据模型。
若要了解更多信息,请参阅Data Mirror或关系架构概述。
手动创建 create-manually
出现 创建关系架构 对话框。 您可以选择 手动创建 或 上传DDL文件 来定义架构结构。
在 创建关系架构 对话框中,选择手动创建,然后选择下一步。
将显示 关系架构详细信息 页。 输入架构显示名称和可选说明,然后选择 完成 以创建架构。
架构编辑器将打开,并带有用于定义架构结构的空画布。 您可以像往常一样添加字段。
添加版本标识符字段 add-version-identifier
要启用版本跟踪并支持变更数据捕获,必须在架构中指定一个版本标识符字段。 在架构编辑器中,选择加号(
输入字段名称,如updateSequence,然后选择 日期时间 或 数字 的数据类型。
在右边栏中,启用 版本标识符 复选框,然后选择 应用 以确认该字段。
要定义关系,请选择架构编辑器中的 添加关系 以创建架构级别的主键/外键关系。 有关详细信息,请参阅有关添加架构级别关系的教程。
接下来,继续定义主键,并根据需要添加其他字段。 有关如何在Experience Platform源中启用变更数据捕获的指导,请参阅变更数据捕获引入指南。
上载DDL文件 upload-ddl-file
使用此工作流通过上传DDL文件来定义架构。 在 创建关系架构 对话框中,选择上传DDL文件,然后从系统中拖动本地DDL文件或选择选择文件。 Experience Platform验证架构,如果文件上传成功,则显示绿色复选标记。 选择 下一步 以确认上传。
将显示选择要导入的实体和字段对话框,允许您预览架构。 查看架构结构,并使用单选按钮和复选框确保每个实体都指定了主键和版本标识符。
updateSequence字段。_change_request_type且类型为String的特殊列才能启用增量处理。 此字段指示数据更改的类型(例如,u (upsert)或d (delete))。虽然在引入期间需要,但诸如_change_request_type之类的控件列未存储在架构中,并且未出现在最终架构结构中。 如果一切看起来都正确,请选择 完成 以创建架构。
架构将在架构编辑器中打开,您可以在保存之前调整结构。
接下来,继续添加其他字段,并根据需要添加其他架构级别关系。
有关如何在Experience Platform源中启用变更数据捕获的指导,请参阅变更数据捕获引入指南。
创建标准架构 create-standard-schema
从架构类型菜单中选择Standard。 出现创建架构对话框。 从该对话框中,选择架构创建工作流。 您可以通过添加字段和字段组手动创建架构,或上传CSV文件以自动生成架构。
[Beta]{class="badge informative"}手动或ML辅助模式创建 manual-or-assisted
要了解如何使用ML算法推荐基于csv文件的架构结构,请参阅机器学习辅助架构创建指南。 本UI指南侧重于手动创建工作流。
手动创建模式 manual-creation
出现创建架构工作流。 您可以通过选择个人资料、体验事件或 其他 为架构选择基类,然后依次选择 下一步 以确认您的选择。 有关这些类的详细信息,请参阅XDM个人配置文件和XDM ExperienceEvent文档。
选择 其他 时,将显示可用类的列表。 在此处,您可以浏览和过滤预先存在的类。
选择一个单选按钮,以根据类是自定义类还是标准类来筛选这些类。 您还可以根据行业筛选可用的结果,或使用搜索字段搜索特定类。
为了帮助您确定相应的类,每个类都有信息和预览图标。 信息图标(
预览图标(
选择任意行以选择一个类,然后选择 下一步 以确认您的选择。
选择类后,将显示名称和审阅部分。 在此部分中,您会提供用于标识架构的名称和描述。 架构的基本结构(由类提供)显示在画布中,供您查看和验证选定的类和架构结构。
在文本字段中输入人性化的架构显示名称。 接下来,输入适当的描述以帮助识别您的架构。 当您查看了架构结构并且满意您的设置时,请选择 完成 以创建您的架构。
此时将显示架构编辑器,其中架构的结构显示在画布中。 如果需要,您现在可以开始向类添加字段。
编辑现有架构 edit
要编辑现有架构,请选择 浏览 选项卡,然后选择要编辑的架构的名称。 您还可以使用搜索栏缩小可用选项列表的范围。
选择架构后,Schema Editor即会显示,画布中显示架构的结构。 您现在可以使用下节中描述的工具和选项自定义架构。
自定义架构 customize-schema
在架构编辑器中打开架构后,您可以自定义其结构、字段和显示属性。 此部分介绍了可用于根据特定要求定制架构的主要自定义选项。
使用以下链接直接导航到此部分中的关键自定义任务:
显示名称切换 display-name-toggle
为方便起见,架构编辑器在原始字段名称和更易于用户识别的显示名称之间提供了切换开关。 这种灵活性可提高字段可发现性和架构的编辑。 此切换开关位于架构编辑器视图的右上角。
标准字段组的显示名称由系统生成,但可以自定义,如显示名称部分中所述。 显示名称会反映在多个UI视图中,包括映射和数据集预览。 默认设置为off,并按其原始值显示字段名。
将字段组添加到架构 add-field-groups
在Schema Editor中打开架构后,可通过使用字段组向架构添加字段。 若要开始,请选择左边栏中 字段组 旁边的添加。
此时将显示一个对话框,其中显示了可为架构选择的字段组的列表。 由于字段组仅与一个类兼容,因此将仅列出与架构的选定类关联的字段组。 默认情况下,列出的字段组将根据其在您组织内的使用流行程度排序。
如果您知道要添加字段的常规活动或业务领域,请在左边栏中选择一个或多个垂直行业的类别,以筛选显示的字段组列表。
您还可以使用搜索栏帮助查找所需的字段组。 名称与查询匹配的字段组显示在列表顶部。 在 标准字段 下,将显示包含描述所需数据属性的字段的字段组。
选中要添加到架构的字段组名称旁边的复选框。 您可以从列表中选择多个字段组,每个选定的字段组都显示在右边栏中。
选择字段组后,选择 添加字段组 以将其添加到架构中。
Schema Editor重新出现,画布中显示了字段组提供的字段。
将字段组添加到架构后,您可以选择根据您的需要删除现有字段或将新的自定义字段添加到这些组。
移除从字段组添加的字段 remove-fields
将字段组添加到架构后,您可以从字段组全局删除字段,或从当前架构本地隐藏它们。 了解这些操作之间的区别对于避免意外模式更改至关重要。
除非您想要 从包含字段组 的每个架构中删除该字段,否则请不要使用此选项。
要从字段组中删除字段,请在画布中选择该字段,然后在右边栏中选择删除。 此示例显示 人口统计详细信息 组中的taxId字段。
要从架构中隐藏多个字段而不从字段组本身中删除它们,请使用 管理相关字段 选项。 从画布中的组中选择任意字段,然后在右边栏中选择管理相关字段。
将出现一个对话框,显示字段组的结构。 使用复选框选择或取消选择要包含的字段。
选择 确认 以更新画布并反映所选字段。
删除或弃用字段时的字段行为 field-removal-deprecation-behavior
使用下表了解每个操作的范围。
将自定义字段添加到字段组 add-fields
将字段组添加到架构后,您可以为该组定义其他字段。 但是,在一个架构中添加到字段组的任何字段也将出现在使用该字段组的所有其他架构中。
此外,如果将自定义字段添加到标准字段组,则该字段组将转换为自定义字段组,并且原始标准字段组将不再可用。
如果要将自定义字段添加到标准字段组,请参阅下面的部分以了解具体说明。 如果要向自定义字段组添加字段,请参阅字段组UI指南中编辑自定义字段组的部分。
如果不想更改任何现有的字段组,您可以创建新的自定义字段组来定义其他字段。
将字段添加到架构 add-fields-to-schema
架构编辑器提供了多种将字段添加到架构结构的方法。 选择最适合您特定要求的方法。
使用以下链接可了解有关将字段添加到架构的特定方法:
将单个字段添加到架构 add-individual-fields
如果要避免为特定用例添加整个字段组,可使用架构编辑器将单个字段直接添加到架构。 您可以添加来自标准字段组的单个字段或添加您自己的自定义字段。
将标准字段添加到架构 add-standard-fields
您可以将标准字段组中的字段直接添加到架构中,而无需预先知道其对应的字段组。 要将标准字段添加到架构,请在画布中选择架构名称旁边的加号(+)图标。 架构结构中出现 无标题字段 占位符,右边栏更新显示用于配置该字段的控件。
在 字段名称 下,开始键入要添加的字段名称。 系统会自动搜索与查询匹配的标准字段,并在 推荐的标准字段 下列出它们,包括它们所属的字段组。
虽然某些标准字段具有相同的名称,但它们的结构可能会因它们来自的字段组而异。 如果标准字段嵌套在字段组结构的父对象中,则添加子字段时,该父字段也将包含在架构中。
选择标准字段旁边的预览图标(
画布将更新以显示添加到架构的标准字段,包括嵌套在字段组结构下的任何父字段。 字段组的名称还列在左边栏中的 字段组 下。 如果要从同一字段组添加更多字段,请选择右边栏中的管理相关字段。
将自定义字段添加到架构 add-custom-fields
与标准字段的工作流类似,您还可以将自己的自定义字段直接添加到架构。
要将字段添加到架构的根级别,请在画布中选择架构名称旁边的加号(+)图标。 架构结构中出现 无标题字段 占位符,右边栏更新显示用于配置该字段的控件。
开始键入要添加的字段的名称,系统会自动开始搜索匹配的标准字段。 要创建新的自定义字段,请选择附加了 (新字段) 的顶部选项。
在为该字段提供显示名称和数据类型后,下一步是将该字段分配给父XDM资源。 如果您的架构使用自定义类,则可以选择将该字段添加到分配的类或字段组。 但是,如果您的架构使用标准类,则只能将自定义字段分配给字段组。
将字段分配给自定义字段组 add-to-field-group
在 分配给 下,选择字段组。 如果您的架构使用标准类,则这是唯一可用的选项,默认情况下处于选中状态。
接下来,必须为要关联的新字段选择字段组。 在提供的文本输入中开始键入字段组的名称。 如果您有任何与输入匹配的现有自定义字段组,则它们将显示在下拉列表中。 或者,您可以键入唯一名称来创建新的字段组。
从列表中选择字段组后,选择应用。
新字段已添加到画布中,并且已在您的租户ID下命名,以避免与标准XDM字段冲突。 与新字段关联的字段组也显示在左边栏中的 字段组 下。
将字段分配给自定义类 add-to-class
在 分配给 下,选择类。 下面的输入字段被替换成当前架构的自定义类的名称,这表示新字段将被分配给此类。
继续根据需要配置该字段,并在完成后选择应用。
新字段已添加到画布中,并且已在您的租户ID下命名,以避免与标准XDM字段冲突。 在左边栏中选择类名称会显示作为类结构一部分的新字段。
将自定义字段添加到标准字段组 custom-fields-for-standard-groups
如果您正在处理的架构具有由标准字段组提供的对象类型字段,则可以将自己的自定义字段添加到该标准对象。
要开始,请选择标准字段组提供的对象根旁边的加号(+)图标。
出现警告消息,提示您确认是否要转换标准字段组。 选择 继续创建字段组 以继续。
画布会重新显示,新字段的占位符无标题。 请注意,标准字段组的名称已附加“(Extended)”,以表示已从原始版本修改了该名称。 从此处,使用右边栏中的控件来定义字段的属性。
应用更改后,新字段将显示在标准对象内的租户ID命名空间下。 此嵌套命名空间可防止字段组自身内的字段名称冲突,以避免破坏使用同一字段组的其他架构中的更改。
编辑架构字段的显示名称 display-names
分配类并将字段组添加到架构后,可以编辑架构中任何字段的显示名称,无论这些字段是由标准资源还是自定义XDM资源提供。
通过切换 显示字段 的显示名称,将字段名称更改为显示名称。 要编辑架构字段的显示名称,请在画布中选择该字段。 在右边栏中,在 显示名称 下提供新名称。
在右边栏中选择应用,画布将更新以显示字段的新显示名称。 选择 保存 以将更改应用于架构。
管理架构 manage-schemas
架构管理任务可从Experience Platform UI中的两个主要位置访问。 根据您使用架构的位置选择适当的工作流。
从浏览视图管理架构 manage-from-browse
此部分记录了 浏览 选项卡中可用的架构操作;有关架构发现、筛选和组织的信息,请参阅浏览XDM资源。
以下部分介绍了 浏览 选项卡中可用的架构管理操作。 可通过每个架构行旁边的省略号(…)菜单访问这些操作。
编辑架构属性 edit-schema-properties
将您直接转到架构编辑器,其中已预填充架构。
删除架构 delete-schema
从您的组织中删除架构。 删除仅适用于尚未为Real-time Customer Profile启用并且没有关联数据集的架构。 删除后,无法恢复架构。
应用数据治理标签 apply-data-governance-labels
直接转到架构工作区标签选项卡。 有关完整说明,请参阅管理架构的数据使用标签文档。
创建数据集 create-dataset
打开 从架构 创建数据集对话框,其中已预填充源架构名称。 输入数据集 名称 和描述(可选),然后选择 创建数据集 以创建数据集。
创建数据集后,它将在数据集工作区中打开。
管理标记 manage-tags
打开添加或删除标记对话框,您可以在其中从架构中分配或删除用户定义的标记。 分配给架构的标记将显示在架构清单中,并可用于筛选。 有关基于标记的组织的详细信息,请参阅浏览XDM资源。
移至文件夹 move-to-folder
打开移动对话框,您可以在其中选择目标文件夹或创建新文件夹。 组织到文件夹中的架构将显示在左边栏中的文件夹层次结构中。 有关基于文件夹的组织的详细信息,请参阅浏览XDM资源。
添加到程序包 add-to-package
在沙盒工具包中包含架构,以便跨环境部署。 架构必须满足包资格要求。 可以在沙盒之间导出和导入包含架构的包。
复制 JSON 结构 copy-json-structure
将架构的完整JSON表示形式复制到剪贴板。 输出与架构注册表中存储的架构结构匹配,可用于API操作或架构共享。
下载样本文件 download-sample-file
生成并下载符合架构结构的示例数据文件。 该文件包含在架构中定义的每个字段的示例值。 示例文件仅用于测试架构结构,不应包含生产数据。
从架构编辑器管理架构 manage-from-editor
在架构编辑器中,您可以执行快速操作以复制架构的JSON结构,或删除架构(如果未为实时客户配置文件启用并且没有关联的数据集)。 选择视图顶部的更多以显示包含快速操作的下拉列表。
复制JSON结构功能允许您查看在仍在构建架构和数据管道时样本有效负载的外观。 对于模式中存在复杂的对象映射结构(如标识映射)的情况,此变量特别有用。
最终确定架构 finalize-schema
自定义完架构结构和字段后,您可能需要执行其他步骤以准备将其用于生产。 这些最终配置步骤可确保您的架构正确与Experience Platform服务集成。
为实时客户轮廓启用架构 profile
实时客户档案合并来自不同来源的数据,以构建每个客户的完整视图。 如果希望架构捕获的数据参与此过程,则必须启用架构以便在Profile中使用。
要启用架构,请先在左边栏中选择架构的名称,然后在右边栏中选择 配置文件 切换开关。
此时会出现一个弹出窗口,警告您一旦启用并保存架构,就无法禁用该架构。 选择 启用 以继续。
画布将重新显示,并启用配置文件切换功能。
要完成该过程,请选择 保存 以保存架构。
该架构现已启用以用于Real-time Customer Profile。 当Experience Platform将数据摄取到基于此架构的数据集时,该数据将合并到您的合并用户档案数据中。
更改架构的类 change-class
在保存架构之前,您可以在初始构成过程中随时更改架构的类。
要重新分配类,请在画布左侧选择分配。
出现一个对话框,其中显示所有可用类的列表,包括您的组织定义的任何类(所有者为“Customer”)以及Adobe定义的标准类。
从列表中选择一个类以在对话框的右侧显示其说明。 您还可以选择 预览类结构 以查看与该类关联的字段和元数据。 选择 分配类 以继续。
此时将打开一个新对话框,要求您确认是否分配一个新类。 选择 分配 以进行确认。
确认类更改后,画布将重置,并且所有合成进度都将丢失。
后续步骤 next-steps
本文档介绍在Experience Platform UI中创建和编辑架构的基础知识。 强烈建议您查看架构创建教程,以了解有关在UI中构建完整架构的全面工作流程,包括为独特用例创建自定义字段组和数据类型。
有关架构工作区的功能的更多信息,请参阅架构工作区概述。
要了解如何管理Schema Registry API中的架构,请参阅架构端点指南。