openboxes icon indicating copy to clipboard operation
openboxes copied to clipboard

Changes for calculateQuantityJob config option

Open jakkarth opened this issue 6 years ago • 1 comments

Using 0.8.6

Actual behavior:

calculateQuantityJob exists as a config option to determine how often the inventory snapshot table's contents are refreshed. The original default was once a day at midnight, but now that the calculation is faster, it can be increased to once every five minutes or even once a minute. However, this option is not documented anywhere.

Expected behavior:

  • Documentation about why changes aren't always immediately visible should be written/updated/bolded/put at the very top of the front page of the manual
  • calculateQuantityJob should be included in the example config in the documentation
  • calculateQuantityJob should have its meaning and format explained so users can specify their desired frequency easily (not everyone knows what a crontab is)
  • calculateQuantityJob should have a more sane default of every 5 minutes
  • The actual job for calculateQuantityJob should have locking to prevent multiple instances from running at the same time, so that even if the user enters too frequent a value for the system to keep up, it will simply update as fast as it's able

Steps to reproduce:

  1. Go to docs.openboxes.com and search for calculateQuantityJob.
  2. Note the lack of results.
  3. Go to the config file section of the docs and read through all of the options.
  4. Don't find calculateQuantityJob anywhere.

See also: #1016

jakkarth avatar Apr 26 '19 14:04 jakkarth

calculateQuantityJob has since been replaced with RefreshInventorySnapshotJob which is manually run. The point still stands though and we can afford to better document how our jobs work.

ewaterman avatar Nov 14 '25 18:11 ewaterman