Pemicu Salesforce

Pengumuman: Application Integration kini tersedia untuk project Google Cloud Anda. Anda kini dapat menggunakan Integrasi Apigee dan Application Integration dalam project Google Cloud yang sama. Pelajari lebih lanjut

Pemicu Salesforce memungkinkan Anda memproses peristiwa Change Data Capture (CDC) atau Enterprise Messaging Platform. Dengan pemicu ini, Anda dapat memulai integrasi berdasarkan salah satu peristiwa CDC (Membuat, Memperbarui, Menghapus, atau Membatalkan Penghapusan) atau peristiwa platform di instance Salesforce Anda.

Sebelum memulai

Bagian ini menjelaskan langkah-langkah yang diperlukan untuk menghubungkan dan mengonfigurasi instance Salesforce untuk menggunakan peristiwa Change Data Capture (CDC) atau Platform guna mengalirkan perubahan ke Integrasi Apigee dengan cara pub/sub. Langkah-langkah berikut harus diselesaikan sebelum mengonfigurasi tugas atau pemicu terkait Salesforce di Apigee:

• Menyiapkan pengguna integrasi
• Mengonfigurasi set izin
• Menyiapkan token keamanan
• Membuat aplikasi yang terhubung

Catatan: Untuk menyelesaikan langkah-langkah ini, akses administrasi sistem ke instance Salesforce Anda diperlukan. Jika Anda tidak memiliki akses admin, bagikan petunjuk ini kepada Administrator Salesforce.

Tutorial ini memberikan petunjuk mendalam, tetapi sebaiknya Anda memiliki pemahaman tentang opsi konfigurasi Salesforce. Salesforce menyediakan Dokumentasi Developer mendetail untuk membantu Anda memulai.

Menyiapkan pengguna integrasi

Catatan: Jika sudah memiliki pengguna integrasi dan mengetahui sandinya, Anda dapat melanjutkan ke langkah berikutnya. Jika Anda perlu mereset sandi, lihat Langkah 6 di bawah.

Siapkan pengguna integrasi dengan langkah-langkah berikut:

1. Login ke instance Salesforce dengan kredensial sysadmin Anda.
2. Klik ikon Roda Gigi lalu pilih Penyiapan, seperti yang ditunjukkan pada gambar di bawah:
3. Klik Pengguna > Pengguna dari menu Administrasi.
4. Dari panel Users, pilih tombol New User.
5. Dalam dialog User Edit, isi detail berikut:
   1. Nama Depan: Nama depan pengguna integrasi.
   2. Nama Belakang: Nama belakang pengguna integrasi.
   3. Email Address: Email untuk pengguna integrasi. Idealnya, ini harus berupa email grup.
   4. Nama pengguna: Nama pengguna yang mematuhi konvensi penamaan tingkat organisasi.

      Jika Anda membuat pengguna integrasi baru, gunakan format berikut: EMAIL.SALESFORCE_ORG_NAME.SANDBOX_NAME

      Jika Anda sudah memiliki pengguna integrasi, pastikan nama pengguna dimasukkan di sini.

   5. Peran: Pilih dari menu dropdown opsi.
   6. Lisensi Pengguna: Masukkan Salesforce atau, jika menggunakan organisasi uji coba, masukkan Salesforce Platform.
   7. Profil: Pilih profil izin untuk pengguna integrasi dari dropdown.

      Sebaiknya tetapkan profil tanpa izin untuk melindungi akses Salesforce pengguna integrasi Anda dari penggunaan yang tidak sah.

   8. Klik Save.
6. Untuk memperbarui sandi pengguna integrasi baru, ikuti langkah-langkah berikut:
   1. Klik tombol Reset password(s) di panel Users. Email reset sandi dikirim ke alamat email yang terkait dengan pengguna.
      Catatan: Pastikan Anda memiliki akses ke akun email yang terkait dengan pengguna integrasi sebelum memicu alur reset sandi. Selain itu, jika SSO diaktifkan untuk pengguna ini, Anda tidak akan dapat mereset sandi. Untuk mengaktifkan opsi reset, buka Profile > System Permissions dan hapus centang opsi SSO Login Enabled.
   2. Ikuti alur reset sandi dari akun email. Catat sandi baru, karena Anda akan memerlukannya untuk langkah berikutnya.

Mengonfigurasi Kumpulan Izin

Jika sudah memiliki akses ke Kumpulan Izin yang sesuai untuk pengguna integrasi, Anda dapat melewati langkah ini dan melanjutkan ke bagian Menyiapkan token keamanan. Jika tidak, ikuti langkah-langkah berikut untuk mengonfigurasi Kumpulan Izin untuk pengguna integrasi dan objek Salesforce.

Untuk mengonfigurasi Kumpulan Izin bagi pengguna integrasi:

1. Dari menu Penyiapan, klik Pengguna > Kumpulan Izin.
2. Di panel Permission Sets, klik tombol New.
3. Dalam dialog Set Izin, masukkan detail berikut:
   • Label: Masukkan nama untuk Kumpulan Izin.
   • Lisensi: Pilih Salesforce dari dropdown Lisensi.
   • Klik Save.
4. Dari daftar opsi setelan System, scroll ke bawah, lalu pilih System Permissions
5. Di halaman System Permissions, klik tombol Edit.
6. Scroll ke bawah daftar izin yang tersedia dan pilih kotak centang API Enabled.

   Izin Api Only User juga diperlukan, tetapi tidak dapat diaktifkan sampai token keamanan yang diperlukan direset. Izin ini ditambahkan di langkah berikutnya.

7. (Opsional) Scroll dan pilih Modify All Data dan View All Data, jika ada. Izin ini tidak diperlukan, tetapi dapat membantu jika Anda ingin secara otomatis memberikan akses pengguna integrasi ke objek baru. Sebaiknya hanya aktifkan izin ini untuk pengujian di sandbox.
8. Scroll ke bagian atas daftar izin, lalu klik Simpan.
9. Konfirmasi setelan Anda, lalu klik Simpan.

Untuk mengonfigurasi Izin yang Ditetapkan untuk objek Salesforce:

1. Klik Permission Set Overview untuk kembali ke halaman konfigurasi Permissions Set utama.
2. Pilih Object Settings dari bagian Apps di panel Permissions Set.
3. Scroll ke bawah dan pilih objek Salesforce yang memerlukan Kumpulan Izin. Contoh ini menggunakan objek Opportunity.
   CATATAN: CDC hanya mendukung subkumpulan objek Salesforce standar. Untuk mempelajari lebih lanjut, lihat: Mengubah Dukungan Objek Peristiwa.
4. Klik tombol Edit di halaman detail objek.
5. Centang kotak untuk jenis data. Jika Anda tahu jenis data mana yang diperlukan, pilih jenis data tersebut. Jika Anda tidak tahu jenis data mana yang diperlukan, pilih semuanya.
6. Pilih kotak centang Object Permissions yang akan diaktifkan. Sebaiknya pilih Baca dan Lihat Semua.
7. Berikan Read Access atau Edit Access untuk setiap kolom objek dengan memilih kotak centang yang sesuai.
   Catatan: Akses tulis tidak diperlukan untuk digunakan dengan CDC.
8. Scroll ke bagian atas halaman, lalu klik Simpan.

Menyiapkan Token Keamanan

Jika Anda telah membuat token keamanan untuk pengguna integrasi sebelumnya, dan mereset sandi, email dengan token keamanan baru akan otomatis dikirim. Anda dapat menggunakan token baru dan langsung ke bagian Membuat aplikasi yang terhubung.

Jika tidak, gunakan langkah-langkah berikut untuk mereset token keamanan untuk pengguna integrasi:

1. Login ke Salesforce sebagai pengguna integrasi, menggunakan nama pengguna dan sandi yang ditetapkan di langkah sebelumnya.
2. Dari menu utama, klik foto profil, lalu klik Settings.
3. Dari menu Settings, pilih Reset My Security Token untuk membuka panel Reset Security Token.
4. Klik tombol Reset Security Token.
5. Periksa email yang berisi token keamanan baru pada akun email yang terkait dengan pengguna integrasi. Catat token keamanan baru karena Anda akan membutuhkannya untuk langkah berikutnya.
6. (Opsional) Aktifkan izin Hanya Pengguna API di Izin Sistem untuk kumpulan izin Anda, seperti yang dijelaskan dalam Mengonfigurasi kumpulan izin di atas.

Membuat Aplikasi yang Terhubung

Izin administrasi sistem diperlukan untuk menyiapkan Aplikasi yang Terhubung. Jika saat ini Anda login sebagai pengguna integrasi, pastikan untuk logout, lalu login lagi sebagai sysadmin.

Ikuti langkah-langkah ini untuk menyiapkan Aplikasi yang Terhubung:

1. Klik ikon Roda Gigi lalu pilih Penyiapan.
2. Dari menu Setup, telusuri dan pilih App Manager, seperti yang ditunjukkan pada gambar di bawah:
3. Klik Aplikasi Terhubung Baru.
4. Di panel konfigurasi, berikan detail berikut:
   • Nama Aplikasi yang Terhubung: Masukkan nama untuk aplikasi yang terhubung.
   • API Name: Masukkan nama API.
   • Email kontak: Masukkan email untuk aplikasi Anda yang terhubung, idealnya alias email grup.
   • API (Enable OAuth Settings): Pilih Enable OAuth Settings. Selanjutnya, tetapkan nilai berikut:
     1. (Opsional) URL callback: Ini hanya diperlukan jika Anda ingin layanan eksternal melakukan validasi. Jika memilih untuk memberikan callback, pastikan Anda menyertakan awalan http(s)://.
     2. Cakupan OAuth yang Dipilih: Pilih:
        • Mengakses dan mengelola data Anda (api)
        • Menjalankan permintaan atas nama Anda kapan saja (refresh_token, offline_access)
5. Klik Save.
   Catatan: Aplikasi terhubung yang baru dibuat tidak akan berfungsi selama 2-10 menit awal setelah pembuatan.
6. Klik Lanjutkan. Anda perlu memberi otorisasi ulang dengan kode verifikasi yang dikirimkan ke alamat email Anda.
7. Setelah berhasil memverifikasi kode, rahasia konsumen dan kunci konsumen akan ditampilkan di halaman berikutnya. Catat nilai ini, karena nilai tersebut akan digunakan saat menyiapkan Modul Auth untuk Apigee.
8. Klik tombol Manage.
9. Setelah berada di halaman Detail Aplikasi yang Terhubung, klik tombol Edit Kebijakan.
10. Di bagian Kebijakan OAuth, ubah nilai di dropdown Pengguna yang Diizinkan menjadi Pengguna yang disetujui admin telah diberi otorisasi sebelumnya.
11. Klik Save.
12. Scroll ke bagian Profil dan Kumpulan Izin pada halaman untuk memilih profil atau Set Izin yang ingin Anda terapkan ke aplikasi yang terhubung.
    Anda dapat memilih profil atau Set Izin, atau campuran keduanya, yang akan memungkinkan pengguna dengan profil yang benar atau Set Izin untuk mengakses aplikasi yang terhubung.
13. Pilih profil atau Setel Izin yang diinginkan.
14. Klik Save.

Langkah-langkah prasyarat untuk menggunakan peristiwa CDC

Sebelum mengonfigurasi pemicu Apigee untuk menggunakan peristiwa CDC, pastikan untuk menambahkan objek yang dikonfigurasi ke CDC di Salesforce:

1. Login ke Salesforce sebagai sysadmin.
2. Klik ikon Roda Gigi, lalu klik Penyiapan.
3. Dengan menggunakan navigasi sebelah kiri, telusuri dan pilih Ubah Pengambilan Data.
4. Pada halaman penyiapan Change Data Capture, cari objek Salesforce yang ingin Anda gunakan di kolom Available Entities, lalu tarik ke kolom Selected Entities.
   Catatan: Maksimum 5 objek per lisensi Salesforce dapat dipilih untuk CDC. Hubungi perwakilan Salesforce untuk informasi lebih lanjut dan opsi pemberian lisensi.
5. Klik Save.

Langkah-langkah prasyarat untuk menggunakan peristiwa Platform

Sebelum mengonfigurasi pemicu Apigee untuk menggunakan peristiwa Platform, selesaikan langkah-langkah berikut di Salesforce:

• Buat Peristiwa Platform
• Memperbarui izin untuk Peristiwa Platform

Membuat peristiwa Platform

Untuk membuat peristiwa Platform, lakukan langkah-langkah berikut:

1. Login ke instance Salesforce dengan kredensial sysadmin Anda.
2. Klik ikon Roda Gigi, lalu pilih Penyiapan.
3. Di panel navigasi, telusuri Platform, lalu klik Peristiwa platform.

4. Di halaman Peristiwa platform, klik New Platform Event dan tetapkan properti berikut:

• Label
• Label Jamak
• Object Name(Kolom ini diisi secara otomatis)
• Perilaku Publikasi Pilih salah satu nilai berikut:
  • Publikasikan Setelah Commit: Mengembalikan streaming peristiwa jika kondisi tidak terpenuhi.
  • Publikasikan Segera: Memicu peristiwa secara instan, tanpa menunggu validasi apa pun.
  Untuk informasi lebih lanjut tentang perilaku publikasi, lihat Peristiwa dan Transaksi Platform.
• Status Deployment (Opsional): Pilih Di-deploy jika peristiwa siap untuk deployment.

Klik Save.

Buat kolom kustom. Untuk membuat kolom kustom, klik Baru di bagian Kolom dan Hubungan Kustom, lalu pilih jenis kolom kustom. Anda dapat membuat kolom kustom sebanyak yang diperlukan.

Setelah membuat kolom kustom, di halaman Peristiwa platform, perhatikan nilai kolom API Name. Nama objek diakhiri dengan _e, yang berarti objek tersebut adalah objek Peristiwa Platform. Untuk objek CDC, nama objek diakhiri dengan _c.

Memperbarui izin untuk Peristiwa Platform

Kumpulan izin harus diperbarui agar pengguna integrasi dapat mengakses Peristiwa Platform yang baru dibuat.

Untuk memperbarui izin, lakukan langkah-langkah berikut:

1. Dari menu Penyiapan, klik Pengguna > Kumpulan Izin.
2. Di halaman Set Izin, klik izin yang dibuat sebelumnya.
3. Klik Object Settings > Plural Label of the Platform Event.
4. Di bagian Object Permissions, aktifkan izin Read dan Create.
5. Klik Save.

Menambahkan pemicu Salesforce

Untuk menambahkan pemicu Salesforce ke integrasi baru atau yang sudah ada, ikuti langkah-langkah di bawah:

1. Di UI Apigee, pilih Organisasi Apigee.
2. Klik Develop > Integrations.
3. Pilih integrasi yang ada atau buat integrasi baru dengan mengklik Buat Integrasi.

   Jika Anda membuat integrasi baru:

   1. Masukkan nama dan deskripsi dalam dialog Create Integration.
   2. Pilih Region untuk integrasi dari daftar wilayah yang didukung.
   3. Klik Create.

   Tindakan ini akan membuka integrasi di desainer integrasi.

4. Di menu navigasi desainer integrasi, klik +Tambahkan tugas/pemicu > Tasks untuk melihat daftar tugas yang tersedia.
5. Pilih integrasi yang ada atau klik Buat integrasi.
6. Di editor integrasi, klik + Tambahkan tugas/pemicu > Pemicu untuk melihat pemicu yang tersedia
7. Klik dan tempatkan elemen pemicu Salesforce ke desainer.

Mengonfigurasi pemicu Salesforce

Untuk mengonfigurasi pemicu Salesforce, lakukan langkah-langkah berikut:

1. Klik Pemicu Salesforce di editor integrasi untuk melihat panel konfigurasi pemicu.
2. Pilih instance Salesforce dari drop-down Konfigurasi instance Salesforce.

   Jika Anda tidak memiliki instance Salesforce, buat instance baru. Untuk informasi selengkapnya, lihat Membuat instance Salesforce baru.

3. Pilih saluran Salesforce dari drop-down Konfigurasi saluran Salesforce.

   Jika Anda tidak memiliki saluran Salesforce, buat saluran baru. Untuk informasi selengkapnya, lihat Membuat saluran Salesforce baru.

4. Jika Anda telah memilih jenis peristiwa sebagai CDC, pilih salah satu operasi berikut:
   • Create
   • Update
   • Delete
   • Undelete

   Pemicu hanya berjalan jika operasi atau operasi celah tertentu terjadi.

   Pemicu Salesforce hanya dapat dikonfigurasi untuk satu operasi. Jika Anda ingin menjalankan pemicu untuk beberapa operasi, buat pemicu Salesforce untuk setiap operasi.

Membuat instance Salesforce baru

Untuk mengonfigurasi instance Salesforce baru, lakukan langkah-langkah berikut:

1. Di properti pemicu yang dapat diedit, klik Select a Salesforce instance configuration > + Add new Salesforce instance configuration.
2. Pada dialog Add Salesforce instance configuration, tetapkan properti berikut:
• Nama koneksi instance Salesforce: Masukkan nama untuk instance.

  Setelah konfigurasi, Anda akan menggunakan nama ini untuk merujuk ke instance Salesforce.

• Domain Salesforce: Masukkan otoritas layanan untuk instance. Anda dapat menemukan domain tersebut di akun Salesforce. Misalnya: instance.my.salesforce.com. Gambar berikut menampilkan domain Salesforce:

  

• Profil autentikasi: Pilih profil autentikasi.

  Jika Anda tidak memiliki profil autentikasi, buat profil baru jenis autentikasi kredensial sandi pemilik resource OAuth 2.0. Gambar berikut menunjukkan kolom yang diperlukan untuk membuat profil autentikasi:

  

  Untuk informasi tentang kolom, lihat Kredensial sandi pemilik resource OAuth 2.0. Untuk instance Salesforce, masukkan nilai berikut:
  • Client-ID: masukkan kunci konsumen yang Anda catat saat menyiapkan aplikasi yang terhubung.
  • Rahasia: masukkan rahasia konsumen yang Anda catat saat menyiapkan aplikasi yang terhubung.
  • Sandi: Masukkan sandi pengguna dengan format USER_PASSWORDSECURITY_TOKEN. Ganti kode berikut:
    • USER_PASSWORD: sandi pengguna Salesforce.
    • SECURITY_TOKEN: token keamanan yang ditetapkan untuk integrasi Anda.
    Misalnya, jika USER_PASSWORD adalah test-password dan SECURITY_TOKEN adalah 737K27NCa3O6, sandi Anda adalah test-password737K27NCa3O6.

ID Organisasi Salesforce: Masukkan ID org dari instance Salesforce. Anda bisa mendapatkan ID dari administrator Salesforce.

Klik Tambahkan.

Membuat saluran Salesforce baru

Untuk mengonfigurasi saluran Salesforce baru, lakukan langkah-langkah berikut:

1. Pada properti pemicu yang dapat diedit, klik Select a Salesforce channel configuration > + Add new Salesforce channel configuration.
2. Pada dialog Add Salesforce channel configuration, masukkan nama objek untuk properti Salesforce object name.

   Jika tidak yakin dengan nama objeknya, hubungi administrator Salesforce.

3. Klik Tambahkan.

Variabel output

Respons dari pemicu Salesforce tersedia untuk Anda dalam variabel output.

Variabel output untuk peristiwa CDC dijelaskan dalam tabel berikut:

Variabel	Data type	Deskripsi
SalesforceTriggerCdcPayload	JSON	Detail peristiwa perubahan.
SalesforceTriggerEvent	JSON	Berisi replayId peristiwa.
SalesforceTriggerSchema	String	Skema pemicu.
SalesforceTriggerCdcSnapshot	JSON	Snapshot objek setelah peristiwa perubahan. Kolom ini hanya tersedia untuk operasi Update dan Create.
SalesforceTriggerCdcRecordId	String	Berisi recordId data yang diperbarui atau ditambahkan. recordId adalah ID objek Salesforce yang diubah.

Variabel output untuk peristiwa Platform dijelaskan dalam tabel berikut:

Variabel	Data type	Deskripsi
SalesforceTriggerPEPayload	JSON	Detail peristiwa perubahan.
SalesforceTriggerEvent	JSON	Berisi replayId peristiwa.
SalesforceTriggerSchema	String	Skema pemicu.

Parameter output untuk pemicu ini adalah variabel JSON CdcTriggerPayload. Variabel JSON berisi objek kumpulan data yang diperbarui.

Praktik terbaik

Sebaiknya gunakan pemicu Salesforce jika Anda ingin menggunakan notifikasi Salesforce untuk memicu integrasi tanpa menulis kode kustom untuk memublikasikan peristiwa Salesforce. Setiap perubahan kecil pada kolom dalam kasus Salesforce akan memicu peristiwa CDC Salesforce, sehingga memicu integrasi, yang dapat menghasilkan derau integrasi yang signifikan. Pertimbangkan untuk menggunakan Filter peristiwa perubahan untuk memfilter hanya peristiwa CDC yang diperlukan yang memicu integrasi. Menggunakan Ubah filter peristiwa dapat membantu mengurangi derau integrasi dan memastikan kepatuhan terhadap batasan lisensi Anda.

Demikian pula, sebaiknya batalkan publikasi integrasi apa pun menggunakan pemicu ini saat integrasi tidak lagi diperlukan. Hingga publikasi atau penghapusannya dibatalkan, integrasi akan terus memproses peristiwa CDC dan Platform Salesforce.

Pertimbangan

Sebelum menggunakan pemicu Salesforce untuk menjalankan integrasi Anda, pertimbangkan hal berikut:

• Salesforce biasanya mengirimkan maksimum 100 ribu peristiwa CDC dan Platform per hari. Hubungi administrator Salesforce untuk memahami batasan lisensi Anda sebelum memilih peristiwa CDC untuk pemicu integrasi Anda.
  Catatan: Beberapa integrasi yang menggunakan Saluran Salesforce yang sama tidak akan menggandakan pemakaian kuota Salesforce Anda.
• Jika Anda merencanakan upload massal ke Salesforce, pertimbangkan untuk menjeda CDC guna mengurangi derau integrasi dan memastikan kepatuhan terhadap batasan lisensi Anda.
• Ukuran maksimum pesan peristiwa yang dapat dipublikasikan Salesforce adalah 1 MB. Untuk informasi selengkapnya, lihat Mengubah Alokasi Pengambilan Data.
• Apigee tidak mendukung peristiwa CDC Salesforce untuk region minicluster berikut:
  • asia-northeast1
  • asia-south1
  • australia-southeast1
  • europe-west2
  • europe-west3
  • europe-west6
  • northamerica-northeast1
  • southamerica-east1
  • us-east4
  • us-west2