DataWorks menyediakan parameter bawaan dan kustom untuk membantu Anda mengembangkan kode ekstensi secara lebih efisien dan efektif. Misalnya, Anda dapat menggunakan parameter agar ekstensi hanya berlaku untuk ruang kerja tertentu. Topik ini menjelaskan cara menggunakan parameter ekstensi.
Informasi latar belakang
Untuk menggunakan parameter ekstensi dalam kode Anda, terlebih dahulu definisikan parameter tersebut dalam informasi pendaftaran ekstensi. Anda dapat menambahkan parameter bawaan atau kustom sesuai kebutuhan selama pengembangan. Pengembang dapat memanggil API GetExtension untuk mengambil konfigurasi parameter ekstensi.
Anda dapat menambahkan beberapa parameter. Setiap parameter harus berada pada baris baru.
Saat menambahkan parameter bawaan:
Parameter bawaan menggunakan format
key=value. Parameter bawaan berikut didukung:Parameter bawaan 1: extension.project.disabled, konfigurasi blacklist ruang kerja
Parameter bawaan 2: extension.project.disabled.append, tambahkan ke blacklist ruang kerja
Parameter bawaan 3: extension.project.{eventCode}.disabled, konfigurasi blacklist titik ekstensi
Parameter bawaan 5: extension.fileType.{fileType}.{eventCode}.enabled
Parameter bawaan 6:
extension.manualPass.enabled. Parameter ini menentukan apakah tombol Mark as Passed diaktifkan untuk ekstensi.extension.manualPass.enabled=trueJika parameter ini diatur, tombol Mark as Passed akan muncul di kolom Operations di sisi kanan ekstensi.
Saat menambahkan parameter kustom:
Gunakan format
key=value.
Parameter bawaan 1: extension.project.disabled, konfigurasi blacklist ruang kerja
Skenario:
Anda dapat menggunakan parameter ini untuk menonaktifkan ekstensi pada ruang kerja tertentu.
Deskripsi parameter:
extension.project.disabled=projectId1,projectId2,projectId3Pada parameter ini, projectId menentukan ID ruang kerja tempat ekstensi dinonaktifkan. Anda dapat memperoleh ID tersebut dengan memanggil operasi ListProjects atau menemukannya di halaman konfigurasi ruang kerja di Konsol DataWorks.
CatatanAnda dapat menentukan beberapa ID ruang kerja untuk satu parameter. Pisahkan ID tersebut dengan koma (,).
Contoh:
extension.project.disabled=projectId1Catatan:
Jangan mengonfigurasi kunci yang sama berkali-kali. Jika kunci yang sama dikonfigurasi beberapa kali, hanya konfigurasi terakhir yang berlaku.
Parameter bawaan 2: extension.project.disabled.append, tambahkan ke blacklist ruang kerja
Skenario:
Jika parameter
extension.project.disabledsudah diatur, Anda dapat menggunakan parameter ini untuk menambahkan lebih banyak ruang kerja ke daftar blacklist. Ekstensi akan dinonaktifkan untuk ruang kerja yang ditambahkan.Deskripsi parameter:
extension.project.disabled.append=projectId1,projectId2,projectId3Pada parameter ini, projectId menentukan ID ruang kerja tempat ekstensi dinonaktifkan. Anda dapat memperoleh ID tersebut dengan memanggil operasi ListProjects atau menemukannya di halaman konfigurasi ruang kerja di Konsol DataWorks.
CatatanAnda dapat menentukan beberapa ID ruang kerja untuk satu parameter. Pisahkan ID tersebut dengan koma (,).
Contoh:
extension.project.disabled.append=projectId1
Parameter bawaan 3: extension.project.{eventCode}.disabled, konfigurasi blacklist titik ekstensi
Skenario:
Anda dapat menggunakan parameter ini untuk menonaktifkan ekstensi pada titik ekstensi tertentu di ruang kerja tertentu.
Parameter:
extension.project.{eventCode}.disabled=projectId1,projectId2,projectId3Tabel berikut menjelaskan parameter tersebut:
eventCode: Jenis event dari titik ekstensi yang ingin Anda nonaktifkan. Untuk informasi selengkapnya, lihat Lampiran: Detail event (eventType).
projectId: ID ruang kerja tempat Anda ingin menonaktifkan ekstensi. Anda dapat memperoleh ID tersebut dengan memanggil operasi ListProjects atau menemukannya di halaman konfigurasi ruang kerja di Konsol DataWorks.
CatatanAnda dapat menentukan beberapa ID ruang kerja untuk parameter ini. Pisahkan ID tersebut dengan koma (,).
Contoh:
extension.project.commit-file.disabled=projectId1 extension.project.delete-file.disabled=projectId2,projectId3Catatan:
Jangan mengonfigurasi kunci yang sama berkali-kali. Jika kunci yang sama dikonfigurasi beberapa kali, hanya konfigurasi terakhir yang berlaku.
Parameter bawaan 4: extension.project.{eventCode}.disabled.append, tambahkan ke blacklist titik ekstensi
Skenario:
Ketika parameter
extension.project.{eventCode}.disabled.appendberisi nilai tunggal (bukan daftar beberapa ID ruang kerja yang dipisahkan koma), Anda dapat menggunakan parameter ini untuk menambahkan ruang kerja tempat titik ekstensi ekstensi tersebut akan dinonaktifkan.Deskripsi parameter:
extension.project.{eventCode}.disabled.append=projectId1,projectId2,projectId3Placeholder dijelaskan sebagai berikut:
eventCode: Jenis event dari titik ekstensi yang ingin Anda nonaktifkan. Untuk informasi selengkapnya, lihat Lampiran: Detail event (eventType).
projectId: ID ruang kerja tempat Anda ingin menonaktifkan ekstensi. Anda dapat memperoleh ID tersebut dengan memanggil operasi ListProjects atau menemukannya di halaman konfigurasi ruang kerja di Konsol DataWorks.
CatatanAnda dapat menentukan beberapa ID ruang kerja untuk parameter ini. Pisahkan ID tersebut dengan koma (,).
Contoh:
extension.project.commit-file.disabled.append=projectId1 extension.project.delete-file.disabled.append=projectId2,projectId3
Parameter bawaan 5: extension.fileType.{fileType}.{eventCode}.enabled
Skenario:
Anda dapat menggunakan parameter ini untuk mengaktifkan atau menonaktifkan ekstensi pada jenis task node tertentu.
Deskripsi parameter:
extension.fileType.{fileType}.{eventCode}.enabledPlaceholder dijelaskan sebagai berikut:
fileType: Menentukan kode jenis untuk tipe task node. Anda dapat memperoleh kode jenis tersebut dengan memanggil operasi ListFileType.
eventCode: Jenis event dari titik ekstensi yang ingin Anda nonaktifkan. Untuk informasi selengkapnya, lihat Lampiran: Detail event (eventType).
Contoh:
Contoh berikut menunjukkan cara mengonfigurasi parameter ini untuk tipe task node 10 (task ODPS SQL) dan tipe task node 11 (task ODPS MR).
Jika Anda mengatur parameter ke `true` untuk kedua tipe task tersebut, setiap `fileType` yang tidak dikonfigurasi akan bernilai default `false`.
extension.fileType.10.run-file.enabled=true extension.fileType.11.run-file.enabled=trueEkstensi berlaku untuk task ODPS SQL dan task ODPS MR. Ekstensi dipicu saat task-task tersebut dijalankan.
Ekstensi tidak dipicu oleh task node lainnya, seperti task sinkronisasi batch Data Integration (DI).
Jika Anda mengatur parameter ke `false` untuk kedua tipe task tersebut, setiap `fileType` yang tidak dikonfigurasi akan bernilai default `true`.
extension.fileType.10.run-file.enabled=false extension.fileType.11.run-file.enabled=falseEkstensi tidak berlaku untuk task ODPS SQL maupun task ODPS MR. Ekstensi tidak dipicu saat task-task tersebut dijalankan.
Ekstensi dipicu oleh semua task node lainnya, seperti task sinkronisasi batch Data Integration (DI).
Dalam mode campuran, setiap `fileType` yang tidak dikonfigurasi akan bernilai default `false`.
extension.fileType.10.run-file.enabled=false extension.fileType.11.run-file.enabled=trueEkstensi berlaku untuk task ODPS MR. Ekstensi dipicu saat task jenis ini dijalankan.
Ekstensi tidak berlaku untuk task ODPS SQL maupun task node lainnya, seperti task sinkronisasi batch Data Integration (DI). Ekstensi tidak dipicu saat task-task tersebut dijalankan.