Membuat class pesan sumber

Panduan ini menjelaskan cara membuat class pesan sumber untuk Manufacturing Data Engine (MDE).

Pemodelan class pesan sumber

Class pesan sumber harus ditentukan untuk mengambil sekumpulan pesan sumber yang memiliki struktur umum.

Semakin spesifik Anda mendesain class pesan sumber, semakin sedikit pernyataan bersyarat yang perlu Anda tulis dalam skrip Whistle untuk menangani perbedaan skema antara pesan sumber yang berbeda. Namun, membuat class pesan sumber yang lebih spesifik akan mengorbankan kebutuhan akan lebih banyak parser.

Oleh karena itu, pemodelan kelas pesan sumber melibatkan penyeimbangan yang tepat antara, di satu sisi, memiliki kelas pesan sumber dengan skema pesan yang seragam dan, di sisi lain, jumlah parser yang perlu Anda kelola.

Pembuatan class pesan sumber

Bagian ini menguraikan proses pembuatan class pesan sumber menggunakan panggilan API atau antarmuka konsol.

Penting: Mulai rilis MDE 1.4.1 dan versi yang lebih baru, header pesan Pub/Sub disimpan dalam atribut khusus yang disebut mdeHeaders. Kelas pesan yang ada dari rilis sebelumnya yang menggunakan ekspresi seperti #root.headers['SOME_ATTRIBUTE'] akan terus berfungsi untuk sejumlah rilis mendatang sebelum dihentikan. Pastikan Anda mengupdate ekspresi class pesan untuk menggunakan #root.mdeHeaders['SOME_ATTRIBUTE'].

REST

POST /configuration/v1/message-classes

{
  "name": "MESSAGE_CLASS_NAME",
  "MESSAGE_CLASS_NAME": "PRIORITY",
  "expression": "SPEL_EXPRESSION"
}

Ganti kode berikut:

• MESSAGE_CLASS_NAME: nama class pesan yang akan dibuat.
• PRIORITY: prioritas class pesan. Prioritas class pesan adalah bilangan bulat dari 0 hingga 65535 , inklusif. Bilangan bulat yang lebih rendah menunjukkan prioritas yang lebih tinggi.
• SPEL_EXPRESSION: ekspresi SpEL yang menentukan class pesan. Misalnya, #root.event['value'] instanceof T(Number)

Konsol

1. Buka bagian 'MESSAGE CLASSES' di UI untuk membuat Source Message Class. Daftar semua Kelas Pesan yang tersedia ditampilkan di bagian UI ini:

   

   Untuk setiap Kelas Pesan, parameter berikut ditampilkan dalam Daftar:

   • Nama Class Pesan: nama Class Pesan. Harus unik.
   • Message Class Expression: ekspresi SpEL sebenarnya yang terkait dengan Message Class.
   • Prioritas: prioritas Class Pesan (angka yang lebih rendah menunjukkan prioritas yang lebih tinggi).
   • Diaktifkan: status class pesan. Kelas Pesan yang Dinonaktifkan tidak akan menjadi bagian dari penyerapan.
   • Tindakan: tombol kontekstual yang memberikan akses ke fungsi 'Lihat/Edit' dan fungsi 'Aktifkan / Nonaktifkan' untuk Class Pesan yang dipilih.

2. Untuk menambahkan Message Class baru, klik tombol 'ADD NEW MESSAGE CLASS' di bagian atas. Menu samping baru akan ditampilkan yang berisi semua parameter Message Class yang diperlukan untuk diberikan:

   

   • Nama Class Pesan: String unik yang menentukan Class Pesan.
   • Ekspresi Class Pesan: mengacu pada ekspresi SpEL yang menentukan class pesan.
   • Prioritas: menentukan prioritas yang terkait dengan Class Pesan. Prioritas kelas pesan adalah bilangan bulat dari 0 hingga 65535 , inklusif. Bilangan bulat yang lebih rendah menunjukkan prioritas yang lebih tinggi. Jika pesan memvalidasi ekspresi 2 Kelas Pesan, hanya pesan dengan nilai prioritas yang lebih rendah yang akan dipicu.

3. Untuk membuat Message Class baru, isi kolom Message Class Expression dengan ekspresi SpEL yang valid dan tetapkan prioritas

4. Klik tombol 'BUAT' untuk menyimpan perubahan. Pesan konfirmasi akan ditampilkan jika Message Class baru berhasil dibuat.

Catatan: Saat runtime, semua class pesan sumber aktif diurutkan berdasarkan prioritas, dan untuk setiap pesan tertentu, setiap ekspresi class pesan dievaluasi hingga ditemukan ekspresi yang dievaluasi menjadi true. Pada saat itu, evaluasi kelas pesan lebih lanjut akan berhenti.

Menguji ekspresi class pesan sumber

Anda dapat bereksperimen dan menguji ekspresi class pesan sumber sebelum membuat class pesan sumber.

REST

POST /configuration/v1/message-classes:test

{
  "expression": "SPEL_EXPRESSION",
  "testMessage": "TEST_MESSAGE"
}

Ganti kode berikut:

• SPEL_EXPRESSION: ekspresi SpEL yang menentukan class pesan.
• TEST_MESSAGE: objek pesan sumber pengujian.

Objek yang ditampilkan memberi tahu Anda apakah ekspresi yang diberikan sudah benar secara sintaksis, dan apakah akan dievaluasi menjadi true dari false untuk pesan yang diberikan.

Konsol

UI menyediakan opsi untuk menguji ekspresi SpEL dari Class Pesan baru dengan pesan pengujian.

1. Isi kotak 'Test Message' dengan contoh pesan JSON.
2. Klik 'JALANKAN PENGUJIAN' untuk menjalankan validasi. Hasil pengujian adalah 'Cocok' atau 'Tidak cocok' dan penjelasan singkat tentang kriteria pencocokan.

Mengevaluasi pesan pengujian terhadap semua class pesan aktif

Anda dapat mengevaluasi pesan untuk menentukan kelas pesan sumber tempat pesan pengujian akan berada untuk serangkaian kelas pesan sumber yang aktif.

REST

POST /configuration/v1/message-classes:evaluate

{
  "testMessage": "TEST_MESSAGE"
}

Ganti kode berikut:

• TEST_MESSAGE dengan objek pesan sumber pengujian.

Objek yang ditampilkan memberi tahu Anda class pesan sumber mana yang cocok untuk pesan yang diberikan, jika ada.