Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...

A integração OZmap-RBX é do tipo Passiva-direta, desenvolvida pela equipe RBX.

...

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, com ações podendo ser realizadas pelo RBX Web, e os apps RBX Salesforce e RBX Workforce.

Resumo de funcionalidades

...

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 no OZmap, 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 como “Pedido com viabilidade no OZmap”confirmando que há viabilidade, e em seguida mostrará uma lista com as caixas encontradas e os splitters que cada caixa possui, incluindo 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 por fim 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

...

  • 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 o 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”;

      • ImportanteIMPORTANTE: 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 o este cliente no RBX, e altera o seu estado de implantação para “Implantado”.

...

  • 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 no OZmap, é 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 no OZmap, 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 o 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 no OZmap, é 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 o 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 no OZmap, é 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 o este cliente no RBX, e remove o cliente e seu imóvel do OZmap.

...

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á exista existe no RBX com ID correspondente e tenha tido alguma atualização no OZmap, o RBX replica as alterações na caixa ou splitter da 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 de caixa ou splitter cadastrado no RBX, o RBX exclui a caixa ou splitter correspondente na da sua base.

Dados Acesso

Dados de acesso necessários para as operações realizadas pelo integrador são:

...