Membuat bucket metadata

Panduan ini menjelaskan cara membuat bucket metadata. Anda dapat membuat bucket metadata menggunakan Configuration API atau antarmuka web Manufacturing Data Engine (MDE).

Sebelum memulai

Sebelum Anda mulai membuat bucket, baca bagian cara memodelkan metadata dalam dokumentasi MDE.

Penamaan bucket

Saat Anda membuat bucket, nama bucket harus unik dalam deployment MDE. Nama bucket tidak boleh berisi spasi atau karakter khusus seperti &, @, atau %.

Membuat bucket metadata

Anda dapat membuat bucket metadata menggunakan terminal atau antarmuka konsol.

REST

Jalankan permintaan REST API berikut:

POST /metadata/v1/buckets

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

Ganti kode berikut:

• BUCKET_NAME: Nama bucket yang akan dibuat.
• BUCKET_TYPE: Jenis bucket yang akan dibuat. Harus salah satu dari TAG, RECORD, atau LOOKUP. natural_key instance metadata dalam bucket TAG harus berupa nama tag. natural_key instance metadata dalam bucket RECORD dapat berupa kunci apa pun. natural_key dari instance metadata dalam bucket LOOKUP dapat berupa kunci apa pun, tetapi rekaman tidak dapat mereferensikan instance dalam bucket lookup, dan instance tidak ditulis ke tujuan data mana pun. Bucket penelusuran hanya berfungsi sebagai sumber data referensi yang dapat diambil oleh parser menggunakan fungsi Whistle lookupByKey dan digunakan untuk memperkaya data.
• BUCKET_SCHEMA: Skema JSON bucket. Skema membatasi instance yang dapat dibuat di bucket.
• INSTANCE_OVERWRITE_MODE: TRUE atau FALSE. Menentukan apakah instance baru dibuat dengan menggabungkan instance yang diberikan dengan instance terbaru untuk kunci alami tertentu atau apakah instance baru dibuat seperti yang diberikan.

Konsol

Untuk menambahkan bucket metadata baru menggunakan konsol, klik bagian METADATA di menu atas bagian Cloud Management. Halaman konfigurasi Metadata mencantumkan Bucket yang tersedia di instance MDE:

Untuk setiap Bucket, informasi berikut akan tersedia:

• Name: Nama bucket. Setiap nama harus unik.
• Versi: Versi bucket. Hanya versi terbaru yang tersedia yang ditampilkan secara default. Untuk menampilkan versi sebelumnya, hapus centang pada kotak 'Only Latest'.
• Jenis bucket: Memvisualisasikan jenis bucket. Tiga jenis bucket yang berbeda didukung:
  1. Tag: Bucket yang memenuhi syarat tag tertentu. Atribut ini dikaitkan dengan jenis dan diwarisi oleh semua tag dari jenis tertentu. Atribut ini dapat di-instantiate di tingkat tag karena dimaksudkan untuk memenuhi syarat variabel itu sendiri, bukan salah satu catatan spesifiknya. Contoh Bucket tag dapat berupa 'Hierarki aset' atau 'Satuan Ukur' tag.
  2. Record: Bucket catatan memenuhi syarat setiap Catatan dari tag tertentu. Atribut ini juga dikaitkan dengan jenis dan diwariskan oleh tag, tetapi di-instansiasi di tingkat Rekaman. Setiap Record diharapkan memiliki nilai yang berbeda di antara serangkaian terbatas Bucket Instance. Contoh Bucket Kumpulan Data dapat berupa 'Shift' atau 'Nama Operator'.
  3. Referensi: Bucket yang menentukan serangkaian key-value pair antara Kunci yang ditentukan pengguna dan instance.

Untuk membuat Bucket baru, klik Tambahkan bucket metadata baru:

Isi formulir yang ditampilkan dari panel samping dengan parameter Bucket yang diperlukan:

• Nama Bucket: Nama unik yang ditentukan pengguna untuk bucket.
• Jenis bucket: Untuk menentukan class Bucket.
• Mode update instance: Menentukan jenis update instance yang ditentukan untuk bucket metadata:
  1. Penggantian Instance: Instance yang ada diganti dengan instance terbaru yang diterima dari edge, meskipun tidak lengkap.
  2. Penggabungan Instance: Instance yang ada digabungkan dengan instance terbaru yang diterima dari edge. Hanya atribut yang ada dalam instance tepi baru yang diganti.
• Skema JSON: JSON Schema yang menentukan struktur bucket. Harus berupa Skema yang valid. Semua instance metadata divalidasi terhadap skema bucket.

Berikut adalah contoh JSON Schema bucket metadata default yang disediakan oleh paket konfigurasi default:

{
  "$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
}