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.

160 lines
5.8 KiB

  1. ==========
  2. User roles
  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-LGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
  13. :alt: License: LGPL-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/12.0/base_user_role
  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-12-0/server-backend-12-0-base_user_role
  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/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module was written to extend the standard functionality regarding users
  25. and groups management.
  26. It helps creating well-defined user roles and associating them to users.
  27. It can become very hard to maintain a large number of user profiles over time,
  28. juggling with many technical groups. For this purpose, this module will help
  29. you to:
  30. * define functional roles by aggregating low-level groups,
  31. * set user accounts with the predefined roles (roles are cumulative),
  32. * update groups of all relevant user accounts (all at once),
  33. * ensure that user accounts will have the groups defined in their roles
  34. (nothing more, nothing less). In other words, you can not set groups
  35. manually on a user as long as there is roles configured on it,
  36. * activate/deactivate roles depending on the date (useful to plan holidays, etc)
  37. * get a quick overview of roles and the related user accounts.
  38. That way you make clear the different responsabilities within a company, and
  39. are able to add and update user accounts in a scalable and reliable way.
  40. **Table of contents**
  41. .. contents::
  42. :local:
  43. Configuration
  44. =============
  45. To configure this module, you need to go to *Configuration / Users / Roles*,
  46. and create a new role. From there, you can add groups to compose your role,
  47. and then associate users to it.
  48. You can also define default roles for a new user by editing the user called
  49. "Default User".
  50. Roles:
  51. .. figure:: https://raw.githubusercontent.com/OCA/server-backend/12.0/base_user_role/static/description/roles.png
  52. :width: 80 %
  53. :align: center
  54. Add groups:
  55. .. figure:: https://raw.githubusercontent.com/OCA/server-backend/12.0/base_user_role/static/description/role_groups.png
  56. :width: 80 %
  57. :align: center
  58. Add users (with dates or not):
  59. .. figure:: https://raw.githubusercontent.com/OCA/server-backend/12.0/base_user_role/static/description/role_users.png
  60. :width: 80 %
  61. :align: center
  62. Usage
  63. =====
  64. [ This file must be present and contains the usage instructions
  65. for end-users. As all other rst files included in the README,
  66. it MUST NOT contain reStructuredText sections
  67. only body text (paragraphs, lists, tables, etc). Should you need
  68. a more elaborate structure to explain the addon, please create a
  69. Sphinx documentation (which may include this file as a "quick start"
  70. section). ]
  71. To use this module, you need to:
  72. #. Go to Configuration / Users / Users choose user and set Roles:
  73. .. image:: https://raw.githubusercontent.com/OCA/server-backend/base_user_role/static/description/user_form.png
  74. Bug Tracker
  75. ===========
  76. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-backend/issues>`_.
  77. In case of trouble, please check there if your issue has already been reported.
  78. If you spotted it first, help us smashing it by providing a detailed and welcomed
  79. `feedback <https://github.com/OCA/server-backend/issues/new?body=module:%20base_user_role%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  80. Do not contact contributors directly about support or help with technical issues.
  81. Credits
  82. =======
  83. Authors
  84. ~~~~~~~
  85. * ABF OSIELL
  86. Contributors
  87. ~~~~~~~~~~~~
  88. * Sébastien Alix <sebastien.alix@osiell.com>
  89. * Duc, Dao Dong <duc.dd@komit-consulting.com> (https://komit-consulting.com)
  90. * Jean-Charles Drubay <jc@komit-consulting.com> (https://komit-consulting.com)
  91. * Antonio Russo <antonio.r@rwsdigital.com>
  92. Do not contact contributors directly about support or help with technical issues.
  93. Other credits
  94. ~~~~~~~~~~~~~
  95. Images
  96. ------
  97. * Oxygen Team: `Icon <http://www.iconarchive.com/show/oxygen-icons-by-oxygen-icons.org/Actions-user-group-new-icon.html>`_ (LGPL)
  98. Maintainers
  99. ~~~~~~~~~~~
  100. This module is maintained by the OCA.
  101. .. image:: https://odoo-community.org/logo.png
  102. :alt: Odoo Community Association
  103. :target: https://odoo-community.org
  104. OCA, or the Odoo Community Association, is a nonprofit organization whose
  105. mission is to support the collaborative development of Odoo features and
  106. promote its widespread use.
  107. .. |maintainer-ABF OSIELL| image:: https://github.com/ABF OSIELL.png?size=40px
  108. :target: https://github.com/ABF OSIELL
  109. :alt: ABF OSIELL
  110. .. |maintainer-jcdrubay| image:: https://github.com/jcdrubay.png?size=40px
  111. :target: https://github.com/jcdrubay
  112. :alt: jcdrubay
  113. Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:
  114. |maintainer-ABF OSIELL| |maintainer-jcdrubay|
  115. This module is part of the `OCA/server-backend <https://github.com/OCA/server-backend/tree/12.0/base_user_role>`_ project on GitHub.
  116. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.