使用Schema Editor建立模式

Adobe Experience Platform使用者介面可讓您在稱為Schema Editor的互動式視覺畫布中建立和管理Experience Data Model (XDM)結構。 本教程介紹如何使用Schema Editor建立模式。

注意

為了進行示範,本教學課程中的步驟包括建立描述客戶忠誠度方案成員的範例架構。 雖然您可以使用這些步驟為自己建立不同的架構,但建議您先遵循建立範例架構,以瞭解Schema Editor的功能。

如果您偏好使用Schema Registry API來編寫架構,請先閱讀Schema Registry 開發人員指南,再嘗試使用API](create-schema-api.md)建立架構的教學課程。[

快速入門

本教學課程需要對架構建立中涉及的Adobe Experience Platform各個方面有深入的瞭解。 在開始本教學課程之前,請先閱讀說明檔案,瞭解下列概念:

開啟方案工作區

Platform UI中的結構描述工作區提供Schema Library的視覺化效果,允許您查看管理組織可用的結構描述。 工作區也包含Schema Editor,您可在此教學課程中組合架構的畫布。

登入Experience Platform後,在左側導覽中選擇​方案​以開啟​方案​工作區。 瀏覽​標籤顯示可查看和自定義的方案清單(Schema Library的表示法)。 該清單包括方案所基於的名稱、類型、類和行為(記錄或時間序列),以及上次修改方案的日期和時間。

如需詳細資訊,請參閱UI](…/ui/explore.md)中[探索現有XDM資源的指南。

建立並命名方案

要開始合成方案,請在​方案​工作區右上角選擇​建立方案。 此時會顯示下拉式選單,提供您選擇核心類別XDM Individual Profile和XDM ExperienceEvent的選項。 如果這些類不符合您的目的,您也可以選擇​Browse​以從其他可用類中選擇,或者選擇建立新類

在本教程中,選擇​XDM Individual Profile

出現Schema Editor。 這是您將在其中構成架構的畫布。 由於您選擇了標準XDM類作為模式的基礎,因此當您到達編輯器時,將在畫布的​Structure​部分自動建立未命名的模式,以及基於該類的所有架構中包含的標準欄位。 在​Composition​節中,該架構的已分配類也列在​Class​下。

注意

在保存模式之前的初始合成過程中,可以在任意點更改模式的類,但應該非常小心。 Mixins僅與特定類別相容,因此變更類別會重設畫布和您新增的任何欄位。

使用編輯器右側的欄位,提供架構的顯示名稱和選用說明。 輸入名稱后,畫布會更新以反映架構的新名稱。

在決定架構的名稱時,需要考慮幾個重要事項:

  • 架構名稱應簡短且具說明性,以便稍後可輕鬆找到架構。
  • 架構名稱必須是唯一的,這表示它也應足夠具體,以免日後重複使用。 例如,如果您的組織針對不同品牌有不同的忠誠度方案,最好將方案命名為「品牌A忠誠度成員」,以便輕鬆區分您稍後可能定義的其他忠誠度相關方案。
  • 您也可以使用結構描述來提供與結構描述相關的任何其他上下文資訊。

本教程將構建一個方案,以便接收與忠誠度方案成員相關的資料,因此,該方案名為「忠誠度成員」。

新增mixin

您現在可以新增mix,開始將欄位新增至您的架構。 混音是一組一個或多個欄位,通常一起用於描述特定概念。 本教學課程使用mixin來描述忠誠度計畫的成員,並擷取關鍵資訊,例如姓名、生日、電話號碼、地址等。

要添加混音,請在​Mixins​子部分中選擇​Add

隨即出現新對話方塊,顯示可用混音清單。 每個混音僅用於特定類,因此對話框僅列出與所選類(在本例中為XDM Individual Profile類)相容的混音。 如果您使用標準XDM類別,則會根據使用人氣,智慧地排序混合清單。

從清單中選取混音,會使混音出現在右側邊欄中。 您可以視需要選取多個混音,在確認前先將每個混音新增至右側邊欄的清單。 此外,目前選取混音的右側會出現一個圖示,可讓您預覽其提供的欄位結構。

在預覽混音時,在右側導軌中提供混音的結構的詳細描述。 您也可以瀏覽所提供畫布中的mixin欄位。 當您選取不同欄位時,右側欄位會更新,以顯示相關欄位的詳細資訊。 當您完成預覽時,選擇​Back​以返回混音選擇對話框。

在本教學課程中,選擇​人口統計詳細資料 mixin,然後選擇​新增mixin

結構畫布會重新出現。 Mixins​區段現在列出「人口統計詳細資料」,而​Structure​區段包含由mixin貢獻的欄位。 您可以在​Mixins​區段下選取mixin的名稱,以反白顯示它在畫布中提供的特定欄位。

此混音在頂層名稱person下提供數個欄位,資料類型為"Person"。 此欄位群組說明個人的相關資訊,包括姓名、出生日期和性別。

注意

請記住,欄位可能會使用標量類型(例如字串、整數、陣列或日期),以及Schema Registry中定義的任何資料類型(表示共同概念的欄位群組)。

請注意,name欄位的資料類型為"人員名稱",這表示它也說明一個通用概念,並包含與名稱相關的子欄位,例如名字、姓氏、禮貌標題和字尾。

選擇畫布中的不同欄位,以顯示它們對架構結構所貢獻的其他欄位。

添加另一個混音

您現在可以重複相同的步驟來新增另一個混音。 當您這次檢視「新增mixin ]」對話方塊時,請注意「人口統計詳細資料」混音已變灰,且旁邊的核取方塊無法選取。[​這可防止意外複製您已包含在目前架構中的混音。

在本教程中,從對話框中選擇"Personal Contact Details" mixin,然後選擇​添加mixin​將其添加到模式。

新增後,畫布會重新顯示。 "個人聯絡資訊"現在列在​Composition​區段的​Mixins​下,而且在​Structure​下新增了家庭位址、行動電話等欄位。

name欄位類似,您剛新增的欄位代表多欄位概念。 例如,homeAddress的資料類型為「郵遞區號」,而mobilePhone的資料類型為「電話號碼」。 您可以選取每個欄位以展開這些欄位,並查看資料類型中包含的其他欄位。

定義新混音

「忠誠度成員」結構旨在捕獲與忠誠度方案成員相關的資料,因此它需要一些與忠誠度相關的特定欄位。 沒有可用的標準混音包含必要的欄位,因此您需要定義新的混音。

此時,當您開啟​新增Mixin​對話方塊時,請選取​建立新Mixin。 接著會要求您提供混合的顯示名稱和說明。

和類名一樣,混音名應簡短,說明混音對架構的貢獻。 這些名稱也是唯一的,因此您將無法重複使用名稱,因此必須確保它足夠具體。

在本教學課程中,請將新混音命名為「忠誠度詳細資訊」。

選擇​添加mixin​返回Schema Editor。 "忠誠度詳細資料"現在應顯示在畫布左側的​Mixins​下,但目前尚無相關欄位,因此在​Structure​下不會顯示新欄位。

新增欄位至mixin

現在您已建立「忠誠度詳細資料」混音,是時候定義混音將對結構貢獻的欄位了。

首先,在​Mixins​區段中選擇混音名稱。 執行此操作後,mixin的屬性會顯示在編輯器的右側,並且​+(+)​表徵圖會出現在​Structure​下的架構名稱旁。

選擇"Loyalty Members"旁邊的​加號(+)​表徵圖,在結構中建立新節點。 此節點(在此範例中稱為_tenantId)代表您的IMS組織的租用戶ID,前面有底線。 租用戶ID的存在表示您新增的欄位包含在您組織的命名空間中。

換言之,您新增的欄位對您的組織而言是獨一無二的,而且會儲存在Schema Registry中,位於只有您的組織才能存取的特定區域。 您定義的欄位必須一律新增至您的租用戶名稱空間,以避免與其他標準類別、混合、資料類型和欄位的名稱產生衝突。

該命名空間節點內部是"新建欄位"。 這是"忠誠度詳細資料"混合的開頭。

使用編輯器右側的控制項,首先建立類型為"Object"的loyalty欄位,以用於保存您的忠誠度相關欄位。 完成後,選擇​Apply

將應用更改並顯示新建立的loyalty對象。 選取物件旁的​加號(+)​圖示,以新增其他與忠誠度相關的欄位。 「新欄位」出現,而「欄位屬性」區段會顯示在畫布的右側。

每個欄位都需要下列資訊:

  • 欄位名稱:欄 位的名稱,以駝峰大小寫寫。範例:loyaltyLevel
  • 顯示名稱: 以標題大小寫寫的欄位名稱。範例:忠誠度等級
  • 類型: 欄位的資料類型。這包括基本標量類型和Schema Registry中定義的任何資料類型。 範例:字串、整數、布林、人、地址、電話號碼等。
  • 說明: 欄位的選用說明應包含在句子中,最多應包含200個字元。

Loyalty物件的第一個欄位將是名為loyaltyId的字串。 將新欄位的類型設定為"String"時,Field屬性​部分將填入幾個用於應用約束的選項,包括預設值、格式和最大長度。

根據所選資料類型,可使用不同的約束選項。 由於loyaltyId將是電子郵件地址,因此從​格式​下拉式選單中選擇「email」。 選擇​應用​以應用更改。

將更多欄位新增至mixin

現在您已新增loyaltyId欄位,您可以新增其他欄位來擷取與忠誠度相關的資訊,例如:

  • 點(整數)
  • 會員登記(日期)

要將每個欄位添加到方案中,請選擇loyalty對象旁的​加號(+)​表徵圖並填寫所需資訊。

完成後,「忠誠度」物件將包含忠誠度ID、點數和成員間隔的欄位。

將列舉欄位新增至mixin

在Schema Editor中定義欄位時,有一些附加選項可以應用於基本欄位類型,以便對欄位可包含的資料提供進一步的約束。 下表說明了這些約束的使用案例:

約束 說明
必填 指出資料擷取需要此欄位。 任何根據此架構上傳至資料集且不包含此欄位的資料,在擷取時都會失敗。
陣列 指出欄位包含一組值,每個值都指定了資料類型。 例如,在資料類型為"String"的欄位上使用此約束指定該欄位將包含字串陣列。
Enum 指出此欄位必須包含可能值列舉清單中的其中一個值。
身份 指出此欄位是身分欄位。 有關身分欄位的更多資訊,請參閱本教學課程](#identity-field)的稍後章節。[
關係 雖然架構關係可以通過使用union架構和Real-time Customer Profile來推斷,但這僅適用於共用相同類的架構。 Relationship約束表示該欄位引用基於不同類的方案的主標識,這意味著兩個方案之間的關係。 有關詳細資訊,請參閱定義關係的教程。
注意

任何必填、身分或關係欄位都會顯示在左側導軌中,讓您不論架構的複雜性如何,都能輕鬆找到這些欄位。

在本教學課程中,架構中的"loyalty"物件需要新的列舉欄位,以說明客戶的「忠誠度等級」,其中值只能是四個可能選項之一。 要將此欄位添加到方案中,請選擇loyalty對象旁的​加號(+)​表徵圖,並填寫​欄位名​和​顯示名​的必需欄位。 對於​Type,選擇「字串」。

選擇欄位類型後,將顯示其他複選框,包括​ArrayEnum​和​Identity​的複選框。

選擇​Enum​複選框以開啟下面的​Enum值​部分。 在這裡,您可以為每個可接受的忠誠度等級輸入​Value(在camelCase中)和​Label(在Title Case中為可選的讀者友好名稱)。

完成所有欄位屬性後,選擇​Apply​將「loyaltyLevel」欄位添加到loyalty對象。

將多欄位物件轉換為資料類型

loyalty物件現在包含數個特定於忠誠度的欄位,並代表通用的資料結構,可用於其他結構。 Schema Editor可讓您將這些物件的結構轉換為資料類型,以輕鬆套用可重複使用的多欄位物件。

資料類型允許一致地使用多欄位結構,並提供比混音更大的靈活性,因為它們可以在架構中的任意位置使用。 這是通過將欄位的​Type​值設定為Schema Registry中定義的任何資料類型的值來完成的。

要將loyalty對象轉換為資料類型,請選擇​結構​下的loyalty欄位,然後選擇編輯器右側​欄位屬性​下的​轉換為新資料類型。 出現綠色快顯,確認物件已成功轉換。

現在,當您查看​Structure​下方時,您會看到loyalty欄位的資料類型為"Loyalty",欄位旁邊有小型鎖定圖示,表示它們不再是個別欄位,而是多欄位資料類型的一部分。

在未來的架構中,您現在可以指派「Loyalty」類型的欄位,並自動包含ID、忠誠度等級、成員自身及點數的欄位。

注意

您也可以建立和編輯自訂資料類型,而不受編輯結構描述的影響。 有關詳細資訊,請參閱建立和編輯資料類型的指南。

搜尋和篩選結構欄位

您的架構現在除了其基本類別提供的欄位外,還包含數個混音。 使用較大的結構時,您可以選擇左側導軌中混音名稱旁的核取方塊,將顯示的欄位篩選為您感興趣的混音所提供的欄位。

如果您在架構中尋找特定欄位,也可以使用搜尋列來依名稱篩選顯示的欄位,而不論其下提供何種混音。

重要

當顯示相符欄位時,搜尋函式會將任何選取的混合篩選納入考量。 如果搜尋查詢未顯示您預期的結果,您可能需要再次檢查您是否未篩選出任何相關混音。

將架構欄位設定為標識欄位

架構所提供的標準資料結構可用於跨多個來源識別屬於同一個人的資料,允許各種下游使用案例,例如分段、報告、資料科學分析等。 為了根據個別身分來接合資料,索引鍵欄位必須標示為適用結構中的Identity欄位。

Experience Platform 使您可以透過使用中的「識別」核取方塊,輕鬆 ​地標示識別欄 Schema Editor位不過,您必鬚根據資料的性質,判斷哪個欄位最適合做為身分識別。

例如,可能有數千個忠誠度方案成員屬於相同的「忠誠度等級」,但忠誠度方案的每個成員都有唯一的loyaltyId(在此例中為個別成員的電子郵件地址)。 loyaltyId是每個成員的唯一標識符,這使它成為身份欄位的理想候選符,而loyaltyLevel則否。

重要

下面介紹的步驟介紹如何將身份描述符添加到現有模式欄位。 除了在架構本身的結構中定義身份欄位外,您還可以使用identityMap欄位來改為包含身份資訊。

如果您打算使用identityMap,請記住它將覆蓋您直接添加到架構中的任何主標識。 有關詳細資訊,請參閱架構構成指南中有關identityMap的部分。

在編輯器的​Structure​部分,選擇loyaltyId欄位,並在​Field properties​下顯示​Identity​複選框。 選中該框並顯示將其設定為​主標識​的選項。 也選擇此框。

注意

每個架構只能包含一個主標識欄位。 一旦將方案欄位設定為主標識,如果您稍後嘗試將方案中的另一個標識欄位設定為主標識,將會收到錯誤消息。

接著,您必須從下拉式清單中預先定義的名稱空間清單中提供​Identity namespace。 由於loyaltyId是客戶的電子郵件地址,因此從下拉式清單中選擇「電子郵件」。 選擇​應用​以確認loyaltyId欄位的更新。

注意

有關標準名稱空間及其定義的清單,請參見Identity Service documentation

套用變更後,loyaltyId的圖示會顯示指紋符號,指出它現在是識別欄位。

現在,所有收錄在loyaltyId欄位中的資料都將用來協助識別該個人,並將該客戶的單一檢視結合在一起。 若要進一步瞭解在Experience Platform中使用身分識別,請參閱Identity Service檔案。

啟用方案以用於Real-time Customer Profile

Real-time Customer Profile 運用身分資料, Experience Platform 提供每位客戶的全方位檢視。此服務可建立強穩、360°的客戶屬性描述檔,以及客戶在與Experience Platform整合的任何系統上,所有互動的時間戳記帳戶。

要啟用與Real-time Customer Profile一起使用的架構,它必須定義主標識。 如果您嘗試啟用方案而未先定義主要身分,則會收到錯誤訊息。


要啟用Profile中的「忠誠成員」架構,請首先在編輯器的​結構​部分中選擇「Loyalty Members」。

在編輯器的右側,會顯示有關架構的資訊,包括其顯示名稱、說明和類型。 除此資訊外,還有​描述檔​切換按鈕。

選擇​描述檔​並出現一個快顯視窗,要求您確認您要啟用Profile的架構。


警告

在Real-time Customer Profile啟用並儲存架構後,便無法停用它。

選擇​啟用​以確認您的選擇。 如果需要,可以再次選擇​Profile​切換以禁用模式,但在Profile啟用時保存模式後,便不能再禁用它。

後續步驟和其他資源

現在,您已完成架構合成,您就可以在畫布中看到完整的架構。 選擇​Save,架構將保存到Schema Library,使Schema Registry可以訪問該架構。

您的新架構現在可用來將資料內嵌至Platform。 請記住,一旦使用架構來收錄資料,則只能進行加性變更。 有關方案版本化的詳細資訊,請參見架構組成的基礎

您現在可以遵循的教學課程,在UI中定義結構關係,將新的關係欄位新增至「忠誠度成員」結構。

「忠誠度成員」結構也可供使用Schema Registry API來檢視和管理。 若要開始使用API,請先閱讀Schema Registry API 開發人員指南

視訊資源

警告

下列視訊中顯示的Platform UI已過時。 請參閱上述檔案以取得最新的UI螢幕擷取和功能。

以下視訊說明如何在Platform UI中建立簡單架構。

以下影片旨在強化您對使用混合與類別的瞭解。

附錄

以下各節提供有關Schema Editor使用的附加資訊。

建立新類

Experience Platform 提供了根據組織唯一的類定義方案的靈活性。要瞭解如何建立新類,請參閱UI](…/ui/resources/classes.md#create)中[建立和編輯類的指南。

更改方案的類

可以在保存模式之前,在初始合成過程中的任意點更改模式的類。

警告

重新指派架構的類別時應格外小心。 Mixins僅與特定類別相容,因此變更類別會重設畫布和您新增的任何欄位。

要瞭解如何更改架構類別,請參閱UI](…/ui/resources/schemas.md)中[管理架構的指南。

本頁內容