Dicionário de dados

O dicionário de dados da Kruzer é uma estrutura essencial que organiza e define as entidades de domínio utilizadas na plataforma. Ele desempenha um papel crucial na gestão dos atributos dos dados, especificando o tipo e a estrutura de cada atributo, bem como os comportamentos e características adicionais que podem influenciar como os dados são manipulados e utilizados.

Componentes do Dicionário de Dados

1. Tipos de Atributos

   O dicionário de dados define o tipo de cada atributo, como texto, número, data, entre outros. Isso garante que os dados sejam corretamente interpretados, parseados e armazenados conforme seu tipo especificado.

   Tipo	Descrição
   ID	Esse tipo parseia automaticamente os dados informados para um ObjectID do MongoDB, permitindo que inserções e pesquisas sejam corretamente aplicados.
   Bool	teste
   Date	Esse tipo parseia automaticamente strings no formato de datas para o tipo Date do NodeJS, realizando validações e verificações em atualizações e pesquisas.
   Enum	Esse tipo é utilizado para uma lista de opções pré estabelecida, onde apenas dados enumerados podem ser inseridos na base de dados.
   Text	teste
   Number	teste
   Decimal	teste
   Array	Permite a definição de atributos que são listas ou arrays de valores, suportando a inclusão de múltiplos itens de um mesmo tipo.
   Object	Permite a definição de atributos que são objetos compostos por vários campos, cada um com seu próprio tipo e estrutura.
   Translate	Assim como Object, o Translate é um objeto, porém com apenas um nível de profundidade e com chaves enumeradas para cada idioma suportado pela plataforma. Esse tipo auxilia no cadastramento de dados com traduções, além de habilitar funcionalidade de tradução de dados automatica.

2. Flags e Comportamentos

   • searchable: Indica que o atributo deve ser incluído na indexação para pesquisas, permitindo que ele seja pesquisado por termos específicos.
   • optional: Especifica que o atributo não é obrigatório, podendo ser omitido em alguns registros.
   • enum: Define um conjunto restrito de valores permitidos para o atributo, garantindo que apenas valores válidos sejam aceitos.
   • min: Define o valor mínimo permitido para atributos numéricos ou de data, garantindo que o valor esteja dentro de um intervalo aceitável.
   • max: Define o valor máximo permitido para atributos numéricos ou de data, garantindo que o valor não exceda um limite especificado.

Para garantir que os dados atendam completamente ao domínio de cada módulo, o dicionário de dados é especificado de forma individual dentro de cada módulo. Desta forma, a mesma entidade pode existir em diferentes módulos, mas com uma estrutura adaptada que melhor atende às necessidades específicas de cada módulo. Na documentação, você poderá visualizar o dicionário de dados disponível em cada módulo, permitindo uma compreensão detalhada do comportamento e das características de cada atributo, bem como suas aplicações específicas.

O dicionário de dados da Kruzer é fundamental para garantir a integridade, a consistência e a eficiência na manipulação e armazenamento dos dados, permitindo que a plataforma opere de forma eficaz e alinhada com as necessidades dos usuários e das aplicações integradas.