Skip to main content
Uma exportação começa no catálogo de recursos exportáveis e termina em um arquivo gerado em storage.

Fluxo imediato

Fluxo agendado

Etapas

EtapaAtorMomentoEfeito
Configurar catálogoBackOffice ou plataformaAntes de liberar o recursoDefine recurso, permissão, formatos, colunas, filtros e limites.
Solicitar exportaçãoUsuário autorizadoQuando precisa baixar dadosInforma recurso, formato, colunas, filtros e escopo.
Validar solicitaçãoSistemaAntes de criar job ou agendamentoConfere permissão, escopo, colunas e filtros contra o catálogo.
Criar jobSistemaExportação imediata ou execução de agendamentoCria ExportJob com status inicial.
ProcessarWorkerQuando o job entra na filaGera arquivo, conta linhas e preenche metadados.
BaixarUsuário solicitanteDepois de concluídoRecebe URL assinada derivada do fileKey.
Expirar ou cancelarSistema ou usuário autorizadoQuando arquivo ou solicitação não deve seguir ativaBloqueia download ou nova execução.

Regras

  • O recurso precisa existir como ExportResource ativo.
  • A permissão exigida pelo catálogo precisa estar no escopo do usuário.
  • As colunas solicitadas precisam ser subconjunto das colunas permitidas.
  • Os filtros precisam usar campos e operadores permitidos.
  • Colunas sensíveis exigem tratamento explícito no catálogo.
  • URL assinada é derivada no momento do download e não deve ser persistida.
  • ExportScheduled precisa ter scheduledAt futuro.
  • ExportScheduled executado cria um ExportJob com mesmo escopo, recurso, formato, colunas e filtros.
  • Jobs e agendamentos cancelados, expirados, concluídos ou removidos logicamente não executam novamente.

Status

ModeloStatus principais
ExportJobPENDING, QUEUED, RUNNING, COMPLETED, FAILED, EXPIRED, CANCELED
ExportScheduledSCHEDULED, COMPLETED, FAILED, CANCELED
Veja a modelagem em ExportJob.