~~ODT~~

<PHP>
echo "<div style='display:block;float:right;'>"; 
echo "Última atualização: ";
ver('', false);
echo "</div>";
</PHP>

====== Documento Detalhado ======

Este caso de uso exibe informações detalhadas de um documento. É chamado por outros casos de uso do sistema que lidam com documentos de protocolo.

===== Descrição do Caso de Uso =====

Este caso de uso pode ser acessado por: //SIPAC → Módulo Protocolo → Consultas/Relatórios → Consultas → Documentos → Exibir Detalhes //.

São exibidas as seguintes informações do documento:

  * **__Protocolo__**: Tipo - NUMÉRICO, Formato - RADICAL.NÚMERO/ANO-DÍGITOS.
  * **__Origem__**: Tipo - TEXTO, Formato - ''Interna'' ou ''Externa''.
  * **__Protocolo Original do Documento__**: Tipo - TEXTO. Apenas aparece quando o documento o apresentar. 
  * **__Tipo do Documento__**: Tipo - TEXTO, Formato - NOME DO TIPO.
  * **__Identificador__**: TIPO - TEXTO. Apenas aparece quando o documento apresentar o identificador.
  * **__Ano do Documento__**: Tipo - NUMÉRICO, Formato - AAAA.
  * **__Código do Memorando__** ([[#Principais Regras de Negócio|RN02]]): Tipo - NUMÉRICO.   
  * **__Título do Memorando__** ([[#Principais Regras de Negócio|RN02]]): Tipo - TEXTO.
  * **__Assunto  (CONARQ)__** ([[#Principais Regras de Negócio|RN01]]): Tipo - TEXTO, Formato - CÓDIGO - CLASSIFICAÇÃO CONARQ.
  * **__Assunto__** ([[#Principais Regras de Negócio|RN03]]): Tipo - TEXTO.
  * **__Assunto Detalhado__**: Tipo - TEXTO.
  * **__Data do Documento__**: Tipo - DATA, Formato - DD/MM/AAAA.
  * **__Destinatário Principal__**: Tipo - TEXTO, Formato - NOME SERVIDOR | SIGLA UNIDADE (CÓDIGO). Apenas aparece quando o documento for um memorando.    
    * **__CC__**: Tipo - TEXTO, Formato - NOME SERVIDOR | SIGLA UNIDADE (CÓDIGO). Apenas aparece quando o memorando apresentar cópias para outros destinatários. 
  * **__Unidade de Origem__**: Tipo - TEXTO, Formato - NOME DA UNIDADE (CÓDIGO). Apenas aparece quando o documento a apresentar.  
  * **__Órgão Externo de Origem__**: Tipo - TEXTO, Formato - NOME DO ÓRGÃO. Apenas aparece quando o documento o apresentar.  
  * **__Data de Autuação Original__**: Tipo - DATA, Formato - DD/MM/AAAA. Apenas aparece quando o documento for externo.
  * **__Data de Autuação__**: Tipo - DATA, Formato - DD/MM/AAAA. Apenas aparece quando o documento for interno e a apresentar.        
  * **__Usuário de Autuação__**: Tipo - TEXTO, Formato - NOME DO USUÁRIO. Apenas aparece quando o documento for interno e o apresentar.      
  * **__Datado Cadastro__**: Tipo - DATA, Formato - DD/MM/AAAA HH:mm.
  * **__Observação__**: Tipo - TEXTO. Apenas aparece quando o documento o apresentar.      
  * **__Situação__**: Tipo - TEXTO.
  * **__Situação na Unidade__** ([[#Principais Regras de Negócio|RN02]]): Tipo - TEXTO.    

Caso o documento seja um memorando eletrônico respondido, são mostrados os seguintes dados:
  * **__Memorando respondido__**:
    * **__Data__**: Tipo - DATA, Formato - DD/MM/AAAA.
    * **__Documento__**: Tipo - TEXTO/AAAA, Formato - IDENTIFICADOR/ANO.
    * **__Identificador__**: Tipo - NUMÉRICO. Apenas aparece quando o documento o apresentar.     
    * **__Origem__**: Tipo - TEXTO, Formato -  (CÓDIGO) NOME DA UNIDADE.
    * **__Observação__**: Tipo - TEXTO.

Para documentos que não sejam memorandos eletrônicos ou circulares, são exibidos os interessados do documento:
  * **__Interessados do Documento__**:
    * **__Identificador__**: Tipo - NUMÉRICO, Formato - 999999999.
    * **__Tipo__**: Tipo - TEXTO.
    * **__Nome__**: Tipo - TEXTO.
    * **__E-Mail__**: Tipo - TEXTO.

Abaixo são exibidas as movimentações do documento:

  * **__Movimentações do Documento__**:
    * **__Destino__**: Tipo - TEXTO,Formato - NOME DA UNIDADE OU ÓRGÃO EXTERNO.
    * **__Enviado Em__**: Tipo - DATA, Formato - DD/MM/AAAA HH:MM.
    * **__Enviado Por__**: Tipo - TEXTO, Formato - LOGIN DO USUÁRIO.
    * **__Recebido Em__**: Tipo - DATA, Formato - DD/MM/AAAA HH:MM.
    * **__Recebido Por__**: Tipo - TEXTO, Formato - LOGIN DO USUÁRIO.
    * **__Tempo Esperado__**: Tipo - NUMÉRICO, Formato - 999 dia(s).
    * **__Observação__**: Tipo - TEXTO. Apenas aparece quando o movimento do documento o apresentar.    
    * **__Localização Física__**: Tipo - TEXTO. ([[#Principais Regras de Negócio| RN04]], [[#Principais Regras de Negócio| RN05]])    
      * Para cada movimento, são exibidos os despachos realizados, caso eles existam:
        * **__Despacho__**: Tipo - DATA e TEXTO, Formato - DD/MM/AAAA - NOME DA UNIDADE (CÓDIGO) 
        * Para cada despacho temos a opção: Caso o despacho esteja autenticado.
          * //Visualizar Despacho//: No qual é mostrado o arquivo de despacho.

Se houver ocorrências cadastradas para o documento, serão exibidas as seguintes informações:

  * **__Ocorrências deste documento__**:
    * **__Ocorrência__**: Tipo - TEXTO.
    * **__Data do Cadastro__**: Tipo - DATA, Formato - DD/MM/AAAA.
    * **__Data Ocorrência__**: Tipo - DATA, Formato - DD/MM/AAAA.
    * **__Prazo de Término__**: Tipo - NUMÉRICO/DATA, Formato - 999 dia(s) - DD/MM/AAAA.
    * **__Situação__**: Tipo - TEXTO, Formato - NOME DA SITUAÇÃO.
    * **__Usuário__**: Tipo - TEXTO, Formato - LOGIN DO USUÁRIO.
    * Para cada ocorrência do documento temos a opção:
      * //[[desenvolvimento:especificacoes:sipac:protocolo:casos_de_uso:consultas_relatorios:consultas:ocorrencia_detalhada|Visualizar Ocorrência]]//: Onde é possível visualizar os detalhes da ocorrência.

Em seguida, caso o documento apresente arquivos anexados, temos as seguintes informações sobre eles:
  * **__Arquivos anexados ao Documento__**:
    * **__Nome__**: Tipo - TEXTO.
    * **__Descrição__**: Tipo - TEXTO.
    * Para cada documento temos a opção:
      * //Baixar Arquivo//.

Para documentos que tenham sido classificados como sigilosos:
  * **__Histórico de Classificação Sigilosa__**:
    * **__Tipo__**: Tipo - TEXTO, o qual pode ser:
      * ''CLASSIFICAÇÃO'';
      * ''DESCLASSIFICAÇÃO'';
      * ''RECLASSIFICAÇÃO''.
    * **__Realizado em__**: Formato - DD/MM/AAAA, Tipo - DATA.
    * **__Grau de Sigilo__**: Tipo - TEXTO, , o qual pode ser:
      * ''ULTRA-SECRETO'';
      * ''SECRETO'';
      * ''CONFIDENCIAL''.
      * ''RESERVADO''.
    * **__Realizado por__**: Formato - NOME DO USUÁRIO, Tipo - TEXTO.
    * **__Observação__**:  Tipo - TEXTO.

Por fim, são mostrados os dados das alterações feitas no documento, caso elas existam:
  * **__Alterações Ocorridas no Documento__**:
    * **__Situação__**: Tipo - TEXTO.
    * **__Data__**: Tipo - DATA, Formato - DD/MM/AAAA.
    * **__Alterado Por__**: Tipo - TEXTO, Formato - LOGIN DO USUÁRIO.
    * **__Observação__**: Tipo - TEXTO.
    * **__Localização Física__**: Tipo - TEXTO. Apenas aparece quando a alteração seja de arquivamento do documento e a localização seja na unidade do usuário.    

Para o documento, existe ainda a opção de **Imprimir Comprovante** do Documento.

O caso de uso é finalizado.

===== Principais Regras de Negócio =====

  * **RN01** - O campo **Assunto (CONARQ)** só aparece quando o parâmetro **//UTILIZA_CLASSIFICACAO_CONARQ//** for verdadeiro e o apresente.
  * **RN02** - Os campos **Título do Memorando**, **Código do Memorando** e **Situação na Unidade** só aparecem quando o documento for um memorando eletrônico e os apresente.
  * **RN03** - O campo **Assunto** só aparece quando a RN01 e a RN02 forem falsos.
  * **RN04** - A localização física dos documentos arquivados apenas serão visualizadas quando o movimento do documento a apresentar e ela seja na unidade do usuário. 
  * **RN05** - Caso o parâmetro EXIBE_LOCALIZACAO_CONSULTA_PROTOCOLO seja verdadeiro, a visualização da localização física dos documentos arquivados é liberada para todos os usuário do sistema, caso contrário, continua a situação anterior.
  
==== Resoluções/Legislações Associadas ====

Não se aplica.

===== Classes Persistentes e Tabelas Envolvidas =====

^ Classe ^ Tabela |
| br.ufrn.sipac.protocolo.dominio.Documento | administrativo.protocolo.documento |
| br.ufrn.sipac.protocolo.dominio.MovimentoDocumento | administrativo.protocolo.movimento_documento | 
| br.ufrn.sipac.protocolo.dominio.MudancaDocumento   | administrativo.protocolo.mudanca_documento |
| br.ufrn.sipac.protocolo.dominio.TipoDocumento      | administrativo.protocolo.tipodocumento |
| br.ufrn.sipac.protocolo.dominio.ClassificacaoConarq (Assunto)   | administrativo.protocolo.classificacao_conarq |
| br.ufrn.sipac.protocolo.dominio.OcorrenciaProcessoDocumento | administrativo.protocolo.ocorrencia_processo_documento |
| br.ufrn.sipac.protocolo.dominio.Despacho | administrativo.protocolo.despacho |

====== Plano de Teste ======

Sistema: SIPAC

Módulo: Protocolo

Link(s): SIPAC → Módulo Protocolo → Consultas/Relatórios → Consultas → Documentos 

Usuário: marcilia, jbb, bruma, elizabete, fabiobarreto

Papel que o usuário deve ter: qualquer papel com acesso ao Módulo de Protocolo.

===== Cenários de Teste =====

Não se Aplica.

===== Dados para o Teste =====

Para alterar os parâmetros da **RN01**, podemos usar:
<code sql>
UPDATE comum.parametro SET valor = 'true' WHERE nome = 'UTILIZA_CLASSIFICACAO_CONARQ'
</code>

Pode ser acessado pelo [[desenvolvimento:especificacoes:sipac:protocolo:casos_de_uso:consultas_relatorios:consultas:documentos| Consultar Documentos]].