Download as
Browse Code »

Commit 60570e5cf9895f6bae976bc5d78030816ba94fad

Authored by Guilherme Andrade Del Cantoni
1 parent 972043fd
Exists in master and in 4 other branches desenv, fix-101, fix-24, fix-43

Atualização do manual de instalação e atualização do módulo

Showing 1 changed file with 343 additions and 265 deletions   Show diff stats
README.md
  Diff comments   View file @60570e5
... ... @@ -13,26 +13,25 @@ Para maiores informações sobre o ConectaGov e o PEN, acesse http://www.planeja
13 13  
14 14 Este manual está estruturado nas seguintes seções:
15 15  
16   - 1. **Instalação**
  16 +1. [**Instalação**](#instalação):
17 17 Procedimentos de instalação do módulo nos servidores de aplicação e atualização do banco de dados.
18 18  
19   - 3. **Configuração**
20   - Orientações voltadas para o administrador do sistema configurar os parâmetros do módulo para o correto funcionamento da integração.
21   -
22   - 4. **Utilização**
23   - Apresentação das funcionalidades que permitem o trâmite externo de processos e o acompanhamento de seu histórico.
24   -
25   - 5. **Atualização**
26   - Procedimentos para realizar a atualização de uma nova versão do módulo
  19 +2. [**Atualização**](#atualização):
  20 +Procedimentos para realizar a atualização de uma nova versão do módulo
27 21  
28   - 6. **Suporte**
29   - Canais de comunicação para resolver problemas ou tirar dúvidas sobre o módulo e os demais componentes do ConectaGov.
  22 +4. [**Utilização**](#utilização):
  23 +Apresentação das funcionalidades que permitem o trâmite externo de processos e o acompanhamento de seu histórico.
  24 +
  25 +5. [**Suporte**](#suporte):
  26 +Canais de comunicação para resolver problemas ou tirar dúvidas sobre o módulo e os demais componentes do ConectaGov.
30 27  
31 28 ## Instalação
32 29  
33 30 ### Pré-requisitos
34   - - **SEI versão 3.0.5 ou superior instalada, exceto a versão 3.0.10.**
35   - - Usuário de acesso ao banco de dados do SEI e SIP com permissões para criar novas estruturas no banco de dados.
  31 + - **SEI versão 3.0.11 ou superior instalada**;
  32 + - Supervisor versão 4.X ou superior instalada;
  33 + - Gearman instalado;
  34 + - Usuário de acesso ao banco de dados do SEI e SIP com permissões para criar novas estruturas no banco de dados.
36 35  
37 36 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.
38 37 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:
45 44  
46 45 ### Procedimentos
47 46  
48   -1. Fazer backup dos banco de dados do SEI e SIP e dos arquivos de configuração do sistema.
  47 +##### 1. Fazer backup dos banco de dados do SEI e SIP e dos arquivos de configuração do sistema.
  48 +
  49 +---
49 50  
50   -2. Instalar o **gearmand** e o **supervisord** no servidor responsável por tratar o agendamento de tarefas do sistema.
  51 +##### 2. Instalar o **gearmand** e o **supervisord** no servidor responsável por tratar o agendamento de tarefas do sistema.
  52 +
51 53 Estes dois componentes são utilizados para gerenciar a fila de recebimento de novos processos de forma assíncrona pelo SEI.
52 54  
53 55 **Importante:** É imprescindível que os dois sejam instalados **SOMENTE** no nó de aplicação em que está configurado o CRON de agendamento do SEI.
54 56 **Importante:** Deverá ser utilizado o Supervisor a partir da versão 4.0
55 57  
56   - Exemplo de instalação do German e Supervisor no CentOS:
  58 +Exemplo de instalação do German e Supervisor no CentOS:
  59 +```bash
  60 +# pre-requisito
  61 +yum install epel-release && yum update
  62 +
  63 +# instalação do gearman e supervisord
  64 +yum install supervisor-4.* gearmand libgearman libgearman-devel php56*-pecl-gearman
  65 +```
  66 +
  67 +---
  68 +##### 3. Configuração dos serviços de recebimento de processos no **supervisor**
  69 +
  70 +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.
  71 +
  72 +Exemplo de configuração do supervisor:
  73 +
  74 +As linhas de configuração apresentadas abaixo deverão ser adicionadas no final do arquivo de configuração do *Supervisor* (/etc/supervisord.conf).
  75 +**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)
  76 +**Atenção 2:** Verifique se a localização dos scripts ProcessarPendenciasRN.php e PendenciasTramiteRN.php estão corretas no parâmetro *[command]*.
  77 +
  78 +```ini
  79 +# adicione no final do arquivo
  80 +[program:sei_processar_pendencias]
  81 +command=/usr/bin/php -c /etc/php.ini /opt/sei/web/modulos/pen/rn/ProcessarPendenciasRN.php
  82 +process_name=%(program_name)s_%(process_num)02d
  83 +numprocs=4
  84 +directory=/opt/sei/web
  85 +user=apache
  86 +autostart=true
  87 +autorestart=true
  88 +startsecs=5
  89 +startretries=1000
  90 +log_stdout=true
  91 +log_stderr=true
  92 +logfile_backups=50
  93 +logfile_maxbytes=10MB
  94 +logfile=/var/log/supervisor/sei_processar_pendencias.log
  95 +stdout_logfile=/var/log/supervisor/sei_processar_pendencias.log-out
  96 +stderr_logfile=/var/log/supervisor/sei_processar_pendencias.log-err
  97 +stderr_events_enabled=true
  98 +
  99 +[program:sei_monitorar_pendencias]
  100 +command=/usr/bin/php -c /etc/php.ini /opt/sei/web/modulos/pen/rn/PendenciasTramiteRN.php
  101 +numprocs=1
  102 +directory=/opt/sei/web
  103 +user=apache
  104 +autostart=true
  105 +autorestart=true
  106 +startsecs=5
  107 +startretries=1000
  108 +log_stdout=true
  109 +log_stderr=true
  110 +logfile_maxbytes=10MB
  111 +logfile_backups=50
  112 +logfile=/var/log/supervisor/sei_monitorar_pendencias.log
  113 +stdout_logfile=/var/log/supervisor/sei_monitorar_pendencias.log-out
  114 +stderr_logfile=/var/log/supervisor/sei_monitorar_pendencias.log-err
  115 +stderr_events_enabled=true
  116 +```
  117 +
  118 +---
  119 +##### 4. Configurar a tarefa de reinicialização de serviços caso se identifique possíveis indisponibilidades.
  120 +
  121 +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.
  122 +
  123 +Os procedimento descritos abaixo deverão ser executados no mesmo servidor em que está instalado o **supervisor** e o **gearman** (passo 3).
  124 +
  125 +Mova o script **verificar-servicos.sh**, localizado na raiz do diretório do módulo, para a pasta de **sei/bin** do SEI:
  126 +
  127 +```bash
  128 +cp [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/web/modulos/pen/verificar-servicos.sh /opt/sei/bin/
  129 +```
  130 +
  131 +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.
  132 +
  133 +```bash
  134 +crontab -e
  135 +
  136 +*/10 * * * * [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/bin/verificar-servicos.sh
  137 +```
  138 +
  139 +---
  140 +##### 5. Configurar módulo ConectaGov no arquivo de configuração do SEI
  141 +
  142 +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]**:
  143 +
  144 +```php
  145 +'SEI' => array(
  146 + 'URL' => 'http://[servidor sei]/sei',
  147 + 'Producao' => true,
  148 + 'RepositorioArquivos' => '/var/sei/arquivos',
  149 + 'Modulos' => array('PENIntegracao' => 'pen'),
  150 + ),
  151 +```
  152 +
  153 +Adicionar a referência ao módulo PEN na array da chave 'Modulos' indicada acima:
  154 +```php
  155 +'Modulos' => array('PENIntegracao' => 'pen')
  156 +```
  157 +
  158 +---
  159 +##### 6. Mover o diretório de arquivos do módulo "pen" para o diretório sei/web/modulos/
  160 +Importante renomear a pasta do módulo "mod-sei-pen" para somente "pen" por questões de padronização de nomenclatura.
  161 +
  162 +---
  163 +##### 7. Mover o arquivo do certificado digital utilizado para integração com o **ConectaGov** para o diretório "sei/config/".
  164 +
  165 +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.
  166 +
  167 +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.
  168 +
  169 +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.).
57 170  
58   - # pre-requisito
59   - yum install epel-release && yum update
  171 +Maiores informações e solicitações podem ser feitas através do e-mail processo.eletronico@planejamento.gov.br.
60 172  
61   - # instalação do gearman e supervisord
62   - yum install supervisor-4.* gearmand libgearman libgearman-devel php56*-pecl-gearman
  173 +---
  174 +##### 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.
63 175  
64   -3. Configuração dos serviços de recebimento de processos no **supervisor**
  176 +---
  177 +##### 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.
65 178  
66   - 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.
  179 +---
  180 +##### 10. Executar o script **sip\_atualizar\_versao\_modulo_pen.php** para atualizar o banco de dados do SIP para o funcionamento do módulo:
  181 +```bash
  182 +php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sip/scripts/sip_atualizar_versao_modulo_pen.php
  183 +```
67 184  
68   - As linhas de configuração apresentadas abaixo deverão ser adicionadas no final do arquivo de configuração do *Supervisor* (/etc/supervisord.conf).
69   -
70   - **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)
  185 +---
  186 +##### 11. Executar o script **sei_atualizar_versao_modulo_pen.php** para inserção de dados no banco do SEI referente ao módulo.
  187 +```bash
  188 +php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/scripts/sei_atualizar_versao_modulo_pen.php
  189 +```
  190 +
  191 +---
  192 +##### 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.
  193 +
  194 +---
  195 +##### 13. Configurar as permissões de segurança para os perfis e unidades que poderão realizar o trâmite externo de processos.
  196 +
  197 +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.
  198 +
  199 +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.
  200 +
  201 +Para criação do novo perfil e atribuição dos devidos recursos, acesse [**SIP > Perfil > Novo**]
  202 +
  203 +Exemplo: ***Perfil: Envio Externo***
71 204  
72   - **Atenção 2:** Verifique se a localização dos scripts ProcessarPendenciasRN.php e PendenciasTramiteRN.php estão corretas no parâmetro *[command]*.
73   -
74   - Exemplo de configuração do supervisor:
75   -
76   - # adicione no final do arquivo
77   - [program:sei_processar_pendencias]
78   - command=/usr/bin/php -c /etc/php.ini /opt/sei/web/modulos/pen/rn/ProcessarPendenciasRN.php
79   - process_name=%(program_name)s_%(process_num)02d
80   - numprocs=4
81   - directory=/opt/sei/web
82   - user=apache
83   - autostart=true
84   - autorestart=true
85   - startsecs=5
86   - startretries=1000
87   - log_stdout=true
88   - log_stderr=true
89   - logfile_backups=50
90   - logfile_maxbytes=10MB
91   - logfile=/var/log/supervisor/sei_processar_pendencias.log
92   - stdout_logfile=/var/log/supervisor/sei_processar_pendencias.log-out
93   - stderr_logfile=/var/log/supervisor/sei_processar_pendencias.log-err
94   - stderr_events_enabled=true
95   -
96   -
97   - [program:sei_monitorar_pendencias]
98   - command=/usr/bin/php -c /etc/php.ini /opt/sei/web/modulos/pen/rn/PendenciasTramiteRN.php
99   - numprocs=1
100   - directory=/opt/sei/web
101   - user=apache
102   - autostart=true
103   - autorestart=true
104   - startsecs=5
105   - startretries=1000
106   - log_stdout=true
107   - log_stderr=true
108   - logfile_maxbytes=10MB
109   - logfile_backups=50
110   - logfile=/var/log/supervisor/sei_monitorar_pendencias.log
111   - stdout_logfile=/var/log/supervisor/sei_monitorar_pendencias.log-out
112   - stderr_logfile=/var/log/supervisor/sei_monitorar_pendencias.log-err
113   - stderr_events_enabled=true
114   -
115   -
116   -4. Configurar a tarefa de reinicialização de serviços caso se identifique possíveis indisponibilidades.
117   -
118   - 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.
119   -
120   - Os procedimento descritos abaixo deverão ser executados no mesmo servidor em que está instalado o **supervisor** e o **gearman** (passo 3).
121   -
122   - Mova o script **verificar-servicos.sh**, localizado na raiz do diretório do módulo, para a pasta de **sei/bin** do SEI.
123   -
124   - cp [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/web/modulos/pen/verificar-servicos.sh /opt/sei/bin/
125   -
126   - 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.
127   -
128   - # crontab -e
129   - */10 * * * * [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/bin/verificar-servicos.sh
130   -
131   -5. Configurar módulo ConectaGov no arquivo de configuração do SEI
132   -
133   - 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]**:
134   -
135   - 'SEI' => array(
136   - 'URL' => 'http://[servidor sei]/sei',
137   - 'Producao' => true,
138   - 'RepositorioArquivos' => '/var/sei/arquivos',
139   - 'Modulos' => array('PENIntegracao' => 'pen'),
140   - ),
141   -
142   - Adicionar a referência ao módulo PEN na array da chave 'Modulos' indicada acima:
143   -
144   - 'Modulos' => array('PENIntegracao' => 'pen')
145   -
146   -6. Mover o diretório de arquivos do módulo "pen" para o diretório sei/web/modulos/
147   - Importante renomear a pasta do módulo "mod-sei-pen" para somente "pen" por questões de padronização de nomenclatura.
148   -
149   -7. Mover o arquivo do certificado digital utilizado para integração com o **ConectaGov** para o diretório "sei/config/".
  205 +Recursos:
  206 +~~~~
  207 + * pen_procedimento_expedido_listar
  208 + * pen_procedimento_expedir
  209 +~~~~
  210 +
  211 +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:
  212 +~~~~
  213 + * pen_map_hipotese_legal_envio_alterar
  214 + * pen_map_hipotese_legal_envio_cadastrar
  215 + * pen_map_hipotese_legal_envio_excluir
  216 + * pen_map_hipotese_legal_envio_listar
  217 + * pen_map_hipotese_legal_padrao
  218 + * pen_map_hipotese_legal_padrao_cadastrar
  219 + * pen_map_hipotese_legal_recebimento_alterar
  220 + * pen_map_hipotese_legal_recebimento_cadastrar
  221 + * pen_map_hipotese_legal_recebimento_excluir
  222 + * pen_map_hipotese_legal_recebimento_listar
  223 + * pen_map_tipo_documento_envio_alterar
  224 + * pen_map_tipo_documento_envio_cadastrar
  225 + * pen_map_tipo_documento_envio_excluir
  226 + * pen_map_tipo_documento_envio_listar
  227 + * pen_map_tipo_documento_envio_visualizar
  228 + * pen_map_tipo_documento_recebimento_alterar
  229 + * pen_map_tipo_documento_recebimento_cadastrar
  230 + * pen_map_tipo_documento_recebimento_excluir
  231 + * pen_map_tipo_documento_recebimento_listar
  232 + * pen_map_tipo_documento_recebimento_visualizar
  233 + * pen_map_unidade_alterar
  234 + * pen_map_unidade_cadastrar
  235 + * pen_map_unidade_excluir
  236 + * pen_map_unidade_listar
  237 + * pen_parametros_configuracao
  238 + * pen_parametros_configuracao_alterar
  239 +~~~~
  240 +Recomenda-se que os recursos acima não sejam atribuídos aos perfis básicos do sistema.
150 241  
151   - 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.
  242 +---
  243 +##### 14. Configurar as unidades do SEI que poderão realizar o envio e recebimento de trâmites externos
  244 +
  245 +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).
  246 +No credenciamento da instituição, estes valores serão passados pela unidade de TI do MPDG.
  247 +
  248 +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.
  249 +
  250 +---
  251 +##### 15. Configuração de unidade administrativa virtual para gerenciamento de envio e recebimento de processos pelo módulo.
  252 +
  253 +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.
  254 +
  255 +##### 15.1. Acessar o SIP e criar uma nova unidade administrativa com as seguintes configurações:
152 256  
153   - 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.
  257 + Sigla: EXTERNO
  258 + Nome: Unidade Externa
154 259  
155   - 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.).
  260 +##### 15.2. Configurar a nova unidade na hierarquia do SEI, através da funcionalidade **[SIP > Hierarquias > Montar]**
156 261  
157   - Maiores informações e solicitações podem ser feitas através do e-mail processo.eletronico@planejamento.gov.br.
  262 +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**
158 263  
159   -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.
  264 +---
  265 +##### 16. Configuração de tipo de processo a ser aplicado aos processos recebidos de instituições externas.
160 266  
161   -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.
  267 +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.
162 268  
  269 +Caso a opção for pela criação de um novo tipo de processo específico, segue abaixo sugestão para configuração:
163 270  
164   -10. Executar o script **sip\_atualizar\_versao\_modulo_pen.php** para atualizar o banco de dados do SIP para o funcionamento do módulo:
  271 +```
  272 + Nome: Processo Recebido Externamente (a classificar)
  273 + Descrição: Processos recebidos de outras instituições
  274 + // O assunto deve ser definido juntamente com a área de documentação
  275 + Sugestão de Assuntos: 019.01 - INFORMAÇÕES SOBRE O ÓRGÃO
  276 + Restringir aos Órgãos: [vazio]
  277 + Restringir às Unidades: [vazio]
  278 + Níveis de Acesso Permitidos: Restrito e Público
  279 + Nível de Acesso Sugerido: Público
  280 + Processo único no órgão por usuário: Não
  281 + Interessado: Não
  282 + Interno do Sistema: Sim
  283 +```
165 284  
166   - # php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sip/scripts/sip_atualizar_versao_modulo_pen.php
  285 +---
  286 +##### 17. Configurar os parâmetros do Módulo de Integração Pen
  287 +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:
167 288  
168   -11. Executar o script **sei_atualizar_versao_modulo_pen.php** para inserção de dados no banco do SEI referente ao módulo.
  289 +* **Endereço do Web Service:**
  290 +*Endereço dos serviços de integração do PEN*
  291 + - Desenvolvimento: https://pen-api.trafficmanager.net/interoperabilidade/soap/v2/
  292 + - Homologação: https://homolog.pen.api.trafficmanager.net/interoperabilidade/soap/v2/
  293 + - Produção: https://api.conectagov.processoeletronico.gov.br/interoperabilidade/soap/v2/
  294 +* **Endereço do Web Service de Pendências**:
  295 +*Endereço dos serviços de notificação de trâmites de processos*
  296 + - Desenvolvimento: https://pen-pendencias.trafficmanager.net/
  297 + - Homologação: https://homolog.pen.pendencias.trafficmanager.net/
  298 + - Produção: https://pendencias.conectagov.processoeletronico.gov.br/
  299 +* **ID do Repositório de Estruturas:**
  300 +*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.*
  301 + - *Valor 1 (Código de identificação da estrutura organizacional do Poder Executivo - SIORG)*
  302 +* **Localização do Certificado Digital:**
  303 + - *Localização do certificado digital o órgão (arquivo do passo 8)*
  304 +* **Número Máximo de Tentativas de Recebimento:**
  305 + - *Valor padrão: 3*
  306 +* **Tamanho Máximo de Documentos Expedidos:**
  307 + - *Valor padrão: 50*
  308 +* **Senha do Certificado Digital:**
  309 + - *Senha do certificado digital*
  310 +* **Tipo de Processo Externo:**
  311 +*Id do tipo de documento externo. *
  312 + - *Configurar com o ID do Tipo de Processo Externo configurado no passo 15*
  313 +* **Unidade Geradora de Processo e Documento Recebido:**
  314 +*Id da unidade de origem que serão atribuídos os documentos recebidos de um outro órgão.*
  315 + - *Configurar com o ID da Unidade criada no passo 14*
  316 +
  317 +
  318 +---
  319 +##### 18. Iniciar serviços de monitoramento de pendências de trâmite **Gearman** e **Supervisor**
  320 +
  321 +```bash
  322 +service gearmand start && service supervisord start
  323 +```
  324 +
  325 +Executar o comando **ps -ef** e verificar se os dois processos seguintes estão em execução:
  326 +
  327 +```bash
  328 +/usr/bin/php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/modulos/pen/rn/PendenciasTramiteRN.php
  329 +/usr/bin/php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/modulos/pen/rn/ProcessarPendenciasRN.php
  330 +```
  331 +
  332 +Caso não esteja houve algum problema de configuração e a expedição de processos não irá funcionar.
  333 +**Atenção**: Importante colocar o serviço para ser iniciado automaticamente juntamente com o servidor.
169 334  
170   - # php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/scripts/sei_atualizar_versao_modulo_pen.php
  335 +---
  336 +##### 19. Realizar o mapeamento de tipos de documentos do SEI com as especies documentais definidas no PEN, tanto de envio quanto de recebimento.
171 337  
172   -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.
  338 +Esta configuração deve ser feita antes de começar a utilização do módulo.
  339 + - SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Tipos de Documentos >> **Envio** >> Cadastrar
  340 + - SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Tipos de Documentos >> **Recebimento** >> Cadastrar
173 341  
174   -13. Configurar as permissões de segurança para os perfis e unidades que poderão realizar o trâmite externo de processos.
  342 +**Observação**: Os tipos de documentos a serem mapeados deverão estar configurados no SEI como Externo ou Interno/Externo
175 343  
176   - 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.
  344 +---
  345 +##### 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.
177 346  
178   - 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.
  347 +**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.
179 348  
180   - Para criação do novo perfil e atribuição dos devidos recursos, acesse [**SIP > Perfil > Novo**]
  349 +Este mapeamento deve ser feito antes de começar a utilização do módulo e está disponível em
  350 + - SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Hipóteses Legais >> **Envio** >> Cadastrar
  351 + - SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Hipóteses Legais >> **Recebimento** >> Cadastrar
181 352  
182   - Exemplo: ***Perfil: Envio Externo***
183   -
184   - Recursos:
185   -
186   - * pen_procedimento_expedido_listar
187   - * pen_procedimento_expedir
188   -
189   - 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:
190   -
191   - * pen_map_hipotese_legal_envio_alterar
192   - * pen_map_hipotese_legal_envio_cadastrar
193   - * pen_map_hipotese_legal_envio_excluir
194   - * pen_map_hipotese_legal_envio_listar
195   - * pen_map_hipotese_legal_padrao
196   - * pen_map_hipotese_legal_padrao_cadastrar
197   - * pen_map_hipotese_legal_recebimento_alterar
198   - * pen_map_hipotese_legal_recebimento_cadastrar
199   - * pen_map_hipotese_legal_recebimento_excluir
200   - * pen_map_hipotese_legal_recebimento_listar
201   - * pen_map_tipo_documento_envio_alterar
202   - * pen_map_tipo_documento_envio_cadastrar
203   - * pen_map_tipo_documento_envio_excluir
204   - * pen_map_tipo_documento_envio_listar
205   - * pen_map_tipo_documento_envio_visualizar
206   - * pen_map_tipo_documento_recebimento_alterar
207   - * pen_map_tipo_documento_recebimento_cadastrar
208   - * pen_map_tipo_documento_recebimento_excluir
209   - * pen_map_tipo_documento_recebimento_listar
210   - * pen_map_tipo_documento_recebimento_visualizar
211   - * pen_map_unidade_alterar
212   - * pen_map_unidade_cadastrar
213   - * pen_map_unidade_excluir
214   - * pen_map_unidade_listar
215   - * pen_parametros_configuracao
216   - * pen_parametros_configuracao_alterar
217   -
218   - Recomenda-se que os recursos acima não sejam atribuídos aos perfis básicos do sistema.
219   -
220   -14. Configurar as unidades do SEI que poderão realizar o envio e recebimento de trâmites externos
  353 +**Observação**: Os tipos de documentos a serem mapeados deverão estar configurados no SEI como Externo ou Interno/Externo
221 354  
222   - 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).
223   - No credenciamento da instituição, estes valores serão passados pela unidade de TI do MPDG.
  355 +---
  356 +##### 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.
  357 +Este link pode ajudar a configurar conforme o SO utilizado: http://ntp.br/guia-linux-comum.php
224 358  
225   - 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.
  359 +---
  360 +---
226 361  
227   -15. Configuração de unidade administrativa virtual para gerenciamento de envio e recebimento de processos pelo módulo.
  362 +## Atualização
228 363  
229   - 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.
  364 +Para realizar a atualização do módulo, realize os seguintes procedimentos:
230 365  
231   - 15.1. Acessar o SIP e criar uma nova unidade administrativa com as seguintes configurações:
232   -
233   - Sigla: EXTERNO
234   - Nome: Unidade Externa
  366 +##### 1. Fazer backup dos banco de dados do SEI e SIP e dos arquivos de configuração do sistema
235 367  
236   - 15.2. Configurar a nova unidade na hierarquia do SEI, através da funcionalidade **[SIP > Hierarquias > Montar]**
  368 +---
  369 +##### 2. Baixar a última versão do módulo disponível em https://softwarepublico.gov.br/gitlab/sei/mod-sei-pen/tags
237 370  
238   - 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**
  371 +---
  372 +##### 3. Atualizar software Supervisord para a versão 4.X
239 373  
240   -16. Configuração de tipo de processo a ser aplicado aos processos recebidos de instituições externas.
  374 +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.
241 375  
242   - 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.
  376 +---
  377 +##### 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.
243 378  
244   - Caso a opção for pela criação de um novo tipo de processo específico, segue abaixo sugestão para configuração:
  379 +---
  380 +##### 5. Importante renomear a pasta do módulo "mod-sei-pen" para somente "pen" por questões de padronização de nomenclatura
245 381  
246   - Nome: Processo Recebido Externamente (a classificar)
247   - Descrição: Processos recebidos de outras instituições
248   - // O assunto deve ser definido juntamente com a área de documentação
249   - Sugestão de Assuntos: 019.01 - INFORMAÇÕES SOBRE O ÓRGÃO
250   - Restringir aos Órgãos: [vazio]
251   - Restringir às Unidades: [vazio]
252   - Níveis de Acesso Permitidos: Restrito e Público
253   - Nível de Acesso Sugerido: Público
254   - Processo único no órgão por usuário: Não
255   - Interessado: Não
256   - Interno do Sistema: Sim
  382 +---
  383 +##### 6. Mover o arquivo de instalação do módulo no SEI sei_atualizar_versao_modulo_pen.php para a pasta sei/scripts
  384 +Lembre-se de mover, e não copiar, por questões de segurança e padronização;
257 385  
258 386  
259   -17. Configurar os parâmetros do Módulo de Integração Pen
260   -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:
261   - * **Endereço do Web Service:**
262   - *Endereço dos serviços de integração do PEN*
263   - - Desenvolvimento: https://pen-api.trafficmanager.net/interoperabilidade/soap/v2/
264   - - Homologação: https://homolog.pen.api.trafficmanager.net/interoperabilidade/soap/v2/
265   - - Produção: https://api.conectagov.processoeletronico.gov.br/interoperabilidade/soap/v2/
266   - * **Endereço do Web Service de Pendências**:
267   - *Endereço dos serviços de notificação de trâmites de processos*
268   - - Desenvolvimento: https://pen-pendencias.trafficmanager.net/
269   - - Homologação: https://homolog.pen.pendencias.trafficmanager.net/
270   - - Produção: https://pendencias.conectagov.processoeletronico.gov.br/
271   - * **ID do Repositório de Estruturas:**
272   - *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.*
273   - - *Valor 1 (Código de identificação da estrutura organizacional do Poder Executivo - SIORG)*
274   - * **Localização do Certificado Digital:**
275   - - *Localização do certificado digital o órgão (arquivo do passo 8)*
276   - * **Número Máximo de Tentativas de Recebimento:**
277   - - *Valor padrão: 3*
278   - * **Tamanho Máximo de Documentos Expedidos:**
279   - - *Valor padrão: 50*
280   - * **Senha do Certificado Digital:**
281   - - *Senha do certificado digital*
282   - * **Tipo de Processo Externo:**
283   - *Id do tipo de documento externo. *
284   - - *Configurar com o ID do Tipo de Processo Externo configurado no passo 15*
285   - * **Unidade Geradora de Processo e Documento Recebido:**
286   - *Id da unidade de origem que serão atribuídos os documentos recebidos de um outro órgão.*
287   - - *Configurar com o ID da Unidade criada no passo 14*
288   -
289   -
290   -18. Iniciar serviços de monitoramento de pendências de trâmite **Gearman** e **Supervisor**
291   -
292   - # service gearmand start && service supervisord start
293   -
294   - Executar o comando **ps -ef** e verificar se os dois processos seguintes estão em execução:
295   -
296   - # /usr/bin/php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/modulos/pen/rn/PendenciasTramiteRN.php
297   - # /usr/bin/php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/modulos/pen/rn/ProcessarPendenciasRN.php
298   -
299   - Caso não esteja houve algum problema de configuração e a expedição de processos não irá funcionar.
300   -**Atenção**: Importante colocar o serviço para ser iniciado automaticamente juntamente com o servidor.
  387 +---
  388 +##### 7. Mover o arquivo de instalação do módulo no SIP sip_atualizar_versao_modulo_pen.php para a pasta sip/scripts
  389 +Lembre-se de mover, e não copiar, por questões de segurança e padronização;
301 390  
302   -19. Realizar o mapeamento de tipos de documentos do SEI com as especies documentais definidas no PEN, tanto de envio quanto de recebimento.
  391 +---
  392 +##### 8. Executar o script sip_atualizar_versao_modulo_pen.php para atualizar o banco de dados do SIP para o funcionamento do módulo
  393 +```bash
  394 +php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sip/scripts/sip_atualizar_versao_modulo_pen.php
  395 +```
303 396  
304   - Esta configuração deve ser feita antes de começar a utilização do módulo.
305   - - SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Tipos de Documentos >> **Envio** >> Cadastrar
306   - - SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Tipos de Documentos >> **Recebimento** >> Cadastrar
  397 +---
  398 +##### 9. Executar o script sei_atualizar_versao_modulo_pen.php para inserção de dados no banco do SEI referente ao módulo
  399 +```bash
  400 +php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/scripts/sei_atualizar_versao_modulo_pen.php
  401 +```
307 402  
308   - **Observação**: Os tipos de documentos a serem mapeados deverão estar configurados no SEI como Externo ou Interno/Externo
  403 +---
  404 +##### 10. Configurar a tarefa de reinicialização de serviços caso se identifique possíveis indisponibilidades. (Manual de Instalação do módulo)
  405 +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).
  406 +​
  407 +Mova o script verificar-servicos.sh, localizado na raiz do diretório do módulo, para a pasta de sei/bin do SEI.
309 408  
  409 +```bash
  410 +cp [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/web/modulos/pen/verificar-servicos.sh /opt/sei/bin/
  411 +```
310 412  
311   -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.
  413 +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.
312 414  
313   - **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.
  415 +```bash
  416 +crontab -e
314 417  
315   - Este mapeamento deve ser feito antes de começar a utilização do módulo e está disponível em
316   - - SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Hipóteses Legais >> **Envio** >> Cadastrar
317   - - SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Hipóteses Legais >> **Recebimento** >> Cadastrar
  418 +*/10 * * * * [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/bin/verificar-servicos.sh
  419 +```
318 420  
319   - **Observação**: Os tipos de documentos a serem mapeados deverão estar configurados no SEI como Externo ou Interno/Externo
  421 +---
  422 +##### 11. Reiniciar serviços de monitoramento de pendências de trâmite Gearman e Supervisor:
  423 +```bash
  424 +service gearmand restart && service supervisord restart
  425 +```
320 426  
321   -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.
  427 +---
  428 +---
322 429  
323   - Este link pode ajudar a configurar conforme o SO utilizado: http://ntp.br/guia-linux-comum.php
324 430  
325 431 ## Utilização
326 432  
... ... @@ -428,34 +534,6 @@ O destinatário pode realizar a consulta ao recibo de trâmite, acessando o íco
428 534  
429 535 ![Tela de Controle do Processo - Ícone de Consulta de Recibos](imagens/recibo_conclusao_tramite_destinatario.png)
430 536  
431   -### Hipóteses de Recusa de Trâmite
432   -
433   -### Consulta de Processos Enviados Externamente
434   -
435   -## Atualização
436   -
437   -Para realizar a atualização do módulo, realize os seguintes procedimentos:
438   -
439   -​1. Fazer backup dos banco de dados do SEI e SIP e dos arquivos de configuração do sistema;
440   -
441   -2. Baixar a última versão do módulo disponível em https://softwarepublico.gov.br/gitlab/sei/mod-sei-pen/tags
442   -
443   -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;
444   -
445   -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;
446   -
447   -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;
448   -
449   -6. Executar o script sip_atualizar_versao_modulo_pen.php para atualizar o banco de dados do SIP para o funcionamento do módulo:
450   -# php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sip/scripts/sip_atualizar_versao_modulo_pen.php
451   -
452   -7. Executar o script sei_atualizar_versao_modulo_pen.php para inserção de dados no banco do SEI referente ao módulo:
453   -# php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/scripts/sei_atualizar_versao_modulo_pen.php
454   -
455   -8. Iniciar serviços de monitoramento de pendências de trâmite Gearman e Supervisor:
456   -# service gearmand start && service supervisord start
457   -
458   -
459 537 ## Suporte
460 538  
461 539 ## Problemas Conhecidos
... ...