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.

71 lines
2.0 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. ================
  5. Records Archiver
  6. ================
  7. Create a cron job that deactivates old records in order to optimize
  8. performance.
  9. Records are deactivated based on their last activity (write_date).
  10. Configuration
  11. =============
  12. You can configure lifespan of each type of record in
  13. `Settings -> Configuration -> Records Archiver`
  14. A different lifespan can be configured for each model.
  15. Usage
  16. =====
  17. Once the lifespans are configured, the cron will automatically
  18. deactivate the old records.
  19. Known issues / Roadmap
  20. ======================
  21. The default behavior is to archive all records having a ``write_date`` <
  22. lifespan and with a state being ``done`` or ``cancel``. If these rules
  23. need to be modified for a model (e.g. change the states to archive), the
  24. hook ``RecordLifespan._archive_domain`` can be extended.
  25. Bug Tracker
  26. ===========
  27. Bugs are tracked on `GitHub Issues
  28. <https://github.com/OCA/server-tools/issues>`_. In case of trouble, please
  29. check there if your issue has already been reported. If you spotted it first,
  30. help us smashing it by providing a detailed and welcomed `feedback
  31. <https://github.com/OCA/
  32. server-tools/issues/new?body=module:%20
  33. record_archiver%0Aversion:%20
  34. 9.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  35. Credits
  36. =======
  37. Contributors
  38. ------------
  39. * Yannick Vaucher <yannick.vaucher@camptocamp.com>
  40. * Guewen Baconnier <guewen.baconnier@camptocamp.com>
  41. Maintainer
  42. ----------
  43. .. image:: https://odoo-community.org/logo.png
  44. :alt: Odoo Community Association
  45. :target: https://odoo-community.org
  46. This module is maintained by the OCA.
  47. OCA, or the Odoo Community Association, is a nonprofit organization whose
  48. mission is to support the collaborative development of Odoo features and
  49. promote its widespread use.
  50. To contribute to this module, please visit http://odoo-community.org.