====== Especificação funcional: Gestão de diários ======

===== Resumo =====
A gestão de diários reúne todas as funcionalidades necessárias para gerar e acompanhar o uso dos diários pela secretaria escolar.

===== Descrição =====
A geração de diários, mesmo na web, não deve ser automática. As secretarias escolares precisam ter o controle sobre a geração e finalização dos diários, além de acompanhar o preenchimento desses diários pelos professores e posteriormente realizar a importação das notas no sistema School. Para facilitar essas tarefas, o School web deve contar um uma área onde o secretário escolar possa realizar suas tarefas de gestão e controle de diários de maneira simples e funcional.

==== Acesso à gestão de diários ====
O acesso à página de gestão de diários deve ser restrito a usuários com os [[softwares:schoolweb:requisitos:documentacao_tecnica:arquitetura:permissionamento|perfis]] Geral e Município. Todos os usuários com acesso à página poderão realizar as operações disponíveis.

Ao acionar a opção diários na lista de acompanhamentos, uma nova aba é aberta com as funcionalidades do diário.

==== Lista de turmas/disciplinas ====

{{:softwares:schoolweb:requisitos:diario:acompanhamento_diarios_diariosgerados.png|}}

Ao acessar a página de gestão de diários, o usuário deve visualizar uma tela com várias opções relacionadas ao diário.

No canto esquerdo da tela ficam os tipos de diários (de acordo com o tipo da turma) que podem ser visualizados e os diários desbloqueados.

Ao acionar um tipo de diário (Regular, AEE, Complementar), o grid será modificado para tal, trazendo os dados de acordo com o tipo selecionado. No primeiro momento, virá para o usuário somente os diários gerados. Caso o usuário deseje visualizar os diários não gerados e as combinações de turma x disciplina disponíveis ele pode modificar isso na combo na parte superior esquerda da tela.

Ao acionar os diários desbloqueados, o sistema irá carregar todos os diários desbloqueados do sistema, inclusive ao acionar essa opção o sistema verifica se os diários estão ou não desbloqueados. Esse grid não fica salvo em cache, por isso é carregado toda vez que é acionado.

Os botões de cada grid variam de acordo com o grid selecionado, por exemplo, o grid de diário gerados não possuem o botão de gerar diários, ele se encontra disponível na lista das combinações de turma x disciplina - opção diários não gerados.

A respeito da lista de turma x disciplina:

Quando as disciplinas forem individuais, para cada combinação turma/disciplina deve haver um registro nessa lista. Entretanto, quando houverem disciplinas conjuntas, apenas uma linha representando todas essas disciplinas deve ser apresentada.

A lista de turmas/disciplinas deve apresentar as seguintes informações:
  * **Ano letivo**: Ano base do calendário do curso ao qual a turma está vinculada;
  * **Escola**: Nome da escola;
  * **Curso**: Nome do curso;
  * **Série**: Nome da série;
  * **Turma**: Nome da turma;
  * **Turno**: Nome do turno;
  * **Disciplina**: Nome da disciplina, para disciplinas individuais. Nome da disciplina principal, seguido do texto "(principal)", para disciplinas conjuntas;
  * **Professor**: Nome do professor vinculado à turma/disciplina;
  * **Situação** do diário: Situação do diário da turma/disciplina. Valores possíveis: Não gerado, gerado e finalizado.
  * **Download**: Informa se foi feito o download do XML do diário;
  * **Data Download**: Data do download do XML do diário;
  * **Desconfigurado**: Informa se houve uma atualização indevida no diário;
  * **Data da última importação**: Data da última importação do diário realizada no School Desktop;

=== Filtros e ordenação ===
Todos os campos da lista devem permitir a ordenação dos dados e a realização de filtros.

==== Geração de diários ====
Para que os secretários possam gerar os diários é necessário que a geração esteja habilitada nas configurações do município. Caso não tiver, o sistema irá bloquear o botão de gerar diários nos grids de diários não gerados, impossibilitando a geração dos mesmos.

Para que os professores possam acessar e preencher as informações do diário, estes devem ser gerados para as suar respectivas turmas e disciplinas.

=== Geração individual de diários ===
O sistema deve permitir que o usuário gere o diário para apenas uma turma/disciplina, bastando para isso que ele selecione um item da lista de turmas/disciplinas e solicite a geração desse diário. Caso o item selecionado já possua um diário gerado, o sistema deve alertar o usuário de que o diário já existe e não deve sobrescrever o existente. Da mesma forma, se não houver um professor vinculado à turma/disciplina, o sistema também deve alertar o usuário e não gerar o diário.

=== Geração de vários diários ===
O sistema deve permitir que o usuário gere diários para várias turmas/disciplinas ao mesmo tempo. Para isso, é preciso que o usuário possa selecionar mais de um item na lista de turmas/disciplinas. Com os itens selecionados, ao solicitar a geração dos diários, o sistema deve gera-los apenas para os itens que não tiverem os diários já gerados e que tiverem um professor vinculado. Caso algum diário não seja gerado por um dos problemas citados anteriormente, o sistema deve alertar o usuário sobre a não geração desses diários.

=== Envio de e-mail ===
O sistema deve enviar ao professor um e-mail de confirmação informado que o diário foi gerado.

=== Informações importantes ===

Ao gerar os diários são criados turmas, séries, cursos e anos letivos para eles (nas tabelas dos diários). Se forem alterados alguns dados desses registros na escola pode acontecer dos diários serem bloqueados. Caso não exista nenhum diários gerado, essas informações são atualizadas normalmente sem que haja qualquer bloqueio nos diários gerados após essa alteração na escola.

==== Gerar arquivo de atualização ====

==== Exclusão de diários ====
O sistema deve disponibilizar a possibilidade de excluir um ou vários diários, desde que estes não estejam finalizados.

=== Exclusão individual de diários ===
O sistema deve permitir que o usuário exclua um diário gerado para apenas uma turma/disciplina, bastando para isso que ele selecione um item da lista de turmas/disciplinas e solicite a exclusão desse diário. Antes de excluir o diário, entretanto, é preciso que o sistema solicite a confirmação da operação por parte do usuário. Caso o item selecionado não possua um diário gerado, o sistema deve alertar o usuário de que o diário não existe e não deve fazer nenhuma ação.

==== Acesso ao diário (visualização) ====
O sistema deve permitir que o usuário que realiza a gestão dos diários possa acessá-los sempre que for necessário, bastando para isso clicar sobre um dos itens da lista de turmas/disciplinas (desde que esse item tenha um diário gerado). Esse acesso, entretanto, deve sempre ser realizado apenas para visualização.

==== Geração de arquivos de diários ====
A geração de arquivos de diário deve ser realizada sempre que for necessário realizar a importação dessas informações no sistema School ou se o professor desejar utilizar o diário através do sistema Diário eletrônico. A estrutura do arquivo deve sempre seguir o [[softwares:diario:requisitos:layouts:home|layout]] definido para uso no sistema Diário eletrônico.

=== Geração individual de diários ===
O sistema deve permitir que o usuário gere e faça o download de um arquivo de diários para cada combinação de turma/disciplina, bastando para isso que ele selecione um item na lista de turmas/disciplinas e solicite a geração do arquivo. Caso o item selecionado ainda não tenha um diário gerado, o sistema deve alertar o usuário de que é necessário gerar o diário antes de fazer o download do arquivo.

====Bloqueio / Desbloqueio dos períodos letivos====
===Desbloqueio manual dos períodos letivos===

O desbloqueio manual dos períodos letivos já encerrados e bloqueados deve armazenar o período no qual foram desbloqueados.
Caso a configuração do município esteja habilitando o bloqueio dos períodos letivos, o período será bloqueado ao término da data de todo período letivo somando os dias para bloqueio como configurado.
Ao realizar a operação de desbloqueio manual dos períodos letivos todos os períodos do diário serão desbloqueados e a coluna status será atualizada.

===Bloqueio automático dos períodos letivos desbloqueados manualmente===

Ao carregar a lista de diários no grid de diários desbloqueados ou carregar um diário o sistema deve verificar se o período no qual esse diário que foi desbloqueado manualmente já se encerrou, caso tenha sido encerrado o sistema deverá bloquear os períodos já encerrados.

===Bloqueio manual dos períodos letivos===

Ao realizar essa operação, os períodos letivos encerrados do diário selecionado serão bloqueados só podendo ser utilizado quando os períodos letivos estão desbloqueados.

Só é possível realizar essa operação no grid de diários desbloqueados.

====Encerrar diários====
===Resumo===

Esta opção encerra um diário selecionado para que novos diários possam ser gerados. Ao encerrar um diário o mesmo fica disponível no acompanhamento de "Diários encerrados" para o acesso.

===Descrição===

Ao usar essa opção o sistema irá encerrar o diário, ou seja, o mesmo deixará de ficar disponível para o professor e também não ficará disponível no acompanhamento de diários. Todos os diários encerrados irão ser listados no acompanhamento de "Diários encerrados".

Essa opção se faz necessária para que novos diários possam ser gerados após a finalização do ano letivo da escola quando novas turmas começam a ser criadas e novos alunos começam a ser matriculados.

Um diário encerrado possui todas as informações que o professor inseriu durante o ano, porém o gestor dos diário irá conseguir somente visualizar as informações, a edição é bloqueada.

Antes de encerrar um diário o sistema verifica se a turma foi finalizada, caso não esteja, o sistema impede que a operação prossiga.

O processo de encerramento do diário não pode ser revertido.

Os diários encerrados são armazenados em cash, portanto ao acessar o acompanhamento e efetuar novos encerramentos será necessário encerrar a sessão e logar novamente para visualizar os diários encerrados.
A validação para verificar se o diário está encerrado ou não vale apenas para quando tem somente um diário selecionado, mais do que isso o sistema apenas ignora os diários não gerados.

===Impacto nos diários do professor===

Se um professor tentar abrir um diário quando a turma for finalizada na escola o sistema não irá realizar as atualizações dos dados, pois isso acarretaria na total desconfiguração do mesmo.

O professor somente poderá visualizar as informações e assim que o diário for encerrado na web o diário irá sumir da lista de diários do mesmo.

===Impressão===

Quando um diário encerrado é aberto, as opções de impressão são diferentes de um diário normal. Só existirá um opção de impressão: **Diário completo**(para diários com ficha descritiva: **Todas as disciplinas**), isso se deve ao fato do sistema salvar o HTML da impressão durante o processo de encerramento do diário.

O HTML deve ser salvo pois as configurações de impressão podem mudar de um ano letivo para outro.

===Download do HTML===
Juntamente com a opção de impressão existe a opção de download do HTML. Com ela é possível baixar o HTML do diário ou da ficha descritiva.

===== Configurações e preferências do usuário =====
A geração de diários é baseada diretamente nas configurações do diário...
 
===== Pontos de verificação =====
  * Para um diário ser gerado deve existir um professor vinculado na turma e disciplina e não pode estar gerado.
  * Quando uma das turmas e disciplinas selecionadas não possuir professor vinculado ou tenha algum diário gerado para uma delas nenhum diário será gerado.
  * Quando ocorrer algum erro ao gerar um ou mais diários uma mensagem será apresentada para o usuário.
  * Somente será enviado e-mail de confirmação para o professor caso o mesmo tenho um e-mail válido cadastrado no sistema.
  * A coluna data de download informa sempre a ultima data em que foi feito o download do XML do diário.

===== Observações =====
Nenhuma.