Zuora

Zuora 連接器可讓您連線至 Zuora 執行個體，並以傳統資料庫的形式存取 Zuora 資料。

支援的版本

這個連接器採用 Zuora API v1 版，可雙向存取 Zuora。

事前準備

使用 Zuora 連接器前，請先完成下列工作：

  • 在 Google Cloud 專案中：
    • 確認已設定網路連線。如要瞭解網路模式，請參閱「網路連線」。
    • 將 roles/connectors.admin IAM 角色授予設定連線器的使用者。
    • 將下列 IAM 角色授予要用於連接器的服務帳戶：
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      服務帳戶是特殊的 Google 帳戶類型，主要用於代表需要驗證且必須取得授權才能存取 Google API 資料的非人類使用者。如果您沒有服務帳戶，請建立服務帳戶。詳情請參閱「建立服務帳戶」。

    • 啟用下列服務：
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      如要瞭解如何啟用服務，請參閱「啟用服務」。

    如果專案先前未啟用這些服務或權限，系統會在設定連結器時提示您啟用。

設定連接器

連線專屬於資料來源。也就是說，如果您有多個資料來源，則必須為每個資料來源建立個別的連線。如要建立連線，請按照下列步驟操作：

  1. 在 Cloud 控制台中，前往「Integration Connectors」>「Connections」頁面，然後選取或建立 Google Cloud 專案。

    前往「連線」頁面

  2. 按一下「+ 建立新項目」開啟「建立連線」頁面。
  3. 在「位置」部分中，選擇連線位置。
    1. 區域：從下拉式清單中選取位置。

      連接器支援的地區包括：

      如需所有支援的地區清單，請參閱「位置」一文。

    2. 點選「下一步」。
  4. 在「連線詳細資料」部分，完成下列步驟：
    1. 連接器：從可用連接器的下拉式清單中選取「Zuora」。
    2. 連接器版本：從可用版本的下拉式清單中選取連接器版本。
    3. 在「連線名稱」欄位中，輸入連線執行個體的名稱。

      連線名稱必須符合下列條件：

      • 連線名稱可使用英文字母、數字或連字號。
      • 字母必須為小寫。
      • 連線名稱開頭須為英文字母，結尾則須為英文字母或數字。
      • 連結名稱不得超過 49 個字元。
    4. 視需要輸入連線執行個體的「Description」(說明)。
    5. 或者，可啟用 Cloud Logging，然後選取記錄層級。記錄層級預設為 Error。
    6. 服務帳戶：選取具備必要角色的服務帳戶。
    7. 視需要設定「連線節點設定」：

      • 節點數量下限：輸入連線節點數量下限。
      • 節點數量上限：輸入連線節點數量上限。

      節點是用來處理交易的連線單位 (或備用資源)。連線處理的交易量越多，就需要越多節點；反之，處理的交易量越少，需要的節點就越少。如要瞭解節點對連接器定價的影響，請參閱「 連線節點定價」。如未輸入任何值，系統預設會將節點下限設為 2 (提高可用性)，節點上限則設為 50。

    8. 租戶：設為 Zuora 租戶。根據預設，我們會使用「USProduction」租戶。
    9. 網址：只有在您有美國正式副本環境時才需要填寫。如果提供這項屬性，驗證程序中的「租戶」屬性值就不會生效。
    10. ZuoraService：指定要使用的執行服務或結構定義
    11. 使用用戶端分頁：CData ADO.NET Provider for SAP Cloud for Customer 是否應使用用戶端分頁。
    12. 使用自訂服務：指出是否應使用自訂 SAP Cloud for Customer OData 服務。
    13. 使用者定義的檢視畫面：指向 JSON 設定檔的路徑，其中包含自訂檢視畫面。
    14. (選用) 按一下「+ 新增標籤」，以鍵/值組合的形式為連線新增標籤。
    15. 點選「下一步」。
  5. 在「Authentication」(驗證) 部分中，輸入驗證詳細資料。
    1. 選取「驗證類型」並輸入相關詳細資料。

      Zuora 連線支援下列驗證類型：

      • OAuth 2.0 用戶端憑證

      2. 如要瞭解如何設定這些驗證類型，請參閱「設定驗證」。

    2. 點選「下一步」。
  6. 檢查：檢查連線和驗證詳細資料。
  7. 點選「建立」。

設定驗證機制

如要啟用 OAuth 2.0 用戶端憑證驗證，請按照下列步驟操作：

  1. 在 Zuora 中建立用戶端憑證，並取得用戶端 ID 和用戶端密鑰。
  2. 在 Google Cloud中指定憑證。

在 Zuora 中建立用戶端憑證

  1. 在 OneID 入口網站中，按一下你的顯示圖片，然後按一下「設定」。
  2. 按一下「管理 OAuth 2.0 用戶端」。
  3. 在「管理 OAuth 2.0 用戶端」頁面中，按一下「新增」。
  4. 在「New OAuth 2.0 Client」(新增 OAuth 2.0 用戶端) 視窗中，指定下列欄位：
    • 名稱：輸入用戶端名稱。
    • 類型：從清單中選取「用戶端憑證」。
  5. 按一下 [儲存]。成功建立用戶端後，系統會顯示含有用戶端 ID 和用戶端密鑰的視窗。

    儲存用戶端 ID 和用戶端密鑰，以供日後使用。詳情請參閱「管理 OAuth 2.0 用戶端 」。

在 Google Cloud中指定憑證

在 Integration Connectors 中建立連線時，您必須指定下列詳細資料：

在「Authentication」(驗證) 部分，輸入下列詳細資料：

  • 用戶端 ID：您建立的應用程式用戶端 ID。
  • 用戶端密鑰：Secret Manager 密鑰，內含您建立的已連結應用程式用戶端密鑰。

網路連線類型

下表列出 Zuora 網路連線類型的範例設定值：

欄位名稱 詳細資料
位置 us-central1
連接器 Zuora
連接器版本 1
連線名稱 zuora-con
服務帳戶 account@my-project.iam.gserviceaccount.com
租戶 TENANT
節點數量下限 2
節點數量上限 4
用戶端 ID CLIENT_ID
用戶端密鑰 CLIENT_SECRET
密鑰版本 1

實體、作業和動作

所有整合連接器都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化程序存取應用程式的物件。抽象化會以實體、作業和動作的形式呈現。

  • 實體： 實體可以視為已連結應用程式或服務中的物件，或是屬性集合。實體的定義因連接器而異。舉例來說，在資料庫連接器中，資料表是實體；在檔案伺服器連接器中，資料夾是實體；在訊息系統連接器中，佇列是實體。

    不過，連接器可能不支援或沒有任何實體，在這種情況下，Entities 清單會是空白。

  • 作業： 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作：

    從可用清單中選取實體，系統會產生該實體可用的作業清單。如需作業的詳細說明，請參閱 Connectors 工作的實體作業。 不過，如果連接器不支援任何實體作業，系統就不會在 Operations 清單中列出這些不支援的作業。

  • 動作： 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體，且因連接器而異。一般來說，動作會有一些輸入參數和輸出參數。不過，連接器可能不支援任何動作，此時 Actions 清單會是空白。

實體作業範例

本節說明如何使用這個連接器執行部分實體作業。

範例 - 列出「退款」中的所有記錄

這個範例會列出 Refunds 實體中的所有記錄。

  1. 在「Configure connector task」對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 Refunds。
  3. 選取「List」作業，然後按一下「完成」。
  4. (選用) 在「連結器」工作的「工作輸入」部分，您可以指定篩選子句，篩選結果集。

範例 - 取得應付憑據記錄

這個範例會從 Debit_Memo 實體取得 ID 為 45 的記錄。

  1. 在「Configure connector task」對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 Debit_Memo。
  3. 選取「Get」作業，然後按一下「完成」。
  4. 在「連線器」工作的「工作輸入」部分，按一下「EntityId」，然後在「預設值」欄位中輸入 45。

    其中 45 是 Debit_Memo 實體中的主鍵值。

範例 - 建立支援單

這個範例會在 Ticket 實體中建立票證。

  1. 在「Configure connector task」對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 Tickets。
  3. 選取「Create」作業，然後按一下「完成」。
  4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"Name": "Test735362767",
"Label": "Test735362767",
"Type": "String",
"FieldType": "Insert ticket1",
"GroupName": "ticketinformation",
"Description": "Test ticket"
}

    如果整合成功，連接器工作的 connectorOutputPayload 欄位會包含類似下列內容的值：

    {
"Name": "Test1695971640609"
}

範例 - 更新交易項目

這個範例會更新 Deals 實體中 ID 為 97 的記錄。

  1. 在「Configure connector task」對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 Deals。
  3. 選取「Update」作業，然後按一下「完成」。
  4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"Description": "New description"
}
  5. 按一下「entityId」，然後在「Default Value」欄位中輸入 97。

    或者，您也可以將 filterClause 設為 97，而非指定 entityId。

範例 - 刪除表單

這個範例會刪除 Forms 實體中 ID 為 78 的記錄。

  1. 在「Configure connector task」對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 Forms。
  3. 選取「Delete」作業，然後按一下「完成」。
  4. 在「連線器」工作的「Task Input」(工作輸入內容) 區段中，按一下「entityId」，然後在「Default Value」(預設值) 欄位中輸入 78。

使用 Terraform 建立連線

您可以使用 Terraform 資源建立新連線。

如要瞭解如何套用或移除 Terraform 設定，請參閱「基本 Terraform 指令」。

如要查看用於建立連線的 Terraform 範本範例，請參閱範本範例。

使用 Terraform 建立這項連線時，您必須在 Terraform 設定檔中設定下列變數：

參數名稱 資料類型 必填 說明
用戶群 ENUM 否 請將此值設為 Zuora 租戶。根據預設，我們會使用「USProduction」租戶。支援的值包括：USProduction、USAPISandbox、USPerformanceTest、EUProduction、EUSandbox、EUCentralSandbox、USCloudProduction、USCloudAPISandbox、USCentralSandbox
網址 STRING 否 只有在您有美國正式版副本環境時，才需要這樣做。如果提供這項屬性，驗證程序就不會採用 Tenant 屬性的值。
zuora_service ENUM 否 指定要使用的執行服務或結構定義。支援的值包括：DataQuery、AQuADataExport
use_client_side_paging BOOLEAN 否 CData ADO.NET Provider for SAP Cloud for Customer 是否應使用用戶端分頁。
use_custom_service BOOLEAN 否 指出是否應使用自訂 SAP Cloud for Customer OData 服務。
user_defined_views STRING 否 指向包含自訂檢視區塊的 JSON 設定檔的檔案路徑。

在整合中建立 Zuora 連線

建立連線後，Apigee Integration 和 Application Integration 都會提供該連線。您可以在整合中透過「連接器」工作使用連線。

  • 如要瞭解如何在 Apigee Integration 中建立及使用「連線器」工作，請參閱「連線器工作」。
  • 如要瞭解如何在 Application Integration 中建立及使用「連線器」工作，請參閱「連線器工作」。

向 Google Cloud 社群尋求協助

如要發布問題及討論這個連接器，請前往 Cloud 論壇的 Google Cloud 社群。

後續步驟