Author: |
Akretion,Odoo Community Association (OCA) |
License: |
AGPL-3 |
Branch: |
14.0-apm-sentry |
Repository: |
akretion/server-tools |
Dependencies: |
attachment_queue,
and
storage_backend |
Languages: |
HTML (358, 30.0%),
Python (435, 36.4%),
XML (336, 28.1%),
and
reStructuredText (65, 5.4%) |
Other branches: |
12-attachment-synchro,
12-mig-external_file_location,
12-mig-external_file_location_clement,
12.0-attachment-queue-improvements,
12.0-attachment_synchronize_pattimpex,
12.0-fix-attachment-queue-view,
12.0-jsonify_date_formatting,
12.0-module_analysis-deprecation-warning,
12.0-pygount-readme-requirements,
12.0-refactor-attachment-sync,
12.0_add_safe_eval_context,
14-onchange-helper-keep-computed-editable-field-value,
14.0,
14.0-ADD-attachment_restrict_deletion,
14.0-add-tracking_manager,
14.0-base_generate_code-manual,
14.0-mig-attachment_delete_restrict,
14.0-mig-attachment_synchronize,
14.0-mig-module_analysis,
14.0-mig-sentry-sdk,
14.0-pref-sentry,
14.0-sentry-perf,
14.0-sql_export-menu,
and
16.0-mig-attachment_synchronize |
Other repositories: |
AITIC/server-tools,
Callino/server-tools,
Change2improve/server-tools,
Comunitea/server-tools,
Digital5-Odoo/server-tools,
Dobtor-OCA/server-tools,
ERPLibre/server-tools,
ForgeFlow/server-tools,
GSLabIt/server-tools,
Ingeos/server-tools,
Jarsa/server-tools,
LevelPrime/server-tools,
NL66278/server-tools,
OCA/server-tools,
Rad0van/server-tools,
StefanRijnhart/server-tools,
Tecnativa/server-tools,
TimLai125/server-tools,
VanMoof/server-tools,
Vauxoo/server-tools,
YannickB/server-tools,
aaltinisik/server-tools,
acsone/server-tools,
anhvu-sg/server-tools,
aurestic/server-tools,
avoinsystems/server-tools,
blooparksystems/server-tools,
brain-tec/server-tools,
camptocamp/server-tools,
coopiteasy/server-tools,
diggy128/server-tools,
eLBati/server-tools,
ecosoft-odoo/server-tools,
grindtildeath/server-tools,
gurneyalex/server-tools,
hbrunn/server-tools,
hibou-io/oca-server-tools,
initOS/server-tools,
invitu/server-tools,
janverb/server-tools,
kmee/server-tools,
kos94ok-3D/server-tools,
legalsylvain/server-tools,
lideritjnma/server-tools,
lincersolucoes/oca-server-tools,
lonelyleaves/server-tools,
modoolar/server-tools,
multidadosti-erp/server-tools,
nilshamerlinck/server-tools,
njeudy/server-tools,
omalbastin/server-tools,
petrus-v/server-tools,
praxigento/oca-server-tools,
rdeheele/server-tools,
rsullivan2704/server-tools,
sergiocorato/server-tools,
steingabelgaard/server-tools,
sunflowerit/server-tools,
swbs-co/server-tools,
sysprocesarcastro/server-tools,
tafaRU/server-tools,
takinobori/oca-server-tools,
tegin/server-tools,
tirma-sa/server-tools,
trevi-software/server-tools,
ursais/server-tools,
ypapouin/server-tools,
zarumaru/server-tools,
and
zhaohuaw/server-tools |
<h1 class="title">Attachment Synchronize</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/server-tools/tree/14.0/attachment_synchronize"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-14-0/server-tools-14-0-attachment_synchronize"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/149/14.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module allows to <strong>import/export files</strong> from/to backend servers.</p>
<p>A backend server is defined by the basic <a class="reference external" href="https://github.com/OCA/storage/tree/12.0/storage_backend">storage_backend</a> OCA module, while it can be configured (amazon S3, sftp,...) with additional modules from the <a class="reference external" href="https://github.com/oca/storage">storage</a> repository.</p>
<p>The imported files (and the files to be exported) are stored in Odoo as <code>attachment.queue</code> objects, defined by the <a class="reference external" href="https://github.com/OCA/server-tools/tree/12.0/attachment_queue">attachment_queue</a> module while the importation itself (resp. exportation) is realized by <strong>"Attachments Import Tasks"</strong> (resp. "Attachments Export Tasks") defined by this current module.</p>
<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>As importation and exportation are different processes, they are triggered in different ways :</p>
<p><strong>To import files</strong>, you need to create an <em>"Attachment Import Task"</em> (menu <em>Settings > Technical > Attachments Import Tasks</em>) which defines :</p>
<ul class="simple">
<li>where to find the files to import from the backend server (path to the files, selection pattern)</li>
<li>what to do with the source files in the backend server (avoid duplicates, delete/rename after import...)</li>
<li>how the files will be processed once imported (through the <strong>File Type</strong> field).</li>
</ul>
<img alt="https://raw.githubusercontent.com/OCA/server-tools/14.0/attachment_synchronize/static/description/import_task.png" src="https://raw.githubusercontent.com/OCA/server-tools/14.0/attachment_synchronize/static/description/import_task.png" />
<blockquote class="epigraph">
🔎 The <strong>File Type</strong> options are defined by other modules built to process the Attachments Queues with the same "File Type".</blockquote>
<p><strong>To export files</strong>, you need first to register them as <em>"Attachments Queues"</em> objects linked to an <em>"Attachment Export Task"</em> (which set automatically their <strong>File Type</strong> to <em>"Export File (External Location)"</em>).</p>
<p>Then, you can export one file at a time from the <em>Attachment Queue</em>'s form view, or export all the <em>Attachments Queues</em> in a pending state related to the same <em>Export Task</em> from the given <em>Export Task</em> form view (menu <em>Settings > Technical > Attachments Export Tasks</em>) :</p>
<img alt="https://raw.githubusercontent.com/OCA/server-tools/14.0/attachment_synchronize/static/description/export_task.png" src="https://raw.githubusercontent.com/OCA/server-tools/14.0/attachment_synchronize/static/description/export_task.png" />
<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/server-tools/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20attachment_synchronize%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>Akretion</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id5">Contributors</a></h3>
<p><a class="reference external" href="https://www.akretion.com/">Akretion</a> :</p>
<ul class="simple">
<li>Valentin CHEMIERE</li>
<li>Mourad EL HADJ MIMOUNE <<a class="reference external" href="mailto:mourad.elhadj.mimoune@akretion.com">mourad.elhadj.mimoune@akretion.com</a>></li>
<li>Florian DA COSTA <<a class="reference external" href="mailto:florian.dacosta@akretion.com">florian.dacosta@akretion.com</a>></li>
<li>Clément MOMBEREAU <<a class="reference external" href="mailto:clement.mombereau@akretion.com.br">clement.mombereau@akretion.com.br</a>></li>
</ul>
<p>GS Lab:</p>
<ul class="simple">
<li>Giovanni SERRA <<a class="reference external" href="mailto:giovanni@gslab.it">giovanni@gslab.it</a>></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">maintainers</a>:</p>
<p><a class="reference external" href="https://github.com/florian-dacosta"><img alt="florian-dacosta" src="https://github.com/florian-dacosta.png?size=40px" /></a> <a class="reference external" href="https://github.com/sebastienbeau"><img alt="sebastienbeau" src="https://github.com/sebastienbeau.png?size=40px" /></a> <a class="reference external" href="https://github.com/GSLabIt"><img alt="GSLabIt" src="https://github.com/GSLabIt.png?size=40px" /></a> <a class="reference external" href="https://github.com/bealdav"><img alt="bealdav" src="https://github.com/bealdav.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/14.0/attachment_synchronize">OCA/server-tools</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>