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:
    • 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 melakukan autentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika 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

Mengonfigurasi konektor mengharuskan Anda membuat koneksi ke sumber data (sistem backend). Koneksi bersifat khusus untuk sumber data. Artinya, jika memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan langkah-langkah berikut:

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

    Buka halaman Connections

  2. Klik + Create new untuk membuka halaman Create Connection.
  3. Di bagian Lokasi, pilih lokasi untuk koneksi.
    1. Region: Pilih lokasi dari menu drop-down.

      Region yang didukung untuk konektor mencakup:

      Untuk mengetahui daftar semua wilayah yang didukung, lihat Lokasi.

    2. Klik Next.
  4. Di bagian Connection Details, selesaikan tindakan berikut:
    1. Konektor: Pilih Zuora dari menu drop-down Konektor yang tersedia.
    2. Versi konektor: Pilih versi Konektor dari menu drop-down versi yang tersedia.
    3. Di kolom Connection Name, masukkan nama untuk instance Connection.

      Nama koneksi harus memenuhi kriteria berikut:

      • Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
      • Huruf harus kecil.
      • Nama koneksi harus dimulai dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh lebih dari 63 karakter.
    4. Secara opsional, masukkan Deskripsi untuk instance koneksi.
    5. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
    6. Secara opsional, konfigurasikan Setelan node koneksi:

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

      {i>Node<i} adalah unit (atau replika) koneksi yang memproses transaksi. Lebih banyak node diperlukan untuk memproses lebih banyak transaksi untuk sebuah koneksi dan sebaliknya, lebih sedikit node diperlukan untuk memproses transaksi yang lebih sedikit. Untuk memahami pengaruh node terhadap harga konektor Anda, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default node minimum akan ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.

    7. Tenant: Tetapkan ini ke tenant Zuora Anda. Secara default, kami menggunakan tenant "USProduction".
    8. URL: Ini hanya diperlukan jika Anda memiliki lingkungan Teks Produksi Amerika Serikat. Jika properti ini diberikan, nilai properti Tenant tidak akan berpengaruh dalam proses autentikasi.
    9. ZuoraService: Menentukan layanan atau skema eksekusi yang akan digunakan
    10. Gunakan Paging Sisi Klien: Apakah Penyedia ADO.NET CData untuk SAP Cloud bagi Pelanggan harus menggunakan paging sisi klien atau tidak.
    11. Gunakan Layanan Khusus: Menunjukkan apakah layanan SAP Cloud khusus untuk OData Pelanggan harus digunakan.
    12. Tampilan Buatan Pengguna: Jalur file yang mengarah ke file konfigurasi JSON yang berisi tampilan kustom Anda.
    13. Secara opsional, klik + Add label untuk menambahkan label ke Connection dalam bentuk key-value pair.
    14. Klik Next.
  5. Di bagian Authentication, masukkan detail autentikasi.
    1. Pilih Jenis autentikasi, lalu 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 Next.
  6. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
  7. Klik Create.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

  • Kredensial Klien OAuth 2.0
    • Client-ID: Client ID yang diberikan oleh konektor untuk aplikasi yang Anda buat.
    • Rahasia Klien: Secret Manager yang berisi rahasia klien untuk aplikasi terhubung yang Anda buat.

Entitas, operasi, dan tindakan

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

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

    Namun, mungkin saja konektor tidak mendukung atau memiliki entitas, dalam hal ini daftar Entities akan kosong.

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

    Memilih entity dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entity tersebut. Untuk deskripsi operasi secara mendetail, lihat operasi entity tugas Konektor. Namun, jika konektor tidak mendukung salah satu operasi entity, operasi yang tidak didukung tersebut tidak akan dicantumkan 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 bervariasi dari satu konektor ke konektor lainnya. Namun, mungkin saja konektor tidak mendukung tindakan apa pun, dalam hal ini daftar Actions akan kosong.

Contoh operasi entitas

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

Contoh - Cantumkan semua data di Pengembalian Dana

Contoh ini mencantumkan semua data dalam entity Refunds.

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

Contoh - Dapatkan catatan nota debit

Contoh ini mendapatkan data yang ID-nya 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 Done.
  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 dalam entity Ticket.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Tickets dari daftar Entity.
  3. Pilih operasi Create, lalu klik Done.
  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 transaksi

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

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Deals dari daftar Entity.
  3. Pilih operasi Update, lalu klik Done.
  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 Nilai Default.

    Atau, daripada menentukan entityId, Anda juga dapat menetapkan filterClause ke 97.

Contoh - Menghapus formulir

Contoh ini menghapus data yang ID-nya 78 dalam entity Forms.

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

Gunakan terraform untuk membuat koneksi

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 Diperlukan Deskripsi
tenant ENUM Salah Tetapkan 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 Tindakan ini hanya diperlukan jika Anda memiliki lingkungan Teks Produksi Amerika Serikat. Jika properti ini diberikan, nilai properti Tenant tidak akan berpengaruh dalam proses autentikasi.
zuora_service ENUM Salah Menentukan layanan atau skema eksekusi yang akan menggunakan Nilai yang didukung adalah: DataQuery, AQuADataExport
use_client_side_paging BOOLEAN Salah Apakah Penyedia ADO.NET CData untuk SAP Cloud bagi Pelanggan harus menggunakan paging sisi klien atau tidak.
use_custom_service BOOLEAN Salah Menunjukkan apakah layanan OData SAP Cloud khusus untuk Pelanggan 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 Integrasi Apigee, lihat Tugas konektor.
  • Untuk memahami cara membuat dan menggunakan tugas Konektor dalam Application Integration, lihat tugas konektor.

Dapatkan bantuan dari komunitas Google Cloud

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

Langkah selanjutnya