You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

190 lines
7.6 KiB

  1. =================
  2. Partner Relations
  3. =================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fpartner--contact-lightgray.png?logo=github
  15. :target: https://github.com/OCA/partner-contact/tree/12.0/partner_multi_relation
  16. :alt: OCA/partner-contact
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/partner-contact-12-0/partner-contact-12-0-partner_multi_relation
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/134/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module aims to provide generic means to model relations between partners.
  25. Examples would be 'is sibling of' or 'is friend of', but also 'has contract X
  26. with' or 'is assistant of'. This way, you can encode your knowledge about your
  27. partners directly in your partner list.
  28. **Table of contents**
  29. .. contents::
  30. :local:
  31. Usage
  32. =====
  33. Relation Types
  34. ~~~~~~~~~~~~~~
  35. Before being able to use relations, you'll have define some first.
  36. Do that in Contacts / Relations / Partner relations.
  37. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/12.0/partner_multi_relation/static/description/relation_type_list.png
  38. A relation type has a name for both sides.
  39. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/12.0/partner_multi_relation/static/description/relation_type_form_empty.png
  40. To have an assistant-relation, you would name one side 'is assistant of' and the other side 'has assistant'.
  41. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/12.0/partner_multi_relation/static/description/relation_type_form_name_filled.png
  42. Partner Types
  43. ~~~~~~~~~~~~~
  44. The `Partner Type` fields allow to constrain what type of partners can be used
  45. on the left and right sides of the relation.
  46. * In the example above, the assistant-relation only makes sense between people, so you would choose 'Person' for both partner types.
  47. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/12.0/partner_multi_relation/static/description/relation_type_form_partner_type_filled.png
  48. * For a relation 'is a competitor of', both sides would be companies.
  49. * A relation 'has worked for' should have persons on the left side and companies on the right side.
  50. If you leave these fields empty, the relation is applicable to all types of partners.
  51. Partner Categories
  52. ~~~~~~~~~~~~~~~~~~
  53. You may use categories (tags) to further specify the type of partners.
  54. You could for example enforce the 'is member of' relation to accept only companies with the label 'Organization' on the right side.
  55. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/12.0/partner_multi_relation/static/description/relation_type_form_category_filled.png
  56. Reflexive
  57. ~~~~~~~~~
  58. A reflexive relation type allows a partner to be in relation with himself.
  59. For example, the CEO of a company could be his own manager.
  60. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/12.0/partner_multi_relation/static/description/relation_type_reflexive.png
  61. Symmetric
  62. ~~~~~~~~~
  63. A symetric relation has the same value for the left and right sides.
  64. For example, in a competitor relation, both companies are competitors of each other.
  65. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/12.0/partner_multi_relation/static/description/relation_type_symmetric.png
  66. Invalid Relation Handling
  67. ~~~~~~~~~~~~~~~~~~~~~~~~~
  68. When the configuration of a relation type changes, some relations between 2 partners may become invalid.
  69. For example, if the left partner type is set to `Person` and a relation already exists with a company on the right side,
  70. that relation becomes invalid.
  71. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/12.0/partner_multi_relation/static/description/relation_type_invalid_handling.png
  72. What happens with invalid relations is customizable on the relation type.
  73. 4 possible behaviors are available:
  74. * Do not allow change that will result in invalid relations
  75. * Allow existing relations that do not fit changed conditions
  76. * End relations per today, if they do not fit changed conditions
  77. * Delete relations that do not fit changed conditions
  78. Searching Partners With Relations
  79. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  80. To search for existing relations, go to `Contacts / Relations / Relations`.
  81. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/12.0/partner_multi_relation/static/description/search_relation.png
  82. To find all assistants in your database, fill in 'assistant' and
  83. autocomplete will propose to search for this type of relation.
  84. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/12.0/partner_multi_relation/static/description/search_relation_2.png
  85. Now if you want to find Colleen's assistant, you fill in 'Colleen' and one of the proposals
  86. is to search for partners having a relation with Colleen.
  87. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/12.0/partner_multi_relation/static/description/search_relation_3.png
  88. Searching Relations From Partner View
  89. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  90. A smart button is available on the partner form view to display the list of relations.
  91. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/12.0/partner_multi_relation/static/description/partner_form_view_smart_button.png
  92. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/12.0/partner_multi_relation/static/description/partner_form_view_smart_button_2.png
  93. Bug Tracker
  94. ===========
  95. Bugs are tracked on `GitHub Issues <https://github.com/OCA/partner-contact/issues>`_.
  96. In case of trouble, please check there if your issue has already been reported.
  97. If you spotted it first, help us smashing it by providing a detailed and welcomed
  98. `feedback <https://github.com/OCA/partner-contact/issues/new?body=module:%20partner_multi_relation%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  99. Do not contact contributors directly about support or help with technical issues.
  100. Credits
  101. =======
  102. Authors
  103. ~~~~~~~
  104. * Therp BV
  105. * Camptocamp
  106. Contributors
  107. ~~~~~~~~~~~~
  108. * Holger Brunn <hbrunn@therp.nl>
  109. * Stefan Rijnhart <stefan@therp.nl>
  110. * Ronald Portier <ronald@therp.nl>
  111. * Sandy Carter <sandy.carter@savoirfairelinux.com>
  112. * Bruno Joliveau <bruno.joliveau@savoirfairelinux.com>
  113. * Adriana Ierfino <adriana.ierfino@savoirfairelinux.com>
  114. * Numigi (tm) and all its contributors (https://bit.ly/numigiens)
  115. Maintainers
  116. ~~~~~~~~~~~
  117. This module is maintained by the OCA.
  118. .. image:: https://odoo-community.org/logo.png
  119. :alt: Odoo Community Association
  120. :target: https://odoo-community.org
  121. OCA, or the Odoo Community Association, is a nonprofit organization whose
  122. mission is to support the collaborative development of Odoo features and
  123. promote its widespread use.
  124. This module is part of the `OCA/partner-contact <https://github.com/OCA/partner-contact/tree/12.0/partner_multi_relation>`_ project on GitHub.
  125. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.