使用Schema Editor建立結構描述
Adobe Experience Platform使用者介面可讓您在名為Schema Editor的互動式視覺畫布中建立和管理Experience Data Model (XDM)結構描述。 本教學課程涵蓋如何使用Schema Editor建立結構描述。
為了示範,本教學課程中的步驟涉及建立範例結構描述,以說明客戶忠誠度計畫的成員。 雖然您可以使用這些步驟建立不同的結構描述以供您自己的用途,但建議您先依照建立範例結構描述以瞭解Schema Editor的功能。
快速入門
此教學課程需要您實際瞭解架構建立中Adobe Experience Platform的各個層面。 在開始本教學課程之前,請檢閱檔案以瞭解下列概念:
- Experience Data Model (XDM): Platform用來組織客戶體驗資料的標準化架構。
- 結構描述組合的基本概念: XDM結構描述及其建置區塊的概觀,包括類別、結構描述欄位群組、資料型別和個別欄位。
- Real-Time Customer Profile:根據來自多個來源的彙總資料,提供統一的即時消費者設定檔。
開啟結構描述工作區 browse
Platform UI中的結構描述工作區提供Schema Library的視覺效果,可讓您檢視管理組織可用的結構描述。 工作區也包含Schema Editor,您可在此畫布上撰寫此教學課程的結構描述。
登入Experience Platform後,在左側導覽中選取 結構描述 以開啟 結構描述 工作區。 瀏覽 索引標籤會顯示結構描述清單(Schema Library的表示方式),供您檢視和自訂。 此清單包括結構描述所根據的名稱、型別、類別和行為(記錄或時間序列),以及上次修改結構描述的日期和時間。
如需詳細資訊,請參閱在UI中探索現有XDM資源的指南。
建立方案並為其命名 create
若要開始撰寫結構描述,請選取 結構描述 工作區右上角的 建立結構描述。
建立結構描述工作流程隨即顯示。 接著,選擇結構描述的基底類別。 您可以選擇XDM Individual Profile與XDM ExperienceEvent的核心類別,或是Other (如果這些類別不適合您的用途)。 其他類別選項可讓您建立新類別,或從其他預先存在的類別中選擇。
如需這些類別的詳細資訊,請參閱XDM個別設定檔和XDM ExperienceEvent檔案。 在本教學課程中,請選取 XDM個別設定檔,然後選取 下一步。
選取類別之後,名稱和檢閱區段就會顯示。 您可以在此段落中提供名稱和說明,以識別您的結構描述。 決定結構描述的名稱時,有幾個重要考量事項需要考慮:
- 結構描述名稱應簡短且具有描述性,以便之後可以輕鬆找到結構描述。
- 結構描述名稱必須是唯一的,這表示它也應該是足夠具體的,以使其在將來不會重複使用。 例如,如果貴組織針對不同品牌有不同的忠誠度計畫,則明智的做法是命名您的方案為「品牌A忠誠度會員」,以便輕鬆區別於您稍後可能定義的其他忠誠度相關方案。
- 您也可以使用結構描述來提供關於結構描述的任何其他內容相關資訊。
此教學課程撰寫結構描述以擷取與熟客方案成員相關的資料,因此結構描述命名為"Loyalty Members"。
結構描述的基本結構(由類別提供)會顯示在畫布中,供您檢閱及驗證選取的類別和結構描述結構。
在文字欄位中輸入人性化的結構描述顯示名稱。 接下來,輸入適當的說明來協助識別您的結構描述。 當您檢閱了結構描述結構並對您的設定感到滿意時,請選取 完成 以建立結構描述。
Schema Editor出現。 這是您將在其中撰寫結構描述的畫布。 當您進入編輯器時,會自動在畫布的 結構 區段中建立自標名的結構描述,以及包含在您選取之基底類別中的標準欄位。 結構描述的指派類別也列在 構成 區段的 類別 下。
新增欄位群組 field-group
您現在可以透過新增欄位群組來開始將欄位新增到結構描述。 欄位群組是一或多個欄位的群組,通常搭配使用來描述特定概念。 本教學課程使用欄位群組來說明熟客方案的成員,並擷取關鍵資訊,例如,姓名、生日、電話號碼、地址等。
若要新增欄位群組,請在 欄位群組 子區段中選取 新增。
新的對話方塊隨即出現,顯示可用欄位群組的清單。 每個欄位群組僅供特定類別使用,因此對話方塊僅列出與您選取的類別(在此例中為XDM Individual Profile類別)相容的欄位群組。 如果您使用標準XDM類別,欄位群組清單將會根據使用人氣聰明地排序。
您可以選取左側邊欄中的其中一個篩選器,將標準欄位群組清單縮小至特定產業,例如零售、金融服務及醫療保健。
從清單中選取欄位群組後,該群組就會顯示在右側邊欄中。 您可以視需要選取多個欄位群組,在確認前將每個欄位群組新增到右側欄的清單中。 此外,圖示會顯示在目前所選欄位群組的右側,可讓您預覽其所提供的欄位結構。
預覽欄位群組時,右側邊欄會提供欄位群組的結構描述詳細資訊。 您還可以瀏覽提供的畫布中的欄位群組欄位。 當您選取不同欄位時,右側欄會更新,顯示有關問題欄位的詳細資訊。 完成預覽後選取 上一步 以返回欄位群組選取對話方塊。
在本教學課程中,請選取 人口統計詳細資料 欄位群組,然後選取 新增欄位群組。
結構畫布會重新出現。 欄位群組 區段現在會列出「人口統計詳細資料」,而 結構 區段包含由欄位群組貢獻的欄位。 您可以在 欄位群組 區段下選取欄位群組名稱,以反白顯示它在畫布中提供的特定欄位。
![掛鎖圖示表示。](./media_14897d17936cd65d68cccb634f23c71c699ddfc5d.png?width=750&format=png&optimize=medium)
![結構描述編輯器反白顯示掛鎖圖示](./media_15633808ceddae0ac90e5311534ce5243989ac2c4.png?width=750&format=png&optimize=medium)
此欄位群組提供頂層名稱person
底下的數個資料型別為「人員」的欄位。 這組欄位說明個人的相關資訊,包括姓名、出生日期和性別。
請注意,name
欄位的資料型別為「全名」,這表示它也描述一般概念,並包含與名稱相關的子欄位,例如名字、姓氏、禮貌標題和尾碼。
選取畫布中的不同欄位,以顯示這些欄位對結構描述結構貢獻的任何其他欄位。
新增更多欄位群組 field-group-2
您現在可以重複相同的步驟來新增另一個欄位群組。 當您這次檢視 新增欄位群組 對話方塊時,請注意「人口統計詳細資料」欄位群組已變成灰色,且無法選取其旁邊的核取方塊。 這可防止您不小心複製已包含在目前結構描述中的欄位群組。
在本教學課程中,請從清單中選取標準欄位群組 個人聯絡人詳細資料 和 熟客方案詳細資料,然後選取 新增欄位群組 以將其新增至結構描述。
畫布會重新出現,新增的欄位群組列在 構成 區段的 欄位群組 下,它們的複合欄位會新增到結構描述結構中。
定義自訂欄位群組 define-field-group
熟客方案成員結構描述是用來擷取與熟客方案成員相關的資料,而您新增至結構描述的標準熟客方案詳細資料欄位群組可提供大部分這類資料,包括方案型別、點數、加入日期等。
但是,在某些情況下,您可能會想要包含標準欄位群組未涵蓋的其他自訂欄位,以便實現您的使用案例。 如果新增自訂忠誠度欄位,您有兩個選項:
- 建立新的自訂欄位群組以擷取這些欄位。 本教學課程將涵蓋此方法。
- 使用自訂欄位擴充標準熟客方案詳細資料欄位群組。 這會導致熟客方案詳細資料轉換為自訂欄位群組,且原始標準欄位群組將無法再使用。 請參閱結構描述 UI指南,以取得有關新增自訂欄位至標準欄位群組結構的詳細資訊。
若要建立新的欄位群組,請選取 欄位群組 子區段中如前一樣的 新增,但這次請選取靠近出現的對話方塊頂端的 建立新欄位群組。 接著,系統會要求您提供新欄位群組的顯示名稱和說明。 在本教學課程中,將新的欄位群組命名為"Custom Loyalty Details",然後選取 新增欄位群組。
"Custom Loyalty Details"現在應該出現在畫布左側的 欄位群組 下,但是還沒有任何欄位與其相關聯,因此 結構 下沒有新欄位出現。
新增欄位至欄位群組 field-group-fields
現在您已建立「Custom Loyalty Details」欄位群組,是時候定義欄位群組將貢獻給結構描述的欄位了。
若要開始,請選取畫布中結構描述名稱旁的 加號(+) 圖示。
畫布中會出現「未命名的欄位」預留位置,而右邊欄會更新,顯示該欄位的設定選項。
在此案例中,結構描述需要物件型別欄位,以詳細描述人員目前的熟客方案。 使用右側邊欄中的控制項,開始建立型別為"Object"的loyaltyTier
欄位,此欄位將用來儲存您的相關欄位。
在 指派給 下,您必須選取要指派欄位的欄位群組。 請記住,所有結構描述欄位都屬於類別或欄位群組,由於此結構描述使用標準類別,因此您唯一的選項是選取欄位群組。 開始輸入名稱「Custom Loyalty Details」,然後從清單中選取欄位群組。
完成後,選取 套用。
變更已套用,且新建立的loyaltyTier
物件隨即顯示。 由於這是自訂欄位,因此會自動巢狀內嵌在您組織租使用者ID名稱空間中的物件,前面會加上底線(在此範例中為_tenantId
)。
選取loyaltyTier
物件旁的 加號(+) 圖示以開始新增子欄位。 新的欄位預留位置隨即出現,畫布右側會顯示 欄位屬性 區段。
每個欄位都需要下列資訊:
- 欄位名稱: 欄位名稱,最好是以camelCase撰寫。 不允許使用空格字元。 這是用來參照程式碼和其他下游應用程式中的欄位的名稱。
- 範例:loyaltyLevel
- 顯示名稱: 欄位名稱,以標題大小寫撰寫。 這是檢視或編輯結構描述時,畫布中顯示的名稱。
- 範例:忠誠度等級
- 型別: 欄位的資料型別。 這包括基本純量型別和Schema Registry中定義的任何資料型別。 範例: String、Integer、Boolean、Person、Address、電話號碼等。
- 描述: 欄位的選擇性描述應包含最多200個字元。
loyaltyTier
物件的第一個欄位將是名為id
的字串,代表忠誠會員目前層級的ID。 每個忠誠會員的層級ID將是唯一的,因為該公司會根據不同因素為每個客戶設定不同的忠誠度層級臨界值。 將新欄位的型別設定為"字串",且 欄位屬性 區段會填入多個套用限制的選項,包括預設值、格式和最大長度。 如需瞭解詳細資訊,請參閱資料驗證欄位最佳實務的檔案。
由於id
將是隨機產生的自由字串,因此不需要進一步的限制。 選取 套用 以套用您的變更。
新增更多欄位至欄位群組 field-group-fields-2
現在您已新增id
欄位,您可以新增其他欄位來擷取忠誠度等級資訊,例如:
- 目前點臨界值(整數):成員必須維護以保留在目前層級中的最小熟客點數。
- 下一個層級點臨界值(整數):成員要畢業到下一個層級必須累積的熟客點數。
- 生效日期(日期 — 時間):熟客會員加入此階層的日期。
若要將每個欄位新增至結構描述,請選取loyalty
物件旁的 加號(+) 圖示,並填入必要資訊。
完成時,loyaltyTier
物件將包含id
、currentThreshold
、nextThreshold
和effectiveDate
的欄位。
新增列舉欄位至欄位群組 enum
在Schema Editor中定義欄位時,有一些可套用至基本欄位型別的額外選項,以便針對欄位可包含的資料提供進一步的限制。 下表說明這些限制的使用案例:
在本教學課程中,結構描述中的loyaltyTier
物件需要新的列舉欄位來說明階層類別,其中值只能是四個可能選項之一。 若要將此欄位新增至結構描述,請選取loyaltyTier
物件旁的 加號(+) 圖示,並填入 欄位名稱 和 顯示名稱 的必要欄位。 針對 Type,選取「String」。
選取欄位型別後,會出現其他核取方塊,包括 陣列、列舉與建議值、身分 和 關聯性 的核取方塊。
選取 列舉與建議值 核取方塊,然後選取 列舉。 您可以在此輸入每個可接受的熟客層級類別的 值 (在駝峰式大小寫中)和 顯示名稱 (標題大寫中為選擇性、方便讀者的名稱)。
完成所有欄位屬性後,選取 套用 將tierClass
欄位新增至loyaltyTier
物件。
將多欄位物件轉換為資料型別 datatype
loyaltyTier
物件現在包含數個欄位,並代表在其他結構描述中可能有用的通用資料結構。 Schema Editor可讓您透過將這些物件的結構轉換為資料型別,輕鬆套用可重複使用的多欄位物件。
資料型別允許一致地使用多欄位結構,並且比欄位群組提供更大的彈性,因為它們可以在結構描述內的任何位置使用。 若要這麼做,請將欄位的 Type 值設定為Schema Registry中定義之任何資料型別的值。
若要將loyaltyTier
物件轉換成資料型別,請在畫布中選取loyaltyTier
欄位,然後在 欄位屬性 下選取編輯器右側的 轉換成新資料型別。
系統會顯示通知,確認物件已成功轉換。 在畫布中,您現在可以看到loyaltyTier
欄位現在有連結圖示,而右邊欄表示它有"Loyalty Tier"資料型別。
在未來的結構描述中,您現在可以將欄位指派為「Loyalty Tier」型別,而且它會自動包含ID、階層類別、點臨界值和有效日期的欄位。
搜尋和篩選結構描述欄位
除了其基底類別提供的欄位外,您的結構描述現在包含多個欄位群組。 使用較大的結構描述時,您可以選取左側邊欄中欄位群組名稱旁邊的核取方塊,將顯示的欄位篩選為您感興趣的欄位群組所提供的欄位。
如果您在結構描述中尋找特定欄位,也可以使用搜尋列依名稱篩選顯示的欄位,無論這些欄位是在哪個欄位群組下提供。
將結構描述欄位設定為身分欄位 identity-field
結構提供的標準資料結構可用於識別跨多個來源屬於同一個人的資料,以允許各種下游使用案例,例如細分、報表、資料科學分析等。 為了根據個別身分來拼接資料,索引鍵欄位必須在適用的結構描述中標示為身分欄位。
在Schema Editor中使用 身分 核取方塊,Experience Platform可讓您輕鬆表示身分欄位。 不過,您必須根據資料的性質,判斷哪個欄位最適合作為身分使用。
例如,可能有數千名忠誠計畫成員屬於相同的忠誠度等級,而數個成員可能共用相同的實體地址。 不過,在此案例中,註冊時,熟客方案的每位成員都會提供其個人電子郵件地址。 由於個人電子郵件地址通常由一人管理,因此欄位personalEmail.address
(由個人連絡人詳細資料欄位群組提供)是身分欄位的良好候選人。
identityMap
欄位來包含身分識別資訊。選取畫布中的personalEmail.address
欄位,且 欄位屬性 下會出現 身分 核取方塊。 核取方塊和選項,將此設定為 主要身分 出現。 也請選取此方塊。
接下來,您必須從下拉式清單中的預先定義名稱空間清單中提供 身分識別名稱空間。 由於此欄位是客戶的電子郵件地址,請從下拉式清單中選取「電子郵件」。 選取 套用 以確認personalEmail.address
欄位的更新。
套用變更後,personalEmail.address
的圖示會顯示指紋符號,表示它現在是身分欄位。 此欄位也會列在左側邊欄的 身分 下。
現在,所有擷取至personalEmail.address
欄位的資料將用於協助識別該個人,並將該客戶的單一檢視拼接在一起。 若要進一步瞭解如何在Experience Platform中使用身分,請檢閱Identity Service檔案。
啟用結構描述以用於Real-Time Customer Profile profile
Real-Time Customer Profile利用Experience Platform中的身分資料提供每個個別客戶的整體檢視。 此服務會針對客戶在與Experience Platform整合的任何系統中進行的每次互動,建立健全且全方位客戶屬性設定檔以及時間戳記帳戶。
若要啟用結構描述以搭配Real-Time Customer Profile使用,它必須定義主要身分。 如果您嘗試在未先定義主要身分的情況下啟用結構描述,將會收到錯誤訊息。
若要啟用「熟客會員」結構描述以用於Profile,請先在畫布中選取結構描述標題。
在編輯器的右側,會顯示有關結構的資訊,包括其顯示名稱、說明和型別。 除了此資訊之外,還有 設定檔 切換按鈕。
選取 設定檔,畫面會顯示彈出視窗,要求您確認要啟用Profile的結構描述。
選取 啟用 以確認您的選擇。 您可以再次選取 設定檔 切換來停用結構描述(如果您願意),但一旦結構描述在啟用Profile時儲存,就無法再停用它。
更多動作 more
在架構編輯器中,您還可以執行快速動作以複製架構的JSON結構或刪除架構。 選取檢視頂端的更多,以顯示包含快速動作的下拉式清單。
刪除結構描述 delete-a-schema
可以使用更多動作從結構描述編輯器的UI中刪除結構描述,也可以從瀏覽索引標籤的結構描述詳細資料中刪除結構描述。 在某些情況下,無法刪除結構描述。 如果符合下列條件,則無法刪除結構描述:
- 此結構描述已針對設定檔啟用。
- 此結構描述已啟用設定檔功能,且具有關聯的資料集。
- 此結構描述有關聯的資料集,但未針對設定檔啟用。
複製 JSON 結構 copy-json-structure
選取 複製JSON結構 以針對結構描述資料庫中的任何結構描述產生匯出裝載。 此動作會將JSON結構複製到剪貼簿。 接著,您就可以使用匯出的JSON將結構描述及任何相關資源匯入不同的沙箱或組織。 如此可在不同環境之間的模式輕鬆且有效率地共用和重複使用結構描述。
後續步驟和其他資源
現在您已經完成撰寫結構描述,您可以在畫布中看到完整的結構描述。 選取「儲存」 並將結構描述儲存至Schema Library,以供Schema Registry存取。
您的新結構描述現在可用於將資料內嵌至Platform。 請記住,一旦使用結構描述來擷取資料後,只能進行加總變更。 如需結構描述版本設定的詳細資訊,請參閱結構描述組合的基本知識。
您現在可以依照在上定義結構描述關聯性的教學課程,在UI中新增關聯性欄位至「忠誠會員」結構描述。
您也可以使用Schema Registry API來檢視及管理「忠誠會員」結構描述。 若要開始使用API,請先閱讀Schema Registry API 開發人員指南。
視訊資源
以下影片說明如何在Platform UI中建立簡單結構描述。
以下影片旨在讓您更瞭解如何使用欄位群組和類別。
附錄
下列章節提供使用Schema Editor的額外資訊。
建立新類別 create-new-class
Experience Platform可讓您根據組織獨有的類別來定義結構描述。 若要瞭解如何建立新類別,請參閱在UI中建立和編輯類別的指南。
變更結構描述的類別 change-class
您可以在儲存結構描述之前,在初始構成程式期間隨時變更結構描述的類別。
若要瞭解如何變更結構描述的類別,請參閱在UI中管理結構描述的指南。