Download as
Browse Code »

Commit dce777e9c5ea9ebdbfa69ea26a4bdaeb53ab24d5

Authored by Guilherme Andrade Del Cantoni
1 parent 5f76b569

Ajuste na documentação do módulo para indicar os recursos a serem configurados no SEI

Showing 2 changed files with 11 additions and 243 deletions   Show diff stats
LEIAME.txt
View file @5f76b56
@@ -1,243 +0,0 @@ @@ -1,243 +0,0 @@
1 -========================================================================================================================================  
2 -Módulo PEN  
3 -Data de criação: 27/05/2016  
4 -Data de atualizaçao: 09/08/2017  
5 -Versão: 0.0.3  
6 -=======================================================================================================================================  
7 -Módulo de Integração SEI - PEN  
8 -===================  
9 -  
10 -Data de criação: 27/05/2016  
11 -Data de atualizaçao: 12/09/2017  
12 -Versão: 1.0.0  
13 -  
14 -  
15 -### REQUISITOS PARA INSTALAÇÂO:  
16 -- SEI 3.0.5 (ou superior) instalada (verificar valor da constante de versão do SEI no arquivo sei/SEI.php)  
17 -  
18 -- Usuário de acesso ao banco de dados do SEI e SIP com as devidas permissões de acesso para modificar estrutuda 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 escrita no banco de dados.  
19 -- 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.  
20 -Como todas as comunicações realizadas com o ConectaGov utilizarão conexão segura via HTTPS com certificados digitais emitidos pela cadeia do ICP-Brasil, os servidores de aplicação precisam ser configurados para reconhecer esta cadeia como confiável, o que não é padrão nos sistemas operacionais atuais. 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:  
21 - - Copie o certificado da cadeia de CA utilizado pelo ConectaGov para o diretório /usr/local/share/ca-certificates:  
22 -  
23 - > cp <CERTIFICADO-CA-ICP-BRASIL> /usr/local/share/ca-certificates  
24 -  
25 - - Efetue a atualização da lista de certificados confiáveis do SO  
26 -> sudo update-ca-certificates  
27 ->  
28 -- 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  
29 -  
30 -  
31 -### PROCEDIMENTOS PARA INSTALAÇÂO:  
32 -  
33 -1) Fazer backup dos banco de dados do SEI, SIP e repositórios de arquivos.  
34 -  
35 -2) Instalar o gearmand e o supervisord no servidor responsável por tratar o agendamento de tarefas do sistema.  
36 -**Importante:** É imprescindível que seja no mesmo nó em que está configurado o CRON de agendamento principal do SEI.  
37 -  
38 - # Pre-requisito. Caso contrario, os demais pacotes não são encontrados no CentOS7  
39 - yum install epel-release && yum update  
40 -  
41 - # Instalação do Gearman e supervisord  
42 - yum install supervisor gearmand libgearman libgearman-devel php56*-pecl-gearman  
43 -  
44 -  
45 -3) Configuração do supervisor.  
46 -**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)  
47 -**ATENÇÂO 2:** Verifique se a localização dos scripts ProcessarPendenciasRN.php e PendenciasTramiteRN.php estão corretas no parâmetro 'command'  
48 -  
49 - vi /etc/supervisord.conf  
50 - ...  
51 - # Adicione no final do arquivo  
52 - [program:sei_processar_pendencias]  
53 - command=/usr/bin/php -c /etc/php.ini /opt/sei/web/modulos/pen/rn/ProcessarPendenciasRN.php  
54 - numprocs=1  
55 - directory=/opt/sei/web  
56 - user=apache  
57 - autostart=true  
58 - autorestart=true  
59 - log_stderr=true  
60 - stdout_logfile=/var/log/supervisor/sei-supervisord-stdout.log  
61 - stderr_logfile=/var/log/supervisor/sei-supervisord-stderr.log  
62 -  
63 - [program:sei_monitorar_pendencias]  
64 - command=/usr/bin/php -c /etc/php.ini /opt/sei/web/modulos/pen/rn/PendenciasTramiteRN.php  
65 - numprocs=1  
66 - directory=/opt/sei/web  
67 - user=apache  
68 - autostart=true  
69 - autorestart=true  
70 - log_stderr=true  
71 - stdout_logfile=/var/log/supervisor/sei-supervisord-stdout.log  
72 - stderr_logfile=/var/log/supervisor/sei-supervisord-stderr.log  
73 -  
74 -4) Configurar agendamento de tarefas de reinicialização de serviços caso se identifique os estes estão indisponíveis  
75 -  
76 -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.  
77 -  
78 -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.  
79 -  
80 -4.1) Copiar script de verificação dos serviços de integração do ConectaGov para a pasta de arquivos binários do SEI  
81 -Atenção: Altere a referência para [DIRETORIO_RAIZ_INSTALAÇÃO] descrito abaixo  
82 -cp [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/web/modulos/pen/verificar-servicos.sh /opt/sei/bin/  
83 -  
84 -4.2) Configurar agendamento no cron  
85 -Atenção: Altere a referência para [DIRETORIO_RAIZ_INSTALAÇÃO] descrito abaixo  
86 -  
87 - # crontab -e  
88 - */10 * * * * [DIRETORIO_RAIZ_INSTALAÇÃO]`enter code here`/sei/bin/verificar-servicos.sh  
89 -  
90 -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  
91 -  
92 - 'SEI' => array(  
93 - 'URL' => 'http://[servidor sei]/sei',  
94 - 'Producao' => true,  
95 - 'RepositorioArquivos' => '/var/sei/arquivos',  
96 - 'Modulos' => array(),  
97 - ),  
98 -  
99 -Adicionar a referência ao módulo PEN na array da chave 'Modulos' indicada acima:  
100 -  
101 - 'Modulos' => array('PENIntegracao' => 'pen')  
102 -  
103 -7) Mover o diretório de arquivos do módulo "pen" para o diretório sei/web/modulos/.  
104 -  
105 -8) Colocar o arquivo do certificado digital utilizado para integração com o ConectaGov no diretório "sei/config/".  
106 -  
107 -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.).  
108 -  
109 -9) Copiar o arquivo de instalação do módulo no SEI **sei_atualizar_versao_modulo_pen.php** para a pasta sei/scripts  
110 -  
111 -10) Copiar o arquivo de instalação do módulo no SIP **sip_atualizar_versao_modulo_pen.php** para a pasta sip/scripts  
112 -  
113 -11) Executar o script "sip_atualizar_versao_modulo_pen.php" para atualizar o banco de dados do SIP para o funcionamento do módulo:  
114 -Atenção: Altere a referência para [DIRETORIO_RAIZ_INSTALAÇÃO] descrito abaixo  
115 -  
116 - # php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sip/scripts/sip_atualizar_versao_modulo_pen.php  
117 -  
118 -12) Executar o script **sei_atualizar_versao_modulo_pen.php** para inserção de dados no banco do SEI referente ao módulo.  
119 -Atenção: Altere a referência para [DIRETORIO_RAIZ_INSTALAÇÃO] descrito abaixo  
120 -  
121 - # php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/scripts/sei_atualizar_versao_modulo_pen.php  
122 -  
123 -13) Atualizar a tabela [md_pen_unidade] com os seus respectivos valores do campo "id_unidade_rh".  
124 -  
125 -Atenção: Esta configuração será realizada diretamente no banco de dados somente nesta primeira versão do módulo. 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.  
126 -Na fase de homologação do sistema, estes valores serão passados pela SETIC/MP.  
127 -  
128 - update md_pen_unidade set id_unidade_rh = [ID_UNIDADE_PEN] where id_unidade = [ID_UNIDADE_SEI];  
129 -  
130 -14) Configuração de unidade administrativa virtual para gerenciamento de envio e recebimento de processos pelo módulo.  
131 -  
132 -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.  
133 -  
134 -14.1) Acessar o SIP e criar uma nova unidade administrativa com as seguintes configurações:  
135 -  
136 - sigla: EXTERNO  
137 - nome: Unidade Externa  
138 -  
139 -14.2) Configurar a nova unidade na hierarquia do SEI, através da funcionalidade SIP >> Hierarquias >> Montar  
140 -  
141 -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**  
142 -  
143 -14.3) Obter o número de identificação da nova unidade para posterior configuração dos parâmetros do módulo de integração. O código da nova unidade pode ser obtido através da funcionalidade *SEI >> Administração >> Unidades >> Listar*  
144 -  
145 -15) Configuração de tipo de processo a ser aplicado aos processos recebidos de outras instituições.  
146 -  
147 -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.  
148 -  
149 -Caso a opção for pela criação de um novo tipo de processo específico, segue abaixo sugestão para configuração:  
150 -  
151 -15.1) Criar um novo Tipo de Processo pela funcionalidade *SEI >> Administração >> Tipo de Processo*  
152 -  
153 -> Nome: Demanda Externa: Outros Órgãos Públicos Descrição:  
154 -> Processos recebidos de outras instituições Sugestão de Assuntos: [A  
155 -> CLASSIFICAÇÃO DE ASSUNTO DEVE SER DEFINIDO JUNTAMENTE COM A ÁREA DE DOCUMENTAÇÃO]  
156 -> Ex: 019.01 - INFORMAÇÕES SOBRE O ÓRGÃO  
157 -> Restringir aos Órgãos: [vazio]  
158 -> Restringir às Unidades: [vazio]  
159 -> Níveis de Acesso Permitidos: Público  
160 -> Nível de Acesso Sugerido: Público  
161 -> Processo único no órgão por usuário: Não  
162 -> Interessado: Não  
163 -> Interno do Sistema: Sim  
164 -  
165 -15.2) Obter o número de ID do novo Tipo de Processo para posterior configuração dos parâmetros do módulo de integração. O ID do novo Tipo de Processo pode ser obtido através da funcionalidade *SEI >> Administração >> Tipo de Processo >> Listar*  
166 -  
167 -16) Configurar os parâmetros do Módulo de Integração Pen (Menu: *SEI >> Infra >> Parâmetros*)  
168 -  
169 -**PEN_ENDERECO_WEBSERVICE:** [Endereço dos serviços de integração do PEN]  
170 -  
171 -- Desenvolvimento:  
172 -https://pen-api.trafficmanager.net/interoperabilidade/soap/v1_1/  
173 -- Homologação: https://homolog.pen.api.trafficmanager.net/interoperabilidade/soap/v1_1/  
174 -- Produção: https://api.conectagov.processoeletronico.gov.br/interoperabilidade/soap/v1_1/  
175 -  
176 -**=> PEN_ENDERECO_WEBSERVICE_PENDENCIAS**: [Endereço dos serviços de notificação de trâmites de processos]  
177 -  
178 -- Desenvolvimento:  
179 - https://pen-pendencias.trafficmanager.net/  
180 -- Homologação:  
181 - https://homolog.pen.pendencias.trafficmanager.net/  
182 -- Produção:  
183 - https://pendencias.conectagov.processoeletronico.gov.br/  
184 -  
185 -**=> PEN_ID_REPOSITORIO_ORIGEM:**  
186 -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.  
187 -Exemplo: 1 (Código de identificação da estrutura organizacional do Poder Executivo [SIORG])  
188 -  
189 -**=> PEN_LOCALIZACAO_CERTIFICADO_DIGITAL:**  
190 -Localização do certificado digital o órgão (arquivo do passo 8)  
191 -  
192 -**=> PEN_NUMERO_TENTATIVAS_TRAMITE_RECEBIMENTO:**  
193 -Valor padrão: 3  
194 -  
195 -**=> PEN_TAMANHO_MAXIMO_DOCUMENTO_EXPEDIDO:**  
196 -Valor padrão: 50  
197 -  
198 -**=> PEN_SENHA_CERTIFICADO_DIGITAL:**  
199 -Senha do certificado digital  
200 -Atenção: Configuração de senha será modificada na próxima versão para utilização de criptografia  
201 -  
202 -**=> PEN_TIPO_PROCESSO_EXTERNO:**  
203 -Id do tipo de documento externo. Configurar com o ID do Tipo de Processo Externo configurado no passo 15  
204 -  
205 -**=> PEN_UNIDADE_GERADORA_DOCUMENTO_RECEBIDO:**  
206 -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  
207 -  
208 -  
209 -17) Iniciar Gearman e Supervisor  
210 -Atenção: Altere a referência para [DIRETORIO_RAIZ_INSTALAÇÃO] descrito abaixo:  
211 -  
212 - service gearmand start && service supervisord start  
213 -  
214 -Executar o comando "ps -ef" e verificar se os dois processos seguintes estão em execução:  
215 -  
216 - /usr/bin/php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/modulos/pen/rn/PendenciasTramiteRN.php  
217 -  
218 - /usr/bin/php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/modulos/pen/rn/ProcessarPendenciasRN.php  
219 -  
220 -Caso não esteja houve algum problema de configuração e a expedição de processos não irá funcionar.  
221 -Atenção: Importante colocar o serviço para ser iniciado automaticamente juntamente com o servidor.  
222 -  
223 -18) Realizar o mapeamento de tipos de documentos do SEI com as especies documentais definidas no PEN, tanto de envio quanto de recebimento.  
224 -  
225 -Esta configuração deve ser feita antes de começar a utilização do módulo.  
226 -  
227 -- "Administração" => "Tipos de Documentos" => "Mapeamento de Tipos de Documento" => "Recebimento" => "Cadastrar"  
228 -- "Administração" => "Tipos de Documentos" => "Mapeamento de Tipos de Documento" => "Envio" => "Cadastrar".  
229 -  
230 -Obs.: Os tipos de documentos a serem mapeados deverão estar configurados no SEI como Externo ou Interno/Externo  
231 -  
232 -  
233 -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.  
234 -  
235 -Este link pode ajudar a configurar conforme o SO utilizado: http://ntp.br/guia-linux-comum.php  
236 -  
237 -  
238 -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.  
239 -  
240 -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.  
241 -  
242 -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.  
243 -  
@@ -235,3 +235,14 @@ Por padrão, as funcionalidades (recursos) criados pelo módulo não são atribu @@ -235,3 +235,14 @@ Por padrão, as funcionalidades (recursos) criados pelo módulo não são atribu
235 235
236 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. 236 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.
237 237
  238 +Sugestão:
  239 +20.1) Criar o novo perfil "Trâmite Externo de Processos" e atribuir os seguintes recursos:
  240 +- pen_procedimento_expedir
  241 +- pen_procedimento_expedido_listar
  242 +
  243 +20.2) Adicionar os seguintes recursos ao perfil "Administrador"
  244 +- pen_map_tipo_doc_recebido_listar
  245 +- pen_map_tipo_doc_recebido_cadastrar
  246 +- pen_map_tipo_doc_enviado_visualizar
  247 +- pen_map_tipo_doc_enviado_listar
  248 +- pen_map_tipo_doc_enviado_cadastrar