Especificação funcional: Atualização dos arquivos de diário

A atualização de arquivos de diários sincroniza os dados do arquivo com os dados do School desktop.

Os usuários do Diário Eletrônico não devem possuir controle absoluto sobre as informações de um arquivo de diários. Algumas operações, como a inclusão de novos alunos na turma, por exemplo, devem ser sempre realizadas pela secretaria da escola primeiro, para só depois serem propagadas para os diários dos professores. Para limitar as capacidades dos professores e, ao mesmo tempo, manter os arquivos de diário atualizados, o processo de atualização dos arquivos se faz necessário.

A atualização de um arquivo de diários deve começar na secretaria da escola: um usuário do School Desktop deve gerar um arquivo de atualizações, de acordo com um layout predefinido, contendo as informações mais atuais sobre a formação de turmas, alunos matriculados, vínculos de professores com turmas, etc. Após gerar esse arquivo, o mesmo deve ser enviado para todos os professores da escola para que eles possam realizar a atualização.

De posse desse arquivo, o usuário do sistema deverá abrir o arquivo de diários e, através de uma ferramenta específica, processar as atualizações contidas no arquivo de atualização. O Diário Eletrônico deve, então, realizar as movimentações e atualizações de dados que o usuário do sistema não consegue fazer diretamente, fazendo com que o arquivo de diários e o sistema instalado na escola (School Desktop) tenham as mesmas informações.

O arquivo de atualizações deve ser escrito no formato XML, conforme as especificações predefinidas no layout do arquivo de atualizações e de acordo com as regras definidas no esquema (arquivo .xsd) adequado.

Para garantir que a atualização ocorra da maneira correta, algumas verificações devem ser realizadas pelo sistema antes de processar o arquivo:

1. Abrir o arquivo de atualizações, em modo texto, e verificar a presença de alguns elementos que indiquem que o documento é um arquivo de atualizações:
   1. O indicador de que o arquivo se trata de um documento xml;
   2. O nó raiz do arquivo;
   3. A versão do layout do arquivo;
   4. A indicação do nome do schema que deve ser usado para validar o arquivo.
2. Verificar se o arquivo está definido como somente leitura;
3. Validar o arquivo de atualizações de acordo com o Schema adequado, na versão adequada;

Caso alguma das validações falhe, o sistema não deverá processar o arquivo e o usuário deverá ser informado para que possa providenciar um arquivo de atualizações válido ou resolver os problemas encontrados.

Assim que um arquivo de atualizações válido for aberto, o sistema deve iniciar as comparações dos dados do arquivo com os dados do diário atual para montar uma lista de tarefas de atualização. Ao final do processo de comparação, a lista de tarefas de atualização deverá ser exibida para o usuário para que ele confirme cada uma das alterações que serão realizadas. Somente após a conferência e confirmação do usuário em cada tarefa o sistema deverá processar efetivamente as atualizações no arquivo de diários.

O sistema deve realizar as comparações dos dados mais genéricos para os mais específicos, gerando a lista de tarefas na mesma ordem em que as verificações ocorrem. As tarefas da lista devem ser divididas nas seguintes categorias:

• Tarefa (): tarefas de atualização simples, sem maiores efeitos no uso do diário ou em seus dados. Ex: atualização dos metadados do arquivo, mudanças nos nomes dos alunos, mudanças nos nomes das disciplinas, etc.
• Advertência (): tarefas de atualização mais complexas, que podem gerar perda de dados ou afetar o uso do diário. Ex: Movimentação de alunos, exclusão de alunos das turmas, etc;
• Erro (): modificações que o sistema não deve ou não é capaz de realizar. Ex: O arquivo de atualizações pertence a outra escola, a estrutura de períodos letivos de um curso foi modificada, etc.

Enquanto existirem erros na lista de tarefas a executar, o sistema não deverá realizar nenhuma alteração no arquivo de diários. Alguns desses erros poderão ser corrigidos pelo próprio usuário, enquanto outros deverão ser corrigidos através da geração de um novo arquivo de diários, de um novo arquivo de atualização ou até mesmo de uma alteração manual do arquivo. Para auxiliar o usuário, o sistema deverá exibir informações detalhadas para cada tarefa, orientando o usuário sobre como ele deve proceder.

• O sistema deve processar apenas arquivos de atualização válidos, de acordo com o layout definido para arquivos de atualização;
• O sistema não deve permitir que arquivos de atualização de outras escolas sejam processados em um arquivo de diários;
• O sistema não deve permitir que arquivos de atualização antigos (com data de geração menor que a data de geração/atualização do arquivo de diários) sejam processados;
• O sistema deve exibir uma lista das ações realizadas antes de proceder com as atualizações;
• O sistema deve exibir informações detalhadas sobre cada tarefa que será realizada no arquivo;
• O sistema deve trazer as tarefas simples marcadas como padrão;
• O sistema deve exigir que o usuário confirme cada uma das advertências antes de efetivamente executar as tarefas;
• O sistema deve impedir que a atualização aconteça caso exista algum erro na lista de tarefas a serem executadas;
• O sistema, ao processar a atualização, deve executar exatamente as ações definidas para cada tarefa;
• O sistema deve informar ao usuário que a atualização foi concluída ao final do processo;
• O sistema deve salvar e fechar o arquivo de diários após a atualização;
• O sistema não deve corromper o arquivo de diários após a atualização;
• O sistema não deve apagar o arquivo de atualização após o processo.

Algumas tarefas de atualização, principalmente as que se referem a alunos, são processadas para cada diário. Logo, se o aluno estiver em mais de um diário no mesmo arquivo, serão criadas tarefas de atualização idênticas para cada diário onde o aluno estiver.