OLT Cloud
Essa documentação trata da integração com o sistema OLT Cloud. A integração é realizada através de chamadas API partindo do integrador e utilizando a API disponibilizada pelo OZmap.
Tipo de Integração
A integração OZmap-OLT Cloud é do tipo Passiva-direta, desenvolvida pela equipe OLT Cloud.
Descrição
O OLT Cloud é um sistema de provisionamento e monitoramento focado no gerenciamento de PONs, CTOs, OLTs e ONUs de maneira isolada ou compartilhada.
A integração é responsável por sincronizar as Caixas entre os sistemas, gerenciar a criação e o cancelamento de Clientes no OZmap com base nos dados do OLT Cloud e também realizar a atualização de portas dos clientes.
Resumo de funcionalidades
Funcionalidade | Descrição | Direção da integração |
---|---|---|
Sincronização de Caixas | Atualização dos dados da Caixa no OLT Cloud com base nos dados deste elemento no OZmap. | OZmap => OLT Cloud |
Criação de Clientes | Criação no OZmap de clientes que se encontram cadastrados no OLT Cloud. | OLT Cloud => OZmap |
Atualização de Porta de Clientes | Ao trocar um cliente de porta no OLT Cloud por padrão é atualizado a porta do cliente no OZmap. Porém pode ocorrer atualização de forma bilateral, dependendo da configuração do cliente no OLT Cloud. | OZmap => OLT Cloud |
Cancelamento de Clientes | Remoção no OZmap de clientes que tiveram a porta removida no OLT Cloud. | OLT Cloud => OZmap |
Funcionalidades
Abaixo serão descritas as funcionalidades apresentadas no resumo de forma a entender como funciona o fluxo de sincronização.
Sincronização de Caixas
A sincronização de caixas no OLT Cloud tem como objetivo manter as informações de Caixas e suas portas sempre atualizadas, com base nos dados obtidos do OZmap. O processo permite configurar quais tipos de caixas do OZmap devem ser sincronizados e de quais projetos elas devem ser extraídas. As caixas são vinculadas ao OLT Cloud por meio de seus respectivos IDs no OZmap, e essa informação é armazenada em um campo específico da tabela de CTOs no OLT Cloud chamado “ex_id”.
A frequência dessa sincronização é determinada pela equipe do OLT Cloud e depende da quantidade de caixas do cliente, podendo ocorrer a cada 1 hora se o Cliente possuir poucas Caixas em sua base, ou podendo ocorrer apenas duas vezes ao dia caso o Cliente possua um número elevado de Caixas (ocorrendo às 5h e às 17h).
O funcionamento dessa sincronização ocorre da seguinte forma:
O cliente realiza a configuração da sincronização de Caixas OZmap para sua base no OLT Cloud, definindo no OLT Cloud quais tipos de Caixas OZmap devem ser importadas e a partir de quais Projetos.
As Caixas OZmap sincronizadas irão conter informações no OLT Cloud como: quantidade de portas, nome, status de implementação e coordenadas.
Uma rotina é executada periodicamente (ocorrendo no intervalo de tempo determinado pelo time da OLT Cloud como ja explicado anteriormente), e realiza as seguintes funções:
Realiza a criação e exclusão de caixas no OLT Cloud caso tenham sido criadas ou removidas no OZmap.
Realiza a atualização dos dados das Caixas no OLT Cloud caso tenham sido alterados no OZmap, como nome coordenadas ou quantidade de portas.
Criação de Clientes
A criação de clientes no OZmap é acionada quando um cliente é vinculado a uma Caixa no OLT Cloud. Durante esse processo, a integração verifica se o cliente já está registrado no OZmap. A identificação pode variar dependendo das especificidades do ERP integrado ao OLT Cloud, mas, de modo geral, segue este fluxo:
Verificação inicial: São buscadas as propriedades no OZmap vinculadas à Caixa correspondente. Em seguida, verifica-se se alguma dessas propriedades possui um código de cliente equivalente ao ID de contrato de algum cliente no OLT Cloud. Esse ID de contrato é o mesmo originado do ERP.
Busca alternativa via PPPoE: Caso o cliente não seja localizado pelo ID de contrato, tenta-se identificá-lo pelo campo "user_PPPoE", utilizando o valor vinculado ao campo "onu" associado ao cliente no sistema.
Busca por Serial Number: Se ainda assim o cliente não for encontrado, a integração tenta identificá-lo pelo Serial Number vinculado a uma ONU no OZmap.
Criação do cliente: Caso o cliente não seja identificado por nenhum dos métodos acima, ele é criado no OZmap. O cliente é então associado à Caixa e à porta correspondentes, com o status "implantado". Além disso, os dados da ONU são registrados no sistema, acompanhados de uma observação indicando que a criação foi realizada via OLT Cloud.
Atualização de Porta de Clientes
Por padrão, a atualização das portas dos clientes no OLT Cloud é realizada com base nos dados do OZmap. Assim, caso a porta de um cliente seja alterada no OZmap, essa informação será automaticamente replicada no OLT Cloud. A integração busca o cliente no OZmap utilizando diferentes critérios de identificação, dependendo da forma como o vínculo foi estabelecido: pelo código do OZmap associado ao ID de contrato no OLT Cloud, pelo usuário PPPoE ou pelo Serial Number. Após localizar o cliente, a integração atualiza sua porta no OLT Cloud com as informações do OZmap.
Contudo, se a configuração "Gravar dados no OZmap" estiver ativada no OLT Cloud, a atualização passa a ser bilateral. Nesse caso, alterações de porta realizadas no OLT Cloud também serão replicadas no OZmap, garantindo que as informações estejam sincronizadas em ambos os sistemas.
Cancelamento de Clientes
O cancelamento de clientes ocorre quando o cliente é desvinculado de uma Caixa no OLT Cloud. Nesse caso, a integração identifica o cliente no OZmap utilizando diferentes critérios, dependendo da forma como o vínculo foi estabelecido: pelo código do OZmap associado ao ID de contrato no OLT Cloud, pelo usuário PPPoE ou pelo Serial Number. Após localizar o cliente, ele é desconectado da Caixa no OZmap, mantendo-se sua propriedade registrada no sistema. Vale destacar que, mesmo após o cancelamento no OZmap, o cliente continuará existindo no OLT Cloud.
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 OLT Cloud.
OZmap
Parâmetro | Descrição | Exemplo |
---|---|---|
API URL | Endereço da API OZmap | |
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 OLT Cloud 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 | Funcionalidade |
---|---|---|
|
|
|