...
Essa documentação trata do serviço externo Ravi. 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.
| Table of Contents |
|---|
Dados Acesso
Dados de acesso necessários para buscar informações via API no sistema Ravi. (Estes dados devem ser fornecidos no questionário inicial)
...
Parâmetro
...
Descrição
...
Exemplo
...
IP
...
IP da máquina que contém o serviço externo para conexão.
...
192.168.0.2
...
Token
...
Token provido pelo cliente para acessar o serviço. Localizado em Configurações > Registro Ravi
...
Po9eebairai1bo-CaoH2eo2iaVohp-beM7EiThemahph-Aeb6wah2hei8ah
...
Usuário
...
Nome usuário do sistema criado para a integração.
...
ozmap
...
Senha
...
Senha de acesso do usuário
...
-
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
18.230.31.104
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
...
Código de vinculo
...
Atributo utilizado para vincular os clientes do OZmap com onus no Ravi
...
Serial Number
Logs
...
|
Tipo de Integração
A integração OZmap-Ravi é do tipo Ativa.
Descrição
O Ravi é um sistema de monitoramento e provisionamento de equipamentos FTTH, bem com infraestrutura de TI.
Resumo de funcionalidades
Funcionalidade | Descrição | Direção da integração |
|---|---|---|
Atualização de potência | Atualização do valor de potência lida no OZmap baseado na leitura informada pelo Ravi. | Ravi => OZmap |
Atualização de status | Atualização do valor de status do cliente no OZmap baseado na leitura informada pelo Ravi. | Ravi => OZmap |
Implantação de cliente | Ativação (Implantar) cliente no OZmap ao reconhecer uma potência válida lida pelo Ravi. | Ravi => 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 potência
Atualização do valor de potência lida no OZmap baseado na leitura informada pelo Ravi. O campo Potência lida “Potência lida” é atualizado no OZmap, utilizando o campo “rxonu” do Ravi.
São lidas todas as ONUs reconhecidas pelo Ravi
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 Ravi, o campo “Potência lida” do OZmap é atualizado.
Atualização de status
Atualização do valor de status do cliente no OZmap baseado na leitura informada pelo Ravi. O campo “status” é atualizado no OZmap utilizando o campo “status” do Ravi.
...
Status Ravi | Status OZmap |
|---|---|
Offline por rompimento (0) | ERRO (1) |
Online (1) | OK (0) |
Offline (2) | ERRO (1) |
Online sem dados (3) | ERRO (1) |
Offline por desligamento de energia (4) | OK (0) |
Implantação de cliente
Ativação (Implantar) cliente no OZmap ao reconhecer uma potência válida lida pelo Ravi. O campo “implantado” é atualizado no OZmap quando uma potência válida é reportada pela ONU.
São lidas todas as ONUs reconhecidas pelo Ravi
Para cada ONU com potência lida válida, buscamos no OZmap um cliente que possua a ONU com Serial Number semelhante.
Caso seja encontrado, e o cliente no OZmap esteja em status “Não implantado” o campo do OZmap é 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 |
Código de vinculo | Atributo utilizado para vincular os clientes do OZmap com onus no Ravi | Serial Number |
Dados Acesso
Não possui questionário.
Ravi
Dados de acesso necessários para buscar informações via API no sistema Ravi. (Estes dados devem ser fornecidos no questionário inicial)
Parâmetro | Descrição | Exemplo |
|---|---|---|
IP | IP da máquina que contém o serviço externo para conexão. | 192.168.0.2 |
Token | Token provido pelo cliente para acessar o serviço. Localizado em Configurações > Registro Ravi | Po9eebairai1bo-CaoH2eo2iaVohp-beM7EiThemahph-Aeb6wah2hei8ah |
Usuário | Nome usuário do sistema criado para a integração. | ozmap |
Senha | Senha de acesso do usuário | - |
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)
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Logs
Os logs da integração são disponibilizados no endereço: https://cliente.ozmap.com.br/integrations/ravi/logs
Questionário
Pergunta | Resposta | Funcionalidade |
|---|---|---|
É possível utilizar apenas algumas das funcionalidades acima? | Não, até a presente versão todas as funcionalidades são executadas, sem distinção ou configuração que pause uma delas. | - |
É possível alterar o mapeamento de status definidos? Ex: “Online sem dados” ser OK no OZmap | Não, até a presente versão o mapeamento de status é fixo, é algo possível de ser feito mediante pedido de melhoria. | Atualização de Status |
//Anotar as perguntas e possíveis respostas e quais as funcionalidades relacionadas às respostas.