Tugas Konektor memungkinkan Anda terhubung dengan cepat dan aman ke berbagai layanan Google Cloud dan aplikasi bisnis lainnya dari integrasi Anda menggunakan konektor siap pakai yang tersedia di Integration Connectors.
Guna mengetahui daftar semua konektor yang didukung untuk Integrasi Apigee, lihat Referensi konektor.Sebelum memulai
- Pastikan Anda telah memiliki peran IAM Admin Connectors (
roles/connectors.admin
) di project Google Cloud. Untuk mengetahui informasi tentang cara memberikan peran, lihat Mengelola akses. - Pelajari konsep umum Integration Connectors.
- Agar terhubung ke layanan Google Cloud dan aplikasi bisnis lainnya menggunakan konektor, pastikan Anda telah melampirkan akun layanan yang dikelola pengguna ke integrasi Anda. Jika integrasi Anda tidak memiliki akun layanan yang dikelola pengguna yang dikonfigurasi, akun layanan default (
service-PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com
) akan digunakan untuk autentikasi secara default. - Pastikan akun layanan Anda memiliki peran IAM yang diperlukan. Untuk mengetahui informasi tentang cara memberikan peran ke akun layanan, lihat Mengelola akses ke akun layanan.
Menambahkan tugas Konektor
Untuk menambahkan tugas Konektor dalam integrasi Anda, lakukan hal berikut:
- Di UI Apigee, pilih Organisasi Apigee Anda.
- Klik Develop > Integrations.
- Pilih integrasi yang ada atau buat integrasi baru dengan mengklik Buat Integrasi.
Jika Anda membuat integrasi baru:
- Masukkan nama dan deskripsi dalam dialog Create Integration.
- Pilih Region untuk integrasi dari daftar wilayah yang didukung.
- Klik Create.
Tindakan ini akan membuka integrasi di desainer integrasi.
- Di menu navigasi desainer integrasi, klik +Tambahkan tugas/pemicu > Tasks untuk melihat daftar tugas yang tersedia.
- Klik dan tempatkan elemen Connectors di editor integrasi.
Mengonfigurasi tugas Konektor
Untuk mengonfigurasi tugas Konektor, lakukan hal berikut:
- Klik elemen tugas Connectors pada desainer untuk melihat panel konfigurasi tugas Connectors.
Atau, klik
untuk mengganti nama nama tugas. - Klik Configure Connector.
- Anda dapat memilih koneksi yang ada di region atau membuat koneksi baru. Untuk mengonfigurasi koneksi yang ada, selesaikan langkah-langkah berikut di halaman Connectors Task Editor:
- Untuk Select Connectors, pilih region koneksi.
- Pilih koneksi yang ada dari daftar koneksi yang tersedia di region yang dipilih.
- Klik Next.
- Dari daftar Jenis, pilih Entitas atau Tindakan.
- Jika Anda memilih Entitas, daftar entitas yang didukung untuk koneksi ditampilkan di bagian Tetapkan entitas/tindakan. Pilih entity, diikuti dengan Operation yang ingin Anda lakukan pada entity tersebut.
- Jika Anda memilih Tindakan, daftar tindakan yang didukung untuk koneksi akan ditampilkan di kolom Tetapkan entitas/tindakan. Pilih tindakan untuk koneksi. Entitas dan tindakan yang didukung didasarkan pada jenis konektor. Guna mengetahui daftar semua konektor yang didukung untuk Integrasi Apigee, lihat Referensi konektor. Untuk melihat tindakan dan entity yang didukung untuk sebuah konektor, lihat dokumentasi konektor tertentu.
Jika konektor mendukung kueri SQL kustom, Anda dapat memilih opsi Execute kustom kueri dari daftar Tindakan. Untuk mendapatkan informasi tentang cara menambahkan kueri SQL kustom untuk konektor Anda, lihat Tindakan: Menjalankan kueri SQL kustom.
- Klik Done untuk menyelesaikan konfigurasi koneksi dan menutup panel.
Gambar berikut menunjukkan contoh tata letak halaman Connectors Task Editor.
Mengonfigurasi variabel input dan output tugas
Panel konfigurasi tugas Connectors menampilkan variabel Task Input dan Task Output yang otomatis dibuat berdasarkan Entity and Operation atau Action yang dipilih dalam dialog Configure Connector task. Variabel ini dapat dikonfigurasi dan dapat diakses sebagai input untuk tugas saat ini atau sebagai output tugas berikutnya, atau kondisional dalam integrasi saat ini.
Untuk mengonfigurasi variabel Task Input atau Task Output, klik variabel terkait untuk membuka panel Konfigurasikan Variabel, lalu lakukan langkah-langkah berikut:
- Masukkan nilai variabel di kolom Nilai Default.
- (Opsional) Pilih Gunakan sebagai input untuk integrasi atau Gunakan sebagai output untuk integrasi.
- Klik Save.
Untuk mengetahui informasi selengkapnya tentang parameter input dan output tugas Konektor, lihat Operasi entity.
Operasi dan tindakan entity
Anda dapat melakukan operasi CRUD (Membuat, Membaca, Memperbarui, Menghapus) pada entitas konektor. Setiap operasi entity ini memiliki kumpulan parameter input dan output yang berbeda. Tabel berikut mencantumkan parameter input dan output dari berbagai operasi entity.
Nama operasi | Parameter input | Parameter output |
---|---|---|
Daftar |
|
|
Dapatkan | entityId | connectorOutputPayload |
Buat | connectorInputPayload | connectorOutputPayload |
Perbarui |
|
connectorOutputPayload |
Hapus |
|
T/A |
Parameter input
Tabel berikut menjelaskan parameter input untuk berbagai operasi entity.
Nama parameter | Jenis data | Deskripsi |
---|---|---|
entityId | String | ID unik baris yang ingin Anda akses. Biasanya, Misalnya, untuk mendapatkan baris tertentu dari tabel MySQL, |
connectorInputPayload | JSON | Data aktual yang akan ditambahkan atau diperbarui dalam suatu entitas. Contoh berikut menunjukkan cuplikan JSON dari data baris yang akan ditambahkan dalam tabel:
{ "employee_first_name": "John", "employee_emailID": "test-05@test.com" } Dalam contoh ini, |
filterClause | String | Membatasi hasil operasi berdasarkan suatu kondisi. Untuk informasi selengkapnya tentang menambahkan klausa filter, lihat Menambahkan filter untuk operasi. |
listEntitiesPageSize | Bilangan bulat |
Menentukan jumlah hasil yang harus ditampilkan di halaman. Halaman adalah pengelompokan data yang logis dalam kumpulan hasil. Konsep halaman berguna jika Anda mengharapkan sejumlah besar data dalam kumpulan hasil. Jika kumpulan hasilnya besar, tugas Konektor mungkin gagal, karena ada batas ukuran data yang dapat diproses oleh tugas Konektor. Dengan memecah hasil menjadi beberapa bagian yang lebih kecil, Anda dapat menghindari masalah ini. Misalnya, jika Anda mengharapkan 1.000 data dalam kumpulan hasil, Anda dapat menetapkan
|
listEntitiesPageToken | String | ID halaman (token) yang memungkinkan Anda mengakses halaman tertentu. Anda bisa mendapatkan nilai token halaman dari parameter output |
listEntitiesSortByColumns | Array string | Nama kolom yang ingin Anda gunakan untuk mengurutkan set hasil.
|
Parameter output
Tabel berikut menjelaskan parameter output untuk berbagai operasi entity.
Nama parameter | Jenis data | Deskripsi |
---|---|---|
connectorOutputPayload | JSON | Output operasi dalam format JSON. |
listEntitiesNextPageToken | String |
ID yang dihasilkan sistem untuk halaman. Anda dapat menganggap token sebagai pointer yang dapat digunakan untuk mengakses halaman tertentu dari kumpulan hasil. Jika telah mengelompokkan hasil
menjadi beberapa halaman dengan menetapkan parameter Misalnya, Anda telah menetapkan parameter Jika kumpulan hasil memiliki banyak halaman, Anda dapat mempertimbangkan untuk menggunakan tugas For Setiap Loop agar dapat berulang kali memanggil tugas Konektor dan menggunakan tugas Pemetaan Data untuk secara otomatis menetapkan nilai token ke parameter input |
Klausa filter untuk operasi entity
Anda dapat membatasi record yang diproses oleh tugas Konektor menggunakan variabel Klausa filter yang tersedia sebagai Input Tugas. Misalnya, dalam kasus operasi delete, Anda dapat menambahkan klausa filter untuk menghapus kumpulan data dengan orderId
tertentu.
Klausa filter hanya dapat diterapkan untuk operasi entity berikut:
- Daftar
- Hapus
- Perbarui
Saat Anda memilih salah satu operasi ini, bagian Input Tugas dari tugas Konektor menampilkan kolom Klausa filter secara otomatis.
Menambahkan klausa filter
Untuk menambahkan klausa filter, lakukan langkah-langkah berikut:
- Klik elemen tugas Connectors pada desainer untuk melihat panel konfigurasi tugas Connectors.
- Luaskan bagian Task Input, lalu klik variabel string filterClause(Connectors).
Dialog Konfigurasi Variabel akan muncul.
- Masukkan klausa filter (dengan mengikuti klausa syntax) di kolom Nilai Default.
- Klik Save.
Sintaksis dan contoh klausa filter
Klausa filter memiliki format berikut:
FIELD_NAME CONDITION FILTER_VALUE
Contoh
OwnerId = '0053t000007941XAAQ'
PoNumber < 2345
OrderNumber = 00110 AND StatusCode = 'Draft'
TotalAmount > 2500
ShippingPostalCode = 94043 OR ShippingPostalCode = 77002
Penggunaan variabel dalam klausa filter
Anda tidak dapat langsung menggunakan variabel integrasi dalam klausa filter. Jika ingin menggunakan variabel integrasi, Anda harus terlebih dahulu mengonfigurasi tugas Pemetaan Data untuk membuat pemetaan antara variabel integrasi dan klausa filter.Tabel berikut menunjukkan contoh pemetaan antara variabel integrasi dan variabel filterClause(Connectors)
:
Input | Output |
---|---|
PRIMARY_KEY_ID = ' .CONCAT(INTEGRATION_VARIABLE) .CONCAT(') |
filterClause(Connectors) |
PRIMARY_KEY_ID = '
dimasukkan sebagai Nilai di baris input.
Tindakan: Menjalankan kueri SQL kustom
Untuk membuat kueri kustom, ikuti langkah-langkah berikut:
- Ikuti petunjuk mendetail untuk menambahkan tugas konektor.
- Saat mengonfigurasi tugas konektor, untuk jenis tindakan yang ingin Anda lakukan, pilih Tindakan.
- Dalam daftar Action, pilih Execute custom query, lalu klik Done.
- Luaskan bagian Input tugas, lalu lakukan tindakan berikut:
- Di kolom Timeout after, masukkan jumlah detik untuk menunggu hingga kueri dijalankan.
Nilai default:
180
detik. - Di kolom Jumlah baris maksimum, masukkan jumlah baris maksimum yang akan ditampilkan dari database.
Nilai default:
25
. - Untuk memperbarui kueri kustom, klik Edit Skrip Kustom. Dialog Editor skrip akan terbuka.
- Dalam dialog Script editor, masukkan kueri SQL, lalu klik Save.
Anda dapat menggunakan tanda tanya (?) dalam pernyataan SQL untuk mewakili satu parameter yang harus ditentukan dalam daftar parameter kueri. Misalnya, kueri SQL berikut memilih semua baris dari tabel
Employees
yang cocok dengan nilai yang ditentukan untuk kolomLastName
:SELECT * FROM Employees where LastName=?
- Jika Anda telah menggunakan tanda tanya dalam kueri SQL, Anda harus menambahkan parameter dengan mengklik + Tambahkan Nama Parameter untuk setiap tanda tanya. Saat menjalankan integrasi, parameter ini menggantikan tanda tanya (?) dalam kueri SQL secara berurutan. Misalnya, jika Anda menambahkan tiga tanda tanya (?), Anda harus menambahkan tiga parameter secara berurutan.
Untuk menambahkan parameter kueri, lakukan hal berikut:
- Dari daftar Jenis, pilih jenis data parameter.
- Di kolom Nilai, masukkan nilai parameter.
- Untuk menambahkan beberapa parameter, klik + Tambahkan Parameter Kueri.
- Di kolom Timeout after, masukkan jumlah detik untuk menunggu hingga kueri dijalankan.
Pembaruan skema
Semua entity dan tindakan akan memiliki skema yang terkait dengan entity tersebut. Misalnya, skema tindakan akan memiliki detail parameter seperti nama parameter, dan jenis datanya yang sesuai. Skema (metadata) untuk entity dan tindakan diambil oleh koneksi saat runtime dari backend Anda. Jika ada pembaruan pada skema, pembaruan tersebut tidak akan otomatis diterapkan pada koneksi yang ada; Anda harus memperbarui skema secara manual. Untuk melihat skema yang diperbarui pada tugas konektor yang sudah ada, ikuti langkah-langkah berikut:- Di Integration Connectors, buka halaman Connection details dari koneksi, lalu klik Refresh connection schema.
- Dalam Integrasi Apigee, Anda harus mengonfigurasi ulang tugas konektor yang ada untuk koneksi yang sama.
Pembuatan koneksi inline
Anda dapat menggunakan tugas Konektor untuk langsung membuat koneksi baru di Integration Connectors.
Sebelum memulai
Buat koneksi baru
Untuk membuat koneksi baru dari Integrasi Apigee, lakukan langkah-langkah berikut:
- Klik elemen tugas Connectors pada desainer untuk melihat panel konfigurasi tugas Connectors.
- Klik Configure Connector.
Halaman Connectors Task Editor akan muncul.
- Lewati kolom Region.
- Klik Connection, lalu pilih opsi Create Connection dari menu drop-down.
- Selesaikan langkah-langkah berikut di panel Create Connection:
- Pada langkah Lokasi, pilih lokasi untuk koneksi.
- Klik Region, lalu pilih lokasi dari menu drop-down.
- Klik Next.
- Pada langkah Detail Koneksi, berikan detail tentang koneksi:
- Konektor: Pilih jenis konektor yang ingin Anda buat dari menu drop-down. Untuk mengetahui informasi tentang daftar konektor yang didukung, lihat Semua Konektor Integrasi.
- Versi konektor: Pilih versi yang tersedia dari jenis Konektor yang dipilih dari menu drop-down.
- Connection Name: Masukkan nama untuk instance Koneksi.
- (Opsional) Masukkan Deskripsi untuk instance koneksi.
- (Opsional) Centang Enable Cloud Logging untuk menyimpan data log instance koneksi.
- Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
- (Opsional) Klik Setelan lanjutan untuk mengonfigurasi setelan node koneksi.
Untuk informasi selengkapnya, lihat dokumentasi koneksi masing-masing di Konektor Integrasi.
- (Opsional) Klik + TAMBAHKAN LABEL untuk menambahkan label ke koneksi dalam bentuk pasangan kunci/nilai.
- Klik Next.
-
Pada langkah Authentication, berikan detail autentikasi untuk koneksi.
- Metode Autentikasi yang diisi pada langkah ini didasarkan pada jenis koneksi yang dibuat.
Jenis koneksi yang berbeda menggunakan metode autentikasi yang berbeda. Untuk informasi selengkapnya, lihat bagian Mengonfigurasi autentikasi dalam dokumentasi koneksi masing-masing di Konektor Integrasi.
- Klik Next.
- Metode Autentikasi yang diisi pada langkah ini didasarkan pada jenis koneksi yang dibuat.
- Peninjauan: Tinjau detail koneksi dan autentikasi Anda.
- Klik Create.
- Pada langkah Lokasi, pilih lokasi untuk koneksi.
Praktik terbaik
- Untuk mengetahui informasi tentang batas penggunaan yang berlaku bagi tugas Konektor, lihat Batas penggunaan.
- Untuk mengetahui informasi tentang cara memecahkan masalah tugas Konektor yang gagal, lihat Menggunakan log untuk memecahkan masalah dan melacak kegagalan konektor.
Strategi penanganan error
Strategi penanganan error untuk tugas menentukan tindakan yang akan diambil jika tugas gagal karena error sementara. Untuk informasi tentang cara menggunakan strategi penanganan error, dan mengetahui berbagai jenis strategi penanganan error, lihat Strategi penanganan error.