建立類型

本指南說明如何在 Manufacturing Data Engine (MDE) 中建立新類型。您可以使用設定 API 或 MDE 網頁介面建立型別。

事前準備

除了其他設定外,您還可透過「類型」定義該類型記錄的脈絡化範圍,也就是可用於或必須用於脈絡化記錄的中繼資料值區。如要將中繼資料 bucket 與類型建立關聯,請先建立 bucket。詳情請參閱如何建立中繼資料 bucket

類型命名

建立型別時,名稱在 MDE 部署作業中不得重複。型別名稱不得包含空格或特殊字元,例如 &@%

建立類型

如要建立具有一個中繼資料 bucket 關聯和一般儲存空間規格的型別,可以使用終端機或控制台介面。

REST

執行下列 REST API 要求:

POST /configuration/v1/types

{
  "archetype": "ARCHETYPE NAME",
  "name": "TYPE_NAME",
  "metadataBuckets": [
    {
      "bucketName": "BUCKET_NAME",
      "version": "BUCKET_VERSION"
    }
  ],
  "storageSpecs": [
    {
      "sink": "BIG_QUERY",
      "disabled": "false",
      "materializeCloudMetadata": "true"
    },
    {
      "sink": "BIG_TABLE",
      "disabled": "false",
      "materializeCloudMetadata": "false"
    },
    {
      "sink": "GCS",
      "disabled": "false",
      "materializeCloudMetadata": "false"
    },
    {
      "sink": "PUBSUB_PROTO",
      "disabled": "false",
      "materializeCloudMetadata": "false"
    },
    {
      "sink": "PUBSUB_JSON",
      "disabled": "false",
      "materializeCloudMetadata": "false"
    }
  ]
}

更改下列內容:

  • ARCHETYPE:原型名稱。可能的值為 DISCRETE_DATA_SERIESCLUSTERED_DISCRETE_DATA_SERIESNUMERIC_DATA_SERIESCLUSTERED_NUMERIC_DATA_SERIESCONTINUOUS_DATA_SERIESCLUSTERED_CONTINUOUS_DATA_SERIES
  • TYPE_NAME:要建立的型別名稱。
  • BUCKET_NAME:要與這個類型建立關聯的 bucket 名稱。
  • BUCKET_VERSION:要與這個型別建立關聯的 bucket 版本。

控制台

  1. 如要使用控制台建立新的「類型」,請開啟「類型」部分的分頁。

    「型別」部分 - 型別清單

  2. 本節列出 MDE 執行個體中的所有可用類型。清單會顯示每種型別的基本設定,包括:

  • 名稱:類型的專屬名稱。所有型別的名稱都不得重複。
  • 儲存空間:顯示與類型相關聯的目前儲存空間規格。
  • 原型:顯示定義類型的原型名稱。 每種型別都與獨一無二的原型相關聯。類型建立後,即無法修改原型關聯。
  • 版本:類型的版本號碼。型別可以進行版本控管。這份清單的預設檢視畫面只會顯示該類型可用的最新版本。如要顯示舊版,請取消勾選「顯示最新版本」核取方塊。
  • 中繼資料:為與類型相關聯的每個中繼資料值區,顯示以顏色編碼的徽章。標記中繼資料值區與記錄中繼資料值區的差異在於徽章內有特定圖示。
    • 轉換:顯示與類型相關聯的每個轉換類型徽章。
  • 已啟用:如果類型已啟用,則顯示 true 值;如果未啟用,則顯示 false 值。您可以隨時啟用或停用類型。
  • 有效:建立類型後,需要一段時間才能完成佈建。類型佈建期間的有效狀態為 false。準備就緒時,會顯示為 true

每種新類型都會在建立時,提供自己的基礎架構,用於儲存所有資料接收器的標記和記錄。舉例來說,如果建立新類型,系統會在 BigQuery 中建立新資料表,並自動填入對應於其原型結構定義的結構定義。在佈建類型時,類型會顯示為 Non Active

  1. 如要建立新的「類型」,請按一下「新增類型」。系統會顯示下列表單:

    「型別」部分 - 型別清單

  2. 如要定義新的「類型」,請提供名稱和原型。類型一經建立,即無法變更名稱和原型。所有型別的名稱都不得重複。原型必須從可用原型清單中選取。您無法建立或修改現有原型,因為原型是系統設定的一部分。

  3. 開啟「資料結構定義」部分,視需要定義 JSON schema,定義新類型的資料欄位:

    「型別」部分 - 型別清單

  4. 資料結構定義必須是有效的 JSON Schema,否則系統不會接受。這項資料結構定義不會在擷取管道中強制執行。在日後的 MDE 版本中,系統會根據資料類型的資料結構定義,驗證傳入訊息中的資料物件。資料結構定義可讓您瞭解不同資料接收器中可用資料欄位的結構。此外,每個資料結構定義也必須根據原型特徵定義。

  5. 定義與類型相關聯的中繼資料 bucket,開啟「中繼資料 bucket」部分,完成新類型的定義:

    「型別」部分 - 型別清單

  6. 如要將中繼資料 bucket 新增至類型,請按一下「新增」

  7. 從可用的中繼資料值區清單中,選擇要新增的值區。系統只會顯示這些值區的最新版本。中繼資料值區 之後可以更新版本,方法是建立新的型別版本。加入 bucket 後,中繼資料部分會顯示新徽章。

    「型別」部分 - 型別清單

  8. 開啟表單的「儲存空間設定」部分,定義預設儲存空間設定。這個部分內有切換按鈕,可為這個 MDE 執行個體中提供的每個資料接收器啟用/停用資料傳輸。

    「型別」部分 - 型別清單

  9. 選取要預設儲存這類代碼的每個接收器。標記建立時會繼承儲存空間規格。您隨時可以在代碼層級修改儲存空間規格。

  10. 如要完成新類型的定義,請開啟「轉換和連結」部分,選取與這個類型相關聯的轉換。

    「型別」部分 - 型別清單

  11. 選取要與類型建立關聯的轉換,並根據如何設定轉換定義其參數。

  12. 新增所有參數後,按一下「CREATE」(建立),儲存新的「Type」(類型)。如果任何參數有誤,系統會顯示錯誤訊息。如果作業成功,畫面上會顯示確認訊息。