You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

61 lines
2.5 KiB

9 years ago
9 years ago
  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :alt: License: AGPL-3
  3. ================================
  4. Needaction counters in main menu
  5. ================================
  6. This module shows the sum of all submenus' needaction counters in main menus. This way, users get visual feedback where there's still work to do without having to open the respective menu beforehand.
  7. The counters are updated periodically, so users will also be notified if there are new records that require attention.
  8. Configuration
  9. =============
  10. To configure the update frequency, set the configuration parameter `web_menu_navbar_needaction.refresh_timeout` to the amount of milliseconds after which the counters should be updated. Don't do this too often, as this will cause a lot of queries to the database. The default it 600000, which is equivalent to 10 minutes.
  11. To disable updates, set the parameter to 0.
  12. For more fine-grained control over the menus, you can turn off needaction for a menu by setting its field `needaction` to `False`, or in case you need a different needaction domain, set `needaction_domain` on the menuitem to the domain you need. A side effect of this is that you can use this addon to add needaction capabilities to any model, independent of it implementing the respective mixin by simply filling in your domain there.
  13. Usage
  14. =====
  15. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  16. :alt: Try me on Runbot
  17. :target: https://runbot.odoo-community.org/runbot/162/8.0
  18. For further information, please visit:
  19. * https://www.odoo.com/forum/help-1
  20. Bug Tracker
  21. ===========
  22. Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
  23. In case of trouble, please check there if your issue has already been reported.
  24. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  25. `here <https://github.com/OCA/web/issues/new?body=module:%20web_menu_navbar_needaction%0Aversion:%208.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  26. Credits
  27. =======
  28. Contributors
  29. ------------
  30. * Holger Brunn <hbrunn@therp.nl>
  31. Maintainer
  32. ----------
  33. .. image:: https://odoo-community.org/logo.png
  34. :alt: Odoo Community Association
  35. :target: https://odoo-community.org
  36. This module is maintained by the OCA.
  37. OCA, or the Odoo Community Association, is a nonprofit organization whose
  38. mission is to support the collaborative development of Odoo features and
  39. promote its widespread use.
  40. To contribute to this module, please visit http://odoo-community.org.