diff --git a/export_async_schedule/README.rst b/export_async_schedule/README.rst new file mode 100644 index 0000000000..c2adaa34f3 --- /dev/null +++ b/export_async_schedule/README.rst @@ -0,0 +1,142 @@ +============================= +Scheduled Asynchronous Export +============================= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:170e4045b865c79a1eacbba69044d718814a3965bc3ad044ad2e4236f503153f + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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%2Fqueue-lightgray.png?logo=github + :target: https://github.com/OCA/queue/tree/17.0/export_async_schedule + :alt: OCA/queue +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/queue-17-0/queue-17-0-export_async_schedule + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/queue&target_branch=17.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +Add a new Automation feature: Scheduled Exports. Based on an export list +and a domain, an email is sent every X hours/days/weeks/months to a +selection of users. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +The configuration of a scheduled export is based on export lists. + +To create an export list: + +- open the list view of the model to export +- select at least one record, and open "Action → Export" +- select the fields to export and save using "Save fields list". + +To configure a scheduled export: + +- open "Settings → Technical → Automation → Scheduled Exports" +- create a scheduled export by filling the form + +A Scheduled Action named "Send Scheduled Exports" checks every hour if +Scheduled Exports have to be executed. + +Usage +===== + +When the configuration of a Scheduled Export is done, their execution is +automatic. + +Users will receive an email containing a link to download the exported +file at the specified frequency. The attachments stay in the database +for 7 days by default (it can be changed with the system parameter +``attachment.ttl``. + +Known issues / Roadmap +====================== + +- We could configure a custom TTL (time-to-live) for each scheduled + export + +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 to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Camptocamp +* ACSONE SA/NV + +Contributors +------------ + +- Guewen Baconnier (Camptocamp) +- `Komit `__: + + - Cuong Nguyen Mtm + +- Stéphane Mangin (ACSONE SA/NV) + +Other credits +------------- + +The migration of this module from 14.0 to 17.0 was financially supported +by: + +- ACSONE SA/NV (https://www.acsone.eu/) + +The migration of this module from 13.0 to 14.0 was financially supported +by: + +- Scaleway SAS (https://www.scaleway.com/) +- Komit (https://komit-consulting.com) + +Maintainers +----------- + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +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. + +.. |maintainer-guewen| image:: https://github.com/guewen.png?size=40px + :target: https://github.com/guewen + :alt: guewen + +Current `maintainer `__: + +|maintainer-guewen| + +This module is part of the `OCA/queue `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/export_async_schedule/__init__.py b/export_async_schedule/__init__.py new file mode 100644 index 0000000000..31660d6a96 --- /dev/null +++ b/export_async_schedule/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import models diff --git a/export_async_schedule/__manifest__.py b/export_async_schedule/__manifest__.py new file mode 100644 index 0000000000..c14ba8a5c3 --- /dev/null +++ b/export_async_schedule/__manifest__.py @@ -0,0 +1,24 @@ +# Copyright 2019 Camptocamp +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +{ + "name": "Scheduled Asynchronous Export", + "summary": "Generate and send exports by emails on a schedule", + "version": "17.0.1.0.0", + "author": "Camptocamp, ACSONE SA/NV, Odoo Community Association (OCA)", + "license": "AGPL-3", + "website": "https://github.com/OCA/queue", + "category": "Generic Modules", + "depends": [ + "base_export_async", + "queue_job", + ], + "data": [ + "data/ir_cron.xml", + "views/export_async_schedule_views.xml", + "security/ir.model.access.csv", + ], + "installable": True, + "maintainers": ["guewen"], + "development_status": "Beta", +} diff --git a/export_async_schedule/data/ir_cron.xml b/export_async_schedule/data/ir_cron.xml new file mode 100644 index 0000000000..edd4338e61 --- /dev/null +++ b/export_async_schedule/data/ir_cron.xml @@ -0,0 +1,17 @@ + + + + Send Scheduled Exports + + + + 1 + hours + -1 + + code + model.search([('next_execution', '<=', datetime.datetime.now())]).run_schedule() + + diff --git a/export_async_schedule/i18n/export_async_schedule.pot b/export_async_schedule/i18n/export_async_schedule.pot new file mode 100644 index 0000000000..8fc346d9ac --- /dev/null +++ b/export_async_schedule/i18n/export_async_schedule.pot @@ -0,0 +1,200 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * export_async_schedule +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 14.0\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: \n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__active +msgid "Active" +msgstr "" + +#. module: export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_search +msgid "All" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__export_format__csv +msgid "CSV" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__create_uid +msgid "Created by" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__create_date +msgid "Created on" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__interval_unit__days +msgid "Day(s)" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__display_name +msgid "Display Name" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__end_of_month +msgid "End Of Month" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__export_format__excel +msgid "Excel" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model,name:export_async_schedule.model_export_async_schedule +msgid "Export Async Schedule" +msgstr "" + +#. module: export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_form +msgid "Export Configuration" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__domain +msgid "Export Domain" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__export_format +msgid "Export Format" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__ir_export_id +msgid "Export List" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,help:export_async_schedule.field_export_async_schedule__lang +msgid "Exports will be translated in this language." +msgstr "" + +#. module: export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_search +msgid "Group By" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__interval_unit__hours +msgid "Hour(s)" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__id +msgid "ID" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__import_compat +msgid "Import-compatible Export" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__interval +msgid "Interval" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__lang +msgid "Language" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule____last_update +msgid "Last Modified on" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__write_uid +msgid "Last Updated by" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__write_date +msgid "Last Updated on" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__model_id +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_search +msgid "Model" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__model_name +msgid "Model Name" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__interval_unit__months +msgid "Month(s)" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__next_execution +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_search +msgid "Next Execution" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__user_ids +msgid "Recipients" +msgstr "" + +#. module: export_async_schedule +#: model_terms:ir.actions.act_window,help:export_async_schedule.action_export_async_schedule +msgid "Schedule Exports to send by email" +msgstr "" + +#. module: export_async_schedule +#: model:ir.actions.act_window,name:export_async_schedule.action_export_async_schedule +#: model:ir.ui.menu,name:export_async_schedule.menu_export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_search +msgid "Scheduled Exports" +msgstr "" + +#. module: export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_form +msgid "Scheduling" +msgstr "" + +#. module: export_async_schedule +#: model:ir.actions.server,name:export_async_schedule.ir_cron_export_async_schedule_ir_actions_server +#: model:ir.cron,cron_name:export_async_schedule.ir_cron_export_async_schedule +#: model:ir.cron,name:export_async_schedule.ir_cron_export_async_schedule +msgid "Send Scheduled Exports" +msgstr "" + +#. module: export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_form +msgid "Test Export" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__interval_unit +msgid "Unit" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__interval_unit__weeks +msgid "Week(s)" +msgstr "" diff --git a/export_async_schedule/i18n/fr.po b/export_async_schedule/i18n/fr.po new file mode 100644 index 0000000000..c59dd28c90 --- /dev/null +++ b/export_async_schedule/i18n/fr.po @@ -0,0 +1,203 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * export_async_schedule +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 14.0\n" +"Report-Msgid-Bugs-To: \n" +"PO-Revision-Date: 2021-02-09 17:45+0000\n" +"Last-Translator: Yann Papouin \n" +"Language-Team: none\n" +"Language: fr\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=n > 1;\n" +"X-Generator: Weblate 4.3.2\n" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__active +msgid "Active" +msgstr "Actif" + +#. module: export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_search +msgid "All" +msgstr "Tout" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__export_format__csv +msgid "CSV" +msgstr "CSV" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__create_uid +msgid "Created by" +msgstr "Créé par" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__create_date +msgid "Created on" +msgstr "Créé le" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__interval_unit__days +msgid "Day(s)" +msgstr "Jour(s)" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__display_name +msgid "Display Name" +msgstr "Nom affiché" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__end_of_month +msgid "End Of Month" +msgstr "Fin de mois" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__export_format__excel +msgid "Excel" +msgstr "Excel" + +#. module: export_async_schedule +#: model:ir.model,name:export_async_schedule.model_export_async_schedule +msgid "Export Async Schedule" +msgstr "Planification de l'export asynchrone" + +#. module: export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_form +msgid "Export Configuration" +msgstr "Configuration de l'export" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__domain +msgid "Export Domain" +msgstr "Domaine de l'export" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__export_format +msgid "Export Format" +msgstr "Format d'export" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__ir_export_id +msgid "Export List" +msgstr "Liste d'export" + +#. module: export_async_schedule +#: model:ir.model.fields,help:export_async_schedule.field_export_async_schedule__lang +msgid "Exports will be translated in this language." +msgstr "Les exports seront traduits dans cette langue." + +#. module: export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_search +msgid "Group By" +msgstr "Regrouper par" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__interval_unit__hours +msgid "Hour(s)" +msgstr "Heure(s)" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__id +msgid "ID" +msgstr "ID" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__import_compat +msgid "Import-compatible Export" +msgstr "Export compatible avec l'import" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__interval +msgid "Interval" +msgstr "Intervalle de temps" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__lang +msgid "Language" +msgstr "Langage" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule____last_update +msgid "Last Modified on" +msgstr "Dernière modification le" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__write_uid +msgid "Last Updated by" +msgstr "Dernière mise à jour par" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__write_date +msgid "Last Updated on" +msgstr "Dernière mise à jour le" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__model_id +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_search +msgid "Model" +msgstr "Modèle" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__model_name +msgid "Model Name" +msgstr "Nom du modèle" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__interval_unit__months +msgid "Month(s)" +msgstr "Mois" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__next_execution +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_search +msgid "Next Execution" +msgstr "Prochaine exécution" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__user_ids +msgid "Recipients" +msgstr "Destinataires" + +#. module: export_async_schedule +#: model_terms:ir.actions.act_window,help:export_async_schedule.action_export_async_schedule +msgid "Schedule Exports to send by email" +msgstr "Planifier les exports à envoyer par courriel" + +#. module: export_async_schedule +#: model:ir.actions.act_window,name:export_async_schedule.action_export_async_schedule +#: model:ir.ui.menu,name:export_async_schedule.menu_export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_search +msgid "Scheduled Exports" +msgstr "Exports planifiés" + +#. module: export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_form +msgid "Scheduling" +msgstr "Ordonnancement" + +#. module: export_async_schedule +#: model:ir.actions.server,name:export_async_schedule.ir_cron_export_async_schedule_ir_actions_server +#: model:ir.cron,cron_name:export_async_schedule.ir_cron_export_async_schedule +#: model:ir.cron,name:export_async_schedule.ir_cron_export_async_schedule +msgid "Send Scheduled Exports" +msgstr "Envoyer des exports planifiés" + +#. module: export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_form +msgid "Test Export" +msgstr "Export de test" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__interval_unit +msgid "Unit" +msgstr "Unité" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__interval_unit__weeks +msgid "Week(s)" +msgstr "Semaines(s)" diff --git a/export_async_schedule/i18n/it.po b/export_async_schedule/i18n/it.po new file mode 100644 index 0000000000..71f50eff3e --- /dev/null +++ b/export_async_schedule/i18n/it.po @@ -0,0 +1,201 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * export_async_schedule +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 14.0\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: Automatically generated\n" +"Language-Team: none\n" +"Language: it\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=n != 1;\n" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__active +msgid "Active" +msgstr "" + +#. module: export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_search +msgid "All" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__export_format__csv +msgid "CSV" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__create_uid +msgid "Created by" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__create_date +msgid "Created on" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__interval_unit__days +msgid "Day(s)" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__display_name +msgid "Display Name" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__end_of_month +msgid "End Of Month" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__export_format__excel +msgid "Excel" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model,name:export_async_schedule.model_export_async_schedule +msgid "Export Async Schedule" +msgstr "" + +#. module: export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_form +msgid "Export Configuration" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__domain +msgid "Export Domain" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__export_format +msgid "Export Format" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__ir_export_id +msgid "Export List" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,help:export_async_schedule.field_export_async_schedule__lang +msgid "Exports will be translated in this language." +msgstr "" + +#. module: export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_search +msgid "Group By" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__interval_unit__hours +msgid "Hour(s)" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__id +msgid "ID" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__import_compat +msgid "Import-compatible Export" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__interval +msgid "Interval" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__lang +msgid "Language" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule____last_update +msgid "Last Modified on" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__write_uid +msgid "Last Updated by" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__write_date +msgid "Last Updated on" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__model_id +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_search +msgid "Model" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__model_name +msgid "Model Name" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__interval_unit__months +msgid "Month(s)" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__next_execution +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_search +msgid "Next Execution" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__user_ids +msgid "Recipients" +msgstr "" + +#. module: export_async_schedule +#: model_terms:ir.actions.act_window,help:export_async_schedule.action_export_async_schedule +msgid "Schedule Exports to send by email" +msgstr "" + +#. module: export_async_schedule +#: model:ir.actions.act_window,name:export_async_schedule.action_export_async_schedule +#: model:ir.ui.menu,name:export_async_schedule.menu_export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_search +msgid "Scheduled Exports" +msgstr "" + +#. module: export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_form +msgid "Scheduling" +msgstr "" + +#. module: export_async_schedule +#: model:ir.actions.server,name:export_async_schedule.ir_cron_export_async_schedule_ir_actions_server +#: model:ir.cron,cron_name:export_async_schedule.ir_cron_export_async_schedule +#: model:ir.cron,name:export_async_schedule.ir_cron_export_async_schedule +msgid "Send Scheduled Exports" +msgstr "" + +#. module: export_async_schedule +#: model_terms:ir.ui.view,arch_db:export_async_schedule.view_export_async_schedule_form +msgid "Test Export" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields,field_description:export_async_schedule.field_export_async_schedule__interval_unit +msgid "Unit" +msgstr "" + +#. module: export_async_schedule +#: model:ir.model.fields.selection,name:export_async_schedule.selection__export_async_schedule__interval_unit__weeks +msgid "Week(s)" +msgstr "" diff --git a/export_async_schedule/models/__init__.py b/export_async_schedule/models/__init__.py new file mode 100644 index 0000000000..cb2b01369e --- /dev/null +++ b/export_async_schedule/models/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import export_async_schedule diff --git a/export_async_schedule/models/export_async_schedule.py b/export_async_schedule/models/export_async_schedule.py new file mode 100644 index 0000000000..a99030c6eb --- /dev/null +++ b/export_async_schedule/models/export_async_schedule.py @@ -0,0 +1,150 @@ +# Copyright 2019 Camptocamp +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from datetime import datetime + +from dateutil.relativedelta import relativedelta + +from odoo import api, fields, models +from odoo.tools.safe_eval import safe_eval + +from odoo.addons.base.models.res_partner import _lang_get + + +class ExportAsyncSchedule(models.Model): + _name = "export.async.schedule" + _description = "Export Async Schedule" + + active = fields.Boolean(default=True) + + # Export configuration + model_id = fields.Many2one( + comodel_name="ir.model", required=True, ondelete="cascade" + ) + model_name = fields.Char(related="model_id.model", string="Model Name") + user_ids = fields.Many2many( + string="Recipients", comodel_name="res.users", required=True + ) + domain = fields.Char(string="Export Domain", default=[]) + ir_export_id = fields.Many2one( + comodel_name="ir.exports", + string="Export List", + required=True, + domain="[('resource', '=', model_name)]", + ondelete="restrict", + ) + export_format = fields.Selection( + selection=[("csv", "CSV"), ("excel", "Excel")], + default="csv", + required=True, + ) + import_compat = fields.Boolean(string="Import-compatible Export") + lang = fields.Selection( + _lang_get, + string="Language", + default=lambda self: self.env.lang, + help="Exports will be translated in this language.", + ) + + # Scheduling + next_execution = fields.Datetime(default=fields.Datetime.now, required=True) + interval = fields.Integer(default=1, required=True) + interval_unit = fields.Selection( + selection=[ + ("hours", "Hour(s)"), + ("days", "Day(s)"), + ("weeks", "Week(s)"), + ("months", "Month(s)"), + ], + string="Unit", + default="months", + required=True, + ) + end_of_month = fields.Boolean() + + @api.depends("model_id", "ir_export_id") + def _compute_display_name(self): + for record in self: + record.display_name = f"{record.model_id.name}: {record.ir_export_id.name}" + + def run_schedule(self): + for record in self: + if record.next_execution > datetime.now(): + continue + record.action_export() + record.next_execution = record._compute_next_date() + + def _compute_next_date(self): + next_execution = self.next_execution + if next_execution < datetime.now(): + next_execution = datetime.now() + args = {self.interval_unit: self.interval} + if self.interval_unit == "months" and self.end_of_month: + # dateutil knows how to deal with variable days of months, + # it will put the latest possible day + args.update({"day": 31, "hour": 23, "minute": 59, "second": 59}) + return next_execution + relativedelta(**args) + + @api.onchange("end_of_month") + def onchange_end_of_month(self): + if self.end_of_month: + self.next_execution = self.next_execution + relativedelta( + day=31, hour=23, minute=59, second=59 + ) + + @api.model + def _get_fields_with_labels(self, model_name, export_fields): + self_fields = self.env[model_name]._fields + result = [] + for field_name in export_fields: + if "/" in field_name: + # The ir.exports.line model contains only the name of the + # field, and when we follow relations, the name of the fields + # joined by /. example: 'bank_ids/acc_number' + # Here, we follow the relations to get the labels + parts = field_name.split("/") + model_fields = self_fields + label_parts = [] + for cur_field_name in parts: + cur_field = model_fields[cur_field_name] + label_parts.append(cur_field._description_string(self.env)) + comodel_name = cur_field.comodel_name + if comodel_name: + model_fields = self.env[cur_field.comodel_name]._fields + label = "/".join(label_parts) + else: + label = self_fields[field_name]._description_string(self.env) + result.append({"label": label, "name": field_name}) + return result + + def _prepare_export_params(self): + export_fields = [ + export_field.name for export_field in self.ir_export_id.export_fields + ] + if self.import_compat: + export_fields = [ + {"label": export_field, "name": export_field} + for export_field in export_fields + ] + else: + export_fields = self._get_fields_with_labels( + self.model_name, + [export_field for export_field in export_fields], + ) + export_format = self.export_format == "excel" and "xlsx" or self.export_format + return { + "format": export_format, + "model": self.model_name, + "fields": export_fields, + "ids": False, + "domain": safe_eval(self.domain), + "context": self.env.context, + "import_compat": self.import_compat, + "user_ids": self.user_ids.ids, + } + + def action_export(self): + for record in self: + record = record.with_context(lang=record.lang) + params = record._prepare_export_params() + record.env["delay.export"].with_delay().export(params) diff --git a/export_async_schedule/pyproject.toml b/export_async_schedule/pyproject.toml new file mode 100644 index 0000000000..4231d0cccb --- /dev/null +++ b/export_async_schedule/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/export_async_schedule/readme/CONFIGURE.md b/export_async_schedule/readme/CONFIGURE.md new file mode 100644 index 0000000000..278b5b78a8 --- /dev/null +++ b/export_async_schedule/readme/CONFIGURE.md @@ -0,0 +1,15 @@ +The configuration of a scheduled export is based on export lists. + +To create an export list: + +- open the list view of the model to export +- select at least one record, and open "Action → Export" +- select the fields to export and save using "Save fields list". + +To configure a scheduled export: + +- open "Settings → Technical → Automation → Scheduled Exports" +- create a scheduled export by filling the form + +A Scheduled Action named "Send Scheduled Exports" checks every hour if Scheduled Exports +have to be executed. diff --git a/export_async_schedule/readme/CONTRIBUTORS.md b/export_async_schedule/readme/CONTRIBUTORS.md new file mode 100644 index 0000000000..60fc06800f --- /dev/null +++ b/export_async_schedule/readme/CONTRIBUTORS.md @@ -0,0 +1,4 @@ +- Guewen Baconnier (Camptocamp) +- [Komit](https://komit-consulting.com): + - Cuong Nguyen Mtm \ +- Stéphane Mangin (ACSONE SA/NV) \ No newline at end of file diff --git a/export_async_schedule/readme/CREDITS.md b/export_async_schedule/readme/CREDITS.md new file mode 100644 index 0000000000..3baa48e957 --- /dev/null +++ b/export_async_schedule/readme/CREDITS.md @@ -0,0 +1,9 @@ +The migration of this module from 14.0 to 17.0 was financially supported by: + +- ACSONE SA/NV () + + +The migration of this module from 13.0 to 14.0 was financially supported by: + +- Scaleway SAS () +- Komit () diff --git a/export_async_schedule/readme/DESCRIPTION.md b/export_async_schedule/readme/DESCRIPTION.md new file mode 100644 index 0000000000..ac4ef91777 --- /dev/null +++ b/export_async_schedule/readme/DESCRIPTION.md @@ -0,0 +1,2 @@ +Add a new Automation feature: Scheduled Exports. Based on an export list and a domain, +an email is sent every X hours/days/weeks/months to a selection of users. diff --git a/export_async_schedule/readme/ROADMAP.md b/export_async_schedule/readme/ROADMAP.md new file mode 100644 index 0000000000..a59070f728 --- /dev/null +++ b/export_async_schedule/readme/ROADMAP.md @@ -0,0 +1 @@ +- We could configure a custom TTL (time-to-live) for each scheduled export diff --git a/export_async_schedule/readme/USAGE.md b/export_async_schedule/readme/USAGE.md new file mode 100644 index 0000000000..aa2a06e205 --- /dev/null +++ b/export_async_schedule/readme/USAGE.md @@ -0,0 +1,5 @@ +When the configuration of a Scheduled Export is done, their execution is automatic. + +Users will receive an email containing a link to download the exported file at the +specified frequency. The attachments stay in the database for 7 days by default (it can +be changed with the system parameter `attachment.ttl`. diff --git a/export_async_schedule/security/ir.model.access.csv b/export_async_schedule/security/ir.model.access.csv new file mode 100644 index 0000000000..4e3a697a18 --- /dev/null +++ b/export_async_schedule/security/ir.model.access.csv @@ -0,0 +1,2 @@ +"id","name","model_id:id","group_id:id","perm_read","perm_write","perm_create","perm_unlink" +"access_export_async_schedule","export_async_schedule","model_export_async_schedule","base.group_system",1,1,1,1 diff --git a/export_async_schedule/static/description/icon.png b/export_async_schedule/static/description/icon.png new file mode 100644 index 0000000000..3a0328b516 Binary files /dev/null and b/export_async_schedule/static/description/icon.png differ diff --git a/export_async_schedule/static/description/index.html b/export_async_schedule/static/description/index.html new file mode 100644 index 0000000000..5e366aabf6 --- /dev/null +++ b/export_async_schedule/static/description/index.html @@ -0,0 +1,484 @@ + + + + + +Scheduled Asynchronous Export + + + +
+

Scheduled Asynchronous Export

+ + +

Beta License: AGPL-3 OCA/queue Translate me on Weblate Try me on Runboat

+

Add a new Automation feature: Scheduled Exports. Based on an export list +and a domain, an email is sent every X hours/days/weeks/months to a +selection of users.

+

Table of contents

+ +
+

Configuration

+

The configuration of a scheduled export is based on export lists.

+

To create an export list:

+
    +
  • open the list view of the model to export
    • +
  • select at least one record, and open “Action → Export”
    • +
  • select the fields to export and save using “Save fields list”.
    • +
+

To configure a scheduled export:

+
    +
  • open “Settings → Technical → Automation → Scheduled Exports”
    • +
  • create a scheduled export by filling the form
    • +
+

A Scheduled Action named “Send Scheduled Exports” checks every hour if +Scheduled Exports have to be executed.

+
+
+

Usage

+

When the configuration of a Scheduled Export is done, their execution is +automatic.

+

Users will receive an email containing a link to download the exported +file at the specified frequency. The attachments stay in the database +for 7 days by default (it can be changed with the system parameter +attachment.ttl.

+
+
+

Known issues / Roadmap

+
    +
  • We could configure a custom TTL (time-to-live) for each scheduled +export
    • +
+
+
+

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 to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Camptocamp
    • +
  • ACSONE SA/NV
    • +
+
+
+

Contributors

+ +
+
+

Other credits

+

The migration of this module from 14.0 to 17.0 was financially supported +by:

+ +

The migration of this module from 13.0 to 14.0 was financially supported +by:

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

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.

+

Current maintainer:

+

guewen

+

This module is part of the OCA/queue project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/export_async_schedule/tests/__init__.py b/export_async_schedule/tests/__init__.py new file mode 100644 index 0000000000..69f905f9cf --- /dev/null +++ b/export_async_schedule/tests/__init__.py @@ -0,0 +1 @@ +from . import test_export_async_schedule diff --git a/export_async_schedule/tests/test_export_async_schedule.py b/export_async_schedule/tests/test_export_async_schedule.py new file mode 100644 index 0000000000..ed44e9761e --- /dev/null +++ b/export_async_schedule/tests/test_export_async_schedule.py @@ -0,0 +1,189 @@ +# Copyright 2019 Camptocamp +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from datetime import datetime + +from dateutil.relativedelta import relativedelta + +from odoo.tests import common + +from odoo.addons.queue_job.tests.common import mock_with_delay + + +class TestExportAsyncSchedule(common.TransactionCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.Schedule = cls.env["export.async.schedule"] + cls._create_schedule() + + @classmethod + def _create_schedule(cls): + cls.ir_export = cls.env["ir.exports"].create( + { + "name": "test", + "resource": "res.partner", + "export_fields": [ + (0, 0, {"name": "display_name"}), + (0, 0, {"name": "email"}), + (0, 0, {"name": "phone"}), + (0, 0, {"name": "title/shortcut"}), + ], + } + ) + model = cls.env["ir.model"].search([("model", "=", "res.partner")]) + user = cls.env.ref("base.user_admin") + cls.schedule = cls.Schedule.create( + { + "model_id": model.id, + "user_ids": [(4, user.id)], + "domain": '[("is_company", "=", True)]', + "ir_export_id": cls.ir_export.id, + "export_format": "csv", + "import_compat": True, + "lang": "en_US", + } + ) + + def test_fields_with_labels(self): + export_fields = [ + "display_name", + "email", + "phone", + "title/shortcut", + "parent_id/company_id/name", + ] + result = self.env["export.async.schedule"]._get_fields_with_labels( + "res.partner", export_fields + ) + expected = [ + {"label": "Display Name", "name": "display_name"}, + {"label": "Email", "name": "email"}, + {"label": "Phone", "name": "phone"}, + {"label": "Title/Abbreviation", "name": "title/shortcut"}, + { + "label": "Related Company/Company/Company Name", + "name": "parent_id/company_id/name", + }, + ] + self.assertEqual(result, expected) + + def test_prepare_export_params_compatible(self): + prepared = self.schedule._prepare_export_params() + expected = { + "context": {}, + "domain": [("is_company", "=", True)], + # in 'import compatible' mode, the header (label) + # is equal to the field name + "fields": [ + {"label": "display_name", "name": "display_name"}, + {"label": "email", "name": "email"}, + {"label": "phone", "name": "phone"}, + {"label": "title/shortcut", "name": "title/shortcut"}, + ], + "format": "csv", + "ids": False, + "import_compat": True, + "model": "res.partner", + "user_ids": [self.env.ref("base.user_admin").id], + } + self.assertDictEqual(prepared, expected) + + def test_prepare_export_params_friendly(self): + self.schedule.import_compat = False + prepared = self.schedule._prepare_export_params() + expected = { + "context": {}, + "domain": [("is_company", "=", True)], + # in 'import compatible' mode, the header (label) + # is equal to the field name + "fields": [ + {"label": "Display Name", "name": "display_name"}, + {"label": "Email", "name": "email"}, + {"label": "Phone", "name": "phone"}, + {"label": "Title/Abbreviation", "name": "title/shortcut"}, + ], + "format": "csv", + "ids": False, + "import_compat": False, + "model": "res.partner", + "user_ids": [self.env.ref("base.user_admin").id], + } + self.assertDictEqual(prepared, expected) + + def test_schedule_next_date(self): + start_date = datetime.now() + relativedelta(hours=1) + + def assert_next_schedule(interval, unit, expected): + self.schedule.next_execution = start_date + self.schedule.interval = interval + self.schedule.interval_unit = unit + + self.assertEqual(self.schedule._compute_next_date(), expected) + + assert_next_schedule(1, "hours", start_date + relativedelta(hours=1)) + assert_next_schedule(2, "hours", start_date + relativedelta(hours=2)) + assert_next_schedule(1, "days", start_date + relativedelta(days=1)) + assert_next_schedule(2, "days", start_date + relativedelta(days=2)) + assert_next_schedule(1, "weeks", start_date + relativedelta(weeks=1)) + assert_next_schedule(2, "weeks", start_date + relativedelta(weeks=2)) + assert_next_schedule(1, "months", start_date + relativedelta(months=1)) + assert_next_schedule(2, "months", start_date + relativedelta(months=2)) + + self.schedule.end_of_month = True + assert_next_schedule( + 1, + "months", + start_date + relativedelta(months=1, day=31, hour=23, minute=59, second=59), + ) + assert_next_schedule( + 2, + "months", + start_date + relativedelta(months=2, day=31, hour=23, minute=59, second=59), + ) + + def test_run_schedule(self): + in_future = datetime.now() + relativedelta(minutes=1) + self.schedule.next_execution = in_future + self.schedule.run_schedule() + # nothing happened because we have not reached the next execution + self.assertEqual(self.schedule.next_execution, in_future) + + in_past = datetime.now() - relativedelta(minutes=1) + self.schedule.next_execution = in_past + self.schedule.run_schedule() + # it has been executed and the date changed to the next execution + self.assertGreater(self.schedule.next_execution, in_past) + + def test_delay_job(self): + with mock_with_delay() as (delayable_cls, delayable): + self.schedule.action_export() + + # check 'with_delay()' part: + self.assertEqual(delayable_cls.call_count, 1) + # arguments passed in 'with_delay()' + delay_args, __ = delayable_cls.call_args + self.assertEqual((self.env["delay.export"],), delay_args) + + # check what's passed to the job method 'export' + self.assertEqual(delayable.export.call_count, 1) + delay_args, delay_kwargs = delayable.export.call_args + expected_params = ( + { + "context": {"lang": "en_US"}, + "domain": [("is_company", "=", True)], + "fields": [ + {"label": "display_name", "name": "display_name"}, + {"label": "email", "name": "email"}, + {"label": "phone", "name": "phone"}, + {"label": "title/shortcut", "name": "title/shortcut"}, + ], + "format": "csv", + "ids": False, + "import_compat": True, + "model": "res.partner", + "user_ids": [2], + }, + ) + + self.assertEqual(delay_args, expected_params) diff --git a/export_async_schedule/views/export_async_schedule_views.xml b/export_async_schedule/views/export_async_schedule_views.xml new file mode 100644 index 0000000000..3fffd23940 --- /dev/null +++ b/export_async_schedule/views/export_async_schedule_views.xml @@ -0,0 +1,122 @@ + + + + export.async.schedule.tree + export.async.schedule + + + + + + + + + + + + + export.async.schedule.form + export.async.schedule + +
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + +
+ + + + + export.async.schedule.search + export.async.schedule + + + + + + + + + + + + + + + + + + + + Scheduled Exports + ir.actions.act_window + export.async.schedule + Schedule Exports to send by email + + + + diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000000..cb3962bde2 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1 @@ +odoo-addon-base_export_async @ git+https://github.com/OCA/queue.git@refs/pull/894/head#subdirectory=base_export_async