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 66 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.

Tipo de Integração

A integração OZmap-SGP é do tipo Ativa.

Descrição

O SGP é 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 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 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

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 => 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 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 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, se essa porta estiver 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, tenha splitter mas no SGP não possua porta, criamos o cliente no splitter e na primeira porta disponível no OZmap.

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

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 de contrato existente no SGP, e atualiza os campos 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)

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.

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 de contrato existente no SGP que contenham ONU, 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:

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

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 no OZmap

Somente será criado o cliente 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

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:

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?

Não, atualmente a integração compara splitters SGP somente a caixas OZmap, mas é possível fazer uma sugestão de melhoria pra isso.

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

  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.