Creare un bucket di metadati

Questa guida descrive come creare un bucket di metadati. Puoi creare un bucket di metadati utilizzando l'API Configuration o l'interfaccia web di Manufacturing Data Engine (MDE).

Prima di iniziare

Prima di iniziare a creare un bucket, leggi la sezione su come modellare i metadati nella documentazione di MDE.

Denominazione dei bucket

Quando crei un bucket, il nome deve essere univoco in un deployment MDE. I nomi dei bucket non devono contenere spazi o caratteri speciali come &, @ o %.

Creare un bucket di metadati

Puoi creare un bucket di metadati utilizzando il terminale o l'interfaccia della console.

REST

Esegui la seguente richiesta dell'API REST:

POST /metadata/v1/buckets

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

Sostituisci quanto segue:

• BUCKET_NAME: il nome del bucket da creare.
• BUCKET_TYPE: il tipo di bucket da creare. Deve essere TAG, RECORD o LOOKUP. La natural_key di un'istanza di metadati in un bucket TAG deve essere un nome di tag. La natural_key di un'istanza di metadati in un bucket RECORD può essere qualsiasi chiave. La natural_key di un'istanza di metadati in un bucket LOOKUP può essere qualsiasi chiave, ma i record non possono fare riferimento alle istanze in un bucket di ricerca e le istanze non vengono scritte in alcun sink di dati. I bucket di ricerca fungono solo da origine di dati di riferimento che possono essere recuperati dal parser utilizzando la funzione Whistle lookupByKey e utilizzati per arricchire i record.
• BUCKET_SCHEMA: lo schema JSON del bucket. Lo schema vincola le istanze che possono essere create nel bucket.
• INSTANCE_OVERWRITE_MODE: TRUE o FALSE. Determina se le nuove istanze vengono create unendo l'istanza fornita con l'ultima istanza per una determinata chiave naturale o se le nuove istanze vengono create come fornite.

Console

Per aggiungere un nuovo bucket di metadati utilizzando la console, fai clic sulla sezione METADATI del menu in alto della sezione Gestione cloud. La pagina di configurazione Metadati elenca i bucket disponibili nell'istanza MDE:

Per ogni bucket vengono fornite le seguenti informazioni:

• Nome: il nome del bucket. Ogni nome deve essere univoco.
• Versione: la versione del bucket. Per impostazione predefinita, viene visualizzata solo l'ultima versione disponibile. Per visualizzare le versioni precedenti, deseleziona la casella di controllo "Solo ultima".
• Tipo di bucket: visualizza il tipo di bucket. Sono supportati tre tipi di bucket diversi:
  1. Tag: bucket che qualificano un determinato tag. Sono associati a un tipo e vengono ereditati da tutti i tag di quel tipo. Possono essere create a livello di tag, in quanto hanno lo scopo di qualificare la variabile stessa e non i suoi record specifici. Un esempio di bucket di tag potrebbe essere "Gerarchia degli asset" o "Unità di misura" del tag.
  2. Record: i bucket di record qualificano ciascuno dei record di un determinato tag. Sono anche associati a un tipo e vengono ereditati dal tag, ma vengono creati a livello di record. Ogni record deve avere un valore diverso in un insieme limitato di istanze di bucket. Un esempio di bucket di record potrebbe essere "Shift" o "Nome operatore".
  3. Riferimento: bucket che definiscono un insieme di coppie chiave-valore tra una chiave definita dall'utente e un'istanza.

Per creare un nuovo bucket, fai clic su Aggiungi nuovo bucket di metadati:

Compila il modulo visualizzato nel riquadro laterale con i parametri del bucket necessari:

• Nome bucket: un nome univoco definito dall'utente per il bucket.
• Tipo di bucket: per definire la classe del bucket.
• Modalità di aggiornamento dell'istanza: specifica il tipo di aggiornamenti dell'istanza specificati per il bucket di metadati:
  1. Sostituzione istanza: l'istanza esistente viene sostituita dall' ultima istanza ricevuta dall'edge, anche se è incompleta.
  2. Unione istanze: l'istanza esistente viene unita all'ultima istanza ricevuta dall'edge. Vengono sostituiti solo gli attributi contenuti nella nuova istanza edge.
• Schema JSON: lo JSON Schema che definisce la struttura del bucket. Deve essere uno schema valido. Tutte le istanze di metadati vengono convalidate rispetto allo schema del bucket.

Di seguito è riportato un esempio di JSON Schema di un bucket di metadati predefinito fornito dal pacchetto di configurazione predefinito:

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