SmartOLT-WIP

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.

Descrição

O SmartOLT é uma ferramenta de software para gerenciamento de OLTs. 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 no OZmap. A integração encontra as ONUs SmartOLT no OZmap através do serial das ONUs (“sn“ no SmartOLT deve ser igual ao “serial” do cliente no OZmap para que seja encontrado para atualização).

Dados Acesso

SmartOLT

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)

Error rendering macro 'excerpt-include' : No link could be created for 'IN:Base variables'.

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

Logs

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

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
Ativação de clientes	Atualização do estado de implantação no OZmap baseado na leitura de potência informada 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.

Caso seja encontrado cliente pelo serial, 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 Zabbix	Status OZmap
Online	OK (0)
Offline	ERROR (1)
Power fail	ERROR (1)

Atualização de potência

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

São lidos os valores de potência de todas as ONUs encontradas no SmartOLT.

Caso seja encontrado cliente pelo serial, e o valor presente no OZmap seja diferente do valor trazido pelo SmartOLT, o campo “Potência lida” do OZmap é atualizado.

Ativação de clientes

Atualização do valor de potência lida no OZmap baseado na leitura informada pelo Zabbix. O campo “Potência lida” é atualizado no OZmap, utilizando o item definido nas configurações.

São lidos os valores de potência de todas as ONUs encontradas no SmartOLT.
Caso seja encontrado cliente pelo serial, e o cliente não esteja como “implantado” no OZmap, se pussuir potência maior que “0” vinda do SmartOLT, o estado de implantação no OZmap é alterado para “implantado”.

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.

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