Search 1.9 billion lines of Odoo code on GitHub
connector
<h1 class="title">Connector</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/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/connector/tree/13.0/connector"><img alt="OCA/connector" src="https://img.shields.io/badge/github-OCA%2Fconnector-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/connector-13-0/connector-13-0-connector"><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/102/13.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This is a framework designed to build connectors with external systems,
usually called <code>Backends</code> in the documentation.</p>
<p>Documentation: <a class="reference external" href="http://odoo-connector.com">http://odoo-connector.com</a></p>
<p>It features:</p>
<ul>
<li><p class="first">A jobs queue</p>
<blockquote>
<p>In which the connectors can push functions (synchronization tasks)
to be executed later.</p>
</blockquote>
</li>
<li><p class="first">An event pattern</p>
<blockquote>
<p>The connectors can subscribe listener functions on the events,
executed when the events are fired.</p>
</blockquote>
</li>
<li><p class="first">Connector base classes</p>
<blockquote>
<p>Called <code>ConnectorUnit</code>.</p>
<p>Include base classes for the use in connectors, ready to be extended:</p>
<ul class="simple">
<li><code>Synchronizer</code>: flow of an import or export</li>
<li><code>Mapper</code>: transform a record according to mapping rules</li>
<li><code>Binder</code>: link external IDs with local IDS</li>
<li><code>BackendAdapter</code>: adapter interface for the exchanges with the backend</li>
<li>But <code>ConnectorUnit</code> can be extended to accomplish any task</li>
</ul>
</blockquote>
</li>
<li><p class="first">A multi-backend support</p>
<blockquote>
<p>Each <code>ConnectorUnit</code> can be registered amongst a backend type (eg.
Magento) and a backend version (allow to have a different <code>Mapper</code>
for each backend's version for instance)</p>
</blockquote>
</li>
</ul>
<p>It is used for example used to connect <a class="reference external" href="http://odoo-magento-connector.com">Magento</a> and <a class="reference external" href="https://github.com/OCA/connector-prestashop">Prestashop</a>, but
also used with Solr, CMIS, ...</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="id2">Usage</a></li>
<li><a class="reference internal" href="#changelog" id="id3">Changelog</a><ul>
<li><a class="reference internal" href="#next" id="id4">Next</a></li>
<li><a class="reference internal" href="#id1" id="id5">12.0.1.0.0 (2018-11-26)</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bug-tracker" id="id6">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id7">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id8">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id9">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id10">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id2">Usage</a></h2>
<p>This module does nothing on its own. It is a ground for developing
advanced connector modules. For further information, please go on:
<a class="reference external" href="http://odoo-connector.com">http://odoo-connector.com</a></p>
<a name="changelog"></a>
<h2><a class="toc-backref" href="#id3">Changelog</a></h2>
<a name="next"></a>
<h3><a class="toc-backref" href="#id4">Next</a></h3>
<a name="id1"></a>
<h3><a class="toc-backref" href="#id5">12.0.1.0.0 (2018-11-26)</a></h3>
<ul class="simple">
<li>[MIGRATION] from 12.0 branched at rev. 324e006</li>
</ul>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id6">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/connector/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/connector/issues/new?body=module:%20connector%0Aversion:%2013.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="#id7">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id8">Authors</a></h3>
<ul class="simple">
<li>Camptocamp</li>
<li>Openerp Connector Core Editors</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id9">Contributors</a></h3>
<p>Read the <a class="reference external" href="./AUTHORS">contributors list</a></p>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id10">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>This module is part of the <a class="reference external" href="https://github.com/OCA/connector/tree/13.0/connector">OCA/connector</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>