Essa documentação trata do serviço externo 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 relacionadas.
| Table of Contents | ||||
|---|---|---|---|---|
|
Tipo de Integração
A integração OZmap-Sytex é do tipo Passiva-direta.
Descrição
O Sytex é uma plataforma de gerencimaneto 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 distintas.
Resumo de funcionalidades
Módulo I
Funcionalidade | Descrição | Direção da integração |
|---|---|---|
Atualização e Criação de Caixas | Atualização e Criação no Sytex 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
Funcionalidade | Descrição | Direção da integração |
|---|---|---|
Criação de Projetos | Criação dos projetos OZmap no Sytex por meio de um serviço | OZmap => Sytex |
Criação de Elementos de Rede | 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 no resumo de forma a entender como funciona o fluxo de sincronização.
Sincronização de Projetos
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
Dados de acesso necessários para buscar informações via API no sistema Sytex. (Estes dados devem ser fornecidos no questionário inicial)
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 |
|---|---|---|
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)
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
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 respostas.