יצירת קטגוריה של מטא-נתונים

במדריך הזה נסביר איך ליצור קטגוריה של מטא-נתונים. אפשר ליצור מאגר מטא-נתונים באמצעות Configuration API או ממשק האינטרנט של Manufacturing Data Engine ‏ (MDE).

לפני שמתחילים

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

מתן שמות לקטגוריות

כשיוצרים קטגוריה, השם שלה צריך להיות ייחודי בפריסת MDE. שמות של קטגוריות לא יכולים להכיל רווחים או תווים מיוחדים כמו &, @ או %.

יצירת קטגוריה של מטא-נתונים

אפשר ליצור קטגוריית מטא-נתונים באמצעות הטרמינל או ממשק המסוף.

REST

מריצים את בקשת ה-API הבאה בארכיטקטורת REST:

POST /metadata/v1/buckets

  {
    "name": "BUCKET_NAME",
    "type": "BUCKET_TYPE",
    "schema": "BUCKET_SCHEMA",
    "provider": "local",
    "attributes": {
      "instanceOverwriteMode": "INSTANCE_OVERWRITE_MODE"
    }
  }

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

  • ‫BUCKET_NAME: השם של הקטגוריה שרוצים ליצור.
  • ‫BUCKET_TYPE: סוג ה-bucket שרוצים ליצור. חייב להיות אחד מהערכים הבאים: TAG, RECORD או LOOKUP. ה-natural_key של מופע מטא-נתונים בקטגוריית TAG חייב להיות שם תג. הפרמטר natural_key של מופע מטא-נתונים בקטגוריית RECORD יכול להיות כל מפתח. ה-natural_key של מופע מטא-נתונים בדלי LOOKUP יכול להיות כל מפתח, אבל רשומות לא יכולות להפנות למופעים בדלי חיפוש, והמופעים לא נכתבים ל-data sink כלשהו. דליים של חיפושים משמשים רק כמקור של נתוני הפניה שאפשר לאחזר באמצעות הפונקציה lookupByKey של Whistle ולשפר את הרשומות.
  • ‫BUCKET_SCHEMA: סכימת ה-JSON של הדלי. הסכימה מגבילה את המופעים שאפשר ליצור בקטגוריה.
  • ‫INSTANCE_OVERWRITE_MODE: TRUE או FALSE. המאפיין הזה קובע אם נוצרים מופעים חדשים על ידי מיזוג המופע שצוין עם המופע האחרון של מפתח טבעי נתון, או אם נוצרים מופעים חדשים כמו שהם.

המסוף

כדי להוסיף מאגר מטא-נתונים חדש באמצעות המסוף, לוחצים על הקטע METADATA (מטא-נתונים) בתפריט העליון של הקטע Cloud Management (ניהול הענן). בדף ההגדרות מטא-נתונים מפורטים המאגדים שזמינים במופע MDE:

הקטע Types (סוגים) – רשימה של מטא-נתונים

לכל Bucket מופיעים הפרטים הבאים:

  • ‫Name: השם של הקטגוריה. כל שם צריך להיות ייחודי.
  • גרסה: הגרסה של הדלי. כברירת מחדל, מוצגת רק הגרסה האחרונה שזמינה. כדי להציג גרסאות קודמות, מבטלים את הסימון בתיבת הסימון 'הגרסה האחרונה בלבד'.
  • סוג הדלי: תצוגה חזותית של סוג הדלי. יש שלושה סוגים שונים של דליים שנתמכים:
    1. תג: מאגרי מידע שעומדים בדרישות של תג מסוים. הם משויכים לסוג מסוים ומועברים בירושה לכל התגים מהסוג הזה. אפשר ליצור מופעים שלהם ברמת התג, כי הם נועדו להגדיר את המשתנה עצמו ולא רשומות ספציפיות שלו. דוגמה לקטגוריית תגים יכולה להיות 'היררכיית הנכסים' או 'יחידות המידה' של התג.
    2. רשומה: דלי הרשומות מסווגים כל אחת מהרשומות של תג נתון. הם גם משויכים לסוג ועוברים בירושה מהתג, אבל הם מופעלים ברמת הרשומה. כל רשומה צריכה להיות בעלת ערך שונה מתוך קבוצה מוגבלת של מופעי Bucket. דוגמה ל-Record Bucket יכולה להיות 'משמרת' או 'שם המפעיל'.
    3. הפניה: מאגרי מידע שמגדירים קבוצה של צמדי מפתח/ערך בין מפתח שהוגדר על ידי המשתמש לבין מופע.

כדי ליצור Bucket חדש, לוחצים על הוספת Bucket חדש של מטא-נתונים:

הקטע Types (סוגים) – רשימה של סוגים

ממלאים את הטופס שמוצג בחלונית הצדדית עם הפרמטרים הנדרשים של Bucket:

  • שם הקטגוריה: שם ייחודי שהמשתמש מגדיר לקטגוריה.
  • ‫Bucket type: להגדרת הסוג של Bucket.
  • מצב עדכון של מופע: מציין את סוג העדכונים של המופע שצוינו עבור קטגוריית המטא-נתונים:
    1. החלפת מופע: המופע הקיים מוחלף במופע האחרון שהתקבל מהקצה, גם אם הוא לא מלא.
    2. מיזוג מופעים: המופע הקיים מוזג עם המופע האחרון שהתקבל מה-Edge. רק המאפיינים שכלולים במופע החדש של Edge מוחלפים.
  • סכימת JSON: JSON Schema שמגדיר את המבנה של הקטגוריה. צריך להיות סכימה תקינה. כל מופעי המטא-נתונים מאומתים מול סכימת הקטגוריה.

הדוגמה הבאה היא JSON Schema של קטגוריית מטא-נתונים שמוגדרת כברירת מחדל, שסופקה על ידי חבילת ההגדרות שמוגדרת כברירת מחדל:

{
  "$id": "https://gmde.cloud/tag.schema.json",
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "title": "Tag metadata bucket",
  "type": "object",
  "properties": {
    "datatype": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "registerId": {
      "type": "string"
    },
    "edgeTagName": {
      "type": "string"
    },
    "tagName": {
      "description": "Tag name",
      "type": "string"
    },
    "deviceID": {
      "type": "string"
    },
    "deviceName": {
      "type": "string"
    },
    "deviceMetadata": {
      "type": "object"
    }
  },
  "required": ["tagName"],
  "additionalProperties": false
}