Essa documentação trata do serviço externo 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 relacionadas.
Tipo de Integração
A integração OZmap-RBX é do tipo Ativa.
Descrição
O RBX é um sistema de Gestão (ERP) focado no controle financeiro, estoque e documentação para Provedores de internet.
As funcionalidades da 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 e cancelamento de clientes no OZmap, com base nas leituras do RBX.
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. |
|
Nome Banco de Dados | Nome do banco de dados disponibilizado pelo RBX. |
|
Porta de acesso Banco de Dados | Porta de acesso ao banco de dados disponibilizado pelo RBX. |
|
Usuário | Nome de usuário no banco de dados criado para a integração. |
|
Senha | Senha de acesso do usuário no banco de dados. |
|
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)
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 |
Configurações Específicas
Parâmetro | Descrição | Padrão |
---|---|---|
Pesquisar por transferência de contrato do cliente no RBX para atualização de código no OZmap | Atualizar código de cliente no OZmap com base em uma busca de transferência de contrato deste cliente no RBX | Desativado |
Pesquisar por contratos abertos do cliente no RBX para atualização de código no OZmap | Atualizar código de cliente dependendo de uma pesquisa de todos os contratos abertos do cliente no RBX | Desativado |
Remoção de clientes cancelados automaticamente | Remove clientes de propriedades automaticamente com base na leitura de clientes cancelados no RBX | Desativado |
Logs
https://<cliente>.ozmap.com.br:17000/rbx/logs
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 do cliente | Atualização de status 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 do 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 ativo no RBX (status “A”) e o cliente no OZmap esteja em status “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 do 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 cancelado no RBX (status “C”), o cliente é removido do OZmap, mantendo a propriedade conectada com o splitter no OZmap
Há também uma configuração para desconectar a propriedade do splitter se necessário.
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 do 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 as regras abaixo:
São buscados todos os clientes do RBX
Para cada cliente que foi encontrado e não tem um cliente no OZmap com um código semelhante ao RBX, é pesquisado o seu contrato novo para atualização do código respeitando as seguintes regras:
De acordo com a configuração do cliente (buscar ou não por transferência de contrato ou todos os contratos para atualização de código), são buscados todos os contratos relacionados ao código ou somente um.
Se só um for buscado e este tiver um contrato para qual foi transferido para (campo “TransferidoPara”), o código do cliente no OZmap é mudado para esse qual foi transferido.
Se múltiplos forem buscados, é buscado o contrato RBX com código semelhante ao cliente no OZmap e todos os contratos abertos do cliente no RBX (situação ativo “A”) de acordo com esse código.
Se o contrato RBX com código semelhante ao código de cliente no OZmap tem como situação cancelado (“C”) e
Só há um outro contrato aberto no RBX relacionado ao cliente: é buscado o imóvel do cliente do contrato cancelado e o cliente do contrato RBX aberto no OZmap
Se o imóvel OZmap do contrato RBX cancelado existir e o cliente OZmap do contrato RBX aberto não existir: o cliente OZmap cancelado é removido do imóvel e o cliente com contrato RBX aberto é criado no OZmap e movido para ele.
Há múltiplos contratos abertos relacionados ao cliente no RBX: é buscado o imóvel do contrato RBX cancelado e os clientes OZmap relacionados a esses contratos RBX abertos
Se a propriedade do contrato RBX cancelado existir e só existir um cliente existente no OZmap com código semelhante aos contratos RBX abertos: o cliente OZmap cancelado é removido da propriedade e o cliente com contrato aberto é criado e movido para ele
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 |
0 Comments