Metadaten-Bucket erstellen

In dieser Anleitung wird beschrieben, wie Sie einen Metadaten-Bucket erstellen. Sie können einen Metadaten-Bucket über die Configuration API oder die Web-UI von Manufacturing Data Engine (MDE) erstellen.

Hinweis

Bevor Sie einen Bucket erstellen, lesen Sie den Abschnitt Metadaten modellieren in der MDE-Dokumentation.

Bucket-Benennung

Wenn Sie einen Bucket erstellen, muss der Name in einer MDE-Bereitstellung eindeutig sein. Bucket-Namen dürfen keine Leerzeichen oder Sonderzeichen wie &, @ oder % enthalten.

Metadaten-Bucket erstellen

Sie können einen Metadaten-Bucket entweder über das Terminal oder die Console-Oberfläche erstellen.

REST

Führen Sie die folgende REST API-Anfrage aus:

POST /metadata/v1/buckets

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

Ersetzen Sie Folgendes:

  • BUCKET_NAME: Der Name des zu erstellenden Buckets.
  • BUCKET_TYPE: Der Typ des zu erstellenden Buckets. Muss einer der folgenden Werte sein: TAG, RECORD oder LOOKUP. Der natural_key einer Metadateninstanz in einem TAG-Bucket muss ein Tag-Name sein. Der natural_key einer Metadateninstanz in einem RECORD-Bucket kann ein beliebiger Schlüssel sein. Der natural_key einer Metadateninstanz in einem LOOKUP-Bucket kann ein beliebiger Schlüssel sein. Auf Instanzen in einem Lookup-Bucket kann jedoch nicht verwiesen werden und die Instanzen werden nicht in eine Datensenke geschrieben. Lookup-Buckets dienen nur als Quelle für Referenzdaten, die vom Parser mit der Whistle-Funktion lookupByKey abgerufen und zum Anreichern von Datensätzen verwendet werden können.
  • BUCKET_SCHEMA: Das JSON-Schema des Buckets. Das Schema schränkt die Instanzen ein, die im Bucket erstellt werden können.
  • INSTANCE_OVERWRITE_MODE: Entweder TRUE oder FALSE. Bestimmt, ob neue Instanzen erstellt werden, indem die bereitgestellte Instanz mit der neuesten Instanz für einen bestimmten natürlichen Schlüssel zusammengeführt wird, oder ob neue Instanzen wie bereitgestellt erstellt werden.

Console

Wenn Sie über die Console einen neuen Metadaten-Bucket hinzufügen möchten, klicken Sie im oberen Menü des Bereichs Cloud Management auf METADATA. Auf der Konfigurationsseite Metadaten werden die verfügbaren Buckets in der MDE-Instanz aufgeführt:

Abschnitt „Typen“ – Liste mit Metadaten

Für jeden Bucket werden die folgenden Informationen bereitgestellt:

  • Name: Der Name des Buckets. Jeder Name muss eindeutig sein.
  • Version: Die Version des Buckets. Standardmäßig wird nur die neueste verfügbare Version angezeigt. Wenn Sie frühere Versionen anzeigen möchten, deaktivieren Sie das Kästchen „Nur neueste“.
  • Bucket-Typ: Visualisiert den Typ des Buckets. Es werden drei verschiedene Bucket-Typen unterstützt:
    1. Tag: Buckets, die ein bestimmtes Tag qualifizieren. Sie sind einem Typ zugeordnet und werden von allen Tags dieses Typs übernommen. Sie können auf Tag-Ebene instanziiert werden, da sie die Variable selbst und nicht einen ihrer spezifischen Datensätze qualifizieren sollen. Ein Beispiel für einen Tag-Bucket ist die „Asset-Hierarchie“ oder die „Maßeinheiten“ des Tags.
    2. Datensatz: Datensatz-Buckets qualifizieren jeden Datensatz eines bestimmten Tags. Sie sind auch einem Typ zugeordnet und werden vom Tag übernommen, werden aber auf Datensatzebene instanziiert. Jeder Datensatz muss einen anderen Wert aus einer begrenzten Anzahl von Bucket-Instanzen haben. Ein Beispiel für einen Datensatz-Bucket ist die „Schicht“ oder der „Name des Bedieners“.
    3. Referenz: Buckets, die eine Reihe von Schlüssel/Wert-Paaren zwischen einem benutzerdefinierten Schlüssel und einer Instanz definieren.

Wenn Sie einen neuen Bucket erstellen möchten, klicken Sie auf Neuen Metadaten-Bucket hinzufügen:

Abschnitt „Typen“ – Liste der Typen

Füllen Sie das Formular aus, das in der Seitenleiste mit den erforderlichen Bucket-Parametern angezeigt wird:

  • Bucket-Name: Ein eindeutiger, benutzerdefinierter Name für den Bucket.
  • Bucket-Typ: Zum Definieren der Bucket-Klasse.
  • Modus für Instanzaktualisierung: Gibt den Typ der Instanzaktualisierungen an, die für den Metadaten-Bucket angegeben wurden:
    1. Instanz überschreiben: Die vorhandene Instanz wird durch die neueste Instanz ersetzt, die vom Edge empfangen wurde, auch wenn sie unvollständig ist.
    2. Instanz zusammenführen: Die vorhandene Instanz wird mit der neuesten Instanz zusammengeführt, die vom Edge empfangen wurde. Nur die Attribute, die in der neuen Edge-Instanz enthalten sind, werden ersetzt.
  • JSON-Schema: Das JSON Schema, das die Struktur des Buckets definiert. Muss ein gültiges Schema sein. Alle Metadateninstanzen werden anhand des Bucket-Schemas validiert.

Das folgende Beispiel zeigt ein JSON Schema eines Standard-Metadaten-Buckets das vom Standardkonfigurationspaket bereitgestellt wird:

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