Base EDI backend.
Provides following models:
- EDI Backend, to centralize configuration
- EDI Backend Type, to classify EDI backends (eg: UBL, GS1, e-invoice, pick-yours)
- EDI Exchange Type, to define file types of exchange
- EDI Exchange Record, to define a record exchanged between systems
Also define a mixin to be inherited by records that will generate EDIs
Table of contents
Configuration
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.
In order to define a new Exchange Record, we need to configure:
- Backend Type
- Exchange Type
- Backend
- Components
Jobs
- Internal User: might be an EDI user without even knowing about it, triggering EDI flows by some of his actions on business records; does not need access to related queue jobs.
- EDI User: more conscious EDI user that might sometimes need to debug things a bit further and thus needs access to related queue jobs.
- EDI Manager: full configuration access.
Component definition
The component usage must be defined like edi.{direction}.{kind}.{code} where:
- direction is
outputorinput - kind can be:
generate,send,check,process,receive - code is the
{backend type code}or{backend type code}.{exchange type code}
User EDI generation
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.
Exchange type rules configuration
Exchange types can be further configured with rules. You can use rules to:
- make buttons automatically appear in forms
- define your own custom logic
Go to an exchange type and go to the tab «Model rules». There you can add one or more rule, one per model. On each rule you can define a domain or a snippet to activate it. In case of a «Form button» kind, if the domain and/ the snippet is/are satisfied, a form btn will appear on the top of the form. This button can be used by the end user to manually generate an exchange. If there’s more than a backend and the exchange type has not a backend set, a wizard will appear asking to select a backend to be used for the exchange.
In case of «Custom» kind, you’ll have to define your own logic to do something.
Usage
After certain operations or manual execution, Exchange records will be generated. This Exchange records might be input records or outputs records.
The change of state can be manually executed by the system or be managed through by
ir.cron.
Output Exchange records
An output record is intended to be used for exchange information from Odoo to another system.
The flow of an output record should be:
- Creation
- Generation of data
- Validation of data
- Sending data
- Validation of data processed properly by the other party
Input Exchange records
An input record is intended to be used for exchange information another system to odoo.
The flow of an input record should be:
- Creation
- Reception of data
- Checking data
- Processing data
Known issues / Roadmap
14.0.1.0.0
The module name has been changed from edi to edi_oca.
Bug Tracker
Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.
Do not contact contributors directly about support or help with technical issues.
Credits
Contributors
- Simone Orsi <simahawk@gmail.com>
- Enric Tobella <etobella@creublanca.es>
- Thien Vo <thienvh@trobz.com>
Maintainers
This module is maintained by the OCA.
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.
Current maintainers:
This module is part of the OCA/edi project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.