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.

115 lines
4.2 KiB

  1. =====================
  2. User roles by company
  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%2Fserver--backend-lightgray.png?logo=github
  15. :target: https://github.com/OCA/server-backend/tree/14.0/base_user_role_company
  16. :alt: OCA/server-backend
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/server-backend-14-0/server-backend-14-0-base_user_role_company
  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/253/14.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. Enable User Roles depending on the Companies selected.
  25. A company specific Role will only be enabled
  26. if it is set for **all** the currently selected companies.
  27. For example, if a user is "Sales Manager" only for Company A,
  28. it will see that role enabled only if Company A is selected.
  29. If the user selects Company A and Company B,
  30. then the "Sales Manager" role won't be enabled.
  31. **Table of contents**
  32. .. contents::
  33. :local:
  34. Configuration
  35. =============
  36. Roles are set on the User form.
  37. The "Company" additional column allows to set a Role as only valid for specific companies.
  38. There is also a "Active Role" techincal field, only visible in developer mode.
  39. It shows what roles are active, after applying the company selection rules.
  40. Usage
  41. =====
  42. Select the active companies from the web client widget, near the top right corner.
  43. When doing so, the User's security Groups are recomputed, based on the Roles.
  44. When the user changes the company selection, only the groups available to all active companies will be activated.
  45. For example:
  46. * A "SALES PERSON" and a "SALES MANAGER" roles are created.
  47. * A user is assigned to the roles:
  48. * "SALES PERSON", with no specific company assigned (meaning all)
  49. * "SALES MANAGER" only to "My Company (Chicago)"
  50. * When selecting active companies from the UI widget:
  51. * If only "My Company (San Francisco)" is active, "SALES PERSON" will be active.
  52. * If only "My Company (Chicago)" is active, "SALES PERSON" and "SALES MANAGER" will be active.
  53. * If both "My Company (San Francisco)" and "My Company (Chicago)" is active, "SALES PERSON" will be active.
  54. Bug Tracker
  55. ===========
  56. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-backend/issues>`_.
  57. In case of trouble, please check there if your issue has already been reported.
  58. If you spotted it first, help us smashing it by providing a detailed and welcomed
  59. `feedback <https://github.com/OCA/server-backend/issues/new?body=module:%20base_user_role_company%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  60. Do not contact contributors directly about support or help with technical issues.
  61. Credits
  62. =======
  63. Authors
  64. ~~~~~~~
  65. * Open Source Integrators
  66. Contributors
  67. ~~~~~~~~~~~~
  68. `Open Source Integrators <http://opensourceintegrators.com>`_
  69. * Daniel Reis <dreis@opensourceintegrators.com>
  70. * Chandresh Thakkar <cthakkr@opensourceintegrators.com>
  71. Maintainers
  72. ~~~~~~~~~~~
  73. This module is maintained by the OCA.
  74. .. image:: https://odoo-community.org/logo.png
  75. :alt: Odoo Community Association
  76. :target: https://odoo-community.org
  77. OCA, or the Odoo Community Association, is a nonprofit organization whose
  78. mission is to support the collaborative development of Odoo features and
  79. promote its widespread use.
  80. This module is part of the `OCA/server-backend <https://github.com/OCA/server-backend/tree/14.0/base_user_role_company>`_ project on GitHub.
  81. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.