Buat Fungsi Aviator - DataWorks

Topik ini menjelaskan cara membuat fungsi Aviator.

Prasyarat

Proses bisnis telah dibuat. Untuk informasi lebih lanjut, lihat Buat dan kelola proses bisnis.
Grup sumber daya eksklusif untuk DataService Studio telah dibeli. Untuk informasi lebih lanjut, lihat Buat dan gunakan grup sumber daya eksklusif untuk DataService Studio.
Catatan
Anda harus menggunakan grup sumber daya eksklusif untuk DataService Studio untuk menjalankan fungsi Aviator.

Informasi latar belakang

Di halaman DataService Studio, Anda dapat membuat, menguji, dan menerbitkan fungsi. Kemudian, Anda dapat mengaitkan fungsi tersebut dengan API dan menggunakannya sebagai filter untuk memproses parameter permintaan atau respons dari API guna melakukan kueri kompleks sesuai kebutuhan bisnis. Untuk contoh kode yang menunjukkan cara menggunakan fungsi Aviator sebagai filter untuk API dalam skenario umum, lihat Praktik Terbaik Menggunakan Fungsi Aviator Sebagai Filter.

Batasan

Anda harus menggunakan grup sumber daya eksklusif untuk DataService Studio untuk menjalankan fungsi Aviator.
Untuk API yang sama, fungsi yang digunakan sebagai prafilter dan pascafilter harus memiliki tipe yang sama.

Tindakan pencegahan

Untuk memastikan keamanan data dan kinerja fungsi, Anda harus menggunakan grup sumber daya eksklusif untuk DataService Studio saat menjalankan fungsi Aviator.

Saat mengedit atau menguji fungsi, Anda harus mengaitkan fungsi tersebut dengan grup sumber daya eksklusif untuk DataService Studio. Untuk informasi lebih lanjut, lihat Kelola Fungsi.
Jika Anda mengaktifkan fitur filter untuk API dan mengaitkan API dengan fungsi selama pengembangan API, Anda harus mengaitkan API dengan grup sumber daya eksklusif untuk DataService Studio. Untuk informasi lebih lanjut, lihat Buat API Menggunakan Antarmuka Tanpa Kode.

Sintaksis fungsi Aviator

Sistem menyediakan template berikut untuk fungsi Aviator. Untuk informasi lebih lanjut tentang sintaksis fungsi Aviator, lihat Sintaksis Fungsi Aviator.

## --- AviatorScript ---
## $0: nama default dari parameter input.
## Ekspresi harus dipisahkan oleh titik koma ";".

## Contoh 1:
## $0.a: Dapatkan atribut "a" dari parameter input "$0".
## $0.b[index]: Dapatkan indeks dari array "b" dari parameter input "$0". Indeks tidak bisa berupa ekspresi atau variabel.

## Contoh 2:
## Input: {"keyA":[1,2],"keyB":"value"}
## Fungsi: $0.keyA[0]=3; $0.keyB="new_value"; return $0;
## Output: {"keyA":[3,2],"keyB":"new_value"}

return $0;

Anda dapat memodifikasi fungsi sesuai kebutuhan bisnis Anda.

Nama default untuk parameter input fungsi Aviator adalah $0 dan tidak dapat diubah. Gunakan parameter $0 untuk mendapatkan input fungsi Aviator.
Input fungsi harus dalam format JSON. Di DataService Studio, fungsi digunakan sebagai filter untuk memproses parameter permintaan atau respons dari API. Parameter permintaan API didefinisikan dalam format JSON satu lapis, sedangkan respons API didefinisikan dalam format JSON multi-lapis. Oleh karena itu, input fungsi juga harus dalam format JSON. Parameter $0 menentukan data input dalam format JSON.
Jika fungsi digunakan sebagai prafilter untuk API, sistem akan mengonversi parameter permintaan API atau output dari fungsi sebelumnya dari pasangan kunci-nilai menjadi data dalam format JSON. Kemudian, sistem menggunakan data dalam format JSON untuk menggantikan parameter $0. Tipe data nilai dalam data JSON hanya bisa STRING.
Jika fungsi digunakan sebagai prafilter untuk API, output dari fungsi adalah pasangan kunci-nilai. Pasangan kunci-nilai digunakan sebagai parameter input pernyataan SQL. Oleh karena itu, pasangan kunci-nilai tidak boleh berisi pasangan kunci-nilai bersarang.

Pergi ke halaman DataService Studio

Masuk ke Konsol DataWorks. Di bilah navigasi atas, pilih wilayah yang diinginkan. Kemudian, klik DataService Studio di panel navigasi di sebelah kiri. Di halaman yang muncul, pilih ruang kerja yang diinginkan dari daftar drop-down dan klik Go to DataService Studio.

Buat fungsi

Di panel Service Development, gerakkan penunjuk mouse ke ikon , lalu pilih Create Function > Create Aviator Function.
Sebagai alternatif, Anda dapat menemukan proses bisnis yang diinginkan, klik kanan Function, lalu pilih Create Function > Create Aviator Function.

Di kotak dialog Create Aviator Function, konfigurasikan parameter.

Parameter	Deskripsi
Function Name	Nama fungsi. Nama dapat mencapai panjang hingga 256 karakter.
Function Template	Template yang digunakan untuk membuat fungsi. Atur nilainya menjadi AviatorScript Standard v1.
Function Description	Deskripsi fungsi. Deskripsi dapat mencapai panjang hingga 512 karakter.
Destination Folder	Folder untuk menyimpan fungsi. Catatan Nilai parameter ini bisa berupa nama proses bisnis, nama folder, atau kategori fungsi. Jika tidak ada proses bisnis yang tersedia, Anda harus membuat proses bisnis.

Klik Determine.
Di bagian Edit Code, masukkan kode fungsi.
Konfigurasikan grup sumber daya untuk DataService Studio.
1. Di panel navigasi kanan tab konfigurasi fungsi, klik Resource Group. Di bagian Resource Group Type pada tab Grup Sumber Daya, pilih Grup Sumber Daya Eksklusif untuk DataService Studio untuk parameter Skema dan pilih grup sumber daya dari daftar drop-down Grup Sumber Daya Eksklusif untuk DataService Studio.
  Anda hanya dapat memilih Grup Sumber Daya Eksklusif untuk DataService Studio untuk parameter Skema.
  Catatan
  Jika grup sumber daya eksklusif untuk DataService Studio yang ingin Anda pilih tidak ditampilkan dalam daftar drop-down, Anda dapat pergi ke halaman Grup Sumber Daya di Konsol DataWorks, lalu asosiasikan grup sumber daya eksklusif dengan ruang kerja Anda di tab Grup Sumber Daya Eksklusif. Anda juga dapat mengklik Beli Grup Sumber Daya untuk DataService Studio di tab Grup Sumber Daya untuk membeli grup sumber daya eksklusif untuk DataService Studio. Untuk informasi lebih lanjut, lihat Buat dan gunakan grup sumber daya eksklusif untuk DataService Studio.
2. Di bagian Environment Configuration, konfigurasikan parameter Memory dan Function Timeout.
  Kami merekomendasikan agar Anda mengatur parameter Waktu Habis Fungsi ke nilai yang kurang dari atau sama dengan 1000 untuk grup sumber daya bersama dan kurang dari atau sama dengan 100 untuk grup sumber daya eksklusif untuk DataService Studio.
Klik ikon di bilah alat.

Setelah fungsi dibuat, Anda dapat menguji dan menerbitkan fungsi tersebut. Kemudian, Anda dapat mengaitkan fungsi dengan API dan menggunakannya sebagai prafilter atau pascafilter untuk API.

Apa yang harus dilakukan selanjutnya

Setelah membuat fungsi, Anda dapat menguji dan menerbitkannya. Untuk informasi lebih lanjut, lihat Uji, Terbitkan, dan Gunakan Fungsi dan Terbitkan Fungsi.
Setelah menerbitkan fungsi, Anda dapat mengaitkan fungsi dengan API dan menggunakannya sebagai prafilter atau pascafilter untuk API. Dengan cara ini, fungsi dapat memproses parameter permintaan atau respons dari API. Untuk informasi lebih lanjut, lihat Gunakan Fungsi Sebagai Filter untuk API.