From 91b3a7f74439a9e773708973b488f2ef8fad1a1a Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Fri, 28 Jun 2024 09:25:40 +0000 Subject: [PATCH] [BOT] post-merge updates --- README.md | 6 +- edi_oca/README.rst | 2 +- edi_oca/static/description/index.html | 1309 ++++++++++--------------- setup/_metapackage/pyproject.toml | 11 + 4 files changed, 556 insertions(+), 772 deletions(-) create mode 100644 setup/_metapackage/pyproject.toml diff --git a/README.md b/README.md index 725a1d434..7b55d4133 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,11 @@ [//]: # (addons) -This part will be replaced when running the oca-gen-addons-table script from OCA/maintainer-tools. +Available addons +---------------- +addon | version | maintainers | summary +--- | --- | --- | --- +[edi_oca](edi_oca/) | 17.0.1.0.0 | [![simahawk](https://github.com/simahawk.png?size=30px)](https://github.com/simahawk) [![etobella](https://github.com/etobella.png?size=30px)](https://github.com/etobella) | Define backends, exchange types, exchange records, basic automation and views for handling EDI exchanges. [//]: # (end addons) diff --git a/edi_oca/README.rst b/edi_oca/README.rst index 29b3703b4..9156ff58f 100644 --- a/edi_oca/README.rst +++ b/edi_oca/README.rst @@ -7,7 +7,7 @@ EDI !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! - !! source digest: sha256:87b6de44d08b210516845cbfbdcf77a1b88f592ea40d0285a2f25823f2cf737c + !! source digest: sha256:4ebb91b3f97b6a90b0b601f76d7528f3434e225b8dfebaa71bfd7cdb3b45d03e !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png diff --git a/edi_oca/static/description/index.html b/edi_oca/static/description/index.html index e17ae8dcb..f758bf2f9 100644 --- a/edi_oca/static/description/index.html +++ b/edi_oca/static/description/index.html @@ -1,772 +1,541 @@ - + - - - - EDI - - - -
-

EDI

- - -

- - Beta - - - License: LGPL-3 - - - OCA/edi-framework - - - Translate me on Weblate - - - Try me on Runboat - -

-

Base EDI backend.

-

Provides following models:

-
    -
  1. EDI Backend, to centralize configuration
    2. -
  2. EDI Backend Type, to classify EDI backends (eg: UBL, GS1, e-invoice, - pick-yours) -
    3. -
  3. EDI Exchange Type, to define file types of exchange
    4. -
  4. EDI Exchange Record, to define a record exchanged between systems
    5. -
-

Also define a mixin to be inherited by records that will generate EDIs

-

- Table of contents -

- -
-

- 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
    • -
-
-

- Component definition -

-

The component usage must be defined like edi.{direction}.{kind}.{code} - where: -

-
    -
  • direction is output or input
    • -
  • kind can be: generate, send, check, process, receive
    • -
  • code is the {backend type code} or {backend type code}.{exchange type - code} -
    • -
-
-
-

- 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. -
  2. define your own custom logic
    3. -
-

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.

-
-
-
-

- Bug Tracker -

-

Bugs are tracked on - GitHub 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. -

-

Do not contact contributors directly about support or help with technical issues.

-
-
-

- Credits -

-
-

- Authors -

-
    -
  • ACSONE
    • -
  • Creu Blanca
    • -
  • Camptocamp
    • -
-
-
-

- Contributors -

- -
-
-

- Maintainers -

-

This module is maintained by the OCA.

- - Odoo Community Association - -

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. -

-

Current - maintainers: -

-

- - simahawk - - - etobella - -

-

This module is part of the - - OCA/edi-framework - - project on GitHub. -

-

You are welcome to contribute. To learn how please visit - https://odoo-community.org/page/Contribute. -

-
-
-
- + + + +EDI + + + +
+

EDI

+ + +

Beta License: LGPL-3 OCA/edi-framework Translate me on Weblate Try me on Runboat

+

Base EDI backend.

+

Provides following models:

+
    +
  1. EDI Backend, to centralize configuration
    2. +
  2. EDI Backend Type, to classify EDI backends (eg: UBL, GS1, e-invoice, +pick-yours)
    3. +
  3. EDI Exchange Type, to define file types of exchange
    4. +
  4. EDI Exchange Record, to define a record exchanged between systems
    5. +
+

Also define a mixin to be inherited by records that will generate EDIs

+

Table of contents

+ +
+

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
    • +
+
+

Component definition

+

The component usage must be defined like edi.{direction}.{kind}.{code} +where:

+
    +
  • direction is output or input
    • +
  • kind can be: generate, send, check, process, receive
    • +
  • code is the {backend type code} or {backend type code}.{exchange type +code}
    • +
+
+
+

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. +
  2. define your own custom logic
    3. +
+

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.

+
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub 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.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • ACSONE
    • +
  • Creu Blanca
    • +
  • Camptocamp
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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.

+

Current maintainers:

+

simahawk etobella

+

This module is part of the OCA/edi-framework project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ diff --git a/setup/_metapackage/pyproject.toml b/setup/_metapackage/pyproject.toml new file mode 100644 index 000000000..10e8e3d38 --- /dev/null +++ b/setup/_metapackage/pyproject.toml @@ -0,0 +1,11 @@ +[project] +name = "odoo-addons-oca-edi-framework" +version = "17.0.20240628.0" +dependencies = [ + "odoo-addon-edi_oca>=17.0dev,<17.1dev", +] +classifiers=[ + "Programming Language :: Python", + "Framework :: Odoo", + "Framework :: Odoo :: 17.0", +]