...
Essa documentação trata do serviço externo IXC. O serviço externo é acessado via API. As funcionalidades descritas aqui indicam as capacidades e os requisitos da integração, bem como o questionário e as funcionalidades relacionadas.
...
A integração OZmap-IXC é do tipo Ativa.
Descrição
O IXC Soft é uma ferramenta de gestão para provedores de internet, focado no controle financeiro, estoque e documentação.
...
Resumo das funcionalidades
Funcionalidade | Descrição | Direção da integração |
|---|---|---|
Implantação e Sincronização de Clientes | Implantação e Atualização de Informações de clientes OZmap com base na leitura do IXC. | IXC => OZmap |
Cancelamento de Clientes | Remoção no OZmap de clientes que se encontram cancelados no IXC. | IXC => OZmap |
Atualização da Porta |
de Clientes | Ao trocar um cliente de porta |
no sistema escolhido como fonte, replica essa alteração no sistema oposto. | OZmap => IXC ou IXC => OZmap |
Atualização das Coordenadas |
de Clientes | Atualização dos atributos de latitude e longitude |
de clientes, com base na leitura do |
sistema escolhido como fonte no sistema oposto. | OZmap => IXC ou IXC => OZmap | |
Sincronização de Condomínios | Criação de caixas no IXC para representar os splitters de um condomínio OZmap. | OZmap => IXC |
Criação de Clientes | Criação no OZmap de clientes que se encontram cadastrados no IXC mas não existem no OZmap. | IXC => OZmap |
Atualização e Criação de Caixas | Atualização e Criação de caixas que se encontram cadastradas no OZmap mas não existem no IXC. É possível também utilizar splitters OZmap como caixas no IXC, para essa função, cada splitter no OZmap será criado como caixa no IXC. | OZmap=> IXC |
Funcionalidades
Implantação e Sincronização de Clientes IXC no OZmap
...
É feito a leitura de todos os clientes no IXC que possuem o tipo de conexão fibra (tipo_conexao_mapa = “f”) e o status de login ativo (ativo = “s”);
A integração busca clientes no OZmap com código igual ao atributo de login IXC definido para a integração;
Caso seja encontrado, se a configuração “Implantar Clientes Automaticamente no OZmap“ estiver ativada e o cliente IXC possuir uma ONU, o estado de implantação deste cliente no OZmap é atualizado para “implantado”;
Se o parâmetro ”Atualização de status dos Clientes OZmap” estiver ativo, e o status de conexão do cliente no IXC esteja diferente do OZmap, é atualizado o valor do status da conexão no OZmap com base no valor lido no atributo “online” no IXC seguindo a seguinte tabela.
Online IXC | Status OZmap |
|---|---|
S (Sim) | OK |
N (Não) | ERRO |
SS (Sem Status) | ERRO |
Se o parâmetro “Atualização de potência dos Clientes OZmap” estiver ativo, e a potência do cliente no IXC divergir da potência no cliente OZmap (considerando o parâmetro “Limite de alteração de potência“), é atualizado o campo de potência lida da ONU no OZmap com o valor encontrado no IXC. Abaixo uma tabela exemplificando os casos de atualização de potência, considerando o “Limite de alteração de potência“ sendo 0.5:
Valor Potência IXC | Potência lida no OZmap | Potência será atualizada no OZmap? |
|---|---|---|
-20.50 | -20.80 | Não |
-21.00 | -20.80 | Não |
-21.35 | -20.80 | Sim |
-20.25 | -20.80 | Sim |
Caso o cliente não possuir nome no OZmap ou o valor diferir do IXC, é atualizado o nome do cliente no OZmap com o valor encontrado no IXC. O campo de nome utilizado no IXC para a verificação é o “razão”;
Se o parâmetro “Atualização de endereço dos Clientes OZmap” estiver ativo, e o campo de endereço da propriedade do cliente no OZmap estiver diferente do endereço lido para o cliente no IXC, o endereço da propriedade do cliente no OZmap é atualizado com os dados de endereço do IXC.
...
É feito a leitura de todos os clientes no IXC que possuem o tipo de conexão fibra (tipo_conexao_mapa = “f”) e o status de login não ativo (ativo = “n”);
A partir destes clientes, a integração busca clientes no OZmap com código igual ao atributo de login IXC definido para a integração;
Se o cliente estiver sem contrato ou o contrato esteja como “inativo” no IXC, o cliente é removido da propriedade no OZmap, por padrão a propriedade é mantida e o drop permanece conectado ao splitter OZmap e, uma observação de nome do cliente e data de remoção é adicionada ao imóvel.
Se o status do contrato do cliente no IXC está como “desistiu”, o cliente e imóvel são removidos do OZmap;
Atualização da Porta do Cliente
...
Observação: não é recomendado usar essa funcionalidade sem usar a configuração para utilizar splitters OZmap como caixas no IXC, já que ela é necessária para identificar o splitter do cliente no OZmap corretamente se exista mais de um splitter na caixa onde ele se encontra.
A atualização de porta consiste em identificar que um cliente foi alterado de caixa/porta no OZmapsistema escolhido como fonte, e replicar essa atualização para o IXCsistema, e ocorre da seguinte forma:
É feito a leitura de todos os clientes no IXC que possuem o tipo de conexão fibra (tipo_conexao_mapa = “f”) e o status de login ativo (ativo = “s”);
A integração busca clientes no OZmap com código igual ao atributo de login IXC definido para a integração;
Caso o sistema escolhido como fonte seja o OZmap:
Caso o cliente no IXC esteja em uma caixa diferente no OZmap, é atualizado a caixa e a porta do cliente no IXC, replicando os dados do OZmap. Se o cliente estiver utilizando a configuração de utilizar splitters OZmap como caixas no IXC, se sofrer alteração de splitter no OZmap, ele será atualizado de caixa no IXC.
Caso o cliente no IXC esteja na mesma caixa no OZmap, porém, esteja em portas diferentes, é atualizado a porta IXC do cliente com o valor existente no OZmap;
Atualização das Coordenadas do Cliente no IXC
A atualização de coordenadas consiste em atualizar as coordenadas do cliente IXC com base na leitura do OZmap, e ocorre da seguinte forma:
É feito a leitura de todos os clientes no IXC que possuem o tipo de conexão fibra (tipo_conexao_mapa = “f”) e o status de login ativo (ativo = “s”);
A integração busca clientes no OZmap com código igual ao atributo de login IXC definido para a integração;
A integração compara os valores de latitude e longitude cadastrados no login IXC, com a latitude e longitude da propriedade do cliente no OZmap.
Caso haja divergência entre os valores de IXC e OZmap, os dados de longitude e latitude do login IXC são atualizados com os valores presentes no OZmap.
Sincronização de Condomínios
A sincronização de condomínios consiste em criar e atualizar no IXC caixas para cada splitter presente dentro de um condomínio OZmap. É feito dessa forma pois o IXC não reconhece o conceito de condomínio, e segue a seguinte ordem:
São buscados no OZmap todos os condomínios que foram criados ou sofreram alteração desde o ultimo intervalo de sincronização e, além disso, condominios que não estiverem em projeto e o splitter OZmap tenha o atributo de permitir conexão de cliente ativo.
Caso seja um condomínio que não exista ainda no IXC, para cada splitter que tenha portas livres deste condomínio, será criado uma caixa no IXC. Após a criação dessas caixas no IXC, elas são identificados pelo nome do condomínio OZmap mais o nome do splitter OZmap; Um exemplo de nome seria:
COND. RIO BRANCO - Splitter-01Caso seja um condomínio existente no IXC que teve alteração no OZmap, essa alteração é replicada na caixa IXC;
Uma vez ao dia, é tentado realizar a criação/atualização de condominios que houveram erros em sincronizações anteriores;
Criação de Clientes no OZmap
...
Caso o cliente não tenha informações de porta no OZmap e a configuração ‘Desconexão de clientes em trocas de porta caso não tenham informações de conexão no sistema fonte’ esteja ativa, também faz a desconexão do cliente no IXC.
IMPORTANTE:
A atualização de caixa e/ou porta somente será feita caso haja uma caixa no IXC vinculada com a caixa OZmap do cliente.
Caso a configuração “Atualizar fibra de cliente IXC” esteja ativa, também será atualizado as informações de porta da ONU/fibra do cliente no IXC.
Caso o sistema escolhido como fonte seja o IXC:
Caso o cliente no OZmap esteja em uma caixa diferente no IXC, e:
Não use a configuração “Utilizar o Splitter OZmap como Caixa no IXC”:
É atualizado a caixa e a porta do cliente no OZmap, utilizando o primeiro splitter que permita a conexão de cliente dentro da caixa OZmap.
Caso o cliente no OZmap esteja na mesma caixa no IXC, porém esteja em portas diferentes, é atualizado a porta OZmap do cliente com o valor existente no IXC.
Use a configuração “Utilizar o Splitter OZmap como Caixa no IXC”:
É atualizado a caixa e a porta do cliente no OZmap, utilizando o splitter OZmap que foi vinculado com a caixa IXC e a caixa em que esse splitter se encontra no OZmap.
Caso o cliente no OZmap esteja na mesma caixa no IXC, porém esteja em portas diferentes, é atualizado a porta OZmap do cliente com o valor existente no IXC.
Caso o cliente não tenha informações de porta no IXC e a configuração ‘Desconexão de clientes em trocas de porta caso não tenham informações de conexão no sistema fonte’ esteja ativa, também faz a desconexão do cliente no OZmap.
IMPORTANTE: A atualização de caixa e/ou porta somente será feita caso haja uma caixa no OZmap vinculada com a caixa IXC do cliente.
Atualização das Coordenadas do Cliente
A atualização de coordenadas consiste em atualizar as coordenadas do cliente IXC com base na leitura do OZmap, e ocorre da seguinte forma:
É feito a leitura de todos os clientes no IXC ;Para cada cliente no IXC, é verificado se existe um cliente OZmap, procurando pelo código do cliente OZmap semelhante que possuem o tipo de conexão fibra (tipo_conexao_mapa = “f”) e o status de login ativo (ativo = “s”);
A integração busca clientes no OZmap com código igual ao atributo de login IXC definido para a integração;
A integração tentará criar os clientes que existem no IXC mas não existem no OZmap;
Para cada cliente IXC a ser criado no OZmap, será buscado, pelo id da caixa OZmap, se a caixa do cliente no IXC existe no OZmap;
Caso a caixa não exista no OZmap, o cliente não será criado;
Se for encontrado uma caixa correspondente no OZmap, criamos o imóvel no OZmap com o id da caixa do OZmap e o cliente com o código OZmap sendo o atributo de login IXC definido para a integração, e:
Caso a caixa exista no OZmap e tenha splitter, criamos o cliente no splitter e na porta lida no IXC;
Caso não seja encontrada a porta do cliente IXC, no OZmap, o cliente OZmap é conectado na primeira porta disponível no splitter OZmap;
No OZmap, por padrão atualmente, os clientes criados são posicionados ao redor de suas caixas, não sendo utilizado o endereço ou coordenadas do IXC para esse posicionamento.
Sincronização de Caixas
...
(Importante: O vínculo é estabelecido entre o atributo de login no IXC e o código do cliente no OZmap. Portanto, se houver qualquer alteração no atributo de login de um cliente no IXC que já esteja vinculado a um cliente no OZmap, esse vínculo será desfeito e não será refeito automaticamente);
A integração compara os valores de latitude e longitude cadastrados no login IXC, com a latitude e longitude da propriedade do cliente no OZmap.
Caso haja divergência entre os valores de IXC e OZmap e:
O sistema fonte para as coordenadas seja o OZmap:
Os dados de latitude e longitude do cliente no IXC são atualizados com os valores presentes no OZmap.
O sistema fonte para as coordenadas seja o IXC:
A integração verifica se o cadastro de login do cliente no IXC teve alguma alteração desde a última sincronização ou se é um cliente novo:
Caso o cliente se enquadre nessas condições, os dados de latitude e longitude do cliente no OZmap são atualizados com os valores presentes no login do IXC.
Sincronização de Condomínios
A sincronização de condomínios consiste em criar e atualizar no IXC caixas para cada splitter presente dentro de um condomínio OZmap. É feito dessa forma pois o IXC não reconhece o conceito de condomínio, e segue a seguinte ordem:
Se for uma caixa existente no IXC, e que foi removida do OZmap, é feito uma atualização do status da caixa IXC para inativo (status = “i”).
Configurações Base
...
Parâmetro
...
Descrição
...
Padrão
...
Tempo entre Sincronizações
...
Tempo aguardado entre as sincronizações realizadas pela integração.
...
Configurações Específicas - Caixas
...
Parâmetro
...
Descrição
...
Padrão
...
Considerar OLT
...
Busca um transmissor IXC com IP correspondente ao da OLT OZmap. Caso não seja encontratado, a caixa será criada no IXC com id_transmissor=0.
...
Desativado
...
Transmissor IXC obrigatório para caixas
...
Quando a opção de considerar OLTs estiver ativa, uma caixa ou condominio OZmap só serão atualizados/criados no IXC, se existir transmissor no IXC com IP correspondente ao da IP da OLT OZmap, caso contrário, não serão atualizados/criados.
...
Desativado
...
Considerar Projeto
...
Uma caixa ou condominio OZmap só serão atualizados/criados no IXC, se o nome do projeto no IXC for exatamente o mesmo nome do projeto no OZmap (Ex. Projeto e PROJETO são diferentes), caso contrário, não serão atualizados.
...
Desativado
...
Utilizar o Splitter OZmap como Caixa no IXC
...
Criar caixas no IXC para cada splitter no OZmap. Se tiver desabilitado, para cada caixa no OZmap é criada uma caixa no IXC, e a disponibilidade é a soma de todas as portas de todos os splitters da caixa no OZmap.
...
Desativado
...
Sincronização de Condominios
...
Criar caixas no IXC para cada splitter em um condominio no OZmap.
...
Desativado
Configurações Específicas - Clientes
...
Parâmetro
...
Descrição
...
Padrão
...
Código de vínculo entre clientes
...
Atributo do login IXC que será usado como código de cliente OZmap na busca de clientes entre os dois sistemas, para execução de todas as funcionalidades ligadas a login IXC / cliente OZmap. Deve ser um código único no IXC.
...
login
...
Implantar Clientes Automaticamente no OZmap
...
Todos os clientes IXC que não estão implantados no OZmap, mas possuem o status ativo no IXC, serão implantados no OZmap.
...
Desativado
...
Criar Clientes Automaticamente no OZmap
...
Clientes que existem no IXC porém não existem no OZmap serão criados no OZmap caso a caixa do cliente no IXC seja encontrada pelo nome no OZmap.
...
Desativado
...
Atualizar Porta do Cliente no IXC
...
A atualização de porta consiste em identificar que um cliente foi alterado de caixa/porta no OZmap, e replicar essa atualização para o IXC.
...
Desativado
...
Atualizar Coordenadas do Cliente no IXC
...
Atualização dos atributos de latitude e longitude do login IXC, com base na leitura de coordenadas da propriedade do cliente OZmap, caso esses valores sejam divergentes entre os sistemas.
...
Desativado
...
Desconectar Automaticamente Cliente Inativo IXC do Splitter OZmap
...
Quando um cliente tem o status de login mudado para inativo no IXC, ele é excluido do OZmap e desconectado automaticamente da porta que ele está ocupando no splitter OZmap.
...
Desativado
...
Criar Cliente IXC na Caixa OZmap
...
Ao criar um novo cliente no OZmap, caso não seja encontrado o splitter OZmap que o cliente está no IXC, ele é criado dentro da caixa, mas, sem ligação com o splitter de atendimento.
OBS: Essa configuração só tem validade, caso a configuração de utilizar splitters OZmap como caixas no IXC estiver desabilitada.
...
Desativado
...
Atualização de endereço dos Clientes OZmap
...
Atualização do campo de endereço na propriedade do cliente no OZmap, com base na leitura de endereço do cliente no IXC, caso esses valores sejam divergentes entre os sistemas.
...
Ativado
...
Atualização de potência dos Clientes OZmap
...
Atualização do campo de potência na propriedade do cliente no OZmap, com base na leitura da potência do cliente no IXC, caso esses valores sejam divergentes entre os sistemas.
...
Ativado
...
Limite de alteração de potência
...
Limite mínimo de alteração da potência no IXC para que a potência lida do cliente no OZmap seja atualizada.
...
0.5
...
Atualização do status dos Clientes OZmap
...
Atualização do status do cliente no OZmap, com base na leitura de status do cliente no IXC, caso esses valores sejam divergentes entre os sistemas.
...
Ativado
Dados Acesso
https://docs.google.com/forms/u/2/d/1ujtHdsXTYYTD1mH8jzikW6eK6TVuVdfNqeTSRtEvtnw/edit?usp=drive_web
IXC
Dados de acesso necessários para buscar informações via API no sistema IXC. (Estes dados devem ser fornecidos no questionário inicial)
...
Parâmetro
...
Descrição
...
Exemplo
...
URL
...
URL do servidor que contém o serviço externo para conexão.
...
https://ixc.cliente.com.br
...
Token
...
Token provido pelo cliente para acessar o serviço.
...
10:cb582f30dadd4a3311f8ebafbd045884ad9e51249d03fcd481050141b1325b78
...
Liberação de IPs
Para validação e execução da integração no ambiente de produção, é necessário serem liberados no servidor do cliente os IPs utilizados pelo OZmap:
Servidor OZmap do cliente (ping cliente.ozmap.com.br)
...
Também se faz necessária a liberação dos mesmos IPs acima no próprio IXC, normalmente por solicitação do cliente ao suporte IXC.
Logs
Os logs desta integração estão disponíveis no endereço:
https://cliente.ozmap.com.br/integrations/ixc/logs
Questionário
...
Pergunta
...
Resposta
...
Funcionalidade
...
É possível utilizar apenas algumas das funcionalidades acima?
...
Sim, atualmente são opcionais algumas funcionalidades
...
Criar Cliente, Atualizar Porta do Cliente, Desconectar Automaticamente Cliente do Splitter, Implantar Cliente, Atualizar potência do Cliente, Atualizar status do Cliente.
...
Caso a configuração de considerar o projeto esteja desativada, para realizar a sincronização de um novo projeto do OZmap no IXC, é necessário criar o projeto no IXC ou apenas criando no OZmap ele já cria o projeto e sincroniza os elementos?
...
É necessário criar também o projeto no IXC com o mesmo nome do projeto OZmap. Caso contrário, o projeto e os elementos dele não serão sincronizados.
...
Considerar o Projeto.
...
Quais atributos de login IXC podem ser usados como código de cliente OZmap?
...
Qualquer atributo do login IXC que seja único no sistema (só exista um para cada login). Por exemplo: id_contrato, deve ser um contrato para um login, se houver mais de um login com esse id_contrato, não pode ser usado como código. O mesmo vale para os demais atributos de login IXC.
...
Criar Cliente, Cancelar cliente e todas as atualizações de clientes no OZmap e no login IXC.
...
Quando não é utilizada a configuração específica “Considerar Projeto”, qual id de projeto é utilizado nas caixas OZmap criadas/editadas no IXC?
...
Por padrão, a caixa é criada/editada no IXC utilizando como id de projeto “0” .
...
Atualização e Criação de Caixas
...
Quando não é utilizada a configuração específica “Considerar OLT”, qual id de transmissor é utilizado nas caixas OZmap criadas/editadas no IXC?
...
Por padrão, a caixa é criada/editada no IXC utilizando como id de transmissor “0”.
...
Atualização e Criação de Caixas
...
Quando utilizada a configuração “Considerar OLT” e não for encontrado um transmissor IXC correspondente à OLT OZmap, a caixa OZmap será criada/editada no IXC?
...
Caso a configuração “Transmissor IXC obrigatório para caixas” esteja desabilitada, a caixa será criada/editada no IXC com id de transmissor “0”.
...
Atualização e Criação de Caixas
...
Há alguma funcionalidade na integração para atualização de coordenadas dos clientes no OZmap com base nesse dado do IXC?
...
Atualmente não, mas é possível implementar via sugestão de melhoria.
Hoje só é possível atualizar coordenadas dos clientes no IXC com base nesse dado do OZmap.
...
-
...
A integração realiza atualização de portas/splitter/caixa do IXC para o OZmap?
...
Não, atualmente a integração só realiza atualização de portas de clientes do OZmap para o IXC, ou seja, as alterações de portas/splitter/caixa realizadas no OZmap são replicadas ao IXC.
...
São buscados no OZmap as caixas todos os condomínios que foram criadas criados ou sofreram alteração desde o ultimo intervalo de sincronização e, além disso, a caixa OZmap deve possuir a capacidade para atender clientes, não pode estar em projeto e, serão considerados para criação/atualização somente splitters que permitam conexão de cliente;
Caso a caixa não existir no IXC, a mesma será criada no IXC com as informações obtidas na sincronização, essas informações se encontra na tabela abaixo, mostrando qual o valor será pego do OZmap e atribuido no IXC. Por padrão, o OZmap cria apenas uma caixa no IXC e soma a quantidade de portas considerando o total de portas de splitters de atendimento na caixa OZmap e atribui essa informação no IXC;
...
Atributo da Caixa no IXC
...
Atributo da Caixa no OZmap
...
Exemplo
...
Descrição
...
Nome
...
AL1-CTO-4-8
...
Capacidade
...
Quantidade de Portas de Splitter de Atendimento
...
16
...
ID do Projeto
...
ID do Projeto
...
0
...
ID do Transmissor
...
ID do Transmissor
...
0
...
Latitude e Longitude
...
Latitude e Longitude
...
-3.010164, -59.959736
...
Endereço
...
Endereço
...
-
...
Observação
...
Observação
...
-
Caso seja uma caixa existente no IXC que teve alteração no OZmap, essa alteração é replicada na caixa IXC;
É possível habilitar a configuração de utilizar os splitters OZmap como caixas no IXC, cada splitter presente dentro de uma caixa no OZmap, é criado como caixa no IXC, isso se dá ao fato do IXC não reconhecer o conceito de splitters, então, cada splitter no OZmap equivale a uma caixa no IXC.
...
Atributo da Caixa no IXC
...
Atributo do Splitter no OZmap
...
Exemplo
...
Nome
...
Utilizado o Identificador do projeto, nome do splitter e nome da caixa
...
[Exemplo] Splitter 01 [AL1-CTO-4-8]
...
Capacidade
...
Quantidade de Portas do Splitter
...
16
...
ID do Projeto
...
ID do Projeto da Caixa
...
0
...
ID do Transmissor
...
ID do Transmissor da Caixa
...
0
...
Endereço
...
Endereço da Caixa
...
-
...
Latitude e Longitude
...
Latitude e Longitude da Caixa
...
-3.010164, -59.959736
...
Observação
...
Utilizado o nome da caixa e a observação do splitter.
...
Caixa: AL1-CTO-4-8
Observação Splitter
que o splitter OZmap tenha o atributo de permitir conexão de cliente ativo.
Caso seja um condomínio que não exista ainda no IXC, para cada splitter que tenha portas livres deste condomínio, será criado uma caixa no IXC. Após a criação dessas caixas no IXC, elas são identificados pelo nome do condomínio OZmap mais o nome do splitter OZmap; Um exemplo de nome seria:
COND. RIO BRANCO - Splitter-01Caso seja um condomínio existente no IXC que teve alteração no OZmap, essa alteração é replicada na caixa IXC;
Criação de Clientes no OZmap
A criação de clientes consiste em buscar todos os clientes que existem no IXC e que não existem no OZmap, e criá-los no OZmap, seguindo a seguinte ordem:
É feito a leitura de todos os clientes no IXC;
Para cada cliente no IXC, é verificado se existe um cliente OZmap, procurando pelo código do cliente OZmap semelhante ao atributo de login IXC definido para a integração;
A integração tentará criar os clientes que existem no IXC mas não existem no OZmap;
Para cada cliente IXC a ser criado no OZmap, será buscado, pelo id da caixa OZmap, se a caixa do cliente no IXC existe no OZmap;
Caso a caixa não exista no OZmap, o cliente não será criado;
Se for encontrado uma caixa correspondente no OZmap, criamos o imóvel no OZmap com o id da caixa do OZmap e o cliente com o código OZmap sendo o atributo de login IXC definido para a integração, e:
Caso a caixa exista no OZmap e tenha splitter, criamos o cliente no splitter e na porta lida no IXC;
Caso não seja encontrada a porta do cliente IXC, no OZmap, o cliente OZmap é conectado na primeira porta disponível no splitter OZmap;
No OZmap, por padrão atualmente, os clientes criados são posicionados ao redor de suas caixas, não sendo utilizado o endereço ou coordenadas do IXC para esse posicionamento.
Sincronização de Caixas
A criação e atualização de caixas OZmap no IXC consiste em criar caixas no IXC que existam no OZmap mas ainda não existam no IXC, e, identificar caixas já sincronizadas que tiveram alguma atualização no OZmap para ser replicada no IXC, e seguem a seguinte ordem:
São buscados no OZmap as caixas que foram criadas ou sofreram alteração desde o ultimo intervalo de sincronização e, além disso, a caixa OZmap deve possuir a capacidade para atender clientes, não pode estar em projeto e, serão considerados para criação/atualização somente splitters que permitam conexão de cliente;
Caso a caixa não existir no IXC, a mesma será criada no IXC com as informações obtidas na sincronização, essas informações se encontra na tabela abaixo, mostrando qual o valor será pego do OZmap e atribuido no IXC. Por padrão, o OZmap cria apenas uma caixa no IXC e soma a quantidade de portas considerando o total de portas de splitters de atendimento na caixa OZmap e atribui essa informação no IXC;
Atributo da Caixa no IXC | Atributo da Caixa no OZmap | Exemplo |
|---|---|---|
Descrição | Nome | AL1-CTO-4-8 |
Capacidade | Quantidade de Portas de Splitter de Atendimento | 16 |
ID do Projeto | ID do Projeto | 0 |
ID do Transmissor | ID do Transmissor | 0 |
Latitude e Longitude | Latitude e Longitude | -3.010164, -59.959736 |
Endereço | Endereço | - |
Observação | Observação | - |
Caso seja uma caixa existente no IXC que teve alteração no OZmap, essa alteração é replicada na caixa IXC;
É possível habilitar a configuração de utilizar os splitters OZmap como caixas no IXC, onde cada splitter de atendimento presente dentro de uma caixa no OZmap que não esteja “Em projeto” ou dentro de um condomínio vertical, é criado como caixa no IXC. Isso se dá ao fato do IXC não reconhecer o conceito de splitters, então, cada splitter no OZmap equivale a uma caixa no IXC com essa configuração.
Atributo da Caixa no IXC | Atributo do Splitter no OZmap | Exemplo |
|---|---|---|
Nome | Utilizado o Identificador do projeto, nome do splitter e nome da caixa | [Exemplo] Splitter 01 [AL1-CTO-4-8] |
Capacidade | Quantidade de Portas do Splitter | 16 |
ID do Projeto | ID do Projeto da Caixa | 0 |
ID do Transmissor | ID do Transmissor da Caixa | 0 |
Endereço | Endereço da Caixa | - |
Latitude e Longitude | Latitude e Longitude da Caixa | -3.010164, -59.959736 |
Observação | Utilizado o nome da caixa e a observação do splitter. | Caixa: AL1-CTO-4-8 |
Se for uma caixa existente no IXC, e que foi removida do OZmap (caixa removida no OZmap para quem usa caixas OZmap como caixas IXC, ou caso o cliente use splitters OZmap como caixas IXC, seja o splitter ou caixa do splitter removida no OZmap) é feita uma atualização do status da caixa IXC para inativo (status = “i”) e adicionado um prefixo de (INATIVA).
Se a configuração ‘Remover caixas IXC que foram deletadas no OZmap’ estiver ativa, a caixa é então removida no IXC.
Retentativa de elementos com erro
Por padrão, elementos que possuíram erros de tratamento 5 vezes seguidas são limitados automaticamente pela integração, sendo somente retentados novamente de 24 em 24 horas, uma lista dos elementos sendo retentados pode ser visualizada na auditoria da integração.
Configurações Base
Parâmetro | Descrição | Padrão | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
Tempo entre Sincronizações | Tempo aguardado entre as sincronizações realizadas pela integração. |
| ||||||||||
Limitar tentativa de elementos com erro. | Se elementos com erros seguidos devem ter suas tentativas limitadas pela integração. | Desativado |
Configurações Específicas - Caixas
Parâmetro | Descrição | Padrão |
|---|---|---|
Considerar OLT | Busca um transmissor IXC com IP correspondente ao da OLT OZmap. Caso não esteja ligado a uma OLT no OZmap ou não seja encontrado o transmissor correspondente no IXC, a caixa será criada no IXC com id_transmissor=0. | Desativado |
Transmissor IXC obrigatório para caixas | Quando a opção de considerar OLTs estiver ativa, uma caixa ou condomínio OZmap só serão atualizados/criados no IXC, se existir transmissor no IXC com IP correspondente ao da IP da OLT OZmap, caso contrário, não serão atualizados/criados. | Desativado |
Considerar Projeto | Uma caixa ou condomínio OZmap só serão atualizados/criados no IXC, se o nome do projeto no IXC for exatamente o mesmo nome do projeto no OZmap (Ex. Projeto e PROJETO são diferentes), caso contrário, não serão atualizados. | Desativado |
Utilizar o Splitter OZmap como Caixa no IXC | Criar caixas no IXC para cada splitter no OZmap. Se tiver desabilitado, para cada caixa no OZmap é criada uma caixa no IXC, e a disponibilidade é a soma de todas as portas de todos os splitters da caixa no OZmap. | Desativado |
Sincronização de Condomínios | Criar caixas no IXC para cada splitter em um condomínio no OZmap. | Desativado |
Remover caixas IXC que foram deletadas no OZmap | Caixas deletadas no OZmap também são removidas do IXC. | Ativado |
Configurações Específicas - Clientes
Parâmetro | Descrição | Padrão |
|---|---|---|
Código de vínculo entre clientes | Atributo do login IXC que será usado como código de cliente OZmap na busca de clientes entre os dois sistemas, para execução de todas as funcionalidades ligadas a login IXC / cliente OZmap. Deve ser um código único no IXC. | login |
Implantar Clientes Automaticamente no OZmap | Todos os clientes IXC que não estão implantados no OZmap, mas possuem o status ativo no IXC, serão implantados no OZmap. | Desativado |
Criar Clientes Automaticamente no OZmap | Clientes que existem no IXC porém não existem no OZmap serão criados no OZmap caso a caixa do cliente no IXC seja encontrada pelo nome no OZmap. | Desativado |
Atualizar Porta de Clientes | Ao trocar um cliente de porta no sistema escolhido como fonte, replica essa alteração no sistema oposto | Desativado |
Fonte de informações de portas para sincronização de portas entre os sistemas OZmap e IXC | O sistema fonte que contém os dados de portas corretos e que serão propagados ao sistema oposto. | ozmap |
Atualizar Coordenadas de Clientes | Atualização dos atributos de latitude e longitude de clientes, com base na leitura do sistema escolhido como fonte. | Desativado |
Fonte de coordenadas para sincronização de coordenadas entre os sistemas | O sistema fonte que contém os dados de coordenadas corretos e que serão propagados ao sistema oposto. | ozmap |
Desconectar Automaticamente Cliente Inativo IXC do Splitter OZmap | Quando um cliente tem o status de login mudado para inativo no IXC, o cliente é excluído do OZmap e o imóvel é desconectado automaticamente da porta que ele está ocupando no splitter OZmap, porém o drop permanece ligado a caixa (solto). | Desativado |
Criar Cliente IXC na Caixa OZmap | Ao criar um novo cliente no OZmap, caso não seja encontrado o splitter OZmap que o cliente está no IXC, ele é criado dentro da caixa, mas, sem ligação com o splitter de atendimento. OBS: Essa configuração só tem validade, caso a configuração de utilizar splitters OZmap como caixas no IXC estiver desabilitada. | Desativado |
Atualização de endereço dos Clientes OZmap | Atualização do campo de endereço na propriedade do cliente no OZmap, com base na leitura de endereço do cliente no IXC, caso esses valores sejam divergentes entre os sistemas. | Ativado |
Atualização de potência dos Clientes OZmap | Atualização do campo de potência na propriedade do cliente no OZmap, com base na leitura da potência do cliente no IXC, caso esses valores sejam divergentes entre os sistemas. | Ativado |
Limite de alteração de potência | Limite mínimo de alteração da potência no IXC para que a potência lida do cliente no OZmap seja atualizada. | 0.5 |
Atualização do status dos Clientes OZmap | Atualização do status do cliente no OZmap, com base na leitura de status do cliente no IXC, caso esses valores sejam divergentes entre os sistemas. | Ativado |
Desconexão de clientes em trocas de porta caso não tenham informações de conexão no sistema fonte | Decide se a desconexão de clientes e também a falta de conexão de clientes no sistema fonte será propagada para o sistema oposto. | Desativado |
Atualizar fibra de cliente IXC | Decide se as informações de ONU/fibra do cliente IXC também serão atualizadas caso haja uma troca de porta com fonte OZmap. | Desativado |
Dados Acesso
https://docs.google.com/forms/u/2/d/1ujtHdsXTYYTD1mH8jzikW6eK6TVuVdfNqeTSRtEvtnw/edit?usp=drive_web
IXC
Dados de acesso necessários para buscar informações via API no sistema IXC. (Estes dados devem ser fornecidos no questionário inicial)
Parâmetro | Descrição | Exemplo |
|---|---|---|
URL | URL do servidor que contém o serviço externo para conexão. | https://ixc.cliente.com.br |
Token | Token provido pelo cliente para acessar o serviço. | 10:cb582f30dadd4a3311f8ebafbd045884ad9e51249d03fcd481050141b1325b78 |
OZmap
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Liberação de IPs
Para validação e execução da integração no ambiente de produção, é necessário serem liberados no servidor do cliente os IPs utilizados pelo OZmap:
Servidor OZmap do cliente (ping cliente.ozmap.com.br)
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Também se faz necessária a liberação dos mesmos IPs acima no próprio IXC, normalmente por solicitação do cliente ao suporte IXC.
Auditoria
A integração possui uma auditoria de elementos que pode ser acessada pelo dashboard do OZmap ou com as instruções disponibilizadas pela rota de logs da integração, mais informações sobre essa auditoria podem ser encontradas neste link.
Questionário
Pergunta | Resposta | Funcionalidade |
|---|---|---|
É possível utilizar apenas algumas das funcionalidades acima? | Sim, atualmente são opcionais algumas funcionalidades | Criar Cliente, Atualizar Porta do Cliente, Desconectar Automaticamente Cliente do Splitter, Implantar Cliente, Atualizar potência do Cliente, Atualizar status do Cliente. |
Caso a configuração de considerar o projeto esteja desativada, para realizar a sincronização de um novo projeto do OZmap no IXC, é necessário criar o projeto no IXC ou apenas criando no OZmap ele já cria o projeto e sincroniza os elementos? | É necessário criar também o projeto no IXC com o mesmo nome do projeto OZmap. Caso contrário, o projeto e os elementos dele não serão sincronizados. | Considerar o Projeto. |
Quais atributos de login IXC podem ser usados como código de cliente OZmap? | Qualquer atributo do login IXC que seja único no sistema (só exista um para cada login). Por exemplo: id_contrato, deve ser um contrato para um login, se houver mais de um login com esse id_contrato, não pode ser usado como código. O mesmo vale para os demais atributos de login IXC. | Criar Cliente, Cancelar cliente e todas as atualizações de clientes no OZmap e no login IXC. |
Quando não é utilizada a configuração específica “Considerar Projeto”, qual id de projeto é utilizado nas caixas OZmap criadas/editadas no IXC? | Por padrão, a caixa é criada/editada no IXC utilizando como id de projeto “0” . | Atualização e Criação de Caixas |
Quando não é utilizada a configuração específica “Considerar OLT”, qual id de transmissor é utilizado nas caixas OZmap criadas/editadas no IXC? | Por padrão, a caixa é criada/editada no IXC utilizando como id de transmissor “0”. | Atualização e Criação de Caixas |
Quando utilizada a configuração “Considerar OLT” e não for encontrado um transmissor IXC correspondente à OLT OZmap, a caixa OZmap será criada/editada no IXC? | Caso a configuração “Transmissor IXC obrigatório para caixas” esteja desabilitada, a caixa será criada/editada no IXC com id de transmissor “0”. | Atualização e Criação de Caixas |
Há alguma funcionalidade na integração para atualização de coordenadas dos clientes no OZmap com base nesse dado do IXC? | Sim, agora contamos com uma funcionalidade que permite fazer ou a alteração do OZmap para o IXC ou a alteração do IXC para o OZmap. | Atualizar Coordenadas de Clientes |
A integração realiza atualização de portas/splitter/caixa do IXC para o OZmap? | Sim, agora contamos com uma funcionalidade que permite fazer ou a alteração do OZmap para o IXC ou a alteração do IXC para o OZmap. | Atualizar Porta de Clientes |
Ao excluir um cliente no OZmap, ele será removido no IXC? | Não, a integração não cria ou remove clientes do IXC. | - |
Ao excluir um cliente no IXC, ele será removido do OZmap? | Não, a única condição para um cliente ser removido no OZmap é por cancelamento de conexão no IXC. | Cancelamento de Clientes |
Caso ocorra a viabilidade de um cliente no IXC (criação de um cliente em uma caixa) ocorrerá a criação do cliente no OZmap? | Sim, caso o cliente estiver no IXC em uma caixa e não no OZmap, a integração irá criar o cliente no OZmap. | Criação de Clientes |
Se o login de um cliente for alterado no IXC, o vínculo com o cliente no OZmap será perdido? | Sim, ao alterar o login no IXC, o vínculo com o cliente no OZmap será perdido e não será restaurado automaticamente. Isso impede que a integração consiga identificar o cliente no OZmap. Para corrigir, é necessário ajustar manualmente o código do cliente no OZmap, tornando-o idêntico ao novo login no IXC. |
//Anotar as perguntas e possíveis respostas e quais as funcionalidades relacionadas às respostas.