Setelah Anda mendaftarkan, memublikasikan, dan mengaktifkan ekstensi di DataWorks Open Platform, DataWorks akan mengirim pesan event ke ekstensi tersebut setiap kali event titik ekstensi dipicu di ruang kerja terkait. Berdasarkan respons ekstensi, DataWorks menentukan apakah operasi tersebut diizinkan. Topik ini menjelaskan event titik ekstensi yang didukung oleh Data Studio dan cara menggunakannya untuk memicu ekstensi.
Prasyarat
-
Anda telah mengaktifkan subscription pesan. Untuk informasi selengkapnya, lihat Enable message subscription.
-
Anda telah mengembangkan dan menyebarkan ekstensi. Untuk informasi selengkapnya, lihat Develop and deploy an extension using Function Compute.
Informasi latar belakang
-
Aktifkan ekstensi.
Pada halaman Management Center, Anda dapat melihat Extensions dan mengaktifkan atau menonaktifkan pemeriksaan ekstensi untuk ruang kerja saat ini.
-
Event titik ekstensi dalam Pengembangan Data.
Modul Data Studio dari DataWorks mendukung event titik ekstensi seperti event pre-publish file, pre-commit file, dan pre-submit table. Untuk daftar lengkap event titik ekstensi dan konsep terkait, lihat List of supported extension point events.
-
DataWorks dapat mengirim notifikasi pesan untuk event titik ekstensi. Ekstensi kemudian dapat secara otomatis memvalidasi dan merespons event tersebut. Untuk informasi lebih lanjut tentang proses pemicu, lihat Supported extension point events.
Batasan
Saat ekstensi diaktifkan, batasan berikut berlaku untuk notifikasi pesan dan respons terhadap event yang dipicu selama pengembangan data.
-
Setelah ekstensi bawaan diaktifkan, ekstensi tersebut hanya mendukung node ODPS SQL.
Artinya, ketika event titik ekstensi dipicu untuk node ODPS SQL, proses akan diblokir. Ekstensi bawaan memvalidasi logika dan mengembalikan hasilnya. Jika event dipicu untuk node non-ODPS SQL, proses juga diblokir, tetapi ekstensi bawaan tidak melakukan validasi dan langsung mengembalikan hasil sukses.
-
Event pre-publish table event dan event pre-submit table event adalah event titik ekstensi yang hanya dipicu untuk tabel MaxCompute.
-
Untuk node komposit yang berisi inner node, seperti do-while nodes dan for-each nodes, semua inner node harus lolos pemeriksaan sebelum operasi berikutnya dapat dilanjutkan.
Ikhtisar kemampuan
Anda dapat mendaftarkan layanan lokal atau program sebagai ekstensi DataWorks untuk menerima pesan terkait event titik ekstensi tertentu di modul Data Studio. Hal ini memungkinkan Anda menerapkan logika kustom untuk menangani event tersebut dan mengembalikan hasilnya ke platform melalui callback ke API UpdateIDEEventResult. Metode ini memungkinkan kontrol proses di DataWorks. Titik ekstensi yang didukung meliputi:
-
Operasi file: Run, commit, publish, dan delete file.
-
Operasi Tabel: Mengirim dan memublikasikan tabel.
CatatanEvent ekstensi untuk operasi tabel di Data Studio hanya dapat dipicu untuk tabel MaxCompute.
Event titik ekstensi yang didukung
Di Data Studio, Anda dapat menggunakan ekstensi untuk memvalidasi dan merespons event titik ekstensi berikut.
DataStudio - Run File Di editor kode DataStudio, klik tombol Run untuk memicu event pemeriksaan awal dari ekstensi. Overlay Checking muncul dengan pesan: "Operasi akan dieksekusi secara otomatis setelah pemeriksaan lolos. Anda dapat melihat hasilnya di [Operation Check]." Di panel Operation Check di sebelah kiri, Anda dapat melihat semua catatan pemeriksaan (termasuk jenis seperti run, commit file, dan delete). Klik catatan tersebut untuk membuka kotak dialog detailnya, tempat Anda dapat melihat jenis pemeriksaan, status, dan detail untuk setiap ekstensi.
DataStudio - Submit File: Saat Anda mengirim file di DataStudio, sistem memicu pemeriksaan event pre-commit file. Klik tombol Submit pada bilah alat untuk memicu pemeriksaan ekstensi. Editor menampilkan prompt "Checking", dan operasi akan dieksekusi secara otomatis setelah pemeriksaan lolos. Anda dapat melihat status setiap item pemeriksaan di panel Operation Check di sebelah kiri. Daftar tersebut menampilkan "Trigger file pre-commit event check".
DataStudio - Publishing a file Setelah Anda mengklik tombol Publish di editor kode untuk mengirim file, sistem memicu pemeriksaan ekstensi. Antarmuka Create Deployment Package muncul, di mana status node terkait dalam daftar file ditampilkan sebagai Checking and validating. Anda dapat mengklik status node tersebut untuk membuka kotak dialog Operation Check guna melihat jenis pemeriksaan, status, dan detail validasi.
DataStudio - Delete file Di pohon file Data Studio, klik kanan node target dan pilih Delete. Tindakan ini memicu event pemeriksaan awal dari program ekstensi. Notifikasi biru muncul di bagian bawah halaman dengan pesan: "Operasi ini telah memicu pemeriksaan. Operasi akan berlaku secara otomatis setelah pemeriksaan lolos. Silakan lihat hasil pemeriksaan di 'Operation Check'." Buka halaman Operation Check untuk melihat daftar catatan pemeriksaan. Daftar tersebut mencakup kolom Nama/Waktu Operasi, Jenis, dan Status. Klik catatan tertentu untuk melihat detail pemeriksaan operasi tersebut. Detailnya mencakup jenis pemeriksaan, seperti "Pre-delete combination test", dan status saat ini, seperti "Checking". Halaman ini juga menyediakan tautan View Details dan View Document.
DataStudio: Submit table Saat Anda mengirim tabel (misalnya xc_table_prod) ke lingkungan pengembangan atau produksi, sistem secara otomatis memicu pemeriksaan awal dari program ekstensi. Kotak dialog Checking muncul dengan pesan: "Operasi dijalankan secara otomatis setelah pemeriksaan lolos. Silakan lihat hasilnya di Operation Check." Di sidebar Operation Check di sebelah kiri, Anda dapat memfilter dan melihat semua catatan pemeriksaan berdasarkan jenis dan status. Klik catatan tertentu untuk membuka kotak dialog detail Operation Check. Kotak dialog ini menampilkan daftar validasi program ekstensi yang dipicu oleh operasi saat ini (misalnya jenis pemeriksaan "Pre-submission check for table - Test program") dan status validasinya. Fitur ini mendukung operasi View Details dan Re-check.
DataStudio - Publish Table Pada halaman konfigurasi tabel, klik tab Submit to Production Environment untuk memicu pemeriksaan ekstensi. Sistem kemudian menampilkan prompt: "Checking - Operasi akan dieksekusi secara otomatis setelah pemeriksaan lolos. Silakan lihat hasilnya di 'Operation Check'." Buka halaman Operation Check untuk melihat daftar catatan pemeriksaan. Daftar tersebut berisi nama tabel, waktu pengiriman, jenis pemeriksaan, dan status. Klik catatan untuk melihat detailnya. Detail tersebut mencakup jenis pemeriksaan (misalnya Pre-publish Check for Table) dan status saat ini. Anda juga dapat mengklik View Details dan View Documentation. Operasi ini memicu validasi ekstensi yang diaktifkan untuk jenis event pre-publish pada tabel di ruang kerja tersebut.
Referensi
-
Untuk informasi selengkapnya tentang penggunaan ekstensi, lihat Use extensions.
-
Data Studio mendukung event titik ekstensi tambahan. Untuk informasi selengkapnya, lihat List of supported extension point events.
-
Untuk informasi selengkapnya tentang format entitas pesan untuk event perubahan file, lihat File change events (commit, publish, run, delete, and code review).
-
Untuk informasi selengkapnya tentang format entitas pesan untuk event perubahan tabel, lihat Table change events (submit table to development environment and publish table to production environment).