SmartOLT

Essa documentação trata do serviço externo SmartOLT. 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-SmartOLT é do tipo Ativa.

Descrição

O SmartOLT é uma ferramenta de software para gerenciamento de OLTs e ONUs. Adição, remoção, provisionamento, gerenciamento e monitoramento de ONUs estão entre as principais funcionalidades deste sistema.

As funcionalidades da integração entre OZmap e SmartOLT se baseiam na leitura de potências e status de ONUs no SmartOLT para atualização destes dados nos clientes OZmap, além da ativação de clientes não implantados no OZmap. A integração encontra as ONUs SmartOLT no OZmap através do serial (“sn“ no SmartOLT deve ser igual ao “serial” do cliente no OZmap para que seja encontrado e atualização).

Resumo de funcionalidades

Funcionalidade	Descrição	Direção da integração
Atualização de status	Atualização do valor de status do cliente no OZmap baseado na leitura informada pelo SmartOLT.	SmartOLT => OZmap
Atualização de potência	Atualização do valor de potência lida no OZmap baseado na leitura informada pelo SmartOLT.	SmartOLT => OZmap
Implantação de clientes	Ativação (Implantar) cliente no OZmap ao reconhecer uma potência válida lida pelo SmartOLT.	SmartOLT => OZmap

Funcionalidades

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

Atualização de status

Atualização do valor de status do cliente no OZmap baseado na leitura informada pelo SmartOLT. O campo “status” é atualizado no OZmap respeitando as regras abaixo.

São lidos os valores de status de todas as ONUs encontradas no SmartOLT.
Para cada ONU, buscamos no OZmap um cliente que possua a ONU com Serial Number semelhante.
Caso seja encontrado, e o valor presente no OZmap seja diferente do valor trazido pelo SmartOLT, o campo do OZmap é atualizado. O valor de status segue o seguinte padrão:

Status SmartOLT	Status OZmap
Online	OK (0)
Offline	ERROR (1)
Power fail	ERROR (1)
LOS	ERROR (1)

Atualização de potência

Atualização do valor de potência lida no OZmap baseado na leitura informada pelo SmartOLT. O campo “Potência lida” é atualizado no OZmap respeitando as regras abaixo.

São lidos os valores de potência (atributo signal_1310) de todas as ONUs encontradas no SmartOLT.
Para cada ONU, buscamos no OZmap um cliente que possua a ONU com Serial Number semelhante.
Caso seja encontrado, o campo de “Potência lida” do cliente no OZmap será atualizado com o valor de potência lido na ONU no SmartOLT, contanto que seguinte condição seja atingida:
- A potência lida da ONU no SmartOLT deve possuir um valor com diferença maior que 0,5dBm (potência 0,5 melhor ou 0,5 pior) em relação ao valor do campo “Potência lida” do cliente no OZmap para que seja atualizada.

Implantação de clientes

Atualização do estado de implantação do cliente no OZmap baseado na leitura de potência informada pelo SmartOLT.

São lidos os valores de potência de todas as ONUs encontradas no SmartOLT.
Para cada ONU com potência válida (ou seja, que possuam potência de valor numérico diferente de 0), buscamos no OZmap um cliente que possua a ONU com Serial Number semelhante.
Caso seja encontrado, e o cliente esteja com estado de implantação “Não implantado” no OZmap, o campo é atualizado para “Implantado”.

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

Parâmetro	Descrição	Padrão
Limite de alteração de potência	Limite mínimo de alteração da potência no SmartOLT para que a potência lida do cliente no OZmap seja atualizada.	0.5

Dados Acesso

Não possui questionário.

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

Parâmetro	Descrição	Exemplo
URL	Endereço do servidor SmartOLT.	https://cliente.smartolt.com/
Chave API	Chave API para acesso ao SmartOLT.	-

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:

Servidor OZmap do cliente (ping cliente.ozmap.com.br)

54.207.162.199

Também se faz necessária a liberação dos mesmos IPs acima no próprio SmartOLT, que pode ser feito desta forma:

Na tela inicial, selecionar “Settings”.
Na aba “General”, selecionar “Edit general settings”.
Adicionar os IPs no campo “IPs allowed to access SMARTOLT” (por exemplo: 54.207.162.199, 10.10.10.10) e salvar (botão “Save”):

Logs

Os logs da integração são disponibilizados no endereço: https://cliente.ozmap.com.br/integrations/smartolt/logs

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 status do cliente no OZmap com base na potência recebida do SmartOLT?	Não, no momento a atualização de status no OZmap ocorre somente pelo valor de status lido no SmartOLT.	-
É possível integrar mais de uma SmartOLT com um mesmo OZmap?	Não, no momento não é possível, mas o cliente pode realizar essa solicitação junto ao CS para avaliarmos a viabilidade para que a integração trabalhe assim.	-

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

SmartOLT - es