Versions Compared

Key

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

...

Essa documentação trata da integração com o sistema INT6. A integração é realizada por chamadas de API partindo do INT6 utilizando a API disponibilizada pelo OZmap e partindo do OZmap utilizando a API disponibilizada pelo INT6.

Table of Contents
minLevel1
maxLevel7

Tipo de Integração

A integração OZmap-INT6 é do tipo Híbrida.

Descrição

O INT6 é um sistema de monitoramento e provisionamento de equipamentos GPON, bem com suporte para redes neutras.

A integração OZmap x INT6 é feita em duas direções e via API, com o OZmap buscando informações de potência do INT6 e INT6 buscando informações de rede do OZmap.

OBS: Por padrão, o gpon_client_idno INT6 deve ser igual ao “código” do cliente no OZmap para ser encontrado e tratado pelos dois lados da integração. Atualmente esse deve ser , sendo necessariamente, um valor numérico. Porém, também é possível usar o pppoe_username do INT6 como código, via configuração específica, devendo ser ajustado nos dois lados da integração (OZmap e INT6).

Resumo das funcionalidades - Serviço de integração OZmap

Funcionalidade

Descrição

Direção da integração

Atualização de Status de Conexão dos Clientes OZmap

O status dos clientes OZmap é atualizado conforme a leitura de potência verificada no INT6.

INT6 => OZmap

Atualização de Potência dos Clientes OZmap

A potência dos clientes OZmap é atualizada conforme a leitura de potência verificada no INT6.

INT6 => OZmap

Atualização de Estado de Implantação dos Clientes OZmap

O estado de implantação dos clientes OZmap é atualizado conforme a leitura de potência verificada no INT6.

INT6 => OZmap

Atualização dos Dados da ONU OZmap

Os dados da ONU OZmap são atualizados conforme a leitura dos dados da ONU no INT6.

INT6 => OZmap

Resumo das funcionalidades - Serviço de integração INT6

Funcionalidade

Descrição

Direção da integração

Consulta de Potência do Cliente OZmap

A INT6 busca no OZmap a potência calculada de um cliente.

OZmap => INT6

Consultar CTOs OZmap Disponíveis para Provisionamento

A INT6 realiza busca de CTOs OZmap próximas do cliente OZmap e disponibiliza para provisionamento.

OZmap => INT6

Ativação e Atualização dos Dados do Cliente no OZmap

A INT6 atualiza no OZmap os dados de splitter, porta, coordenada e estado de implantação do cliente com base no que foi escolhido para provisionamento no INT6.

INT6 => OZmap

Criar Cliente no OZmap

A INT6 verifica se o cliente existe no OZmap, se não existir, ele é criado com as informações de splitter e porta escolhidos no provisionamento.

INT6 => OZmap

Cancelar Cliente no OZmap

A INT6 remove do OZmap os clientes desprovisionados no seu sistema.

INT6 => OZmap

Serviço de integração OZmap

Funcionalidades

...

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

Atualização de Status de Conexão dos Clientes OZmap

Sincronização dos status de conexão dos clientes INT6 existentes no OZmap:

  • São lidos todos os clientes OZmap;

  • É feita a busca de clientes no INT6 de acordo com o parâmetro “Código INT6 a ser considerado na integração”, ocorrendo da seguinte forma:

    • Caso seja o gpon_client_id:

      • Para cada cliente OZmap que possui um código numérico, é buscado um cliente com “gpon_client_id” igual no INT6;

    • Case seja o pppoe_username:

      • Para cada cliente OZmap, é buscado um cliente com “pppoe_username” igual no INT6;

    • Caso seja o circuit_id_integration:

      • Para cada cliente OZmap, é buscado um cliente com “circuit_id_integration" igual no INT6;

  • Para cada cliente OZmap encontrado no INT6 que possua algum valor de potência, é feito o seguinte tratamento:

    • Se a nova potência do INT6 for um valor numérico positivo ou negativo, o status de conexão do cliente no OZmap é atualizado para OK;

    • Se a nova potência for zero ou textual, o status de conexão é atualizado para ERROR no OZmap;

Valor Potência INT6

Status Conexão OZmap

0

ERROR

0.1, 1, 1.5 …

OK

-0.5, -1, -1.5 …

OK

Atualização de Potência dos Clientes OZmap

Sincronização de potência dos clientes INT6 existentes no OZmap:

  • São lidos todos os clientes OZmap;

  • É feita a busca de clientes no INT6 de acordo com o parâmetro “Código INT6 a ser considerado na integração”, ocorrendo da seguinte forma:

    • Caso seja o gpon_client_id:

      • Para cada cliente OZmap que possui um código numérico, é buscado um cliente com “gpon_client_id” igual no INT6;

    • Case seja o pppoe_username:

      • Para cada cliente OZmap, é buscado um cliente com “pppoe_username” igual no INT6;

  • Para cada cliente OZmap encontrado no INT6 que possua algum valor de potência, é feito o seguinte tratamento:

    • Se a potência do cliente no INT6 divergir da potência no cliente OZmap (considerando o parâmetro “Limite de alteração de potência“), é atualizado o campo de potência lida da ONU no OZmap com o valor encontrado no INT6;. Abaixo uma tabela exemplificando os casos de atualização de potência, considerando o “Limite de alteração de potência“ sendo 0.5:

Valor Potência INT6

Potência lida no OZmap

Potência será atualizada no OZmap?

-20.50

-20.80

Não

-21.00

-20.80

Não

-21.35

-20.80

Sim

-20.25

-20.80

Sim

Atualização do Estado de Implantação dos Clientes OZmap

Sincronização dos status de conexão dos clientes INT6 existentes no OZmap:

  • São lidos todos os clientes OZmap;

  • É feita a busca de clientes no INT6 de acordo com o parâmetro “Código INT6 a ser considerado na integração”, ocorrendo da seguinte forma:

    • Caso seja o gpon_client_id:

      • Para cada cliente OZmap que possui um código numérico, é buscado um cliente com “gpon_client_id” igual no INT6;

    • Case seja o pppoe_username:

      • Para cada cliente OZmap, é buscado um cliente com “pppoe_username” igual no INT6;

  • Para cada cliente OZmap encontrado no INT6 que possua algum valor de potência, é feito o seguinte tratamento:

    • Se a nova potência for um valor numérico positivo ou negativo, e o cliente estiver como “não implantado” no OZmap, o estado de implantação dele é mudado para “implantado” no OZmap.

Atualização dos Dados da ONU OZmap

Atualização dos dados da ONU OZmap com base na leitura da ONU do INT6:

  • São lidos todos os clientes OZmap;

  • É feita a busca de clientes no INT6 de acordo com o parâmetro “Código INT6 a ser considerado na integração”, ocorrendo da seguinte forma:

    • Caso seja o gpon_client_id:

      • Para cada cliente OZmap que possui um código numérico, é buscado um cliente com “gpon_client_id” igual no INT6;

    • Case seja o pppoe_username:

      • Para cada cliente OZmap, é buscado um cliente com “pppoe_username” igual no INT6;

  • Para cada cliente OZmap encontrado no INT6 que possua algum valor de potência, é feito o seguinte tratamento:

    • É verificado se há divergência entre os dados de serial number, user pppoe e mac address no OZmap e no INT6, e havendo divergência, os dados da ONU no OZmap são atualizados com as informaçoes encontradas no INT6;

      • Nessa atualização de dados, é possível habilitar a configuração de utilizar no OZmap o short serial number do INT6, ao invés do serial number completo;

Configurações Base OZmap

Parâmetro

Descrição

Padrão

Tempo entre Sincronizações

Tempo aguardado entre as sincronizações realizadas pela integração.

Insert excerpt
CP:Base variables
CP:Base variables
namesync_ixc
nopaneltrue

Configurações Específicas OZmap

...

Parâmetro

Descrição

Padrão

Código INT6 a ser considerado na integração

Atributo das ONUs no INT6 que será comparado com código de clientes no OZmap, para encontrar correspondentes e aplicar funcionalidades da integração. Atualmente, podem ser usados o gpon_client_id e pppoe_username.

gpon_client_id

Limite de alteração de potência

Limite mínimo de alteração da potência no INT6 para que a potência lida do cliente no OZmap seja atualizada.

0.5

Atualizar os Dados da ONU no OZmap

Se o serial number, user pppoe ou mac de uma ONU no OZmap divergir do INT6, são atualizados os dados da ONU no OZmap, com base nos dados lidos do INT6.

Desativado.

Utilizar o Short Serial Number na ONU OZmap

Na ONU OZmap, pode ser utilizado o short serial number ao invés do serial number completo, lido da ONU INT6. Essa funcionalidade só pode ser ativa, caso a funcionalidade de atualizar os dados da ONU também estiver ativa.

Desativado.

Dados Acesso - Serviço de integração OZmap

https://docs.google.com/forms/d/1Ma6wF8XOaeKOSetxfbcR0Qkv6N4iJ4CAraxyyZpj2-0/edit

INT6

Dados de acesso necessários para buscar informações via API no sistema INT6. (Estes dados devem ser fornecidos no questionário inicial)

Parâmetro

Descrição

Exemplo

URL

URL do servidor que contém o serviço externo para conexão.

autoisp.exemplo.com.br

Email

Email provido pelo cliente para acessar o serviço.

ozmap@int6tech.com.br

Token

Token provido pelo cliente para acessar o serviço.

aMshEhZtyK-7AyQTZM5v

OZmap

Insert excerpt
CP:Base variables
CP:Base variables
nameozmap_token
nopaneltrue

Liberação de IPs

Para validação e execução da integração no ambiente de produção, é necessário serem liberados no servidor do cliente os IPs utilizados pelo OZmap:

...

Insert excerpt
CP:Base variables
CP:Base variables
nopaneltrue

Logs

No momento a integração OZmap INT6 não possui logs.

Questionário - Serviço de integração OZmap

...

Pergunta

...

Resposta

...

Funcionalidade

...

É possível utilizar apenas algumas das funcionalidades acima?

...

Sim, atualmente são opcionais algumas funcionalidades

...

.

Serviço de integração INT6

Funcionalidades INT6

Abaixo serão descritas as funcionalidades do INT6, apresentadas no resumo para entender como funciona o fluxo das funcionalidades.

Consulta de Potência Calculada do Cliente OZmap

A consulta de informações de potência do cliente OZmap é realizado na seguinte forma:

  • No momento do provisionamento, INT6 busca no OZmap as informações de potência calculada, slot, pon e olt do cliente;

  • Essa potência calculada do OZmap é comparada com a potência lida da ONU no INT6, e caso a diferença seja maior que o limite definido no INT6, essa ativação não é autorizada;

Consultar CTOs OZmap Disponíveis para Provisionamento

A consulta das CTOs OZmap disponíveis para realizar provisionamento , é dado dada da seguinte forma:

  • A partir da coordenada do cliente no INT6, é feito uma consulta no OZmap por splitters de CTOs e condomínios próximos ao cliente no OZmap;

  • Uma lista de splitters OZmap disponíveis é exibida para ser escolhido para realizar provisionamento da ONU no INT6;

Ativação e Atualização dos Dados do Cliente no OZmap

A atualização de dados dos clientes no OZmap , é feito da seguinte forma:

  • No momento do provisionamento, é buscado um cliente no OZmap com código igual ao “gpongpon_client_id” id, pppoe_username ou circuit_id_integration da ONU no INT6 (dependendo de como estiver configurado no serviço INT6);

  • Se o cliente for encontrado no OZmap, os dados de CTO, splitter, porta e coordenada são atualizados no OZmap com base nos dados definidos na hora do provisionamento no INT6;

  • Caso o estado de implantação do cliente esteja como “não implantado” no OZmap, é atualizado para “implantado”;

Criar Cliente no OZmap

A criação de clientes no OZmap , é dada da seguinte forma:

  • No momento do provisionamento, é buscado um cliente no OZmap com código igual ao “gpongpon_client_id” id ou pppoe_username da ONU no INT6 (dependendo de como estiver configurado no serviço INT6);

  • Se o cliente não for encontrado no OZmap, é feita a criação de um novo cliente no OZmap, com os dados de CTO, splitter, porta e coordenadas definidos na hora do provisionamento no INT6;

  • O cliente é criado no OZmap já com o estado de implantação “implantado”

Cancelar Cliente no OZmap

O cancelamento de clientes no OZmap é dado da seguinte forma:

  • No momento do desprovisionamento de um cliente no INT6, é buscado um cliente no OZmap com código igual ao gpon_client_id ou pppoe_username da ONU no INT6 (dependendo de como estiver configurado no serviço INT6);

  • Se o cliente for encontrado no OZmap, o INT6 remove o cliente por completo do OZmap (cliente, imóvel e drop são excluídos).

Sincronização de Caixas

A sincronização de caixas no INT6 é dada da seguinte forma:

  • O INT6 busca OLTs OZmap com etiqueta OZmap igual ao ID de integração da OLT INT6

  • A partir destas OLTs, são buscadas todas as caixas, splitters e suas conexões.

  • A partir de todas as conexões de cada OLT, é preparado uma árvore de elementos relacionados a esta, que é então retornada ao INT6 para processamento e atualização de dados.

Dados Acesso - Serviço de integração INT6

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

OZmap

Parâmetro

Descrição

Exemplo

URL

Endereço do OZmap, com a porta de serviço padrão.

https://cliente.ozmap.com.br:9994

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

É possível utilizar apenas algumas das funcionalidades do Serviço de integração OZmap?

Sim, atualmente são opcionais algumas funcionalidades

Atualizar os Dados da ONU, Utilizar Short Serial Number na ONU.