...
| Table of Contents | ||||
|---|---|---|---|---|
|
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 |
|---|---|---|
Implantação de clientes ativos | Ativação (Implantar) cliente no OZmap de acordo com o que é informado pelo RBX | RBX => OZmap |
Remoção de clientes cancelados | Remoção no OZmap de clientes cancelados de acordo com o que é informado pelo RBX | RBX => OZmap |
Atualização de status de conexão do cliente | Atualização de status de conexão de clientes no OZmap de acordo com o que é informado pelo 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 | RBX => OZmap | |
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
...
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 |
|---|---|---|
URL | Endereço do 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 | ||
Porta OZmap | Porta de serviço padrão do OZmap. | 9994 |
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|
|---|---|---|---|---|---|