Este documento apresenta o manual para a instalação do Módulo do Protocolo Integrado, que permite ao SEI enviar metadados dos processos e suas tramitações para o sistema Protocolo Integrado (protocolointegrado.gov.br).
Este módulo é compatível com o SEI ou SUPER a partir da versão 4.0.
ATENÇÃO: Caso o módulo já se encontre instalado em uma versão anterior, siga as instruções detalhadas de atualização no documento MIGRACAO.md presente no arquivo de distribuição do módulo (mod-sei-protocolo-integrado-VERSAO.zip)
O Protocolo Integrado é um sistema instituído pela Portaria Interministerial nº 2.320, de 30 de dezembro de 2014, de adesão obrigatória para os órgãos do Governo Federal, que objetiva servir ao cidadão como ferramenta de consulta sobre as tramitações de documentos e processos atuados no âmbito da Administração Pública Federal. Maiores informações sobre o projeto deste sistema podem ser acessadas através do endereço: https://gov.br/pen
O módulo do Protocolo Integrado adiciona novas funcionalidade para permitir o envio dos metadados de processos do SEI/SUPER para o Protocolo Integrado. O envio destes metadados é realizado de modo bastante simples, além de ser transparente para aquelas pessoas utilizam o sistema.
Este documento está estruturado nas seguintes seções:
-
Instalação: Procedimentos destinados à Equipe Técnica responsáveis pela instalação do módulo nos servidores web e atualização do banco de dados.
-
Configuração: Procedimentos destinados ao Administradores responsáveis pela configuração do módulo através da funcionalidades de administração do sistema.
-
Suporte: Canais de comunicação para resolver problemas ou tirar dúvidas sobre o módulo e os demais componentes do Processo Eletrônico Nacional.
-
Problemas Conhecidos: Canais de comunicação para resolver problemas ou tirar dúvidas sobre o módulo e os demais componentes do Processo Eletrônico Nacional.
Esta seção descreve os passos obrigatórios para INSTALAÇÃO do **mod-sei-protocolo-integrado**.
Todos os itens descritos nesta seção são destinados à equipe de tecnologia da informação, responsáveis pela execução dos procedimentos técnicos de instalação e manutenção da infraestrutura.
- SEI ou SUPER, versão 4.0.x 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;
- Credenciais (usuário e senha) para publicar no Protocolo Integrado, conforme orientações presentes no seguinte endereço: https://portaldeservicos.economia.gov.br .
Por questões de segurança, a equipe do Protocolo Integrado libera inicialmente o acesso ao webservice do ambiente de homologação do sistema e, posteriormente, o acesso ao webservice de produção após testes completado os testes em ambiente de homologação.
Para maiores informações, entre em contato pelo telefone 0800 978-9005 ou diretamente pela Central de Serviços do PEN, endereço https://portaldeservicos.economia.gov.br/.
Todos os procedimentos de manutenção do sistema devem ser precedidos de backup completo de todo o sistema a fim de possibilitar a sua recuperação em caso de falha. A rotina de instalação descrita abaixo atualiza tanto o banco de dados, como os arquivos pré-instalados do módulo e, por isto, todas estas informações precisam ser resguardadas.
Necessário realizar o download do pacote de distribuição do módulo mod-sei-protocolo-integrado para instalação ou atualização do sistema SEI. O pacote de distribuição consiste em um arquivo zip com a denominação mod-sei-protocolo-integrado-VERSAO.zip e sua última versão pode ser encontrada em https://github.com/spbgovbr/mod-sei-protocolo-integrado/releases
Após realizar a descompactação do arquivo .zip, será criada uma nova pasta contendo a seguinte estrutura:
/**mod-sei-protocolo-integrado**-VERSAO
/sei # Arquivos do módulo posicionados corretamente dentro da estrutura do SEI
/sip # Arquivos do módulo posicionados corretamente dentro da estrutura do SIP
INSTALACAO.md # Instruções de instalação do **mod-sei-protocolo-integrado**
MIGRACAO.md # Instruções de atualização do **mod-sei-protocolo-integrado**
NOTAS_VERSAO.md # Registros de novidades, melhorias e correções desta versão
Importante enfatizar que os arquivos contidos dentro dos diretórios sei e sip não substituem nenhum código-fonte original do sistema. Eles apenas posicionam os arquivos do módulos nas pastas corretas de scripts, configurações e pasta de módulos, todos posicionados dentro de um diretório específico denominado mod-pen para deixar claro quais scripts fazem parte do módulo.
Os diretórios sei e sip descompactados acima devem ser mesclados com os diretórios originais através de uma cópia simples dos arquivos.
Observação: O termo curinga VERSAO deve ser substituído nas instruções abaixo pelo número de versão do módulo que está sendo instalado
$ cp /tmp/**mod-sei-protocolo-integrado**-VERSAO.zip <DIRETÓRIO RAIZ DE INSTALAÇÃO DO SEI E SIP>
$ cd <DIRETÓRIO RAIZ DE INSTALAÇÃO DO SEI E SIP>
$ unzip **mod-sei-protocolo-integrado**-VERSAO.zip
Esta etapa é padrão para a instalação de qualquer módulo no SEI para que ele possa ser carregado junto com o sistema. Edite o arquivo sei/config/ConfiguracaoSEI.php para adicionar a referência ao módulo PEN na chave [Modulos] abaixo da chave [SEI]:
'SEI' => array(
'URL' => ...,
'Producao' => ...,
'RepositorioArquivos' => ...,
'Modulos' => array('ProtocoloIntegradoIntegracao' => 'protocolo-integrado'),
),Adicionar a referência ao módulo PEN na array da chave 'Modulos' indicada acima:
'Modulos' => array('ProtocoloIntegradoIntegracao' => 'protocolo-integrado')A atualização realizada no SIP não cria nenhuma tabela específica para o módulo, apenas é aplicada a criarção os recursos, permissões e menus de sistema utilizados pelo mod-sei-protocolo-integrado. Todos os novos recursos criados possuem o prefixo protocolo_integrado_ para fácil localização pelas funcionalidades de gerenciamento de recursos do SIP.
O script de atualização da base de dados do SIP fica localizado em <DIRETÓRIO RAIZ DE INSTALAÇÃO DO SEI E SIP>/sip/scripts/mod-protocolo-integrado/sip_atualizar_versao_modulo_protocolo_integrado.php
$ php -c /etc/php.ini <DIRETÓRIO RAIZ DE INSTALAÇÃO DO SEI E SIP>/sip/scripts/mod-protocolo-integrado/sip_atualizar_versao_modulo_protocolo_integrado.phpNesta etapa é instalado/atualizado as tabelas de banco de dados vinculadas do mod-sei-protocolo-integrado. Todas estas tabelas possuem o prefixo md_pi_ para organização e fácil localização no banco de dados.
O script de atualização da base de dados do SIP fica localizado em <DIRETÓRIO RAIZ DE INSTALAÇÃO DO SEI E SIP>/sei/scripts/mod-protocolo-integrado/sei_atualizar_versao_modulo_protocolo_integrado.php
$ php -c /etc/php.ini <DIRETÓRIO RAIZ DE INSTALAÇÃO DO SEI E SIP>/sei/scripts/mod-protocolo-integrado/sei_atualizar_versao_modulo_protocolo_integrado.phpA instalação da nova versão do mod-sei-protocolo-integrado cria um arquivo de configuração específico para o módulo dentro da pasta de configuração do SEI (<DIRETÓRIO RAIZ DE INSTALAÇÃO DO SEI>/sei/config/mod-protocolo-integrado/).
O arquivo de configuração padrão criado ConfiguracaoModProtocoloIntegrado.exemplo.php vem com o sufixo exemplo justamente para não substituir o arquivo principal contendo as configurações vigentes do módulo.
Caso não exista o arquivo principal de configurações do módulo criado em <DIRETÓRIO RAIZ DE INSTALAÇÃO DO SEI E SIP>/sei/config/mod-protocolo-integrado/ConfiguracaoModProtocoloIntegrado.php, renomeie o arquivo de exemplo para iniciar a parametrização da integração.
cd <DIRETÓRIO RAIZ DE INSTALAÇÃO DO SEI>/sei/config/mod-protocolo-integrado/
mv ConfiguracaoModProtocoloIntegrado.exemplo.php ConfiguracaoModProtocoloIntegrado.php
Altere o arquivo de configuração específico do módulo em <DIRETÓRIO RAIZ DE INSTALAÇÃO DO SEI E SIP>/sei/config/mod-protocolo-integrado/ConfiguracaoModProtocoloIntegrado.php e defina as configurações do módulo, conforme apresentado abaixo:
-
WebService Endereço do Web Service principal de integração com o Protocolo Integrado Os endereços disponÃveis são os seguintes (verifique se houve atualizações durante o procedimento de instalação):
-
UsuarioWebService
Login do usuário a ser utilizado na autenticação com o Webservice -
SenhaWebService
Senha do usuário a ser utilizado na autenticação com o Webservice -
TentativasReenvio Número de Tentativas para Reenvio dos Metadados. Quando o envio de processos para o Protocolo Integrado for malsucedido, o módulo tentará reenviá-los respeitando a quantidade de vezes especificada abaixo.
-
QuantidadeAndamentosEnvio Número máximo de andamentos a enviar por vez. Quando o agendamento for executado, este parâmetro utilizado como número máximo de andamentos de processos a ser enviado.
-
PublicarProcessosRestritos
Publica informações de processos restritos
A título de esclarecimento, é importante destacar que além dos itens e subtitens de menu apresentados, o processo de instalação também cria, no SIP, os seguintes 7 recursos:
-
md_pi_acesso_arquivo_metadados: Responsável por dar permissão de acesso a visualizar (no tabela do item de menu 'Monitoramento') os metadados que foram enviados ao Protocolo Integrado e ao log de erro caso tenha ocorrido algum problema na publicação.
-
md_pi_configurar_publicacao: Responsável por dar permissão de acesso para selecionar quais tipos de andamentos dos processos devem ser publicadas no Protocolo Integrado (item de menu 'Configuração das Mensagens').
-
md_pi_forcar_reenvio: Responsável por dar permissão para forçar reenvio de informações de processos de forma manual.
-
md_pi_mensagens_alterar: Responsável por dar permissão de alterar a descrição dos andamentos dos processos que devem ser publicadas no Protocolo Integrado (item de menu 'Configuração das Mensagens').
-
md_pi_mensagens_listar: Responsável por dar permissão a visualizar todos os andamentos passíveis de publicação no Protocolo Integrado (item de menu 'Configuração das Mensagens').
-
md_pi_monitoramento: Responsável por dar permissão à tela de monitoramento dos processos enviados ao Protocolo Integrado (item de menu 'Monitoramento').
Além dos itens de menu e recursos já vistos (criados no SIP), o processo de instalação do módulo também realiza, no SEI, a criação de três agendamentos relacionados ao Protocolo Integrado (menu Infra > Agendamentos). Os mesmos encontram-se inicialmente desativados e serão descritos a seguir.
Este é o único agendamento de execução obrigatória, e portanto deve ser ativado. Trata-se da “rotina de publicação dos processos no Protocolo Integrado”.
Periodicidade: É recomendado que seja diária e fora do horário comercial. O valor padrão da periodicidade (2 horas da manhã) deve ser alterado como melhor convir à organização. Não há parâmetros adicionais.
Atenção: Imagine que se todos os órgãos utilizarem o valor padrão sem alterá-lo teremos muitos órgãos utilizando de forma concorrente o webservice neste horário.
Rotina de notificação por e-mail caso a publicação de processos pare de executar. É um agendamento opcional que deve ser ativado caso o administrador do módulo do Procolo Integrado deseje receber notificações avisando que o agendamento de publicação não está sendo executado há determinado tempo. O e-mail informará há quantos dias o agendamento da publicação de processos não executa corretamente.
Esse agendamento recebe como parâmetro o número de dias de tolerância de não envio de informações para o Protocolo Integrado.
Periodicidade: Livre escolha quanto à periodicidade de execução.
Parâmetros: Deve ser informado um valor inteiro que indica a tolerância para quantidade de dias sem ocorrer publicação. Excedida esta quantidade de dias sem publicação, será enviado um e-mail ao administrador da integração notificando tal fato. O valor máximo a ser cadastrado para este parâmetro deve ser dois (2), para que não haja desconformidade com o § 1º do art. 3º da Portaria Interministerial nº 2.320, de 30 de dezembro de 2014.
Rotina de notificação por e-mail de processos que falharam ao serem publicados. É um agendamento opcional que deve ser ativado (recomendável) caso o administrador do módulo de publicação deseje receber notificações sobre processos que não puderam ser publicados no Protocolo Integrado.
Exibe informações sobre quantos processos não foram publicados na última vez que o agendamento de publicação foi executado.
Periodicidade: Livre escolha quanto à periodicidade de execução.
Em caso de dúvidas ou problemas durante o procedimento de atualização, favor entrar em conta pelos canais de atendimento disponibilizados na Central de Atendimento do Processo Eletrônico Nacional, que conta com uma equipe para avaliar e responder esta questão de forma mais rápida possível.
Para mais informações, contate a equipe responsável por meio dos seguintes canais:
- Portal de Atendimento (PEN): Canal de Atendimento - Módulo do Protocolo Integrado
- Telefone: 0800 978 9005