Crea un bucket de metadatos

En esta guía, se describe cómo crear un bucket de metadatos. Puedes crear un bucket de metadatos con la API de Configuration o la interfaz web de Manufacturing Data Engine (MDE).

Antes de comenzar

Antes de comenzar a crear un bucket, lee la sección sobre cómo modelar metadatos en la documentación del MDE.

Nombres de buckets

Cuando creas un bucket, el nombre debe ser único en una implementación de MDE. Los nombres de los buckets no deben contener espacios ni caracteres especiales, como &, @ o %.

Crea un bucket de metadatos

Puedes crear un bucket de metadatos con la interfaz de la terminal o de la consola.

REST

Ejecuta la siguiente solicitud a la API de REST:

POST /metadata/v1/buckets

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

Reemplaza lo siguiente:

• BUCKET_NAME: Es el nombre del bucket que se creará.
• BUCKET_TYPE: Es el tipo de bucket que se creará. Debe ser TAG, RECORD o LOOKUP. El natural_key de una instancia de metadatos en un bucket TAG debe ser un nombre de etiqueta. El natural_key de una instancia de metadatos en un bucket de RECORD puede ser cualquier clave. El natural_key de una instancia de metadatos en un bucket de LOOKUP puede ser cualquier clave, pero los registros no pueden hacer referencia a instancias en un bucket de búsqueda, y las instancias no se escriben en ningún receptor de datos. Los buckets de búsqueda solo sirven como fuente de datos de referencia que el analizador puede recuperar con la función de Whistle lookupByKey y que se usa para enriquecer los registros.
• BUCKET_SCHEMA: Es el esquema JSON del bucket. El esquema restringe las instancias que se pueden crear en el bucket.
• INSTANCE_OVERWRITE_MODE por TRUE o FALSE. Determina si se crean instancias nuevas combinando la instancia proporcionada con la instancia más reciente para una clave natural determinada o si se crean instancias nuevas según lo proporcionado.

Console

Para agregar un nuevo bucket de metadatos con la consola, haz clic en la sección METADATOS del menú superior de la sección Administración de Cloud. En la página de configuración de Metadata, se enumeran los buckets disponibles en la instancia de MDE:

Para cada bucket, se proporciona la siguiente información:

• Nombre: Es el nombre del bucket. Cada nombre debe ser único.
• Versión: Es la versión del bucket. De forma predeterminada, solo se muestra la versión más reciente disponible. Para mostrar versiones anteriores, desmarca la casilla de verificación "Solo la más reciente".
• Tipo de bucket: Visualiza el tipo de bucket. Se admiten tres tipos de bucket diferentes:
  1. Etiqueta: Son los buckets que califican una etiqueta determinada. Se asocian a un tipo y las heredan todas las etiquetas de ese tipo determinado. Se pueden crear instancias a nivel de la etiqueta, ya que tienen como objetivo calificar la variable en sí y no ninguno de sus registros específicos. Un ejemplo de un bucket de etiquetas podría ser la "Jerarquía de activos" o las "Unidades de medida" de la etiqueta.
  2. Registro: Los buckets de registros califican cada uno de los registros de una etiqueta determinada. También se asocian a un tipo y la etiqueta los hereda, pero se crean instancias a nivel del registro. Se espera que cada registro tenga un valor diferente entre un conjunto limitado de instancias de Bucket. Un ejemplo de Record Bucket podría ser "Turno" o "Nombre del operador".
  3. Referencia: Son discretizaciones que definen un conjunto de pares clave-valor entre una clave definida por el usuario y una instancia.

Para crear un bucket nuevo, haz clic en Agregar un bucket de metadatos nuevo:

Completa el formulario que se muestra en el panel lateral con los parámetros de Bucket necesarios:

• Nombre del bucket: Es un nombre único definido por el usuario para el bucket.
• Tipo de discretización: Para definir la clase Bucket
• Modo de actualización de la instancia: Especifica el tipo de actualizaciones de instancias que se especifican para el bucket de metadatos:
  1. Invalidación de instancia: La instancia existente se reemplaza por la instancia más reciente recibida desde el borde, incluso si está incompleta.
  2. Combinación de instancias: La instancia existente se combina con la instancia más reciente recibida del borde. Solo se reemplazan los atributos contenidos en la nueva instancia de borde.
• Esquema JSON: Es el JSON Schema que define la estructura del bucket. Debe ser un esquema válido. Todas las instancias de metadatos se validan según el esquema del bucket.

A continuación, se muestra un ejemplo de JSON Schema de un bucket de metadatos predeterminado que proporciona el paquete de configuración predeterminado:

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