...
Essa documentação trata do serviço externo da integração com o sistema Sytex. O serviço externo é acessado via API. As funcionalidades descritas aqui indicam as capacidades e os requisitos da integração, bem como as funcionalidades relacionadasA integração é realizada através de chamadas API partindo do Integrador e utilizando a API disponibilizada pelo OZmap.
| Table of Contents | ||||
|---|---|---|---|---|
|
...
O Sytex é uma plataforma de gerencimaneto gerenciamento de atividades de implantação e manutenção de tecnologia, que agiliza a gestão de processos e trabalhos em capo. É responsavel por integrar as etapas do projeto, planejamento, logística e execução da rede FTTH.Existem dois tipos de integração Sytex e são divididas em módulos com funcionalidades distintascampo.
A integração com o OZmap se baseia em uma consulta realizada uma vez ao dia nas caixas OZmap, para realizar a sincronização dessas caixas no Sytex.
Resumo de funcionalidades
Módulo I
Funcionalidade
Descrição
Direção da integração
Criação de Projetos
Funcionalidade | Descrição | Direção da integração |
|---|---|---|
Atualização e Criação Sincronização de Caixas | Atualização e Criação no Sytex criação de todas as caixas que se encontram cadastradas no OZmap. Esse processo é realizado apenas uma vez ao dia às 21hrs. | OZmap => Sytex |
Módulo II
OZmap no Sytex |
OZmap => Sytex |
Criação dos elementos de rede no Sytex
OZmap => Sytex
Atualização de Elementos de Rede
Atualização dos elementos de rede que não existem na base de dados Sytex a partir dos elementos existentes no OZmap
Sytex => OZmap
Atualização do Estado de Implantação
A integração Sytex enviará o estado de implantação ao OZmap para atualizar as caixas com estado “Implantado”
Sytex => OZmap
Atualização de Informação de outros Projetos
Adicionar como informações adicionais no OZmap, outros projetos presentes no Sytex. Exemplo: projetos de manutenção
Sytex => OZmap
Funcionalidades
Abaixo serão descritas as funcionalidades referente apenas a integração Módulo II apresentada apresentadas no resumo de forma a entender como funciona o fluxo de sincronização.
Sincronização
...
São criados todos os projetos definidos no OZmap no Sytex através de um serviço.
Sincronização de Caixas
São criadas no Sytex todas as caixas OZmap com estado diferente de “draft”. Na criação da caixa é passado o nome no OZmap como código no Sytex, são passados as coordenadas (lat, lng) e registradas no campo “NetworkElementoCoordinate” no Sytex e o tipo de elemento de rede (box-type).
Caso a caixa já existe no Sytex é apenas realizado a sua atualização levando em consideração a sua última atualização que pode ser observada na propriedade “updatedAt” no OZmap, se a caixa tiver um updatedAt maior que o presente na base de dados do Sytex é feita a sua atualização.
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
Dados Acesso
Não possui questionário.
Sytex
...
de Caixas
O processo de sincronização de caixas ocorre da seguinte maneira:
Uma vez por dia, às 21 horas, é realizada uma consulta no OZmap para obter informações sobre todas as caixas que não estejam em estado de implantação “Em projeto”.
Após a consulta, é feita uma verificação no Sytex para determinar quais caixas precisam ser atualizadas ou criadas.
O Sytex verifica cada caixa encontrada no OZmap pelo nome, checando se existe uma caixa no Sytex com mesmo nome.
Se não existir, a caixa OZmap é criada no Sytex;
Se existir, a caixa Sytex é atualizada com os dados mais recentes da caixa OZmap.
No Sytex, as caixas OZmap são criadas como Elementos de Rede (EdR), com seu nome, tipo e coordenadas preenchidos e atualizados com os dados obtidos do OZmap.
Além disso, no Sytex, cada caixa representa um ponto de localização, onde o técnico que precisa realizar alguma tarefa no Sytex, pode atribuir a ela uma nova atividade, como um formulário de implantação/manutenção, por exemplo.
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 Sytex.
OZmap
Parâmetro | Descrição | Exemplo |
|---|
IP
IP da máquina que contém o serviço externo para conexão.
192.168.0.2
Token
Token provido pelo cliente para acessar o serviço. Localizado em Configurações > Registro Ravi
Po9eebairai1bo-CaoH2eo2iaVohp-beM7EiThemahph-Aeb6wah2hei8ah
Usuário
Nome usuário do sistema criado para a integração.
ozmap
Senha
Senha de acesso do usuário
-
OZmap
Parâmetro | Descrição | Exemplo |
|---|---|---|
TokenURL API | Endereço do OZmap, com a porta de serviço padrão. | |
Chave API | Token associado a conta do usuário de integração cadastrado no ozmapOZmap. (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)
...
Logs
Os logs da integração são disponibilizados no endereço: https://cliente.ozmap.com.br/integrations/sytex/logs
Questionário
...
Pergunta
...
Resposta
...
Funcionalidade
...
É possível utilizar apenas algumas das funcionalidades acima?
...
Não, até a presente versão todas as funcionalidades são executadas, sem distinção ou configuração que pause uma delas.
...
-
...
É possível alterar o mapeamento de status definidos? Ex: “Online sem dados” ser OK no OZmap
...
Não, até a presente versão o mapeamento de status é fixo, é algo possível de ser feito mediante pedido de melhoria.
...
Atualização de Status
//Anotar as perguntas e possíveis respostas e quais as funcionalidades relacionadas às respostasCaso o servidor OZmap esteja em ambiente ON-Premisses, é necessário liberar nos firewalls o IP do servidor onde está o Sytex 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 |
|---|---|
Caso uma caixa seja excluída no OZmap, ela será excluída no Sytex? | Não, atualmente a integração somente cria e atualiza caixas OZmap no Sytex. |