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


====== Gerar Arquivo de Adicional ======

O arquivo de adicional representa o arquivo a ser enviado ao sistema SIAPE com informações de registros de adicional noturno ou horas extras lançados para o servidor dentro de uma faixa periódica.
Layout do Arquivo utilizado para geração do arquivo .txt: {{:desenvolvimento:especificacoes:sigrh:administracao_de_pessoal:casos_de_uso:financeiro:adicionais:layout_arquivo_adicionais.pdf|}}

Pré Condições: Confirmar as informações dos adicionais através do [[dados_de_adicionais_noturnos|dados de adicionais noturno]].

Esse caso de uso é utilizado pelos gestores financeiros com a finalidade de gerar os arquivos de adicional, que posteriormente serão enviados ao SIAPEnet (como adicional).

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

Este caso de uso inicia quando o usuário acessa a opção: SIGRH -> Administração de Pessoal -> Financeiro -> Adicionais -> Gerar Arquivo de Adicional.

Para gerar o arquivo de adicional será necessário informar:
  * **Período do Adicional***: Formato - MÊS/AAAA, Tipo - TEXTO e DATA. Para o MÊS são apresentadas opções: ''Janeiro, Fevereiro, ..., Dezembro''.
  * **Rubrica***: Tipo - TEXTO. São apresentadas opções: ''ADIC.P/SERV.EXTRAORDINARIO-EST'', ''ADICIONAL NOTURNO'', ''ADICIONAL DE INSALUBRIDADE'', ''ADICIONAL DE PERICULOSIDADE'', ''ADIC.DE IRRADIACAO IONIZANTE'' ou ''GRATIFICAÇÃO RAIO X-ATIVO''. 
  * **Operação***: Tipo - TEXTO, São apresentadas opções: ''Inclusão ou Alteração''. Tipo de operação para a geração do arquivo.

Ao realizar o cadastro, o arquivo ([[#principais_regras_de_negócio|RN01]], [[#principais_regras_de_negócio|RN02]], [[#principais_regras_de_negócio|RN03]]) é gerado em formato texto (.txt) de conformidade com o layout definido e pode ser salvo pelo usuário.

O caso de uso é finalizado.

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

  * **RN01** -  Na geração do arquivo é incluso um registro na entidade de relacionamento do arquivo com os registros de adicionais com as informações do registro, do arquivo, do período que o arquivo se refere e com a data da associação do arquivo;
  * **RN02** -  Na geração do arquivo, na entidade que armazena as  informações dos registros de adicionais(registro_adicional), para todos os registros gerados no arquivo, o campo que informa se houve geração de arquivo (arquivo_incluido) é atualizado como verdadeiro.
  * <del>**RN03** -  Caso já tenha sido gerado o arquivo de adicional para um mesmo período, o registro anterior é inativado e incluso um novo registro para o relacionamento; </del>
  * **RN04** - Quando o usuário logado possuir papel com exigência de vinculação a uma unidade, todas as operações somente podem ser realizadas para servidores lotados na unidade que foi vinculada ao papel. Caso contrário, as operações podem ser realizadas para servidores lotados em qualquer unidade.
  * **RN05** - O arquivo de adicional noturno e hora extra é enviado como adicional no SiapeNet, já o arquivo de faltas é enviado como movimentação financeira.

==== Resoluções/Legislações Associadas ====
Não se aplica.

<ifauth @admin>

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

^ Classe ^ Tabela |
| br.ufrn.sigrh.financeiro.dominio.ArquivoRegistroAdicional | administrativo.financeiro.arquivo_reg_adicional |
| br.ufrn.sigrh.financeiro.dominio.RelacionamentoRegistroAdicional | administrativo.financeiro.relac_arq_reg_adicional |
| br.ufrn.sigrh.financeiro.dominio.RegistroAdicional | administrativo.financeiro.registro_adicional |
| br.ufrn.sigrh.financeiro.dominio.SolicitacaoPagamentoAdicional | administrativo.financeiro.solicitacao_pag_adicional |

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

Sistema: SIGRH

Módulo: Administração de Pessoal

Link(s): Financeiro -> Adicionais -> Gerar Arquivo de Adicional

Usuário: glorian

Papel que usuário deve ter: SigrhPapeis.GESTOR_DAP, SigrhPapeis.ADMINISTRADOR_DAP, SigrhPapeis.GESTOR_FINANCEIRO

===== Cenários de Teste =====
Não se aplica.

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

<code sql>


-- Scripts para consultar cada tabela individualmente;

SELECT id_arquivo_reg_adicional, data, id_rubrica, data_cadastro, id_registro_entrada, 
       invalido, operacao, conteudo
  FROM financeiro.arquivo_reg_adicional
 WHERE data_cadastro > '2010-06-01';

SELECT id_relac_arq_reg_adicional, id_arquivo_adicional, id_registro_adicional, 
       data_associacao, id_registro_associacao, data_desassociacao, 
       id_registro_desassociacao
  FROM financeiro.relac_arq_reg_adicional
 WHERE data_associacao > '2010-06-01';

SELECT id_registro_adicional, id_servidor, data, quantidade, id_registro_entrada, 
       data_cadastro, id_rubrica, conteudo_adicional, id_unidade, incluido_arquivo, 
       data_alteracao, valor, id_solicitacao_pag_adicional
  FROM financeiro.registro_adicional
 WHERE data_cadastro > '2010-06-01';

SELECT id_solicitacao_pag_adicional, numero, ano, mes_referencia, ano_referencia, 
       id_unidade, id_tipo_adicional, id_status, id_registro_entrada, 
       data_cadastro, id_arquivo_reg_adicional
  FROM financeiro.solicitacao_pag_adicional
 WHERE data_cadastro > '2010-06-01';

-- Script para consultar as quatro tabelas relacionando-se;
-- relac_arq_reg_adicional é a tabela intermediária da relação muitos-muitos entre arquivo_reg_adicional e registro_adicional;
-- por fim, tem-se a seguinte relação: solicitacao_pag_adicional  1----N  registro_adicional;

       SELECT * 
         FROM financeiro.relac_arq_reg_adicional relac
   INNER JOIN financeiro.arquivo_reg_adicional arq ON relac.id_arquivo_adicional = arq.id_arquivo_reg_adicional
   INNER JOIN financeiro.registro_adicional reg ON relac.id_registro_adicional = reg.id_registro_adicional
   INNER JOIN financeiro.solicitacao_pag_adicional solic ON reg.id_solicitacao_pag_adicional = solic.id_solicitacao_pag_adicional
        WHERE relac.data_associacao > '2010-06-10';
</code>

</ifauth>