Criar um bucket de metadados

Este guia descreve como criar um bucket de metadados. É possível criar um bucket de metadados usando a API Configuration ou a interface da Web do Manufacturing Data Engine (MDE).

Antes de começar

Antes de criar um bucket, leia a seção Como modelar metadados na documentação do MDE.

Nomenclatura de buckets

Ao criar um bucket, o nome precisa ser exclusivo em uma implantação do MDE. Os nomes de buckets não podem conter espaços ou caracteres especiais, como &, @ ou %.

Criar um bucket de metadados

É possível criar um bucket de metadados usando o terminal ou a interface do console.

REST

Execute a seguinte solicitação da API REST:

POST /metadata/v1/buckets

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

Substitua:

• BUCKET_NAME: o nome do bucket a ser criado.
• BUCKET_TYPE: o tipo de bucket a ser criado. Precisa ser TAG, RECORD ou LOOKUP. O natural_key de uma instância de metadados em um bucket TAG precisa ser um nome de tag. O natural_key de uma instância de metadados em um bucket RECORD pode ser qualquer chave. O natural_key de uma instância de metadados em um bucket LOOKUP pode ser qualquer chave, mas os registros não podem referenciar instâncias em um bucket de pesquisa, e as instâncias não são gravadas em nenhum coletor de dados. Os intervalos de pesquisa servem apenas como fonte de dados de referência que podem ser recuperados pelo analisador usando a função lookupByKey do Whistle e usados para enriquecer registros.
• BUCKET_SCHEMA: o esquema JSON do bucket. O esquema restringe as instâncias que podem ser criadas no bucket.
• INSTANCE_OVERWRITE_MODE: TRUE ou FALSE. Determina se novas instâncias são criadas mesclando a instância fornecida com a mais recente para uma determinada chave natural ou se novas instâncias são criadas conforme fornecidas.

Console

Para adicionar um novo bucket de metadados usando o console, clique na seção METADADOS do menu superior da seção Gerenciamento na nuvem. A página de configuração Metadados lista os buckets disponíveis na instância do MDE:

Para cada Bucket, as seguintes informações são fornecidas:

• Nome: o nome do bucket. Cada nome precisa ser exclusivo.
• Versão: a versão do bucket. Por padrão, apenas a versão mais recente disponível é mostrada. Para mostrar versões anteriores, desmarque a caixa de seleção "Somente a mais recente".
• Tipo de agrupamento: mostra o tipo de agrupamento. Três tipos diferentes de intervalos são compatíveis:
  1. Tag: buckets que qualificam uma determinada tag. Elas são associadas a um tipo e herdadas por todas as tags desse tipo. Elas podem ser instanciadas no nível da tag, já que qualificam a variável em si, e não registros específicos dela. Um exemplo de um bucket de tag pode ser a "Hierarquia de recursos" ou as "Unidades de medida" da tag.
  2. Registro: os buckets de registro qualificam cada um dos registros de uma determinada tag. Elas também são associadas a um tipo e herdadas pela tag, mas são instanciadas no nível do registro. Cada registro precisa ter um valor diferente em um conjunto limitado de instâncias de bucket. Um exemplo de agrupamento por registros pode ser "Turno" ou "Nome do operador".
  3. Referência: buckets que definem um conjunto de pares de chave-valor entre uma chave definida pelo usuário e uma instância.

Para criar um novo intervalo, clique em Adicionar novo intervalo de metadados:

Preencha o formulário exibido no painel lateral com os parâmetros necessários de "Bucket":

• Nome do bucket: um nome exclusivo definido pelo usuário para o bucket.
• Tipo de agrupamento: para definir a classe "Bucket".
• Modo de atualização da instância: especifica o tipo de atualizações de instância especificadas para o bucket de metadados:
  1. Substituição de instância: a instância atual é substituída pela instância mais recente recebida da borda, mesmo que esteja incompleta.
  2. Mesclagem de instâncias: a instância atual é mesclada com a mais recente recebida da borda. Somente os atributos contidos na nova instância de aresta são substituídos.
• Esquema JSON: o JSON Schema que define a estrutura do bucket. Precisa ser um esquema válido. Todas as instâncias de metadados são validadas em relação ao esquema do bucket.

Confira a seguir um exemplo de JSON Schema de um bucket de metadados padrão fornecido pelo pacote de configuração padrão:

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