Browse Source

[11.0][MIG] record_archiver

pull/1381/head
Artem Kostyuk 6 years ago
parent
commit
fa1e50990c
  1. 64
      record_archiver/README.rst
  2. 16
      record_archiver/__manifest__.py
  3. 17
      record_archiver/__openerp__.py
  4. 30
      record_archiver/data/cron.xml
  5. 7
      record_archiver/models/ir_model.py
  6. 33
      record_archiver/models/record_lifespan.py
  7. 4
      record_archiver/readme/CONFIGURE.rst
  8. 3
      record_archiver/readme/CONTRIBUTORS.rst
  9. 4
      record_archiver/readme/DESCRIPTION.rst
  10. 4
      record_archiver/readme/ROADMAP.rst
  11. 2
      record_archiver/readme/USAGE.rst
  12. 0
      record_archiver/static/description/icon.png
  13. 443
      record_archiver/static/description/index.html
  14. 2
      record_archiver/tests/__init__.py
  15. 5
      record_archiver/tests/test_active_search.py
  16. 59
      record_archiver/tests/test_archive.py
  17. 96
      record_archiver/views/record_lifespan_view.xml

64
record_archiver/README.rst

@ -1,16 +1,40 @@
.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
================ ================
Records Archiver Records Archiver
================ ================
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
:target: https://github.com/OCA/server-tools/tree/11.0/record_archiver
:alt: OCA/server-tools
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/server-tools-11-0/server-tools-11-0-record_archiver
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/149/11.0
:alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5|
Create a cron job that deactivates old records in order to optimize Create a cron job that deactivates old records in order to optimize
performance. performance.
Records are deactivated based on their last activity (write_date). Records are deactivated based on their last activity (write_date).
**Table of contents**
.. contents::
:local:
Configuration Configuration
============= =============
@ -36,36 +60,40 @@ hook ``RecordLifespan._archive_domain`` can be extended.
Bug Tracker Bug Tracker
=========== ===========
Bugs are tracked on `GitHub Issues
<https://github.com/OCA/server-tools/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
<https://github.com/OCA/
server-tools/issues/new?body=module:%20
record_archiver%0Aversion:%20
9.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/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 <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**>`_.
Do not contact contributors directly about support or help with technical issues.
Credits Credits
======= =======
Authors
~~~~~~~
* Camptocamp
Contributors Contributors
------------
~~~~~~~~~~~~
* Yannick Vaucher <yannick.vaucher@camptocamp.com> * Yannick Vaucher <yannick.vaucher@camptocamp.com>
* Guewen Baconnier <guewen.baconnier@camptocamp.com> * Guewen Baconnier <guewen.baconnier@camptocamp.com>
Maintainer
----------
Maintainers
~~~~~~~~~~~
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png .. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association :alt: Odoo Community Association
:target: https://odoo-community.org :target: https://odoo-community.org
This module is maintained by the OCA.
OCA, or the Odoo Community Association, is a nonprofit organization whose OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and mission is to support the collaborative development of Odoo features and
promote its widespread use. promote its widespread use.
To contribute to this module, please visit http://odoo-community.org.
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/11.0/record_archiver>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

16
record_archiver/__manifest__.py

@ -0,0 +1,16 @@
# Copyright 2015 Yannick Vaucher (Camptocamp SA)
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
{
'name': 'Records Archiver',
'version': '11.0.1.0.0',
'author': 'Camptocamp, Odoo Community Association (OCA)',
'license': 'AGPL-3',
'category': 'misc',
'depends': ['base'],
'website': 'https://github.com/OCA/server-tools',
'data': [
'security/ir.model.access.csv',
'views/record_lifespan_view.xml',
'data/cron.xml',
],
}

17
record_archiver/__openerp__.py

@ -1,17 +0,0 @@
# -*- coding: utf-8 -*-
# © 2015 Yannick Vaucher (Camptocamp SA)
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
{'name': 'Records Archiver',
'version': '9.0.1.0.0',
'author': 'Camptocamp,Odoo Community Association (OCA)',
'license': 'AGPL-3',
'category': 'misc',
'depends': ['base'],
'website': 'www.camptocamp.com',
'data': ['views/record_lifespan_view.xml',
'data/cron.xml',
'security/ir.model.access.csv',
],
'installable': True,
'auto_install': False,
}

30
record_archiver/data/cron.xml

@ -1,19 +1,17 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<openerp>
<data noupdate="1">
<odoo noupdate="1">
<record forcecreate="True" id="ir_cron_record_archiver" model="ir.cron">
<field name="name">Records Archiver</field>
<field eval="True" name="active"/>
<field name="user_id" ref="base.user_root"/>
<field name="interval_number">1</field>
<field name="interval_type">months</field>
<field name="numbercall">-1</field>
<field eval="False" name="doall"/>
<field eval="'record.lifespan'" name="model"/>
<field eval="'_scheduler_archive_records'" name="function"/>
<field eval="'()'" name="args"/>
</record>
<record forcecreate="True" id="ir_cron_record_archiver" model="ir.cron">
<field name="name">Records Archiver</field>
<field name="active" eval="True"/>
<field name="user_id" ref="base.user_root"/>
<field name="interval_number">1</field>
<field name="interval_type">months</field>
<field name="numbercall">-1</field>
<field name="doall" eval="False"/>
<field name="model_id" ref="record_archiver.model_record_lifespan"/>
<field name="state">code</field>
<field name="code">model._scheduler_archive_records()</field>
</record>
</data>
</openerp>
</odoo>

7
record_archiver/models/ir_model.py

@ -1,7 +1,6 @@
# -*- coding: utf-8 -*-
# © 2015 Guewen Baconnier (Camptocamp SA)
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
from openerp import api, fields, models
# Copyright 2015 Guewen Baconnier (Camptocamp SA)
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
from odoo import api, fields, models
class IrModel(models.Model): class IrModel(models.Model):

33
record_archiver/models/record_lifespan.py

@ -1,25 +1,23 @@
# -*- coding: utf-8 -*-
# © 2015-2016 Yannick Vaucher (Camptocamp SA)
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
# Copyright 2015-2016 Yannick Vaucher (Camptocamp SA)
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
import logging import logging
from datetime import datetime from datetime import datetime
from dateutil.relativedelta import relativedelta from dateutil.relativedelta import relativedelta
from openerp import api, exceptions, fields, models
from openerp.tools.translate import _
from odoo import _, api, exceptions, fields, models
_logger = logging.getLogger(__name__) _logger = logging.getLogger(__name__)
class RecordLifespan(models.Model): class RecordLifespan(models.Model):
""" Configure records lifespans per model
"""Configure records lifespans per model.
After the lifespan is expired (compared to the `write_date` of the After the lifespan is expired (compared to the `write_date` of the
records), the records are deactivated. records), the records are deactivated.
""" """
_name = 'record.lifespan' _name = 'record.lifespan'
_order = 'model'
_order = 'model_name'
model_id = fields.Many2one( model_id = fields.Many2one(
'ir.model', 'ir.model',
@ -27,10 +25,10 @@ class RecordLifespan(models.Model):
required=True, required=True,
domain=[('has_an_active_field', '=', True)], domain=[('has_an_active_field', '=', True)],
) )
model = fields.Char(
model_name = fields.Char(
related='model_id.model', related='model_id.model',
readonly=True,
string='Model Name', string='Model Name',
store=True,
) )
months = fields.Integer( months = fields.Integer(
required=True, required=True,
@ -57,19 +55,19 @@ class RecordLifespan(models.Model):
@api.multi @api.multi
def _archive_domain(self, expiration_date): def _archive_domain(self, expiration_date):
""" Returns the domain used to find the records to archive.
"""Returns the domain used to find the records to archive.
Can be inherited to change the archived records for a model. Can be inherited to change the archived records for a model.
""" """
model = self.env[self.model_id.model] model = self.env[self.model_id.model]
domain = [('write_date', '<', expiration_date)] domain = [('write_date', '<', expiration_date)]
if 'state' in model._columns:
if 'state' in model.fields_get_keys():
domain += [('state', 'in', ('done', 'cancel'))] domain += [('state', 'in', ('done', 'cancel'))]
return domain return domain
@api.multi @api.multi
def _archive_lifespan_records(self): def _archive_lifespan_records(self):
""" Archive the records for a lifespan, so for a model.
"""Archive the records for a lifespan, so for a model.
Can be inherited to customize the archive strategy. Can be inherited to customize the archive strategy.
The default strategy is to change the field ``active`` to False The default strategy is to change the field ``active`` to False
@ -84,7 +82,7 @@ class RecordLifespan(models.Model):
if not isinstance(model, models.Model): if not isinstance(model, models.Model):
raise exceptions.UserError( raise exceptions.UserError(
_('Model %s not found') % model_name) _('Model %s not found') % model_name)
if 'active' not in model._columns:
if 'active' not in model.fields_get_keys():
raise exceptions.UserError( raise exceptions.UserError(
_('Model %s has no active field') % model_name) _('Model %s has no active field') % model_name)
@ -96,19 +94,14 @@ class RecordLifespan(models.Model):
if not recs: if not recs:
return return
# use a SQL query to bypass tracking always messages on write for
# object inheriting mail.thread
query = ("UPDATE %s SET active = FALSE WHERE id in %%s"
) % model._table
self.env.cr.execute(query, (tuple(recs.ids),))
recs.invalidate_cache()
recs.with_context(tracking_disable=True).toggle_active()
_logger.info( _logger.info(
'Archived %s %s older than %s', 'Archived %s %s older than %s',
len(recs.ids), model_name, expiration_date) len(recs.ids), model_name, expiration_date)
@api.multi @api.multi
def archive_records(self): def archive_records(self):
""" Call the archiver for several record lifespans """
"""Call the archiver for several record lifespans."""
for lifespan in self: for lifespan in self:
lifespan._archive_lifespan_records() lifespan._archive_lifespan_records()
return True return True

4
record_archiver/readme/CONFIGURE.rst

@ -0,0 +1,4 @@
You can configure lifespan of each type of record in
`Settings -> Configuration -> Records Archiver`
A different lifespan can be configured for each model.

3
record_archiver/readme/CONTRIBUTORS.rst

@ -0,0 +1,3 @@
* Yannick Vaucher <yannick.vaucher@camptocamp.com>
* Guewen Baconnier <guewen.baconnier@camptocamp.com>
* Artem Kostyuk <a.kostyuk@mobilunity.com>

4
record_archiver/readme/DESCRIPTION.rst

@ -0,0 +1,4 @@
Create a cron job that deactivates old records in order to optimize
performance.
Records are deactivated based on their last activity (write_date).

4
record_archiver/readme/ROADMAP.rst

@ -0,0 +1,4 @@
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.

2
record_archiver/readme/USAGE.rst

@ -0,0 +1,2 @@
Once the lifespans are configured, the cron will automatically
deactivate the old records.

0
record_archiver/static/src/img/icon.png → record_archiver/static/description/icon.png

Before

Width: 55  |  Height: 65  |  Size: 5.7 KiB

After

Width: 55  |  Height: 65  |  Size: 5.7 KiB

443
record_archiver/static/description/index.html

@ -0,0 +1,443 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
<title>Records Archiver</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
.subscript {
vertical-align: sub;
font-size: smaller }
.superscript {
vertical-align: super;
font-size: smaller }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
.align-top {
vertical-align: top }
.align-middle {
vertical-align: middle }
.align-bottom {
vertical-align: bottom }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="records-archiver">
<h1 class="title">Records Archiver</h1>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-tools/tree/11.0/record_archiver"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-11-0/server-tools-11-0-record_archiver"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/149/11.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>Create a cron job that deactivates old records in order to optimize
performance.</p>
<p>Records are deactivated based on their last activity (write_date).</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="id2">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id3">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id4">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id5">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id6">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id7">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id8">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
<p>You can configure lifespan of each type of record in
<cite>Settings -&gt; Configuration -&gt; Records Archiver</cite></p>
<p>A different lifespan can be configured for each model.</p>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id2">Usage</a></h1>
<p>Once the lifespans are configured, the cron will automatically
deactivate the old records.</p>
</div>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#id3">Known issues / Roadmap</a></h1>
<p>The default behavior is to archive all records having a <tt class="docutils literal">write_date</tt> &lt;
lifespan and with a state being <tt class="docutils literal">done</tt> or <tt class="docutils literal">cancel</tt>. If these rules
need to be modified for a model (e.g. change the states to archive), the
hook <tt class="docutils literal">RecordLifespan._archive_domain</tt> can be extended.</p>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id4">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
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
<a class="reference external" href="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**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#id5">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id6">Authors</a></h2>
<ul class="simple">
<li>Camptocamp</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id7">Contributors</a></h2>
<ul class="simple">
<li>Yannick Vaucher &lt;<a class="reference external" href="mailto:yannick.vaucher&#64;camptocamp.com">yannick.vaucher&#64;camptocamp.com</a>&gt;</li>
<li>Guewen Baconnier &lt;<a class="reference external" href="mailto:guewen.baconnier&#64;camptocamp.com">guewen.baconnier&#64;camptocamp.com</a>&gt;</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id8">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>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.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/11.0/record_archiver">OCA/server-tools</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>
</div>
</body>
</html>

2
record_archiver/tests/__init__.py

@ -1,4 +1,2 @@
# -*- coding: utf-8 -*-
from . import test_active_search from . import test_active_search
from . import test_archive from . import test_archive

5
record_archiver/tests/test_active_search.py

@ -1,7 +1,6 @@
# -*- coding: utf-8 -*-
# © 2015 Guewen Baconnier (Camptocamp SA)
# Copyright 2015 Guewen Baconnier (Camptocamp SA)
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html). # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
import openerp.tests.common as common
import odoo.tests.common as common
class TestActiveSearch(common.TransactionCase): class TestActiveSearch(common.TransactionCase):

59
record_archiver/tests/test_archive.py

@ -1,49 +1,52 @@
# -*- coding: utf-8 -*-
# © 2015 Guewen Baconnier (Camptocamp SA)
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
# Copyright 2015 Guewen Baconnier (Camptocamp SA)
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
from datetime import datetime, timedelta from datetime import datetime, timedelta
import openerp.tests.common as common
import odoo.tests.common as common
class TestArchive(common.TransactionCase):
class TestArchive(common.SavepointCase):
def setUp(self):
super(TestArchive, self).setUp()
Partner = self.env['res.partner']
self.partner1 = Partner.create(
at_install = False
post_install = True
@classmethod
def setUpClass(cls):
super().setUpClass()
cls.env = cls.env(context=dict(
cls.env.context,
tracking_disable=True,
))
Partner = cls.env['res.partner']
cls.partner1 = Partner.create(
{'name': 'test user 1'}) {'name': 'test user 1'})
self.partner2 = Partner.create(
cls.partner2 = Partner.create(
{'name': 'test user 2'}) {'name': 'test user 2'})
self.partner3 = Partner.create(
cls.partner3 = Partner.create(
{'name': 'test user 3'}) {'name': 'test user 3'})
old_date = datetime.now() - timedelta(days=365) old_date = datetime.now() - timedelta(days=365)
self.env.cr.execute(
cls.env.cr.execute(
'UPDATE res_partner SET write_date = %s ' 'UPDATE res_partner SET write_date = %s '
'WHERE id IN %s', (old_date, tuple([self.partner2.id,
self.partner3.id]))
'WHERE id IN %s', (old_date, tuple([cls.partner2.id,
cls.partner3.id]))
) )
self.Lifespan = self.env['record.lifespan']
self.model_id = self.ref('base.model_res_partner')
cls.Lifespan = cls.env['record.lifespan']
cls.model = cls.env.ref('base.model_res_partner')
@common.at_install(False)
@common.post_install(True)
def test_lifespan(self): def test_lifespan(self):
lifespan = self.Lifespan.create(
{'model_id': self.model_id,
'months': 3,
})
lifespan = self.Lifespan.create({
'model_id': self.model.id,
'months': 3,
})
lifespan.archive_records() lifespan.archive_records()
self.assertTrue(self.partner1.active) self.assertTrue(self.partner1.active)
self.assertFalse(self.partner2.active) self.assertFalse(self.partner2.active)
self.assertFalse(self.partner3.active) self.assertFalse(self.partner3.active)
@common.at_install(False)
@common.post_install(True)
def test_scheduler(self): def test_scheduler(self):
self.Lifespan.create(
{'model_id': self.model_id,
'months': 3,
})
self.Lifespan.create({
'model_id': self.model.id,
'months': 3,
})
self.Lifespan._scheduler_archive_records() self.Lifespan._scheduler_archive_records()
self.assertTrue(self.partner1.active) self.assertTrue(self.partner1.active)
self.assertFalse(self.partner2.active) self.assertFalse(self.partner2.active)

96
record_archiver/views/record_lifespan_view.xml

@ -1,56 +1,54 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<openerp>
<data>
<odoo>
<record id="view_record_lifespan_tree" model="ir.ui.view">
<field name="name">record.lifespan.tree</field>
<field name="model">record.lifespan</field>
<field name="arch" type="xml">
<tree string="Records Archiver Lifespans" editable="bottom">
<field name="model_id"/>
<field name="months"/>
</tree>
</field>
</record>
<record id="view_record_lifespan_tree" model="ir.ui.view">
<field name="name">record.lifespan.tree</field>
<field name="model">record.lifespan</field>
<field name="arch" type="xml">
<tree string="Records Archiver Lifespans" editable="bottom">
<field name="model_id"/>
<field name="months"/>
</tree>
</field>
</record>
<record id="view_record_lifespan_search" model="ir.ui.view">
<field name="name">record.lifespan.search</field>
<field name="model">record.lifespan</field>
<field name="arch" type="xml">
<search string="Records Archiver Lifespans">
<field name="model_id"/>
</search>
</field>
</record>
<record id="view_record_lifespan_search" model="ir.ui.view">
<field name="name">record.lifespan.search</field>
<field name="model">record.lifespan</field>
<field name="arch" type="xml">
<search string="Records Archiver Lifespans">
<field name="model_id"/>
</search>
</field>
</record>
<record model="ir.actions.act_window" id="action_record_lifespan_view">
<field name="name">Records Archiver Lifespans</field>
<field name="type">ir.actions.act_window</field>
<field name="res_model">record.lifespan</field>
<field name="view_type">form</field>
<field name="view_mode">tree</field>
<field name="search_view_id" ref="view_record_lifespan_search"/>
<field name="help" type="html">
<p class="oe_view_nocontent_create">
Click to define a new lifespan for a type of records.
</p><p>
Every record of model with a lifespan will be set to inactive
after the the defined months are elapsed. The lifespan is
based on the last write on a record.
</p>
</field>
</record>
<record model="ir.actions.act_window" id="action_record_lifespan_view">
<field name="name">Records Archiver Lifespans</field>
<field name="type">ir.actions.act_window</field>
<field name="res_model">record.lifespan</field>
<field name="view_type">form</field>
<field name="view_mode">tree</field>
<field name="search_view_id" ref="view_record_lifespan_search"/>
<field name="help" type="html">
<p class="oe_view_nocontent_create">
Click to define a new lifespan for a type of records.
</p><p>
Every record of model with a lifespan will be set to inactive
after the the defined months are elapsed. The lifespan is
based on the last write on a record.
</p>
</field>
</record>
<menuitem id="menu_record_archiver"
name="Record Archiver"
parent="base.menu_administration"
sequence="10"/>
<menuitem id="menu_record_archiver"
name="Record Archiver"
parent="base.menu_administration"
sequence="10"/>
<menuitem id="menu_record_lifespan_config"
name="Lifespans"
parent="menu_record_archiver"
sequence="20"
action="action_record_lifespan_view"/>
<menuitem id="menu_record_lifespan_config"
name="Lifespans"
parent="menu_record_archiver"
sequence="20"
action="action_record_lifespan_view"/>
</data>
</openerp>
</odoo>
Loading…
Cancel
Save