Versions Compared

Key

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

...

Este documento tem como objetivo apresentar as principais informações sobre a importação de dados do Smartmaps Codemaps para o OZmap, bem como disponibilizar um formulário pré-importação.

Table of Contents
minLevel1
maxLevel7

Descrição

A importação entre Codemaps e OZmap acontece via API, nós realizamos a consulta no Codemaps para realizar a importação dos elementos no OZmap.

Essa documentação trata apenas de um modelo inicial de importação, podendo ser solicitada a importação em formato diferente ou de mais elementos, a ser avaliado pela equipe responsável.

Resumo das funcionalidades

Importação de Tipos

Funcionalidade

Descrição

Importação de Tipos de Splitter

Importar todos os tipos de splitters do Codemaps.

Necessário para a importação de splitters.

Importação de Tipos de Cabo

Importar todos os tipos de cabos do Codemaps.

Necessário para a importação de cabos.

Importação de Elementos

Funcionalidade

Descrição

Importação de Projetos

...

No Smartmaps os elementos são organizados em projetos. Na importação para o OZmap é possível criar projetos com o mesmo nome dos projetos Smartmaps.

Ou seja, se você tem um projeto chamado, por exemplo: ‘Martinópolis', ao realizarmos a importação para o OZmap, o mesmo será criado com o nome encontrado no Smartmaps.

Caso for um projeto que já exista na base do OZmap, ao realizarmos a importação, nada acontecerá com ele no OZmap.

Dados Acesso

...

Parâmetro

...

Descrição

...

Exemplo

...

URL

...

URL do servidor que contém o serviço externo para conexão.

...

https://cliente.smartmaps.com.br

...

Usuário Smartmaps

...

Usuário criado no Smartmaps para realizar acesso via interface e as requisições API.

...

josue.cliente.2@cliente.com.br

...

Senha

...

Senha do usuário criado no Smartmaps para o OZmap enviar requisições API.

...

0zm4p-l1nk

Liberação de IPs

Para validação é necessário serem liberados no servidor do cliente os IPs utilizados pelo OZmap:

  • 54.207.162.199 - VPN

Caso o cliente necessite realizar a liberação do IP da nossa VPN, em paralelo, é necessário informar ao DevOps o IP do cliente para que seja incluído em nossa rota de IP`s;

Importação dos Elementos

Base de Dados e Elementos Importados

A importação é realizada via API do Smartmaps, sendo necessário um usuário e senha. Também necessitamos acesso à interface do Smartmaps para validações pontuais durante o processo de importação.

Na tabela abaixo, especificamos quais elementos trazemos e suas respectivas rotas.

...

ROTA

...

ELEMENTOS

...

SMARTMAPS_URL/splittermodel

...

Tipos de Splitters

...

SMARTMAPS_URL/cablemodel

...

Tipos de Cabos

...

SMARTMAPS_URL/folder/${project_id}/cto

...

Caixas de Terminação Óptica

...

SMARTMAPS_URL/folder/${project_id}/ceo

...

Caixas de Emenda Óptica

...

SMARTMAPS_URL/folder/${project_id}/pop

...

POPs

...

SMARTMAPS_URL/folder/${project_id}/cable?validator=${token}&type=D

...

Cabos

...

SMARTMAPS_URL/equipment/${box_id}/splitter

...

Splitters

...

SMARTMAPS_URL/equipment/${box_id}/connectionDiagram

...

Conexões de Caixas

Tipos e Níveis

...

Elemento

...

Tipo

...

Nível (default)

...

Caixas de Emenda Óptica

...

Não importamos os tipos do Smartmaps

...

CE

...

Caixas de Terminação Óptica

...

Não importamos os tipos do Smartmaps

...

CTO

...

Cabos

...

Importamos os tipos do Smartmaps

...

O mesmo encontrado no Smartmaps

...

Splitters

...

Importamos os tipos do Smartmaps

...

O mesmo encontrado no Smartmaps

Importação dos Equipamentos

  • Será necessário o cliente liberar acesso ao Smartmaps para acesso a API e consultar interface.

  • Não realizamos tradução de tipos de equipamentos.

  • Roteadores, Conversores, ONU e Postes não são importados na versão atual da importação. Não temos previsão da implementação dessa funcionalidade.

Importação das Conexões

Importamos as conexões internas das caixas, POPs e clientes.

OBS: Atualmente na Importação do IXC para o OZmap, não é possível trazer a topologia (diagrama de emenda de caixa), e, os elementos que são importados do IXC, vem de acordo com sua ordem.

...

Importar todos os projetos do Codemaps.

Importação de Caixas

Importar todas as caixas dos tipos CTO e CE do Codemaps.

Importação de POPs

Importar todas as POPs do Codemaps.

Importação de Cabos

Importar todos os cabos do Codemaps.

Importação de Conexões entre Elementos

Importar todas as conexões entre elementos do Codemaps.

Funcionalidades

Funcionalidades

Abaixo serão descritas as funcionalidades do serviço de importação OZmap apresentadas no resumo de forma a entender como funciona o fluxo de importação.

Importações de Tipos

As importações de tipos do Codemaps é feita para permitir que os dados que as utilizam (Cabos e Splitters) possam ser criados no OZmap. As importações ocorrem da seguinte forma:

  • Tipos de Splitter: Os tipos de splitters são importados por completo para o OZmap.

    • O código do tipo de splitter no OZmap é definido pelo nome no Codemaps.

    • Se o tipo de splitter for balanceado no Codemaps:

      • Por padrão, todos os tipos de splitters balanceados criados no OZmap terão a opção “Permitir Conexão com Clientes” ativa.

      • A quantidade de entradas e saídas do tipo de splitter no OZmap é definida pelo nome do tipo de splitter no Codemaps.

      • Se o tipo de splitter for nomeado, por exemplo, 1x16 no Codemaps, no OZmap será criado um tipo de splitter com 1 entrada e 16 saídas.

    • Caso o tipo de splitter for desbalanceado no Codemaps:

      • Por padrão, todos os tipos de splitters desbalanceados criados no OZmap terão a opção “Permitir Conexão com Clientes” desativada.

      • Por padrão, a quantidade de entradas e saidas do tipo de splitter no OZmap é 1 entrada e 2 saídas.

  • Tipos de Cabo: Os tipos de cabos são importados por completo para o OZmap.

    • O código do tipo de cabo no OZmap é definido pelo nome do seu tipo de cabo no Codemaps.

    • Por padrão, o perfil de fibra utilizado nos tipos de cabos do OZmap é o ABNT.

    • Por padrão, todos os tipos de cabos do Codemaps serão importados como cabos primários para o OZmap.

    • A quantidade de fibras do tipo de cabo no OZmap é determinado pelo atributo “Max Fiber” do Codemaps.

    • A quantidade de looses do tipo de cabo no OZmap é determinado pelo atributo “Number Tubes” do Codemaps.

      • É feito uma validação, caso o valor do atributo “Number Tubes” no Codemaps for menor ou igual a 0, a quantidade de looses no tipo de cabo no OZmap será equivalente a 1.

      • Caso o valor do atributo “Number Tubes” no Codemaps for maior que 0, a quantidade de looses no tipo de cabo no OZmap será o mesmo valor encontrado no atributo “Number Tubes”.

Importações de Elementos

As importações de elementos do Codemaps é feita com o objetivo de replicar os elementos de documentação, total ou parcial. As importações de elementos do Codemaps ocorrem da seguinte forma:

  • Projetos: Todos os projetos do Codemaps são importados para o OZmap, replicando as características no OZmap. No Codemaps os elementos são vinculados aos projetos, então, no decorrer da importação do projeto, importaremos também todos os elementos vinculados a esse projeto no Codemaps.

    • O nome do projeto OZmap será o mesmo do projeto do Codemaps.

    • A latitude e longitude do projeto OZmap são um valor fixo, sendo:

      • -23.302531760763703 para latitude.

      • -51.17002487182618 para longitude.

  • Caixas: Todas as caixas do Codemaps são importadas para o OZmap, replicando as características no OZmap. Serão importadas todas as caixas dos tipos CTO e CE do Codemaps.

    • O nome da caixa OZmap será definida pelo nome no Codemaps.

    • Por padrão, o tipo das caixas OZmap serão os mesmos do Codemaps, sendo eles CTO e CE.

    • As coordenadas da caixa OZmap serão as mesmas do Codemaps.

    • Por padrão, todas as caixas serão criadas como implantadas no OZmap.

    • O projeto da caixa OZmap será o mesmo do Codemaps.

  • POPs: Todas as POPs do Codemaps são importadas para o OZmap, replicando as características no OZmap.

    • O nome da POP OZmap será definido pelo nome no Codemaps.

    • As coordenadas da POP no OZmap serão as mesmas do Codemaps.

    • Por padrão, todas as POPs serão criadas como implantadas no OZmap.

    • O projeto da POP OZmap será o mesmo do Codemaps.

    • Por padrão, todas as POPs importadas terão o tipo Comum no OZmap.

  • Cabos: Todos os cabos do Codemaps são importadas para o OZmap, replicando as características no OZmap.

    • O nome do cabo OZmap será definido pelo seu nome no Codemaps.

    • O tipo de cabo OZmap será o mesmo do Codemaps.

    • Os pontos (coordenadas) do cabo OZmap serão os mesmos do Codemaps.

    • Por padrão, todos os cabos serão criados como implantados no OZmap.

    • As pontas dos cabos OZmap serão as mesmas pontas do Codemaps, caso não seja encontrado alguma das pontas, será criado uma caixa fim de cabo.

      • Caso a ponta possua vinculo com algum splitter no Codemaps, o tipo da caixa será “CE” (template vazio) e nível “CE” para facilitar a visualização. O splitter será importado logo na sequencia para o OZmap.

      • Caso a ponta não tenha vinculo com nenhum splitter no Codemaps, o tipo da caixa será “C_FIM_CABO” (template vazio) e nível “CE” para facilitar a visualização.

    • Inclui obrigatoriamente as importação de:

      • Tipos de Cabo

    • Pode depender da importação de:

      • Caixas e POPs

  • Splitters: Todos os splitters do Codemaps são importadas para o OZmap, replicando as características no OZmap. Todos os splitters são importados para o OZmap no decorrer da importação das caixas.

    • O nome do splitter OZmap será seu nome do Codemaps.

    • A caixa do splitter OZmap será a mesma do Codemaps.

    • O tipo do splitter OZmap será o mesmo do Codemaps.

    • Inclui obrigatoriamente as importação de:

      • Tipos de Splitter

    • Pode depender da importação de:

      • Caixas

  • Conexões entre Elementos: Todas as conexões entre elementos são importadas para o OZmap.

    • As conexões se referem as ligações entre elementos dentro de uma caixa como conexões entre cabos e cabos e splitters.

    • Pode depender da importação de:

      • Cabos, Caixas e Splitters

LEGENDA:

“Inclui obrigatoriamente as importação de” - São outros elementos que também precisarão ser importados juntamente com o elemento selecionado pelo cliente no questionário.

“Pode depender da importação de” - São outros elementos que, caso não ser sejam importados, podem impedir a criação dos elementos em questão.

Configurações Base

Dados Acesso

https://forms.gle/DftnSSLSQSaEAhZo7

Dados de acesso necessários para buscar informações via API nos sistemas Codemaps e OZmap. (Estes dados devem ser fornecidos no questionário inicial).

OZmap

Parâmetro

Descrição

Exemplo

URL OZmap

Endereço do OZmap que receberá os elementos importados.

https://cliente1.ozmap.com.br

Codemaps

Parâmetro

Descrição

Exemplo

URL

URL do servidor que contém o serviço externo para conexão.

https://cliente.codemaps.com.br

Usuário Codemaps

Usuário criado no Codemaps para realizar acesso via interface e as requisições API.

cliente@cliente.com.br

Senha

Senha do usuário criado no Codemaps para o OZmap enviar requisições API.

0zm4p-passwd

Dúvidas Frequentes

Pergunta

Resposta

Funcionalidade

É possível realizar a importação via KML/KMZ ?

Não.

-

É necessário criar um usuário com acesso a interface no

Smartmaps

Codemaps ?

Sim, com acesso a interface conseguimos conferir se a importação está correta, assim como conexões internas e etc.

-

É possível importar postes, roteadores, conversores e ONU do Codemaps para o OZmap?

Não, atualmente não é possível.

-