Instalação e atualização do conector iPeS
A plataforma iPES mantém um canal de releases do conector para integração rápida dos sistemas oficialmente suportados. Esta página apresenta detalhes relevantes e uma visão geral sobre a instalação e a execução do conector.
Sistemas suportados
| Sistema | Versões suportadas | Dados extraídos |
|---|---|---|
| AGHU | A definir | Pacientes Profissionais Sumário de alta |
| e-SUS APS (CDS) | v3.x ou mais recente | Pacientes Profissionais Coleta de dados simplificada Registro de imunobiológico administrado |
| e-SUS APS (PEC) | v3.x, v4.0.x, v4.1.x, v5.x | Agendamentos Pacientes Profissionais Registro de atendimento clínico Registro de imuniobiológico administrado |
| e-SUS Notifica | Sem restrição conhecida | Pacientes Notificação de caso suspeito de COVID-19 |
| GAL | A definir | Pacientes Profissionais Resultado de exame |
| GSEA | Sem restrição conhecida | Pacientes Profissionais Registro de atendimento clínico |
| iPeS/Vitai | Todas | Pacientes Profissionais Registro de atendimento clínico Sumário de alta |
| Hórus | A definir | Paciente Registro de dispensação de medicamentos |
| SISUPA | Sem restrição conhecida | Pacientes Profissionais Registro de atendimento clínico |
| Schema iPES | Todas | Registro de atendimento clínico Sumário de alta |
Notas de lançamento
| Versão | Data | Atualizações |
|---|---|---|
| 2.21.1 | 09/09/2025 | |
| 2.21.0 | 05/09/2025 | |
| 2.20.0 | 25/08/2025 | |
| 2.19.0 | 14/08/2025 | |
| 2.18.0 | 13/08/2025 | |
| 2.17.0 | 06/06/2025 | |
| 2.16.0 | 15/01/2025 | |
| 2.15.0 | 10/09/2024 | |
| 2.14.0 | 08/09/2024 | |
| 2.13.0 | 04/09/2024 | |
| 2.12.0 | 06/08/2024 | |
| 2.11.0 | 14/05/2024 | |
| 2.10.0 | 21/04/2024 | |
| 2.9.0 | 18/12/2023 | |
| 2.8.0 | 06/10/2023 | |
| 2.7.0 | 20/07/2023 | |
| 2.5.0 | 12/01/2023 | |
| 2.3.0 | 22/11/2022 | |
| 2.1.0 | 18/11/2022 | |
| 1.9.0 | 17/10/2022 | |
| 1.8.0 | 16/09/2022 | |
| 1.7.0 | 09/06/2022 | |
| 1.6.2 | 18/01/2022 | |
| 1.6.1 | 15/10/2021 | |
| 1.6.0 | 27/09/2021 | |
| 1.5.0 | 21/09/2021 | |
| 1.4.0 | 29/04/2021 | |
| 1.3.0 | 19/04/2021 | |
| 1.2.0 | 14/01/2021 | |
| 1.1.0 | 03/12/2020 | |
| 1.0.9 | 23/10/2020 | spring.config.additional-location |
| 1.0.8 | 24/08/2020 | |
| 1.0.7 | 03/08/2020 | beans.xml |
| 1.0.6 | 28/07/2020 | |
| 1.0.5 | 24/07/2020 | |
| 1.0.4 | 20/07/2020 | |
| 1.0.3 | 12/06/2020 | |
| 1.0.2 | 07/06/2020 | |
| 1.0.1 | 22/05/2020 | |
| 1.0.0 | 19/05/2020 |
Pré-requisitos
- 2GB ou mais de memória RAM
- 2GB ou mais de espaço espaço em disco (HD ou SSD)
- Conexão de saída para a plataforma iPES via internet
- Conexão de saída para o banco de dados do sistema de origem (preferencialmente via intranet)
Além dos critérios de infraestrutura mencionados acima, o mecanismo de instalação/atualização do conector é baseado em um script que implanta um processo de controle associado a um processo de execução/extração. As dependências (Java 9 e Groovy 3) são baixadas e configuradas automaticamente através de rotinas testadas nos seguintes sistemas operacionais:
- Windows 7, 10 e 11 (execução automática como serviço do sistema operacional)
- Linux (execução automática via
init.dousystemd), preferencialmente CentOS, Ubuntu ou similares
Finalmente, para adesão ao ecossistema da plataforma iPES, instalações de conectores devem ser autorizadas para geração das respectivas credenciais. Entre em contato com o gestor municipal/estadual responsável ou com a nossa equipe para mais informações.
Planejamento e dimensionamento
Como o conector foi projetado para coabitar a infraestrutura do sistema a ser integrado sem causar prejuízo significativo ou comprometer o desempenho e o funcionamento dos recursos computacionais, a extração e a transformação dos dados ocorrem em passo discreto, usualmente limitado a alguns milhares de registros por hora em equipamentos commodity. Dependendo da volumetria do sistema a ser integrado e do período passado a ser processado, instâncias adicionais do conector podem ser instaladas simultaneamente para tratar dados legados. Também é possível ainda a execução em paralelo através de réplicas de leitura e o processamento de registros em nuvem através de dumps.
Instruções e queries para avaliação da volumetria estão disponíveis na documentação dos sistemas suportados.
Instalação e atualização do conector
O conector conta com um assistente de instalação disponível no site da plataforma. Múltiplas instalações na mesma máquina são possíveis, desde que em diretórios distintos.
Execução do instalador
As instruções a seguir são baseadas no Ubuntu, mas passos análogos são aplicáveis para outros sistemas operacionais. Por conveniência, o instalador do conector está disponível tanto como release.tar.zip quanto release.tar.gz.
sudo su
mkdir -p /opt/ipes-connector
cd /opt/ipes-connector
curl -LO https://ipes.tech/res-connector-agent-launcher/release.tar.gz
tar -xvzf release.tar.gz
#Atribuir permissão de execução nos scripts
find . -iname '*.sh' -exec chmod +x {} \;
#Remover eventuais caracteres residuais do Windows que possam atrapalhar a execução dos scripts
sed -i -e 's/\r//g' *.sh
sudo bash install.sh
Analogamente, estão disponíveis também scripts utilitários para desinstalação (uninstall.sh) e execução (run.sh), bem como as respectivas versões para Windows (install.bat, uninstall.bat e run.bat). As dependências externas (Java 9 e Groovy 3) serão resolvidas localmente, sem alterações no PATH ou interferência em outras versões já instaladas, o assistente guiará interativamente as configurações iniciais, o conector será instalado como serviço do sistema operacional e iniciará automaticamente.
Configurações iniciais
| # | Configuração | Descrição | Valor padrão |
|---|---|---|---|
| 1 | Ambiente | Ambiente de execução para onde os dados serão enviados (1) Homologação ou (2) Produção |
(1) Homologação |
| 2 | Client key do serviço de logs | Chave individual para acesso ao serviço de logs É fornecida junto às credenciais de cada conector |
|
| 3 | Client secret do serviço de logs | Segredo individual para acesso ao serviço de logs É fornecido junto às credenciais de cada conector |
|
| 4 | Identificador único | Tag para identificação de uma instalação Especialmente relevante quando há múltiplas instâncias |
Data/hora da instalação |
| 5 | Client ID do serviço de RES | Chave individual para acesso ao serviço de RES É fornecida junto às credenciais de cada conector |
|
| 6 | Client secret do serviço de RES | Segredo individual para acesso ao serviço de RES É fornecido junto às credenciais de cada conector |
|
| 7 | CNES | Código CNES do estabelecimento de saúde responsável | |
| 8 | Tipo de estabelecimento | Tipo de estabelecimento de saúde associado no CNES | |
| 9 | Contato da instalação | Contato local acompanhando ou executando o a instalação do conector | |
| 10 | Sistema de origem | Sistema de origem cujos dados serão integrados pelo conector | e-SUS APS |
| 11 | Data mínima | Data mínima a partir da qual os registros clínicos serão integrados | 2019-01-01 00:00:00.000 |
| 12 | Data máxima | Data máxima até quando os registros clínicos serão integrados Quando inferior à data atual, assume-se que a instância processará legado |
2100-01-01 00:00:00.000 |
| 13 | Duração do lote | Duração (1-168 horas) do lote de registros clínicos processados por vez Caso a volumetria do sistema seja grande, recomenda-se lote menor A granularidade da duração do lote deve respeitar a precisão da origem |
24 |
| 14 | URL JDBC | String de conexão com o banco de dados em formato JDBC | jdbc:postgresql://localhost:5433/esus |
| 15 | Usuário | Usuário para conexão com o banco de dados Recomenda-se novo usuário com permissões de conexão e leitura |
esus_readonly |
| 16 | Senha | Senha para conexão com o banco de dados | esus |
| 17 | Horário de extração | Expressão cron para delimitar o horário em que o conector operaPode ser usado para restringir o acesso ao banco de dados |
* * 0-23 ? * SUN-SAT |
| 18 | Módulo de extratores | Conjunto de extratores e modelos clínicos habilitados para extração Varia com o sistema de origem |
|
| 191 | Municípios excluídos | Permite ignorar registros de municípios específicos durante a extração Evita o reenvio de dados municipais em uma instalação estadual É opcional, codificado como lista de códigos IBGE separados por vírgula |
|
| 202 | Nome amigável do estabelecimento | Nome amigável do estabelecimento de saúde | |
| 212 | Nome formal do estabelecimento | Nome formal (conforme cadastro do CNES) do estabelecimento de saúde |
1 Configuração disponível somente quando conjunto de extratores inclui CDS 2 Configuração disponível somente quando módulo de extratores inclui VITAI
Após a configuração, o conector iniciará automaticamente. Serão criados localmente arquivos PID_CONNECTOR e PID_LAUNCHER, apontando os identificadores dos processos em execução, bem como SID, sinalizando o nome do serviço instalado no no sistema operacional. Após alguns instantes, será populado em tempo de execução o arquivo log/agent.log, em que é possível acompanhar o funcionamento do conector. De uma forma geral, logs do tipo br.com.coreconsulting.res.connector.agent.batch.DocumentExtractorItemReader - detected 10688 document(s) at ./xml/PatientData e br.com.coreconsulting.res.connector.agent.batch.DocumentExtractorDTO - saved audit for PatientData with id = 4875 and status = SUCCESS indicam que a solução está operando positivamente. Para facilitar a observação, a seguinte captura deve apresentar entradas após alguns minutos de execução:
tail -n 999999 -f log/agent.log | grep -E '(detected|and status)'
Adicionalmente, arquivos *.timestamp.txt serão populados no diretório para cada extrator habilitado. Além do script utilitário (run.sh), o conector também pode ser operado como serviço do sistema operacional:
sudo service $(cat SID) stop
sudo service $(cat SID) start
O arquivo SID contém o nome do serviço de acordo com o identificador único de instância usado na instalação, por padrão ipes-connector- com sufixo de data/hora em formato yyyyMMddHHmm.
Atualização periódica
Após a instalação e primeira execução do conector, um processo de controle buscará e atualizará o agente periodicamente sem intervenção manual.
Manutenção e monitoramento remoto
Uma vez que o conector está em execução, heartbeats e logs são enviados periodicamente para a plataforma iPES, onde métricas de funcionamento e progresso são consolidadas e monitoradas para acompanhar a saúde das integrações. Algumas configurações e intervenções pontuais podem ser desempenhadas remotamente sob demanda, e, caso sejam identificadas indisponibilidades de banco de dados ou hardware que demandem suporte direto, a equipe pode acionar os responsáveis locais pelo sistema de origem com base no cadastro da instalação durante o credenciamento.