IXC

Tipo de Integração

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.

As funcionalidades da integração entre OZmap e IXC se baseiam na leitura de clientes no IXC para atualização, criação e remoção de clientes no OZmap e a criação e remoção de caixas OZmap no IXC. A integração encontra os clientes IXC no OZmap através do login IXC.

OBS: o atributo de login IXC definido para a integração deve ser igual ao “código” do cliente no OZmap para ser encontrado.

Resumo das funcionalidades

Funcionalidades

Implantação e Sincronização de Clientes IXC no OZmap

A implantação e sincronização de informações de clientes IXC no OZmap ocorre com base nas leituras feitas no IXC e ocorrem nas seguintes situações:

• É 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.

• 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:

• 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.

Cancelamento de Clientes

O cancelamento de clientes IXC no OZmap ocorre com base nas leituras feitas no IXC e ocorre nas seguintes situações:

• É 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

Importante: 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 sistema escolhido como fonte, e replicar essa atualização para o sistema, 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;

  • 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.

• 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.

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 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:

• 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, condomínios 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-01

• Caso 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 condomínios que houveram erros em sincronizações anteriores;

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;

• 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.

• 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.

Configurações Base

Configurações Específicas - Caixas

Configurações Específicas - Clientes

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)

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 serem liberados no servidor do cliente os IPs utilizados pelo OZmap:

• Servidor OZmap do cliente (ping cliente.ozmap.com.br)

• 54.207.162.199

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

//Anotar as perguntas e possíveis respostas e quais as funcionalidades relacionadas às respostas.