[19.0][MIG] edi_core_oca

edi_core_oca/README.rst

@@ -0,0 +1,240 @@
+.. image:: https://odoo-community.org/readme-banner-image
+   :target: https://odoo-community.org/get-involved?utm_source=readme
+   :alt: Odoo Community Association
+
+===
+EDI
+===
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:d81318a2b32374412fddae78f470a1ed33828abb1b021ead2d4bbbd98213cab9
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
+    :alt: License: LGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fedi--framework-lightgray.png?logo=github
+    :target: https://github.com/OCA/edi-framework/tree/19.0/edi_core_oca
+    :alt: OCA/edi-framework
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/edi-framework-19-0/edi-framework-19-0-edi_core_oca
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/edi-framework&target_branch=19.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+Base EDI backend.
+
+Provides following models:
+
+1. EDI Backend, to centralize configuration
+2. EDI Backend Type, to classify EDI backends (eg: UBL, GS1, e-invoice,
+   pick-yours)
+3. EDI Exchange Type, to define file types of exchange
+4. 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**
+
+.. contents::
+   :local:
+
+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.
+
+Code to execute
+---------------
+
+By default, EDI Framework uses fields on ``edi.backend`` to get the
+right function to execute. Each function is related to a model where the
+specific function is defined. This models needs to inherit the specific
+handler of each case.
+
+- receive: model ``edi.oca.handler.receive`` with function receive.
+- process: model ``edi.oca.handler.process`` with function process.
+- generate: model ``edi.oca.handler.generate`` with function generate.
+- send: model ``edi.oca.handler.send`` with function send.
+- check: model ``edi.oca.handler.check`` with function check.
+- validate on inputs: model ``edi.oca.handler.input.validate`` with
+  function input_validate.
+- validate on outputs: model ``edi.oca.handler.output.validate`` with
+  function input_validate.
+
+You can see an example on the tests fake_models.
+
+For a more complex behaviour, you can use ``edi_component_oca`` module
+to use components.
+
+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:
+
+1. make buttons automatically appear in forms
+2. 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.
+
+18.0.1.4.0
+----------
+
+Components dependancy has been removed and set on a new dependant module
+``edi_component_oca``. Module ``edi_oca`` has been_renamed to
+``edi_core_oca``.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/edi-framework/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 <https://github.com/OCA/edi-framework/issues/new?body=module:%20edi_core_oca%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+-------
+
+* ACSONE
+* Dixmit
+* Camptocamp
+
+Contributors
+------------
+
+- Simone Orsi <simahawk@gmail.com>
+- Enric Tobella <enric.tobella@dixmit.com>
+- Manuel Regidor <manuel.regidor@sygel.es>
+- Thien Vo <thienvh@trobz.com>
+- Jordi Masvidal <jordi.masvidal@forgeflow.com>
+
+Maintainers
+-----------
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+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.
+
+.. |maintainer-simahawk| image:: https://github.com/simahawk.png?size=40px
+    :target: https://github.com/simahawk
+    :alt: simahawk
+.. |maintainer-etobella| image:: https://github.com/etobella.png?size=40px
+    :target: https://github.com/etobella
+    :alt: etobella
+
+Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-simahawk| |maintainer-etobella| 
+
+This module is part of the `OCA/edi-framework <https://github.com/OCA/edi-framework/tree/19.0/edi_core_oca>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

edi_core_oca/__init__.py

@@ -0,0 +1,2 @@
+from . import models
+from . import wizards

edi_core_oca/__manifest__.py

@@ -0,0 +1,55 @@
+# Copyright 2020 ACSONE
+# Copyright 2021 Camptocamp
+# @author: Simone Orsi <simahawk@gmail.com>
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+{
+    "name": "EDI",
+    "summary": """
+    Define backends, exchange types, exchange records,
+    basic automation and views for handling EDI exchanges.
+    """,
+    "version": "19.0.1.0.0",
+    "website": "https://github.com/OCA/edi-framework",
+    "development_status": "Beta",
+    "license": "LGPL-3",
+    "author": "ACSONE,Dixmit,Camptocamp,Odoo Community Association (OCA)",
+    "maintainers": ["simahawk", "etobella"],
+    "depends": [
+        "base_edi",
+        "mail",
+        "base_sparse_field",
+    ],
+    "external_dependencies": {"python": ["PyYAML", "openupgradelib"]},
+    "data": [
+        "wizards/edi_exchange_record_create_wiz.xml",
+        "data/cron.xml",
+        "data/ir_actions_server.xml",
+        "data/sequence.xml",
+        "data/edi_configuration.xml",
+        "security/res_groups.xml",
+        "security/ir_model_access.xml",
+        "views/edi_backend_views.xml",
+        "views/edi_backend_type_views.xml",
+        "views/edi_exchange_record_views.xml",
+        "views/edi_exchange_type_views.xml",
+        "views/edi_exchange_type_rule_views.xml",
+        "views/edi_configuration_views.xml",
+        "views/edi_configuration_trigger_views.xml",
+        "views/res_partner.xml",
+        "views/menuitems.xml",
+        "templates/exchange_chatter_msg.xml",
+        "templates/exchange_mixin_buttons.xml",
+    ],
+    "assets": {
+        "web.assets_backend": [
+            "edi_core_oca/static/src/js/widget_edi.esm.js",
+            "edi_core_oca/static/src/xml/widget_edi.xml",
+        ],
+        "web.assets_unit_tests": [
+            "edi_core_oca/static/tests/**/*",
+        ],
+    },
+    "demo": ["demo/edi_backend_demo.xml"],
+    "installable": True,
+}

edi_core_oca/data/cron.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo noupdate="1">
+    <record
+        id="cron_edi_backend_check_output_exchange"
+        model="ir.cron"
+        forcecreate="True"
+    >
+        <field name="name">EDI exchange check output sync</field>
+        <field name="active" eval="True" />
+        <field name="user_id" ref="base.user_root" />
+        <field name="interval_number">1</field>
+        <field name="interval_type">hours</field>
+        <field name="model_id" ref="edi_core_oca.model_edi_backend" />
+        <field name="state">code</field>
+        <field name="code">model.search([])._cron_check_output_exchange_sync()</field>
+    </record>
+    <!-- TODO -->
+    <record
+        id="cron_edi_backend_check_input_exchange"
+        model="ir.cron"
+        forcecreate="True"
+    >
+        <field name="name">EDI exchange check input sync</field>
+        <field name="active" eval="True" />
+        <field name="user_id" ref="base.user_root" />
+        <field name="interval_number">1</field>
+        <field name="interval_type">hours</field>
+        <field name="model_id" ref="edi_core_oca.model_edi_backend" />
+        <field name="state">code</field>
+        <field name="code">model.search([])._cron_check_input_exchange_sync()</field>
+    </record>
+</odoo>

edi_core_oca/data/edi_configuration.xml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+    <!-- The `ir_action` parameter must be passed in order to use `send_via_email`
+    Examlple:
+        <field name="snippet_do">record._edi_send_via_email(ir_action)</field>
+     -->
+
+    <record id="edi_conf_trigger_record_create" model="edi.configuration.trigger">
+        <field name="name">On record create</field>
+        <field name="code">on_record_create</field>
+        <field name="description">Trigger when a record is created</field>
+    </record>
+    <record id="edi_conf_trigger_record_write" model="edi.configuration.trigger">
+        <field name="name">On record write</field>
+        <field name="code">on_record_write</field>
+        <field name="description">Trigger when a record is updated</field>
+    </record>
+    <!-- TODO: these 2 have to be triggered somehow -->
+    <record id="edi_conf_trigger_send_via_email" model="edi.configuration.trigger">
+        <field name="name">Send via email</field>
+        <field name="code">on_send_via_email</field>
+        <field name="description">Send record via email TBD</field>
+    </record>
+    <record id="edi_conf_trigger_send_via_edi" model="edi.configuration.trigger">
+        <field name="name">Send via EDI</field>
+        <field name="code">on_send_via_edi</field>
+        <field name="description">Send record via EDI TBD</field>
+    </record>
+
+    <record id="edi_conf_send_via_email" model="edi.configuration">
+        <field name="name">Send Via Email</field>
+        <field name="active">False</field>
+        <field name="trigger_id" ref="edi_conf_trigger_send_via_email" />
+        <field name="snippet_do">record._edi_send_via_email()</field>
+    </record>
+    <record id="edi_conf_send_via_edi" model="edi.configuration">
+        <field name="name">Send Via EDI</field>
+        <field name="active">False</field>
+        <field name="trigger_id" ref="edi_conf_trigger_send_via_edi" />
+        <field name="snippet_do">record._edi_send_via_edi(conf.type_id)</field>
+    </record>
+</odoo>

edi_core_oca/data/ir_actions_server.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+    <record model="ir.actions.server" id="action_retry_edi_exchange_record">
+        <field name="name">Retry</field>
+        <field name="group_ids" eval="[(4, ref('base_edi.group_edi_manager'))]" />
+        <field name="model_id" ref="model_edi_exchange_record" />
+        <field name="binding_model_id" ref="model_edi_exchange_record" />
+        <field name="state">code</field>
+        <field name="code">
+            if records:
+                action = records.action_retry()
+        </field>
+    </record>
+</odoo>