View a markdown version of this page

Parameter otomatisasi - AWS Studio Aplikasi
Manfaat parameter otomatisasiSkenario dan kasus penggunaanMendefinisikan jenis parameter otomatisasiMengkonfigurasi nilai dinamis untuk diteruskan ke parameter otomatisasiJenis keamananValidasiPraktik terbaik untuk parameter otomatisasi

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Parameter otomatisasi

Parameter otomatisasi adalah fitur canggih di App Studio yang dapat digunakan untuk membuat otomatisasi yang fleksibel dan dapat digunakan kembali dengan meneruskan nilai dinamis dari berbagai sumber, seperti UI, otomatisasi lain, atau tindakan data. Mereka bertindak sebagai placeholder yang diganti dengan nilai aktual saat otomatisasi dijalankan, memungkinkan Anda untuk menggunakan otomatisasi yang sama dengan input yang berbeda setiap kali.

Dalam otomatisasi, parameter memiliki nama unik, dan Anda dapat mereferensikan nilai parameter menggunakan variabel params diikuti oleh nama parameter, misalnya,{{params.customerId}}.

Artikel ini memberikan pemahaman mendalam tentang parameter otomatisasi, termasuk konsep dasar, penggunaan, dan praktik terbaiknya.

Manfaat parameter otomatisasi

Parameter otomatisasi memberikan beberapa manfaat, termasuk daftar berikut:

  1. Penggunaan kembali: Dengan menggunakan parameter, Anda dapat membuat otomatisasi yang dapat digunakan kembali yang dapat disesuaikan dengan nilai input yang berbeda, memungkinkan Anda untuk menggunakan kembali logika otomatisasi yang sama dengan input yang berbeda.

  2. Fleksibilitas: Alih-alih nilai hard-coding menjadi otomatisasi, Anda dapat menentukan parameter dan memberikan nilai yang berbeda saat diperlukan, membuat otomatisasi Anda lebih dinamis dan mudah beradaptasi.

  3. Pemisahan kekhawatiran: Parameter membantu memisahkan logika otomatisasi dari nilai-nilai spesifik yang digunakan, mempromosikan organisasi kode dan pemeliharaan.

  4. Validasi: Setiap parameter memiliki tipe data, seperti string, angka, atau boolean, yang divalidasi saat runtime. Ini memastikan bahwa permintaan dengan tipe data yang salah ditolak tanpa perlu kode validasi khusus.

  5. Parameter opsional dan wajib: Anda dapat menetapkan parameter otomatisasi sebagai opsional atau wajib. Parameter yang diperlukan harus disediakan saat menjalankan otomatisasi, sementara parameter opsional dapat memiliki nilai default atau dihilangkan. Fleksibilitas ini memungkinkan Anda membuat otomatisasi yang lebih serbaguna yang dapat menangani skenario yang berbeda berdasarkan parameter yang disediakan.

Skenario dan kasus penggunaan

Skenario: Mengambil detail produk

Bayangkan Anda memiliki otomatisasi yang mengambil detail produk dari database berdasarkan ID produk. Otomatisasi ini dapat memiliki parameter yang disebutproductId.

productIdParameter bertindak sebagai placeholder yang dapat Anda isi dengan nilai ID produk aktual saat menjalankan otomatisasi. Alih-alih mengkodekan ID produk tertentu ke dalam otomatisasi, Anda dapat menentukan productId parameter dan meneruskan nilai ID produk yang berbeda setiap kali Anda menjalankan otomatisasi.

Anda dapat memanggil otomatisasi ini dari sumber data komponen, meneruskan ID produk yang dipilih sebagai productId parameter menggunakan sintaks braket keriting ganda:{{ui.productsTable.selectedRow.id}}. Dengan cara ini, ketika pengguna memilih produk dari tabel (ui.productsTable), otomatisasi akan mengambil detail untuk produk yang dipilih dengan meneruskan id baris yang dipilih sebagai productId parameter.

Atau, Anda dapat memanggil otomatisasi ini dari otomatisasi lain yang memutar daftar produk dan mengambil detail untuk setiap produk dengan meneruskan id produk sebagai parameter. productId Dalam skenario ini, nilai productId parameter akan diberikan secara dinamis dari {{product.id}} ekspresi di setiap iterasi loop.

Dengan menggunakan productId parameter dan sintaks braket keriting ganda, Anda dapat membuat otomatisasi ini lebih fleksibel dan dapat digunakan kembali. Alih-alih membuat otomatisasi terpisah untuk setiap produk, Anda dapat memiliki otomatisasi tunggal yang dapat mengambil detail untuk produk apa pun hanya dengan memberikan ID produk yang sesuai sebagai nilai parameter dari sumber yang berbeda, seperti komponen UI atau otomatisasi lainnya.

Skenario: Menangani parameter opsional dengan nilai fallback

Mari kita pertimbangkan skenario di mana Anda memiliki entitas “Tugas” dengan kolom “Pemilik” yang diperlukan, tetapi Anda ingin bidang ini menjadi opsional dalam otomatisasi dan memberikan nilai fallback jika pemilik tidak dipilih.

  1. Buat otomatisasi dengan parameter bernama Owner yang memetakan ke Owner bidang Task entitas.

  2. Karena Owner bidang diperlukan dalam entitas, Owner parameter akan disinkronkan dengan pengaturan yang diperlukan.

  3. Untuk membuat Owner parameter opsional dalam otomatisasi, mati required kan pengaturan untuk parameter ini.

  4. Dalam logika otomatisasi Anda, Anda dapat menggunakan ekspresi seperti{{params.Owner || currentUser.userId}}. Ekspresi ini memeriksa apakah Owner parameter disediakan. Jika tidak disediakan, itu akan kembali ke ID pengguna saat ini sebagai pemilik.

  5. Dengan cara ini, jika pengguna tidak memilih pemilik dalam formulir atau komponen, otomatisasi akan secara otomatis menetapkan pengguna saat ini sebagai pemilik untuk tugas tersebut.

Dengan mengubah required pengaturan untuk Owner parameter dan menggunakan ekspresi fallback, Anda dapat memisahkannya dari persyaratan bidang entitas, menjadikannya opsional dalam otomatisasi, dan memberikan nilai default ketika parameter tidak disediakan.

Mendefinisikan jenis parameter otomatisasi

Dengan menggunakan tipe parameter untuk menentukan tipe data dan menetapkan persyaratan, Anda dapat mengontrol input untuk otomatisasi Anda. Ini membantu memastikan otomatisasi Anda berjalan andal dengan input yang diharapkan.

Menyinkronkan tipe dari entitas

Mensinkronisasi jenis parameter dan persyaratan secara dinamis dari definisi bidang entitas menyederhanakan otomatisasi bangunan yang berinteraksi dengan data entitas, memastikan bahwa parameter selalu mencerminkan jenis dan persyaratan bidang entitas terbaru.

Prosedur berikut merinci langkah-langkah umum untuk menyinkronkan jenis parameter dari entitas:

  1. Buat entitas dengan bidang yang diketik (misalnya Boolean, Number, dll.) Dan tandai bidang sesuai kebutuhan.

  2. Buat otomatisasi baru.

  3. Tambahkan parameter ke otomatisasi, dan saat memilih Jenis, pilih bidang entitas yang ingin Anda sinkronkan. Jenis data dan pengaturan yang diperlukan akan secara otomatis disinkronkan dari bidang entitas yang dipetakan

  4. Jika diperlukan, Anda dapat mengganti pengaturan “wajib” dengan mengalihkannya on/off untuk setiap parameter. Ini berarti status yang diperlukan tidak akan tetap sinkron dengan bidang entitas, tetapi jika tidak, status tersebut akan tetap disinkronkan.

Mendefinisikan tipe secara manual

Anda juga dapat menentukan jenis parameter secara manual tanpa menyinkronkan dari entitas

Dengan menentukan jenis parameter kustom, Anda dapat membuat otomatisasi yang menerima jenis input tertentu dan menangani parameter opsional atau diperlukan sesuai kebutuhan, tanpa bergantung pada pemetaan bidang entitas.

  1. Buat entitas dengan bidang yang diketik (misalnya Boolean, Number, dll.) Dan tandai bidang sesuai kebutuhan.

  2. Buat otomatisasi baru.

  3. Tambahkan parameter ke otomatisasi, dan ketika memilih Jenis, pilih jenis yang diinginkan.

Mengkonfigurasi nilai dinamis untuk diteruskan ke parameter otomatisasi

Setelah Anda menentukan parameter untuk otomatisasi, Anda dapat meneruskan nilai kepada mereka saat memanggil otomatisasi. Anda dapat meneruskan nilai parameter dengan dua cara:

  1. Pemicu komponen: Jika Anda memanggil otomatisasi dari pemicu komponen, seperti klik tombol, Anda dapat menggunakan JavaScript ekspresi untuk meneruskan nilai dari konteks komponen. Misalnya, jika Anda memiliki bidang input teks bernamaemailInput, Anda dapat meneruskan nilainya ke parameter email dengan ekspresi berikut:ui.emailInput.value.

  2. Otomatisasi lainnya: Jika Anda memanggil otomatisasi dari otomatisasi lain, Anda dapat menggunakan JavaScript ekspresi untuk meneruskan nilai dari konteks otomatisasi. Misalnya, Anda dapat meneruskan nilai parameter lain atau hasil dari langkah tindakan sebelumnya.

Jenis keamanan

Dengan menentukan parameter dengan tipe data tertentu, seperti String, Number, atau Boolean, Anda dapat memastikan bahwa nilai yang diteruskan ke otomatisasi Anda adalah tipe yang diharapkan.

catatan

Di App Studio, tanggal adalah tanggal string ISO, dan itu akan divalidasi juga.

Keamanan jenis ini membantu mencegah ketidakcocokan jenis, yang dapat menyebabkan kesalahan atau perilaku tak terduga dalam logika otomatisasi Anda. Misalnya, jika Anda mendefinisikan parameter sebagai aNumber, Anda dapat yakin bahwa nilai apa pun yang diteruskan ke parameter tersebut akan menjadi angka, dan Anda tidak perlu melakukan pemeriksaan jenis tambahan atau konversi dalam otomatisasi Anda.

Validasi

Anda dapat menambahkan aturan validasi ke parameter Anda, memastikan bahwa nilai yang diteruskan ke otomatisasi Anda memenuhi kriteria tertentu.

Meskipun App Studio tidak menyediakan pengaturan validasi bawaan untuk parameter, Anda dapat menerapkan validasi kustom dengan menambahkan JavaScript tindakan ke otomatisasi yang menimbulkan kesalahan jika batasan tertentu dilanggar.

Untuk bidang entitas, subset aturan validasi, seperti minimum/maximum nilai, didukung. Namun, itu tidak divalidasi pada tingkat otomatisasi, hanya di lapisan data, saat menjalankan tindakan Create/Update/Delete Rekam.

Praktik terbaik untuk parameter otomatisasi

Untuk memastikan bahwa parameter otomatisasi Anda dirancang dengan baik, dapat dipelihara, dan mudah digunakan, ikuti praktik terbaik berikut:

  1. Gunakan nama parameter deskriptif: Pilih nama parameter yang secara jelas menggambarkan tujuan atau konteks parameter.

  2. Berikan deskripsi parameter: Manfaatkan bidang Deskripsi saat menentukan parameter untuk menjelaskan tujuan, batasan, dan harapan mereka. Deskripsi ini akan muncul di komentar JSDoc saat mereferensikan parameter, serta di antarmuka pengguna mana pun di mana pengguna perlu memberikan nilai untuk parameter saat memanggil otomatisasi.

  3. Gunakan tipe data yang sesuai: Pertimbangkan dengan cermat tipe data dari setiap parameter berdasarkan nilai input yang diharapkan, misalnya: String, Number, Boolean, Object.

  4. Validasi nilai parameter: Terapkan pemeriksaan validasi yang sesuai dalam otomatisasi Anda untuk memastikan bahwa nilai parameter memenuhi persyaratan tertentu sebelum melanjutkan tindakan lebih lanjut.

  5. Gunakan nilai fallback atau default: Meskipun App Studio saat ini tidak mendukung pengaturan nilai default untuk parameter, Anda dapat menerapkan nilai fallback atau default saat menggunakan parameter dalam logika otomatisasi Anda. Misalnya, Anda dapat menggunakan ekspresi seperti {{ params.param1 || "default value" }} untuk memberikan nilai default jika param1 parameter tidak disediakan atau memiliki nilai palsu.

  6. Pertahankan konsistensi parameter: Jika Anda memiliki beberapa otomatisasi yang memerlukan parameter serupa, cobalah untuk mempertahankan konsistensi dalam nama parameter dan tipe data di seluruh otomatisasi tersebut.

  7. Penggunaan parameter dokumen: Pertahankan dokumentasi yang jelas untuk otomatisasi Anda, termasuk deskripsi setiap parameter, tujuannya, nilai yang diharapkan, dan contoh atau kasus tepi yang relevan.

  8. Sering meninjau dan memfaktorkan ulang: Tinjau otomatisasi Anda dan parameternya secara berkala, memfaktorkan ulang atau mengkonsolidasikan parameter sesuai kebutuhan untuk meningkatkan kejelasan, pemeliharaan, dan kegunaan kembali.

  9. Batasi jumlah parameter: Sementara parameter memberikan fleksibilitas, terlalu banyak parameter dapat membuat otomatisasi menjadi kompleks dan sulit digunakan. Bertujuan untuk mencapai keseimbangan antara fleksibilitas dan kesederhanaan dengan membatasi jumlah parameter hanya pada apa yang diperlukan.

  10. Pertimbangkan pengelompokan parameter: Jika Anda menemukan diri Anda mendefinisikan beberapa parameter terkait, pertimbangkan untuk mengelompokkannya menjadi satu Object parameter.

  11. Masalah terpisah: Hindari menggunakan parameter tunggal untuk berbagai tujuan atau menggabungkan nilai yang tidak terkait ke dalam satu parameter. Setiap parameter harus mewakili masalah atau bagian data yang berbeda.

  12. Gunakan alias parameter: Jika Anda memiliki parameter dengan nama panjang atau kompleks, pertimbangkan untuk menggunakan alias atau versi singkatan dalam logika otomatisasi untuk keterbacaan dan pemeliharaan yang lebih baik.

Dengan mengikuti praktik terbaik ini, Anda dapat memastikan bahwa parameter otomatisasi Anda dirancang dengan baik, dapat dipelihara, dan mudah digunakan, yang pada akhirnya meningkatkan kualitas dan efisiensi otomatisasi Anda secara keseluruhan.