Show Menu
主题×

使用架构编辑器创建架构

模式注册表提供用户界面和RESTful API,您可以从中视图和管理Adobe Experience Platform模式库中的所有资源。 模式库包含Adobe、Experience Platform合作伙伴、您所使用应用程序的供应商为您提供的资源,以及您定义并保存到模式注册表的资源。
本教程介绍了在模式中使用模式编辑器创建Experience Platform的步骤。 如果您希望使用模式注册表API编写模式,请先阅读模式注册表开 发人员指南 ,然后再 尝试使用API创建模式
本教程还包含定 义新类的步骤 ,您随后可以使用它构建模式。

入门指南

本教程需要对使用Adobe Experience Platform编辑器时涉及的模式的各个方面进行有效的了解。 在开始本教程之前,请查阅以下概念的文档:
本教程要求您具有访问Experience Platform的权限。 如果您无权访问Experience Platform中的IMS组织,请在继续操作前与系统管理员联系。

浏览模式工作区中的现有模式

Experience Platform中的模式工作区提供了模式库的可视化,允许您视图和管理所有可用的模式,以及构建新。 工作区还包括模式编辑器,在本教程中,您将在画布上构建模式。
登录Experience Platform后,单 击左 侧导航中的模式,您将转到模式工作区。 您将看到一列表模式(模式库的表示),您可以在其中视图、管理和自定义所有可用模式。 列表包括模式所基于的名称、类型、类和行为(记录或时间序列),以及模式上次修改的日期和时间。
单击“搜索”栏旁边的筛选器图标,以对注册表中的所有资源(包括类、混合和数据类型)使用筛选功能。

创建和命名模式

要开始编写模式,请单 击模式 工作区右上角的“创建模式”。
出现 模式编 辑器。 这是您将在其上创作模式的画布。 当您到达编辑器时,画布的“结构”部分会自 动创建 “无标题模式”,以便您开始自定义。
在编辑器的右侧是模式属 ,您可以在其中提供模式的名称(使用显 示名称 字段)。 输入名称后,画布会随之更新,以反映模式的新名称。
在为模式决定名称时,需要考虑以下几个重要事项:
  • 模式名称应简短且具有描述性,以便以后可以在库中轻松找到模式。
  • 模式名称必须是唯一的,这意味着它也应足够具体,以便将来不再重用它。 例如,如果您的组织具有针对不同品牌的单独忠诚项目,则最好将您的模式命名为“Brand A Loyalty Members”,以便轻松与您稍后可能定义的其他与忠诚度相关的模式区分开来。
  • 或者,您也可以使用“说明”字段提供有关模式的 其他 信息。
本教程构建一个模式,用于收集与忠诚项目成员相关的数据,因此该模式命名为“忠诚会员”。

分配类

编辑器的左侧是“合成” 部分 。 它当前包含两个子部分: 模式 课程
既然模式有名称,就该指定模式将实现的类了。 单击 “类 ”旁 的“分配 ”。
将显 示“指定类 ”对话框。 此窗口显示所有可用类的列表,包括您的组织定义的任何类(所有者是“客户”)以及Adobe定义的标准类。
单击类名称可显示类的说明。 您还可以选择 预览类结构 ,以查看与类关联的字段和元数据。
本教程使用XDM单个用户档案类。 单击类旁的单选按钮进行选择,然后单击“指 定类”
画布将重新显示。 “ ”部分现在包含您选择的类(XDM单个用户档案),XDM单个用户档案类贡献的字段现在在“结构”部分 中可见
字段以“fieldName”格式显示 |数据类型”。 本教程稍后提供了在UI中定义模式字段的步骤。
在保 存模式之前 ,您可以在初始合成过程中的任意点更改模式的类,但应当非常小心。 Mixins仅与某些类兼容,因此更改类将重置画布和已添加的任何字段。

添加混音

既然已分配了类,“合 ”部分包含第三个子部分: 混音
您现在可以通过添加混音开始向模式添加字段。 混音是由一个或多个字段组成的组,用于描述特定概念。 本教程使用mixins描述忠诚度项目的成员并捕获关键信息,如姓名、生日、电话号码、地址等。
要添加混音,请单 Mixins 子部 分中的“添加”。
将出 现“添加混合 ”对话框。 混音仅用于特定类,因此混音的列表只显示与所选类(本例中为XDM单个用户档案类)兼容的类。
选择混音旁的单选按钮将为您提供“预览混音结 构”选项 。 选择“用户档案人详细信息”混音,然后单击“添 加混音”
模式画布将重新显示。 Mixins 部分 现在列表“用户档案详细信息”混合,“结构 ** ”部分包括混合所贡献的字段。
此混音在顶级名称“person”下提供数据类型为“Person”的多个字段。 这组字段描述有关个人的信息,包括姓名、出生日期和性别。
请记住,字段可能使用标量类型(如字符串、整数、数组或日期)作为其模式类型,以及注册表中的任何“数据类型”(表示通用概念的字段组)。
请注意,“名称”字段的数据类型为“人员姓名”,这意味着该字段也描述了通用概念,并包含与名称相关的子字段,如名字、姓氏和全名。
单击画布中的不同字段,查看它们贡献给模式结构的任何其他字段。

添加另一个混音

您现在可以重复相同的步骤来添加另一个混音。 当您此次视图 “添加用户档案 ”对话框时,请注意“人详细信息”混音已灰显,并且其旁边的单选按钮无法被选择。 这可防止您意外复制已包含在当前模式中的混音。
您现在可以从“添加混音”对话框添加“用户档案个人 详细信息 ”混音。
添加后,画布将重新显示。 “用户档案个人详细信息”现在列 在“合成 *”部分的* Mixin下,并且“结构”下添加了家庭地址、手机等 字段
与“名称”字段相似,您刚添加的字段表示多字段概念。 例如,“homeAddress”的数据类型为“Address”,“mobilePhone”的数据类型为“Phone Number”。 您可以单击其中的每个字段展开它们,并查看数据类型中包含的其他字段。

定义新混音

“忠诚度会员”模式用于捕获与忠诚度项目成员相关的数据,因此它需要一些特定的忠诚度相关字段。 没有包含必要字段的标准混音,因此您需要定义新混音。
此时,打开“添加混 合”对话框 ,选择 “创建新混合” 。 随后将要求您为混音提 供显示 名称和说 明。
与类名称一样,混音名称应简短,用于描述混音对模式的贡献。 它们也是唯一的,因此您将无法重用该名称,因此必须确保其足够具体。
对于本教程,将新混音命名为“忠诚度详细信息”。
单击 “添加混合 ”以返回到模式编辑器。 “忠诚度详细信息”现 在应显示在 画布左侧的Mixins下,但还没有与它关联的字段,因此“结构”下没有新的字

向混音添加字段

现在您已创建“忠诚度详细信息”混音,是时候定义混音将对模式贡献的字段了。
要开始,请单击“混音”部分中的混 音名 。 完成此操作后, 编辑器的右侧将显示 “Mixin Properties”(混合属性),并且“Structure”(结构)下的模式名 称旁将显示“Add Field ”(添加字段) 按钮
单击 “Loyalty Members”旁边的“添加字段”,在结构中创建新节点。 此节点(在本示例中称为“_tenantId”)表示您的IMS组织的租户ID,前面有下划线。 租户ID的存在表示您正在添加的字段包含在您组织的命名空间中。
换言之,您添加的字段对您的组织而言是独一无二的,并将保存在模式注册表中仅可供您的IMS组织访问的特定区域。 您定义的字段必须始终添加到您的命名空间中,以防止与来自其他标准类、混音、数据类型和字段的名称发生冲突。
在该命名空间节点中有一个“新字段”。 这是“忠诚度详细信息”混音的开始。
使 用编辑器 右侧的字段属性,通过创建类型为“Object”的“loyalty”字段(用于保存与忠诚度相关的字段)进行开始。 完成后,单击“ 应用 ”。
将应用更改并显示新创建的“忠诚度”对象。 单 击对象旁 “添加字段”以添加其他与忠诚度相关的字段。 将显示“新建字段” ,画布 右侧将显示“字段属性”部分。
每个字段都需要以下信息:
  • 字段名称: 字段的名称,用驼峰大小写写。 示例: loyaltyLevel
  • 显示名称: 字段的名称,以标题大小写写写。 示例: 忠诚度级别
  • 类型: 字段的数据类型。 这包括基本标量类型和在模式注册表中定义的任何数据类型。 示例: 字符串、整数、布尔值、人员、地址、电话号码等。
  • 描述: 该字段的可选描述应包含在句子中。 (最多200个字符。)
Loyalty对象的第一个字段将是一个名为“loyaltyId”的字符串。 将新字段的类型设置为“字符串”时,“字段属 ”窗口将填充多个用于应用约束的选项, 包括Default Value Format ​和Maximum Length
根据所选数据类型,可以使用不同的约束选项。 由于“loyaltyId”将是电子邮件地址,因此请从“格式”下拉菜单中选择“ 电子邮件 ”。 选择 应用 ,以应用更改。

添加更多字段以混音

现在,您已添加“loyaltyId”字段,可添加其他字段以捕获与忠诚度相关的信息,例如:
  • 点(整数)
  • 会员自(日期)
通过单击忠诚度对象 上的“添加字段 ”并填写所需的信息,可添加每个字段。
完成后,Loyalty对象将包含以下字段: 忠诚度ID、积分和会员。

添加“枚举”字段以混音

在模式编辑器中定义字段时,您可以应用一些其他选项来对基本字段类型进行限制,以便对字段可以包含的数据提供进一步的约束。
此示例为“忠诚度级别”字段,其中值只能是四个可能选项之一。 要将此字段添加到模式,请单 击“loyalty ”对象旁的“添加字段” ,然后在“字段属性”下填写必 ​填字段。
对于 类型 ,选择“字符串”,您将看到Array、Enum和Identity Adobe的其 ​他复选 ​框出现。
选中枚 复选框以打开 下面的枚 举值。 在此,您可以为每 个可接受 的忠诚度级别输入Value (在camelCase中)和 Label(在Title Case中是可选的、对读者友好的名称)。
完成所有字段属性后,单 “应用”,“loyaltyLevel”字段将添加到“loyalty”对象。
有关可用附加约束的更多信息:
  • 必需: 指示数据获取需要此字段。 根据此模式上传到数据集且不包含此字段的任何数据在摄取时都将失败。
  • 阵列: 指示字段包含一组值,每个值都指定了数据类型。 例如,选择“字符串”的数据类型并选中“数组”复选框表示字段将包含字符串数组。
  • 枚举: 指示此字段必须包含来自可能值的枚举列表的值之一。
  • 身份: 指示此字段是标识字段。 有关标识字段的更多信 息将在本教程后面提供

将多字段对象转换为数据类型

添加多个特定于忠诚度的字段后,“loyalty”对象现在包含一个公共模式结构,该结构可能在其他数据中有用。
当您认为多字段结构可以重复使用,并且希望能够灵活地在其他位置使用相同的模式结构时,编辑器可以将该结构转换为数据类型。
数据类型允许多字段结构的一致使用,并提供比混音更灵活的性能,因为它们可以在模式的任何位置使用。 这是通过将混合中 字段的 “类型”设置为注册表中定义的任何数据类型来完成的。
要将“loyalty”对象转换为数据类型,请单击“ Structure ”下的“loyalty”字段,然 后在“Field Properties ”下选择编辑器右侧的“Convert to New Data Type” ​出现一个小的绿色弹出窗口,确认“对象已转换为数据类型”。
现在,当您在“结 ”下查看时,您会发现“忠诚度”字段的数据类型为“忠诚度”,并且字段旁边有小的锁图标,表示它们不再是单个字段,而是多字段结构的一部分。
在将来的模式中,您现在可以为一个 字段指 定“忠诚度”的类型,它将自动包括“忠诚度级别”、“积分”、“成员开始”和“忠诚度ID”字段。

将模式字段设置为标识字段

模式用于将数据引入Experience Platform,数据最终用于识别个人并整合来自多个来源的信息。 要帮助处理此过程,键字段可标记为“Identity”字段。
Experience Platform通过使用模式编辑器中的“标识”复选框 ​,可轻松地指示标识字段。
例如,忠诚度项目中可能有数千个成员属于同一“级别”,但忠诚度项目的每个成员都有唯一的“loyaltyId”(在此实例中为单个成员的电子邮件地址)。 “loyaltyId”是每个成员的唯一标识符,这一事实使它成为标识字段的最佳候选者,而“level”则不是。
在编辑器 “结构”部分,单击您创建的“loyaltyId”字段,您将看到“字段属性”下 “标识”复 ​选框。 选中该框,您将可以选择将其设置为主 标识 。 同时选中该框。
接下来,您必须提供 标识名称空间 。 有几个预定义的命名空间,但由于“loyaltyId”是成员的电子邮件地址,因此请从下拉列表中选择“电子邮件”。 您现在可以单 “应用”以确认对“loyaltyId”字段的更新。
现在,所有引入“loyaltyId”字段的数据都将用于帮助识别该个人并整合该客户的单个视图。
将模式字段设置为主标识后,如果稍后尝试将模式中的其他字段设置为主标识,您将收到错误消息。 每个模式只能包含一个主标识字段。
要了解有关使用身份的更多信息,请查阅Identity Service文档

启用模式以用于实时客户用户档案

模式编辑器允许模式与实时 客户用户档案一起使用 。 用户档案通过构建可靠的、360°用户档案的客户属性以及客户在与Experience Platform集成的任何系统中进行的每次交互的时间戳帐户,为每位客户提供全面的视图。
要使模式能够与实时客户用户档案一起使用,它必须定义主标识。 如果您尝试启用模式而未先定义主标识,则会收到“缺少主标识”错误消息。
要启用“忠诚会员”模式在用户档案中使用,请首先单击编辑器“结构”部分 中的 “忠诚会员”。
在编辑器的右侧的“模式属性” ,将显示有关模式的信息,包括其显示名称、说明和类型。 除此信息外,还有一个名为用户档案的切换 按钮
击用户档案 ,然后出现一个弹出窗口,要求您确认是否要启用模式进行用户档案。
模式启用“实时客户”用户档案并保存后,便无法禁用它。

后续步骤

现在您已完成“忠诚会员”模式的编写,您可以在编辑器的“结构”部分 看到 完整的模式。 单 “保存”,模式将保存到模式库,模式注册表可访问该库。
您的新模式现在可用于将数据引入平台。 请记住,一旦模式被用于摄取数据,只能进行附加更改。 有关模式 版本控制的更多信息 ,请参阅模式合成的基础知识。
“Loyalt Members”模式还可用于使用模式注册表API查看和管理。 要开始使用API,请阅读开始注册表API开 发人员指南进行模式

附录

以下信息是模式编辑器教程的补充。

Create a new class

Experience Platform能够灵活地根据组织特有的类定义模式。
在模式编 辑器的 “类”部分中单 “分 配”,打开 “分配类”对话框。 在对话框中,选择“ 创建新类”
然后,您可以为新类 定义模式将定义的 “显示名称”(类的简短、描述性、唯一且用户友好的名称)、“说 ”和 “行为 ”(“记录”或“时间序列”)。
构建实现组织定义的类的模式时,请记住,混合仅可用于兼容类。 由于您定义的类是新类,因此“添加混音”对话框中未列 出兼容混音 。 相反,您需要选择“创 建新混音 ”并定义一个混音以用于该类。 下次构建实现新类的模式时,将列出您定义的混音并可供使用。

更改模式的类

在初始模式合成过程中的任何时间,在保存模式之前,您都可以更改模式所基于的类。
在更改课程之前,请务必小心。 Mixins仅与某些类兼容,因此更改类会重置画布并删除已添加到该点的所有字段。
要更改类,请在编辑 器的 “合 ”部分中单 击“类 ”旁边的“分配”。
当“分 配类 ”对话框打开时,您可以从可用列表中选择新类。 单 击“分配 类”,此时将打开一个新对话框,要求您确认要分配新类。
如果您确认类更改,画布将重置,并且所有合成进度都将丢失。