EDI Notification

edi_notification_oca · OCA/edi-framework

    Repository
    OCA/edi-framework · module folder · Try on Runboat
    Module version
    1.0.0
    Category
    Uncategorized
    Folder size
    0.05 MB
    License
    LGPL-3
    Application
    No
    Auto-installable
    No
    Website
    https://github.com/OCA/edi-framework
    Last tracking update
    2026-08-07 09:06:36
    Authors
    Camptocamp, Odoo Community Association (OCA)
    Maintainers
    Camptocamp, Odoo Community Association (OCA)
    Committers
    Ricardoalso, OCA-git-bot, oca-ci
    Odoo dependencies
    OCA/edi:
    - base_edi
    OCA/edi-framework:
    - edi_core_oca
    odoo/odoo:
    - base
    - mail
    - base_setup
    - web
    - bus
    - web_tour
    - html_editor
    - base_sparse_field
    Python dependencies
    PyYAML, openupgradelib
    System dependencies
    None
    Required by
    None
    Description
    This module creates activities for users when an exchange record's process fails.

It also installs an ``edi.configuration`` rule (``Notify Users On Exchange
Error``) that calls ``edi.notification.tool`` on process errors.

Exchange types must be configured properly to create such activities:

- field "Notify On Process Error" must be checked to activate the feature
  for the current exchange type
- field "Activity Type Used When Notify On Process Error" is used to define
  the type of the newly created activity
- fields "Notify Groups On Process Error" and "Notify Users On Process Error" are used
  to define the users that will be assigned to the newly created activity

    Code Analysis ⓘ

    Views touched (1)
    XML IDNameModelTypeStatus
    edi_exchange_type_view_form edi.exchange.type form Inherits edi_core_oca.edi_exchange_type_view_form
    HTTP endpoints (0)

    No HTTP endpoints found for this module.

    Models touched (3)

    New fields (0)

    No new fields.

    Public methods (0)

    No public methods.

    New fields (5)
    • notify_on_process_error Boolean
      default=False help="If an error happens on process, a notification will be sent to all selected users. If active, please select the specific groups and specific users in the 'Notifications' page."
    • notify_on_process_error_activity_type_id Many2one → mail.activity.type
      default=<expr> string='Activity Type Used When Notify On Process Error' args: 'mail.activity.type'
    • notify_on_process_error_enabled Boolean
      compute='_compute_notify_on_process_error_enabled'
    • notify_on_process_error_groups_ids Many2many → res.groups
      comodel_name='res.groups' inverse='_inverse_notify_on_process_error_groups_users' string='Notify Groups On Process Error'
    • notify_on_process_error_users_ids Many2many → res.users
      comodel_name='res.users' help="Select users to send notifications to. If 'Notification Groups' have been selected, notifications will also be sent to users selected in here." inverse='_inverse_notify_on_process_error_groups_users' string='Notify Users On Process Error'
    Public methods (0)

    No public methods.

    New fields (0)

    No new fields.

    Public methods (1)
    • on_edi_exchange_error(self, exchange_record)
      Schedule notification activities for a failed exchange record. This hook is intended to be called by an ``edi.configuration`` snippet (see ``edi_notification_oca/data/edi_configuration.xml``) when an exchange record process ends in error.

    Loading…

    Loading…