View padrão de banco de dados
Consiste na criação um view no banco de dados seguindo exatamente uma estrutura padrão da Dito, com o mesmo nome de campos e do objeto, retornando o conteúdo esperado.
IMPORTANTE: A documentação abaixo orienta sobre a criação de views previamente validadas pela Dito, porém a responsabilidade pela manutenção e possíveis alterações não são responsabilidade da Dito, visamos compartilhar este documento com objetivo de auxiliar, mas a responsabilidade por disponibilização dos dados para integração é da própria marca.
- Tipo de integração: Offline Padronizada - View
- ERP: Todos
- Fonte de dados/Extrator: View - Banco de dados
- VPN: site-to-site ou liberação por IP
- Dados integrados: Consumidores, Transações e Vendedores
Plano de tracking:
A estrutura dos dados que serão enviados é padronizada neste tipo de integração. Não é possível alterar ou desconsiderar os dados existentes. É possível incluir novos dados através de informações adicionais customizadas.
O plano de tracking, contendo a estrutura utilizada, pode ser solicitado ao time Dito.
Caso haja necessidade de alterar os dados que estão no plano de tracking, é necessário que seja utilizada uma integração customizada.
Atividades técnicas:
1. Criar as Views no formato padrão
Esta integração necessita que o cliente adeque a estrutura de dados do sistema de origem (ERP) utilizado para seguir um padrão de informações requerido pela Dito.
É necessário criar uma view com o mesmo nome, estrutura e nomenclatura e dos campos.
É possível considerar dados adicionais, além dos padrões, incluindo campos com o prefixo “data_“ na view.
A estrutura das views está descrita abaixo:
Pessoas
- Nome da view:
dito_crm_pessoas - Objetivo: Cadastrar as pessoas contendo as suas características.
Impacto no produto: Este cadastro é a base para o funcionamento do produto, disponibilizando os dados das pessoas que podem ser impactadas através das comunicações da marca. Todos os dados enviados neste cadastro poderão ser utilizados na segmentação do público-alvo para utilização dos canais da Dito.
Estrutura:
- Campos padrões (obrigatórios):
| Título | Nome do campo | Formato | Conteúdo esperado |
|---|---|---|---|
| Código do consumidor | id | Texto (CPF ou e-mail) | 09909909909 |
| CPF/CNPJ | cpf_cnpj | Texto (11 dígitos para CPF e 14 dígitos para CNPJ - apenas números) | 09909909909 |
| Nome | name | Texto | João da Silva |
| Texto ([email protected]) | [email protected] | ||
| Telefone | phone | Texto (DD+Número - só números) | 31988887777 |
| Gênero | gender | M para masculino F para feminino | M ou F |
| Cidade | city | Texto | Belo Horizonte |
| Data de nascimento | birthday | Data (YYYY-MM-DD) | 1995-12-22 |
| Data de cadastro | created_at | Data (YYYY-MM-DD HH24:MI:SS) | 2024-07-25 10:35:29 |
| Data de modificação | updated_at | Data (YYYY-MM-DD HH24:MI:SS) | 2024-07-25 10:35:29 |
- Campos adicionais (conforme necessidade de cada cliente):
| Título | Nome do campo | Formato | Conteúdo esperado |
|---|---|---|---|
| Qualquer tipo de dado | “data_”+”nome_campo” Exemplo: data_cep | Texto, número ou data (YYYY-MM-DD HH24:MI:SS) | Qualquer tipo de dado |
Lojas e Vendedores
- Nome da view:
dito_crm_vendedores - Objetivo: Cadastrar as lojas e os vendedores.
Impacto no produto: Este cadastro será utilizado para estruturar os acessos e compor o encarteiramento das pessoas no produto Agenda.
Estrutura:
- Campos padrões (obrigatórios):
| Título | Nome do campo | Formato | Conteúdo e |
|---|---|---|---|
| Código do vendedor | seller_id | Texto O conteúdo depende se o mesmo código de vendedor se repete por loja ou não. Ex: vendedor ID 50 na loja ID 1 e vendedor ID 50 na loja ID 2. NÃO SE REPETE: usar apenas o código. SE REPETE: usar “código”+”:”+”código da loja” | 50 ou 50:1 |
| Nome do vendedor | seller_name | Texto | João da Silva |
| CPF do vendedor | seller_cpf | Texto (11 dígitos só números) | 09909909909 |
| Cargo do vendedor | seller_role | Texto VENDEDOR GERENTE | VENDEDOR ou GERENTE |
| Status do vendedor | seller_status | Texto Controla quem terá acesso ao produto Agenda. ATIVO: possui acesso ao produto. INATIVO: não possui acesso ao produto. | ATIVO ou INATIVO |
| Código da loja | store_id | Número | 1 |
| Nome da loja | store_name | Texto | LOJA 1 |
Compras/Devoluções
- Nome da view:
dito_crm_compras - Objetivo: Cadastrar as compras e as devoluções realizadas pelas pessoas consultadas através da view
dito_crm_pessoas.
Impacto no produto: Este cadastro irá gerar um comportamento (evento) de “comprou“ ou “devolveu“ para uma pessoa já cadastrada. Este comportamento será utilizado no cálculo da receita, poderá ser visualizado na ficha do consumidor, utilizado na segmentação, em jornadas, canais ou agenda como uma condição que vai resultar nas pessoas que serão impactadas pelas comunicações da marca.
Estrutura:
- Campos padrões (obrigatórios):
| Título | Nome do campo | Formato | Conteúdo esperado |
|---|---|---|---|
| Código do consumidor | customer_id | Texto (id da view de pessoas) Mesmo conteúdo do campo id da view dito_crm_pessoas. | 09909909909 |
| Código da transação | transaction_id | Número Precisa ser único, não pode se repetir. Sugerimos concatenar o código da transação com o CPF/CNPJ da pessoa, a data da transação e a loja. | 46650 |
| Tipo da transação | transaction_type | “C“ para compra “D“ para devolução | C ou D |
| Data de criação | created_at | Data (YYYY-MM-DD HH24:MI:SS) | 2024-07-25 10:35:29 |
| Código do vendedor | seller_id | Texto (seller_id da view de lojas e vendedores) Mesmo conteúdo do campo seller_id da view dito_crm_vendedores.É utilizado para atribuir uma compra a um vendedor no encarteiramento do produto Agenda. | 50 ou 50:1 |
| Nome do vendedor | seller_name | Texto (seller_name da view de lojas e vendedores) Mesmo conteúdo do campo seller_name da view dito_crm_vendedores. | JOÃO DA SILVA |
| Código da loja | store_id | Número (store_id da view de lojas e vendedores) Mesmo conteúdo do campo store_id da view dito_crm_vendedores. | 1 |
| Nome da loja | store_name | Texto (store_name da view de lojas e vendedores) Mesmo conteúdo do campo store_name da view dito_crm_vendedores. | LOJA 1 |
| Quantidade de produtos/itens | qtde_items | Número | 5 |
| Valor de desconto | vlr_desconto | Número | 5.42 |
| Valor de frete | vlr_frete | Número | 43.61 |
| Receita/Valor total | revenue | Número | 473.21 |
- Campos adicionais (conforme necessidade de cada cliente):
| Título | Nome do campo | Formato | Conteúdo esperado |
|---|---|---|---|
| Qualquer tipo de dado | “data_”+”nome_campo” Exemplo: data_cep | Texto, número ou data (YYYY-MM-DD HH24:MI:SS) | Qualquer tipo de dado |
Produtos
- Nome da view:
dito_crm_produtos - Objetivo: Cadastrar os produtos adquiridos ou devolvidos através das transações consultadas na view
dito_crm_compras.
Impacto no produto: Este cadastro irá gerar um comportamento (evento) de “comprou-produto“ ou “devolveu-produto“ para uma pessoa já cadastrada. Este comportamento poderá ser visualizado na ficha do consumidor, utilizado na segmentação, em jornadas, canais ou agenda como uma condição que vai resultar nas pessoas que serão impactadas pelas comunicações da marca.
Estrutura:
- Campos padrões (obrigatórios):
| Título | Nome do campo | Formato | Conteúdo esperado |
|---|---|---|---|
| Código do consumidor | customer_id | Texto (id da view de pessoas) Mesmo conteúdo do campo id da view dito_crm_pessoas. | 09909909909 |
| Código da transação | transaction_id | Número (transaction_id da view de compras) Mesmo conteúdo do campo transaction_id da view dito_crm_compras. | 46650 |
| Data de criação | created_at | Data (YYYY-MM-DD HH24:MI:SS) | 2024-07-25 10:35:29 |
| Código do produto | product_id | Número | 12787 |
| Código do produto para identificação no estoque SKU (Stock Keeping Unit - Unidade de Manutenção de Estoque) | product_sku | Texto | MX-CS-ALG-40-BRA |
| Nome do produto | product_name | Texto | CAMISETA DA DITO |
| Grupo/Categoria | product_category | Texto | CAMISETERIA |
| Quantidade | qtde_items | Número | 2 |
| Preço do produto | product_price | Número | 100 |
| Preço pago pelo produto | product_revenue | Número | 90 |
- Campos adicionais (conforme necessidade de cada cliente):
| Título | Nome do campo | Formato | Conteúdo esperado |
|---|---|---|---|
| Qualquer tipo de dado | “data_”+”nome_campo” Exemplo: data_cep | Texto, número ou data (YYYY-MM-DD HH24:MI:SS) | Qualquer tipo de dado |
2. Definir a forma de conexão ao ambiente
Neste tipo de integração é possível utilizar uma das duas formas de conexão ao banco de dados:
- VPN site-to-site: disponibilizar as informações que serão solicitadas pelo
time de segurança da Dito para configuração. - Liberação por IP: solicitar os dados ao time da Dito para realizar a liberação de acesso dos IPs da Dito ao banco de dados.
3. Disponibilizar os acessos
Com a forma de conexão estabelecida é necessário criar um usuário no banco de dados com acesso de consulta às views padrões criadas conforme as orientações e informar os acessos ao banco de dados para a Dito:
- Nome do banco
- Host
- Porta
- Usuário
- Senha
- Driver (SGBD)
- Driver SSL Mode (se utilizar)
- Driver options (se utilizar)
Updated 13 days ago