Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 27 Next »

Essa documentação trata do serviço externo SGP. O serviço externo é acessado via API. As funcionalidades descritas aqui indicam as capacidades e os requisitos da integração, bem como o questionário e as funcionalidades relacionadas.

Descrição

O Sistema de Gerenciamento para Provedores de Internet é uma ferramenta de gestão para 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 no SGP para atualização destes dados nos clientes OZmap. A integração encontra as ONUs SGP no OZmap através do contrato das ONUs.

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

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:

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 SGP

Clientes com status "Cancelado" ou "Inviabilidade Técnica" no SGP são cancelados no 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 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.

Resumo das funcionalidades

Funcionalidade

Descrição

Direção da integração

Sincronização de Dados de Clientes

Sincronização dos dados dos clientes cadastrados no OZmap, podendo incluir status do contrato, status da conexão, potência, nome e endereço.

SGP => OZmap

Cancelamento de Clientes

Cancelamento de clientes que se encontram cancelados no SGP.

SGP => OZmap

Ativação de Clientes

Ativação de clientes que se encontram ativados no SGP.

SGP => OZmap

Criação de Clientes

Criação de clientes que se encontram cadastrados no SGP.

SGP => 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 identificados todos os clientes que existem no SGP (contrato) e não existem no OZmap (código do cliente).

  • A partir desses clientes encontrados, é analisado se ele está conectado a um splitter no SGP. (Para criar no OZmap é necessário estar conectado).

  • Após confirmar que o cliente possui um splitter, é analisado se o cliente não está com o status de cancelado no SGP.

  • Com o cliente possuindo um splitter e o status não está como cancelado no SGP, vamos no OZmap buscar 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 caixa exista, mas não tenha splitter, o cliente é criado na caixa sem conexão.

    • Caso a caixa exista e tenha splitter, criamos o cliente no splitter e na porta indicada no SGP.

    • Caso a caixa não exista, o cliente não será criado no OZmap.

    • 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 projeto do cliente no SGP.

    • Caso 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.

Atualização de Campos (Nome, Potência (RX), Estado de Ativação, Status de Conexão e Endereço).

A cada X minutos, 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 SGP, e atualiza os campos baseado 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)

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.

Estado de Ativação

Atualização do valor de “implantado” ou “cancelado” 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:

Estado de Ativação SGP

Estado de Ativação OZmap

Ativo (1)

Implantado

Cancelado (3) ou Inviabilidade Técnica (5)

Cancelado

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.

Cancelamento de Clientes

A cada X minutos, 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 SGP, e identifica contratos cancelados que ainda existem no OZmap, clientes são considerados cancelados no OZmap quando:

Estado de Ativação SGP

Estado de Ativação OZmap

Cancelado (3)

Cancelado

Inviabilidade Técnica (5)

Cancelado

O cancelamento se dá dessa forma:

  • Imóvel e Cliente são removidos por completo;

  • Nenhuma conexão com splitter é mantida;

  • São adicionadas informações do cliente removido (Nome, Código, Data) nas observações do imóvel.

Questionário

Pergunta

Resposta

Funcionalidade

É possível utilizar apenas algumas das funcionalidades acima?

Não, no momento ainda não é possível escolher executar apenas uma ou mais das funcionalidades descritas.

-

É 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

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

  • No labels