From f72d0c15f71f6d137ff3590403cbdbc816ad5d17 Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Tue, 16 Mar 2021 14:37:30 +0000 Subject: [PATCH] [UPD] README.rst --- base_import_match/README.rst | 69 ++- .../static/description/index.html | 502 ++++++++++++++++++ 2 files changed, 548 insertions(+), 23 deletions(-) create mode 100644 base_import_match/static/description/index.html diff --git a/base_import_match/README.rst b/base_import_match/README.rst index b3bdf41a..e6c60e56 100644 --- a/base_import_match/README.rst +++ b/base_import_match/README.rst @@ -1,11 +1,30 @@ -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html - :alt: License: AGPL-3 - ================= Base Import Match ================= +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github + :target: https://github.com/OCA/server-backend/tree/11.0/base_import_match + :alt: OCA/server-backend +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-backend-11-0/server-backend-11-0-base_import_match + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/253/11.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + By default, when importing data (like CSV import) with the ``base_import`` module, Odoo follows this rule: @@ -53,6 +72,11 @@ By default 2 rules are installed for production instances: In demo instances there are more examples. +**Table of contents** + +.. contents:: + :local: + Configuration ============= @@ -82,11 +106,7 @@ To use this module, you need to: #. Go to any list view. #. Press *Import* and follow the import procedure as usual. -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/149/11.0 - -Known Issues / Roadmap +Known issues / Roadmap ====================== * Add a setting to throw an error when multiple matches are found, instead of @@ -95,32 +115,35 @@ Known Issues / Roadmap 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 smashing it by providing a detailed and welcomed feedback. +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 smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= -Contributors ------------- +Authors +~~~~~~~ -* Jairo Llopis -* Vicent Cubells -* Marçal Isern +* Grupo ESOC Ingeniería de Servicios +* Tecnativa -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - 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. -To contribute to this module, please visit https://odoo-community.org. +This module is part of the `OCA/server-backend `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/base_import_match/static/description/index.html b/base_import_match/static/description/index.html new file mode 100644 index 00000000..c682f69d --- /dev/null +++ b/base_import_match/static/description/index.html @@ -0,0 +1,502 @@ + + + + + + +Base Import Match + + + +
+

Base Import Match

+ + +

Beta License: AGPL-3 OCA/server-backend Translate me on Weblate Try me on Runbot

+

By default, when importing data (like CSV import) with the base_import +module, Odoo follows this rule:

+
    +
  • If you import the XMLID of a record, make an update.
    • +
  • If you do not, create a new record.
    • +
+

This module allows you to set additional rules to match if a given import is an +update or a new record.

+

This is useful when you need to sync heterogeneous databases, and the field you +use to match records in those databases with Odoo’s is not the XMLID but the +name, VAT, email, etc.

+

After installing this module, the import logic will be changed to:

+
    +
  • If you import the XMLID of a record, make an update.
    • +
  • If you do not:
      +
    • If there are import match rules for the model you are importing:
        +
      • Discard the rules that require fields you are not importing.
        • +
      • Traverse the remaining rules one by one in order to find a match in the database.
          +
        • Skip the rule if it requires a special condition that is not +satisfied.
          • +
        • If one match is found:
            +
          • Stop traversing the rest of valid rules.
            • +
          • Update that record.
            • +
          +
          • +
        • If zero or multiple matches are found:
            +
          • Continue with the next rule.
            • +
          +
          • +
        • If all rules are exhausted and no single match is found:
            +
          • Create a new record.
            • +
          +
          • +
        +
        • +
      +
      • +
    • If there are no match rules for your model:
        +
      • Create a new record.
        • +
      +
      • +
    +
    • +
+

By default 2 rules are installed for production instances:

+
    +
  • One rule that will allow you to update companies based on their VAT, when +is_company is True.
    • +
  • One rule that will allow you to update users based on their login.
    • +
+

In demo instances there are more examples.

+

Table of contents

+ +
+

Configuration

+

To configure this module, you need to:

+
    +
  1. Go to Settings > Technical > Database Structure > Import Match.
    2. +
  2. Create.
    3. +
  3. Choose a Model.
    4. +
  4. Choose the Fields that conform a unique key in that model.
    5. +
  5. If the rule must be used only for certain imported values, check +Conditional and enter the exact string that is going to be imported +in Imported value.
      +
    1. Keep in mind that the match here is evaluated as a case sensitive +text string always. If you enter e.g. True, it will match that +string, but will not match 1 or true.
      2. +
    +
    6. +
  6. Save.
    7. +
+

In that list view, you can sort rules by drag and drop.

+
+
+

Usage

+

To use this module, you need to:

+
    +
  1. Follow steps in Configuration section above.
    2. +
  2. Go to any list view.
    3. +
  3. Press Import and follow the import procedure as usual.
    4. +
+
+
+

Known issues / Roadmap

+
    +
  • Add a setting to throw an error when multiple matches are found, instead of +falling back to creation of new record.
    • +
+
+
+

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 smashing it by providing a detailed and welcomed +feedback.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Grupo ESOC Ingeniería de Servicios
    • +
  • Tecnativa
    • +
+
+
+

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.

+

This module is part of the OCA/server-backend project on GitHub.

+

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

+
+
+
+ +