...
| Table of Contents | ||||
|---|---|---|---|---|
|
Tipo de Integração
A integração OZmap-SGP é do tipo Ativa.
Descrição
O Sistema de Gerenciamento para Provedores de Internet SGP é uma ferramenta de gestão completa, com módulos do sistema integrados e prontos para sua empresa funcionar de forma organizada e otimizada, os módulos do sistema são integrados.
Dados Acesso
https://docs.google.com/forms/d/1ZrFR1QU4xM7ag_EU-whzzz-oA6es7anXZFCM1GvTn8M/edit
SGP
Dados de acesso necessários para buscar informações via API no sistema SGP. (Estes dados devem ser fornecidos no questionário inicial)
...
Parâmetro
...
Descrição
...
Exemplo
...
URL
...
Endereço do servidor SGP.
...
https://sgp.cliente.com.br
...
Token
...
Token provido pelo cliente para acessar o serviço.
...
59123456-2e1d-479a-9b49-5513b2aac54f
...
Nome do App
...
Nome que o cliente deu para a conta de serviço da integração dentro do seu serviço externo.
...
OZmap
OZmap
...
Parâmetro
...
Descrição
...
Exemplo
...
Token
...
Token associado a conta do usuário de integração cadastrado no ozmap. ( O usuário deve ter acesso aos projetos que a integração irá trabalhar (Escolha do usuário). Tutorial de como gerar usuário/chave.)
...
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtb2R1bGUiOiJhcGkiLCJ1c2VyIjoiNWQ5ZjNmYjgyMDAxNDEwMDA2NDdmNzY4IiwiY3JlYXRpb25EYXRlIjoiMjAyMC0wOC0yNFQxNjoxMjoyMS43MTdaIiwiaWF0IjoxNTk6Mjg1NTQxfQ.S215vbHlBLtZSzxmORIc2sH1lEKi5VALKBqZB1VcFCE
Liberação de IPs
Para validação e execução da integração no ambiente de produção, é necessário que sejam liberados no servidor do cliente os IPs utilizados pelo OZmap:
Servidor OZmap do cliente (ping cliente.ozmap.com.br)
54.207.162.199
Configurações Base
...
Parâmetro
...
Descrição
...
Padrão
...
Tempo entre Sincronizações
...
Tempo aguardado entre as sincronizações realizadas pela integração
...
15 minutos
Configurações Específicas - Clientes
...
Parâmetro
...
Descrição
...
Padrão
...
Cancelar Clientes Automaticamente no ERP
...
Clientes com status "Cancelado" ou "Inviabilidade Técnica" no ERP são cancelados no OZmap.
...
Desativado
...
Criar Clientes Automaticamente no OZmap
...
Clientes que existem no ERP porém não existem no OZmap serão criados no OZmap caso a caixa seja encontrada pelo nome.
...
Desativado
...
Considerar o Projeto na Criação de Novos Clientes no OZmap
...
Somente será criado o cliente no OZmap cuja o projeto da caixa OZmap tenha o nome igual ao projeto do cliente no SGP.
...
Desativado
Logs
Os logs desta integração estão disponíveis no endereço: https://<cliente>.ozmap.com.br/integrations/sgp/logspara provedores de internet, focado no controle financeiro, estoque e documentação.
As funcionalidades da integração entre OZmap e SGP se baseiam na leitura de clientes no SGP para atualização, criação e remoção de clientes no OZmap. A integração encontra os clientes SGP no OZmap através do contrato SGP.
OBS: “contrato“ no SGP deve ser igual ao “code” do cliente no OZmap para que seja encontrado.
Resumo das funcionalidades
Funcionalidade | Descrição | Direção da integração |
|---|---|---|
Atualização |
Atualiza a porta na qual o cliente se encontra cadastrado no ERP.
OZMap => SGP
Sincronização de condomínios
Criação de caixas no ERP para representar os splitters de um condomínio.
OZMap => SGP
Sincronização de dados de clientes
de Dados de Clientes | Atualização dos dados dos clientes cadastrados no OZmap, podendo incluir estado de implantação, status |
da conexão, potência, coordenadas, nome e endereço lidos no SGP. |
SGP => OZmap | ||
Atualização da Porta de Clientes | Ao trocar um cliente de porta no SGP é atualizado a porta do cliente no OZmap. | SGP => OZmap |
Cancelamento de |
Clientes |
Remoção no OZmap de clientes que se encontram cancelados no |
SGP. |
SGP = |
> OZmap |
Implantação de |
Clientes | Ativação |
(Implantar) cliente no OZmap de acordo com o status lido no SGP. | SGP => OZmap |
Criação de |
Clientes | Criação no OZmap de clientes que se encontram cadastrados no |
SGP. |
SGP |
Sincronização de caixas
Sincronização e criação de caixas que se encontram cadastradas no ERP.
=> |
//Se é do OZMap -> o serviço externo ou o contrário. Funcionalidades que tem bidirecionalidade devem ser identificadas com <->. A direcionalidade é definida por de onde está a “fonte da verdade” e para onde vai ser sincronizado.
Funcionalidades inversas
Funcionalidades marcadas como OZMap <- serviço externo.
Criação de clientes
...
OZmap |
Funcionalidades
Abaixo serão descritas as funcionalidades apresentadas no resumo de forma a entender como funciona o fluxo de sincronização.
Criação de Clientes
São buscados todos os clientes que existem no SGP, que possuam ONU e que não existem no OZmap (
...
procurando pelo código do cliente OZmap semelhante ao contrato SGP).
A partir desses clientes encontrados, é
...
analisado se ele está conectado a um splitter no SGP. (
...
Para criar no OZmap é necessário estar conectado).
...
Com o cliente possuindo um splitter e o status não está como cancelado no SGP, vamos buscar no OZmap
...
por padrão uma caixa com nome IGUAL ao nome existente no splitter do SGP, se for encontrada, criamos o cliente no OZmap com os dados necessários e conexão com a caixa.
Caso a configuração “Considerar condomínios verticais” esteja ativada, também será levado em consideração os condomínios verticais na busca no OZmap por caixa com nome IGUAL ao nome existente no splitter do SGP.
...
Caso a caixa exista no OZmap, mas não tenha splitter, o cliente é criado na caixa sem conexão.
...
Caso a caixa exista no OZmap e tenha splitter, criamos o cliente no splitter e na porta indicada
...
pelo SGP, caso essa porta esteja disponível no OZmap e o valor da porta seja compatível com a quantidade de saídas do splitter.
Caso a caixa exista no OZmap e tenha splitter no SGP mas o cliente não possua porta no SGP, criamos o cliente no primeiro splitter e na primeira porta disponível no OZmap. Porém caso a configuração “Considerar mais de um splitter na caixa OZmap” esteja ativada, o cliente não é criado.
Caso a caixa exista no OZmap e tenha splitter e a configuração “Considerar mais de um splitter na caixa OZmap” esteja ativa, será levado em consideração mais de um splitter na caixa, ou seja, será buscado em todos os splitters da caixa uma porta correspondente a indicada no SGP. Porém para que todos os splitters sejam considerados, o splitters devem ser nomeados em ordem numérica válida. Ex: Splitter 1, Splitter 2, Splitter 3, neste exemplo, caso o Splitter 2 não exista o Splitter 3 não será considerado como splitter válido.
Caso a caixa não exista no OZmap, o cliente não será criado.
Caso a configuração de considerar o nome de projeto na criação de novos clientes esteja ativa, o cliente somente será criado no OZmap caso o projeto da caixa OZmap tenha o nome igual ao nome da cidade do cliente no SGP.
Caso a configuração de “Criar clientes no OZmap com coordenadas SGP” estiver ativada e, as coordenadas do endereço do cliente estiverem preenchidas no SGP, ao criar o novo cliente no OZmap, ele será posicionado na mesma coordenada do SGP no OZmap.
Caso a configuração não estiver ativada ou as coordenadas não estiverem preenchidas no SGP, o cliente será criado em torno da caixa.
Implantação e Atualização de Clientes (Nome, Potência (RX),
...
Coordenadas, Status de Conexão e Endereço).
A cada X minutosApós cada intervalo entre as sincronizações, a integração busca os contratos e conexões atualizadas do SGP.
Identifica os clientes no OZmap pelo código (id) de contrato existente no ERPSGP, e atualiza os campos baseado baseados nas seguintes regras:
Nome
...
Se
...
houver alteração do nome no SGP
...
e esteja com diferença no OZmap, é considerado o nome que está no SGP. (Qualquer alteração de nome no OZmap será descartada)
Potência (RX)
...
Estado de ativação: Caso o cliente tenha o Status de contrato “Ativo” (1), o cliente e tenha estado “Não Implantado” no OZmap, ele é atualizado para o estado “Implantado” automaticamente.
...
Status de Conexão: Caso o SGP retorne essa informação (Depende de suporte para o dispositivo, todo suporte para essa parte é deles), ela é atualizada no OZmap:
“Online” no ERP ⇒ “OK” no OZmap
“Offline” no ERP ⇒ “ERROR” no OZmap
Cancelamento de clientes
A cada X minutos
Atualização do valor de “Potencia lida” do cliente no OZmap é baseado na leitura informada pelo SGP. Essa atualização é feita caso a potência do SGP seja diferente da potência existente no OZmap atualmente.
Coordenadas
Caso a configuração de “Utilizar coordenadas SGP para clientes no OZmap” esteja ativa, a atualização das coordenadas do cliente no OZmap é baseada na leitura informada pelo SGP. Essa atualização no OZmap é feita caso a coordenada do SGP seja diferente da coordenada do cliente no OZmap atualmente.
IMPORTANTE: Todas as coordenadas dos clientes no OZmap serão trocadas para as do SGP.
Estado de Implantação
Atualização do valor do campo estado de implantação para “implantado” no OZmap é baseado na leitura informada pelo SGP.
Caso o valor presente no OZmap seja diferente do valor trazido pelo SGP, o campo do OZmap é atualizado. O valor segue o seguinte padrão para ser implantado no OZmap:
Estado de Implantação SGP | Estado de Implantação OZmap |
|---|---|
Ativo (1) | Implantado |
Suspenso (4) | Implantado |
Novo (6) | Implantado |
Ativo Reduzido (7) | Implantado |
Status de Conexão
Atualização do valor de status do cliente no OZmap é baseado na leitura informada pelo SGP. O campo “status” é atualizado no OZmap utilizando o “status_conexão” do SGP.
Caso o valor presente no OZmap seja diferente do valor trazido pelo SGP, o campo do OZmap é atualizado. O valor segue o seguinte padrão:
Status Conexão SGP | Status Conexão OZmap |
|---|---|
Online | OK (0) |
Offline | ERROR (1) |
Endereço
Atualização do valor de endereço do cliente no OZmap é baseado na leitura informada pelo SGP. A atualização é feita caso o endereço do SGP seja diferente do endereço existente no OZmap atualmente.
Atualização de Caixa, Splitter e Porta dos Clientes OZmap
A Atualização de Caixa, Splitter e Porta de clientes OZmap consiste em identificar alteração de algum desses dados do cliente no SGP e replicar essa alteração para o cliente OZmap correspondente, e ocorre da seguinte forma:
É identificado o cliente no OZmap pelo código de contrato existente no SGP
Por padrão é buscado no OZmap por uma caixa com nome IGUAL ao nome do splitter no SGP. Porém caso utilize a configuração “Considerar condomínios verticais” também será considerado os condomínios verticais OZmap nessa busca.
Caso a configuração de considerar o nome de projeto esteja ativa, a porta do cliente somente será atualizada no OZmap caso o projeto da caixa OZmap possua o mesmo nome da cidade do cliente no SGP.
Caso exista uma caixa correspondente no OZmap, por padrão é buscado no primeiro splitter uma porta correspondente a porta do SGP. Porém caso a configuração “Considerar mais de um splitter na caixa OZmap“ esteja ativada, será buscado uma porta correspondente levando em consideração todos os splitters presentes na caixa, entretanto para que todos os splitters sejam considerados eles devem ser nomeados em ordem numérica válida. Ex: Splitter 1, Splitter 2, Splitter 3, neste exemplo, caso o Splitter 2 não exista o Splitter 3 não será considerado como splitter válido.
Caso o cliente esteja conectado a uma caixa diferente da caixa encontrada, o cliente é atualizado no OZmap para a caixa e a porta correspondente a do SGP.
Caso o cliente não tenha informações de caixa no SGP e a configuração ‘Desconexão de clientes em trocas de porta’ esteja ativa, será realizada a desconexão do cliente no OZmap.
Cancelamento de Clientes
Após cada intervalo entre as sincronizações, a integração busca os contratos e conexões atualizadas do SGP.
Identifica os clientes no OZmap pelo código (id) de contrato existente no ERPSGP que contenham ONU, e identifica contratos cancelados que ainda existem no OZmap, clientes são considerados cancelados no OZmap :
Contrato é considerado cancelado se tiver no status: CANCELADO(3) ou INVIABILIDADE_TECNICA(5) no SGP.
Caso o cliente esteja “Implantado” no OZmap, é considerado um cancelamento de cliente já ativo, e o cancelamento se dá dessa formaquando:
Estado de Ativação SGP | Estado de Ativação OZmap |
|---|---|
Cancelado (3) | Cancelado |
Inviabilidade Técnica (5) | Cancelado |
O cancelamento se dá dessa forma:
Clientes com o status de não implantado no OZmap:
Imóvel e Cliente são removidos por completo;
Nenhuma conexão com splitter é mantida;
Clientes com o status de implantado no OZmap:
Cliente é removido do ImóvelImóvel permanece conectado ao Splitter.por completo do imóvel;
São adicionadas informações do cliente removido (Nome, Código, Data) nas observações do imóvel;
Se a configuração de desconectar o imóvel do cliente cancelado da porta do splitter estiver ativa, o imóvel é desconectado da porta do splitter no OZmap, liberando a porta para novas conexões;
Se a configuração de remover completamente o imóvel do cliente cancelado estiver ativa, o imóvel .
Caso o cliente esteja “Não Implantado” no OZmap, é considerada uma “Desistência” (Quando um cliente não chega a ser ativado, e cancela), e o cancelamento se da dessa forma:
Imóvel e cliente são removidos por completo
Nenhuma conexão com splitter é mantida.
Questionário
...
Pergunta
...
Resposta
...
e o cliente são removidos por completo e nenhuma conexão com splitter é mantida;
Configurações Base
Parâmetro | Descrição | Padrão |
|---|---|---|
Tempo entre Sincronizações | Tempo aguardado entre as sincronizações realizadas pela integração | 15 minutos. |
Configurações Específicas - Clientes
Parâmetro | Descrição | Padrão |
|---|---|---|
Cancelar Clientes Automaticamente no OZmap | Clientes com status "Cancelado" ou "Inviabilidade Técnica" no SGP são removidos do OZmap. | Desativado |
Criar Clientes Automaticamente no OZmap | Clientes que existem no SGP porém não existem no OZmap serão criados no OZmap caso a caixa do cliente no SGP seja encontrada pelo nome no OZmap. | Desativado |
Considerar o Projeto na Criação de Novos Clientes e Atualização de Portas no OZmap | Somente será criado o cliente e ou atualizado a porta no OZmap, cuja o projeto da caixa OZmap tenha o nome igual ao nome da cidade do cliente no SGP. | Desativado |
Remover Completamente o Imóvel do Cliente SGP Cancelado no OZmap | Ao cancelar um cliente no SGP, e o mesmo não é uma reserva no OZmap, o imóvel e cliente são removidos completamente do OZmap. | Desativado |
Desconectar o Imóvel do Cliente SGP Cancelado da Porta do Splitter OZmap | Ao cancelar um cliente no SGP e o mesmo não é uma reserva no OZmap, o imóvel dele será desconectado da porta do splitter OZmap, liberando ela para novas conexões. O imóvel e drop continuarão existindo no OZmap, conectados a caixa, mas desconectado do splitter. | Desativado |
Utilizar coordenadas SGP para clientes no OZmap | Clientes com coordenadas OZmap divergentes das coordenadas no SGP terão suas coordenadas atualizadas para às do SGP. | Desativada |
Criar clientes no OZmap com coordenadas SGP | Clientes criados automaticamente no OZmap pela integração serão criados usando as coordenadas vindas do SGP. | Ativada |
Considerar Condomínios Verticais | Além das caixas também será considerado os condomínios verticais na criação e atualização de portas de clientes no OZmap. | Desativada |
Considerar mais de um Splitter na Caixa OZmap | No processo de criação de clientes e atualização de portas no OZmap, será considerado todos os splitters presentes na caixa do OZmap. Para que essa configuração funcione corretamente, esses splitters devem ser nomeados em ordem numérica correta. Por exemplo: para que o Splitter 3 seja reconhecido é necessário que os Splitters 1 e 2 existam. | Desativada |
Atualizar Porta de Clientes | Será atualizado a porta/caixa dos clientes no OZmap de acordo com os dados do cliente no SGP. | Desativada |
Dados Acesso
https://docs.google.com/forms/d/1ZrFR1QU4xM7ag_EU-whzzz-oA6es7anXZFCM1GvTn8M/edit
SGP
Dados de acesso necessários para buscar informações via API no sistema SGP. (Estes dados devem ser fornecidos no questionário inicial)
Parâmetro | Descrição | Exemplo |
|---|---|---|
URL | Endereço do servidor SGP. | https://sgp.cliente.com.br |
Token | Token provido pelo cliente para acessar o serviço. | 59123456-2e1d-479a-9b49-5513b2aac54f |
Nome do App | Nome que o cliente deu para a conta de serviço da integração dentro do seu serviço externo. | OZmap |
OZmap
Parâmetro | Descrição | Exemplo |
|---|---|---|
Token | Token associado a conta do usuário de integração cadastrado no ozmap. (O usuário deve ter acesso aos projetos que a integração irá trabalhar (Escolha do usuário). Tutorial de como gerar usuário/chave.) | eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtb2R1bGUiOiJhcGkiLCJ1c2VyIjoiNWQ5ZjNmYjgyMDAxNDEwMDA2NDdmNzY4IiwiY3JlYXRpb25EYXRlIjoiMjAyMC0wOC0yNFQxNjoxMjoyMS43MTdaIiwiaWF0IjoxNTk6Mjg1NTQxfQ.S215vbHlBLtZSzxmORIc2sH1lEKi5VALKBqZB1VcFCE |
Liberação de IPs
Para validação e execução da integração no ambiente de produção, é necessário que sejam liberados no servidor do cliente os IPs utilizados pelo OZmap:
Servidor OZmap do cliente (ping cliente.ozmap.com.br)
54.207.162.199
Logs
Os logs desta integração estão disponíveis no endereço: https://cliente.ozmap.com.br/integrations/sgp/logs
Questionário
Pergunta | Resposta | Funcionalidade |
|---|---|---|
É possível utilizar apenas algumas das funcionalidades acima? | Sim, atualmente são opcionais algumas funcionalidades | Cancelar Clientes, Criar Clientes, Considerar Projetos na Criação de Clientes, Criar Clientes ao Redor da Utilizar coordenadas SGP e Desconectar o Imóvel do Cliente Cancelado da Porta do Splitter. |
É possível alterar o mapeamento de status definidos? Ex: Status 7 no SGP ser OK no OZmap | Não, até a presente versão o mapeamento de status é fixo, é algo possível de ser feito mediante pedido de melhoria. | Atualização de Status |
É possível manter o imóvel no OZmap após o cancelamento do cliente? | Sim, se o cliente estiver com status “implantado” no OZmap e a configuração de “Remover Imóvel Completamente” estiver desativada, o imóvel permanecerá existindo e ocupando porta no OZmap. | - |
É possível criar um cliente SGP no OZmap em uma porta que já esteja ocupada por um imóvel? | Não, na funcionalidade de criar clientes da integração irá dar erro, independente da porta estar ocupada por um cliente ou imóvel. | Criar Clientes |
É possível remover o imóvel OZMap do cliente SGP cancelado da porta do Splitter OZmap? | Sim, com a configuração de “Desconectar Imóvel do Splitter”, ao cancelar um cliente no SGP que tenha o status “Implantado” no OZmap, o imóvel é desconectado da porta do splitter no OZmap. | Desconectar o Imóvel do Cliente SGP Cancelado da Porta do Splitter OZmap |
Preciso criar o projeto e o cliente nos dois sistemas ou em um só? | Atualmente, se a integração não estiver considerando projetos, só criando o cliente no SGP e atribuindo um splitter a ele, ja é o suficiente para ele ser criado no OZmap. | Criar Clientes |
Na configuração de considerar o nome do projeto na criação de clientes do SGP no OZmap a acentuação é levada em conta? | Sim, a acentuação e as letras maiusculas e minusculas são levadas em conta, por isso, os nomes nos dois sistemas devem ser identicos. | Considerar o Projeto. |
Se o nome do splitter SGP representar um condomínio no OZmap, a integração conseguirá reconhecer esse splitter? | Sim, utilizando a configuração "Considerar condomínios verticais”, os condomínios verticais serão considerados nos processos de criação de clientes e atualização de portas no OZmap. | Considerar Condomínios Verticais |
//Anotar as perguntas e possíveis respostas e quais as funcionalidades relacionadas às respostas.