~~ODT~~
Última atualização: 2017/04/03 18:22 (edição externa)
Cadastrar Documento
Um documento reúne informações que podem tramitar por várias unidades ao longo do seu desenvolvimento. Cada unidade envolvida tem a possibilidade de incrementar informações no documento em forma de Despacho Eletrônico de Documento.
Esse caso de uso tem a finalidade de realizar o cadastro de um documento.
É utilizado por servidores habilitados a realizar o cadastro de documentos protocolados nas unidades.
Pré-condições:
O sistema deverá apresentar o parâmetro NUMERO_RADICAL_PADRAO_PROTOCOLO definido ou a unidade do usuário deverá ser ou apresentar uma unidade responsável protocolizadora, ou seja, uma unidade que apresente um radical associado. Caso estas condições não sejam observadas, o usuário será encaminhado para uma página de erro de negocio onde será lhe informada esta condição.
Descrição do Caso de Uso
Esse caso de uso se inicia quando o usuário acessa o caminho: SIPAC → Protocolo → Documentos → Cadastro → Cadastrar Documento.
Passo 1
O caso de uso começa com o usuário acessando o sistema e preenchendo os Dados do Documento:
Origem do Documento*: Nesse campo será informada a procedência do documento, interna ou externa. Formato - ORIGEM DO DOCUMENTO, Tipo - TEXTO.
Documento Interno: Tipo - TEXTO.
Documento Externo: Tipo - TEXTO. Caso esta opção seja escolhida, surgem os novos campos:
Tipo do Documento*: Formato - NOME DO TIPO DO DOCUMENTO, Tipo - AUTOCOMPLETE.
Documento (Identificador/Ano): Formato - IDENTIFICADOR/AAAA. Tipo - TEXTO e NUMÉRICO.
Assunto do Documento (CONARQ): Formato - 999.999 <CÓDIGO DA CLASSIFICAÇÃO CONARQ> - NOME COMPLETO DA CLASSIFICAÇÃO CONARQ , Tipo - AUTOCOMPLETE.
Assunto Detalhado: Tipo - TEXTO.
Data do Documento*: Formato - DD/MM/AAAA, Tipo - DATA.
Suporte*: Formato - Físico/Digital, Tipo - TEXTO. (
RN05 )
Natureza do Documento*: Formato - Ostensivo/Sigiloso, Tipo - TEXTO.
Grau de Sigilo*: Tipo - TEXTO. (
RN06 )(
RN07 )
Observação: Tipo - TEXTO.
Informações exclusivas para “Documentos Externos”:
Tipo da Pessoa*: Formato - FÍSICA/JURÍDICA, Tipo - Caractere. (
RN09 )
Órgão de Origem*: Formato - NOME DO ÓRGÃO EXTERNO (UF - ESFERA ADMINISTRATIVA), Tipo - AUTOCOMPLETE. Aparece apenas quando a opção Documento Externo esteja selecionada.
Data de Autuação Original*: Formato - DD/MM/AAAA, Tipo - DATA. Aparece apenas quando a opção Documento Externo esteja selecionada.
Para cada documento, é possível adicionar uma lista de assinantes que irão garantir a autenticidade do documento escrito ou anexado. São exibidas as opções de Adicionar Assinante, onde é possível escolher servidores da unidade do usuário, e Adicionar Assinantes de Outra Unidade, onde poderão ser adicionados servidores de outras unidades. Após adicionar os assinantes, é exibida uma listagem com os dados:
Assinante: Tipo - TEXTO.
Unidade: Tipo - TEXTO.
Situação: Tipo - TEXTO.
É possível remover os assinantes da listagem.
Passo 2
Passo 3
Continuando o cadastro, o usuário deve informar os interessados deste documento. Os interessados podem ser de 5 categorias:
Servidor: Servidores da instituição, onde serão identificados pela matrícula SIAPE (Sem o dígito verificador). Tipo - LÓGICO.
Nome servidor: Formato - NOME DO SERVIDOR | MATRICULA SIAPE, Tipo - AUTOCOMPLETE
Notificar Interessado: Tipo - LÓGICO.
Aluno*: Alunos que serão identificados pela matricula. Tipo - LÓGICO.
Aluno: Formato - NOME DO ALUNO | MATRICULA, Tipo - AUTOCOMPLETE
Notificar Interessado: Tipo - LÓGICO.
Credor: Pessoas físicas ou Jurídicas que são interessados em documentos de compra, pagamento, por exemplo. Tipo - LÓGICO.
Credor*: Pessoas físicas ou Jurídicas. Formato - NOME DO CREDOR, Tipo - AUTOCOMPLETE.
Notificar Interessado: Tipo - LÓGICO.
Unidade: Uma unidade da instituição. Tipo - LÓGICO.
Unidade*: Formato: CÓDIGO DA UNIDADE | NOME DA UNIDADE | ÁRVORE DE UNIDADES, Tipo - NUMÉRICO, AUTOCOMPLETE e TEXTO.
Notificar Interessado: Tipo - LÓGICO.
Outros: Público Externo, órgãos internacionais ou qualquer outro interessado que não se adeque aos citados acima. Tipo - LÓGICO.
CPF/CNPJ: Formato - 999.999.999-99 | 99.999.999/9999-99, Tipo - NUMÉRICO
Nome do Interessado*: Formato - NOME DO INTERESSADO, Tipo - TEXTO.
Notificar Interessado: Tipo - LÓGICO.
Abaixo, é exibida a lista dos Interessados Inseridos no Documento com os dados de acordo com a categoria informada:
Identificador: Formato: IDENTIFICADOR DO INTERESSADO, Tipo - NUMÉRICO.
Nome: Formato: NOME DO INTERESSADO, Tipo - TEXTO.
E-Mail: Tipo - TEXTO.
Tipo: Formato: NOME DO TIPO, Tipo - TEXTO.
Para cada interessados temos a opção de Excluir Interessado a qual remove o interessado da lista de interessados.
Serão enviados email aos interessados caso o documento sofra alguma movimentação (Envio, Recebimento, Arquivamento, Cancelamento, Ativação ou em Diligência):
Passo 4
Nesse passo o usuário deverá informar os dados da movimentação inicial do documento, podendo, também, informar um despacho para tal:
Passo 5
No seguinte passo serão apresentados os Dados Gerais do Documento para serem conferidos antes da confirmação do cadastro ( RN08 ). As informações exibidas são:
Origem do Documento: Formato: INTERNO | EXTERNO, Tipo - TEXTO.
Protocolo de Registro Original: Tipo - TEXTO.
Órgão de Origem: Formato - NOME DO ÓRGÃO ( UF - ESFERA ADMINISTRATIVA ), Tipo - TEXTO. Para Documentos externos.
Data de Autuação Original: Formato - DD/MM/AAAA, Tipo - DATA. Para Documentos externos.
Identificador: Tipo - TEXTO.
Ano: Formato - AAAA. Tipo - NUMÉRICO.
Tipo do Documento: Formato - DENOMINAÇÃO DO TIPO DO DOCUMENTO, Tipo - TEXTO.
Assunto do Documento (CONARQ): Formato - 999.999 - DENOMINAÇÃO ASSUNTO DO DOCUMENTO, Tipo - TEXTO.
Assunto Detalhado: Tipo - TEXTO.
Unidade Origem: Formato - SIGLA UNIDADE ORIGEM (CÓDIGO DA UNIDADE), Tipo - TEXTO.
Data do Documento: Formato - DD/MM/AAAA, Tipo - DATA.
Observação: Tipo - TEXTO.
Arquivos Anexados ao Documento:
Interessados Inseridos ao Documento:
Dados da Movimentação, com os dados:
Para documentos internos:
Unidade de Origem: Formato - NOME DA UNIDADE(CÓDIGO DA UNIDADE), Tipo - TEXTO e NUMÉRICO.
Unidade de Destino: Formato - NOME DA UNIDADE(CÓDIGO DA UNIDADE), Tipo - TEXTO e NUMÉRICO.
Para documentos externos:
Órgão de Origem: Formato - NOME DO ÓRGÃO ( UF - ESFERA ADMINISTRATIVA ), Tipo - TEXTO.
Unidade de Destino: Formato - NOME DA UNIDADE(CÓDIGO DA UNIDADE), Tipo - TEXTO e NUMÉRICO.
Para documentos de ofício:
Unidade de Origem: Formato - NOME DA UNIDADE(CÓDIGO DA UNIDADE), Tipo - TEXTO e NUMÉRICO.
Órgão de Destino: Formato - NOME DO ÓRGÃO ( UF - ESFERA ADMINISTRATIVA ), Tipo - TEXTO.
Despacho:
Tipo do Despacho: Tipo - TEXTO.
Parecer: Tipo - TEXTO, Formato - 'FAVORÁVEL' | 'DESFAVORÁVEL'
Servidor Responsável pelo Despacho: Tipo - TEXTO, Formato - NOME DO SERVIDOR
Público: Tipo - TEXTO, Formato - 'SIM' | 'NÃO'
Passo 6
Por fim serão exibidas as informações do documento gerado:
Número: Formato - AAAA. Tipo - NUMÉRICO.
Protocolo: Formato - 23077.999999/AAAA-99, Tipo - NUMÉRICO
Protocolo de Registro Original: Tipo - TEXTO.
Órgão de Origem: Formato - NOME DO ÓRGÃO ( UF - ESFERA ADMINISTRATIVA ), Tipo - TEXTO. Para Documentos externos.
Data de Autuação Original: Formato - DD/MM/AAAA, Tipo - DATA. Para Documentos externos.
Identificador: Tipo - TEXTO.
Ano: Formato - AAAA. Tipo - NUMÉRICO.
Tipo do Documento: Formato - DENOMINAÇÃO DO TIPO DO DOCUMENTO, Tipo - TEXTO.
Assunto do Documento (CONARQ): Formato - 999.999 - DENOMINAÇÃO ASSUNTO DO DOCUMENTO, Tipo - TEXTO.
Assunto Detalhado: Tipo - TEXTO.
Unidade Origem: Formato - SIGLA UNIDADE ORIGEM (CÓDIGO DA UNIDADE), Tipo - TEXTO.
Data do Documento: Formato - DD/MM/AAAA, Tipo - DATA.
Observação: Tipo - TEXTO.
Arquivos Anexados ao Documento:
Interessados Inseridos ao Documento:
Dados da Movimentação, com os dados:
Para documentos internos:
Unidade de Origem: Formato - NOME DA UNIDADE(CÓDIGO DA UNIDADE), Tipo - TEXTO e NUMÉRICO.
Unidade de Destino: Formato - NOME DA UNIDADE(CÓDIGO DA UNIDADE), Tipo - TEXTO e NUMÉRICO.
Para documentos externos:
Órgão de Origem: Formato - NOME DO ÓRGÃO ( UF - ESFERA ADMINISTRATIVA ), Tipo - TEXTO.
Unidade de Destino: Formato - NOME DA UNIDADE(CÓDIGO DA UNIDADE), Tipo - TEXTO e NUMÉRICO.
Para documentos de ofício:
Unidade de Origem: Formato - NOME DA UNIDADE(CÓDIGO DA UNIDADE), Tipo - TEXTO e NUMÉRICO.
Órgão de Destino: Formato - NOME DO ÓRGÃO ( UF - ESFERA ADMINISTRATIVA ), Tipo - TEXTO.
Despacho:
Tipo do Despacho: Tipo - TEXTO.
Parecer: Tipo - TEXTO, Formato - 'FAVORÁVEL' | 'DESFAVORÁVEL'
Servidor Responsável pelo Despacho: Tipo - TEXTO, Formato - NOME DO SERVIDOR
Público: Tipo - TEXTO, Formato - 'SIM' | 'NÃO'
O usuário também poderá Imprimir Comprovante, nele conterá as informações do documento cadastrado juntamente com seu código de barra respectivo.
Na página da comprovante serão mostrados os dados principais do processo e suas movimentações associadas.
O caso de uso é finalizado.
Principais Regras de Negócio
RN01 - A unidade de destino escolhida deve possuir pelo menos um usuário cadastrado no sistema para receber o documento.
RN02 - Apenas os usuários que apresentam a permissão de cadastrar protocolo na unidade na qual está logado no sistema pode acessar o caso de uso. Ou seja, além de ter o papel de cadastrar protocolo, o usuário deve ter permissão desse papel para a unidade que está acessando o sistema.
RN03 - O Assunto do Documento (CONARQ) apenas será solicitado caso o parâmetro UTILIZA_CLASSIFICACAO_CONARQ seja verdadeiro.
RN04 - Caso o documento seja do tipo MEMORANDO ELETRÔNICO ou MEMORANDO CIRCULAR, o seu identificador deve ser apenas numérico.
RN05 - O campo suporte deve aparecer apenas quando o parâmetro PERMITE_SUPORTE_PROTOCOLO for verdadeiro.
RN06 - O campo Grau de Sigilo dele aparecer apenas quando a natureza do documento for classificada como Sigiloso.
RN07 - O grau de sigilo pode ser: confidencial, reservado, secreto ou ultra-secreto.
RN08 - Na confirmação do cadastro de documentos será verificado a duplicidade do mesmo seguindo os critérios do tipo, ano, origem, destino e interessado(s). Caso seja constato documentos com a mesma características será alertado ao usuário com a opção de cancelar a operação ou cadastrá-lo mesmo assim.
RN09 - Para origem do documento externa e tipo da pessoa como física o campo de Protocolo de Registro Original será facultativo, já para pessoa como jurídica será obrigatório.
RN10 - O sistema deve realizar a contagem de páginas do arquivo inserido pelo usuário.
-
Resoluções/Legislações Associadas
PORTARIA NORMATIVA Nº 5, DE 19 DE DEZEMBRO DE 2002: Dispõe sobre os procedimentos gerais para utilização dos serviços de protocolo, no âmbito da Administração Pública Federal, para os órgãos e entidades integrantes do Sistema de Serviços Gerais - SISG.
Classes Persistentes e Tabelas Envolvidas
Classe | Tabela |
br.ufrn.sipac.protocolo.dominio.Documento | administrativo.protocolo.documento |
br.ufrn.sipac.cadastro.dominio.Unidade | administrativo.public.unidade |
br.ufrn.sipac.protocolo.dominio.MovimentoDocumento | administrativo.protocolo.movimento_documento |
br.ufrn.sipac.protocolo.dominio.TipoDocumento | administrativo.protocolo.tipodocumento |
br.ufrn.sipac.protocolo.dominio.ClassificacaoConarq (Assunto) | administrativo.protocolo.classificacao_conarq |
Plano de Teste
Sistema: SIPAC
Módulo: Protocolo
Link(s): Documentos → Cadastro → Cadastrar Documento
Usuário: marcilia, paulinho, bruma
Papel que usuário deve ter: ProtocoloPapeis.CADASTRAR_PROTOCOLO
Cenários de Teste
Verificar se é informado o radical do documento pelo sistema corretamente no cadastro. (Ver item abaixo)
Pode-se verificar se o documento foi cadastrado corretamente através do caso de uso SIPAC → Protocolo → Consultas/Relatórios → Consultas → Documentos
Dados para o Teste
Para RN01. A consulta abaixo traz unidades que não tem usuários com permissão de receber documentos.
SELECT codigo_unidade, nome, sigla,nome_capa FROM comum.unidade WHERE organizacional = TRUE AND id_tipo_organizacional = 7 AND id_gestora = 1424 AND id_classificacao_unidade = 4
AND id_nivel_organizacional = 2 AND id_unidade NOT IN (
SELECT id_unidade FROM comum.unidade WHERE id_unidade IN
(SELECT DISTINCT u.id_unidade FROM comum.unidade u, comum.usuario us, comum.permissao pe, comum.papel pa
WHERE us.id_unidade = u.id_unidade AND pe.id_usuario = us.id_usuario AND pa.id = pe.id_papel AND pa.id = 6
UNION SELECT DISTINCT u.id_unidade FROM comum.unidade u, comum.usuario_unidade us, comum.permissao pe, comum.papel pa
WHERE us.id_unidade = u.id_unidade AND pe.id_usuario = us.id_usuario AND pa.id = pe.id_papel AND pa.id = 6 AND u.organizacional = TRUE ) )
Pra saber o radical correto que o sistema informará ao documento, primeiro devemos saber se o parâmetro NUMERO_RADICAL_PADRAO_PROTOCOLO está presente no sistema, para isso usamos a consulta:
SELECT p.nome, p.valor AS radical
FROM comum.parametro p
WHERE p.nome = 'NUMERO_RADICAL_PADRAO_PROTOCOLO'
Onde seu valor será o radical a ser associado ao documento pelo sistema. Caso este não esteja presente, devemos saber a unidade do usuário que realiza o cadastro. Sabendo isso, podemos procurar a unidade protocolizadora responsável por esta unidade, usando recursivamente a consulta:
SELECT u.radical, u.nome, u.codigo_unidade, u.unidade_responsavel, u.id_unidade
FROM comum.unidade u
WHERE u.id_unidade = <ID DA UNIDADE>
O valor recursivo será o identificador da unidade responsável.
As condições de parada são:
A coluna radical não esteja nula, cujo valor será o radical correto para o processo.
A coluna radical esteja nula e o identificador da unidade seja igual ao identificador da unidade responsável. Nesse caso, o usuário é encaminhado para uma página de erro de negocio onde será informado que para prosseguir a unidade do usuário deverá ser ou apresentar uma unidade responsável protocolizadora.
Para saber o identificador da unidade do usuário, podemos usar:
SELECT u.id_unidade, u.codigo_unidade, u.nome
FROM comum.unidade u
WHERE u.codigo_unidade = <CÓDIGO DA UNIDADE>
O radical de uma unidade pode ser cadastrado pelo SIGAdim, no cadastro/alteração de unidades.
Para a RN02, podemos usar:
SELECT pa.nome, u.login
FROM comum.usuario_unidade uu
JOIN comum.usuario u ON u.id_usuario = uu.id_usuario
JOIN comum.pessoa p ON p.id_pessoa = u.id_pessoa
JOIN comum.unidade un ON un.id_unidade = uu.id_unidade
JOIN comum.permissao pe ON pe.id_usuario = u.id_usuario
JOIN comum.papel pa ON pa.id = pe.id_papel
WHERE pe.id_papel = 6
GROUP BY pe.id_unidade_papel, pa.nome, u.login, uu.id_usuario
ORDER BY u.login
SELECT pa.nome, u.login, un.codigo_unidade, un.nome
FROM comum.usuario u
JOIN comum.permissao pe ON pe.id_usuario = u.id_usuario
JOIN comum.papel pa ON pa.id = pe.id_papel
JOIN comum.unidade un ON un.id_unidade = pe.id_unidade_papel
WHERE u.login LIKE '<LOGIN DO USUÁRIO>'
AND pe.id_papel = 6
Para alterar os parâmetros da RN03 podemos usar:
UPDATE comum.parametro SET valor = 'true' WHERE nome = 'UTILIZA_CLASSIFICACAO_CONARQ'
Para alterar os parâmetros da RN05 podemos usar:
UPDATE comum.parametro SET valor = 'true' WHERE nome = 'PERMITE_SUPORTE_PROTOCOLO'