netbox/docs/plugins/development
Alexander Haase 4bba92617d
Closes #16971: Add system jobs (#17716)
* Fix check for existing jobs

If a job is to be enqueued once and no specific scheduled time is
specified, any scheduled time of existing jobs will be valid. Only if a
specific scheduled time is specified for 'enqueue_once()' can it be
evaluated.

* Allow system jobs to be registered

A new registry key allows background system jobs to be registered and
automatically scheduled when rqworker starts.

* Test scheduling of system jobs

* Fix plugins scheduled job documentation

The documentation reflected a non-production state of the JobRunner
framework left over from development. Now a more practical example
demonstrates the usage.

* Allow plugins to register system jobs

* Rename system job metadata

To clarify which meta-attributes belong to system jobs, each of them is
now prefixed with 'system_'.

* Add predefined job interval choices

* Remove 'system_enabled' JobRunner attribute

Previously, the 'system_enabled' attribute was used to control whether a
job should run or not. However, this can also be accomplished by
evaluating the job's interval.

* Fix test

* Use a decorator to register system jobs

* Specify interval when registering system job

* Update documentation

---------

Co-authored-by: Jeremy Stretch <jstretch@netboxlabs.com>
2024-11-01 14:56:08 -04:00
..
background-jobs.md Closes #16971: Add system jobs (#17716) 2024-11-01 14:56:08 -04:00
dashboard-widgets.md Improved docs for how to register dashboard widgets (#14913) 2024-01-26 14:15:28 -05:00
data-backends.md Closes #16971: Add system jobs (#17716) 2024-11-01 14:56:08 -04:00
event-types.md #16886: Updated documentation for event types 2024-07-31 15:54:31 -04:00
exceptions.md Closes #9075: Introduce AbortRequest exception for cleanly interrupting object mutations 2022-06-30 15:15:07 -04:00
filtersets.md Update filtersets.md 2022-08-28 13:53:53 +03:00
forms.md 16284 fix plugin forms doc 2024-05-28 09:07:32 -04:00
graphql-api.md 16014 Update incorrect django-graphene reference and add link to filtering docs. (#16015) 2024-05-08 14:29:54 -04:00
index.md 15093 Allow plugins to register events pipeline (#17717) 2024-10-18 12:47:16 -04:00
migration-v4.md Closes #15740: Fix typos and deprecated List in docs (#15741) 2024-04-17 08:28:03 -04:00
models.md 15692: Introduce background jobs (#16927) 2024-07-30 13:31:21 -04:00
navigation.md Remove old feature notifications 2024-04-02 14:14:58 -04:00
rest-api.md #17143: Update docs for nested serializer use 2024-08-30 10:18:29 -04:00
search.md Closes #14134: Display additional object attributes in global search results (#14154) 2023-11-09 16:21:09 -05:00
staged-changes.md Closes #17472: Deprecate the staged changes API 2024-10-10 14:32:39 -04:00
tables.md Remove old feature notifications 2024-04-02 14:14:58 -04:00
templates.md Closes #10604: Remove unused extra_tabs block from object.html generic template 2023-02-19 20:09:51 -05:00
views.md Documentation updates for v4.1 2024-07-31 16:26:21 -04:00