diff --git a/record_archiver/__openerp__.py b/record_archiver/__openerp__.py index 146313735..f76b83f4c 100644 --- a/record_archiver/__openerp__.py +++ b/record_archiver/__openerp__.py @@ -20,28 +20,80 @@ {'name': 'Records Archiver', 'version': '0.1', 'description': """ +Records Archiver +================ + Create a cron job that deactivates old records in order to optimize performance. Records are deactivated based on their last activity (write_date). +Configuration +============= + You can configure lifespan of each type of record in `Settings -> Configuration -> Records Archiver` -Lifespan is defined per record per company. +A different lifespan can be configured for each model. + +Usage +===== + +Once the lifespans are configured, the cron will automatically +deactivate the old records. + +Known issues / Roadmap +====================== + +The default behavior is to archive all records having a ``write_date`` < +lifespan and with a state being ``done`` or ``cancel``. If these rules +need to be modified for a model (e.g. change the states to archive), the +hook ``RecordLifespan._archive_domain`` can be extended. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues +`_. In case of trouble, +please check there if your issue has already been reported. If you +spotted it first, help us smashing it by providing a detailed and +welcomed feedback `here +`_. + + +Credits +======= + +Contributors +------------ + +* Yannick Vaucher +* Guewen Baconnier + +Maintainer +---------- + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +This module is maintained by the OCA. + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +To contribute to this module, please visit http://odoo-community.org. """, - 'author': 'Camptocamp', - 'maintainer': 'Camptocamp', + 'author': 'Camptocamp,Odoo Community Association (OCA)', 'license': 'AGPL-3', 'category': 'misc', - 'complexity': "easy", # easy, normal, expert 'depends': ['base'], 'website': 'www.camptocamp.com', 'data': ['views/record_lifespan_view.xml', 'data/cron.xml', 'security/ir.model.access.csv', ], - 'test': [], 'installable': True, 'auto_install': False, }