Reporting & Export Workflow
Reporting & Export Workflow
Section titled “Reporting & Export Workflow”Objetivo
Section titled “Objetivo”O Reporting & Export Workflow gera relatórios versionados, exports estruturados e artefatos de auditoria a partir dos artefatos aprovados do assessment. Ele não decide compliance, não altera SoA, Gap Analysis, Maturity Assessment ou POA&M, e não usa Vectorize como fonte normativa.
Tipos de Relatório e Export
Section titled “Tipos de Relatório e Export”Tipos de relatório suportados no contrato:
full_assessment_reportexecutive_summarysoa_exportgap_analysis_reportmaturity_reportpoam_reportaudit_packagemachine_readable_export
Formatos suportados no contrato:
jsonmarkdownhtmldocxpdfcsvxlsxzip
O MVP implementa JSON e Markdown. HTML é derivado simples de Markdown. DOCX/PDF ficam como interface e placeholders documentados para renderer server-side futuro.
Fontes Exigidas
Section titled “Fontes Exigidas”full_assessment_report exige:
- SoA
approved; - Gap Analysis
approved; - Maturity Assessment
approvedou limitação registrada; - POA&M
approvedou limitação registrada.
SoA e Gap Analysis ausentes ou não aprovados bloqueiam o relatório completo por padrão. Maturity e POA&M podem ficar ausentes no MVP, desde que a limitação seja preservada em metadata.limitations.
Relatórios parciais podem usar o artefato aprovado correspondente.
Versionamento e Imutabilidade
Section titled “Versionamento e Imutabilidade”report_versions usa draft, under_review, approved, superseded e archived. Relatório aprovado é imutável. Alterações após aprovação exigem nova versão. Quando uma nova versão do mesmo report_type é aprovada, versões aprovadas anteriores podem ser marcadas como superseded.
Cada versão preserva:
source_soa_version_id;source_gap_analysis_version_id;source_maturity_assessment_version_id, quando houver;source_poam_version_id, quando houver;framework_id;scf_version_id;trace_id.
Estrutura do Relatório Completo
Section titled “Estrutura do Relatório Completo”O relatório completo contém seções mínimas:
- Cover / Metadata
- Executive Summary
- Assessment Scope
- Methodology
- SCF and Framework Basis
- Statement of Applicability Summary
- Evidence and Gap Analysis Summary
- Detailed Gap Findings
- Maturity Assessment Summary
- Maturity by Domain
- POA&M Summary
- Detailed POA&M
- Limitations and Assumptions
- Traceability Appendix
- Evidence Index
- Approval and Version History
Evidência e Rastreabilidade
Section titled “Evidência e Rastreabilidade”O relatório não inclui documentos completos por padrão. O índice de evidências usa referências seguras: IDs de finding, SoA item, documento/chunk quando disponíveis e snippets/resumos curtos.
Toda afirmação relevante deve apontar para artefato-fonte ou aparecer como limitação, premissa ou recomendação. Vector search continua sendo apenas mecanismo de recuperação da KB; a base normativa permanece em packages/scf-core.
Storage R2-Compatible
Section titled “Storage R2-Compatible”report_artifacts registra metadados de armazenamento e content_hash. O storage adapter local usa provider r2_compatible_mock e chave segura:
tenants/{tenant_id}/organizations/{organization_id}/assessments/{assessment_id}/reports/{report_version_id}/{artifact_type}.{format}Download URL é placeholder e respeita tenant/assessment, com expiração documentada.
Segurança e Multi-Tenancy
Section titled “Segurança e Multi-Tenancy”Todo serviço exige tenant_id, organization_id, assessment_id e trace_id. Criação, renderização, storage e aprovação exigem actor_id. Repositórios in-memory filtram por tenant e assessment. Export sem tenant context é bloqueado.
Integrações
Section titled “Integrações”- Assessment Engine: a API avança para
report_generatedquando a transição está disponível. O approval formal usa gatereport. - SoA: o relatório inclui contagens por
applicability_status. - Gap Analysis: o relatório inclui resumo por status e findings detalhados.
- Maturity: integração preparada por provider opcional.
- POA&M: o relatório inclui ações por prioridade, status, owner role, evidências esperadas e critérios de aceite quando há versão aprovada.
- SCF Data Service:
framework_idescf_version_idsão preservados; mappings não são inventados.
Limitações do MVP
Section titled “Limitações do MVP”- Repositórios são in-memory.
- JSON e Markdown são os formatos reais implementados.
- DOCX/PDF são placeholders.
- Export jobs são executados de forma síncrona no mock, embora o contrato represente fila/job.
- Audit log persistente ainda é placeholder no API Gateway.
packages/maturityainda não existe; a maturidade é provider opcional.- Storage R2 real depende de adapter Cloudflare futuro.
Decisões em Aberto
Section titled “Decisões em Aberto”- Renderer final de PDF/DOCX e ambiente de execução.
- Adapter PostgreSQL transacional para reporting.
- Política formal de audit package ZIP e inclusão controlada de evidências completas.
- Fechamento automático do assessment após report aprovado versus aprovação manual final.