====== Guia de Implantação do módulo Assistência Estudantil - SIGAA ======

Este guia de implantação tem por objetivo abordar os aspectos de banco de dados envolvidos na implantação do Módulo de Assistência Estudantil do SIGAA.  Serão abordados quais as tabelas do banco de dados envolvidas, e que devem ser preenchidas previamente para o correto funcionamento do sistema.

====== Glossário ======

  * SIGAA – Sistema Integrado de Gestão de Atividades Acadêmicas;
  * Banco de Dados – Armazenamento de dados, relacionado com SGBDR, mesmo que base de dados;
  * SGBDR – Sistema de gerenciamento de banco de dados relacional;
  * SQL – Linguagem de pesquisa declarativa para banco de dados relacional;
  * Postgres – Um sistema gerenciador de banco de dados relacional, mesmo que PostgreSQL; 
  * ETL (Extract, Transform, Load) – Extrair, Transformar e Carregar, termo usado para dar carga em SGBDR, usado ao importar ou exportar dados oriundos de um  sistema legado para um SGBDR;
  * Entidade – Tabela em um banco de dados;
  * Atributo – Coluna ou campo de uma tabela em banco de dados; 
  * Tupla – Registro ou linha de uma ocorrência em uma tabela; 
  * DMR/MR – Diagrama Modelo Relacional; 
  * DD – Dicionário de Dados – É uma coleção de metadados, isto é, dados sobre os dados,  que contêm definições e representações de elementos de dados;
  * Popular tabela – Preencher uma entidade ou tabela com dados.
  * CRUD – Acrônimo de Create, Read, Update e Delete em língua inglesa, para as quatros oparações básicas utilizadas em banco de dados relacionais (SGBDR) ou em interface para usuários para criação, consulta, atualização e destruição de dados.

====== Referências ======

Para a compreensão deste módulo é importante a consulta dos seguintes artefatos:              

====== Especificações  de  negócio: ======

https://docs.info.ufrn.br/doku.php?id=desenvolvimento:especificacoes:sigaa:assistencia_ao_estudante:negocio

====== Pré-Requisitos ======

  * Definição dos parâmetros corretamente conforme seção abaixo. 
  * Popular banco de dados com entidades envolvidas.

====== Observações ======

  *  Nas descrições das entidades a seguir, poderão ser encontradas a lista de valores possíveis para alguns campos. Em alguns casos, esses valores não correspondem a uma referência para a chave ou campo de outra entidade. Mas normalmente, os valores listados são correspondentes a chave primária da tabela referenciada onde os valores estão efetivamente armazenados. Portanto, deve-se considerar o preenchimento dessas entidades como pré-requisito para o preenchimento do campo da entidade que está sendo descrita;
  *  Algumas entidades possuem campos criados nas migrações de outros sistemas legados. Esses campos, que geralmente possuem as iniciais "codmerg", podem ser desconsiderados ou utilizados a critério da instituição para armazenar informações do sistema de onde os dados são oriundos;
  *  Algumas entidades podem possuir campos com o sufixo "_ascii" (ex. "nome_ascii"). Esses campos são textuais e armazenam textos sem acentuação com o objetivo de melhorar o processo de busca da informação pelo sistema. Por exemplo, uma busca pelo campo "//nome"// da tabela //comum.pessoa//, será feita sobre o campo "//nome_ascii"// pois é um campo indexado e permite uma localização mais precisa das informações;
  *  Para facilitar o preenchimento dos campos com o sufixo "_ascii", pode ser utilizada a função chamada "//sem_acento"// do esquema //public//, passando como parâmetro o valor do campo que se deseja criar o seu correrpondente ASCII.
  * Com o objetivo de ampliar e facilitar entendimento, todas as tabelas e colunas deste módulo foram documentadas, no banco, com o uso da cláusula SQL apropriada para comentários, COMMENT ON, que podem ser visualizados com o uso do programa pgAdmin III.

^ Código ^ Nome do Parâmetro ^ Descrição ^

====== Papéis de Usuários ======

A tabela abaixo descreve os perfis envolvidos na funcionalidade do Módulo de Pesquisa

^Nome do Papel ^ Funcionalidade ^


====== Banco de Dados ======

Este tópico descreve os procedimentos para ETL, para o módulo de pesquisa, citaremos as principais entidades envolvidas, seus pré-requisitos, dependências e relacionamentos, para ilustrar iremos usar DMR (Diagramas Modelo Relacional), DD (Dicionário de Dados) e ainda figuras exemplos. Uma visão geral de todo o módulo de  pesquisa, poderá ser vislumbrada através do DD Dicionário de Dados descritos neste documento acrescidos de DMR Diagrama Modelo Relacional.  Tomamos por SGBDR base, onde serão importados os dados, o  PostgreSQL versão 8.x/9.0.


^ Tabela ^ Comentário ^ 

Recomendamos atentar para as dependências, pré-requsitos, antes de popular cada tabela do módulo de Assistência Estudantil. No Quadro abaixo, a seguir, são descritas as tabelas que tem  dependências.  

^ esquema_tabela_pai ^ esquema_tabela_filho ^



====== Entidade Auxiliares, Tipos, Classificações, etc. ======
 
Esta tópico visa informar quais as entidades base do módulo que necessitam de preenchimento obrigatório, isto é, com dados padronizados para o perfeito funcionamento do módulo de Assistência Estudandil.


====== Movimentações ======

Este tópico representam as tabelas com mais incidências de tuplas, isto é, inserção (inserts) e atualização (updates ), onde são registradas as movimentações  do módulo de Assistência Estudantil.