Essa documentação trata da integração com o sistema RBX. A integração é realizada através de chamadas de API partindo do Integrador e utilizando a API disponibilizada pelo OZmap.
Tipo de Integração
A integração OZmap-RBX é do tipo Passiva, desenvolvida pela equipe RBX.
Descrição
O RBX é um sistema de Gestão (ERP) focado no controle financeiro, estoque e documentação para provedores de internet.
As funcionalidades desta integração entre OZmap e RBX tem como foco principal a realização de consulta de viabilidade com reserva de porta, implantação e cancelamento de clientes no OZmap.
Resumo de funcionalidades
Funcionalidade | Descrição | Direção da integração |
---|---|---|
Viabilidade com Reserva de Porta no OZmap | Buscar viabilidade técnica no OZmap para um endereço de cliente ou equipamento RBX, e reservar uma porta no OZmap para sua instalação. | RBX => OZmap |
Implantação de Clientes no OZmap | Implantação de clientes RBX no OZmap, através da ligação de equipamento no RBX. | RBX => OZmap |
Cancelamento de Clientes e Reservas no OZmap | Remove reservas e clientes no OZmap, através do cancelamento de contrato ou desligamento de equipamento no RBX. | RBX => OZmap |
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.
Viabilidade com Reserva de Porta no OZmap
A Viabilidade com Reserva de Porta no OZmap realizada pelo RBX no OZmap consiste em verificar a disponibilidade de atendimento para um novo cliente ou equipamento em determinada localidade e reservar uma porta para sua instalação posterior, e ocorre da seguinte forma:
RBX Web:
Para realizar o processo para um pedido, pelo cadastro de pedido do cliente, é acionado o menu “Viabilidade”, e selecionado “Viabilidade OZmap”;
Para realizar o processo para um cliente, ao selecionar o equipamento desejado na lista de equipamentos do cadastro do cliente, é 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 não estejam “Em projeto”, e possuam 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 como “Pedido com viabilidade no OZmap”, e em seguida, as caixas encontradas e os splitters que cada caixa possui, incluindo a situação de cada porta dos splitters (livre, 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 o número de contrato 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 caixa encontradas para que o usuário faça a seleção, após deve ser selecionado o splitter e por fim a fibra (correspondente ao número da porta) a ser reservada para aquele cliente.
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”;
Feito isso, o RBX busca no OZmap o cliente com código correspondente ao contrato 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 código correspondente ao contrato RBX, e altera o seu estado de implantação para “Implantado”;
Cancelamento de Clientes e Reservas no OZmap
RBX Web:
Para realizar o cancelamento de uma reserva no OZmap, acessar o cadastro de pedido e a tela de viabilidade OZmap, e então selecionar a porta que deseja cancelar a reserva. Com isso, o RBX irá remover do OZmap o cliente não implantado correspondente a essa reserva de porta. 16:20
Para realizar o cancelamento de um equipamento no OZmap, ao selecionar o equipamento desejado na lista de equipamentos do cadastro do cliente, é acionado o menu “Desativar”;
Após confirmada a desativação do equipamento, …
RBX Salesforce:
Para realizar o cancelamento de uma reserva no OZmap, acessar o cadastro de pedido e selecionar “Cancelar reserva de porta”. Com isso, o RBX irá remover do OZmap o cliente não implantado correspondente a essa reserva de porta.
RBX Workforce (app):
Para realizar o processo de cancelamento, deve ser selecionado o equipamento dentro do atendimento do cliente, e usar a opção “Desligar Equipamento”;
Feito isso, o RBX busca no OZmap o cliente com código correspondente ao contrato RBX, e exclui o cliente e o seu imóvel do OZmap;
Sincronização de Caixas e Splitters
A Sincronização de Caixas e Splitters no RBX realizada pelo RBX manter as informações de caixas, splitters e portas atualizadas no sistema para utilização nas demais funcionalidades da integração dentro do RBX, 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;
Paralelamente a isso, o RBX executa uma rotina a cada hora, verificando caixas e splitters que foram editados ou removidos no OZmap;
Caso uma caixa ou splitter seja editada no OZmap possua mesmo ID de caixa ou splitter cadastrado no RBX, o RBX replica as alterações na caixa ou splitter correspondente na sua base;
Caso uma caixa ou splitter seja removida no OZmap possua mesmo ID de caixa ou splitter cadastrado no RBX, o RBX exclui a caixa ou splitter correspondente na 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, para a consulta de viabilidade no OZmap | 150 |
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 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 |
---|---|---|
Add Comment