Créer un bucket de métadonnées

Ce guide explique comment créer un bucket de métadonnées. Vous pouvez créer un bucket de métadonnées à l'aide de l'API Configuration ou de l'interface Web Manufacturing Data Engine (MDE).

Avant de commencer

Avant de créer un bucket, consultez la section Modéliser les métadonnées de la documentation MDE.

Nommer les buckets

Lorsque vous créez un bucket, son nom doit être unique dans un déploiement MDE. Les noms de buckets ne doivent pas contenir d'espaces ni de caractères spéciaux tels que &, @ ou %.

Créer un bucket de métadonnées

Vous pouvez créer un bucket de métadonnées à l'aide du terminal ou de l'interface de la console.

REST

Exécutez la requête d'API REST suivante :

POST /metadata/v1/buckets

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

Remplacez les éléments suivants :

• BUCKET_NAME : nom du bucket à créer.
• BUCKET_TYPE : type de bucket à créer. Doit être défini sur TAG, RECORD ou LOOKUP. Le natural_key d'une instance de métadonnées dans un bucket TAG doit être un nom de tag. Le natural_key d'une instance de métadonnées dans un bucket RECORD peut être n'importe quelle clé. Le natural_key d'une instance de métadonnées dans un bucket LOOKUP peut être n'importe quelle clé, mais les enregistrements ne peuvent pas faire référence à des instances dans un bucket de recherche, et les instances ne sont écrites dans aucun récepteur de données. Les buckets de recherche ne servent que de source de données de référence pouvant être récupérées par l'analyseur à l'aide de la fonction Whistle lookupByKey et utilisées pour enrichir les enregistrements.
• BUCKET_SCHEMA : schéma JSON du bucket. Le schéma limite les instances qui peuvent être créées dans le bucket.
• INSTANCE_OVERWRITE_MODE : TRUE ou FALSE Détermine si de nouvelles instances sont créées en fusionnant l'instance fournie avec la dernière instance pour une clé naturelle donnée ou si de nouvelles instances sont créées telles qu'elles sont fournies.

Console

Pour ajouter un bucket de métadonnées à l'aide de la console, cliquez sur la section MÉTADONNÉES du menu supérieur de la section Gestion du cloud. La page de configuration Métadonnées liste les buckets disponibles dans l'instance MDE :

Pour chaque bucket, les informations suivantes sont fournies :

• Nom : nom du bucket. Chaque nom doit être unique.
• Version : version du bucket. Seule la dernière version disponible s'affiche par défaut. Pour afficher les versions antérieures, décochez la case "Dernière version uniquement".
• Type de bucket : il visualise le type de bucket. Trois types de buckets sont acceptés :
  1. Tag : buckets qui correspondent à un tag donné. Ils sont associés à un type et hérités par tous les tags de ce type. Elles peuvent être instanciées au niveau de la balise, car elles visent à qualifier la variable elle-même et non l'un de ses enregistrements spécifiques. Un exemple de bucket de tags peut être la hiérarchie des composants ou les unités de mesure du tag.
  2. Enregistrement : les buckets d'enregistrement qualifient chacun des enregistrements d'un tag donné. Ils sont également associés à un type et hérités par le tag, mais sont instanciés au niveau de l'enregistrement. Chaque enregistrement doit avoir une valeur différente parmi un ensemble limité d'instances de bucket. Par exemple, un bucket d'enregistrement peut être "Shift" (Shift) ou "Operator Name" (Nom de l'opérateur).
  3. Référence : buckets qui définissent un ensemble de paires clé/valeur entre une clé définie par l'utilisateur et une instance.

Pour créer un bucket, cliquez sur Ajouter un bucket de métadonnées :

Remplissez le formulaire affiché dans le panneau latéral avec les paramètres de bucket nécessaires :

• Nom du bucket : nom unique défini par l'utilisateur pour le bucket.
• Type de bucket : pour définir la classe Bucket.
• Mode de mise à jour de l'instance : il spécifie le type de mises à jour d'instance spécifié pour le bucket de métadonnées :
  1. Remplacer l'instance : l'instance existante est remplacée par la dernière instance reçue depuis la périphérie, même si elle est incomplète.
  2. Fusion d'instances : l'instance existante est fusionnée avec la dernière instance reçue depuis la périphérie. Seuls les attributs contenus dans la nouvelle instance d'arête sont remplacés.
• Schéma JSON : JSON Schema définissant la structure du bucket. Doit être un schéma valide. Toutes les instances de métadonnées sont validées par rapport au schéma du bucket.

Voici un exemple de JSON Schema d'un bucket de métadonnées par défaut fourni par le package de configuration par défaut :

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