How simgonzalez/edi works
This project is a large-scale, modular collection of Odoo add‐ons developed by the Odoo Community Association (OCA) to implement and enhance Electronic Data Interchange (EDI) functionality. Rather than being a monolithic application, it’s organized as many separate modules (or “addons”), each responsible for a specific business function such as invoice generation, import/export of documents (PDF, XML, UBL, Factur-X/ZUGFeRD), partner identification, and other EDI-related functions. In essence, the core “system” here is the Odoo ERP platform into which these EDI modules plug as separate components that can be maintained and deployed individually while still integrating with the central Odoo system.
Main Components
a. Odoo Core Platform: Represent the Odoo server as the central runtime environment that loads and executes all add-ons.
b. EDI Modules: Group the various add-ons by their business functionality—for example:
• Invoice Modules – (account_einvoice_generate, account_invoice_export, account_invoice_facturx, account_invoice_import, account_invoice_ubl and its email attachment variant)
• Purchase & Sale Order Modules – (sale_order_import, sale_order_import_ubl, sale_order_ubl, purchase_order_ubl, sale_order_customer_free_ref, etc.)
• Base and Integration Support Modules – (base_edi, base_ubl, base_facturx, partner_identification_import, pdf_helper, etc.)
• EDI Process and Endpoint Modules – (edi_account_invoice_import, edi_account_oca, edi_endpoint_oca, edi_exchange_template_oca, edi_oca, etc.)
c. Common/Shared Services: These include modules that act as common frameworks (such as base modules) which provide shared functionality used by many "child" modules.
d. External Interfaces & Integration Points: This includes connections to external systems (e.g., OVH API integrations, external storage backends, webservice endpoints, etc.) that interact with specific modules like account_invoice_download_ovh or edi_webservice_oca.
e. Testing, CI/CD and Configuration: Note the presence of continuous integration configurations (GitHub workflows, pre-commit tests, etc.) and configuration files that are part of the development infrastructure.
Relationships and Interactions
d. Integration flows from external services (like OVH API, external document providers, or webservices) into their corresponding modules (for example, connecting an external invoice download service into account_invoice_download_ovh).
e. Where modules “plug in” to each other (like how edi_sale_order_import_ubl builds on sale_order_import), show connecting lines to illustrate these relationships.
Architectural Patterns and Design Principles
a. Modular / Layered Architecture: Emphasize that the system architecture is composed of independent but interlinked modules. Each module “owns” a particular set of functionalities that extend Odoo’s base system.
b. Reusability and Separation of Concerns: Many modules reuse functionality provided by common base modules.
c. Integration via Standardized Interfaces: Highlight that all modules must conform to the Odoo framework’s API for views, models, and data exchange, ensuring smooth integration across different business areas.
Relevant Technologies and Frameworks
a. Use Odoo’s ORM and MVC framework as the technical basis for most modules.
b. Each add-on often contains XML files for view configurations, Python files for business logic, and i18n files for translations. Optionally, annotate these details where relevant.