Criar entidade de dados

Clientes

Débora Ferreira

Débora Ferreira

Última atualização

Entidade de dados é uma representação de um conjunto de informações sobre um determinado conceito. Toda entidade possui campos, que são as informações que formam as entidades.

Para exemplificar, imagine um sistema de controle de uma biblioteca. Esse sistema controla livros que podem ser alugados por clientes. Então, percebemos que esses 3 conceitos (livro, cliente, aluguel) são entidades que possuem informações sobre cada uma delas. Entidade de dados, portanto, é um grupo de informações sobre determinado conceito.

Com esses conceitos, é possível configurar os mais diversos cenários de controle de dados pelo Master Data. Por padrão, são inseridos as seguintes entidades de dados: Cliente, Endereço, Stores etc. É possível criar quantas mais entidades de dados desejar, possibilitando um ambiente personalizado, voltado às necessidade de cada loja.

Entendendo os tipos

Antes do passo a passo de configuração, é preciso esclarecer os tipos de dados que serão utilizados na configuração. A entidade de dados é composta por campos que, por sua vez, têm um tipo. Esse tipo identifica quais as características das informações que serão armazenadas no campo e realiza validações, filtros e cálculos de acordo com o valor selecionado.

Na criação de um campo, são exibidos os tipos listados abaixo, juntamente com seu significado.

  • Relationship: É o tipo de campo para relacionamento com outra entidade. Como relacionamento, entende-se a informação de uma entidade sendo exibida em outra entidade. Por exemplo, usando o caso da biblioteca, pode-se desejar que o nome do Cliente apareça no registro de Aluguel. Para isso, basta fazer um relacionamento entre Aluguel e Cliente, usando o campo nome cadastrado em Aluguel, selecionando o tipo Relationship, dentro da configuração, deve ser selecionado o campo de Cliente que deseja exibir, logo, deve-se selecionar também o campo nome.
  • User Login: É o tipo de campo que seleciona automaticamente o usuário logado. É utilizado para cenários em que se deseja registrar o e-mail do usuário que realizar ação em um registro da entidade.
  • Integer: É o tipo que armazena números inteiros, ou seja, números sem a parte fracionária. Armazena os números inteiros entre -2147483648 e 2147483647.
  • Long: É o mesmo tipo que integer, porém, com possibilidade de armazenar mais números. Armazena de -263 a 263-1.
  • Date: É o tipo que armazena informações sobre data.
  • Time: É o tipo que armazena informações sobre hora.
  • Date and Time: É o tipo que armazena data e hora.
  • Percent: É o tipo que armazena informações em percentual.
  • Currency: É o tipo que armazena informações no formato de moeda.
  • Decimal: É o tipo que armazena números com a parte fracionária sempre configurada para 2. Ou seja, este campo armazena sempre 2 dígitos como decimais do valor inserido.
  • URL: É o tipo que armazena uma URL.
  • Email: É o tipo que armazena um Email.
  • CEP: É o tipo que armazena um CEP.
  • Varchar 10: É o tipo que armaneza números, letras e caracteres especiais. Neste caso, limita o número de dígitos em 10.
  • Varchar 50: É o tipo que armaneza números, letras e caracteres especiais. Neste caso, limita o número de dígitos em 50.
  • Varchar 100: É o tipo que armaneza números, letras e caracteres especiais. Neste caso, limita o número de dígitos em 100.
  • Varchar 750: É o tipo que armaneza números, letras e caracteres especiais. Neste caso, limita o número de dígitos em 750.
  • Text: É o tipo que armaneza números, letras e caracteres especiais. Neste caso, não existe limitação de caractetes.
  • Boolean: É o tipo que armazena informação de verdadeiro ou falso. Sempre deve haver um valor padrão para o campo, ou seja, ele sempre estará preenchido como verdadeiro ou falso.
  • Auto Increment: É o tipo que armazena números inteiros e que é incrementado automaticamente, ou seja, a cada novo registro, esse campo recebe o valor do registro anterior + 1.
  • Telephone: É o tipo que armazena informações no formato de telefone.
  • Tag: Tipo descontinuado.
  • Score2: Campo composto por chave, valor e validade. Ex.: Uma possibilidade e uso é para controle de compra por cliente, guardando quanto o cliente comprou e quantas compras foram feitas. Este campo só pode ser preenchido por API.
  • File: É o tipo que armazena um arquivo. O tamanho limite a ser aceito deve ser configurado nas opções do campo (botão com símbolo de engrenagem).
  • Flow: Tipo descontinuado.
  • Tag Reference: Tipo descontinuado.
  • CPF / CNPJ: É o tipo que armazena informações de CPF e CNPJ.

Como configurar

  1. Acesse o DynamicStorage, através da url: SUALOJA.ds.vtexcrm.com.br, alterando o valor SUALOJA pelo account name da loja;
  2. Clique na aba Entidade de dados;
  3. Clique no botão Novo;
  4. Preencha o campo sigla com 2 letras que identifiquem a entidade de dados. Essas letras serão as iniciais do campo identificador do registro. Ex.: Sigla SP, identificador SP-0001;
  5. Preencha o nome da entidade de dados que deseja criar;
  6. Selecione o tipo de chave primária, que pode ser uma das seguintes opções: GUID: é uma sequência de números e caracteres que não se repete e identifica um registro; Sequencial numérico: é uma sequência numérica que não se repete e identifica um registro; A chave primária será informada pelo cliente através do atributo “id”: não cria automaticamente um campo identificador, este campo deve ser criado manualmente e deve ser dado o nome de id;
  7. A flag permitir consultar todos os registros sem filtro deve ser marcada quando é preciso consultar os registros sem filtro e sem autenticação. Lembre-se! Esta configuração é muito crítica porque permite que via API possam ser listados todos os registros da base.
  8. Preencha a aba Campos com os campos que os valores não serão calculados automaticamente;
  9. Preencha a coluna Nome com o valor de identificação do campo. Não é permitido a inserção de espaço nem caracteres especiais. Ex.: nomeDoCliente;
  10. Preencha a coluna Nome de exibição com o valor que será exibido no formulário. Ex.: Nome do Cliente;
  11. Selecione o tipo do campo, de acordo com as opções descritas na área entendendo os tipos;
  12. Clique sobre o símbolo de engrenagem para abrir as opções de configuração;
  13. Selecione permitir nulo caso seja possível a criação ou edição de um registro com o campo em branco. Caso essa opção fique desmarcada, não será possível criar um registro com o campo sem algum valor;
  14. Selecione auditado se o campo deve ser salvo na histórico de alterações do formulário;
  15. Selecione público para leitura se, pela API, for possível realizar a leitura dos dados desse campos sem a necessidade de autenticação;
  16. Selecione público para escrita se, pela API, for possível realizar a inserção de dados nesse campo sem a necessidade de autenticação;
  17. Selecione público para filtrar se, pela API, for possível realizar o filtro de dados desse campo sem a necessidade de autenticação;
  18. Selecione é buscável se esse campo for utilizado para busca no formulário e por API;
  19. Selecione é filtro se esse campo for utilizado para filtro no formulário e por API;
  20. Preencha a descrição do campo;
  21. Acesse a aba Campos Automáticos para a configuração de campos em que os valores serão calculados automaticamente;
  22. A configuração se dá da mesma maneira que a configuração de um campo não automático, com a exceção da área Edição da fórmula, que deve ser preenchida com o código em C# que fará a lógica de cálculo do campo. Como auxílio, é possível utilizar as expressões dinâmicas, que inserem valores de outros campos no código. Além disso, é necessário selecionar em que momento o cálculo será executado;
  23. Para inserir mais campos, basta clicar no botão Novo campo ou Novo campo calculado;
  24. Ao final da configuração, clique no botão Salvar ou Salvar e novo (para seguir para a criação de uma nova entidade de dados);
  25. Clique no botão com símbolo de disquete para publicar a entidade de dados criada ou alterada.

Após a criação da entidade de dados, é necessário criar o formulário para a inserção, alteração e exibição de dados em seu ambiente Master Data.