Author: |
Camptocamp, Odoo Community Association (OCA) |
License: |
AGPL-3 |
Branch: |
12.0-import_asyn_batch-sbj |
Repository: |
acsone/queue |
Dependencies: |
base,
base_export_async,
and
queue_job |
Languages: |
HTML (367, 42.6%),
Python (315, 36.5%),
XML (105, 12.2%),
and
reStructuredText (75, 8.7%) |
Other branches: |
12.0,
and
12.0-prg_master |
Other repositories: |
Callino/queue,
Change2improve/queue,
Comunitea/queue,
DamonLiu0814/queue,
Digital5-Odoo/queue,
ERPLibre/queue,
Gabinete-Digital/queue,
Ingeos/queue,
Jarsa/queue,
NeatNerdPrime/queue,
OCA/queue,
Vauxoo/queue,
alsor62/queue,
anhvu-sg/queue,
aurestic/queue,
blueoceandevops/queue,
boskowski/odoo_oca_queue,
brain-tec/queue,
camptocamp/queue,
cogitoweb/queue,
coopiteasy/queue,
guewen/queue,
lideritjnma/queue,
nilshamerlinck/queue,
praxigento/oca-queue,
profumang/queue,
sahil-navadiya/queue,
steingabelgaard/queue,
sunflowerit/queue,
sunshineLhj/queue,
takinobori/oca-queue,
tegin/queue,
telesoho/queue,
thanhchatvn/queue,
themreza/queue,
tirma-sa/queue,
vrenaville/queue,
wjshan/queue,
and
xcgd/queue |
<h1 class="title">Scheduled Asynchronous Export</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/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>
<a name="configuration"></a>
<h2><a class="toc-backref" href="#id1">Configuration</a></h2>
<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>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id2">Usage</a></h2>
<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 <code>attachment.ttl</code>.</p>
<a name="known-issues-roadmap"></a>
<h2><a class="toc-backref" href="#id3">Known issues / Roadmap</a></h2>
<ul class="simple">
<li>We could configure a custom TTL (time-to-live) for each scheduled export</li>
</ul>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id4">Bug Tracker</a></h2>
<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>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id5">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id6">Authors</a></h3>
<ul class="simple">
<li>Camptocamp</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id7">Contributors</a></h3>
<ul class="simple">
<li>Guewen Baconnier (Camptocamp)</li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id8">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/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>