Page Comparison

...

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 integradospara 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 ONUs clientes no SGP para atualização destes dados nos clientes , criação e remoção de clientes no OZmap. A integração encontra as ONUs os clientes SGP no OZmap através do contrato das ONUsSGP.

OBS: “contrato“ no SGP deve ser igual ao “code” do cliente no OZmap para que seja atualizado.

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/logs.

encontrado.

Resumo das funcionalidades

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 identificados buscados todos os contratos clientes que existem no SGP(Contrato) e , que possuam ONU e que não existem no OZmap (Código procurando pelo código do cliente OZmap semelhante ao contrato SGP).

• A partir desses clientes encontrados, é buscada qual Caixa/Splitter/Porta analisado se ele está conectado a um splitter no SGP. (Se tiver Para criar no OZmap é necessário estar conectado).

• Após identificar a caixaCom o cliente possuindo um splitter e o status não está como cancelado no SGP, vamos buscar no OZmap buscar 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:

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:

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 quando:

• 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 forma

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 e o cliente são removidos por completo e nenhuma conexão com splitter é mantida;

Configurações Base

Configurações Específicas - Clientes

...

    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

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)

OZmap

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

//Anotar as perguntas e possíveis respostas e quais as funcionalidades relacionadas às respostas.