diff --git a/README.md b/README.md index 6da05d1..d250948 100644 --- a/README.md +++ b/README.md @@ -1,266 +1,311 @@ -Módulo de Integração SEI - PEN -====================================== +# Manual do Módulo ConectaGov -Data de criação: 27/05/2016 -Data de atualizaçao: 09/02/2018 -Versão: 1.1.0 +O módulo **conectagov** é o responsável por integrar o Sistema Eletrônico de Informações - SEI à plataforma de interoperabilidade do Processo Eletrônico Nacional - PEN. +O projeto ConectaGov tem como objetivo interligar todos os sistema de processo eletrônico do Poder Executivo Federal a fim de simplificar a troca de documentos oficiais entre instituições de forma rápida e segura. -### REQUISITOS PARA INSTALAÇÂO: -* SEI 3.0.5 (ou superior) instalada (verificar valor da constante de versão do SEI no arquivo sei/SEI.php) +A utilização deste módulo adicionará novas funcionalidades ao SEI permitindo, entre outros: + - Enviar processos administrativos para instituições externas + - Receber processos administrativos de outros órgãos + - Acompanhar a relação de processos em trâmite externo + +Para maiores informações sobre o ConectaGov e o PEN, acesse http://www.planejamento.gov.br/pensei. -* Usuário de acesso ao banco de dados do SEI e SIP com as devidas permissões de acesso para modificar a estrutura do banco de dados. Após a instalação, o usuário de manutenção deverá ser alterado para outro contendo apenas as permissões de leitura e escrita no banco de dados. -* Caso o ambiente do ConectaGov utilizado nesta configuração esteja utilizando HTTPS com certificado digital do ICP-Brasil, será necessário configurar a cadeia de certificados do ICP-BRASIL como confiáveis nos nós de aplicação do SEI. Como todas as comunicações realizadas com o ConectaGov utilizarão conexão segura via HTTPS com certificados digitais, os servidores de aplicação precisam ser configurados para reconhecer esta cadeia como confiável, o que não é padrão. Com isto, os seguintes comandos precisam ser executados em cada nós de aplicação do SEI, incluindo aquele responsável pelo tratamento das tarefas agendadas: +Este manual está estruturado nas seguintes seções: - -- Copie o certificado da cadeia de CA utilizado pelo ConectaGov para o diretório /usr/local/share/ca-certificates: - > cp /usr/local/share/ca-certificates + 1. **Instalação** +Procedimentos de instalação do módulo nos servidores de aplicação e atualização do banco de dados. - -- Efetue a atualização da lista de certificados confiáveis do sistema operacional - > sudo update-ca-certificates + 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. **Suporte** + Canais de comunicação para resolver problemas ou tirar dúvidas sobre o módulo e os demais componentes do ConectaGov. -* Para concluir os procedimentos de configuração do módulo, será necessário registrar no portal do Processo Eletrônico Nacional - PEN as unidades administrativas que poderão realizar trâmites externo ou recebimento de processos/documentos externo no SEI. Este procedimento precisa ser realizado pelo gestor de protocolo previamente habilitado no portal do PEN. Para maiores informações, acesse o endereço eletrônico http://conectagov.processoeletronico.gov.br/ ou entre em contato pelo e-mail processo.eletronico@planejamento.gov.br +## Instalação +### Pré-requisitos + - SEI versão 3.0.5 ou superior instalada. + - 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**. Para maiores informações, acesse http://conectagov.processoeletronico.gov.br/ ou entre em contato pelo e-mail processo.eletronico@planejamento.gov.br -### PROCEDIMENTOS PARA INSTALAÇÂO: +### Procedimentos -1) Fazer backup dos banco de dados do SEI, SIP e repositórios de arquivos. - -2) Instalar o gearmand e o supervisord no servidor responsável por tratar o agendamento de tarefas do sistema. -**Importante:** É imprescindível que seja no mesmo nó em que está configurado o CRON de agendamento principal do SEI. - - # Pre-requisito. Caso contrario, os demais pacotes não são encontrados no CentOS7 +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. +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 no mesmo nó de aplicação em que está configurado o CRON de agendamento principal do SEI. + +Exemplo de instalação do German e Supervisor no CentOS: + + # pre-requisito yum install epel-release && yum update - # Instalação do Gearman e supervisord + # instalação do gearman e supervisord yum install supervisor gearmand libgearman libgearman-devel php56*-pecl-gearman +3. Configuração dos serviços de recebimento de processos + + 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. + + 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]*. -3) Configuração do supervisor. -**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' + Exemplo de configuração do supervisor: - vi /etc/supervisord.conf - ... - # 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 - numprocs=1 - directory=/opt/sei/web - user=apache - autostart=true - autorestart=true - log_stderr=true - stdout_logfile=/var/log/supervisor/sei-supervisord-stdout.log - stderr_logfile=/var/log/supervisor/sei-supervisord-stderr.log + # 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 + numprocs=1 + directory=/opt/sei/web + user=apache + autostart=true + autorestart=true + log_stderr=true + stdout_logfile=/var/log/supervisor/sei-supervisord-stdout.log + stderr_logfile=/var/log/supervisor/sei-supervisord-stderr.log - [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 - log_stderr=true - stdout_logfile=/var/log/supervisor/sei-supervisord-stdout.log - stderr_logfile=/var/log/supervisor/sei-supervisord-stderr.log + [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 + log_stderr=true + stdout_logfile=/var/log/supervisor/sei-supervisord-stdout.log + stderr_logfile=/var/log/supervisor/sei-supervisord-stderr.log -4) Configurar agendamento de tarefas de reinicialização de serviços caso se identifique os estes estão indisponíveis +4. Configurar a tarefa de reinicialização de serviços caso se identifique possíveis indisponibilidades. -Esta configuração é recomendada como contingência em conjunto com o Supervisor para garantir que os serviços de integração não serão desativados em caso de indisponibilidade momentânea da infraestrutura do ConectaGov. + 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. -No mesmo servidor em que está instalado/configurado o supervisor e gearman (passo 3), configurar o script **verificar-servicos.sh**, localizado na raiz do módulo, no serviço de agendamento CRON. Sugerimos que o tempo de monitoramento e tentativa de reativação seja configurado em 10 minutos. + Os procedimento descritos abaixo deverão ser executados no mesmo servidor em que está instalado o **supervisor** e o **gearman** (passo 3). -4.1) Copiar script de verificação dos serviços de integração do ConectaGov para a pasta de arquivos binários do SEI -Atenção: Altere a referência para [DIRETORIO_RAIZ_INSTALAÇÃO] descrito abaixo - cp [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/web/modulos/pen/verificar-servicos.sh /opt/sei/bin/ + Mova o script **verificar-servicos.sh**, localizado na raiz do diretório do módulo, para a pasta de scripts do SEI. -4.2) Configurar agendamento no cron -Atenção: Altere a referência para [DIRETORIO_RAIZ_INSTALAÇÃO] descrito abaixo + cp [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/web/modulos/pen/verificar-servicos.sh /opt/sei/bin/ - # crontab -e - */10 * * * * [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/bin/verificar-servicos.sh + 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. -6) Editar o arquivo "sei/ConfiguracaoSEI.php", tomando o cuidado de usar editor que não altere o charset do arquivo, para adicionar a referência ao módulo PEN na chave 'Modulos' abaixo da chave 'SEI': -Atenção para as virgulas nos finais das linhas + # 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/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(), + 'Modulos' => array('PENIntegracao' => 'pen'), ), - -Adicionar a referência ao módulo PEN na array da chave 'Modulos' indicada acima: + + Adicionar a referência ao módulo PEN na array da chave 'Modulos' indicada acima: - 'Modulos' => array('PENIntegracao' => 'pen') - -7) 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. + 'Modulos' => array('PENIntegracao' => 'pen') -8) Mover o arquivo do certificado digital utilizado para integração com o ConectaGov para o diretório "sei/config/". +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. -Os certificados digitais necessários para conectar aos ambientes de desenvolvimento e homologação do PEN estão localizados no paco​te de instalação. 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.). +7. Mover o arquivo do certificado digital utilizado para integração com o **ConectaGov** para o diretório "sei/config/". -9) 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. + Os certificados digitais para conectar aos ambientes de desenvolvimento e homologação do PEN estão localizados no paco​te 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. -10) 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. - -11) Executar o script "sip_atualizar_versao_modulo_pen.php" para atualizar o banco de dados do SIP para o funcionamento do módulo: -Atenção: Altere a referência para [DIRETORIO_RAIZ_INSTALAÇÃO] descrito abaixo + 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.). - # php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sip/scripts/sip_atualizar_versao_modulo_pen.php - -12) Executar o script **sei_atualizar_versao_modulo_pen.php** para inserção de dados no banco do SEI referente ao módulo. -Atenção: Altere a referência para [DIRETORIO_RAIZ_INSTALAÇÃO] descrito abaixo + Maiores informações e solicitações podem ser feitas através do e-mail processo.eletrônico@planejamento.gov.br. - # php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/scripts/sei_atualizar_versao_modulo_pen.php +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. -13) 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çao no portal do Processo Eletrônico Nacional: http://conectagov.processoeletronico.gov.br. -Na fase de homologação do sistema, estes valores serão passados pela SETIC/MP. +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. -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. -14) Configuração de unidade administrativa virtual para gerenciamento de envio e recebimento de processos pelo módulo. +10. Executar o script **sip_atualizar_versao_modulo_pen.php** para atualizar o banco de dados do SIP para o funcionamento do 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. + # php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sip/scripts/sip_atualizar_versao_modulo_pen.php -14.1) Acessar o SIP e criar uma nova unidade administrativa com as seguintes configurações: +11. Executar o script **sei_atualizar_versao_modulo_pen.php** para inserção de dados no banco do SEI referente ao módulo. - sigla: EXTERNO - nome: Unidade Externa + # php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/scripts/sei_atualizar_versao_modulo_pen.php -14.2) Configurar a nova unidade na hierarquia do SEI, através da funcionalidade SIP >> Hierarquias >> Montar +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. -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** +13. Configurar as permissões de segurança para os perfis e unidades que poderão realizar o trâmite externo de processos. -15) Configuração de tipo de processo a ser aplicado aos processos recebidos de outras instituições. + 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. -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. + 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. -Caso a opção for pela criação de um novo tipo de processo específico, segue abaixo sugestão para configuração: + Para criação do novo perfil e atribuição dos devidos recursos, acesse [**SIP > Perfil > Novo**] + Exemplo: *Perfil: Trâmite Externo* + Recursos: + - pen_procedimento_expedido_listar + - pen_procedimento_expedir -15.1) Criar um novo Tipo de Processo pela funcionalidade *SEI >> Administração >> Tipo de Processo* + 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 -> Nome: Demanda Externa: Outros Órgãos Públicos Descrição: -> Processos recebidos de outras instituições Sugestão de Assuntos: [A -> CLASSIFICAÇÃO DE ASSUNTO DEVE SER DEFINIDO JUNTAMENTE COM A ÁREA DE DOCUMENTAÇÃO] -> Ex: 019.01 - INFORMAÇÕES SOBRE O ÓRGÃO -> Restringir aos Órgãos: [vazio] -> Restringir às Unidades: [vazio] -> Níveis de Acesso Permitidos: 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 +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. -16) Configurar os parâmetros do Módulo de Integração Pen (Menu: *SEI >> Administração >> Processo Eletrônico Nacional >> Parâmetros de Configuração*) + 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: -**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/ + Sigla: EXTERNO + Nome: Unidade Externa + + 15.2. Configurar a nova unidade na hierarquia do SEI, através da funcionalidade **[SIP > Hierarquias > Montar]** + + 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** + +16. Configuração de tipo de processo a ser aplicado aos processos recebidos de instituições externas. + + 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: + + Nome: Demanda Externa: Outros Órgãos Públicos + 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 + +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/ -**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.* -**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. -Exemplo: 1 (Código de identificação da estrutura organizacional do Poder Executivo [SIORG]) + Exemplo: + 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) +- **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 +- **Número Máximo de Tentativas de Recebimento:** +*Valor padrão: 3* -**Tamanho Máximo de Documentos Expedidos:** -Valor padrão: 50 +- **Tamanho Máximo de Documentos Expedidos:** +*Valor padrão: 50* -**Senha do Certificado Digital:** -Senha do certificado digital -Atenção: Configuração de senha será modificada na próxima versão para utilização de criptografia +- **Senha do Certificado Digital:** +*Senha do certificado digital* +**Atenção**: Configuração de senha será modificada na próxima versão para utilização de criptografia -**Tipo de Processo Externo:** -Id do tipo de documento externo. Configurar com o ID do Tipo de Processo Externo configurado no passo 15 +- **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 +- **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* -17) Iniciar Gearman e Supervisor -Atenção: Altere a referência para [DIRETORIO_RAIZ_INSTALAÇÃO] descrito abaixo: +18. Iniciar serviços de monitoramento de pendências de trâmite **Gearman** e **Supervisor** - service gearmand start && service supervisord start + # service gearmand start && service supervisord start -Executar o comando "ps -ef" e verificar se os dois processos seguintes estão em execução: + 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. - -18) Realizar o mapeamento de tipos de documentos do SEI com as especies documentais definidas no PEN, tanto de envio quanto de recebimento. - -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 - -Obs.: Os tipos de documentos a serem mapeados deverão estar configurados no SEI como Externo ou Interno/Externo - -19) 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. -Atenção: Antes de iniciar esta configuração, será necessário executar manualmente o agendamento "PENAgendamentoRN::atualizarHipotesesLegais" em [SEI >> Infra >> Agendamentos]. Isto será necessário para atualizar o SEI com a última versão da tabela de hipóteses legais do PEN. - -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 - -Obs.: Os tipos de documentos a serem mapeados deverão estar configurados no SEI como Externo ou Interno/Externo - - -19) 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 - - -20) Configurar as permissões de segurança para os perfis e unidades que poderão realizar o trâmite externo de processos no sistema. - -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 aos novos recursos incluidos pelo módulo (pen_*). Este novo perfil deverá ser atribuído aos usuários que podem realizar o trâmite externo de processos para outras instituições. - -Sugerimos a configuração dos seguintes recursos no novo perfil criado para trâmites de processos externos: -* pen_procedimento_expedido_listar -* pen_procedimento_expedir - -Sugerimos a configuração dos seguintes recursos no perfil ADMINISTRADOR: -* 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 + # /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. + +19. Realizar o mapeamento de tipos de documentos do SEI com as especies documentais definidas no PEN, tanto de envio quanto de recebimento. + + 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 + + **Observação**: Os tipos de documentos a serem mapeados deverão estar configurados no SEI como Externo ou Interno/Externo + + +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. + + **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. + + 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 + + **Observação**: Os tipos de documentos a serem mapeados deverão estar configurados no SEI como Externo ou Interno/Externo + +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 + +## Suporte + +## Problemas Conhecidos + +### Problema com validação de certificados HTTPS + +Caso o ambiente do ConectaGov utilizado nesta configuração esteja utilizando HTTPS com certificado digital não reconhecido (como ICP-Brasil), será necessário configurar a cadeia não reconhecida como confiáveis nos servidores de aplicação do SEI. Com isto, os seguintes comandos precisam ser executados em cada nós de aplicação do SEI, incluindo aquele responsável pelo tratamento das tarefas agendadas: + +Copie o certificado da cadeia de CA utilizado pelo ConectaGov para o diretório /usr/local/share/ca-certificates: + + cp /usr/local/share/ca-certificates + +Efetue a atualização da lista de certificados confiáveis do sistema operacional + + sudo update-ca-certificates -- libgit2 0.21.2