Saat mengembangkan kode untuk suatu ekstensi, DataWorks menyediakan parameter bawaan dan kustom untuk meningkatkan efisiensi pengembangan. Misalnya, Anda dapat menggunakan parameter agar ekstensi hanya aktif di ruang kerja tertentu.
Informasi latar belakang
Saat mengembangkan kode dengan menggunakan parameter ekstensi, Anda harus mendefinisikan parameter tersebut dalam informasi pendaftaran ekstensi. Tambahkan parameter bawaan atau kustom yang mungkin diperlukan selama proses pengembangan ke dalam informasi pendaftaran. Pengembang ekstensi dapat memperoleh konfigurasi parameter ekstensi tersebut dengan memanggil API GetExtension. Pada kotak dialog Register Extension, pilih suatu event di sebelah kiri—seperti event sebelum eksekusi kode, event sebelum penghapusan file, event sebelum tabel diajukan ke lingkungan pengembangan, event sebelum tabel diajukan ke lingkungan produksi, atau event sebelum penerbitan file. Di sebelah kanan, isi formulir dengan informasi seperti Associated Event, Applicable Module, Owner, Test Workspace, Extension Details URL, Extension Documentation URL, Extension Parameter Configuration, dan Description. Pada area teks Extension Parameter Configuration, masukkan parameter dalam format key=value, dengan satu parameter per baris.
-
Tambahkan setiap parameter pada baris baru.
-
Saat menambahkan parameter bawaan:
Parameter bawaan mengikuti format
key=value. Parameter bawaan berikut ini didukung:-
Parameter bawaan 1: extension.project.disabled — daftar blokir ruang kerja
-
Parameter bawaan 2: extension.project.disabled.append — tambahkan ke daftar blokir ruang kerja
-
Parameter bawaan 3: extension.project.{eventCode}.disabled — daftar blokir titik ekstensi
-
Parameter bawaan 5: extension.fileType.{fileType}.{eventCode}.enabled
-
Parameter bawaan 6:
extension.manualPass.enabled. Parameter ini mengontrol visibilitas tombol Mark as Passed untuk ekstensi.extension.manualPass.enabled=truePengaturan ini menampilkan tombol Mark as Passed di kolom aksi untuk ekstensi.
-
-
Saat menambahkan parameter kustom:
Disarankan menggunakan format
key=value.
Parameter bawaan 1: extension.project.disabled — daftar blokir ruang kerja
-
Kasus penggunaan:
Gunakan parameter ini untuk menonaktifkan ekstensi di ruang kerja tertentu.
-
Deskripsi parameter:
extension.project.disabled=projectId1,projectId2,projectId3projectId adalah ID ruang kerja tempat ekstensi dinonaktifkan. Anda dapat memperoleh ID tersebut dengan memanggil API ListProjects atau melihatnya pada halaman konfigurasi ruang kerja di Konsol DataWorks.
CatatanAnda dapat menentukan beberapa ID ruang kerja untuk satu parameter. Pisahkan ID tersebut dengan koma (,).
-
Contoh kode:
extension.project.disabled=projectId1 -
Catatan:
Jangan mengonfigurasi kunci yang sama lebih dari sekali. Jika dilakukan, hanya konfigurasi terakhir yang berlaku.
Parameter bawaan 2: extension.project.disabled.append — Daftar blokir ruang kerja (tambahkan)
-
Kasus penggunaan:
Gunakan parameter ini untuk menambahkan ruang kerja ke daftar blokir tanpa menimpa daftar yang ditentukan oleh
extension.project.disabled. Ekstensi dinonaktifkan di ruang kerja yang ditentukan oleh kedua parameter tersebut. -
Deskripsi parameter:
extension.project.disabled.append=projectId1,projectId2,projectId3projectId adalah ID ruang kerja tempat ekstensi dinonaktifkan. Anda dapat memperoleh ID tersebut dengan memanggil API ListProjects atau melihatnya pada halaman konfigurasi ruang kerja di Konsol DataWorks.
CatatanAnda dapat menentukan beberapa ID ruang kerja untuk satu parameter. Pisahkan ID tersebut dengan koma (,).
-
Contoh kode:
extension.project.disabled.append=projectId1
Parameter bawaan 3: extension.project.{eventCode}.disabled — daftar blokir titik ekstensi
-
Kasus penggunaan:
Gunakan parameter ini untuk menonaktifkan ekstensi pada titik ekstensi tertentu untuk ruang kerja yang ditentukan.
-
Deskripsi parameter:
extension.project.{eventCode}.disabled=projectId1,projectId2,projectId3Di mana:
-
eventCode: Jenis event dari titik ekstensi yang akan dinonaktifkan. Untuk daftar nilai yang valid, lihat Lampiran: Detail event (eventType).
-
projectId: ID ruang kerja tempat ekstensi dinonaktifkan. Anda dapat memperoleh ID tersebut dengan memanggil API ListProjects atau melihatnya pada halaman konfigurasi ruang kerja di Konsol DataWorks.
CatatanAnda dapat menentukan beberapa ID ruang kerja untuk satu parameter. Pisahkan ID tersebut dengan koma (,).
-
-
Contoh kode:
extension.project.commit-file.disabled=projectId1 extension.project.delete-file.disabled=projectId2,projectId3 -
Catatan:
Jangan mengonfigurasi kunci yang sama lebih dari sekali. Jika dilakukan, hanya konfigurasi terakhir yang berlaku.
Parameter bawaan 4: extension.project.{eventCode}.disabled.append — Daftar blokir titik ekstensi (tambahkan)
-
Kasus penggunaan:
Gunakan parameter ini untuk menambahkan ruang kerja ke daftar blokir titik ekstensi tanpa menimpa daftar yang ditentukan oleh
extension.project.{eventCode}.disabled. Ekstensi dinonaktifkan pada titik ekstensi yang ditentukan untuk ruang kerja yang ditentukan oleh kedua parameter tersebut. -
Deskripsi parameter:
extension.project.{eventCode}.disabled.append=projectId1,projectId2,projectId3Di mana:
-
eventCode: Jenis event dari titik ekstensi yang akan dinonaktifkan. Untuk daftar nilai yang valid, lihat Lampiran: Detail event (eventType).
-
projectId: ID ruang kerja tempat ekstensi dinonaktifkan. Anda dapat memperoleh ID tersebut dengan memanggil API ListProjects atau melihatnya pada halaman konfigurasi ruang kerja di Konsol DataWorks.
CatatanAnda dapat menentukan beberapa ID ruang kerja untuk satu parameter. Pisahkan ID tersebut dengan koma (,).
-
-
Contoh kode:
extension.project.commit-file.disabled.append=projectId1 extension.project.delete-file.disabled.append=projectId2,projectId3
Parameter bawaan 5: extension.fileType.{fileType}.{eventCode}.enabled
-
Kasus penggunaan:
Gunakan parameter ini untuk mengaktifkan atau menonaktifkan ekstensi untuk jenis tugas node tertentu.
-
Deskripsi parameter:
extension.fileType.{fileType}.{eventCode}.enabledDi mana:
-
fileType: Kode jenis untuk tugas node tertentu. Anda dapat memanggil API ListFileType untuk memperoleh kode jenis tugas node tersebut.
-
eventCode: Jenis event dari titik ekstensi yang akan dinonaktifkan. Untuk daftar nilai yang valid, lihat Lampiran: Detail event (eventType).
-
-
Contoh kode:
Contoh berikut menunjukkan cara mengonfigurasi ekstensi untuk tugas node ODPS SQL (jenis 10) dan tugas node ODPS MR (jenis 11).
-
Jika semua jenis file yang ditentukan diatur ke
true, jenis file yang tidak dikonfigurasi secara default bernilaifalse.extension.fileType.10.run-file.enabled=true extension.fileType.11.run-file.enabled=true-
Ekstensi aktif untuk tugas node ODPS SQL (10) dan tugas node ODPS MR (11). Saat tugas-tugas ini dijalankan, mereka memicu ekstensi.
-
Tugas node lainnya, seperti tugas node DI sinkronisasi batch, tidak memicu ekstensi.
-
-
Jika semua jenis file yang ditentukan diatur ke
false, jenis file yang tidak dikonfigurasi secara default bernilaitrue.extension.fileType.10.run-file.enabled=false extension.fileType.11.run-file.enabled=false-
Ekstensi tidak aktif untuk tugas node ODPS SQL (10) maupun tugas node ODPS MR (11). Saat tugas-tugas ini dijalankan, mereka tidak memicu ekstensi.
-
Semua tugas node lainnya, seperti tugas node DI sinkronisasi batch, memicu ekstensi.
-
-
Jika Anda menggunakan konfigurasi campuran di mana setidaknya satu jenis file diatur ke
true, jenis file yang tidak dikonfigurasi secara default bernilaifalse.extension.fileType.10.run-file.enabled=false extension.fileType.11.run-file.enabled=true-
Ekstensi aktif untuk tugas node ODPS MR (11). Saat tugas ini dijalankan, ia memicu ekstensi.
-
Ekstensi tidak aktif untuk tugas node ODPS SQL (10) maupun tugas node lainnya, seperti tugas node DI sinkronisasi batch. Tugas-tugas ini tidak memicu ekstensi.
-
-