浏览UI中的架构资源

在Adobe Experience Platform中,所有Experience Data Model (XDM)架构资源都存储在Schema Library中,包括由Adobe提供的标准资源和由您的组织定义的自定义资源。 在Experience Platform UI中,您可以查看Schema Library中任何现有架构、类、字段组或数据类型的结构和字段。 在规划和准备数据引入时,此功能特别有用,因为UI提供了有关这些XDM资源提供的每个字段的预期数据类型和用例的信息。

本教程介绍了在Experience Platform UI中浏览现有架构、类、字段组和数据类型的步骤。

查找架构资源 lookup

在Experience Platform UI的左侧导航中选择​Schemas。 Schemas工作区提供了一个​ Browse ​选项卡来浏览您组织中的所有架构,以及额外的专用选项卡来分别浏览​ClassesField groupsData types​和​Relationships

突出显示带有多个选项卡的架构工作区。

筛选器图标( 筛选器图标图像 )在左边栏中显示控件,以缩小列出的结果的范围。 资源筛选器分别可用于​ Browse ​和​ Relationships ​选项卡上的架构和关系。 在​ Field groups ​选项卡上,使用字段组元数据和筛选中描述的筛选器,按兼容的类和行业标记缩小列表范围。

在Schemas工作区的Browse选项卡上,您可以筛选架构清单。 使用​ Included in Profile ​切换开关可仅显示已启用在实时客户个人资料中使用的架构。 使用​ Show adhoc schemas ​切换筛选创建的架构列表,这些架构的字段已命名为仅供单个数据集使用。

突出显示过滤器面板的Schemas工作区Browse选项卡。

在Schemas工作区的Relationship选项卡上,您可以根据四个条件筛选关系列表。 这些筛选器包括Source schema、Destination schema、Source class和Destination class。 下表提供了这些过滤器的说明。

过滤器
描述
Source schema
要查看所选架构是起点或“源”的所有关系,请从Source schema下拉菜单中选择架构。
Destination schema
要查看所选架构为目标或“目标”的所有关系,请从Destination schema下拉菜单中选择架构。
Source class
要根据初始架构的类筛选关系,请从Source class下拉菜单中选择类。
Destination class
要显示以特定类的架构结尾的关系,请从Destination class下拉菜单中选择一个类。

突出显示筛选条件部分的“关系”选项卡。

您还可以使用搜索栏进一步缩小结果的范围。

突出显示搜索字段的架构工作区的“浏览”选项卡。

搜索结果中显示的资源首先按标题匹配项排序,然后按说明匹配项排序。 反过来,这两个类别中的匹配词越多,列表中显示的资源就越多。

找到要浏览的资源后,从列表中选择其名称,以在画布中查看其结构。

管理架构、类、字段组和数据类型:操作和删除 xdm-resource-actions

当您需要管理或删除XDM资源,或者操作(例如删除)不可用并且需要了解原因时,可使用此部分。

在何处查找操作(内联与详细信息页面) where-to-find-actions

要执行删除、导出或复制资源等操作,请使用以下入口点之一:

在​BrowseClassesField groups​和​ Data types ​选项卡上,管理操作在两个位置可用:

  • 在表​中内联:每个资源行都包含一个操作菜单(例如,),该菜单提供对可用操作的直接访问。

架构清单显示每个资源的省略号菜单中可用的内联操作。

  • 资源详细信息视图:要访问详细信息视图中的完整操作,必须选择​ 自定义(租户定义的) ​资源。 标准(Adobe提供)资源的操作有限,不会显示“删除”、“复制JSON结构”或“添加到包”等选项。 从库存中选择自定义资源以打开其详细信息视图,然后使用页眉中的​ More ​菜单访问相同的可用操作。

资源详细信息视图标头,其中显示“更多”菜单以及可用的操作,例如删除、复制JSON结构和下载样本文件。

对于支持的资源类型(架构、类、字段组和数据类型),这些操作在两个入口点之间是一致的。

可用操作 available-actions

根据资源类型和您的权限,以下操作可能可用:

  • Delete — 从您的组织中永久移除自定义资源(在限制允许的情况下)。 如果阻止删除,请参阅约束
  • Download sample file — 根据资源结构生成示例数据文件。 分步: 生成示例XDM数据
  • Copy JSON structure — 复制JSON格式的资源定义以供重用、导出或检查。 分步: 导出XDM架构
  • Add to package — 将资源包含在沙盒包中,以便跨沙盒导出或导入。 分步: 将对象导出到包

以下内容适用于不同的资源类型:

  • 对于​ 自定义(租户定义的) ​架构、类、字段组和数据类型,上述所有操作可能都可用。

  • 对于​ 标准(Adobe定义) ​类、字段组和数据类型:

    • 只有​ Download sample file ​可用。
    • 删除复制JSON结构​和​ 添加到包 ​不可用。

删除行为 delete-behavior

当您想要删除不再需要的自定义资源时,请使用​ Delete ​操作。

IMPORTANT
删除资源会将其从组织中永久删除,并且无法撤消。 由于使用情况、权限或系统限制,无法删除某些资源。

要删除资源,请执行以下操作:

  1. 在表中找到资源或打开其详细信息视图。
  2. 选择操作菜单(​或​More)。
  3. 选择 Delete
  4. 再次选择​ Delete ​以确认对话框中的操作。

确认后,该资源将从您的组织中永久移除。

如果资源无法删除,则该选项显示为禁用,并带有工具提示来说明无法执行该操作的原因。

架构清单已禁用删除内联操作工具提示,说明该限制。

约束(数据集、配置文件、RBAC、租户与全局) delete-constraints

如果诸如​ Delete ​之类的操作不可用或已禁用,则通常是由于以下情况之一造成的:

  • 权限(RBAC):您必须具有执行管理操作所需的权限(如​Manage Schemas)。 如果缺少权限,则使用工具提示显示操作被禁用。 要了解如何配置权限,请参阅访问控制UI概述

  • 数据集关联:无法删除一个或多个数据集使用的资源(例如与数据集关联的架构)。 要识别和移除数据集依赖项,请参阅删除数据集

  • 配置文件启用:无法删除为实时客户配置文件启用的架构。 有关配置文件启用如何影响架构的指导,请参阅规划实时客户配置文件启用

  • 租户与全局资源:可以删除租户定义的(自定义)资源(受约束约束),但无法删除标准(Adobe提供的)类、字段组和数据类型。

这些约束直接反映在UI中。 当某个操作不可用时,它会显示为已禁用,并包含说明特定限制的工具提示。

如果无法删除资源,请查看上述条件以确定是否需要更新权限、删除依赖项或调整数据模型。

有关画布中的其他架构编辑工作流,请参阅在UI中创建和编辑架构

在画布中浏览XDM资源 explore

选择资源后,其结构将在画布中打开。

显示Commerce数据类型的数据类型工作区画布。

默认情况下,包含子属性的所有对象类型字段在首次出现在画布中时会折叠。 要显示任何字段的子属性,请选择其名称旁边的图标。

已展开字段和子属性突出显示的数据类型工作区画布。

标准类和字段组指示器 standard-class-and-field-group-indicator

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

带有挂锁图标的架构编辑器突出显示

有关指导,请参阅将自定义字段添加到标准字段组文档。 不能编辑标准类。

系统生成的字段 system-fields

某些字段名称的前面带有下划线,如_repo_id。 这些表示系统将在摄取数据时自动生成和分配的字段的占位符。

因此,在摄取到Experience Platform时,应该从数据结构中排除这些字段中的大多数。 此规则的主要例外是_{TENANT_ID}字段,在您的组织下创建的所有XDM字段都必须在此字段下命名空间。

数据类型 data-types

对于画布中显示的每个字段,其对应的数据类型会显示在名称旁边,这概览field希望摄取的数据类型。

画布上显示的“邮政地址”数据类型及其关联的数据类型突出显示。

任何附加了方括号([])的数据类型均表示该特定数据类型的数组。 例如,String[]​的数据类型表示该字段需要字符串值的数组。 Payment Item[]​的数据类型表示符合Payment Item数据类型的对象数组。

如果数组字段基于对象类型,则可以在画布中选择其图标,以显示每个数组项的预期属性。

画布中的对象,其数组字段突出显示,并显示每个数组项的预期属性。

Field properties field-properties

当您选择画布中任何字段的名称时,右边栏会更新以在​ Field properties ​下显示有关该字段的详细信息。 这可以包括字段的预期用例、默认值、模式、格式、字段是否为必填等的描述。 浏览字段组时,所选字段的标签相关详细信息也会显示在此处;请参阅结构视图中的标签

从Commerce数据类型中选择的字段具有突出显示的字段属性。

如果您要检查的字段是枚举字段,则右边栏还会显示该字段预期接收的可接受值。

架构编辑器,在字段属性边栏中选择了字段,并且枚举值和显示名称高亮显示。

身份标识字段 identity

检查包含身份字段的架构时,这些字段在左边栏中列在提供给架构的类或字段组下。 选择左边栏中的身份字段名称以显示画布中的字段,无论其嵌套深度如何。

在画布中用指纹图标( 指纹图标图像 )突出显示身份字段。 如果选择身份字段的名称,则可以查看其他信息,如身份命名空间,以及该字段是否为架构的主要身份。

架构编辑器在左边栏中突出显示了架构的标识,在架构图表中突出显示了字段,在字段属性中突出显示了标识命名空间。

NOTE
有关标识字段及其与下游Experience Platform服务的关系的详细信息,请参阅定义标识字段指南。

关系字段 relationship

如果要检查包含关系字段的架构,则该字段将列在左边栏中的​ Relationships ​下。 选择左边栏中的关系字段名称以显示画布中的字段,无论其嵌套深度如何。 关系字段在画布中也以唯一方式高亮显示,显示字段链接到的引用架构的名称。 对于具有B2B功能的组织,可以编写自定义关系名称,并在这些情况下显示在画布上。

架构编辑器突出显示了关系字段和编辑关系。

要查看引用架构的主要标识的标识命名空间,请选择关系字段,然后在Field properties侧边栏中选择​Edit relationship。 关系的参数显示在显示的Edit relationship对话框中。

显示具有关系参数的“编辑关系”对话框。

有关在XDM架构中使用关系的详细信息,请参阅有关在UI中创建关系的教程。

浏览字段组:使用情况和元数据 explore-field-groups

导航到​Schemas > Field groups​以浏览字段组。 在​ Field groups ​选项卡中,其他功能可帮助您了解字段组在架构中的使用位置及其包含的内容,例如兼容性、必填字段(强制执行引入要求)和治理信号。

这些功能可帮助您在进行更改之前评估影响,并在架构设计期间更有效地识别相关字段组。

查看字段组的架构用法 view-schema-usage-for-field-groups

从​ Field groups ​表中,选择一个字段组以打开其详细信息视图。 画布将更新以显示字段组结构,而属性边栏会显示有关所选资源的其他信息。

使用此字段组的架构

在右侧属性边栏中,Schemas using this field group​部分列出了当前包含字段组的架构。

字段组属性边栏显示使用此字段组部分的架构。

  • 如果字段组由三个或更少架构使用,则会显示所有架构名称。
  • 如果它被三个以上的架构使用,则只显示一些名称,以及用于查看完整列表的选项。

选择架构名称以在新选项卡中打开其详细信息视图,并检查字段组在该架构中的实施方式。

查看更多和完整的架构列表

如果存在比内联显示的模式更多的模式,请选择​ View more ​以打开完整的对话框。

使用此字段组的架构中的“查看更多”选项。

此时将显示​ Schemas using this field group ​对话框,其中显示了使用该字段组的架构的完整列表。

使用此字段组的架构对话框显示架构列表和列。

在​ Schemas using this field group ​对话框中,您可以:

  • 浏览使用字段组的所有架构
  • 浏览大型结果集
  • 选择架构以在新选项卡中打开其详细信息视图

您可以查看架构详细信息,如架构名称、类和其他属性。

此工作流仅用于​影响分析和探索。 它不会修改架构或字段组。 要更改架构结构,请参阅在UI中创建和编辑架构

字段组元数据和筛选 field-group-metadata-and-filtering

Field groups​选项卡提供元数据和筛选工具,帮助您在选择字段组之前查找和评估字段组。

浏览表和过滤器

字段组清单表包括直接在列表视图中公开元数据的其他列,如​Compatible classes,它指示字段组可以应用于哪些类。 字段组只能根据它们代表的数据的行为(例如,基于记录的或时间序列数据),添加到使用列出的兼容类之一的架构中。 当字段组与所有类兼容时,表可能会显示​AllIndustry tags​帮助对要发现的字段组进行分类。

要优化列表,请选择过滤器图标( 过滤器图标图像 )以打开左边栏中的过滤器面板。 下图显示了在左边栏中打开的过滤器面板。

显示兼容类、行业标签和过滤器面板的“字段组”选项卡。

在过滤器面板中,您可以:

  • Compatible classes — 使用下拉菜单按类兼容性筛选字段组
  • Industry tags — 使用复选框按一个或多个行业类别进行筛选

浏览时,在表格中选择一行以更新信息边栏。 信息边栏显示元数据,例如兼容的类和行业标记,因此无需打开字段组即可查看关键详细信息。

字段组详细信息元数据

打开字段组时,属性边栏显示与资源关联的其他元数据。

属性边栏可以显示以下元数据:

  • Compatible classes — 字段组可以扩展的类
  • Required attributes — 当字段组在数据引入期间要求时,必须具有有效值的属性。 要求取决于数据结构,具有缺少的或无效的必需值的记录无法验证
  • Labels — 标签未显示在字段组级别。 选择一个字段以在​ Field properties ​边栏中查看标签详细信息

此信息可帮助您了解在使用或修改字段组之前的限制和要求。

结构视图中的标签

当在画布中打开字段组时,您可以直接在结构中查看标签信息。 选择设置图标( 设置图标。 ) 并启用​ Show labels on tree ​以在画布中的字段上显示标签指示符。

显示树显示选项对话框的字段组画布突出显示“在树上显示标签”。

选择画布中的字段以查看​ Field properties ​边栏中的标签详细信息,包括应用于该字段的标签。

字段组画布在字段属性边栏中显示字段标签和标签详细信息。

标签按类别(例如,身份和敏感标签)分组,可显示应用于数据的治理或与访问相关的限制。

这些指标仅用于可见性,不会更改架构结构。 有关详细信息,请参阅管理架构的数据使用标签

后续步骤

本文档介绍了如何在Experience Platform UI中探索现有XDM资源。 有关Schemas工作区和Schema Editor的不同功能的详细信息,请参阅Schemas工作区概述

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