Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Essa documentação trata da integração com o sistema Telco by G2. A integração é realizada atraves através de chamadas de API partindo do Integrador e utilizando a API disponibilizada no serviço de integração pelo OZmap.

Table of Contents
minLevel1
maxLevel7

Tipo de Integração

A integração OZmap-Telco é do tipo Passiva-indireta.

Descrição

O Telco by G2 é um ERP SAP Business One implementado para empresas de telecomunicações, focado no gerenciamento de operações financeiras, comerciais, controle de estoque, entre outros.

A integração se baseia no Telco realizando principalmente viabilidade, reserva de portas, ativação e cancelamento de clientes no OZmap.

Resumo de funcionalidades

Funcionalidade

Descrição

Direção da integração

Consulta de viabilidade e reserva de portas no OZmap

O Telco envia latitude e longitude de um cliente para o OZmap, que retorna a viabilidade de atendimento para aquela localização, e a partir disso, o Telco pode realizar a reserva de porta no OZmap.

Telco => OZmap

Implantação de clientes no OZmap

O Telco realiza a ativação de clientes através da alteração de estado de implantação no OZmap.

Telco => OZmap

Cancelamento de clientes no OZmap

O Telco realiza a alteração de estado de implantação e posterior exclusão de clientes cancelados no OZmap.

Telco => OZmap

Consulta de caixa e porta de clientes no OZmap

O Telco busca no OZmap os dados de caixa e porta de clientes para exibir no seu sistema.

OZmap => Telco

Funcionalidades

Abaixo serão descritas as funcionalidades apresentadas no resumo de forma a entender como funciona o fluxo de sincronização.

...

.

Consulta de viabilidade e reserva de portas no OZmap

A consulta de viabilidade e reserva de portas no OZmap se baseia na consulta de uma localização, verificando se possui viabilidade de atendimento no OZmap antes de prosseguir com a reserva de porta nos processos de venda e alteração de endereço, e ocorre da seguinte forma:

  • O Telco envia ao OZmap a latitude e longitude do cliente interessado em contratação ou em solicitações de alteração de endereço.

  • A partir da latitude e longitude informadas pelo Telco, o OZmap realizada a verificação de viabilidade técnica, buscando caixas que não estejam “Em projeto”, e possuam splitter de atendimento com portas disponíveis no OZmap;

  • A definição de qual tipo de viabilidade será feita no OZmap é determinada pelo parâmetro “Tipo de viabilidade feita no OZmap”, podendo ser de duas formas:

    • Por raio (padrão): a partir da coordenada passada pelo Telco, busca as caixas mais próximas no OZmap considerando a distância em linha reta do cliente até a caixa. O tamanho máximo em metros para o raio de busca será o que estiver definido nas configurações do OZmap (Configurações > Sistema > API > Raio de busca padrão).

    • Por poste: a partir da coordenada passada pelo Telco, busca o poste mais próximo no OZmap (buscando em um raio de 100 metros), e partindo deste poste, busca caixas considerando a distância do poste até as caixas, passando pelas adjacências disponíveis no OZmap. O tamanho máximo em metros para o drop será o que estiver definido nas configurações do OZmap (Configurações > Projeto > Configuração padrão de drop > Tamanho máximo de drop).

  • O OZmap retorna ao Telco a lista de caixas e portas disponíveis para seguimento do processo de venda ou troca de endereço, onde o usuário pode selecionar uma caixa e porta no Telco para realizar a reserva de porta.

  • Após a seleção de caixa e porta no Telco, um cliente é criado no OZmap ocupando a caixa e porta selecionadas, contendo como código no OZmap o ID de contrato do Telco, e com estado de implantação “Não implantado”.

    • Caso seja uma alteração de endereço, será criado um segundo cliente na caixa e porta selecionadas para o endereço novo, também com estado de implantação “Não implantado”, mas no código, terá o ID de contrato do Telco + a sigla “-AE”, para indicar que se trata de uma alteração de endereço (Ex.: 171717-AE). Até o processo de implantação do cliente no endereço novo ser realizado, haverão dois clientes no OZmap representando este cliente Telco (endereço antigo e endereço novo).

  • Viabilidade de condomínios: Ao selecionar um endereço no Telco, o mesmo realiza a busca de condomínios próximos no OZmap também, possibilitando que a reserva de porta seja feita um condomínio, se for o caso para o cliente solicitante.

Implantação de clientes no OZmap

A Implantação de clientes no OZmap consiste em ativar um cliente no OZmap após a habilitação do seu contrato no Telco, e ocorre da seguinte forma:

  • Para clientes novos:

    • Ao realizar a habilitação de contrato de um cliente no seu sistema, o Telco ativa esse cliente no OZmap.

    • Para isso, o Telco busca no OZmap um cliente com código igual ao ID de contrato do cliente Telco.

    • Caso seja encontrado cliente correspondente no OZmap, o seu estado de implantação é alterado de “Não implantado” para “Implantado”.

  • Para clientes em alteração de endereço:

    • Caso seja um cliente em alteração de endereço, o Telco busca no OZmap um cliente com código igual ao ID de contrato do cliente Telco para localizar o endereço antigo, e para encontrar o endereço novo, busca um cliente no OZmap que possua código igual ao ID de contrato do cliente Telco + a sigla “-AE” (Ex.: 171717-AE).

    • Caso sejam encontrados, o Telco remove o cliente OZmap no endereço antigo, e por padrão, o imóvel do cliente é mantido no OZmap, tendo seu drop desconectado do splitter OZmap.

      • Se o parâmetro “Desconectar Drop de Clientes cancelados no OZmap” estiver desabilitado, o imóvel é mantido no OZmap e o drop permanece conectado à porta do splitter OZmap.

    • O cliente do endereço novo tem o estado de implantação alterado de “Não implantado” para “Implantado”, e a sigla “-AE” é removida do código do cliente OZmap.

Cancelamento de clientes no OZmap

O Cancelamento de clientes no OZmap consiste na mudança de estado de implantação e posterior exclusão de clientes no OZmap, e ocorre da seguinte forma, em duas possíveis situações:

  • Quando um contrato de cliente ativo é cancelado no seu sistema, o Telco desativa esse cliente temporariamente no OZmap.

  • Para isso, o Telco busca no OZmap um cliente com código igual ao ID de contrato do cliente Telco.

  • Caso seja encontrado cliente correspondente no OZmap, o estado de implantação do cliente no OZmap é alterado de “Implantado” para “Não implantado”.

  • Quando uma visita de retirada de equipamento do contrato cancelado é concluída, o Telco exclui o cliente do OZmap, e por padrão, o imóvel do cliente é mantido no OZmap, e seu drop desconectado do splitter OZmap.

    • Se o parâmetro “Desconectar Drop de Clientes cancelados no OZmap” estiver desabilitado, o imóvel é mantido no OZmap e o drop permanece conectado à porta do splitter OZmap.

  • Quando um cliente com contrato que não foi habilitado é cancelado, o Telco exclui direto o cliente do OZmap, e por padrão, realiza o mesmo tratamento explicado acima para seu imóvel e drop no OZmap.

Consulta de caixa e porta de clientes no OZmap

A Consulta de caixa e porta de clientes no OZmap consiste no Telco buscando no OZmap a caixa e porta que o cliente Telco está conectado no OZmap, e ocorre da seguinte forma:

  • O Telco busca no OZmap um cliente com código igual ao ID de contrato do cliente Telco.

  • Caso seja encontrado cliente correspondente no OZmap, o Telco busca a caixa e porta que o cliente está conectado no OZmap.

  • O Telco exibe essas informações de caixa e porta que o cliente está conectado no OZmap no mapeamento de contrato do Telco e demais locais onde se faz necessário saber a caixa e porta do cliente dentro do sistema Telco.

Configurações Base

Parâmetro

Descrição

Padrão

Tipo de viabilidade feita no OZmap

Tipo de viabilidade que será feita pelo OZmap com base nas coordenadas informadas pelo Telco, podendo ser por raio ou por poste (seguindo adjacências).

Raio.

Desconectar Drop de Clientes cancelados no OZmap

Quando um cliente for removido do OZmap por cancelamento de conexão Telco, o drop do imóvel será desconectado da porta do splitter OZmap.

Ativado.

Dados Acesso

Dados de acesso necessários para as operações realizadas pelo integrador são:

Saiba mais como configurar esses dados acionando o suporte do Telco.

OZmap

Parâmetro

Descrição

Exemplo

URL

Endereço do OZmap, com a porta de serviço padrãoda API OZmap disponibilizada para o Telco.

https://cliente.ozmap.com.br:9994/integrations/telco/api/v2v1

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

Caso o servidor OZmap esteja em ambiente ON-Premisses, é necessário liberar nos firewalls o IP do servidor onde está o Telco para acessar as portas 80 e 9994 no ambiente do OZmap.

Caso seu servidor seja hospedado pelo OZmap, essas portas já estarão liberadas para o integrador.

Questionário

Pergunta

Resposta

Quando um cliente é cancelado no Telco, o mesmo é removido imediatamente do OZmap?

Não. O Telco altera o estado de implantação para “Não implantado” e só remove um cliente cancelado do OZmap após a retirada de seu equipamento.

Os clientes criados pelo Telco no OZmap seguem as adjacências disponíveis?

Não. Atualmente o Telco cria clientes somente em linha reta até a caixa no OZmap.

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