Author: |
Ecosoft, Odoo Community Association (OCA) |
License: |
AGPL-3 |
Branch: |
14.0 |
Repository: |
acsone/reporting-engine |
Dependencies: |
queue_job |
Languages: |
HTML (374, 34.5%),
Python (292, 26.9%),
XML (325, 30.0%),
and
reStructuredText (93, 8.6%) |
Other branches: |
12.0,
12.0-ref_report_py3o_python_3.9-mle,
12.0-report_substitute_generate_email-qgr,
13.0,
13.0-ref_report_py3o_python_3.11_tbi,
14.0-imp_report_qweb_signer_allowed_reports_tbi,
and
add-report_py3o_signer-lco |
Other repositories: |
AITIC/reporting-engine,
Change2improve/reporting-engine,
Comunitea/reporting-engine,
DamonLiu0814/reporting-engine,
Darknroses/reporting-engine,
Digital5-Odoo/reporting-engine,
Dobtor-OCA/reporting-engine,
EBII/reporting-engine,
ERPLibre/reporting-engine,
ForgeFlow/reporting-engine,
Ingeos/reporting-engine,
Jarsa/reporting-engine,
NeatNerdPrime/reporting-engine,
NextERP-Romania/reporting-engine,
Nubeo-be/reporting-engine,
OCA-MUK/reporting-engine,
OCA/reporting-engine,
Rad0van/reporting-engine,
StefanRijnhart/reporting-engine,
Studio73/reporting-engine,
Tecnativa/reporting-engine,
Vauxoo/reporting-engine,
aaltinisik/reporting-engine,
akretion/reporting-engine,
anhvu-sg/reporting-engine,
aurestic/reporting-engine,
blooparksystems/reporting-engine,
bmya/reporting-engine-1,
brain-tec/reporting-engine,
budisentosa/reporting-engine,
coopiteasy/reporting-engine,
dcorio/reporting-engine,
druidoo-dev/reporting-engine,
ecosoft-odoo/queue,
ecosoft-odoo/reporting-engine,
flachica/reporting-engine,
gbertolani/reporting-engine,
goyugo/reporting-engine,
gurneyalex/reporting-engine,
ilyasProgrammer/reporting-engine,
initOS/reporting-engine,
johnbendi/reporting-engine,
kmee/reporting-engine,
legalsylvain/reporting-engine,
lideritjnma/reporting-engine,
lweiming/reporting-engine,
multidadosti-erp/reporting-engine,
oondeo/reporting-engine,
praxigento/oca-reporting-engine,
robertsvx27/reporting-engine,
sacostaylara/reporting-engine,
sanube/reporting-engine,
sendalpegat/reporting-engine,
sergiocorato/reporting-engine,
sgheller/reporting-engine,
sunflowerit/reporting-engine,
suwatuanp/reporting-engine,
syci/reporting-engine,
takinobori/oca-reporting-engine,
tbaden/reporting-engine,
tegin/reporting-engine,
tirma-sa/reporting-engine,
ursais/reporting-engine,
versada/reporting-engine,
vikichavada/reporting-engine,
xcgd/reporting-engine,
and
zhaohuaw/reporting-engine |
<h1 class="title">Report Async</h1>
<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/reporting-engine/tree/14.0/report_async"><img alt="OCA/reporting-engine" src="https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/reporting-engine-14-0/reporting-engine-14-0-report_async"><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/143/14.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>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,</p>
<ol class="arabic simple">
<li>Run Now - run report immediately as per normal.</li>
<li>Run Background - put the report execution to queue job.</li>
</ol>
<p>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.</p>
<p>Notes:</p>
<ul class="simple">
<li>Only user with Technical Feature rights can manage the report.</li>
<li>Every internal user will have right to execute the report allowed for his/her groups.</li>
<li>The files created are owned and viewable only by the person who run the report.</li>
<li>Job queue manager can also see all jobs for each reports.</li>
</ul>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id1">Usage</a></h2>
<p>Menu: Dashboard > Report Center</p>
<p>As Technical Feature users, you can manage reports for Report Center.</p>
<ul class="simple">
<li><strong>Report:</strong> choose the report (a window action). Although the option show all window actions
it only make sense for window actions that launch reports.</li>
<li><strong>Allow Async:</strong> 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.</li>
<li><strong>Email Notification:</strong> if checked, once the background process is completed, email with link to download
report will be sent.</li>
<li><strong>Groups:</strong> select user groups allowed to use this report. If left blank, all user can use.</li>
</ul>
<p>As normal user, you can run your reports from Report Center</p>
<ul class="simple">
<li><strong>Run Now button:</strong> to run report immediately as per normal.</li>
<li><strong>Run Background button:</strong> to run report asynchronously. Fall back to run now, if not report that produce file.</li>
<li><strong>Job Status:</strong> show status of the latest run job. If job fail, exception error will also shown</li>
<li><strong>Files:</strong> show all files being produced by the job as run by the user.</li>
<li><strong>Jobs:</strong> show all jobs triggered by this report as run by the user. Only job queue manager have access to this button.</li>
</ul>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id2">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/reporting-engine/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/reporting-engine/issues/new?body=module:%20report_async%0Aversion:%2014.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>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id3">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id4">Authors</a></h3>
<ul class="simple">
<li>Ecosoft</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id5">Contributors</a></h3>
<ul class="simple">
<li><a class="reference external" href="http://ecosoft.co.th">Ecosoft</a>:<ul>
<li>Kitti U. <<a class="reference external" href="mailto:kittiu@ecosoft.co.th">kittiu@ecosoft.co.th</a>></li>
<li>Saran Lim. <<a class="reference external" href="mailto:saranl@ecosoft.co.th">saranl@ecosoft.co.th</a>></li>
<li>Tharathip Chaweewongphan <<a class="reference external" href="mailto:tharathipc@ecosoft.co.th">tharathipc@ecosoft.co.th</a>></li>
</ul>
</li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id6">Maintainers</a></h3>
<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/kittiu"><img alt="kittiu" src="https://github.com/kittiu.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/14.0/report_async">OCA/reporting-engine</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>