יצירת מחלקה של הודעת מקור

במדריך הזה נסביר איך ליצור מחלקת הודעות מקור עבור Manufacturing Data Engine‏ (MDE).

מודלים של סיווג הודעות לפי מקור

צריך להגדיר מחלקות של הודעות מקוריות כדי לתעד קבוצה של הודעות מקוריות עם מבנה משותף.

ככל שתגדירו בצורה ספציפית יותר את מחלקות הודעות המקור, כך תצטרכו לכתוב פחות משפטי תנאי בסקריפטים של Whistle כדי לטפל בהבדלים בסכימה בין הודעות מקור שונות. עם זאת, כדי ליצור מחלקות ספציפיות יותר של הודעות מקור, צריך יותר מנתחים.

לכן, כשמבצעים מודלינג של מחלקות הודעות ממקורות, צריך למצוא את האיזון הנכון בין מחלקות הודעות ממקורות עם סכימות הודעות אחידות לבין מספר מנתחי התוכן שצריך לנהל.

יצירת סיווג של הודעת מקור

בקטע הזה מתואר התהליך של יצירת מחלקה של הודעת מקור באמצעות קריאות ל-API או ממשק המסוף.

REST

POST /configuration/v1/message-classes

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

מחליפים את מה שכתוב בשדות הבאים:

  • MESSAGE_CLASS_NAME: השם של מחלקת ההודעות שרוצים ליצור.
  • PRIORITY: העדיפות של מחלקת ההודעות. העדיפות של מחלקת הודעות היא מספר שלם בין 0 ל-65535 , כולל. מספרים שלמים נמוכים יותר מציינים עדיפויות גבוהות יותר.
  • SPEL_EXPRESSION: ביטוי SpEL שמגדיר את סיווג ההודעה. לדוגמה, #root.event['value'] instanceof T(Number)

המסוף

  1. פותחים את הקטע 'MESSAGE CLASSES' בממשק המשתמש כדי ליצור Source Message Class. רשימה של כל סוגי ההודעות הזמינים מוצגת בקטע הזה של ממשק המשתמש:

    Message Classes – List Messages

    הפרמטרים הבאים מוצגים ברשימה של כל סוג הודעה:

    • שם מחלקת ההודעות: השם של מחלקת ההודעות. הערך חייב להיות ייחודי.
    • Message Class Expression: ביטוי SpEL בפועל שמשויך ל-Message Class.
    • עדיפות: העדיפות של סוג ההודעה (מספרים נמוכים יותר מייצגים עדיפויות גבוהות יותר).
    • מופעל: הסטטוס של סוגי ההודעות. סוגי הודעות שהושבתו לא ייכללו בהעברה.
    • פעולות: כפתור הקשרי שמאפשר גישה לפונקציות 'הצגה / עריכה' ו 'הפעלה / השבתה' של סוג ההודעה שנבחר.
  2. כדי להוסיף סוג הודעה חדש, לוחצים על הלחצן 'הוספת סוג הודעה חדש' בחלק העליון. יוצג תפריט צד חדש עם כל הפרמטרים הנדרשים של סוג ההודעה שצריך לספק:

    Message Classes – Create New Message Class

    • Message Class Name: מחרוזת ייחודית שמגדירה את Message Class.
    • Message Class Expression: מתייחס לביטוי SpEL שמגדיר את הודעת המחלקה.
    • עדיפות: מגדירה את העדיפות שמשויכת לסוג ההודעה. העדיפות של מחלקת הודעות היא מספר שלם בין 0 ל-65535 , כולל. מספרים שלמים נמוכים יותר מציינים עדיפות גבוהה יותר. אם הודעה מאמתת את הביטוי של 2 סוגי הודעות, רק הסוג עם ערך העדיפות הנמוך יותר יופעל.
  3. כדי ליצור Message Class חדש, ממלאים את השדה Message Class Expression (ביטוי של Message Class) בביטוי SpEL תקין ומגדירים את העדיפות.

  4. לוחצים על הלחצן יצירה כדי לשמור את השינויים. אם מחלקת ההודעות החדשה נוצרת בהצלחה, מוצגת הודעת אישור.

בדיקה של ביטוי של מחלקת הודעות מקור

אתם יכולים להתנסות ולבדוק את הביטויים של מחלקת הודעות המקור לפני שאתם יוצרים מחלקת הודעות מקור.

REST

POST /configuration/v1/message-classes:test

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

מחליפים את מה שכתוב בשדות הבאים:

  • SPEL_EXPRESSION: ביטוי SpEL שמגדיר את סיווג ההודעה.
  • TEST_MESSAGE: אובייקט הודעת המקור של הבדיקה.

אובייקט ההחזרה מודיע לכם אם הביטוי שסופק נכון מבחינת התחביר, ואם הוא יחזיר את הערך true מתוך false עבור ההודעה שסופקה.

המסוף

ממשק המשתמש מספק אפשרות לבדוק את ביטוי SpEL של Message Class החדש באמצעות הודעת בדיקה.

  1. ממלאים את התיבה 'הודעת בדיקה' בהודעה לדוגמה JSON.
  2. לוחצים על הפעלת הבדיקה כדי להריץ את האימות. התוצאה של הבדיקה היא 'התאמה' או 'ללא התאמה', והסבר קצר על קריטריוני ההתאמה.

סיווג הודעות – בדיקת סיווג הודעות

הערכת הודעת בדיקה מול כל סוגי ההודעות הפעילים

אתם יכולים להעריך הודעה כדי לקבוע לאיזו מחלקה של הודעות מקור תיפול הודעת בדיקה מתוך קבוצה של מחלקות פעילות של הודעות מקור.

REST

POST /configuration/v1/message-classes:evaluate

{
  "testMessage": "TEST_MESSAGE"
}

מחליפים את מה שכתוב בשדות הבאים:

  • TEST_MESSAGE עם אובייקט הודעת המקור לבדיקה.

אובייקט ההחזרה מציין איזו מחלקה של הודעת מקור הותאמה להודעה שסופקה, אם בכלל.