[14.0][IMP] edi_oca: Add new model edi.configuration #1035

thienvh332 · 2024-09-06T03:20:46Z

Specs

In edi_oca

Add generic edi.configuration model with these characteristics:

Fields

active
code
  uniq identifier, normalized
description: describe what the conf is for
backend_id
type_id

model: model the conf applies to

partner_ids: Apply the conf on specific partners (Leave blank to apply all partners)

trigger: Selection field to make easier and more explicit the use of the conf for a specific event (eg: on_post_account_move, on_so_confirm, etc)
    default option: empty

snippet_before_do: validate the state, used to collect records todo
    can be used to do anything before the action that triggered it
  
    eval ctx:
        trigger = create/write/$name_of_the_event
        conf = current conf

    the snippet can return:
        todo = True/False
        snippet_do_vars = {}  # set of variables to pass over to the next snippet
        event_only
        tracked_fields
        edi_action
        .. in fact, any other variable that might be needed

snippet_do: used to do something specific here

    receives: operation, edi_action, vals, old_vals

This model can then be used by conf consumers.
Other methods:

edi_exec_snippet_before_do(self, record):
  exec before snippet, self=conf

edi_exec_snippet_do(self, record):
  exec snippet, self=conf

edi_get_conf(self, trigger, model_name=None, partners=None, backend=None):
  filter current recordset based on conditions

Backend / Exc. record

In `edi.backend._check_output_exchange_sync` move the loop on new_records to a new method `exchange_generate_send` whereas if the file has to be generated
2 jobs are chained (generate + send) if only send is needed, delay only one job.

Then add edi.exchange.record.action_exchange_generate_send and use that method from backend.
Consumer mixin

Specific fields for configuration (eg: edi_purchase_conf_ids) will be added by glue modules on res.partner.

Default conf

add generic conf for send_via_email

code: send_via_email
trigger: on_email_send
snippet: `record._edi_send_via_email()

add generic conf for send_via_edi

code: send_via_edi
trigger: none
snippet: `record._edi_send_via_edi(conf.type_id)

NOTE: sending emails is not really bound to edi
but in real life it's handy to have a default way to send EDI docs via email.
You could even generate an exchange record to keep track of that
but the choice will be up to the implementers.
The key is that w/ this features they can do whatever they want.

Views

add a specific menu item in edi settings to see all confs
make them searchable by model, active/inactive, partner, exc type, trigger

On edi_purchase_oca

add conf trigger on_button_confirm_purchase_order

add res.partner.edi_purchase_conf_ids
domain model=purchase.order, default_model=purchase.order, default_res_id=active_id

(document this approach in edi_oca readme section for edi.conf)

add generic conf for send_via_email_rfq

code: send_via_email_rfq
snippet: `record._edi_send_via_email(ir_action=record.action_rfq_send())

Example of specific listener implementation:

class EDIConfigPurchaseListener(Component):
    _name = "edi.config.consumer.listener.purchase.order"
    _inherit = "base.event.listener"

def on_button_confirm_purchase_order(self, record):
    trigger = "on_button_confirm_purchase_order"
    confs = record.edi_purchase_conf_ids.edi_get_conf(trigger)
    for conf in confs:
        conf.edi_exec_snippet_do(record)

OCA-git-bot · 2024-09-06T04:46:06Z

Hi @etobella, @simahawk,
some modules you are maintaining are being modified, check this out!

etobella · 2024-09-06T05:19:49Z

More information would be awesome in order to understand why you did this.

simahawk · 2024-09-06T05:47:37Z

@etobella this origins from our discussion on OCA/edi-framework#39
@thienvh332 I'm adding the specs I gave you in the description feel free to adapt / add more things.
IMO we should split the purchase part when ready (let's say before switching from draft to real PR to ease the final review of both parts).

simahawk · 2024-09-06T05:50:50Z

@thienvh332 as it's draft, do you want us to wait for a review?

nilshamerlinck · 2024-09-06T06:37:53Z

hi @simahawk

yes, please wait before reviewing, we need to finalize the internal review on our side
now that you confirmed you want this in v14, we'll complete it asap

thienvh332 · 2024-09-18T11:14:55Z

Hello @simahawk ,
This PR is ready for review. Could you please take a look at it?

simahawk · 2024-10-09T13:47:43Z

can you drop the pypdf fix? 15a994e

simahawk · 2024-10-09T13:51:00Z

edi_oca/models/edi_exchange_consumer_mixin.py

+    ):
+        # Default action if not provided
+        if ir_action is None:
+            # `action_send_email` is just an action name I created


I don't get what's the need for this ... there's no action_send_email anywhere.

simahawk · 2024-10-09T13:53:24Z

edi_oca/models/edi_configuration.py

+    code = fields.Char(required=True, copy=False, index=True, unique=True)
+    description = fields.Char(help="Describe what the conf is for")
+    backend_id = fields.Many2one(string="Backend", comodel_name="edi.backend")
+    type_id = fields.Many2one(


type should be mandatory

no, as per our comments.
Please add a comment here explaining why it is not mandatory ;)

edi_oca/models/edi_configuration.py

edi_oca/components/base_listener_config.py

edi_oca/models/edi_configuration_mixin.py

edi_oca/tests/fake_models.py

edi_purchase_oca/components/listener_purchase_order.py

thienvh332 · 2024-10-24T09:18:02Z

Hi @simahawk ,
I have updated the PR but I have 2 things I need your opinion on. Could you give me your views?

I don't get what's the need for this ... there's no action_send_email anywhere.

We have a common config send_via_email. There we don't know what ir_action is used on each model. So I created it as a common path for other models. They can use _edi_send_via_email without passing ir_action parameter.
Of course, if you feel it is inappropriate I will delete it.

type should be mandatory

About type_id must be mandatory:
- I'm confused about this. There is a requirement to create 2 common confs (send_via_email and send_via_edi). If type_id is required then we will:
  - Create data for edi_exchange_type and related models in edi_oca module.
  - Create those 2 common confs in another module to avoid creating unwanted data when installing the edi_oca module.

simahawk · 2024-10-24T09:31:05Z

Hi @simahawk , I have updated the PR but I have 2 things I need your opinion on. Could you give me your views?

I don't get what's the need for this ... there's no action_send_email anywhere.
* We have a common config **`send_via_email`**. There we don't know what **`ir_action`** is used on each model. So I created it as a common path for other models. They can use **`_edi_send_via_email`** without passing **`ir_action`** parameter.

* Of course, if you feel it is inappropriate I will delete it.

The idea is that everything should be explicit. You must explicitly declare which action you want to use.

type should be mandatory

* About **`type_id`** must be mandatory:
  
  * I'm confused about this. There is a requirement to create 2 common confs (**`send_via_email`** and **`send_via_edi`**). If **`type_id`** is required then we will:
    
    * Create data for **`edi_exchange_type`** and related models in **`edi_oca`** module.
    * Create those **`2 common confs`** in **`another module`** to avoid creating unwanted data when installing the **`edi_oca`** module.

Ok, you are right. Cannot be mandatory. Good point :)

simahawk · 2024-10-24T09:18:36Z

edi_oca/models/edi_backend.py

+    def exchange_generate_send(self, recordset, skip_generate=False, skip_send=False):
+        for rec in recordset:
+            if skip_generate:
+                job1 = rec


what would be delayed in this case if we skip_send too? 🤔

simahawk · 2024-10-24T09:19:27Z

edi_oca/models/edi_configuration.py

+        auto_join=True,
+        index=True,
+    )
+    model = fields.Many2one(


Suggested change

model = fields.Many2one(

model_id = fields.Many2one(

simahawk · 2024-10-24T09:21:21Z

edi_oca/models/edi_configuration.py

+        [
+            ("on_record_write", "Update Record"),
+            ("on_record_create", "Create Record"),
+            ("on_email_send", "Send Email"),


I guess this is to ease the configuration for models like SO, PO, INV, that can be sent by email.
As there's no specific implementation here, I would add a comment that explain why this is here.

Also, I think trigger should be mandatory otherwise the conf is useless, no?
Maybe we can add another option like ("disabled", "Disabled") which would allow to keep the conf visible but disabled.

simahawk · 2024-10-24T09:25:23Z

edi_oca/models/edi_configuration.py

+
+    def edi_get_conf(self, trigger, backend=None):
+        domain = [("trigger", "=", trigger)]
+        backend_ids = self.mapped("type_id.backend_id.id")


what's the point on filtering on all the backends assigned to the current recordset?

simahawk · 2024-10-24T09:32:24Z

edi_oca/models/edi_configuration.py

+    code = fields.Char(required=True, copy=False, index=True, unique=True)
+    description = fields.Char(help="Describe what the conf is for")
+    backend_id = fields.Many2one(string="Backend", comodel_name="edi.backend")
+    type_id = fields.Many2one(


no, as per our comments.
Please add a comment here explaining why it is not mandatory ;)

simahawk · 2024-10-24T09:35:43Z

edi_oca/models/edi_exchange_consumer_mixin.py

+    def _edi_send_via_edi(self, exchange_type):
+        exchange_record = self._edi_create_exchange_record(exchange_type)
+        exchange_record.action_exchange_generate_send()
+        msg = _("EDI auto: output generated.")


This is not only generated but generated and sent.
I wonder if we need this custom message...
The backend will call notify_action_complete when is done...

simahawk · 2024-10-24T09:36:08Z

edi_purchase_oca/components/listener_purchase_order.py

+
+    def on_button_confirm_purchase_order(self, record):
+        trigger = "on_button_confirm_purchase_order"
+        confs = record.mapped("partner_id.edi_purchase_conf_ids").edi_get_conf(trigger)


no need to use mapped

thienvh332 force-pushed the 14.0-imp-edi_oca branch 8 times, most recently from 89cc982 to 15a994e Compare September 18, 2024 10:55

thienvh332 marked this pull request as ready for review September 18, 2024 11:11

simahawk requested changes Oct 9, 2024

View reviewed changes

thienvh332 added 2 commits October 24, 2024 15:34

[ADD] edi_oca: Add new model edi.configuration

30c316c

[UPD] edi_purchase_oca: Update for edi configuration

497f4c4

thienvh332 force-pushed the 14.0-imp-edi_oca branch from 15a994e to 497f4c4 Compare October 24, 2024 09:06

simahawk reviewed Oct 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[14.0][IMP] edi_oca: Add new model edi.configuration #1035

[14.0][IMP] edi_oca: Add new model edi.configuration #1035

thienvh332 commented Sep 6, 2024 •

edited

Loading

OCA-git-bot commented Sep 6, 2024

etobella commented Sep 6, 2024

simahawk commented Sep 6, 2024 •

edited

Loading

simahawk commented Sep 6, 2024

nilshamerlinck commented Sep 6, 2024

thienvh332 commented Sep 18, 2024

simahawk commented Oct 9, 2024

simahawk Oct 9, 2024

simahawk Oct 9, 2024

simahawk Oct 24, 2024

thienvh332 commented Oct 24, 2024

simahawk commented Oct 24, 2024

simahawk Oct 24, 2024

simahawk Oct 24, 2024

simahawk Oct 24, 2024

simahawk Oct 24, 2024

simahawk Oct 24, 2024

simahawk Oct 24, 2024

simahawk Oct 24, 2024

[14.0][IMP] edi_oca: Add new model edi.configuration #1035

Are you sure you want to change the base?

[14.0][IMP] edi_oca: Add new model edi.configuration #1035

Conversation

thienvh332 commented Sep 6, 2024 • edited Loading

Specs

OCA-git-bot commented Sep 6, 2024

etobella commented Sep 6, 2024

simahawk commented Sep 6, 2024 • edited Loading

simahawk commented Sep 6, 2024

nilshamerlinck commented Sep 6, 2024

thienvh332 commented Sep 18, 2024

simahawk commented Oct 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thienvh332 commented Oct 24, 2024

simahawk commented Oct 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thienvh332 commented Sep 6, 2024 •

edited

Loading

simahawk commented Sep 6, 2024 •

edited

Loading