Download as
Browse Code »

Commit 36ce9267186474ae0a72f247062a95ee92a4d47b

Authored by Guilherme Andrade Del Cantoni
1 parent e7abcc5b
Exists in master and in 7 other branches MarceloAjuste3.0.15, MarceloOracle, MarceloOracle2, desenv, fix-tramite-mesmo-sistma, release-1.1.x, supervisordRH7

Atualização inicial do manual de instalação do módulo, versão 1.1.0

Showing 1 changed file with 82 additions and 52 deletions   Show diff stats
README.md
  Diff comments   View file @36ce926
1 1 Módulo de Integração SEI - PEN
2   -===================
  2 +======================================
3 3  
4 4 Data de criação: 27/05/2016
5   -Data de atualizaçao: 12/09/2017
6   -Versão: 1.0.0
  5 +Data de atualizaçao: 09/02/2018
  6 +Versão: 1.1.0
7 7  
8 8  
9 9 ### REQUISITOS PARA INSTALAÇÂO:
10   -- SEI 3.0.5 (ou superior) instalada (verificar valor da constante de versão do SEI no arquivo sei/SEI.php)
  10 +* SEI 3.0.5 (ou superior) instalada (verificar valor da constante de versão do SEI no arquivo sei/SEI.php)
11 11  
12   -- 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.
13   -- 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.
14   -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:
15   - - Copie o certificado da cadeia de CA utilizado pelo ConectaGov para o diretório /usr/local/share/ca-certificates:
  12 +* 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.
  13 +* 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:
16 14  
17   - > cp <CERTIFICADO-CA-ICP-BRASIL> /usr/local/share/ca-certificates
  15 + -- Copie o certificado da cadeia de CA utilizado pelo ConectaGov para o diretório /usr/local/share/ca-certificates:
  16 + > cp <CERTIFICADO-CA-ICP-BRASIL> /usr/local/share/ca-certificates
18 17  
19   - - Efetue a atualização da lista de certificados confiáveis do SO
20   -> sudo update-ca-certificates
21   ->
22   -- 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
  18 + -- Efetue a atualização da lista de certificados confiáveis do sistema operacional
  19 + > sudo update-ca-certificates
  20 +
  21 +* 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
23 22  
24 23  
25 24 ### PROCEDIMENTOS PARA INSTALAÇÂO:
... ... @@ -73,15 +72,16 @@ No mesmo servidor em que está instalado/configurado o supervisor e gearman (pas
73 72  
74 73 4.1) Copiar script de verificação dos serviços de integração do ConectaGov para a pasta de arquivos binários do SEI
75 74 Atenção: Altere a referência para [DIRETORIO_RAIZ_INSTALAÇÃO] descrito abaixo
76   -cp [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/web/modulos/pen/verificar-servicos.sh /opt/sei/bin/
  75 + cp [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/web/modulos/pen/verificar-servicos.sh /opt/sei/bin/
77 76  
78 77 4.2) Configurar agendamento no cron
79 78 Atenção: Altere a referência para [DIRETORIO_RAIZ_INSTALAÇÃO] descrito abaixo
80 79  
81   - # crontab -e
82   - */10 * * * * [DIRETORIO_RAIZ_INSTALAÇÃO]`enter code here`/sei/bin/verificar-servicos.sh
  80 + # crontab -e
  81 + */10 * * * * [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/bin/verificar-servicos.sh
83 82  
84   -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
  83 +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':
  84 +Atenção para as virgulas nos finais das linhas
85 85  
86 86 'SEI' => array(
87 87 'URL' => 'http://[servidor sei]/sei',
... ... @@ -94,15 +94,15 @@ Adicionar a referência ao módulo PEN na array da chave &#39;Modulos&#39; indicada acim
94 94  
95 95 'Modulos' => array('PENIntegracao' => 'pen')
96 96  
97   -7) Mover o diretório de arquivos do módulo "pen" para o diretório sei/web/modulos/.
  97 +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.
98 98  
99   -8) Colocar o arquivo do certificado digital utilizado para integração com o ConectaGov no diretório "sei/config/".
  99 +8) Mover o arquivo do certificado digital utilizado para integração com o ConectaGov para o diretório "sei/config/".
100 100  
101 101 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.).
102 102  
103   -9) Copiar o arquivo de instalação do módulo no SEI **sei_atualizar_versao_modulo_pen.php** para a pasta sei/scripts
  103 +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.
104 104  
105   -10) Copiar o arquivo de instalação do módulo no SIP **sip_atualizar_versao_modulo_pen.php** para a pasta sip/scripts
  105 +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.
106 106  
107 107 11) Executar o script "sip_atualizar_versao_modulo_pen.php" para atualizar o banco de dados do SIP para o funcionamento do módulo:
108 108 Atenção: Altere a referência para [DIRETORIO_RAIZ_INSTALAÇÃO] descrito abaixo
... ... @@ -114,12 +114,11 @@ Atenção: Altere a referência para [DIRETORIO_RAIZ_INSTALAÇÃO] descrito abai
114 114  
115 115 # php -c /etc/php.ini [DIRETORIO_RAIZ_INSTALAÇÃO]/sei/scripts/sei_atualizar_versao_modulo_pen.php
116 116  
117   -13) Atualizar a tabela [md_pen_unidade] com os seus respectivos valores do campo "id_unidade_rh".
118   -
119   -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.
  117 +13) Configurar as unidades do SEI que poderão realizar o envio e recebimento de trâmites externos
  118 +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.
120 119 Na fase de homologação do sistema, estes valores serão passados pela SETIC/MP.
121 120  
122   - update md_pen_unidade set id_unidade_rh = [ID_UNIDADE_PEN] where id_unidade = [ID_UNIDADE_SEI];
  121 +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.
123 122  
124 123 14) Configuração de unidade administrativa virtual para gerenciamento de envio e recebimento de processos pelo módulo.
125 124  
... ... @@ -134,8 +133,6 @@ Esta configuração é necessária para o SEI realizar as devidas regras de regi
134 133  
135 134 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**
136 135  
137   -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*
138   -
139 136 15) Configuração de tipo de processo a ser aplicado aos processos recebidos de outras instituições.
140 137  
141 138 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.
... ... @@ -156,47 +153,40 @@ Caso a opção for pela criação de um novo tipo de processo específico, segue
156 153 > Interessado: Não
157 154 > Interno do Sistema: Sim
158 155  
159   -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*
160 156  
161   -16) Configurar os parâmetros do Módulo de Integração Pen (Menu: *SEI >> Infra >> Parâmetros*)
  157 +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*)
162 158  
163   -**PEN_ENDERECO_WEBSERVICE:** [Endereço dos serviços de integração do PEN]
164   -
165   -- Desenvolvimento:
166   -https://pen-api.trafficmanager.net/interoperabilidade/soap/v1_1/
167   -- Homologação: https://homolog.pen.api.trafficmanager.net/interoperabilidade/soap/v1_1/
168   -- Produção: https://api.conectagov.processoeletronico.gov.br/interoperabilidade/soap/v1_1/
169   -
170   -**=> PEN_ENDERECO_WEBSERVICE_PENDENCIAS**: [Endereço dos serviços de notificação de trâmites de processos]
  159 +**Endereço do Web Service:** [Endereço dos serviços de integração do PEN]
  160 +- Desenvolvimento: https://pen-api.trafficmanager.net/interoperabilidade/soap/v2/
  161 +- Homologação: https://homolog.pen.api.trafficmanager.net/interoperabilidade/soap/v2/
  162 +- Produção: https://api.conectagov.processoeletronico.gov.br/interoperabilidade/soap/v2/
171 163  
172   -- Desenvolvimento:
173   - https://pen-pendencias.trafficmanager.net/
174   -- Homologação:
175   - https://homolog.pen.pendencias.trafficmanager.net/
176   -- Produção:
177   - https://pendencias.conectagov.processoeletronico.gov.br/
  164 +**Endereço do Web Service de Pendências**: [Endereço dos serviços de notificação de trâmites de processos]
  165 +- Desenvolvimento: https://pen-pendencias.trafficmanager.net/
  166 +- Homologação: https://homolog.pen.pendencias.trafficmanager.net/
  167 +- Produção: https://pendencias.conectagov.processoeletronico.gov.br/
178 168  
179   -**=> PEN_ID_REPOSITORIO_ORIGEM:**
  169 +**ID do Repositório de Estruturas:**
180 170 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.
181 171 Exemplo: 1 (Código de identificação da estrutura organizacional do Poder Executivo [SIORG])
182 172  
183   -**=> PEN_LOCALIZACAO_CERTIFICADO_DIGITAL:**
  173 +**Localização do Certificado Digital:**
184 174 Localização do certificado digital o órgão (arquivo do passo 8)
185 175  
186   -**=> PEN_NUMERO_TENTATIVAS_TRAMITE_RECEBIMENTO:**
  176 +**Número Máximo de Tentativas de Recebimento:**
187 177 Valor padrão: 3
188 178  
189   -**=> PEN_TAMANHO_MAXIMO_DOCUMENTO_EXPEDIDO:**
  179 +**Tamanho Máximo de Documentos Expedidos:**
190 180 Valor padrão: 50
191 181  
192   -**=> PEN_SENHA_CERTIFICADO_DIGITAL:**
  182 +**Senha do Certificado Digital:**
193 183 Senha do certificado digital
194 184 Atenção: Configuração de senha será modificada na próxima versão para utilização de criptografia
195 185  
196   -**=> PEN_TIPO_PROCESSO_EXTERNO:**
  186 +**Tipo de Processo Externo:**
197 187 Id do tipo de documento externo. Configurar com o ID do Tipo de Processo Externo configurado no passo 15
198 188  
199   -**=> PEN_UNIDADE_GERADORA_DOCUMENTO_RECEBIDO:**
  189 +**Unidade Geradora de Processo e Documento Recebido:**
200 190 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
201 191  
202 192  
... ... @@ -217,9 +207,17 @@ Atenção: Importante colocar o serviço para ser iniciado automaticamente junta
217 207 18) Realizar o mapeamento de tipos de documentos do SEI com as especies documentais definidas no PEN, tanto de envio quanto de recebimento.
218 208  
219 209 Esta configuração deve ser feita antes de começar a utilização do módulo.
  210 +- SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Tipos de Documentos >> Envio >> Cadastrar
  211 +- SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Tipos de Documentos >> Recebimento >> Cadastrar
220 212  
221   -- "Administração" => "Tipos de Documentos" => "Mapeamento de Tipos de Documento" => "Recebimento" => "Cadastrar"
222   -- "Administração" => "Tipos de Documentos" => "Mapeamento de Tipos de Documento" => "Envio" => "Cadastrar".
  213 +Obs.: Os tipos de documentos a serem mapeados deverão estar configurados no SEI como Externo ou Interno/Externo
  214 +
  215 +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.
  216 +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.
  217 +
  218 +Este mapeamento deve ser feito antes de começar a utilização do módulo e está disponível em
  219 +- SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Hipóteses Legais >> Envio >> Cadastrar
  220 +- SEI >> Administração >> Processo Eletrônico Nacional >> Mapeamento de Hipóteses Legais >> Recebimento >> Cadastrar
223 221  
224 222 Obs.: Os tipos de documentos a serem mapeados deverão estar configurados no SEI como Externo ou Interno/Externo
225 223  
... ... @@ -235,3 +233,35 @@ Por padrão, as funcionalidades (recursos) criados pelo módulo não são atribu
235 233  
236 234 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 235  
  236 +Sugerimos a configuração dos seguintes recursos no novo perfil criado para trâmites de processos externos:
  237 +* pen_procedimento_expedido_listar
  238 +* pen_procedimento_expedir
  239 +
  240 +Sugerimos a configuração dos seguintes recursos no perfil ADMINISTRADOR:
  241 +* pen_map_hipotese_legal_envio_alterar
  242 +* pen_map_hipotese_legal_envio_cadastrar
  243 +* pen_map_hipotese_legal_envio_excluir
  244 +* pen_map_hipotese_legal_envio_listar
  245 +* pen_map_hipotese_legal_padrao
  246 +* pen_map_hipotese_legal_padrao_cadastrar
  247 +* pen_map_hipotese_legal_recebimento_alterar
  248 +* pen_map_hipotese_legal_recebimento_cadastrar
  249 +* pen_map_hipotese_legal_recebimento_excluir
  250 +* pen_map_hipotese_legal_recebimento_listar
  251 +* pen_map_tipo_documento_envio_alterar
  252 +* pen_map_tipo_documento_envio_cadastrar
  253 +* pen_map_tipo_documento_envio_excluir
  254 +* pen_map_tipo_documento_envio_listar
  255 +* pen_map_tipo_documento_envio_visualizar
  256 +* pen_map_tipo_documento_recebimento_alterar
  257 +* pen_map_tipo_documento_recebimento_cadastrar
  258 +* pen_map_tipo_documento_recebimento_excluir
  259 +* pen_map_tipo_documento_recebimento_listar
  260 +* pen_map_tipo_documento_recebimento_visualizar
  261 +* pen_map_unidade_alterar
  262 +* pen_map_unidade_cadastrar
  263 +* pen_map_unidade_excluir
  264 +* pen_map_unidade_listar
  265 +* pen_parametros_configuracao
  266 +* pen_parametros_configuracao_alterar
  267 +
... ...