...
Essa documentação trata do serviço externo da integração com o sistema RBX. O serviço externo é acessado via banco de dados. As funcionalidades descritas aqui indicam as capacidades e os requisitos da integração, bem como o questionário e as funcionalidades relacionadasA integração é realizada através de chamadas de API partindo do Integrador e utilizando a API disponibilizada pelo OZmap.
Table of Contents | ||||
---|---|---|---|---|
|
...
A integração OZmap-RBX é do tipo Passiva-direta, desenvolvida pela equipe RBX.
...
O RBX é um sistema de Gestão (ERP) focado no controle financeiro, estoque e documentação para Provedores provedores de internet.
As funcionalidades da desta integração entre OZmap e RBX se baseiam na busca ao banco de dados disponibilizado pelo ERP, sendo essas funcionalidades a ativação, atualização de status e códigos tem como foco principal a realização de consulta de viabilidade com reserva de porta, implantação e cancelamento de clientes no OZmap, com base nas leituras do RBXações podendo ser realizadas pelo RBX Web, e os apps RBX Salesforce e RBX Workforce.
Resumo de funcionalidades
Funcionalidade | Descrição | Direção da integração |
---|
Implantação de clientes ativos
Viabilidade com Reserva de Porta no OZmap | Buscar viabilidade técnica no OZmap para um pedido de internet ou equipamento RBX, e reservar uma porta no OZmap para sua instalação. | RBX => OZmap |
Remoção de clientes cancelados
Implantação de Clientes no OZmap | Implantação de clientes |
RBX no OZmap, através da ligação de equipamento no RBX. | RBX => OZmap |
Atualização de status de conexão do cliente
Cancelamento de Clientes e Reservas no OZmap | Remoção de reservas e clientes no OZmap, através do cancelamento de reserva e contrato ou desligamento de equipamento no RBX. | RBX => OZmap |
Atualização de código de cliente
Atualização de código de clientes no OZmap de acordo com o que é informado pelo RBX
Sincronização de Caixas e Splitters no RBX | Cadastro, atualização e exclusão periódica de caixas e splitters no RBX, com base nos dados destes elementos no OZmap. | OZmap => RBX |
Funcionalidades
Abaixo serão descritas as funcionalidades apresentadas no resumo de forma a entender como funciona o fluxo de sincronização.
Implantação de clientes ativos
Ativação (implantação) dos clientes ativos no OZmap baseado na leitura informada pelo RBX, respeitando as regras abaixo:
São buscados todos os clientes que possuam registro simultaneamente nas tabelas de ClientesUsuarios, Contratos, Planos e radacct, além de possuírem tipo de plano "M" e NAS Central do Assinante no banco de dados RBX;
Para cada cliente encontrado, buscamos um cliente no OZmap com um código semelhante ao código de contrato do RBX;
Caso seja encontrado, esteja com situação de contrato ativo (“A”) no RBX e o cliente no OZmap esteja em estado de implantação “Não implantado”, o campo do OZmap é atualizado para “Implantado”.
Remoção de clientes cancelados
Remoção dos clientes cancelados no OZmap baseado na leitura informada pelo RBX, de acordo com as regras abaixo:
São buscados todos os clientes que possuam registro simultaneamente nas tabelas de ClientesUsuarios, Contratos, Planos e radacct, além de possuírem tipo de plano "M" e NAS Central do Assinante no banco de dados RBX;
Para cada cliente encontrado, buscamos um cliente no OZmap com um código semelhante ao código de contrato do RBX;
Caso seja encontrado e esteja com situação de contrato cancelado (“C”) no RBX, o cliente é removido do OZmap, é adicionada uma observação na propriedade contendo o nome do cliente e data de remoção. Por padrão é mantida a propriedade no OZmap e a mesma fica conectada com o seu splitter no OZmap, mas caso o cliente deseje, há uma configuração específica para desconectar a propriedade do splitter em todos os cancelamentos.
Atualização de status de clientes
Atualização de status de clientes no OZmap baseado na leitura informada pelo RBX, de acordo com as regras abaixo:
São buscados todos os clientes que possuam registro simultaneamente nas tabelas de ClientesUsuarios, Contratos, Planos e radacct, além de possuírem tipo de plano "M" e NAS Central do Assinante no banco de dados RBX;
Para cada cliente encontrado, buscamos um cliente no OZmap com um código semelhante ao código de contrato do RBX;
Caso seja encontrado e o status OZmap esteja diferente do status (StatusRadius) trazido pelo RBX, o status é atualizado. O valor de status segue o seguinte padrão:
...
Status (StatusRadius) RBX
...
Status OZmap
...
Conectado
...
OK (0)
...
Desconectado
...
ERROR (1)
Atualização de código de clientes
Atualização de código de clientes no OZmap baseado na leitura informada pelo RBX, de acordo com a configuração específica definida para isso e seguindo as regras abaixo:
São buscados todos os clientes que possuam registro simultaneamente nas tabelas de ClientesUsuarios, Contratos, Planos e radacct, além de possuírem tipo de plano "M" e NAS Central do Assinante no banco de dados RBX;
Para os clientes que possuem código no OZmap mas não foram encontrados no RBX por este código de contrato, é feita a atualização de códigos pela opção definida pelo cliente:
Caso o cliente use a configuração para buscar por contratos transferidos:
É buscado o contrato atual do cliente no RBX de acordo com o código no OZmap, e através do campo “TrasnferidoPara” no RBX, encontramos o contrato novo e, atualizamos então o código do cliente no OZmap com esse número de contrato.
Caso o cliente use a configuração para buscar por contratos ativos:
É verificado se o cliente tem mais de um contrato no RBX, se o contrato referente ao código do cliente no OZmap está cancelado no RBX e se existe algum outro contrato novo ativo:
Se existir somente um contrato ativo, atualiza o código do cliente no OZmap com o número deste contrato ativo
Se existirem múltiplos contratos ativos, pesquisa por contratos RBX deste cliente que não possuem cliente com código semelhante no OZmap, se só existir um mesmo, atualiza o código deste cliente no OZmap, usando este código de contrato RBX que não estava atrelado a nenhum cliente OZmap. Se existir mais de um cliente nessas condições no OZmap, não é possível fazer a atualização de código.
Configurações Base
...
Parâmetro
...
Descrição
...
Padrão
...
Tempo entre Sincronizações
...
Tempo aguardado entre as sincronizações realizadas pela integração
...
10 minutos
Configurações Específicas
...
Parâmetro
...
Descrição
...
Padrão
...
Atualização de código de clientes no OZmap por transferência de contratos no RBX
...
Atualização de código no OZmap com base em pesquisa por transferência de contrato do cliente no RBX
...
Desativado
...
Atualização de código de clientes no OZmap por contratos ativos no RBX
...
Atualização de código do cliente no OZmap com base em pesquisa por contratos ativos do cliente no RBX
...
Desativado
...
Remoção de clientes cancelados automaticamente
...
Remove clientes do OZmap com base na leitura de clientes cancelados no RBX
...
Desativado
...
Desconectar propriedade de splitter ao cancelar cliente no OZmap
...
Desconecta do splitter a propriedade de um cliente cancelado no OZmap automaticamente
...
Desativado
Dados Acesso
https://docs.google.com/forms/d/1UtFOKSpoxTkHO8MqGUfqW3e73x_0JLFXiWbAzJ47ZyA
RBX
Dados de acesso necessários para que a integração possa buscar informações via banco de dados no sistema RBX. (Estes dados devem ser fornecidos no questionário inicial)
...
Parâmetro
...
Descrição
...
Exemplo
...
IP Banco de Dados
...
IP do banco de dados disponibilizado pelo RBX.
...
190.113.10.3
...
Nome Banco de Dados
...
Nome do banco de dados disponibilizado pelo RBX.
...
isupporhs
...
Porta de acesso Banco de Dados
...
Porta de acesso ao banco de dados disponibilizado pelo RBX.
...
5432
...
Usuário
...
Nome de usuário no banco de dados criado para a integração.
...
rbx
...
Senha
...
Senha de acesso do usuário no banco de dados.
...
-
OZmap
...
Parâmetro
...
Descrição
...
Viabilidade com Reserva de Porta no OZmap
A Viabilidade com Reserva de Porta no OZmap realizada pelo RBX consiste em verificar a disponibilidade de atendimento para um novo cliente em determinada localidade e reservar uma porta para sua instalação futura, podendo ser realizada tanto pelo RBX Web como pelo app RBX Salesforce, e ocorre da seguinte forma:
RBX Web:
O processo de viabilidade com reserva de porta para um pedido de internet, é feito pelo cadastro de pedido do cliente, onde é acionado o menu “Viabilidade”, e selecionado “Viabilidade OZmap”;
O processo de viabilidade com reserva de porta para um equipamento de cliente, é feito ao selecionar o equipamento desejado na lista de equipamentos do cadastro do cliente, onde é acionado o menu “Consultar caixas de atendimento no OZmap”;
Em ambos os casos, o RBX irá realizar a consulta de viabilidade no OZmap, enviando as coordenadas correspondentes ao endereço do cliente para buscar caixas que estejam implantadas e possuam algum splitter de atendimento com portas disponíveis no OZmap;
A busca de viabilidade realizada no OZmap é feita por raio, e a distância máxima para este raio de busca será a que estiver definida nas configurações do RBX (Parâmetro “Raio de viabilidade”).
Caso haja viabilidade no OZmap, o RBX exibirá uma mensagem confirmando que há viabilidade, e em seguida mostrará uma lista com as caixas encontradas e os splitters que cada caixa possui, exibindo também a situação de cada porta dos splitters (livre ou ocupada);
Para realizar a reserva, deve ser selecionada a porta que deseja reservar dentre as disponíveis usando a opção “Reservar esta porta para este pedido” ou “Reservar esta porta para este equipamento”. Com isso, o RBX irá criar um cliente no OZmap com estado “Não implantado”, na caixa, splitter e porta correspondentes as que foram selecionadas no RBX, e tendo como código um número aleatório criado pelo RBX.
RBX Salesforce (app):
Dentro de cadastro de pedido do cliente, é acionado o menu “Realizar viabilidade”;
O processo de viabilidade é realizado no OZmap, seguindo o mesmo padrão descrito no RBX Web;
Após o retorno de “Pedido com viabilidade”, é possível realizar a reserva de porta pelo menu “Reservar porta”;
O RBX exibe a lista de caixas encontradas para que o usuário faça a seleção, após deve ser selecionado o splitter e a fibra (correspondente ao número da porta) a ser reservada para aquele pedido de cliente, e por fim confirmar a reserva pelo botão “Reservar porta”.
Implantação de Clientes no OZmap
A Implantação de Clientes no OZmap realizada pelo RBX consiste em implantar clientes que tiveram suas ligações de equipamentos realizadas no RBX, e ocorre da seguinte forma:
RBX Web:
Para realizar o processo de implantação de um cliente, ao selecionar o equipamento desejado na lista de equipamentos do cadastro do cliente, é acionado o menu “Consultar caixas de atendimento no OZmap”;
Com isso, é feita uma nova busca de viabilidade no OZmap, e as caixas com seus splitters e portas são exibidas;
Para implantar o cliente, é selecionada a porta em que se deseja utilizar para o cliente:
Caso já haja uma porta reservada previamente para o equipamento, a ligação só poderá ser feita nesta mesma porta através do menu “Ligar equipamento nessa porta”;
Caso não haja reserva para o equipamento, pode ser feita a reserva na hora pelo menu “Reservar esta porta para este equipamento”, e então a ligação diretamente pelo menu “Ligar equipamento nessa porta”;
Caso a reserva tenho sido feita para um pedido, e não para equipamento, a ligação do equipamento pode ser feito tanto na porta reservada para o pedido quanto para qualquer outra.
Feito isso, o RBX busca no OZmap o cliente com ID correspondente ao ID salvo para este cliente no RBX, e altera o seu estado de implantação para “Implantado”.
RBX Workforce (app):
Para realizar o processo de implantação, deve ser selecionado o equipamento dentro do atendimento do cliente, e usar a opção “Ligar Equipamento (OZmap)”;
Com isso, é feita uma nova busca de viabilidade no OZmap, e lista de caixas será exibida;
Ao selecionar uma caixa e o seu splitter, será mostrada a lista de portas disponíveis, onde deve ser seleciona a porta a ser utilizada na ligação, e em seguida, a opção “Ligar equipamento”;
IMPORTANTE: Assim como na versão web, caso já haja uma reserva previamente para o equipamento, só será possível realizar a ligação na porta da reserva.
Feito isso, o RBX busca no OZmap o cliente com ID correspondente ao ID salvo para este cliente no RBX, e altera o seu estado de implantação para “Implantado”.
Cancelamento de Clientes e Reservas no OZmap
O Cancelamento de Clientes e Reservas no OZmap realizada pelo RBX consiste em remover do OZmap clientes com contratos ou reservas canceladas no RBX, e ocorre da seguinte forma:
RBX Web:
Pelo RBX Web, existem três meios de cancelamento de clientes no OZmap:
Para realizar o cancelamento de uma reserva de pedido RBX, é acessado o cadastro de pedido do cliente e a tela de viabilidade OZmap, e então selecionada a porta que deseja cancelar a reserva e usar a opção “Cancelar reserva de porta”.
Para realizar o cancelamento de um equipamento ou sua reserva RBX, ao selecionar o equipamento desejado na lista de equipamentos do cadastro do cliente, é acionado o menu “Desativar”;
Por fim, o cancelamento de clientes no OZmap também pode é feito automaticamente pelo RBX quando o contrato do cliente é cancelado no RBX.
Em todos os casos, para realizar o cancelamento do cliente ou reserva no OZmap, o RBX busca no OZmap o cliente com ID correspondente ao ID salvo para este cliente no RBX, e remove o cliente e seu imóvel do OZmap.
RBX Salesforce (app):
Para realizar o cancelamento de uma reserva de pedido RBX, é acessado o cadastro de pedido do cliente e selecionada a opção “Cancelar reserva de porta”.
Após isso, o RBX busca no OZmap o cliente com ID correspondente ao ID salvo para este cliente no RBX, e remove o cliente e seu imóvel do OZmap.
RBX Workforce (app):
Para realizar o processo de cancelamento de equipamento RBX, é selecionado o equipamento dentro do atendimento do cliente, e usada a opção “Desligar Equipamento”;
Após isso, o RBX busca no OZmap o cliente com ID correspondente ao ID salvo para este cliente no RBX, e remove o cliente e seu imóvel do OZmap.
Sincronização de Caixas e Splitters
A Sincronização de Caixas e Splitters realizada pelo RBX é feita para manter as informações de caixas, splitters e portas atualizadas no RBX com base nos dados OZmap, para utilização nas suas funcionalidades da integração, e ocorre da seguinte forma:
Todas as caixas encontradas durantes os processos de viabilidade, juntamente com seus splitters e portas, são cadastradas no RBX caso ainda não existam com ID correspondente no RBX;
Se uma caixa ou splitter encontrado durante processo de viabilidade já existe no RBX com ID correspondente e tenha tido alguma atualização no OZmap, o RBX replica as alterações na sua base;
Paralelamente a isso, o RBX executa uma rotina a cada hora, verificando caixas e splitters que foram removidos do OZmap;
Caso uma caixa ou splitter tenha sido removido do OZmap e possua mesmo ID cadastrado no RBX, o RBX exclui a caixa ou splitter correspondente da sua base.
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 RBX.
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 | ||
Raio de viabilidade | Raio de busca, em metros, usado pelo RBX para a consulta de viabilidade no OZmap | 150 |
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)
...
Logs
https://cliente.ozmap.com.br/integrations/rbx/logs
Caso o servidor OZmap esteja em ambiente ON-Premisses, é necessário liberar nos firewalls o IP do servidor onde está o RBX 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 desconectar o imóvel do splitter após cancelamento de cliente no OZmap? | Sim, a desconexão do imóvel após cancelamento é uma configuração disponível | Remoção de clientes cancelados|
---|---|---|---|---|---|