Search 1.9 billion lines of Odoo code on GitHub
edi_oca
<h1 class="title">EDI</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/edi/tree/14.0/edi_oca"><img alt="OCA/edi" src="https://img.shields.io/badge/github-OCA%2Fedi-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/edi-14-0/edi-14-0-edi_oca"><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/226/14.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>Base EDI backend.</p>
<p>Provides following models:</p>
<ol class="arabic simple">
<li>EDI Backend, to centralize configuration</li>
<li>EDI Backend Type, to classify EDI backends (eg: UBL, GS1, e-invoice, pick-yours)</li>
<li>EDI Exchange Type, to define file types of exchange</li>
<li>EDI Exchange Record, to define a record exchanged between systems</li>
</ol>
<p>Also define a mixin to be inherited by records that will generate EDIs</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="id2">Configuration</a><ul>
<li><a class="reference internal" href="#component-definition" id="id3">Component definition</a></li>
<li><a class="reference internal" href="#user-edi-generation" id="id4">User EDI generation</a></li>
</ul>
</li>
<li><a class="reference internal" href="#usage" id="id5">Usage</a><ul>
<li><a class="reference internal" href="#output-exchange-records" id="id6">Output Exchange records</a></li>
<li><a class="reference internal" href="#input-exchange-records" id="id7">Input Exchange records</a></li>
</ul>
</li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id8">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id9">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id10">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id11">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id12">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id13">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="configuration"></a>
<h2><a class="toc-backref" href="#id2">Configuration</a></h2>
<p>This module aims to provide an infrastructure to simplify interchangability of documents
between systems providing a configuration platform.
It will be inherited by other modules in order to define the proper implementations of
components.</p>
<p>In order to define a new Exchange Record, we need to configure:</p>
<ul class="simple">
<li>Backend Type</li>
<li>Exchange Type</li>
<li>Backend</li>
<li>Components</li>
</ul>
<a name="component-definition"></a>
<h3><a class="toc-backref" href="#id3">Component definition</a></h3>
<p>The component usage must be defined like <cite>edi.{direction}.{kind}.{code}</cite> where:</p>
<ul class="simple">
<li>direction is <cite>output</cite> or <cite>input</cite></li>
<li>kind can be: <cite>generate</cite>, <cite>send</cite>, <cite>check</cite>, <cite>process</cite>, <cite>receive</cite></li>
<li>code is the <cite>{backend type code}</cite> or <cite>{backend type code}.{exchange type code}</cite></li>
</ul>
<a name="user-edi-generation"></a>
<h3><a class="toc-backref" href="#id4">User EDI generation</a></h3>
<p>On the exchange type, it might be possible to define a set of models, a domain and a
snippet of code.
After defining this fields, we will automatically see buttons on the view to generate
the exchange records.
This configuration is useful to define a way of generation managed by user.</p>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id5">Usage</a></h2>
<p>After certain operations or manual execution, Exchange records will be generated.
This Exchange records might be input records or outputs records.</p>
<p>The change of state can be manually executed by the system or be managed through by
<cite>ir.cron</cite>.</p>
<a name="output-exchange-records"></a>
<h3><a class="toc-backref" href="#id6">Output Exchange records</a></h3>
<p>An output record is intended to be used for exchange information from Odoo to another
system.</p>
<p>The flow of an output record should be:</p>
<ul class="simple">
<li>Creation</li>
<li>Generation of data</li>
<li>Validation of data</li>
<li>Sending data</li>
<li>Validation of data processed properly by the other party</li>
</ul>
<a name="input-exchange-records"></a>
<h3><a class="toc-backref" href="#id7">Input Exchange records</a></h3>
<p>An input record is intended to be used for exchange information another system to odoo.</p>
<p>The flow of an input record should be:</p>
<ul class="simple">
<li>Creation</li>
<li>Reception of data</li>
<li>Checking data</li>
<li>Processing data</li>
</ul>
<a name="known-issues-roadmap"></a>
<h2 class="with-subtitle"><a class="toc-backref" href="#id8">Known issues / Roadmap</a></h2>
<h2 class="section-subtitle" id="id1"><span class="section-subtitle">14.0.1.0.0</span></h2>
<p>The module name has been changed from edi to edi_oca.</p>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id9">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/edi/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/edi/issues/new?body=module:%20edi_oca%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="#id10">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id11">Authors</a></h3>
<ul class="simple">
<li>ACSONE</li>
<li>Creu Blanca</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id12">Contributors</a></h3>
<ul class="simple">
<li>Simone Orsi <<a class="reference external" href="mailto:simahawk@gmail.com">simahawk@gmail.com</a>></li>
<li>Enric Tobella <<a class="reference external" href="mailto:etobella@creublanca.es">etobella@creublanca.es</a>></li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id13">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/simahawk"><img alt="simahawk" src="https://github.com/simahawk.png?size=40px" /></a> <a class="reference external" href="https://github.com/etobella"><img alt="etobella" src="https://github.com/etobella.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/edi/tree/14.0/edi_oca">OCA/edi</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>