From 60570e5cf9895f6bae976bc5d78030816ba94fad Mon Sep 17 00:00:00 2001 From: Guilherme Andrade Del Cantoni Date: Wed, 8 May 2019 15:51:57 -0300 Subject: [PATCH] Atualização do manual de instalação e atualização do módulo --- README.md | 608 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1 file changed, 343 insertions(+), 265 deletions(-) diff --git a/README.md b/README.md index ebfec2b..6ac0249 100644 --- a/README.md +++ b/README.md @@ -13,26 +13,25 @@ Para maiores informações sobre o ConectaGov e o PEN, acesse http://www.planeja Este manual está estruturado nas seguintes seções: - 1. **Instalação** +1. [**Instalação**](#instalação): Procedimentos de instalação do módulo nos servidores de aplicação e atualização do banco de dados. - 3. **Configuração** - Orientações voltadas para o administrador do sistema configurar os parâmetros do módulo para o correto funcionamento da integração. - - 4. **Utilização** - Apresentação das funcionalidades que permitem o trâmite externo de processos e o acompanhamento de seu histórico. - - 5. **Atualização** - Procedimentos para realizar a atualização de uma nova versão do módulo +2. [**Atualização**](#atualização): +Procedimentos para realizar a atualização de uma nova versão do módulo - 6. **Suporte** - Canais de comunicação para resolver problemas ou tirar dúvidas sobre o módulo e os demais componentes do ConectaGov. +4. [**Utilização**](#utilização): +Apresentação das funcionalidades que permitem o trâmite externo de processos e o acompanhamento de seu histórico. + +5. [**Suporte**](#suporte): +Canais de comunicação para resolver problemas ou tirar dúvidas sobre o módulo e os demais componentes do ConectaGov. ## Instalação ### Pré-requisitos - - **SEI versão 3.0.5 ou superior instalada, exceto a versão 3.0.10.** - - Usuário de acesso ao banco de dados do SEI e SIP com permissões para criar novas estruturas no banco de dados. + - **SEI versão 3.0.11 ou superior instalada**; + - Supervisor versão 4.X ou superior instalada; + - Gearman instalado; + - Usuário de acesso ao banco de dados do SEI e SIP com permissões para criar novas estruturas no banco de dados. Para iniciar os procedimentos de configuração do módulo, será necessário registrar no **ConectaGov** as unidades administrativas que poderão realizar o envio e recebimento de processos/documentos externo no SEI. Este procedimento precisa ser realizado pelo **Gestor de Protocolo** previamente habilitado no portal do **ConectaGov-PEN**. Os testes devem ser feitos primeiro em um ambiente de desenvolvimento/homologação. Para solicitação de acesso aos ambientes, acesse os seguintes endereços: @@ -45,282 +44,389 @@ Para solicitação de acesso aos ambientes, acesse os seguintes endereços: ### Procedimentos -1. Fazer backup dos banco de dados do SEI e SIP e dos arquivos de configuração do sistema. +##### 1. Fazer backup dos banco de dados do SEI e SIP e dos arquivos de configuração do sistema. + +--- -2. Instalar o **gearmand** e o **supervisord** no servidor responsável por tratar o agendamento de tarefas do sistema. +##### 2. Instalar o **gearmand** e o **supervisord** no servidor responsável por tratar o agendamento de tarefas do sistema. + Estes dois componentes são utilizados para gerenciar a fila de recebimento de novos processos de forma assíncrona pelo SEI. **Importante:** É imprescindível que os dois sejam instalados **SOMENTE** no nó de aplicação em que está configurado o CRON de agendamento do SEI. **Importante:** Deverá ser utilizado o Supervisor a partir da versão 4.0 - Exemplo de instalação do German e Supervisor no CentOS: +Exemplo de instalação do German e Supervisor no CentOS: +```bash +# pre-requisito +yum install epel-release && yum update + +# instalação do gearman e supervisord +yum install supervisor-4.* gearmand libgearman libgearman-devel php56*-pecl-gearman +``` + +--- +##### 3. Configuração dos serviços de recebimento de processos no **supervisor** + +Neste passo será configurado os dois scripts PHP responsáveis por fazer monitoramento de pendências de trâmite no ConectaGov e processar o recebimento de novos processos. + +Exemplo de configuração do supervisor: + +As linhas de configuração apresentadas abaixo deverão ser adicionadas no final do arquivo de configuração do *Supervisor* (/etc/supervisord.conf). +**Atenção 1:** No parâmetro *[user]* deve ser configurado o usuário que executa o servidor web (verifique no seu servidor qual é o usuario. Ex.: apache) +**Atenção 2:** Verifique se a localização dos scripts ProcessarPendenciasRN.php e PendenciasTramiteRN.php estão corretas no parâmetro *[command]*. + +```ini +# adicione no final do arquivo +[program:sei_processar_pendencias] +command=/usr/bin/php -c /etc/php.ini /opt/sei/web/modulos/pen/rn/ProcessarPendenciasRN.php +process_name=%(program_name)s_%(process_num)02d +numprocs=4 +directory=/opt/sei/web +user=apache +autostart=true +autorestart=true +startsecs=5 +startretries=1000 +log_stdout=true +log_stderr=true +logfile_backups=50 +logfile_maxbytes=10MB +logfile=/var/log/supervisor/sei_processar_pendencias.log +stdout_logfile=/var/log/supervisor/sei_processar_pendencias.log-out +stderr_logfile=/var/log/supervisor/sei_processar_pendencias.log-err +stderr_events_enabled=true + +[program:sei_monitorar_pendencias] +command=/usr/bin/php -c /etc/php.ini /opt/sei/web/modulos/pen/rn/PendenciasTramiteRN.php +numprocs=1 +directory=/opt/sei/web +user=apache +autostart=true +autorestart=true +startsecs=5 +startretries=1000 +log_stdout=true +log_stderr=true +logfile_maxbytes=10MB +logfile_backups=50 +logfile=/var/log/supervisor/sei_monitorar_pendencias.log +stdout_logfile=/var/log/supervisor/sei_monitorar_pendencias.log-out +stderr_logfile=/var/log/supervisor/sei_monitorar_pendencias.log-err +stderr_events_enabled=true +``` + +--- +##### 4. Configurar a tarefa de reinicialização de serviços caso se identifique possíveis indisponibilidades. + +Esta configuração é recomendada como contingência para garantir que os serviços de integração não serão desativados em caso de indisponibilidade momentânea da infraestrutura do ConectaGov. + +Os procedimento descritos abaixo deverão ser executados no mesmo servidor em que está instalado o **supervisor** e o **gearman** (passo 3). + +Mova o script **verificar-servicos.sh**, localizado na raiz do diretório do módulo, para a pasta de **sei/bin** do SEI: + +```bash +cp [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/web/modulos/pen/verificar-servicos.sh /opt/sei/bin/ +``` + +Configure este script no serviço de agendamento CRON com uma periodicidade sugerida de 10 minutos, tempo este utilizado para o devido monitoramento e tentativa de reativação dos serviços. + +```bash +crontab -e + +*/10 * * * * [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/bin/verificar-servicos.sh +``` + +--- +##### 5. Configurar módulo ConectaGov no arquivo de configuração do SEI + +Editar o arquivo **sei/config/ConfiguracaoSEI.php**, tomando o cuidado de usar editor que não altere o charset ISO 5589-1 do arquivo, para adicionar a referência ao módulo PEN na chave **[Modulos]** abaixo da chave **[SEI]**: + +```php +'SEI' => array( + 'URL' => 'http://[servidor sei]/sei', + 'Producao' => true, + 'RepositorioArquivos' => '/var/sei/arquivos', + 'Modulos' => array('PENIntegracao' => 'pen'), + ), +``` + +Adicionar a referência ao módulo PEN na array da chave 'Modulos' indicada acima: +```php +'Modulos' => array('PENIntegracao' => 'pen') +``` + +--- +##### 6. Mover o diretório de arquivos do módulo "pen" para o diretório sei/web/modulos/ +Importante renomear a pasta do módulo "mod-sei-pen" para somente "pen" por questões de padronização de nomenclatura. + +--- +##### 7. Mover o arquivo do certificado digital utilizado para integração com o **ConectaGov** para o diretório "sei/config/". + +Para melhor organização dos arquivos dentro do diretório **sei/config**, sugerimos a criação da uma nova pasta chamada **sei/config/certificados\_mod_conectagov** para adicionar estes arquivos. + +Os certificados digitais para conectar aos ambientes de desenvolvimento e homologação do PEN estão localizados no pacote de instalação disponibilizado pela equipe técnica do Ministério do Planejamento, Desenvolvimento e Gestão - MPDG e são disponibilizados no ato do credenciamento da instituição no ConectaGov. + +Para o ambiente de produção, deverá ser utilizado um certificado digital válido gerado por uma Autoridade de Registro - AR confiável (Exemplo: ICP-Brasil, Certisign, Verisign, etc.). - # pre-requisito - yum install epel-release && yum update +Maiores informações e solicitações podem ser feitas através do e-mail processo.eletronico@planejamento.gov.br. - # instalação do gearman e supervisord - yum install supervisor-4.* gearmand libgearman libgearman-devel php56*-pecl-gearman +--- +##### 8. Mover o arquivo de instalação do módulo no SEI **sei\_atualizar\_versao\_modulo_pen.php** para a pasta **sei/scripts**. Lembre-se de mover, e não copiar, por questões de segurança e padronização. -3. Configuração dos serviços de recebimento de processos no **supervisor** +--- +##### 9. Mover o arquivo de instalação do módulo no SIP **sip\_atualizar\_versao\_modulo\_pen.php** para a pasta **sip/scripts**. Lembre-se de mover, e não copiar, por questões de segurança e padronização. - Neste passo será configurado os dois scripts PHP responsáveis por fazer monitoramento de pendências de trâmite no ConectaGov e processar o recebimento de novos processos. +--- +##### 10. Executar o script **sip\_atualizar\_versao\_modulo_pen.php** para atualizar o banco de dados do SIP para o funcionamento do módulo: +```bash +php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sip/scripts/sip_atualizar_versao_modulo_pen.php +``` - As linhas de configuração apresentadas abaixo deverão ser adicionadas no final do arquivo de configuração do *Supervisor* (/etc/supervisord.conf). - - **Atenção 1:** No parâmetro *[user]* deve ser configurado o usuário que executa o servidor web (verifique no seu servidor qual é o usuario. Ex.: apache) +--- +##### 11. Executar o script **sei_atualizar_versao_modulo_pen.php** para inserção de dados no banco do SEI referente ao módulo. +```bash +php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/scripts/sei_atualizar_versao_modulo_pen.php +``` + +--- +##### 12. Após a instalação do módulo, o usuário de manutenção deverá ser alterado para outro contendo apenas as permissões de leitura e escrita no banco de dados. + +--- +##### 13. Configurar as permissões de segurança para os perfis e unidades que poderão realizar o trâmite externo de processos. + +Por padrão, as funcionalidades (recursos) criados pelo módulo não são atribuídos automaticamente à um perfil específico do sistema, evitando sua disponibilização para todos os usuários do sistema sem a prévia definição dos administradores. + +Sugerimos que seja criado um novo perfil de usuário que receberá as permissões incluídas pelo módulo (pen_*). Este novo perfil deverá ser atribuído aos usuários que poderão realizar o trâmite externo de processos para outras instituições. + +Para criação do novo perfil e atribuição dos devidos recursos, acesse [**SIP > Perfil > Novo**] + +Exemplo: ***Perfil: Envio Externo*** - **Atenção 2:** Verifique se a localização dos scripts ProcessarPendenciasRN.php e PendenciasTramiteRN.php estão corretas no parâmetro *[command]*. - - Exemplo de configuração do supervisor: - - # adicione no final do arquivo - [program:sei_processar_pendencias] - command=/usr/bin/php -c /etc/php.ini /opt/sei/web/modulos/pen/rn/ProcessarPendenciasRN.php - process_name=%(program_name)s_%(process_num)02d - numprocs=4 - directory=/opt/sei/web - user=apache - autostart=true - autorestart=true - startsecs=5 - startretries=1000 - log_stdout=true - log_stderr=true - logfile_backups=50 - logfile_maxbytes=10MB - logfile=/var/log/supervisor/sei_processar_pendencias.log - stdout_logfile=/var/log/supervisor/sei_processar_pendencias.log-out - stderr_logfile=/var/log/supervisor/sei_processar_pendencias.log-err - stderr_events_enabled=true - - - [program:sei_monitorar_pendencias] - command=/usr/bin/php -c /etc/php.ini /opt/sei/web/modulos/pen/rn/PendenciasTramiteRN.php - numprocs=1 - directory=/opt/sei/web - user=apache - autostart=true - autorestart=true - startsecs=5 - startretries=1000 - log_stdout=true - log_stderr=true - logfile_maxbytes=10MB - logfile_backups=50 - logfile=/var/log/supervisor/sei_monitorar_pendencias.log - stdout_logfile=/var/log/supervisor/sei_monitorar_pendencias.log-out - stderr_logfile=/var/log/supervisor/sei_monitorar_pendencias.log-err - stderr_events_enabled=true - - -4. Configurar a tarefa de reinicialização de serviços caso se identifique possíveis indisponibilidades. - - Esta configuração é recomendada como contingência para garantir que os serviços de integração não serão desativados em caso de indisponibilidade momentânea da infraestrutura do ConectaGov. - - Os procedimento descritos abaixo deverão ser executados no mesmo servidor em que está instalado o **supervisor** e o **gearman** (passo 3). - - Mova o script **verificar-servicos.sh**, localizado na raiz do diretório do módulo, para a pasta de **sei/bin** do SEI. - - cp [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/web/modulos/pen/verificar-servicos.sh /opt/sei/bin/ - - Configure este script no serviço de agendamento CRON com uma periodicidade sugerida de 10 minutos, tempo este utilizado para o devido monitoramento e tentativa de reativação dos serviços. - - # crontab -e - */10 * * * * [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/bin/verificar-servicos.sh - -5. Configurar módulo ConectaGov no arquivo de configuração do SEI - - Editar o arquivo **sei/config/ConfiguracaoSEI.php**, tomando o cuidado de usar editor que não altere o charset ISO 5589-1 do arquivo, para adicionar a referência ao módulo PEN na chave **[Modulos]** abaixo da chave **[SEI]**: - - 'SEI' => array( - 'URL' => 'http://[servidor sei]/sei', - 'Producao' => true, - 'RepositorioArquivos' => '/var/sei/arquivos', - 'Modulos' => array('PENIntegracao' => 'pen'), - ), - - Adicionar a referência ao módulo PEN na array da chave 'Modulos' indicada acima: - - 'Modulos' => array('PENIntegracao' => 'pen') - -6. Mover o diretório de arquivos do módulo "pen" para o diretório sei/web/modulos/ - Importante renomear a pasta do módulo "mod-sei-pen" para somente "pen" por questões de padronização de nomenclatura. - -7. Mover o arquivo do certificado digital utilizado para integração com o **ConectaGov** para o diretório "sei/config/". +Recursos: +~~~~ + * pen_procedimento_expedido_listar + * pen_procedimento_expedir +~~~~ + +Também será necessário a configuração dos seguintes recursos ao perfil ADMINISTRADOR para permitir o mesmo realizar as configurações do módulo: +~~~~ + * pen_map_hipotese_legal_envio_alterar + * pen_map_hipotese_legal_envio_cadastrar + * pen_map_hipotese_legal_envio_excluir + * pen_map_hipotese_legal_envio_listar + * pen_map_hipotese_legal_padrao + * pen_map_hipotese_legal_padrao_cadastrar + * pen_map_hipotese_legal_recebimento_alterar + * pen_map_hipotese_legal_recebimento_cadastrar + * pen_map_hipotese_legal_recebimento_excluir + * pen_map_hipotese_legal_recebimento_listar + * pen_map_tipo_documento_envio_alterar + * pen_map_tipo_documento_envio_cadastrar + * pen_map_tipo_documento_envio_excluir + * pen_map_tipo_documento_envio_listar + * pen_map_tipo_documento_envio_visualizar + * pen_map_tipo_documento_recebimento_alterar + * pen_map_tipo_documento_recebimento_cadastrar + * pen_map_tipo_documento_recebimento_excluir + * pen_map_tipo_documento_recebimento_listar + * pen_map_tipo_documento_recebimento_visualizar + * pen_map_unidade_alterar + * pen_map_unidade_cadastrar + * pen_map_unidade_excluir + * pen_map_unidade_listar + * pen_parametros_configuracao + * pen_parametros_configuracao_alterar +~~~~ +Recomenda-se que os recursos acima não sejam atribuídos aos perfis básicos do sistema. - Para melhor organização dos arquivos dentro do diretório **sei/config**, sugerimos a criação da uma nova pasta chamada **sei/config/certificados\_mod_conectagov** para adicionar estes arquivos. +--- +##### 14. Configurar as unidades do SEI que poderão realizar o envio e recebimento de trâmites externos + +Os ID's de unidades são gerenciados pela própria instituição no portal do Processo Eletrônico Nacional ( http://conectagov.processoeletronico.gov.br). +No credenciamento da instituição, estes valores serão passados pela unidade de TI do MPDG. + +Acesse o menu **[SEI > Administração > Processo Eletrônico Nacional > Mapeamento de Unidades]** e vincule as unidades administrativas com seus respectivos identificadores registrados no portal do Processo Eletrônico Nacional. + +--- +##### 15. Configuração de unidade administrativa virtual para gerenciamento de envio e recebimento de processos pelo módulo. + +Esta configuração é necessária para o SEI realizar as devidas regras de registro de históricos de trâmites externos e bloqueio de edição metadados de processos/documentos. Tal unidade será utilizada internamente pelo módulo e não deverá ter acesso liberado para nenhum usuário do sistema. + +##### 15.1. Acessar o SIP e criar uma nova unidade administrativa com as seguintes configurações: - Os certificados digitais para conectar aos ambientes de desenvolvimento e homologação do PEN estão localizados no pacote de instalação disponibilizado pela equipe técnica do Ministério do Planejamento, Desenvolvimento e Gestão - MPDG e são disponibilizados no ato do credenciamento da instituição no ConectaGov. + Sigla: EXTERNO + Nome: Unidade Externa - Para o ambiente de produção, deverá ser utilizado um certificado digital válido gerado por uma Autoridade de Registro - AR confiável (Exemplo: ICP-Brasil, Certisign, Verisign, etc.). +##### 15.2. Configurar a nova unidade na hierarquia do SEI, através da funcionalidade **[SIP > Hierarquias > Montar]** - Maiores informações e solicitações podem ser feitas através do e-mail processo.eletronico@planejamento.gov.br. +Sugerimos que está unidade seja configurada no mesmo nível hierárquico da unidade de teste padrão existente no SEI. Para saber qual é a unidade de testes, basta verificar o parâmetro do SEI chamado **SEI_UNIDADE_TESTE** -8. Mover o arquivo de instalação do módulo no SEI **sei\_atualizar\_versao\_modulo_pen.php** para a pasta **sei/scripts**. Lembre-se de mover, e não copiar, por questões de segurança e padronização. +--- +##### 16. Configuração de tipo de processo a ser aplicado aos processos recebidos de instituições externas. -9. Mover o arquivo de instalação do módulo no SIP **sip\_atualizar\_versao\_modulo\_pen.php** para a pasta **sip/scripts**. Lembre-se de mover, e não copiar, por questões de segurança e padronização. +Como o processo de recebimento de novos processos será feito de forma automática pelo módulo de integração, o sistema precisa atribuir um Tipo de Processo padrão para o novo procedimento recebido. Importante lembrar que a criação de um novo tipo de processo não é obrigatório, sendo possível utilizar outro pré-existente. +Caso a opção for pela criação de um novo tipo de processo específico, segue abaixo sugestão para configuração: -10. Executar o script **sip\_atualizar\_versao\_modulo_pen.php** para atualizar o banco de dados do SIP para o funcionamento do módulo: +``` + Nome: Processo Recebido Externamente (a classificar) + Descrição: Processos recebidos de outras instituições + // O assunto deve ser definido juntamente com a área de documentação + Sugestão de Assuntos: 019.01 - INFORMAÇÕES SOBRE O ÓRGÃO + Restringir aos Órgãos: [vazio] + Restringir às Unidades: [vazio] + Níveis de Acesso Permitidos: Restrito e Público + Nível de Acesso Sugerido: Público + Processo único no órgão por usuário: Não + Interessado: Não + Interno do Sistema: Sim +``` - # php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sip/scripts/sip_atualizar_versao_modulo_pen.php +--- +##### 17. Configurar os parâmetros do Módulo de Integração Pen +Acesse a funcionalidade **[SEI > Administração > Processo Eletrônico Nacional > Parâmetros de Configuração]** para configurar os parâmetros de funcionamento do módulo: -11. Executar o script **sei_atualizar_versao_modulo_pen.php** para inserção de dados no banco do SEI referente ao módulo. +* **Endereço do Web Service:** +*Endereço dos serviços de integração do PEN* + - Desenvolvimento: https://pen-api.trafficmanager.net/interoperabilidade/soap/v2/ + - Homologação: https://homolog.pen.api.trafficmanager.net/interoperabilidade/soap/v2/ + - Produção: https://api.conectagov.processoeletronico.gov.br/interoperabilidade/soap/v2/ +* **Endereço do Web Service de Pendências**: +*Endereço dos serviços de notificação de trâmites de processos* + - Desenvolvimento: https://pen-pendencias.trafficmanager.net/ + - Homologação: https://homolog.pen.pendencias.trafficmanager.net/ + - Produção: https://pendencias.conectagov.processoeletronico.gov.br/ +* **ID do Repositório de Estruturas:** +*ID do repositório de origem do órgão na estrutura organizacional. Este identificador é enviado para a instituição junto com o pacote de integração.* + - *Valor 1 (Código de identificação da estrutura organizacional do Poder Executivo - SIORG)* +* **Localização do Certificado Digital:** + - *Localização do certificado digital o órgão (arquivo do passo 8)* +* **Número Máximo de Tentativas de Recebimento:** + - *Valor padrão: 3* +* **Tamanho Máximo de Documentos Expedidos:** + - *Valor padrão: 50* +* **Senha do Certificado Digital:** + - *Senha do certificado digital* +* **Tipo de Processo Externo:** +*Id do tipo de documento externo. * + - *Configurar com o ID do Tipo de Processo Externo configurado no passo 15* +* **Unidade Geradora de Processo e Documento Recebido:** +*Id da unidade de origem que serão atribuídos os documentos recebidos de um outro órgão.* + - *Configurar com o ID da Unidade criada no passo 14* + + +--- +##### 18. Iniciar serviços de monitoramento de pendências de trâmite **Gearman** e **Supervisor** + +```bash +service gearmand start && service supervisord start +``` + +Executar o comando **ps -ef** e verificar se os dois processos seguintes estão em execução: + +```bash +/usr/bin/php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/modulos/pen/rn/PendenciasTramiteRN.php +/usr/bin/php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/modulos/pen/rn/ProcessarPendenciasRN.php +``` + +Caso não esteja houve algum problema de configuração e a expedição de processos não irá funcionar. +**Atenção**: Importante colocar o serviço para ser iniciado automaticamente juntamente com o servidor. - # php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/scripts/sei_atualizar_versao_modulo_pen.php +--- +##### 19. Realizar o mapeamento de tipos de documentos do SEI com as especies documentais definidas no PEN, tanto de envio quanto de recebimento. -12. Após a instalação do módulo, o usuário de manutenção deverá ser alterado para outro contendo apenas as permissões de leitura e escrita no banco de dados. +Esta configuração deve ser feita antes de começar a utilização do módulo. + - SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Tipos de Documentos >> **Envio** >> Cadastrar + - SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Tipos de Documentos >> **Recebimento** >> Cadastrar -13. Configurar as permissões de segurança para os perfis e unidades que poderão realizar o trâmite externo de processos. +**Observação**: Os tipos de documentos a serem mapeados deverão estar configurados no SEI como Externo ou Interno/Externo - Por padrão, as funcionalidades (recursos) criados pelo módulo não são atribuídos automaticamente à um perfil específico do sistema, evitando sua disponibilização para todos os usuários do sistema sem a prévia definição dos administradores. +--- +##### 20. Realizar o mapeamento das hipóteses legais do SEI com as definidas no PEN para permitir o trâmite externo de processos e documentos restritos. - Sugerimos que seja criado um novo perfil de usuário que receberá as permissões incluídas pelo módulo (pen_*). Este novo perfil deverá ser atribuído aos usuários que poderão realizar o trâmite externo de processos para outras instituições. +**Atenção**: Antes de iniciar esta configuração, será necessário executar manualmente o agendamento **PENAgendamentoRN::atualizarHipotesesLegais** em [**SEI > Infra > Agendamentos**]. Esta tarefa é necessária para atualizar o SEI com a última versão da tabela de hipóteses legais do PEN. - Para criação do novo perfil e atribuição dos devidos recursos, acesse [**SIP > Perfil > Novo**] +Este mapeamento deve ser feito antes de começar a utilização do módulo e está disponível em + - SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Hipóteses Legais >> **Envio** >> Cadastrar + - SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Hipóteses Legais >> **Recebimento** >> Cadastrar - Exemplo: ***Perfil: Envio Externo*** - - Recursos: - - * pen_procedimento_expedido_listar - * pen_procedimento_expedir - - Também será necessário a configuração dos seguintes recursos ao perfil ADMINISTRADOR para permitir o mesmo realizar as configurações do módulo: - - * pen_map_hipotese_legal_envio_alterar - * pen_map_hipotese_legal_envio_cadastrar - * pen_map_hipotese_legal_envio_excluir - * pen_map_hipotese_legal_envio_listar - * pen_map_hipotese_legal_padrao - * pen_map_hipotese_legal_padrao_cadastrar - * pen_map_hipotese_legal_recebimento_alterar - * pen_map_hipotese_legal_recebimento_cadastrar - * pen_map_hipotese_legal_recebimento_excluir - * pen_map_hipotese_legal_recebimento_listar - * pen_map_tipo_documento_envio_alterar - * pen_map_tipo_documento_envio_cadastrar - * pen_map_tipo_documento_envio_excluir - * pen_map_tipo_documento_envio_listar - * pen_map_tipo_documento_envio_visualizar - * pen_map_tipo_documento_recebimento_alterar - * pen_map_tipo_documento_recebimento_cadastrar - * pen_map_tipo_documento_recebimento_excluir - * pen_map_tipo_documento_recebimento_listar - * pen_map_tipo_documento_recebimento_visualizar - * pen_map_unidade_alterar - * pen_map_unidade_cadastrar - * pen_map_unidade_excluir - * pen_map_unidade_listar - * pen_parametros_configuracao - * pen_parametros_configuracao_alterar - - Recomenda-se que os recursos acima não sejam atribuídos aos perfis básicos do sistema. - -14. Configurar as unidades do SEI que poderão realizar o envio e recebimento de trâmites externos +**Observação**: Os tipos de documentos a serem mapeados deverão estar configurados no SEI como Externo ou Interno/Externo - Os ID's de unidades são gerenciados pela própria instituição no portal do Processo Eletrônico Nacional ( http://conectagov.processoeletronico.gov.br). - No credenciamento da instituição, estes valores serão passados pela unidade de TI do MPDG. +--- +##### 21. O protocolo de comunicação implementado pelo PEN realiza a geração e assinatura digital de recibos de entrega e conclusão dos trâmites de processo. Para a correta geração dos recibos pelo módulo, é indispensável que todos os nós da aplicação estejam configurados com o serviço de sincronização de relógios oficial NTP.br. +Este link pode ajudar a configurar conforme o SO utilizado: http://ntp.br/guia-linux-comum.php - Acesse o menu **[SEI > Administração > Processo Eletrônico Nacional > Mapeamento de Unidades]** e vincule as unidades administrativas com seus respectivos identificadores registrados no portal do Processo Eletrônico Nacional. +--- +--- -15. Configuração de unidade administrativa virtual para gerenciamento de envio e recebimento de processos pelo módulo. +## Atualização - Esta configuração é necessária para o SEI realizar as devidas regras de registro de históricos de trâmites externos e bloqueio de edição metadados de processos/documentos. Tal unidade será utilizada internamente pelo módulo e não deverá ter acesso liberado para nenhum usuário do sistema. +Para realizar a atualização do módulo, realize os seguintes procedimentos: - 15.1. Acessar o SIP e criar uma nova unidade administrativa com as seguintes configurações: - - Sigla: EXTERNO - Nome: Unidade Externa +##### 1. Fazer backup dos banco de dados do SEI e SIP e dos arquivos de configuração do sistema - 15.2. Configurar a nova unidade na hierarquia do SEI, através da funcionalidade **[SIP > Hierarquias > Montar]** +--- +##### 2. Baixar a última versão do módulo disponível em https://softwarepublico.gov.br/gitlab/sei/mod-sei-pen/tags - Sugerimos que está unidade seja configurada no mesmo nível hierárquico da unidade de teste padrão existente no SEI. Para saber qual é a unidade de testes, basta verificar o parâmetro do SEI chamado **SEI_UNIDADE_TESTE** +--- +##### 3. Atualizar software Supervisord para a versão 4.X -16. Configuração de tipo de processo a ser aplicado aos processos recebidos de instituições externas. +Os procedimentos de atualização dependente do OS, mas a versão 4 está disponível via gerenciador de pacotes pip do python 3. Versão 2.X não deve ser mais utilizado. - Como o processo de recebimento de novos processos será feito de forma automática pelo módulo de integração, o sistema precisa atribuir um Tipo de Processo padrão para o novo procedimento recebido. Importante lembrar que a criação de um novo tipo de processo não é obrigatório, sendo possível utilizar outro pré-existente. +--- +##### 4. Atualizar as configurações dos serviços de monitoramento do /etc/supervisord.conf conforme definido no passo 03 do Manual de Instalação do mod-sei-pen, seção "Configuração dos serviços de recebimento de processos no supervisor". https://softwarepublico.gov.br/gitlab/sei/mod-sei-pen/blob/master/README.md. - Caso a opção for pela criação de um novo tipo de processo específico, segue abaixo sugestão para configuração: +--- +##### 5. Importante renomear a pasta do módulo "mod-sei-pen" para somente "pen" por questões de padronização de nomenclatura - Nome: Processo Recebido Externamente (a classificar) - Descrição: Processos recebidos de outras instituições - // O assunto deve ser definido juntamente com a área de documentação - Sugestão de Assuntos: 019.01 - INFORMAÇÕES SOBRE O ÓRGÃO - Restringir aos Órgãos: [vazio] - Restringir às Unidades: [vazio] - Níveis de Acesso Permitidos: Restrito e Público - Nível de Acesso Sugerido: Público - Processo único no órgão por usuário: Não - Interessado: Não - Interno do Sistema: Sim +--- +##### 6. Mover o arquivo de instalação do módulo no SEI sei_atualizar_versao_modulo_pen.php para a pasta sei/scripts +Lembre-se de mover, e não copiar, por questões de segurança e padronização; -17. Configurar os parâmetros do Módulo de Integração Pen -Acesse a funcionalidade **[SEI > Administração > Processo Eletrônico Nacional > Parâmetros de Configuração]** para configurar os parâmetros de funcionamento do módulo: - * **Endereço do Web Service:** - *Endereço dos serviços de integração do PEN* - - Desenvolvimento: https://pen-api.trafficmanager.net/interoperabilidade/soap/v2/ - - Homologação: https://homolog.pen.api.trafficmanager.net/interoperabilidade/soap/v2/ - - Produção: https://api.conectagov.processoeletronico.gov.br/interoperabilidade/soap/v2/ - * **Endereço do Web Service de Pendências**: - *Endereço dos serviços de notificação de trâmites de processos* - - Desenvolvimento: https://pen-pendencias.trafficmanager.net/ - - Homologação: https://homolog.pen.pendencias.trafficmanager.net/ - - Produção: https://pendencias.conectagov.processoeletronico.gov.br/ - * **ID do Repositório de Estruturas:** - *ID do repositório de origem do órgão na estrutura organizacional. Este identificador é enviado para a instituição junto com o pacote de integração.* - - *Valor 1 (Código de identificação da estrutura organizacional do Poder Executivo - SIORG)* - * **Localização do Certificado Digital:** - - *Localização do certificado digital o órgão (arquivo do passo 8)* - * **Número Máximo de Tentativas de Recebimento:** - - *Valor padrão: 3* - * **Tamanho Máximo de Documentos Expedidos:** - - *Valor padrão: 50* - * **Senha do Certificado Digital:** - - *Senha do certificado digital* - * **Tipo de Processo Externo:** - *Id do tipo de documento externo. * - - *Configurar com o ID do Tipo de Processo Externo configurado no passo 15* - * **Unidade Geradora de Processo e Documento Recebido:** - *Id da unidade de origem que serão atribuídos os documentos recebidos de um outro órgão.* - - *Configurar com o ID da Unidade criada no passo 14* - - -18. Iniciar serviços de monitoramento de pendências de trâmite **Gearman** e **Supervisor** - - # service gearmand start && service supervisord start - - Executar o comando **ps -ef** e verificar se os dois processos seguintes estão em execução: - - # /usr/bin/php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/modulos/pen/rn/PendenciasTramiteRN.php - # /usr/bin/php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/modulos/pen/rn/ProcessarPendenciasRN.php - - Caso não esteja houve algum problema de configuração e a expedição de processos não irá funcionar. -**Atenção**: Importante colocar o serviço para ser iniciado automaticamente juntamente com o servidor. +--- +##### 7. Mover o arquivo de instalação do módulo no SIP sip_atualizar_versao_modulo_pen.php para a pasta sip/scripts +Lembre-se de mover, e não copiar, por questões de segurança e padronização; -19. Realizar o mapeamento de tipos de documentos do SEI com as especies documentais definidas no PEN, tanto de envio quanto de recebimento. +--- +##### 8. Executar o script sip_atualizar_versao_modulo_pen.php para atualizar o banco de dados do SIP para o funcionamento do módulo +```bash +php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sip/scripts/sip_atualizar_versao_modulo_pen.php +``` - Esta configuração deve ser feita antes de começar a utilização do módulo. - - SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Tipos de Documentos >> **Envio** >> Cadastrar - - SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Tipos de Documentos >> **Recebimento** >> Cadastrar +--- +##### 9. Executar o script sei_atualizar_versao_modulo_pen.php para inserção de dados no banco do SEI referente ao módulo +```bash +php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/scripts/sei_atualizar_versao_modulo_pen.php +``` - **Observação**: Os tipos de documentos a serem mapeados deverão estar configurados no SEI como Externo ou Interno/Externo +--- +##### 10. Configurar a tarefa de reinicialização de serviços caso se identifique possíveis indisponibilidades. (Manual de Instalação do módulo) +Os procedimento descritos abaixo deverão ser executados no mesmo servidor em que está instalado o supervisor e o gearman (passo 3 do Manual de Instalação do módulo). +​ +Mova o script verificar-servicos.sh, localizado na raiz do diretório do módulo, para a pasta de sei/bin do SEI. +```bash +cp [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/web/modulos/pen/verificar-servicos.sh /opt/sei/bin/ +``` -20. Realizar o mapeamento das hipóteses legais do SEI com as definidas no PEN para permitir o trâmite externo de processos e documentos restritos. +Configure este script no serviço de agendamento CRON com uma periodicidade sugerida de 10 minutos, tempo este utilizado para o devido monitoramento e tentativa de reativação dos serviços. - **Atenção**: Antes de iniciar esta configuração, será necessário executar manualmente o agendamento **PENAgendamentoRN::atualizarHipotesesLegais** em [**SEI > Infra > Agendamentos**]. Esta tarefa é necessária para atualizar o SEI com a última versão da tabela de hipóteses legais do PEN. +```bash +crontab -e - Este mapeamento deve ser feito antes de começar a utilização do módulo e está disponível em - - SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Hipóteses Legais >> **Envio** >> Cadastrar - - SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Hipóteses Legais >> **Recebimento** >> Cadastrar +*/10 * * * * [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/bin/verificar-servicos.sh +``` - **Observação**: Os tipos de documentos a serem mapeados deverão estar configurados no SEI como Externo ou Interno/Externo +--- +##### 11. Reiniciar serviços de monitoramento de pendências de trâmite Gearman e Supervisor: +```bash +service gearmand restart && service supervisord restart +``` -21. O protocolo de comunicação implementado pelo PEN realiza a geração e assinatura digital de recibos de entrega e conclusão dos trâmites de processo. Para a correta geração dos recibos pelo módulo, é indispensável que todos os nós da aplicação estejam configurados com o serviço de sincronização de relógios oficial NTP.br. +--- +--- - Este link pode ajudar a configurar conforme o SO utilizado: http://ntp.br/guia-linux-comum.php ## Utilização @@ -428,34 +534,6 @@ O destinatário pode realizar a consulta ao recibo de trâmite, acessando o íco ![Tela de Controle do Processo - Ícone de Consulta de Recibos](imagens/recibo_conclusao_tramite_destinatario.png) -### Hipóteses de Recusa de Trâmite - -### Consulta de Processos Enviados Externamente - -## Atualização - -Para realizar a atualização do módulo, realize os seguintes procedimentos: - -​1. Fazer backup dos banco de dados do SEI e SIP e dos arquivos de configuração do sistema; - -2. Baixar a última versão do módulo disponível em https://softwarepublico.gov.br/gitlab/sei/mod-sei-pen/tags - -3. Mover o diretório de arquivos do módulo "pen" para o diretório sei/web/modulos/ Importante renomear a pasta do módulo "mod-sei-pen" para somente "pen" por questões de padronização de nomenclatura; - -4. Mover o arquivo de instalação do módulo no SEI sei_atualizar_versao_modulo_pen.php para a pasta sei/scripts. Lembre-se de mover, e não copiar, por questões de segurança e padronização; - -5. Mover o arquivo de instalação do módulo no SIP sip_atualizar_versao_modulo_pen.php para a pasta sip/scripts. Lembre-se de mover, e não copiar, por questões de segurança e padronização; - -6. Executar o script sip_atualizar_versao_modulo_pen.php para atualizar o banco de dados do SIP para o funcionamento do módulo: -# php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sip/scripts/sip_atualizar_versao_modulo_pen.php - -7. Executar o script sei_atualizar_versao_modulo_pen.php para inserção de dados no banco do SEI referente ao módulo: -# php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/scripts/sei_atualizar_versao_modulo_pen.php - -8. Iniciar serviços de monitoramento de pendências de trâmite Gearman e Supervisor: -# service gearmand start && service supervisord start - - ## Suporte ## Problemas Conhecidos -- libgit2 0.21.2