[20.0][MIG] edi_queue_oca: Migration to 20.0

edi_queue_oca/README.rst

@@ -0,0 +1,167 @@
+.. image:: https://odoo-community.org/readme-banner-image
+   :target: https://odoo-community.org/get-involved?utm_source=readme
+   :alt: Odoo Community Association
+
+=============
+Edi Queue Oca
+=============
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:1ab25d69fc78c38970945f7e4e2f4c5426629c0cd155b4e06ac962e24645418f
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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/20.0/edi_queue_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-20-0/edi-framework-20-0-edi_queue_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=20.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module integrates EDI exchange records with `Queue
+Job <https://github.com/OCA/queue>`__, so that the four core exchange
+actions — **generate**, **send**, **receive**, and **process** — are
+dispatched as background jobs instead of running synchronously.
+
+Each exchange type can optionally route its jobs to a specific channel,
+set a priority, or **hold all jobs until a fixed time of day** — useful
+when a trading partner's receiving system has a nightly processing
+window or when the operator wants to concentrate resource-intensive EDI
+work in off-peak hours.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+Automatic job dispatch
+----------------------
+
+All exchange actions on ``edi.exchange.record`` are dispatched as
+background jobs automatically. No per-record configuration is required;
+the integration is active for every exchange type as soon as the module
+is installed.
+
+Per-type job configuration
+--------------------------
+
+Each **Exchange Type** gains a *Queue* tab with optional settings:
+
++---------------------------+------------------------------------------+
+| Field                     | Purpose                                  |
++===========================+==========================================+
+| **Job channel**           | Route jobs to a specific channel (e.g.   |
+|                           | ``root.edi.high``).                      |
++---------------------------+------------------------------------------+
+| **Job priority**          | Integer priority passed to the queue job |
+|                           | (lower = higher priority).               |
++---------------------------+------------------------------------------+
+| **Enable ETA Scheduling** | Toggle to activate daily job             |
+|                           | accumulation (see below).                |
++---------------------------+------------------------------------------+
+| **Execution time**        | Hour, minute, and timezone at which      |
+|                           | accumulated jobs are released. Visible   |
+|                           | only when ETA Scheduling is enabled.     |
++---------------------------+------------------------------------------+
+
+Accumulating jobs until a fixed daily time
+------------------------------------------
+
+Enabling **ETA Scheduling** on an exchange type causes every job created
+for that type to be **held in the queue** until the configured time of
+day, rather than being processed immediately. All jobs that arrive
+during the day accumulate and are released together at that moment.
+
+**Typical use cases:**
+
+- A trading partner's receiving system only processes incoming files at
+  a specific nightly window (e.g. 22:00).
+- Resource-intensive EDI operations (large exports, heavy
+  transformations) should be deferred to off-peak hours to avoid
+  competing with daytime workloads.
+- Operational preference to send a batch of documents at a predictable
+  daily time instead of dispatching them one by one in real time.
+
+The execution time is configured with three fields:
+
+- **Hour** — hour of the day (00–23).
+- **Minute** — minute of the hour (00–59).
+- **Timezone** — the timezone in which the hour and minute are
+  interpreted. Defaults to the current user's timezone.
+
+At runtime the configured time is converted to the next matching UTC
+datetime and set as the queue job ETA. If the target time for today has
+already passed, the job is automatically scheduled for the same time
+tomorrow.
+
+When **Enable ETA Scheduling** is off, jobs are dispatched immediately
+as usual.
+
+Duplicate-job prevention
+------------------------
+
+An identity key is attached to every queued job, so re-triggering an
+action for a record that already has a pending job does not enqueue a
+duplicate.
+
+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_queue_oca%0Aversion:%2020.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
+-------
+
+* 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.
+
+This module is part of the `OCA/edi-framework <https://github.com/OCA/edi-framework/tree/20.0/edi_queue_oca>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

edi_queue_oca/__init__.py

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

edi_queue_oca/__manifest__.py

@@ -0,0 +1,20 @@
+# Copyright 2025 Dixmit
+# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl).
+
+{
+    "name": "Edi Queue Oca",
+    "summary": """Set Queue Jobs on EDI""",
+    "version": "20.0.1.0.0",
+    "license": "LGPL-3",
+    "author": "Dixmit,Camptocamp,Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/edi-framework",
+    "depends": ["edi_core_oca", "queue_job"],
+    "data": [
+        "views/edi_exchange_type.xml",
+        "security/ir.access.csv",
+        "data/job_channel.xml",
+        "data/job_function.xml",
+        "views/edi_exchange_record.xml",
+    ],
+    "demo": [],
+}

edi_queue_oca/data/job_channel.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo noupdate="1">
+    <record id="channel_edi_root" model="queue.job.channel">
+        <field name="name">edi</field>
+        <field name="parent_id" ref="queue_job.channel_root" />
+    </record>
+    <record id="channel_edi_exchange" model="queue.job.channel">
+        <field name="name">edi_exchange</field>
+        <field name="parent_id" ref="channel_edi_root" />
+    </record>
+</odoo>

edi_queue_oca/data/job_function.xml

@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo noupdate="1">
+    <record id="job_fun_exchange_record_generate" model="queue.job.function">
+        <field name="model_id" ref="edi_core_oca.model_edi_exchange_record" />
+        <field name="method">action_exchange_generate</field>
+        <field name="on_fail_method">_job_on_fail_generate</field>
+        <field name="channel_id" ref="channel_edi_exchange" />
+    </record>
+    <record id="job_fun_exchange_record_send" model="queue.job.function">
+        <field name="model_id" ref="model_edi_exchange_record" />
+        <field name="method">action_exchange_send</field>
+        <field name="on_fail_method">_job_on_fail_send</field>
+        <field name="channel_id" ref="channel_edi_exchange" />
+    </record>
+    <record id="job_fun_exchange_record_receive" model="queue.job.function">
+        <field name="model_id" ref="edi_core_oca.model_edi_exchange_record" />
+        <field name="method">action_exchange_receive</field>
+        <field name="on_fail_method">_job_on_fail_receive</field>
+        <field name="channel_id" ref="channel_edi_exchange" />
+    </record>
+    <record id="job_fun_exchange_record_process" model="queue.job.function">
+        <field name="model_id" ref="edi_core_oca.model_edi_exchange_record" />
+        <field name="method">action_exchange_process</field>
+        <field name="on_fail_method">_job_on_fail_process</field>
+        <field name="channel_id" ref="channel_edi_exchange" />
+    </record>
+    <record id="job_fun_exchange_record_create_ack" model="queue.job.function">
+        <field name="model_id" ref="edi_core_oca.model_edi_exchange_record" />
+        <field name="method">exchange_create_ack_record</field>
+        <field name="channel_id" ref="channel_edi_exchange" />
+    </record>
+    <!-- TO be removed on 16.0 -->
+    <record id="job_edi_backend_record_generate" model="queue.job.function">
+        <field name="model_id" ref="edi_core_oca.model_edi_backend" />
+        <field name="method">exchange_generate</field>
+        <field name="channel_id" ref="channel_edi_exchange" />
+    </record>
+    <record id="job_edi_backend_record_send" model="queue.job.function">
+        <field name="model_id" ref="edi_core_oca.model_edi_backend" />
+        <field name="method">exchange_send</field>
+        <field name="channel_id" ref="channel_edi_exchange" />
+    </record>
+    <record id="job_edi_backend_record_receive" model="queue.job.function">
+        <field name="model_id" ref="edi_core_oca.model_edi_backend" />
+        <field name="method">exchange_receive</field>
+        <field name="channel_id" ref="channel_edi_exchange" />
+    </record>
+    <record id="job_edi_backend_record_process" model="queue.job.function">
+        <field name="model_id" ref="edi_core_oca.model_edi_backend" />
+        <field name="method">exchange_process</field>
+        <field name="channel_id" ref="channel_edi_exchange" />
+    </record>
+</odoo>

edi_queue_oca/i18n/edi_queue_oca.pot

@@ -0,0 +1,112 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* edi_queue_oca
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 19.0\n"
+"Report-Msgid-Bugs-To: \n"
+"Last-Translator: \n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: edi_queue_oca
+#: model:ir.model.fields,help:edi_queue_oca.field_edi_exchange_type__job_eta_enabled
+msgid ""
+"Accumulate all queue jobs for this exchange type and release them at the "
+"daily time configured below, instead of dispatching each job immediately. "
+"Use this when a trading partner only processes files at a fixed daily "
+"window, or to concentrate resource-intensive EDI work in off-peak hours."
+msgstr ""
+
+#. module: edi_queue_oca
+#: model:ir.model.fields,field_description:edi_queue_oca.field_edi_backend__display_name
+#: model:ir.model.fields,field_description:edi_queue_oca.field_edi_exchange_record__display_name
+#: model:ir.model.fields,field_description:edi_queue_oca.field_edi_exchange_type__display_name
+msgid "Display Name"
+msgstr ""
+
+#. module: edi_queue_oca
+#: model:ir.model,name:edi_queue_oca.model_edi_backend
+msgid "EDI Backend"
+msgstr ""
+
+#. module: edi_queue_oca
+#: model:ir.model,name:edi_queue_oca.model_edi_exchange_type
+msgid "EDI Exchange Type"
+msgstr ""
+
+#. module: edi_queue_oca
+#: model:ir.model,name:edi_queue_oca.model_edi_exchange_record
+msgid "EDI exchange Record"
+msgstr ""
+
+#. module: edi_queue_oca
+#: model:ir.model.fields,help:edi_queue_oca.field_edi_exchange_type__job_eta_tz
+msgid "ETA's timezone for jobs of this type"
+msgstr ""
+
+#. module: edi_queue_oca
+#: model:ir.model.fields,field_description:edi_queue_oca.field_edi_exchange_type__job_eta_enabled
+msgid "Enable ETA Scheduling"
+msgstr ""
+
+#. module: edi_queue_oca
+#: model:ir.model.fields,field_description:edi_queue_oca.field_edi_exchange_type__job_eta_hour
+msgid "Execution time - hour"
+msgstr ""
+
+#. module: edi_queue_oca
+#: model:ir.model.fields,field_description:edi_queue_oca.field_edi_exchange_type__job_eta_minute
+msgid "Execution time - minute"
+msgstr ""
+
+#. module: edi_queue_oca
+#: model:ir.model.fields,field_description:edi_queue_oca.field_edi_exchange_type__job_eta_tz
+msgid "Execution time - timezone"
+msgstr ""
+
+#. module: edi_queue_oca
+#: model:ir.model.fields,help:edi_queue_oca.field_edi_exchange_type__job_eta_hour
+msgid "Hour of the day at which jobs for this type should be scheduled."
+msgstr ""
+
+#. module: edi_queue_oca
+#: model:ir.model.fields,field_description:edi_queue_oca.field_edi_backend__id
+#: model:ir.model.fields,field_description:edi_queue_oca.field_edi_exchange_record__id
+#: model:ir.model.fields,field_description:edi_queue_oca.field_edi_exchange_type__id
+msgid "ID"
+msgstr ""
+
+#. module: edi_queue_oca
+#: model:ir.model.fields,field_description:edi_queue_oca.field_edi_exchange_type__job_channel_id
+msgid "Job Channel"
+msgstr ""
+
+#. module: edi_queue_oca
+#: model:ir.model.fields,field_description:edi_queue_oca.field_edi_exchange_type__job_priority
+msgid "Job Priority"
+msgstr ""
+
+#. module: edi_queue_oca
+#: model_terms:ir.ui.view,arch_db:edi_queue_oca.edi_exchange_record_form_view
+msgid "Jobs"
+msgstr ""
+
+#. module: edi_queue_oca
+#: model:ir.model.fields,help:edi_queue_oca.field_edi_exchange_type__job_eta_minute
+msgid "Minute of the hour at which jobs for this type should be scheduled."
+msgstr ""
+
+#. module: edi_queue_oca
+#: model_terms:ir.ui.view,arch_db:edi_queue_oca.edi_exchange_type_form_view
+msgid "Queue"
+msgstr ""
+
+#. module: edi_queue_oca
+#: model:ir.model.fields,field_description:edi_queue_oca.field_edi_exchange_record__related_queue_jobs_count
+msgid "Related Queue Jobs Count"
+msgstr ""