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.

100 lines
3.4 KiB

  1. ================
  2. Records Archiver
  3. ================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
  15. :target: https://github.com/OCA/server-tools/tree/11.0/record_archiver
  16. :alt: OCA/server-tools
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/server-tools-11-0/server-tools-11-0-record_archiver
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/149/11.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. Create a cron job that deactivates old records in order to optimize
  25. performance.
  26. Records are deactivated based on their last activity (write_date).
  27. **Table of contents**
  28. .. contents::
  29. :local:
  30. Configuration
  31. =============
  32. You can configure lifespan of each type of record in
  33. `Settings -> Configuration -> Records Archiver`
  34. A different lifespan can be configured for each model.
  35. Usage
  36. =====
  37. Once the lifespans are configured, the cron will automatically
  38. deactivate the old records.
  39. Known issues / Roadmap
  40. ======================
  41. The default behavior is to archive all records having a ``write_date`` <
  42. lifespan and with a state being ``done`` or ``cancel``. If these rules
  43. need to be modified for a model (e.g. change the states to archive), the
  44. hook ``RecordLifespan._archive_domain`` can be extended.
  45. Bug Tracker
  46. ===========
  47. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  48. In case of trouble, please check there if your issue has already been reported.
  49. If you spotted it first, help us smashing it by providing a detailed and welcomed
  50. `feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20record_archiver%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  51. Do not contact contributors directly about support or help with technical issues.
  52. Credits
  53. =======
  54. Authors
  55. ~~~~~~~
  56. * Camptocamp
  57. Contributors
  58. ~~~~~~~~~~~~
  59. * Yannick Vaucher <yannick.vaucher@camptocamp.com>
  60. * Guewen Baconnier <guewen.baconnier@camptocamp.com>
  61. * Artem Kostyuk <a.kostyuk@mobilunity.com>
  62. Maintainers
  63. ~~~~~~~~~~~
  64. This module is maintained by the OCA.
  65. .. image:: https://odoo-community.org/logo.png
  66. :alt: Odoo Community Association
  67. :target: https://odoo-community.org
  68. OCA, or the Odoo Community Association, is a nonprofit organization whose
  69. mission is to support the collaborative development of Odoo features and
  70. promote its widespread use.
  71. This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/11.0/record_archiver>`_ project on GitHub.
  72. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.