development-phase · planned
Fase 06 — Documentos
Checklist de templates DOCX, versões, geração e acompanhamento de assinatura.
Referências: fluxo de formalização, contrato do motor e catálogo, migration de templates e migration de documentos gerados.
Comece pela validação OOXML, armazenamento privado e serviço de geração temporária. Em seguida, conecte as telas de upload, revisão e acompanhamento; a regra de dados e a autorização permanecem no backend.
Checklist
- Criar
document_templatesglobal ou por campus, sem chave textual, com desativação. - Criar
template_versionscom coleção privada do Media Library para um DOCX por versão. - Implementar o fluxo de upload com inspeção e validação antes de disponibilizar a versão mais recente.
- Permitir upload DOCX somente ao vínculo autorizado do Setor de Estágio.
- Definir catálogo fixo de variáveis em português com
${NOME_DA_VARIAVEL}. - Implementar inspeção OOXML e validação de variáveis antes de disponibilizar uma versão.
- Adicionar
phpoffice/phpworde declararbrick/mathdiretamente no Composer; validar extensões PHP. - Validar os templates antes de disponibilizá-los, removendo dados fixos indevidos.
- Corrigir o template de credenciamento e reconstruir/renderizar a rescisão.
- Impedir alteração destrutiva e exclusão de versão já utilizada; permitir exclusão física da versão sem documentos gerados.
- Criar
generated_documentscom tipo, origem, status e snapshot quando gerado pelo SGE. - Registrar documento externo sem receber/armazenar arquivo e com template nulo.
- Gerar usando somente dados autorizados pelo contexto do estágio.
- Gerar em arquivo privado temporário, transmitir e apagar em
finally. - Implementar token idempotente e lock para retries/concorrência.
- Registrar geração no Activity Log.
- Controlar assinatura no documento, não no estágio.
- Ao marcar
Aguardando assinatura, exigir o local genérico onde o documento está disponível, sem citar plataforma fixa. - Exibir checkboxes dos interessados elegíveis e, quando selecionados, criar aviso de assinatura por e-mail e no sistema para quem possui conta.
- Acompanhar assinatura externa manualmente.
- Armazenar
protocol_numberretornado pelo SIGAA quando houver. - Tratar aditivo como
GeneratedDocumentType::Addendum. - Testar dados completos/opcionais, acentuação e versão ainda não validada.
- Testar marcadores em tabelas/cabeçalhos, arquivo malicioso, sobras e revisão visual de todas as páginas.
Critério de saída
- Templates e versões são imutáveis após uso.
- Nenhum arquivo final gerado ou fornecido pela concedente é armazenado pelo SGE.
- O status de cada documento é independente do status do estágio.