Manual de Integração de Dados

Padrões técnicos de sincronização de dados

Versão 1.0
Novembro 2019
 Página 2 de 8

Índice

1. Considerações Iniciais ................................................................................. 3

1.1. Objetivos do Projeto .................................................................................... 3

1.2. Descrição Simplificada do Modelo Operacional ........................................... 3

2. Arquitetura de Comunicação com o cliente ................................................. 4

2.1. Modelo Conceitual ....................................................................................... 4

2.2. Dados consumidos do servidor do cliente ................................................... 5

2.3. Dados inseridos/atualizados no cliente ........................................................ 7

2.4. Segurança de acesso e desempenho ......................................................... 7

2.5. Outras opções de integração ....................................................................... 8

11 32302148 | contato@swsoft.com.br
R. Santa Cruz, 541 – Vila Mariana, São Paulo – SP, 04120-080
 Página 3 de 8

1. Considerações Iniciais
1.1. Objetivos do Projeto

O projeto de integração de dados com a SwSoft tem como objetivo a

implantação de uma interface de conversação entre os servidores da SwSoft
com o servidor de dados do cliente para utilização do Software Gestão Max por
parte dos clientes.
Ao longo deste documento são descritos os processos utilizados e os
dados que serão sincronizados e tratados dentro dos servidores da SWSoft afim
de reunir as informações necessárias para que o Gestão Max seja capaz de criar
painéis, visões, dashboards, análises e estabelecer previsões que estarão
disponíveis na plataforma com acesso controlado por usuário e senha dos
clientes integrados.

1.2. Descrição Simplificada do Modelo Operacional

A Swsoft disponibiliza para cada cliente uma base de dados única que
contém todas as informações necessárias para o funcionamento do software
Gestão Max. Para cada base de dados são criados comandos de sincronização
responsáveis por realizar requisições e consumir os retornos da base de dados
do cliente. Estes comandos são controlados por um serviço instalado nos
servidores da Swsoft ou no servidor local do cliente que define os parâmetros da
consulta e a hora que estes comandos serão executados.
Uma vez executado, o comando de sincronização faz uma requisição
para o servidor do cliente.
O retorno da requisição é processado nos servidores da SWSoft e a
informação é tratada para ser inserida na base da dados do cliente na SWSoft.

11 32302148 | contato@swsoft.com.br
R. Santa Cruz, 541 – Vila Mariana, São Paulo – SP, 04120-080
 Página 4 de 8

2. Arquitetura de Comunicação com o cliente

2.1. Modelo Conceitual

A SWSoft irá disponibilizar uma base de dados única para cada cliente
integrado.
Nesta base de dados estarão contidas todas as informações necessárias
para o funcionamento do software Gestão Max, assim como as informações
necessárias para a sincronização dos dados:
 Hora de início para sincronização dos dados;
Define a hora do dia que a sincronização dos dados terá
início, dependendo do projeto do cliente pode ser necessário sincronizar os
dados mais de uma vez ao dia.
 Data e hora da última sincronização bem-sucedida;
Armazena a data e hora da última sincronização de dados
bem-sucedida entre a base de dados do cliente e os servidores da SWSoft. Esta
data servirá de parâmetro nas próximas sincronizações para que não haja
consumo excessivo dos servidores da SWSoft e do cliente. Dependendo do
projeto com o cliente, esses dados podem ser consumidos mais de uma vez ao
dia, porém, nas vezes em que isso ocorrer, os dados ficam restritos ao dia que
está sendo executado, não podendo sincronizar um histórico maior para que não
prejudique o funcionamento do sistema do cliente e da SWSoft.
 Comandos de sincronização;
Os comandos de sincronização são responsáveis por fazer
as requisições ao servidor do cliente que neles estiverem cadastradas. Estes
mesmos comandos devem conter os scripts necessários para tratar os retornos
das requisições realizadas.
A Swsoft irá disponibilizar também, um serviço instalado em seus
servidores/ou no servidor do cliente que será responsável por controlar o
momento em que os comandos de sincronização deverão ser executados,
obedecendo as configurações estabelecidas em cada base de dados.
No momento em que os comandos de sincronização são liberados para
execução, este serviço irá lançar uma aplicação em back-end, executada nos
servidores da SWSoft ou no servidor do cliente que irá executar em lote todos
os comandos de sincronização cadastrados e ativos na base dados do cliente
junto à SWSoft.
Cada comando possui parâmetros e condicionais para que a informação
seja filtrada, evitando o processamento excessivo dos servidores da SwSoft e do
cliente. Com posse desta listagem, este executável que está sendo processado
nos servidores da SWSoft decide quais as informações que serão necessárias
para inserir ou atualizar os dados na base de dados do cliente na SWSoft. Os

11 32302148 | contato@swsoft.com.br
R. Santa Cruz, 541 – Vila Mariana, São Paulo – SP, 04120-080
 Página 5 de 8

parâmetros para esta tomada de decisão também estão contidos no cadastro do

comando de sincronização que está sendo executado.
Este processo é repetido para todos os comandos de sincronização
cadastrados na base de dados do cliente.
O fluxograma a seguir ilustra o modelo conceitual descrito:

2.2. Dados consumidos do servidor do cliente

Pedidos
Número do Pedido
Data do Pedido
Hora do Pedido
Vendedor (Nome ou um Código)
Cliente (Razão/Fantasia ou CPF/CNPJ ou um Código)
Total da Venda
Total de Desconto
Valor de frete no Pedido

Itens do Pedido
Número da Venda
CFOP do Item
Código do Item
Descrição do Item
Qtde do Item no Pedido
Valor Unitário do Item
Desconto (Porcentagem ou Valor)

11 32302148 | contato@swsoft.com.br
R. Santa Cruz, 541 – Vila Mariana, São Paulo – SP, 04120-080
 Página 6 de 8

Unidade de medida do produto na venda

Valor de Custo do Item

Clientes
Código
Razão
Fantasia
CPF/CNPJ
RG/IE
Vendedor
Endereco
Complemento
Bairro
Cidade
UF
CEP
Número do Endereço
País
EMAIL
Telefone
Contato

Produtos
Código
Descrição
Preço de Venda
Preço de Custo
Grupo
Sub-Grupo
Marca

11 32302148 | contato@swsoft.com.br
R. Santa Cruz, 541 – Vila Mariana, São Paulo – SP, 04120-080
 Página 7 de 8

Vendedores
Código
Nome
E-mail

Caso não seja possível disponibilizar alguns desses dados, por favor
informe-nos para verificarmos se a informação é realmente relevante para o
cliente. Pois se não for relevante para o uso do cliente, não é necessário a
sincronização do dado.

2.3. Dados inseridos/atualizados n o cliente

O software de BI da SWSoft não insere ou atualiza informações na

base de dados do cliente, apenas faz leitura das informações.
O software de CRM da SWSoft é capaz de inserir informações na base
de dados do cliente, porém esse processo é controlado e homologado junto ao
cliente e ao ERP para que não haja problemas de integridade dos dados na
base do cliente. Pode-se fazer também uma base intermediária para inclusão
dos dados onde o ERP fica responsável por consumir a informação, evitando
que a base de dados do cliente seja alterada diretamente.

2.4. Segurança de acesso e desempenho

A SwSoft só precisa de acesso à leitura de informações. Pode ser

disponibilizado um usuário que tenha somente leitura de informações e que
inclusive possa ter um limite de linhas para retorno das querys. Assim como
pode ter um usuário com acesso de leitura específica para determinadas
entidades, a SWSoft não precisa de acesso ao banco de dados inteiro.
Caso seja implantado o módulo de CRM, o processo de inclusão de
dados na base do cliente é avaliado e homologado junto ao cliente e ao ERP.
A SWSoft possui controle de consumo excessivo para que não o
servidor do cliente não seja sobrecarregado no momento da sincronização.
Caso seja detectado um query com lentidão, ou com parâmetros muito altos, o
processo é interrompido até que ela seja corrigida.
A parametrização é feita pela média de execução de cada comando a
ser executado. Caso o comando comece a apresentar um tempo de resposta
maior que a média das sincronizações anteriores, ele é revisto para adaptar à
um melhor desempenho.

11 32302148 | contato@swsoft.com.br
R. Santa Cruz, 541 – Vila Mariana, São Paulo – SP, 04120-080
 Página 8 de 8

2.5. Outras opções de integração

Além da opção de conexão direta ao banco de dados, a SwSoft

também trabalha com modelo de integração via API de dados, protegida por
token de integração ou autenticação OAuth.
Conexão direta à um banco de dados intermediário que contenha as
informações necessárias para integração.
Ou leitura de arquivos XML, XLS, CSV ou JSON de dados
disponibilizados em um determinado diretório.
A instalação do serviço de sincronização pode ser feita nos servidores
da SWSoft, caso o servidor do cliente possua acesso externo, ou diretamente
no servidor do cliente, caso a base seja protegida para somente o acesso local.

11 32302148 | contato@swsoft.com.br
R. Santa Cruz, 541 – Vila Mariana, São Paulo – SP, 04120-080