Skip to main content

JobLog

Background job execution log.

Records job execution status and results for monitoring,
debugging, and audit purposes.

Attributes:
job_id: Unique job identifier from job queue
job_name: Name of the job function
status: Current status (queued/running/success/failed)
enqueued_at: When the job was added to queue
started_at: When the job started executing
completed_at: When the job finished
error: Error message if job failed
result: Job result data if successful

Source: job_log.py

Fields

FieldTypeRequiredDescriptionValidators
job_idstrUnique job identifier from job queueminLen: 1
job_namestrName of the job functionminLen: 1
statusstrJob status: queued, running, success, or failed-
enqueued_atdatetimeWhen the job was added to queue-
started_atdatetimeNoneWhen the job started executing
completed_atdatetimeNoneWhen the job finished (success or failure)
errorstrNoneError message if job failed
resultdict[str, Any]NoneJob result data if successful

Permissions

RoleCreateDeleteReadWrite
Admin
Employee
Manager

Configuration

SettingValue
SubmittableFalse
Track ChangesTrue

Controller

Controller hooks are implemented in *_controller.py files. Available lifecycle hooks:

  • validate() - Called before save, raise exceptions for validation errors
  • before_insert() - Called before inserting a new document
  • after_insert() - Called after successfully inserting
  • before_save() - Called before saving (insert or update)
  • after_save() - Called after saving
  • before_delete() - Called before deleting
  • after_delete() - Called after deleting