Prévia do material em texto
CONHECIMENTOS SOBRE O PROCESSO ELETRÔNICO NACIONAL (PEN) P á g i n a | 1 Manual do Gestor de Unidades Protocolizadoras PRESIDÊNCIA DA REPÚBLICA PRESIDENTE JAIR MESSIAS BOLSONARO MINISTÉRIO DA ECONOMIA MINISTRO DE ESTADO PAULO GUEDES SECRETÁRIO-EXECUTIVO MARCELO PACHECO DOS GUARANYS SECRETÁRIO ESPECIAL DE DESBUROCRATIZAÇÃO, GESTÃO E GOVERNO DIGITAL PAULO SPENCER UEBEL SECRETÁRIO DE GESTÃO CRISTIANO ROCHA HECKERT SECRETÁRIA-ADJUNTA ELISE SUELI PEREIRA GONÇALVES SECRETÁRIO-ADJUNTO RENATO FENILI DEPARTAMENTO DE NORMAS E SISTEMAS DE LOGÍSTICA DIRETOR WESLEY RODRIGO COUTO LIRA COODENAÇÃO-GERAL DO PROCESSO ELETRÔNICO NACIONAL COORDENADORA-GERAL PRISCILA ANDRESSA CORREA CABRAL MINISTÉRIO DA ECONOMIA SECRETARIA ESPECIAL DE DESBUROCRATIZAÇÃO, GESTÃO E GOVERNO DIGITAL SECRETARIA DE GESTÃO DEPARTAMENTO DE NORMAS E SISTEMAS DE LOGÍSTICA COORDENAÇÃO-GERAL DO PROCESSO ELETRÔNICO NACIONAL Manual do Gestor de Unidades Protocolizadoras BRASÍLIA - DF JUNHO DE 2020 Ministério da Economia Secretaria Especial de Desburocratização, Gestão e Governo Digital Secretaria de Gestão Departamento de Normas e Sistemas de Logística Histórico de Versões Data Versão do Manual Descrição 27/02/2020 Versão 1.1 Versão preliminar 11/03/2020 Versão 1.2 Revisão do documento 27/05/2020 Versão 1.3 Revisão do documento 25/06/2020 Versão 1.4 Revisão do documento B823m Brasil. Ministério da Economia. Secretaria Especial de Desburocratização, Gestão e Governo Digital. Secretaria de Gestão. Departamento de Normas e Sistemas de Logística. Manual do gestor de unidades protocolizadoras / Ministério da Economia, Secretaria Especial de Desburocratização, Gestão e Governo Digital, Secretaria de Gestão, Departamento de Normas e Sistemas de Logística. -- Brasília : CGPRO/DELOG/SEGES/Ministério da Economia, 2020. 17 p. : il. 1. Protocolo – Administração Pública. 2. Cadastro – Unidades protocolizadoras. 3. Documentos – Padronização. 4. Brasil. Secretaria Especial de Desburocratização, Gestão e Governo Digital. I. Título. CDD 025.17 Sumário Apresentação .................................................................................................................... 6 Número Único de Protocolo (NUP)............................................................................... 6 Cadastro Nacional de Unidades Protocolizadoras (CNUP) ........................................... 8 Cadastro de Unidades Protocolizadoras .......................................................................... 8 Solicitando o cadastro ................................................................................................... 8 Acessando o sistema ..................................................................................................... 9 Cadastrando unidades protocolizadoras .................................................................... 10 Cadastrando uma unidade protocolizadora ativa existente no SIORG .................. 10 Cadastrando uma unidade inativa (legada) ........................................................... 13 Inativando uma unidade protocolizadora .............................................................. 14 Gerenciando unidades protocolizadoras .................................................................... 14 Editando uma unidade protocolizadora ................................................................. 15 Inativando uma unidade protocolizadora .............................................................. 15 Casos especiais ....................................................................................................... 16 Legislação ........................................................................................................................ 16 P á g i n a | 6 Apresentação Número Único de Protocolo (NUP) O Número Único de Protocolo (NUP) é o padrão oficial de numeração utilizado para controle dos documentos, avulsos ou processos, produzidos ou recebidos pelos órgãos e entidades da Administração Pública Federal direta, autárquica e fundacional, em caráter obrigatório e pelas empresas estatais federais, em caráter facultativo. O NUP tem uma função de grande relevância, pois viabiliza a padronização na gestão documental, desde a produção até o arquivamento dos documentos, assim como facilita as comunicações entre as unidades administrativas dos órgãos e entidades e destas com a sociedade, promovendo a simplificação do acesso às informações sobre os documentos públicos federais. O NUP é composto por 17 dígitos (ex: 00000.000000/0000-00), separados em grupos, de acordo com o art. 3° da Portaria Interministerial n° 11, de 2019. O primeiro conjunto numérico é constituído de cinco dígitos, referentes ao código numérico que identifica a unidade protocolizadora do órgão ou entidade de origem do documento, avulso ou processo. O segundo grupo é constituído de seis dígitos, separados do primeiro grupo por um ponto, e determina o registro sequencial dos documentos, avulsos ou processos, sequência essa que deve ser reiniciada a cada ano. O terceiro grupo, é constituído de quatro dígitos, separados do segundo grupo por uma barra, e indica o ano de atribuição do NUP aos documentos, avulsos ou processos. O quarto e último grupo é formado por dois dígitos, separados do terceiro grupo por hífen, indica os dígitos verificadores, calculados de acordo com os procedimentos descritos no Anexo da Portaria Interministerial nº 11/2019. 00000.000000/0000-00 (17 dígitos) A Portaria Interministerial nº 11, de 25 de novembro de 2019, do Ministério da Justiça e Segurança Pública e Ministério da Economia, dispõe sobre os procedimentos relativos à utilização do Número Único de Protocolo - NUP no âmbito dos órgãos e entidades da Administração Pública Federal direta, autárquica e fundacional. Com a entrada em vigor da Portaria Interministerial nº 11/2019 foram revogados os seguintes normativos: • Portaria SLTI-MP nº 3, de 16 de maio de 2003; • Portaria Interministerial MJ-MP nº 2.321, de 30 de dezembro de 2014; • Portaria Interministerial MJ-MP nº 705, de 22 de junho de 2015; e • Portaria Interministerial MJ-MP nº 3, de 29 de dezembro de 2017. http://www.in.gov.br/web/dou/-/portaria-interministerial-n-11-de-25-de-novembro-de-2019-229645093 http://www.in.gov.br/web/dou/-/portaria-interministerial-n-11-de-25-de-novembro-de-2019-229645093 P á g i n a | 7 Diferenças entre a antiga e a nova Portaria do NUP Portaria SLTI/MP nº 3/2003 Portaria Interministerial nº 11/2019 Define faixas numéricas para os órgãos Não prevê faixas numéricas Trata do Catálogo Nacional de Protocolos da Administração Federal Institui o Cadastro Nacional de Unidades Protocolizadoras da Administração Pública Federal O Cadastro de Unidade Protocolizadora - UP é feito mediante envio de Ofício ao Ministério do Planejamento, Orçamento e Gestão (atual Ministério da Economia) Prevê que o cadastro de UP seja regulado em norma específica a ser expedida pelo Arquivo Nacional do Ministério da Justiça e Segurança Pública – NA/MJSP e pela Secretaria de Gestão do Ministério da Economia – SEGES/ME (Instrução Normativa Interministerial nº 13, de 27 de fevereiro de 2020) Especifica dimensões da capa dos processos Não especifica. Esse assunto é tratado na Portaria Interministerial MJ/MP nº 1.677, de 7 de outubro de 2015, que trata dos procedimentos gerais de protocolo no âmbito dos órgãos e entidades da Administração Pública Federal Possui pouca orientação sobre os procedimentos de atribuição de NUPInstitui procedimentos de atribuição de NUP, inclusive quando tramitados entre órgãos Quadro 1 – Principais diferenças entre a antiga e a nova portaria do NUP. As regras e os procedimentos para a atribuição de código e para o cadastramento das unidades protocolizadoras no âmbito dos órgãos e entidades da Administração Pública federal direta, autárquica e fundacional foram definidos pela Instrução Normativa Interministerial nº 13, de 27 de fevereiro de 2020, do Arquivo Nacional do Ministério da Justiça e Segurança Pública e da Secretaria de Gestão do Ministério da Economia. A referida Instrução Normativa Interministerial tem como objetivos: a. aperfeiçoar e simplificar o cadastro de unidades protocolizadoras da Administração Pública federal direta, autárquica e fundacional; b. padronizar e racionalizar a utilização dos códigos numéricos de unidades protocolizadoras; e c. atualizar e aprimorar a transparência do Cadastro Nacional de Unidades Protocolizadoras da Administração Pública Federal – CNUP. http://www.in.gov.br/en/web/dou/-/instrucao-normativa-n-13-de-27-de-fevereiro-de-2020-245729966 http://www.in.gov.br/en/web/dou/-/instrucao-normativa-n-13-de-27-de-fevereiro-de-2020-245729966 http://www.in.gov.br/en/web/dou/-/instrucao-normativa-n-13-de-27-de-fevereiro-de-2020-245729966 http://www.in.gov.br/materia/-/asset_publisher/Kujrw0TZC2Mb/content/id/33258545/do1-2015-10-08-portaria-interministerial-n-1-677-de-7-de-outubro-de-2015-33258536 http://www.in.gov.br/materia/-/asset_publisher/Kujrw0TZC2Mb/content/id/33258545/do1-2015-10-08-portaria-interministerial-n-1-677-de-7-de-outubro-de-2015-33258536 http://www.in.gov.br/materia/-/asset_publisher/Kujrw0TZC2Mb/content/id/33258545/do1-2015-10-08-portaria-interministerial-n-1-677-de-7-de-outubro-de-2015-33258536 P á g i n a | 8 Cadastro Nacional de Unidades Protocolizadoras (CNUP) O Cadastro Nacional de Unidades Protocolizadoras – CNUP foi instituído pela Portaria Interministerial nº 11/2019 com o objetivo dar publicidade às informações sobre as unidades protocolizadoras da Administração Pública Federal e promover a transparência da gestão. O CNUP ainda está em desenvolvimento, tendo em vista a implementação de relatórios extraídos da base de dados do sistema de cadastro das UP, o qual está sendo alimentado pelos órgãos e entidades de acordo com os procedimentos definidos na Instrução Normativa nº 13/2020, cujo prazo foi prorrogado até 3 de julho de 2020 pela Instrução Normativa nº 32, de 20 de abril de 2020. Cadastro de Unidades Protocolizadoras A gestão das unidades protocolizadoras do órgão e de suas entidades vinculadas deve ser realizada obrigatoriamente pelos Ministérios, pela Advocacia-Geral da União e pela Presidência da República1. Facultativamente o órgão pode autorizar a descentralização para suas entidades vinculadas (autarquias, fundações e empresas públicas). Essa determinação reside no fato de que ainda é necessário realizar a gestão das unidades protocolizadoras a partir do histórico de utilização das faixas numéricas definidas pela Portaria SLTI/MP nº 3/2003, revogada pela Portaria Interministerial nº 11/2019. Para isso, deverão ser designados servidores para atuar como gestores das unidades protocolizadoras. Solicitando o cadastro O cadastro de gestores de unidades protocolizadoras deve ser realizado no endereço https://gestaopen.processoeletronico.gov.br/. Esse portal reúne no mesmo ambiente a gestão do NUP e do Barramento. O gestor de unidades protocolizadoras designado pelo órgão deve primeiramente verificar se o órgão possui Comitê criado. Para isso, basta clicar em “Solicitar cadastro” e selecionar o órgão Se não houver o Comitê criado, realize o cadastro, que será analisado pelo administrador, que comunicará a aprovação. Se já houver comitê criado, solicite ao 1 Ver IN 13/2020. Art. 8º https://www.comprasgovernamentais.gov.br/index.php/legislacao/legislacao-por-tema?layout=edit&id=700 http://www.in.gov.br/web/dou/-/portaria-interministerial-n-11-de-25-de-novembro-de-2019-229645093 http://www.in.gov.br/web/dou/-/portaria-interministerial-n-11-de-25-de-novembro-de-2019-229645093 https://gestaopen.processoeletronico.gov.br/ P á g i n a | 9 gestor cadastrado que o inclua como gestor do NUP. No Portal é possível consultar a relação de gestores. Se não conseguir acionar o gestor já cadastrado, abra chamado na Central de Atendimento do PEN e inclua documento comprobatório de delegação de competência para a atividade, como portaria de nomeação, ofício ou e-mail de designação. Atenção: O “documento comprobatório” é um documento emitido pelo órgão do servidor, comprovando seu vínculo com a instituição e indicando-o como responsável pela gestão das unidades protocolizadoras. A liberação do cadastro está condicionada à análise prévia dos documentos e informações enviadas. Acessando o sistema Acesse o endereço http://gestaopen.processoeletronico.gov.br/ e clique em “Acessar sua Conta”. [1][2] Na página seguinte, informe o CPF, a Senha e clique em “Entrar”. Caso tenha esquecido a senha, clique em “Esqueci a senha” e informe o CPF cadastrado. As instruções para recuperação da senha serão enviadas para o e-mail cadastrado. https://portaldeservicos.economia.gov.br/citsmart/login/login.load https://portaldeservicos.economia.gov.br/citsmart/login/login.load http://gestaopen.processoeletronico.gov.br/ P á g i n a | 10 Cadastrando unidades protocolizadoras São consideradas unidades protocolizadoras as unidades organizacionais ou administrativas que tenham, independentemente de sua denominação e posição hierárquica, as atividades de: a. recebimento, classificação, registro, distribuição, controle da tramitação e expedição de documentos, avulsos ou processos; b. autuação de documento(s) avulso(s) para formação de processo(s); e c. atribuição de NUP aos documentos, avulsos ou processos. As unidades administrativas encarregadas das atividades de protocolo são naturalmente unidades protocolizadoras. Além delas, o órgão ou entidade deve avaliar a necessidade de cadastrar mais unidades protocolizadoras. Havendo essa necessidade, devem ser cadastradas, preferencialmente: • unidades organizacionais superiores da estrutura regimental ou do estatuto do órgão ou entidade, visando a racionalização do consumo dos códigos, • unidade administrativa ou organizacional que utilizar anualmente mais de um milhão de Número Único de Protocolo – NUP, para registrar documentos, avulsos ou processos, produzidos ou recebidos, e • unidades administrativas ou organizacionais descentralizadas ou, ainda, regionais. Atenção: Todos os códigos de unidade protocolizadora do órgão ou entidade, ativos ou inativos, devem ser cadastrados no Sistema de Gestão de Unidades Protocolizadoras, com exceção daqueles nunca utilizados. Para isso, está disponível no Portal do Processo Eletrônico Nacional a relação das unidades protocolizadoras cadastradas até a data de entrada em vigor da Instrução Normativa Interministerial nº 13/2020. Cadastrando uma unidade protocolizadora ativa existente no SIORG Para cadastrar uma unidade protocolizadora ativa, efetue o login no sistema e na página inicial clique em “Protocolo”. Em seguida clique em “Gestão do NUP”. http://processoeletronico.gov.br/index.php/assuntos/numero-unico-de-protocolo?layout=edit&id=83 http://processoeletronico.gov.br/index.php/assuntos/numero-unico-de-protocolo?layout=edit&id=83 P á g i n a | 11 Na página de Gestão do NUP, clique em “Cadastrar” e selecione o órgão. Apenas as unidades do órgão cujo usuário é gestor serão visualizadas. Na página seguinte, no campo “Faz parte do Siorg?” escolha a opção “Sim” e seleciona a unidade protocolizadora na estrutura do órgão. Em seguida selecione o código de unidade protocolizadora e clique em “Salvar” para gravar as informações.Unidades protocolizadoras não existentes no SIORG Embora o artigo 17 da Instrução Normativa Interministerial nº 13, de 27 de fevereiro de 2020, vede o funcionamento como unidade protocolizadora de unidade administrativa ou organizacional que não esteja ativa no Sistema de Informações Organizacionais do Governo Federal – SIORG, durante os trabalhos identificamos algumas situações, sendo as mais comuns descritas abaixo: a) Em alguns órgãos e entidades as atividades de protocolo central, geral ou setorial não são realizadas por unidades administrativas formais, mas sim por unidades informais que são responsáveis pelas atividades de recebimento, classificação, registro, distribuição, controle da tramitação e expedição de documentos, avulsos ou processos; autuação de documento(s) avulso(s) para formação de processo(s); e atribuição de NUP aos documentos, avulsos ou processos. b) Em alguns casos o órgão ou entidade opta por distinguir a atividade de protocolo central da unidade administrativa ao qual está vinculada. Por exemplo: Protocolo Central do Ministério da Economia (unidade protocolizadora) e Serviço de P á g i n a | 12 Documentação (unidade administrativa formal, que possui as atribuições de protocolo central). Diante do exposto e considerando que a IN 13/2020 indica no art. 19 que os casos omissos serão resolvidos, em conjunto, pelo Arquivo Nacional e pela Secretaria de Gestão, caso seja necessário cadastrar unidade protocolizadora ativa que não esteja no SIORG, como nos casos “a” e “b” ou outros casos que apresente justificativa aceita, o órgão deve registrar chamado na Central de Atendimento do PEN, opção NUP, para que seja avaliado e incluído pelo Administrador do Sistema. Cadastrando uma unidade protocolizadora ativa não existente no SIORG Para cadastrar uma unidade protocolizadora ativa não existente no Siorg, efetue o login no sistema e na página inicial clique em “Protocolo”. Em seguida clique em “Gestão do NUP”. Na página de Gestão do NUP, clique em “Cadastrar” e selecione o órgão. Apenas as unidades do órgão cujo usuário é gestor serão visualizadas. Na página seguinte, no campo “Faz parte do Siorg?” escolha a opção “Não”. Em seguida, no campo “Unidade legada?” escolha a opção “Não” e selecione o tipo de unidade. Atenção: Ao cadastrar unidades protocolizadoras ativas que não estão no Siorg o usuário deve obrigatoriamente selecionar o tipo de unidade. Apenas três tipos de unidades não existentes no Siorg podem ser cadastradas como UP’s ativas: unidades de Protocolo2, sistema e-SIC ou sistema e-OUV. 2 Protocolo: unidade responsável pelas atividades de recebimento, classificação, registro, distribuição, controle da tramitação e expedição de documentos, avulsos ou processos; autuação de documento(s) avulso(s) para formação de processo(s); e atribuição de NUP aos documentos, avulsos ou processos. P á g i n a | 13 Em seguida informe a descrição da unidade e selecione o código da unidade protocolizadora. Para finalizar o cadastro, clique em “Salvar” para gravar as informações. Cadastrando uma unidade inativa (legada) Unidades legadas são aquelas que em algum momento já funcionaram como unidades protocolizadoras, porém não se encontram mais ativas[3] nas estruturas regimentais dos órgãos e, portanto, não estão mais no Siorg. O cadastramento dessas unidades é obrigatório para evitar que o código de UP outrora utilizado seja reaproveitado. Logo, uma unidade legada é automaticamente desativada no Sistema. Para cadastrar uma unidade protocolizadora legada inativa, efetue o login no sistema e na página inicial clique em “Protocolo”. Em seguida clique em “Gestão do NUP”. Na página de Gestão do NUP, clique em “Cadastrar” e selecione o órgão. Apenas as unidades do órgão cujo usuário é gestor poderão ser visualizadas. Na página seguinte, no campo “Unidade Legada?” clique em “Sim”. Em seguida informe a descrição da unidade e selecione o código de unidade protocolizadora que P á g i n a | 14 era utilizado pela unidade. Para finalizar o cadastro, clique em “Salvar” para gravar as informações. Atenção: O órgão ou entidade que porventura tenha deixado de comunicar ao Ministério da Economia a utilização de algum código de UP, ainda que pertencente à sua faixa numérica, deverá consultar suas bases de dados para realizar o levantamento das unidades protocolizadoras legadas, evitando assim a reutilização indevida de códigos. Inativando uma unidade protocolizadora Para inativar uma unidade protocolizadora, efetue o login no sistema e na página inicial clique em “Protocolo”. Em seguida clique em “Gestão do NUP”. Na página de Gestão do NUP, localize a unidade que deseja inativar e em seguida clique em “Inativar”. Para finalizar, confirme a ação para gravar as informações no sistema. Gerenciando unidades protocolizadoras Após cadastrada uma unidade protocolizadora, será possível apenas a sua edição ou inativação. P á g i n a | 15 Editando uma unidade protocolizadora Ao editar uma unidade protocolizadora é possível atribuir a ela outro código de unidade protocolizadora ou selecionar outra UP para utilizar o código cadastrado. A edição somente deve ser utilizada para corrigir falha de cadastro (do código ou da unidade), tendo em vista que é vedado o reaproveitamento do código de UP. Para editar uma unidade protocolizadora, na página inicial clique em “Protocolo” e em seguida clique em “Gestão do NUP[CS4]”. Em seguida localize a unidade desejada e clique em “Editar”. Na tela de edição, para corrigir o nome da unidade protocolizadora, basta selecionar a unidade correta na hierarquia e manter o código. Caso se deseje corrigir o código da unidade protocolizadora cadastrada, basta selecionar o novo código dentre os disponibilizados pelo sistema. Ao final de ambos os procedimentos, é necessário clicar em “Salvar” para gravar as alterações. Inativando uma unidade protocolizadora Para inativar uma unidade protocolizadora, na página inicial clique em “Protocolo” e em seguida clique em “Gestão do NUP”. Em seguida localize a unidade desejada e clique em “Inativar”. P á g i n a | 16 Atenção: O código de uma unidade protocolizadora inativada não é redisponibilizado pelo sistema. Casos especiais Os gestores de protocolo deverão se atentar para os procedimentos a serem adotados nos casos especiais abaixo elencados: Ocorrência Ação a ser adotada ➢ Fusão de duas ou mais unidades protocolizadoras Adotar o código de UP de uma das unidades fundidas e inativar os demais ➢ Desmembramento de uma unidade protocolizadora Atribuir o código de UP da unidade desmembrada para uma das unidades resultantes do desmembramento e criar código para a outra ➢ Alteração da denominação, vinculação ou subordinação Manter o mesmo código de UP ➢ Extinção, suspensão ou conclusão das atribuições Inativar a unidade protocolizadora ➢ Retorno das atribuições de unidade protocolizadora inativada Reativar a unidade protocolizadora Atenção: É vedada a exclusão e o reaproveitamento do código de unidade protocolizadora extinta. Legislação Disponível em http://processoeletronico.gov.br/index.php/assuntos/legislacao INSTRUÇÃO NORMATIVA Nº 32, DE 20 DE ABRIL DE 2020 • Altera o prazo para atualização de informações disposto no art. 20 da Instrução Normativa nº 13, de 27 de fevereiro de 2019. INSTRUÇÃO NORMATIVA Nº 13, DE 27 DE FEVEREIRO DE 2020 • Dispõe sobre as regras e procedimentos para a atribuição de código e para o cadastramento das unidades protocolizadoras no âmbito dos órgãos e entidades da Administração Pública federal direta, autárquica e fundacional. PORTARIA INTERMINISTERIAL Nº 11, DE 25 DE NOVEMBRO DE 2019 • Dispõe sobre os procedimentos relativos à utilização do Número Único de Protocolo -NUP no âmbito dos órgãos e entidades da Administração Pública federal direta, autárquica e fundacional. http://processoeletronico.gov.br/index.php/assuntos/legislacao P á g i n a | 17 PORTARIA INTERMINISTERIAL Nº 3, DE 29 DE DEZEMBRO DE 2017 (Revogada) • Altera a data de início da vigência da Portaria Interministerial nº 2.321, de 30 de dezembro de 2014, que define os procedimentos relativos à utilização do Número Único de Protocolo - NUP no âmbito dos órgãos e entidades da Administração Pública Federal e dá outras providências. PORTARIA INTERMINISTERIAL N° 705, DE 22 DE JUNHO DE 2015 (Revogada) • Altera a vigência e o Anexo da Portaria Interministerial nº 2.321, de 30 de dezembro de 2014, que define os procedimentos relativos à utilização do Número Único de Protocolo - NUP no âmbito dos órgãos e entidades da Administração Pública Federal e dá outras providências. PORTARIA Nº 2.321, DE 30 DE DEZEMBRO DE 2014 (Revogada) • Define os procedimentos relativos à utilização do Número Único de Protocolo - NUP no âmbito dos órgãos e entidades da Administração Pública Federal e dá outras providências. PORTARIA Nº 3, DE 16 DE MAIO DE 2003 (Revogada) • Orienta os órgãos da Presidência da República, Ministérios, autarquias e fundações integrantes do Sistema de Serviços Gerais - SISG, quanto aos procedimentos relativos às atividades de Comunicações Administrativas, para utilização do número único de processos e documentos. 1 Sistema Protocolo Integrado Manual de Integração ao Web Service Manual com a descrição do Web Service de recebimento das informações de processos e documentos dos órgãos e entidades. Sistema Protocolo Integrado Manual de Integração ao Web Service Manual com a descrição do Web Service de recebimento das informações de processos e documentos dos órgãos e entidades. Versão 1.0 – Vigência a partir de 01/01/2015 2015 2 Presidenta da República Dilma Rousseff Ministério do Planejamento, Orçamento e Gestão – MP Nelson Barbosa Ministério da Justiça - MJ José Eduardo Cardozo Secretaria de Logística e Tecnologia da Informação – SLTI Loreni F. Foresti Arquivo Nacional – AN/MJ Jaime Antunes da Silva Departamento de Logística – DELOG/SLTI/MP Ana Maria Vieira Neto 3 Sumário INTRODUÇÃO ............................................................................................................ 4 CAPÍTULO I – DESCRIÇÃO DO WEB SERVICE ...................................................... 5 1.1 UNIFORM RESOURCE LOCATOR (URL) PARA ACESSO AOS SERVIÇOS ........................................................... 5 1.2 MÉTODOS PRESENTES NO WEB SERVICE ..................................................................................................... 5 1.3 CLASSES DE FRONTEIRA DO WEB SERVICE ................................................................................................... 7 1.4 ERROS DE NEGÓCIO RETORNADOS PELO WEB SERVICE ............................................................................ 10 1.5 ERROS DE SISTEMA RETORNADOS PELO WEB SERVICE.............................................................................. 12 CAPÍTULO || - UTILIZAÇÃO DO WEB SERVICE .................................................... 13 2.1 AUTENTICAÇÃO......................................................................................................................................... 13 2.2 INSTALAÇÃO DO CERTIFICADO ................................................................................................................... 13 4 INTRODUÇÃO O Sistema Protocolo Integrado consolida uma base de dados com informações sobre processos e documentos oriundas dos diversos sistemas de protocolo dos órgãos e entidades da Administração Pública Federal. Oferece à sociedade mais um canal de consultas dessas informações, além de serviços como envio de informes sobre andamento de documentos, avulsos ou processos, via correio eletrônico (e-mail). A iniciativa permite que o Governo Federal promova a melhoria da prestação de informações e serviços à sociedade, principalmente em um momento onde a Lei de Acesso à Informação (Lei n° 12.527, de 18 de novembro de 2011) tem grande visibilidade e a celeridade na identificação e no resgate de dados é crucial para sua efetividade. Além disso, o projeto está em conformidade com a simplificação do atendimento ao cidadão prevista no Decreto Cidadão (Decreto n° 6.932, de 11 de agosto de 2009). Este documento apresenta um manual técnico de integração ao Sistema Protocolo Integrado. As informações contidas nesse material visam auxiliar na utilização do Web Service do Sistema Protocolo Integrado para que seja mais rápida a integração. ANA MARIA VIEIRA NETO Diretora 5 CAPÍTULO I – DESCRIÇÃO DO WEB SERVICE 1.1 UNIFORM RESOURCE LOCATOR (URL) PARA ACESSO AOS SERVIÇOS O envio das informações sobre os documentos, avulsos ou processos, serão testadas no ambiente de homologação. Após validado o envio nesse ambiente, será autorizado o envio para o ambiente de produção. Para acesso aos serviços, utilizar as URLs exibidas na Tabela 1, as quais trazem os arquivos Web Service Descriptrion Language (WSDL). Ambiente URL Pré-Produção http://protocolointegradows.pre.producao.economia.gov.br/ProtocoloWS/i ntegradorService?wsdl Produção https://protocolointegrado.gov.br/ProtocoloWS/integradorService? wsdl Tabela 1: URL dos Web Services O documento WSDL provê informações importantes tanto para desenvolvedores quanto para ferramentas de geração de código. Nesse documento estão descritos: • Métodos disponíveis no Web Service, seus parâmetros de entrada e a saída; • Formato das mensagens que são aceitas pelo Web Service; • Falhas que podem ser lançadas pelo Web Service; • Outras informações. 1.2 MÉTODOS PRESENTES NO WEB SERVICE O serviço de envio de informações ao Sistema Protocolo Integrado possui três métodos, listados na tabela abaixo: Método Classe de Entrada Classe de Saída Falhas enviarDocumento Documento String NegocioFault, SistemaFault enviarListaDocumentos ListaDocumentos Lista de ResultadoDocumento NegocioFault, SistemaFault getQuantidadeMaximaDocume N/A Inteiro NegocioFault, 6 ntosPorRequisicao SistemaFault Tabela 2: Métodos disponíveis no Web Service O método EnviarDocumento submete informações sobre um documento, avulso ou processo, para serem processadas e armazenadas pelo Web Service. Esse método possui 3 fluxos possíveis: 1. Caso alguma informação do documento, avulso ou processo, não seja válida ou o órgão ou entidade não envie credenciais corretas para integração, uma falha de negócio (NegocioFault) será lançada. 2. Caso algum erro de processamento ocorra, como uma falha de comunicação com o banco de dados, uma falha de sistema (SistemaFault) será lançada. 3. Caso contrário, a String “Ok!” será retornada Recomenda-se a utilização desse método para o envio pontual de informações, ou seja, em tempo real. Para envio de informações em lotes, recomenda-se a utilização do método enviarListaDocumentos. O método EnviarListaDocumentos submete uma lista contendo informações sobre um ou mais documentos, avulsos ou processos, para serem processadas e armazenadas pelo Web Service. Esse método possui 3 fluxos possíveis. 1. Caso a lista de documentos, avulsos ou processos, possua mais documentos do que o permitido, esteja vazia ou o órgão/entidade envie credenciais incorretas, uma falha de negócio (NegocioFault) será lançada. 2. Caso algum erro de processamento ocorra, como uma falha de comunicação com o banco de dados, uma falha de sistema (SistemaFault) será lançada. 3. Caso contrário, uma lista de ResultadoDocumento será retornada, contendo o resultado do processamento decada um dos documentos, avulsos ou processos. É importante ressaltar que falhas de validação em informações sobre algum documento, avulso ou processo, da lista não causa a interrupção do processamento das informações sobre os outros documentos, avulsos ou processos. Ou seja, uma falha não será lançada nesse caso. O ResultadoDocumento referente àquele que falhou virá preenchido com o código da falha e sua mensagem descritiva. 7 O método GetQuantidadeMaximaDocumentosPorRequisicao retorna a quantidade máxima de documentos, avulsos ou processos, aceita em uma ListaDocumentos pelo método EnviarListaDocumentos. Recomenda-se a utilização desse método antes da chamada ao método EnviarListaDocumentos. Esse método possui 2 fluxos possíveis: 1. Caso o órgão envie credenciais incorretas, uma falha de negócio (NegocioFault) será lançada. 2. Caso contrário, um inteiro, que representa a quantidade máxima de documentos será retornado. 1.3 CLASSES DE FRONTEIRA DO WEB SERVICE Documento Esta classe é baseada no Padrão de Dados definido para o Sistema Protocolo Integrado e representa um documento, avulso ou processo. ? ? ? ? ? ? ? ? ? 8 ? ? ? A tabela a seguir relaciona cada um dos campos da classe Documento com o campo correspondente no padrão de dados. Campo na classe Campo no Padrão de Dados Protocolo Protocolo DataHoraProducao Data e Hora de Produção ListaProtocoloAnteriores Protocolos Anteriores ProtocoloAnterior - Especie Espécie IdentificacaoDocumento Identificação do Documento Assunto Assunto ListaProtocolosRelacionados Protocolos Relacionados ProtocoloRelacionado - Interessado Interessado NomeInteressado Nome do Interessado IdentificacaoInteressado Identificação do Interessado Historico Histórico ItemHistórico - DataHoraOperacao Data e Hora da Operação UnidadeOperacao Unidade da Operação Operacao Operação Tabela 3: Mapeamento dos campos do xml do Documento e dos campos correspondentes no padrão de dados ListaDocumentos Essa classe representa uma lista de Documentos. Cada documento desta lista é uma instância da classe Documento. 9 ... ... ... ... ResultadoDocumento Essa classe representa o resultado do processamento de um documento, avulso ou processo. O campo pode vir preenchido com uma string representado sucesso: “Ok!” ou uma string com um código e a descrição da falha encontrada. NegocioFault Classe de falha que representa uma falha de negócio. Pode ser originada, por exemplo, por um documento, avulso ou processo, fora do Padrão de Dados definido, pela utilização de credenciais inválidas e etc. Essa classe é encapsulada dentro de uma . SistemaFault Classe de falha que representa uma falha de sistema. Pode ser originada, por exemplo, por uma falha de comunicação com o banco de dados do Sistema Protocolo Integrado. 10 Essa classe é encapsulada dentro de uma . 1.4 ERROS DE NEGÓCIO RETORNADOS PELO WEB SERVICE Na tabela abaixo estão descritas as falhas de negócio lançadas pelos métodos do Web Service. Código da Falha Descrição NF0000 O documento recebido está mal formatado. NF0001 O campo Número de Protocolo é de preenchimento obrigatório. NF0002 O campo Número de Protocolo deve ter 13, 14, 15, 17 ou 21 caracteres. NF0006 Cada Protocolo Anterior deve ter no máximo 40 caracteres alfanuméricos. NF0008 O campo Espécie é de preenchimento obrigatório. NF0009 O campo Espécie deve ter no máximo 50 caracteres. NF0010 O campo Identificação do Documento deve ter no máximo 250 caracteres. NF0011 O campo Assunto é de preenchimento obrigatório. NF0012 O campo Assunto deve ter no máximo 1.500 caracteres. NF0013 Cada Protocolo Relacionado deve ter entre 6 e 21 caracteres alfanuméricos. NF0014 Cada Protocolo Relacionado deve ter apenas caracteres alfanuméricos. NF0020 O campo Data e Hora de Produção deve ser uma data válida e seguir o padrão ISO 8601. NF0023 Cada Protocolo Anterior deve ter apenas caracteres alfanuméricos. 11 NF0026 O campo Número de Protocolo deve ter apenas caracteres alfanuméricos. NF0027 O campo Nome do Interessado é de preenchimento obrigatório. NF0028 O campo Nome do Interessado deve ter no máximo 150 caracteres alfanuméricos. NF0033 O campo Número de Identificação do Interessado deve ter entre 5 e 20 caracteres alfanuméricos. NF0034 O campo Data e Hora de todos os Itens do Histórico deve conter datas válidas e de acordo com o padrão ISO 8601. NF0038 O campo UnidadeOperacao de todos os Itens do Histórico é de preenchimento obrigatório. NF0039 O campo UnidadeOperacao de todo os Itens do Histórico deve ter no máximo 300 caracteres. NF0040 O campo Operação de todos os Itens do Histórico é de preenchimento obrigatório. NF0041 O campo Operação de todos os Itens do Histórico deve ter no máximo 4000 caracteres. NF0044 O campo Data e Hora de Produção é de preenchimento obrigatório. NF0046 O campo Data e Hora de todos os Itens do Histórico é de preenchimento obrigatório. NF0057 Credenciais não informadas no cabeçalho da requisição. NF0059 O campo Número de Identificação do Interessado deve ser preenchido apenas com caracteres alfanuméricos. NF0061 Código SIORG e/ou senha inválidos para uso do serviço. NF0062 Código SIORG e/ou senha inválidos para uso do serviço: órgão extinto. NF0063 O campo Lista de Documentos é de preenchimento obrigatório. NF0064 O campo Lista de Documentos excedeu o limite de documentos permitidos para carga. 12 Tabela 4: Falhas de negócio lançadas pelos métodos do Web Service 1.5 ERROS DE SISTEMA RETORNADOS PELO WEB SERVICE Na tabela abaixo estão descritas as falhas de sistema lançadas pelos métodos do Web Service. Código da Falha Descrição SF0000 Falha de sistema. SF0001 Sistema indisponível. SF0002 Falha de conexão ao banco de dados. Tabela 5: Falhas de Sistema lançadas pelos métodos do Web Service 13 CAPÍTULO || - UTILIZAÇÃO DO WEB SERVICE Essa seção detalha as informações pertinentes para a utilização do Web Service, tratando de pontos técnicos relevantes para o desenvolvimento de uma aplicação cliente. 2.1 AUTENTICAÇÃO A utilização do Web Service requer a autenticação de usuário (codigo siorg) e senha. Essa autenticação é feita por meio do cabeçalho “Authorization” definido pelo protocolo HTTP/1.1, utilizando um esquema de autenticação básico (http://www.ietf.org/rfc/rfc2617.txt. Seção 2). A construção desse cabeçalho é feita através da codificação Base64: 1. Constrói-se uma string a partir da concatenação do código siorg, com o caracter “:” e a senha. 2. Codifica-se essa string utilizando a base64. 3. Concatena-se a string “Basic “ com a string resultante do passo anterior.4. Adiciona-se a string resultante ao cabeçalho Authorization da requisição. Exemplo (Java) O código abaixo é uma possível implementação do algoritmo descrito acima: private static SOAPMessage adicionarCredenciais(SOAPMessage msg) { MimeHeaders hd = msg.getMimeHeaders(); String usuario = “000000”; String senha = “senha”; String auth = new String(Base64.encodeBase64((usuario+":"+senha).getBytes())); hd.addHeader("Authorization", "Basic "+auth); return msg; } 2.2 INSTALAÇÃO DO CERTIFICADO 14 Para garantir a segurança da comunicação com o Webservice, esta deve ser feita através do protocolo HTTPS (uma implementação segura do HTTP), que utiliza o protocolo SSL/TLS. Para que essa comunicação seja feita, é necessário instalar o Certificado do Protocolo Integrado no ambiente que irá fazer as requisições ao webservice. O processo de instalação do certificado depende da tecnologia a ser utilizada. A seguir, segue um exemplo de instalação em ambientes Java. Exemplo (Java) Para instalar o certificado, é necessário importar o certificado para um arquivo Keystore do Java que contém os certificados confiáveis (trust store). Para instalar o certificado em uma trust store, é necessário executar o seguinte comando: keytool -import -trustcacerts -alias protocolo -file certificado-protocolo.cer -keypass PASSWORD -keystore CAMINHO Onde: 1. keytool – ferramenta de administração de chaves e certificados. Localizado em: $JAVA_HOME\bin 2. CAMINHO - localização da trust store do java, por ex.: "C:\Program Files (x86)\Java\jdk1.6.0_45\jre\lib\security\cacerts" 3. certificado-protocolo.cer - certificado do Protocolo Integrado, enviado anexo a este manual. 4. PASSWORD – senha para adicionar certificados. Caso ninguém tenha alterado, a senha padrão é changeit. A lista abaixo contém as localizações normalmente utilizadas pelo Java para armazenar a trust store padrão: 1. $JAVA_HOME/lib/security/jssecacerts 2. $JAVA_HOME/lib/security/cacerts Dependendo das configurações de instalação é possível que o Java utilize outra trust store como padrão. Caso ocorram problemas de comunicação com o webservice, utilizar o parâmetro -Djavax.net.debug=all para analisar o log de 15 comunicação. Com este parâmetro, será impressa a localização da trust store que esta sendo utilizada. 1 Sistema Protocolo Integrado Manual do Cliente Web Service Manual com a descrição do Cliente Web Service do Sistema Protocolo Integrado. Sistema Protocolo Integrado Manual do Cliente Web Service Manual com a descrição do Cliente Web Service do Sistema Protocolo Integrado. 2015 Versão 1.0 –Vigência a partir de 01/01/2015 Presidenta da República Dilma Rousseff Ministério do Planejamento, Orçamento e Gestão – MP Nelson Barbosa Ministério da Justiça - MJ José Eduardo Cardozo Secretaria de Logística e Tecnologia da Informação – SLTI Loreni F. Foresti Arquivo Nacional – AN/MJ Jaime Antunes da Silva Departamento de Logística – DELOG/SLTI/MP Ana Maria Vieira Neto 2 Sumário INTRODUÇÃO..............................................................................................................4 CAPÍTULO I – O CLIENTE WEB SERVICE................................................................5 1.1 INTRODUÇÃO........................................................................................................................................... 5 1.2 INSTALAÇÃO DO CERTIFICADO DIGITAL.....................................................................................................5 1.2 ARQUIVO DE CONFIGURAÇÃO DO CLIENTE...............................................................................................6 1.3 UTILIZAÇÃO DO CLIENTE........................................................................................................................... 7 1.4 ARQUIVO DE ENTRADA............................................................................................................................ 7 CAPÍTULO II – SOLUÇÃO DE PROBLEMAS.............................................................9 3 INTRODUÇÃO O Sistema Protocolo Integrado consolida uma base de dados com informações sobre processos e documentos oriundas dos diversos sistemas de protocolo dos órgãos e entidades da Administração Pública Federal. Oferece à sociedade mais um canal de consultas dessas informações, além de serviços como envio de informes sobre andamento de documentos, avulsos ou processos, via correio eletrônico (e-mail). A iniciativa permite que o Governo Federal promova a melhoria da prestação de informações e serviços à sociedade, principalmente em um momento onde a Lei de Acesso à Informação (Lei n° 12.527, de 18 de novembro de 2011) tem grande visibilidade e a celeridade na identificação e no resgate de dados é crucial para sua efetividade. Além disso, o projeto está em conformidade com a simplificação do atendimento ao cidadão prevista no Decreto Cidadão (Decreto n° 6.932, de 11 de agosto de 2009). Este documento apresenta o manual técnico de uso do Cliente Web Service do Sistema Protocolo Integrado. Dadas as informações extraídas no formato esperado pelo Sistema Protocolo Integrado, a ferramenta realiza o envio das informações via Web Service e pode ser reutilizada pelos órgãos e entidades para que haja maior economicidade na implementação da integração ao referido sistema. ANA MARIA VIEIRA NETO Diretora 4 CAPÍTULO I – O CLIENTE WEB SERVICE 1.1 INTRODUÇÃO Este documento apresenta um manual de utilização do cliente Web Service do Sistema Protocolo Integrado. A tabela 1 contém as URLs dos ambientes do Web Service do Sistema Protocolo Integrado. Ambiente URL Homologação https\://homologa.protocolointegrado.gov.br/ProtocoloWS/integrad orService?wsdl Produção https\://protocolointegrado.gov.br/ProtocoloWS/integradorService ?wsdl Tabela 1: URL dos WebServices Obs.: O caracter “\” antes do “:” nas URLs deve estar presente no arquivo de configuração do cliente, para que haja a leitura correta da URL de conexão pelo sistema operacional. O cliente utiliza o método getQuantidadeMaximaDocumentosPorRequisicao para obter o tamanho máximo do lote de documentos que o Web Service aceita. Depois disso, irá fazer quantas requisições forem necessárias ao método enviarListaDocumentos para enviar as informações de todos os documentos, em lotes contendo a quantidade máxima de documentos aceita, existentes no arquivo de entrada. Essas chamadas ao método enviarListaDocumentos são feitas em paralelo. Ao final do processamento, um arquivo de log é gerado, contendo os resultados do processamento das informações de cada um dos documentos. Caso algum documento seja rejeitado pelo Web Service, um arquivo contendo esses documentos é gerado para análise, correção e reenvio. 1.2 INSTALAÇÃO DO CERTIFICADO DIGITAL A comunicação com o Web Service é feita através do protocolo HTTPS e por isso, é necessário instalar o certificado do Protocolo Integrado. Para instalar o certificado, é necessário importar o certificado para um arquivo Keystore do Java que contém os certificados confiáveis (trust store). 5 Para instalar o certificado em uma trust store, é necessário executar o seguinte comando: keytool -import -trustcacerts -alias protocolo -file certificado-protocolo.cer -keypass PASSWORD -keystore CAMINHO Onde: 1. keytool – ferramenta de administração de chaves e certificados. Localizado em: $JAVA_HOME\bin 2. CAMINHO - localização da trust store do java, por ex.: "C:\Program Files (x86)\Java\jdk1.6.0_45\jre\lib\security\cacerts" 3. certificado-protocolo.cer - certificado do Protocolo Integrado. A versão para o ambiente de homologação encontra-se em: http://comprasgovernamentais.gov.br/arquivos/certificado_homologacao.cer. A versão para ambiente de produção encontra-seem: http://comprasgovernamentais.gov.br/arquivos/certificado_producao.cer. 4. PASSWORD – senha para adicionar certificados. Caso ninguém tenha alterado, a senha padrão é changeit. A lista abaixo contém as localizações normalmente utilizadas pelo Java para armazenar a trust store padrão: 1. $JAVA_HOME/lib/security/jssecacerts 2. $JAVA_HOME/lib/security/cacerts Dependendo das configurações de instalação é possível que o Java utilize outra trust store como padrão. Para maiores detalhes, verifique 1.2 ARQUIVO DE CONFIGURAÇÃO DO CLIENTE Para configurar o cliente, basta editar o arquivo config.properties, que fica no mesmo diretório do pacote .jar da aplicação cliente. Configuração Descrição wsdl Localização do arquivo de descrição(wsdl) do webservice a ser chamado pelo cliente. Ver Tabela 1. codsiorg Código siorg do órgão que deseja enviar as informações para o Protocolo Integrado. 6 http://comprasgovernamentais.gov.br/arquivos/certificado_homologacao.cer http://comprasgovernamentais.gov.br/arquivos/certificado_producao.cer senha Senha de integração do órgão que deseja enviar as informações para o Protocolo Integrado. numero-tentativas Quantidade de tentativas de reenvio que será feita em caso de falha de conexão. segundos-entre- tentativas Intervalo, em segundos, aguardado antes da realização de uma nova tentativa de envio em caso de erro. O Valor mínimo para este parâmetro é de 10 segundos. O sistema utilizará este valor caso um valor inferior seja informado. Tabela 2: Configurações do Cliente 1.3 UTILIZAÇÃO DO CLIENTE Os seguintes passos são necessários para executar o cliente: 1. Iniciar o terminal de comando; 2. Navegar até o diretório onde esta localizado o cliente.jar; 3. Executar o seguinte comando: java -jar cliente.jar arquivo.xml. Onde “arquivo.xml” é o arquivo que contém os documentos a serem enviados para o Web Service. Para informações sobre o arquivo.xml, consultar a seção 1.4 ARQUIVO DE ENTRADA Após a execução, o arquivo “arquivo.log” possuirá um relatório sobre a execução. Os documentos que porventura tiverem sido rejeitados pelo webservice estarão em “arquivo-rejeitados.xml”. 1.4 ARQUIVO DE ENTRADA O arquivo .xml deve conter uma lista de documentos na forma: ... ... ... ... 7 O conteúdo dentro das tags deve estar em conformidade com o padrão de dados do Sistema Protocolo Integrado. A lista pode conter quantos documentos forem desejados, porém pode ser necessário aumentar a oferta de memória para o Java de forma que o cliente consiga ler todo o arquivo (ver Problema 2, na seção CAPÍTULO II – SOLUÇÃO DE PROBLEMAS). O arquivo deve estar codificado em UTF-8 para que não ocorram problemas de codificação de caracteres. 8 CAPÍTULO II – SOLUÇÃO DE PROBLEMAS Problema 1: Ao utilizar o cliente, a seguinte mensagem é exibida no terminal: com.sun.xml.internal.messaging.saaj.client.p2p.HttpSOAPConnection post Grave: SAAJ0009: Message send failed Solução: Esse problema esta relacionado com a instalação do certificado em uma trust store diferente da que o java está utilizando por padrão. Existem duas formas de solucionar: 1. Indicar, na hora de executar o cliente, a localização da trust store que deseja utilizar: java -jar -Djavax.net.ssl.trustStore=CAMINHO cliente.jar arquivo.xml Onde, CAMINHO, é a localização da trust store em que o certificado foi instalado. 2. Outra solução, é verificar qual trust store esta sendo utilizada pelo sistema e então, instalar o certificado nesta. Uma das formas de verificar a localização da trust store é executar o cliente com o seguinte argumento -Djavax.net.debug=all e direcionar a saida da execução para um arquivo de texto. Ou seja, executar o seguinte comando: java -jar -Djavax.net.debug=all cliente.jar teste.xml > saida.txt Ao inspecionar o arquivo saida.txt, procurar pela linha que começa com “trustStore is: “. Nesta linha esta a localização da trust store que esta sendo utilizada pelo sistema. Deve-se então, repetir a instalação do certificado nesta trust store. Problema 2: Ao executar o cliente é exibido um erro de memória Heap insuficiente. Solução: Existem duas soluções possíveis: 1. Aumentar a memória Heap disponível para a JVM por meio do parâmetro -Xmx. Por exemplo, executar o cliente da seguinte forma: java -jar -Xmx1024m cliente.jar arquivo.xml O valor 1024m indica que serão disponibilizados até 1GB de memória para a Heap da JVM. 9 2. Reduzir o tamanho do arquivo a ser carregado pelo cliente até que o mesmo possa ser carregado no cliente. 10