[12.0][ADD] report_async

oca_dependencies.txt

@@ -1,6 +1,7 @@
 server-tools
 server-backend https://github.com/OCA/server-backend
 web
+queue
 # Until merge
 server-backend-mig-dbsource-sqlite https://github.com/Eficent/server-backend 12.0-mig-base_external_dbsource_sqlite
 server-backend-mig-dbsource-mysql https://github.com/Eficent/server-backend 12.0-mig-base_external_dbsource_mysql

report_async/__init__.py

@@ -0,0 +1,5 @@
+# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+
+from . import models
+from . import wizard

report_async/__manifest__.py

@@ -0,0 +1,27 @@
+# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+{
+    'name': 'Report Async',
+    'summary': 'Central place to run reports live or async',
+    'version': '12.0.1.0.0',
+    'author': 'Ecosoft, Odoo Community Association (OCA)',
+    'license': 'AGPL-3',
+    'website': 'https://github.com/OCA/reporting-engine',
+    'category': 'Generic Modules',
+    'depends': [
+        'queue_job',
+    ],
+    'data': [
+        'security/ir.model.access.csv',
+        'security/ir_rule.xml',
+        'data/mail_template.xml',
+        'views/report_async.xml',
+        'wizard/print_report_wizard.xml',
+    ],
+    'demo': [
+        'demo/report_async_demo.xml',
+    ],
+    'installable': True,
+    'maintainers': ['kittiu'],
+    'development_status': 'Beta',
+}

report_async/data/mail_template.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+    <data noupdate="1">
+        <record id="async_report_delivery" model="mail.template">
+            <field name="name">Report Async: New Report Available</field>
+            <field name="model_id" ref="base.model_ir_attachment"/>
+            <field name="subject">Your report is available, ${object.name}</field>
+            <field name="email_from">${object.company_id.partner_id.email_formatted|safe}</field>
+            <field name="partner_to">${user.partner_id.id}</field>
+            <field name="body_html" type="html">
+<table border="0" cellpadding="0" cellspacing="0" style="background-color: #F1F1F1; font-family:Verdana, Arial,sans-serif; color: #454748; width: 100%; border-collapse:separate;">
+    <tr>
+        <td align="center">
+            <table border="0" cellpadding="0" cellspacing="0" width="590" style="padding: 16px; background-color: white; color: #454748; border-collapse:separate;">
+                <tbody>
+                    <tr>
+                        <td align="center" style="min-width: 590px;">
+                            <table border="0" cellpadding="0" cellspacing="0" width="590" style="min-width: 590px; background-color: white; padding: 0px 8px 0px 8px; border-collapse:separate;">
+                                <tr>
+                                    <td valign="top" style="font-size: 13px;">
+                                        % set base_url = object.env['ir.config_parameter'].sudo().get_param('web.base.url')
+                                        % set download_url = '%s/web/content/ir.attachment/%s/datas/%s?download=true' % (base_url, object.id, object.name, )
+                                        <div>
+                                            Dear ${object.create_uid.partner_id.name or ''},
+                                            <br/><br/>
+                                            Your requested report, ${object.name}, is available for <b><a href='${download_url}'>download</a></b>.
+                                            <br/><br/>
+                                            Have a nice day!<br />
+                                            --<br/>${object.company_id.name}
+                                        </div>
+                                    </td>
+                                </tr>
+                            </table>
+                        </td>
+                    </tr>
+                </tbody>
+            </table>
+        </td>
+    </tr>
+</table>
+            </field>
+            <field name="auto_delete" eval="True"/>
+            <field name="user_signature" eval="False"/>
+        </record>
+    </data>
+</odoo>

report_async/demo/report_async_demo.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+
+    <record id="report_async_print_document" model="report.async">
+        <field name="action_id" eval="ref('report_async.action_print_report_wizard')"/>
+        <field name="allow_async" eval="0"/>
+    </record>
+
+</odoo>

report_async/models/__init__.py

@@ -0,0 +1,5 @@
+# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+
+from . import report_async
+from . import ir_report

report_async/models/ir_report.py

@@ -0,0 +1,28 @@
+# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+
+from odoo import api, models
+
+
+# Define all supported report_type
+REPORT_TYPES = ['qweb-pdf', 'qweb-text',
+                'qweb-xml', 'csv',
+                'excel', 'xlsx']
+
+
+class Report(models.Model):
+    _inherit = 'ir.actions.report'
+
+    @api.noguess
+    def report_action(self, docids, data=None, config=True):
+        res = super(Report, self).report_action(docids, data=data,
+                                                config=config)
+        if res['context'].get('async_process', False):
+            rpt_async_id = res['context']['active_id']
+            report_async = self.env['report.async'].browse(rpt_async_id)
+            if res['report_type'] in REPORT_TYPES:
+                report_async.with_delay().run_report(
+                    res['context'].get('active_ids', []), data,
+                    self.id, self._uid)
+                return {}
+        return res

report_async/models/report_async.py

@@ -0,0 +1,162 @@
+# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+
+import base64
+from odoo import api, fields, models, _
+from odoo.tools.safe_eval import safe_eval
+from odoo.exceptions import UserError
+from odoo.addons.queue_job.job import job
+
+
+# Define all supported report_type
+REPORT_TYPES_FUNC = {'qweb-pdf': 'render_qweb_pdf',
+                     'qweb-text': 'render_qweb_text',
+                     'qweb-xml': 'render_qweb_xml',
+                     'csv': 'render_csv',
+                     'excel': 'render_excel',
+                     'xlsx': 'render_xlsx', }
+
+
+class ReportAsync(models.Model):
+    _name = 'report.async'
+    _description = 'Report Async'
+
+    action_id = fields.Many2one(
+        comodel_name='ir.actions.act_window',
+        string='Reports',
+        required=True,
+    )
+    allow_async = fields.Boolean(
+        string='Allow Async',
+        default=False,
+        help="This is not automatic field, please check if you want to allow "
+        "this report in background process",
+    )
+    name = fields.Char(
+        string='Name',
+        related='action_id.display_name',
+    )
+    email_notify = fields.Boolean(
+        string='Email Notification',
+        help="Send email with link to report, when it is ready",
+    )
+    group_ids = fields.Many2many(
+        string='Groups',
+        comodel_name='res.groups',
+        help="Only user in selected groups can use this report."
+        "If left blank, everyone can use",
+    )
+    job_ids = fields.Many2many(
+        comodel_name='queue.job',
+        compute='_compute_job',
+        help="List all jobs related to this running report",
+    )
+    job_status = fields.Selection(
+        selection=[('pending', 'Pending'),
+                   ('enqueued', 'Enqueued'),
+                   ('started', 'Started'),
+                   ('done', 'Done'),
+                   ('failed', 'Failed')],
+        compute='_compute_job',
+        help="Latest Job Status",
+    )
+    job_info = fields.Text(
+        compute='_compute_job',
+        help="Latest Job Error Message",
+    )
+    file_ids = fields.Many2many(
+        comodel_name='ir.attachment',
+        compute='_compute_file',
+        help="List all files created by this report background process",
+    )
+
+    @api.multi
+    def _compute_job(self):
+        for rec in self:
+            rec.job_ids = self.sudo().env['queue.job'].search(
+                [('func_string', 'like', 'report.async(%s,)' % rec.id),
+                 ('user_id', '=', self._uid)],
+                order='id desc')
+            rec.job_status = (rec.job_ids[0].sudo().state
+                              if rec.job_ids else False)
+            rec.job_info = (rec.job_ids[0].sudo().exc_info
+                            if rec.job_ids else False)
+
+    @api.multi
+    def _compute_file(self):
+        files = self.env['ir.attachment'].search(
+            [('res_model', '=', 'report.async'),
+             ('res_id', 'in', self.ids),
+             ('create_uid', '=', self._uid)],
+            order='id desc')
+        for rec in self:
+            rec.file_ids = files.filtered(lambda l: l.res_id == rec.id)
+
+    def run_now(self):
+        self.ensure_one()
+        action = self.env.ref(self.action_id.xml_id)
+        result = action.read()[0]
+        ctx = safe_eval(result.get('context', {}))
+        ctx.update({'async_process': False})
+        result['context'] = ctx
+        return result
+
+    @api.multi
+    def run_async(self):
+        self.ensure_one()
+        if not self.allow_async:
+            raise UserError(_('Background process not allowed.'))
+        action = self.env.ref(self.action_id.xml_id)
+        result = action.read()[0]
+        ctx = safe_eval(result.get('context', {}))
+        ctx.update({'async_process': True})
+        result['context'] = ctx
+        return result
+
+    @api.multi
+    def view_files(self):
+        self.ensure_one()
+        action = self.env.ref('report_async.action_view_files')
+        result = action.read()[0]
+        result['domain'] = [('id', 'in', self.file_ids.ids)]
+        return result
+
+    @api.multi
+    def view_jobs(self):
+        self.ensure_one()
+        action = self.env.ref('queue_job.action_queue_job')
+        result = action.read()[0]
+        result['domain'] = [('id', 'in', self.job_ids.ids)]
+        result['context'] = {}
+        return result
+
+    @api.model
+    @job
+    def run_report(self, docids, data, report_id, user_id):
+        report = self.env['ir.actions.report'].browse(report_id)
+        func = REPORT_TYPES_FUNC[report.report_type]
+        # Run report
+        out_file, file_ext = getattr(report, func)(docids, data)
+        out_file = base64.b64encode(out_file)
+        out_name = '%s.%s' % (report.name, file_ext)
+        # Save report to attachment
+        attachment = self.env['ir.attachment'].sudo().create({
+            'name': out_name,
+            'datas': out_file,
+            'datas_fname': out_name,
+            'type': 'binary',
+            'res_model': 'report.async',
+            'res_id': self.id,
+        })
+        self._cr.execute("""
+            UPDATE ir_attachment SET create_uid = %s, write_uid = %s
+            WHERE id = %s""", (self._uid, self._uid, attachment.id))
+        # Send email
+        if self.email_notify:
+            self._send_email(attachment)
+
+    def _send_email(self, attachment):
+        template = self.env.ref('report_async.async_report_delivery')
+        template.send_mail(attachment.id,
+                           notif_layout='mail.mail_notification_light',
+                           force_send=False)

report_async/readme/CONTRIBUTORS.rst

@@ -0,0 +1 @@
+* Kitti U. <kittiu@ecosoft.co.th>

report_async/readme/DESCRIPTION.rst

@@ -0,0 +1,16 @@
+The new menu "Report Center" is the central place to host your reports in one place.
+From here, there are 2 ways to launch the report,
+
+1. Run Now - run report immediately as per normal.
+2. Run Background - put the report execution to queue job.
+
+By using the queue job, option 2 is great for long running report.
+The report file will be saved for later use, with the option to send report
+by email as soon as it is ready.
+
+Notes:
+
+* Only user with Technical Feature rights can manage the report.
+* Every internal user will have right to execute the report allowed for his/her groups.
+* The files created are owned and viewable only by the person who run the report.
+* Job queue manager can also see all jobs for each reports.

report_async/readme/USAGE.rst

@@ -0,0 +1,19 @@
+Menu: Dashboard > Report Center
+
+As Technical Feature users, you can manage reports for Report Center.
+
+- **Report:** choose the report (a window action). Although the option show all window actions
+  it only make sense for window actions that launch reports.
+- **Allow Async:** check this, if you want the report to run in background too, suitable for
+  report that return file as result, i.e., pdf/xlsx/csv/txt.
+- **Email Notification:** if checked, once the background process is completed, email with link to download
+  report will be sent.
+- **Groups:** select user groups allowed to use this report. If left blank, all user can use.
+
+As normal user, you can run your reports from Report Center
+
+- **Run Now button:** to run report immediately as per normal.
+- **Run Background button:** to run report asynchronously. Fall back to run now, if not report that produce file.
+- **Job Status:** show status of the latest run job. If job fail, exception error will also shown
+- **Files:** show all files being produced by the job as run by the user.
+- **Jobs:** show all jobs triggered by this report as run by the user. Only job queue manager have access to this button.

report_async/security/ir.model.access.csv

@@ -0,0 +1,3 @@
+"id","name","model_id:id","group_id:id","perm_read","perm_write","perm_create","perm_unlink"
+access_report_async,report.async.user,model_report_async,base.group_user,1,0,0,0
+access_report_async_sudo,report.async.sudo,model_report_async,base.group_no_one,1,1,1,1

report_async/security/ir_rule.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+    <record id="rule_report_async_access_by_group" model="ir.rule">
+        <field name="name">Report Async by Groups</field>
+        <field name="model_id" ref="model_report_async"/>
+        <field name="groups" eval="[(4, ref('base.group_user'))]"/>
+        <field name="perm_read" eval="True"/>
+        <field name="perm_create" eval="False"/>
+        <field name="perm_write" eval="False"/>
+        <field name="perm_unlink" eval="False"/>
+        <field name="domain_force">['|', ('group_ids', '=', False), ('group_ids', 'in', [g.id for g in user.groups_id])]</field>
+    </record>
+    <record id="rule_report_async_access_all" model="ir.rule">
+        <field name="name">Report Async by Groups</field>
+        <field name="model_id" ref="model_report_async"/>
+        <field name="groups" eval="[(4, ref('base.group_no_one'))]"/>
+        <field name="perm_read" eval="True"/>
+        <field name="perm_create" eval="True"/>
+        <field name="perm_write" eval="True"/>
+        <field name="perm_unlink" eval="True"/>
+        <field name="domain_force">[(1,'=', 1)]</field>
+    </record>
+</odoo>

report_async/static/description/index.html

@@ -0,0 +1,457 @@
+<?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>Scheduled Asynchronous Export</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="scheduled-asynchronous-export">
+<h1 class="title">Scheduled Asynchronous Export</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/queue/tree/12.0/export_async_schedule"><img alt="OCA/queue" src="https://img.shields.io/badge/github-OCA%2Fqueue-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/queue-12-0/queue-12-0-export_async_schedule"><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/230/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
+<p>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.</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>The configuration of a scheduled export is based on export lists.</p>
+<p>To create an export list:</p>
+<ul class="simple">
+<li>open the list view of the model to export</li>
+<li>select at least one record, and open “Action → Export”</li>
+<li>select the fields to export and save using “Save fields list”.</li>
+</ul>
+<p>To configure a scheduled export:</p>
+<ul class="simple">
+<li>open “Settings → Technical → Automation → Scheduled Exports”</li>
+<li>create a scheduled export by filling the form</li>
+</ul>
+<p>A Scheduled Action named “Send Scheduled Exports” checks every hour
+if Scheduled Exports have to be executed.</p>
+</div>
+<div class="section" id="usage">
+<h1><a class="toc-backref" href="#id2">Usage</a></h1>
+<p>When the configuration of a Scheduled Export is done, their execution
+is automatic.</p>
+<p>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 <tt class="docutils literal">attachment.ttl</tt>.</p>
+</div>
+<div class="section" id="known-issues-roadmap">
+<h1><a class="toc-backref" href="#id3">Known issues / Roadmap</a></h1>
+<ul class="simple">
+<li>We could configure a custom TTL (time-to-live) for each scheduled export</li>
+</ul>
+</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/queue/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/queue/issues/new?body=module:%20export_async_schedule%0Aversion:%2012.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>Guewen Baconnier (Camptocamp)</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>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
+<p><a class="reference external" href="https://github.com/guewen"><img alt="guewen" src="https://github.com/guewen.png?size=40px" /></a></p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/queue/tree/12.0/export_async_schedule">OCA/queue</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>

report_async/tests/__init__.py

@@ -0,0 +1 @@
+from . import test_report_async

report_async/tests/test_report_async.py

@@ -0,0 +1,56 @@
+# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+from odoo.tests import common
+from odoo.tests.common import Form
+from odoo.exceptions import UserError
+
+
+class TestJobChannel(common.TransactionCase):
+
+    def setUp(self):
+        super(TestJobChannel, self).setUp()
+        self.print_doc = self.env.ref('report_async.'
+                                      'report_async_print_document')
+        self.test_rec = self.env.ref('base.module_mail')
+        self.test_rpt = self.env.ref('base.ir_module_reference_print')
+
+    def _print_wizard(self, res):
+        obj = self.env[res['res_model']]
+        ctx = {'active_model': self.print_doc._name,
+               'active_id': self.print_doc.id, }
+        ctx.update(res['context'])
+        with Form(obj.with_context(ctx)) as form:
+            form.reference = '%s,%s' % (self.test_rec._name, self.test_rec.id)
+            form.action_report_id = self.test_rpt
+        print_wizard = form.save()
+        return print_wizard
+
+    def test_1_run_now(self):
+        """Run now will return report action as normal"""
+        res = self.print_doc.run_now()
+        report_action = self._print_wizard(res).print_report()
+        self.assertEquals(report_action['type'], 'ir.actions.report')
+
+    def test_2_run_async(self):
+        """Run background will return nothing, job started"""
+        with self.assertRaises(UserError):
+            self.print_doc.run_async()
+        self.print_doc.write({'allow_async': True,
+                              'email_notify': True})
+        res = self.print_doc.run_async()
+        print_wizard = self._print_wizard(res)
+        report_action = print_wizard.print_report()
+        self.assertEquals(report_action, {})  # Do not run report yet
+        self.assertEquals(self.print_doc.job_status, 'pending')  # Job started
+        # Test produce file (as queue will not run in test mode)
+        docids = [print_wizard.reference.id]
+        data = None
+        report_id = self.test_rpt.id
+        user_id = self.env.user.id
+        self.print_doc.run_report(docids, data, report_id, user_id)
+        # Check name of the newly producted file
+        # Note: on env with test-enable, always fall back to render_qweb_html
+        self.assertIn(self.test_rpt.name, self.print_doc.file_ids[0].name)
+        # View fileds/jobs
+        self.print_doc.view_files()
+        self.print_doc.view_jobs()

report_async/views/report_async.xml

@@ -0,0 +1,133 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+
+    <record id="view_report_async_tree" model="ir.ui.view">
+        <field name="name">report.async.tree</field>
+        <field name="model">report.async</field>
+        <field name="arch" type="xml">
+            <tree string="Report Center">
+                <field name="action_id"/>
+                <button type="object" name="run_now" string="Run Now" icon="fa-bolt"/>
+                <button type="object" name="run_async" string="Run Background" icon="fa-cogs"
+                  attrs="{'invisible': [('allow_async', '=', False)]}"/>
+                <button type="object" name="view_files" string="Files" icon="fa-copy"
+                  attrs="{'invisible': [('allow_async', '=', False)]}"/>
+                <field name="allow_async" invisible="1"/>
+                <field name="job_status"
+                  attrs="{'invisible': [('allow_async', '=', False)]}"/>
+                <field name="email_notify"/>
+            </tree>
+        </field>
+    </record>
+
+    <record id="view_report_async_form" model="ir.ui.view">
+        <field name="name">report.async.form</field>
+        <field name="model">report.async</field>
+        <field name="arch" type="xml">
+            <form>
+                <div class="alert alert-warning"
+                     role="alert"
+                     attrs="{'invisible': ['|', ('job_status', 'in', ['done', 'failed', False]),
+                                           ('allow_async', '=', False)]}"
+                     style="margin-bottom:0px;">
+                    <p>
+                        The report will be running by <i class="fa fa-cogs"/>
+                        <b>job</b>, and will be available at
+                        <i class="fa fa-copy"/><b> Files</b>
+                    </p>
+                </div>
+                <div class="alert alert-danger"
+                     role="alert"
+                     attrs="{'invisible': ['|', ('job_status', '!=', 'failed'),
+                                           ('allow_async', '=', False)]}"
+                     style="margin-bottom:0px;">
+                    <p>
+                        The last <i class="fa fa-cogs"/> <b>running job</b> was failed.
+                        Please contact your system administrator.
+                    </p>
+                </div>
+                <div class="alert alert-success"
+                     role="alert"
+                     attrs="{'invisible': ['|', ('job_status', '!=', 'done'),
+                                           ('allow_async', '=', False)]}"
+                     style="margin-bottom:0px;">
+                    <p>
+                        The last <i class="fa fa-cogs"/> <b>running job</b> was succeed.
+                        You can check the result in <i class="fa fa-copy"/><b> Files</b>
+                    </p>
+                </div>
+                <sheet>
+                    <div class="oe_read_only oe_right oe_button_box" name="buttons">
+                        <button type="object" name="run_now" string="Run Now" icon="fa-bolt"/>
+                        <button type="object" name="run_async" string="Run Background" icon="fa-cogs"
+                          attrs="{'invisible': [('allow_async', '=', False)]}"/>
+                        <button type="object" name="view_files" string="Files" icon="fa-copy"
+                          attrs="{'invisible': [('allow_async', '=', False)]}"/>
+                        <button type="object" name="view_jobs" string="Jobs" icon="fa-align-justify"
+                          groups="queue_job.group_queue_job_manager"
+                          attrs="{'invisible': [('allow_async', '=', False)]}"/>
+                    </div>
+                    <group>
+                        <group>
+                            <field name="action_id" options="{'no_open': True, 'no_create_edit': True}" />
+                            <field name="allow_async"/>
+                            <field name="email_notify"
+                              attrs="{'invisible': [('allow_async', '=', False)]}"/>
+                        </group>
+                        <group>
+                            <field name="job_status"
+                              attrs="{'invisible': [('allow_async', '=', False)]}"/>
+                            <field name="group_ids" widget="many2many_tags"/>
+                        </group>
+                        <group name="job_info" string="Last Run Job Error" colspan="2"
+                          attrs="{'invisible': ['|', ('job_info', '=', False), ('allow_async', '=', False)]}">
+                            <field nolabel="1" name="job_info"/>
+                        </group>
+                    </group>
+                </sheet>
+            </form>
+        </field>
+    </record>
+
+    <record id="view_report_async_search" model="ir.ui.view">
+        <field name="name">report.async.search</field>
+        <field name="model">report.async</field>
+        <field name="arch" type="xml">
+            <search string="Report Center">
+                <field name="action_id"/>
+            </search>
+        </field>
+    </record>
+
+    <record id="action_report_async" model="ir.actions.act_window">
+        <field name="name">Report Center</field>
+        <field name="type">ir.actions.act_window</field>
+        <field name="res_model">report.async</field>
+        <field name="view_type">form</field>
+        <field name="help">Run reports asyncronously</field>
+    </record>
+
+    <menuitem
+        id="menu_report_async"
+        parent="base.menu_board_root"
+        action="action_report_async"
+        sequence="10"/>
+
+    <record id="action_view_files" model="ir.actions.act_window">
+        <field name="name">Report Files</field>
+        <field name="type">ir.actions.act_window</field>
+        <field name="res_model">ir.attachment</field>
+        <field name="view_type">form</field>
+        <field name="view_id" eval="False"/>
+        <field name="search_view_id" ref="base.view_attachment_search"/>
+        <field name="view_mode">kanban,tree,form</field>
+        <field name="domain">[('res_model', '=', 'report.async'), ('create_uid', '=', uid)]</field>
+        <field name="help" type="html">
+            <p class="o_view_nocontent_smiling_face">
+                No files found
+            </p>
+        </field>
+    </record>
+
+
+</odoo>

report_async/wizard/__init__.py

@@ -0,0 +1,4 @@
+# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+
+from . import print_report_wizard

report_async/wizard/print_report_wizard.py

@@ -0,0 +1,43 @@
+# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+
+from odoo import fields, models, api
+
+
+class PrintReportWizard(models.TransientModel):
+    _name = 'print.report.wizard'
+    _description = 'Print Report Wizard'
+
+    reference = fields.Reference(
+        string='Document',
+        selection='_reference_models',
+        required=True,
+    )
+    action_report_id = fields.Many2one(
+        comodel_name='ir.actions.report',
+        string='Report Template',
+        required=True,
+    )
+
+    @api.model
+    def _reference_models(self):
+        excludes = ['res.company']
+        models = self.env['ir.model'].search([
+            ('state', '!=', 'manual'), ('transient', '=', False),
+            ('model', 'not in', excludes)])
+        return [(model.model, model.name) for model in models]
+
+    @api.onchange('reference')
+    def _onchange_reference(self):
+        self.ensure_one()
+        domain = [('id', 'in', [])]
+        self.action_report_id = False
+        if self.reference:
+            domain = [('model', '=', self.reference._name)]
+        return {'domain': {'action_report_id': domain}}
+
+    @api.multi
+    def print_report(self):
+        self.ensure_one()
+        return self.action_report_id.report_action(self.reference,
+                                                   config=False)

report_async/wizard/print_report_wizard.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+
+    <record id="print_report_wizard" model="ir.ui.view">
+        <field name="name">print.report.wizard</field>
+        <field name="model">print.report.wizard</field>
+        <field name="arch" type="xml">
+            <form>
+                <group>
+                    <group>
+                        <field name="reference"/>
+                    </group>
+                    <group>
+                        <field name="action_report_id" options="{'no_open': True, 'no_create_edit': True}"/>
+                    </group>
+                </group>
+                <footer>
+                    <button name="print_report"
+                            type="object" string="Execute"
+                            class="oe_highlight"/>
+                    <button special="cancel"
+                            string="Cancel"/>
+                </footer>
+            </form>
+        </field>
+    </record>
+
+    <record id="action_print_report_wizard" model="ir.actions.act_window">
+        <field name="name">Print Document</field>
+        <field name="res_model">print.report.wizard</field>
+        <field name="view_type">form</field>
+        <field name="view_mode">form</field>
+        <field name="target">new</field>
+    </record>
+
+</odoo>