Zuora

Konektor Zuora memungkinkan Anda terhubung ke instance Zuora dan mengakses data Zuora sebagai database tradisional.

Versi yang didukung

Konektor ini memanfaatkan Zuora API versi v1 untuk mengaktifkan akses dua arah ke Zuora.

Sebelum memulai

Sebelum menggunakan konektor Zuora, lakukan tugas berikut:

  • Di project Google Cloud Anda:
    • Pastikan konektivitas jaringan telah disiapkan. Untuk mengetahui informasi tentang pola jaringan, lihat Konektivitas jaringan.
    • Berikan peran IAM roles/connectors.admin kepada pengguna yang mengonfigurasi konektor.
    • Berikan peran IAM berikut ke akun layanan yang ingin Anda gunakan untuk konektor:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Akun layanan adalah jenis Akun Google khusus yang dimaksudkan untuk mewakili pengguna non-manusia yang perlu diautentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika Anda tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk mengetahui informasi selengkapnya, lihat Membuat akun layanan.

    • Aktifkan layanan berikut:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      Untuk memahami cara mengaktifkan layanan, lihat Mengaktifkan layanan.

    Jika layanan atau izin ini belum diaktifkan untuk project Anda sebelumnya, Anda akan diminta untuk mengaktifkannya saat mengonfigurasi konektor.

Mengonfigurasi konektor

Koneksi khusus untuk sumber data. Artinya, jika Anda memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan hal berikut:

  1. Di Konsol Cloud, buka halaman Integration Connectors > Connections lalu pilih atau buat project Google Cloud.

    Buka halaman Koneksi

  2. Klik + Buat baru untuk membuka halaman Buat Koneksi.
  3. Di bagian Location, pilih lokasi untuk koneksi.
    1. Wilayah: Pilih lokasi dari menu drop-down.

      Region yang didukung untuk konektor meliputi:

      Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

    2. Klik Berikutnya.
  4. Di bagian Detail Koneksi, selesaikan langkah-langkah berikut:
    1. Konektor: Pilih Zuora dari daftar drop-down Konektor yang tersedia.
    2. Versi konektor: Pilih versi Konektor dari daftar drop-down versi yang tersedia.
    3. Di kolom Connection Name, masukkan nama untuk instance Koneksi.

      Nama koneksi harus memenuhi kriteria berikut:

      • Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
      • Huruf harus berupa huruf kecil.
      • Nama koneksi harus diawali dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh melebihi 49 karakter.
    4. Secara opsional, masukkan Deskripsi untuk instance koneksi.
    5. Secara opsional, aktifkan Cloud Logging, lalu pilih level log. Secara default, level log ditetapkan ke Error.
    6. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
    7. Jika perlu, konfigurasikan Setelan node koneksi:

      • Jumlah minimum node: Masukkan jumlah minimum node koneksi.
      • Jumlah node maksimum: Masukkan jumlah maksimum node koneksi.

      Node adalah unit (atau replika) koneksi yang memproses transaksi. Jumlah node yang diperlukan untuk memproses lebih banyak transaksi untuk suatu koneksi akan bertambah dan sebaliknya, jumlah node yang diperlukan untuk memproses lebih sedikit transaksi akan berkurang. Untuk memahami pengaruh node terhadap harga konektor, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default node minimum ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.

    8. Tenant: Tetapkan ini ke tenant Zuora Anda. Secara default, kami menggunakan tenant "USProduction".
    9. URL: Ini hanya diperlukan jika Anda memiliki lingkungan Salinan Produksi AS. Jika properti ini diberikan, nilai properti Tenant tidak akan berpengaruh dalam proses autentikasi.
    10. ZuoraService: Menentukan layanan atau skema eksekusi yang akan digunakan
    11. Gunakan Penomoran Halaman Sisi Klien: Apakah CData ADO.NET Provider for SAP Cloud for Customer harus menggunakan penomoran halaman sisi klien atau tidak.
    12. Gunakan Layanan Kustom: Menunjukkan apakah layanan OData SAP Cloud for Customer kustom harus digunakan.
    13. Tampilan yang Ditentukan Pengguna: Jalur file yang mengarah ke file konfigurasi JSON yang berisi tampilan kustom Anda.
    14. Atau, klik + Tambahkan label untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
    15. Klik Berikutnya.
  5. Di bagian Authentication, masukkan detail autentikasi.
    1. Pilih Jenis autentikasi dan masukkan detail yang relevan.

      Jenis autentikasi berikut didukung oleh koneksi Zuora:

      • Kredensial Klien OAuth 2.0

      2. Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.

    2. Klik Berikutnya.
  6. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
  7. Klik Buat.

Mengonfigurasi autentikasi

Untuk mengaktifkan autentikasi Kredensial Klien OAuth 2.0, ikuti langkah-langkah berikut:

  1. Buat kredensial klien di Zuora dan dapatkan client ID serta rahasia klien.
  2. Tentukan kredensial di Google Cloud.

Buat kredensial klien di Zuora

  1. Di portal OneID, klik avatar Anda, lalu klik Setelan.
  2. Klik Manage OAuth 2.0 Clients.
  3. Di halaman Manage OAuth 2.0 Clients, klik New.
  4. Di jendela New OAuth 2.0 Client, tentukan kolom berikut:
    • Nama: Masukkan nama untuk klien.
    • Jenis: Pilih Client Credentials dari daftar.
  5. Klik Simpan. Setelah klien berhasil dibuat, jendela yang berisi client ID dan rahasia klien akan muncul.

    Simpan ID klien dan rahasia klien untuk digunakan nanti. Untuk mengetahui informasi selengkapnya, lihat Mengelola klien OAuth 2.0 .

Tentukan kredensial di Google Cloud

Saat membuat koneksi di Integration Connectors , Anda harus menentukan detail berikut:

Di bagian Authentication, masukkan detail berikut:

  • Client ID: Client ID untuk aplikasi yang Anda buat.
  • Rahasia Klien: Secret Manager Secret yang berisi rahasia klien untuk aplikasi terhubung yang Anda buat.

Jenis koneksi web

Tabel berikut mencantumkan nilai konfigurasi contoh untuk jenis koneksi web Zuora:

Nama kolom Detail
Lokasi us-central1
Konektor Zuora
Versi konektor 1
Nama Koneksi zuora-con
Akun Layanan account@my-project.iam.gserviceaccount.com
Tenant PENYEWA
Jumlah minimum node 2
Jumlah maksimum node 4
ID Klien CLIENT_ID
Rahasia Klien CLIENT_SECRET
Versi Secret 1

Entitas, operasi, dan tindakan

Semua Konektor Integrasi menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ini ditampilkan kepada Anda sebagai entitas, operasi, dan tindakan.

  • Entitas: Entitas dapat dianggap sebagai objek, atau kumpulan properti, dalam aplikasi atau layanan yang terhubung. Definisi entitas berbeda dari konektor ke konektor. Misalnya, di konektor database, tabel adalah entitas, di konektor server file, folder adalah entitas, dan di konektor sistem pesan, antrean adalah entitas.

    Namun, ada kemungkinan konektor tidak mendukung atau tidak memiliki entity apa pun, sehingga daftar Entities akan kosong.

  • Operasi: Operasi adalah aktivitas yang dapat Anda lakukan pada entity. Anda dapat melakukan salah satu operasi berikut pada entitas:

    Memilih entitas dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entitas tersebut. Untuk deskripsi mendetail tentang operasi, lihat operasi entitas tugas Konektor. Namun, jika konektor tidak mendukung operasi entitas apa pun, operasi yang tidak didukung tersebut tidak tercantum dalam daftar Operations.

  • Tindakan: Tindakan adalah fungsi kelas pertama yang tersedia untuk integrasi melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entitas, dan berbeda-beda dari konektor ke konektor. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter output. Namun, ada kemungkinan konektor tidak mendukung tindakan apa pun, sehingga daftar Actions akan kosong.

Contoh operasi entity

Bagian ini menunjukkan cara melakukan beberapa operasi entitas di konektor ini.

Contoh - Mencantumkan semua catatan di Pengembalian Dana

Contoh ini mencantumkan semua data dalam entitas Refunds.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Refunds dari daftar Entity.
  3. Pilih operasi List, lalu klik Selesai.
  4. Secara opsional, di bagian Input Tugas pada tugas Konektor, Anda dapat memfilter kumpulan hasil dengan menentukan klausa filter.

Contoh - Mendapatkan catatan nota debit

Contoh ini mengambil data yang ID-nya adalah 45 dari entity Debit_Memo.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Debit_Memo dari daftar Entity.
  3. Pilih operasi Get, lalu klik Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik EntityId, lalu masukkan 45 di kolom Default Value.

    Di sini, 45 adalah nilai kunci utama dalam entity Debit_Memo.

Contoh - Membuat tiket

Contoh ini membuat tiket di entitas Ticket.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Tickets dari daftar Entity.
  3. Pilih operasi Create, lalu klik Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"Name": "Test735362767",
"Label": "Test735362767",
"Type": "String",
"FieldType": "Insert ticket1",
"GroupName": "ticketinformation",
"Description": "Test ticket"
}

    Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

    {
"Name": "Test1695971640609"
}

Contoh - Memperbarui entri promo

Contoh ini memperbarui data yang ID-nya 97 dalam entity Deals.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Deals dari daftar Entity.
  3. Pilih operasi Update, lalu klik Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"Description": "New description"
}
  5. Klik entityId, lalu masukkan 97 di kolom Default Value.

    Atau, alih-alih menentukan entityId, Anda juga dapat menyetel filterClause ke 97.

Contoh - Menghapus formulir

Contoh ini menghapus data yang ID-nya 78 di entitas Forms.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Forms dari daftar Entity.
  3. Pilih operasi Delete, lalu klik Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 78 di kolom Default Value.

Membuat koneksi menggunakan Terraform

Anda dapat menggunakan resource Terraform untuk membuat koneksi baru.

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform.

Untuk melihat contoh template terraform untuk pembuatan koneksi, lihat contoh template.

Saat membuat koneksi ini menggunakan Terraform, Anda harus menetapkan variabel berikut dalam file konfigurasi Terraform:

Nama parameter Jenis data Wajib Deskripsi
tenant ENUM Salah Setel ini ke tenant Zuora Anda. Secara default, kami menggunakan tenant "USProduction". Nilai yang didukung adalah: USProduction, USAPISandbox, USPerformanceTest, EUProduction, EUSandbox, EUCentralSandbox, USCloudProduction, USCloudAPISandbox, USCentralSandbox
url STRING Salah Atribut ini hanya diperlukan jika Anda memiliki lingkungan Salinan Produksi AS. Jika properti ini diberikan, nilai properti Tenant tidak akan berpengaruh dalam proses autentikasi.
zuora_service ENUM Salah Menentukan layanan atau skema eksekusi yang akan digunakan. Nilai yang didukung adalah: DataQuery, AQuADataExport
use_client_side_paging BOOLEAN Salah Apakah CData ADO.NET Provider for SAP Cloud for Customer harus menggunakan penomoran halaman sisi klien atau tidak.
use_custom_service BOOLEAN Salah Menunjukkan apakah layanan OData SAP Cloud for Customer kustom harus digunakan.
user_defined_views STRING Salah Jalur file yang mengarah ke file konfigurasi JSON yang berisi tampilan kustom Anda.

Menggunakan koneksi Zuora dalam integrasi

Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Apigee Integration dan Application Integration. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.

  • Untuk memahami cara membuat dan menggunakan tugas Konektor di Apigee Integration, lihat Tugas konektor.
  • Untuk memahami cara membuat dan menggunakan tugas Konektor di Integrasi Aplikasi, lihat Tugas konektor.

Mendapatkan bantuan dari komunitas Google Cloud

Anda dapat memposting pertanyaan dan mendiskusikan konektor ini di komunitas Google Cloud di Forum Cloud.

Langkah berikutnya