mirror of
https://github.com/OCA/server-backend.git
synced 2025-02-18 09:52:42 +02:00
[IMP] base_user_role: pre-commit stuff
This commit is contained in:
committed by
Bert Van Groenendael
parent
31b595720c
commit
d0e2ef8813
@@ -17,36 +17,40 @@ User roles
|
|||||||
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
|
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
|
||||||
:alt: License: LGPL-3
|
:alt: License: LGPL-3
|
||||||
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github
|
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github
|
||||||
:target: https://github.com/OCA/server-backend/tree/16.0/base_user_role
|
:target: https://github.com/OCA/server-backend/tree/17.0/base_user_role
|
||||||
:alt: OCA/server-backend
|
:alt: OCA/server-backend
|
||||||
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
||||||
:target: https://translation.odoo-community.org/projects/server-backend-16-0/server-backend-16-0-base_user_role
|
:target: https://translation.odoo-community.org/projects/server-backend-17-0/server-backend-17-0-base_user_role
|
||||||
:alt: Translate me on Weblate
|
:alt: Translate me on Weblate
|
||||||
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
|
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
|
||||||
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-backend&target_branch=16.0
|
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-backend&target_branch=17.0
|
||||||
:alt: Try me on Runboat
|
:alt: Try me on Runboat
|
||||||
|
|
||||||
|badge1| |badge2| |badge3| |badge4| |badge5|
|
|badge1| |badge2| |badge3| |badge4| |badge5|
|
||||||
|
|
||||||
This module was written to extend the standard functionality regarding users
|
This module was written to extend the standard functionality regarding
|
||||||
and groups management.
|
users and groups management. It helps creating well-defined user roles
|
||||||
It helps creating well-defined user roles and associating them to users.
|
and associating them to users.
|
||||||
|
|
||||||
It can become very hard to maintain a large number of user profiles over time,
|
It can become very hard to maintain a large number of user profiles over
|
||||||
juggling with many technical groups. For this purpose, this module will help
|
time, juggling with many technical groups. For this purpose, this module
|
||||||
you to:
|
will help you to:
|
||||||
|
|
||||||
* define functional roles by aggregating low-level groups,
|
- define functional roles by aggregating low-level groups,
|
||||||
* set user accounts with the predefined roles (roles are cumulative),
|
- set user accounts with the predefined roles (roles are
|
||||||
* update groups of all relevant user accounts (all at once),
|
cumulative),
|
||||||
* ensure that user accounts will have the groups defined in their roles
|
- update groups of all relevant user accounts (all at once),
|
||||||
(nothing more, nothing less). In other words, you can not set groups
|
- ensure that user accounts will have the groups defined in their
|
||||||
manually on a user as long as there is roles configured on it,
|
roles (nothing more, nothing less). In other words, you can not
|
||||||
* activate/deactivate roles depending on the date (useful to plan holidays, etc)
|
set groups manually on a user as long as there is roles configured
|
||||||
* get a quick overview of roles and the related user accounts.
|
on it,
|
||||||
|
- activate/deactivate roles depending on the date (useful to plan
|
||||||
|
holidays, etc)
|
||||||
|
- get a quick overview of roles and the related user accounts.
|
||||||
|
|
||||||
That way you make clear the different responsabilities within a company, and
|
That way you make clear the different responsabilities within a company,
|
||||||
are able to add and update user accounts in a scalable and reliable way.
|
and are able to add and update user accounts in a scalable and reliable
|
||||||
|
way.
|
||||||
|
|
||||||
**Table of contents**
|
**Table of contents**
|
||||||
|
|
||||||
@@ -57,42 +61,42 @@ Configuration
|
|||||||
=============
|
=============
|
||||||
|
|
||||||
To configure this module, you need to go to *Settings / Users / Roles*,
|
To configure this module, you need to go to *Settings / Users / Roles*,
|
||||||
and create a new role. From there, you can add groups to compose your role,
|
and create a new role. From there, you can add groups to compose your
|
||||||
and then associate users to it.
|
role, and then associate users to it.
|
||||||
|
|
||||||
You can also define default roles for a new user by editing the user called
|
You can also define default roles for a new user by editing the user
|
||||||
"Default User".
|
called "Default User".
|
||||||
|
|
||||||
Roles:
|
Roles:
|
||||||
|
|
||||||
.. figure:: https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/roles.png
|
|image1|
|
||||||
:width: 80 %
|
|
||||||
:align: center
|
|
||||||
|
|
||||||
Add groups:
|
Add groups:
|
||||||
|
|
||||||
.. figure:: https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/role_groups.png
|
|image2|
|
||||||
:width: 80 %
|
|
||||||
:align: center
|
|
||||||
|
|
||||||
Add users (with dates or not):
|
Add users (with dates or not):
|
||||||
|
|
||||||
.. figure:: https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/role_users.png
|
|image3|
|
||||||
:width: 80 %
|
|
||||||
:align: center
|
|
||||||
|
|
||||||
Instead of creating roles from scratch, it is possible to create a role
|
Instead of creating roles from scratch, it is possible to create a role
|
||||||
based on the groups of an existing user: select or open the user and choose
|
based on the groups of an existing user: select or open the user and
|
||||||
"Create role from user" in the action menu.
|
choose "Create role from user" in the action menu.
|
||||||
|
|
||||||
|
.. |image1| image:: https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/roles.png
|
||||||
|
.. |image2| image:: https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/role_groups.png
|
||||||
|
.. |image3| image:: https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/role_users.png
|
||||||
|
|
||||||
Usage
|
Usage
|
||||||
=====
|
=====
|
||||||
|
|
||||||
To use this module, you need to:
|
To use this module, you need to:
|
||||||
|
|
||||||
#. Go to Configuration / Users / Users choose user and set Roles:
|
1. Go to Configuration / Users / Users choose user and set Roles:
|
||||||
|
|
||||||
.. image:: https://raw.githubusercontent.com/OCA/server-backend/base_user_role/static/description/user_form.png
|
|image|
|
||||||
|
|
||||||
|
.. |image| image:: https://raw.githubusercontent.com/OCA/server-backend/base_user_role/static/description/user_form.png
|
||||||
|
|
||||||
Bug Tracker
|
Bug Tracker
|
||||||
===========
|
===========
|
||||||
@@ -100,7 +104,7 @@ Bug Tracker
|
|||||||
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-backend/issues>`_.
|
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-backend/issues>`_.
|
||||||
In case of trouble, please check there if your issue has already been reported.
|
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
|
If you spotted it first, help us to smash it by providing a detailed and welcomed
|
||||||
`feedback <https://github.com/OCA/server-backend/issues/new?body=module:%20base_user_role%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
`feedback <https://github.com/OCA/server-backend/issues/new?body=module:%20base_user_role%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
||||||
|
|
||||||
Do not contact contributors directly about support or help with technical issues.
|
Do not contact contributors directly about support or help with technical issues.
|
||||||
|
|
||||||
@@ -108,35 +112,40 @@ Credits
|
|||||||
=======
|
=======
|
||||||
|
|
||||||
Authors
|
Authors
|
||||||
~~~~~~~
|
-------
|
||||||
|
|
||||||
* ABF OSIELL
|
* ABF OSIELL
|
||||||
|
|
||||||
Contributors
|
Contributors
|
||||||
~~~~~~~~~~~~
|
------------
|
||||||
|
|
||||||
* Sébastien Alix <sebastien.alix@camptocamp.com>
|
- Sébastien Alix <sebastien.alix@camptocamp.com>
|
||||||
* Duc, Dao Dong <duc.dd@komit-consulting.com> (https://komit-consulting.com)
|
- Duc, Dao Dong <duc.dd@komit-consulting.com>
|
||||||
* Jean-Charles Drubay <jc@komit-consulting.com> (https://komit-consulting.com)
|
(https://komit-consulting.com)
|
||||||
* Alan Ramos <alan.ramos@jarsa.com.mx> (https://www.jarsa.com.mx)
|
- Jean-Charles Drubay <jc@komit-consulting.com>
|
||||||
* Harald Panten <harald.panten@sygel.es>
|
(https://komit-consulting.com)
|
||||||
* Kevin Khao <kevin.khao@akretion.com>
|
- Alan Ramos <alan.ramos@jarsa.com.mx> (https://www.jarsa.com.mx)
|
||||||
* Tatiana Deribina <tatiana.deribina@sprintit.fi> (https://sprintit.fi)
|
- Harald Panten <harald.panten@sygel.es>
|
||||||
* Guillem Casassas <guillem.casassas@forgeflow.com>
|
- Kevin Khao <kevin.khao@akretion.com>
|
||||||
* Guillaume Pothier <gpothier@caligrafix.cl>
|
- Tatiana Deribina <tatiana.deribina@sprintit.fi> (https://sprintit.fi)
|
||||||
|
- Guillem Casassas <guillem.casassas@forgeflow.com>
|
||||||
|
- Guillaume Pothier <gpothier@caligrafix.cl>
|
||||||
|
|
||||||
Do not contact contributors directly about support or help with technical issues.
|
Do not contact contributors directly about support or help with
|
||||||
|
technical issues.
|
||||||
|
|
||||||
Other credits
|
Other credits
|
||||||
~~~~~~~~~~~~~
|
-------------
|
||||||
|
|
||||||
Images
|
Images
|
||||||
------
|
~~~~~~
|
||||||
|
|
||||||
* Oxygen Team: `Icon <http://www.iconarchive.com/show/oxygen-icons-by-oxygen-icons.org/Actions-user-group-new-icon.html>`_ (LGPL)
|
- Oxygen Team:
|
||||||
|
`Icon <http://www.iconarchive.com/show/oxygen-icons-by-oxygen-icons.org/Actions-user-group-new-icon.html>`__
|
||||||
|
(LGPL)
|
||||||
|
|
||||||
Maintainers
|
Maintainers
|
||||||
~~~~~~~~~~~
|
-----------
|
||||||
|
|
||||||
This module is maintained by the OCA.
|
This module is maintained by the OCA.
|
||||||
|
|
||||||
@@ -162,6 +171,6 @@ Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:
|
|||||||
|
|
||||||
|maintainer-sebalix| |maintainer-jcdrubay| |maintainer-novawish|
|
|maintainer-sebalix| |maintainer-jcdrubay| |maintainer-novawish|
|
||||||
|
|
||||||
This module is part of the `OCA/server-backend <https://github.com/OCA/server-backend/tree/16.0/base_user_role>`_ project on GitHub.
|
This module is part of the `OCA/server-backend <https://github.com/OCA/server-backend/tree/17.0/base_user_role>`_ project on GitHub.
|
||||||
|
|
||||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||||
|
|||||||
3
base_user_role/pyproject.toml
Normal file
3
base_user_role/pyproject.toml
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
[build-system]
|
||||||
|
requires = ["whool"]
|
||||||
|
build-backend = "whool.buildapi"
|
||||||
22
base_user_role/readme/CONFIGURE.md
Normal file
22
base_user_role/readme/CONFIGURE.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
To configure this module, you need to go to *Settings / Users / Roles*,
|
||||||
|
and create a new role. From there, you can add groups to compose your
|
||||||
|
role, and then associate users to it.
|
||||||
|
|
||||||
|
You can also define default roles for a new user by editing the user
|
||||||
|
called "Default User".
|
||||||
|
|
||||||
|
Roles:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Add groups:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Add users (with dates or not):
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Instead of creating roles from scratch, it is possible to create a role
|
||||||
|
based on the groups of an existing user: select or open the user and
|
||||||
|
choose "Create role from user" in the action menu.
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
To configure this module, you need to go to *Settings / Users / Roles*,
|
|
||||||
and create a new role. From there, you can add groups to compose your role,
|
|
||||||
and then associate users to it.
|
|
||||||
|
|
||||||
You can also define default roles for a new user by editing the user called
|
|
||||||
"Default User".
|
|
||||||
|
|
||||||
Roles:
|
|
||||||
|
|
||||||
.. figure:: /OCA/server-backend/16.0/base_user_role/static/description/roles.png
|
|
||||||
:width: 80 %
|
|
||||||
:align: center
|
|
||||||
|
|
||||||
Add groups:
|
|
||||||
|
|
||||||
.. figure:: /OCA/server-backend/16.0/base_user_role/static/description/role_groups.png
|
|
||||||
:width: 80 %
|
|
||||||
:align: center
|
|
||||||
|
|
||||||
Add users (with dates or not):
|
|
||||||
|
|
||||||
.. figure:: /OCA/server-backend/16.0/base_user_role/static/description/role_users.png
|
|
||||||
:width: 80 %
|
|
||||||
:align: center
|
|
||||||
|
|
||||||
Instead of creating roles from scratch, it is possible to create a role
|
|
||||||
based on the groups of an existing user: select or open the user and choose
|
|
||||||
"Create role from user" in the action menu.
|
|
||||||
15
base_user_role/readme/CONTRIBUTORS.md
Normal file
15
base_user_role/readme/CONTRIBUTORS.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
- Sébastien Alix \<<sebastien.alix@camptocamp.com>\>
|
||||||
|
- Duc, Dao Dong \<<duc.dd@komit-consulting.com>\>
|
||||||
|
(<https://komit-consulting.com>)
|
||||||
|
- Jean-Charles Drubay \<<jc@komit-consulting.com>\>
|
||||||
|
(<https://komit-consulting.com>)
|
||||||
|
- Alan Ramos \<<alan.ramos@jarsa.com.mx>\> (<https://www.jarsa.com.mx>)
|
||||||
|
- Harald Panten \<<harald.panten@sygel.es>\>
|
||||||
|
- Kevin Khao \<<kevin.khao@akretion.com>\>
|
||||||
|
- Tatiana Deribina \<<tatiana.deribina@sprintit.fi>\>
|
||||||
|
(<https://sprintit.fi>)
|
||||||
|
- Guillem Casassas \<<guillem.casassas@forgeflow.com>\>
|
||||||
|
- Guillaume Pothier \<<gpothier@caligrafix.cl>\>
|
||||||
|
|
||||||
|
Do not contact contributors directly about support or help with
|
||||||
|
technical issues.
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
* Sébastien Alix <sebastien.alix@camptocamp.com>
|
|
||||||
* Duc, Dao Dong <duc.dd@komit-consulting.com> (https://komit-consulting.com)
|
|
||||||
* Jean-Charles Drubay <jc@komit-consulting.com> (https://komit-consulting.com)
|
|
||||||
* Alan Ramos <alan.ramos@jarsa.com.mx> (https://www.jarsa.com.mx)
|
|
||||||
* Harald Panten <harald.panten@sygel.es>
|
|
||||||
* Kevin Khao <kevin.khao@akretion.com>
|
|
||||||
* Tatiana Deribina <tatiana.deribina@sprintit.fi> (https://sprintit.fi)
|
|
||||||
* Guillem Casassas <guillem.casassas@forgeflow.com>
|
|
||||||
* Guillaume Pothier <gpothier@caligrafix.cl>
|
|
||||||
|
|
||||||
Do not contact contributors directly about support or help with technical issues.
|
|
||||||
5
base_user_role/readme/CREDITS.md
Normal file
5
base_user_role/readme/CREDITS.md
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
## Images
|
||||||
|
|
||||||
|
- Oxygen Team:
|
||||||
|
[Icon](http://www.iconarchive.com/show/oxygen-icons-by-oxygen-icons.org/Actions-user-group-new-icon.html)
|
||||||
|
(LGPL)
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
Images
|
|
||||||
------
|
|
||||||
|
|
||||||
* Oxygen Team: `Icon <http://www.iconarchive.com/show/oxygen-icons-by-oxygen-icons.org/Actions-user-group-new-icon.html>`_ (LGPL)
|
|
||||||
22
base_user_role/readme/DESCRIPTION.md
Normal file
22
base_user_role/readme/DESCRIPTION.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
This module was written to extend the standard functionality regarding
|
||||||
|
users and groups management. It helps creating well-defined user roles
|
||||||
|
and associating them to users.
|
||||||
|
|
||||||
|
It can become very hard to maintain a large number of user profiles over
|
||||||
|
time, juggling with many technical groups. For this purpose, this module
|
||||||
|
will help you to:
|
||||||
|
|
||||||
|
> - define functional roles by aggregating low-level groups,
|
||||||
|
> - set user accounts with the predefined roles (roles are cumulative),
|
||||||
|
> - update groups of all relevant user accounts (all at once),
|
||||||
|
> - ensure that user accounts will have the groups defined in their
|
||||||
|
> roles (nothing more, nothing less). In other words, you can not set
|
||||||
|
> groups manually on a user as long as there is roles configured on
|
||||||
|
> it,
|
||||||
|
> - activate/deactivate roles depending on the date (useful to plan
|
||||||
|
> holidays, etc)
|
||||||
|
> - get a quick overview of roles and the related user accounts.
|
||||||
|
|
||||||
|
That way you make clear the different responsabilities within a company,
|
||||||
|
and are able to add and update user accounts in a scalable and reliable
|
||||||
|
way.
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
This module was written to extend the standard functionality regarding users
|
|
||||||
and groups management.
|
|
||||||
It helps creating well-defined user roles and associating them to users.
|
|
||||||
|
|
||||||
It can become very hard to maintain a large number of user profiles over time,
|
|
||||||
juggling with many technical groups. For this purpose, this module will help
|
|
||||||
you to:
|
|
||||||
|
|
||||||
* define functional roles by aggregating low-level groups,
|
|
||||||
* set user accounts with the predefined roles (roles are cumulative),
|
|
||||||
* update groups of all relevant user accounts (all at once),
|
|
||||||
* ensure that user accounts will have the groups defined in their roles
|
|
||||||
(nothing more, nothing less). In other words, you can not set groups
|
|
||||||
manually on a user as long as there is roles configured on it,
|
|
||||||
* activate/deactivate roles depending on the date (useful to plan holidays, etc)
|
|
||||||
* get a quick overview of roles and the related user accounts.
|
|
||||||
|
|
||||||
That way you make clear the different responsabilities within a company, and
|
|
||||||
are able to add and update user accounts in a scalable and reliable way.
|
|
||||||
5
base_user_role/readme/USAGE.md
Normal file
5
base_user_role/readme/USAGE.md
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
To use this module, you need to:
|
||||||
|
|
||||||
|
1. Go to Configuration / Users / Users choose user and set Roles:
|
||||||
|
|
||||||
|

|
||||||
@@ -1,5 +0,0 @@
|
|||||||
To use this module, you need to:
|
|
||||||
|
|
||||||
#. Go to Configuration / Users / Users choose user and set Roles:
|
|
||||||
|
|
||||||
.. image:: /OCA/server-backend/base_user_role/static/description/user_form.png
|
|
||||||
@@ -369,27 +369,31 @@ ul.auto-toc {
|
|||||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||||
!! source digest: sha256:c476130dcc75dc43a4aa9cfcc84eba040aafbdb3b9ff2b672278a59bd46f91ef
|
!! source digest: sha256:c476130dcc75dc43a4aa9cfcc84eba040aafbdb3b9ff2b672278a59bd46f91ef
|
||||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||||
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-backend/tree/16.0/base_user_role"><img alt="OCA/server-backend" src="https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-backend-16-0/server-backend-16-0-base_user_role"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-backend&target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
|
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-backend/tree/17.0/base_user_role"><img alt="OCA/server-backend" src="https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-backend-17-0/server-backend-17-0-base_user_role"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-backend&target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
|
||||||
<p>This module was written to extend the standard functionality regarding users
|
<p>This module was written to extend the standard functionality regarding
|
||||||
and groups management.
|
users and groups management. It helps creating well-defined user roles
|
||||||
It helps creating well-defined user roles and associating them to users.</p>
|
and associating them to users.</p>
|
||||||
<p>It can become very hard to maintain a large number of user profiles over time,
|
<p>It can become very hard to maintain a large number of user profiles over
|
||||||
juggling with many technical groups. For this purpose, this module will help
|
time, juggling with many technical groups. For this purpose, this module
|
||||||
you to:</p>
|
will help you to:</p>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li>define functional roles by aggregating low-level groups,</li>
|
<li>define functional roles by aggregating low-level groups,</li>
|
||||||
<li>set user accounts with the predefined roles (roles are cumulative),</li>
|
<li>set user accounts with the predefined roles (roles are
|
||||||
|
cumulative),</li>
|
||||||
<li>update groups of all relevant user accounts (all at once),</li>
|
<li>update groups of all relevant user accounts (all at once),</li>
|
||||||
<li>ensure that user accounts will have the groups defined in their roles
|
<li>ensure that user accounts will have the groups defined in their
|
||||||
(nothing more, nothing less). In other words, you can not set groups
|
roles (nothing more, nothing less). In other words, you can not
|
||||||
manually on a user as long as there is roles configured on it,</li>
|
set groups manually on a user as long as there is roles configured
|
||||||
<li>activate/deactivate roles depending on the date (useful to plan holidays, etc)</li>
|
on it,</li>
|
||||||
|
<li>activate/deactivate roles depending on the date (useful to plan
|
||||||
|
holidays, etc)</li>
|
||||||
<li>get a quick overview of roles and the related user accounts.</li>
|
<li>get a quick overview of roles and the related user accounts.</li>
|
||||||
</ul>
|
</ul>
|
||||||
</blockquote>
|
</blockquote>
|
||||||
<p>That way you make clear the different responsabilities within a company, and
|
<p>That way you make clear the different responsabilities within a company,
|
||||||
are able to add and update user accounts in a scalable and reliable way.</p>
|
and are able to add and update user accounts in a scalable and reliable
|
||||||
|
way.</p>
|
||||||
<p><strong>Table of contents</strong></p>
|
<p><strong>Table of contents</strong></p>
|
||||||
<div class="contents local topic" id="contents">
|
<div class="contents local topic" id="contents">
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
@@ -411,25 +415,19 @@ are able to add and update user accounts in a scalable and reliable way.</p>
|
|||||||
<div class="section" id="configuration">
|
<div class="section" id="configuration">
|
||||||
<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
|
<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
|
||||||
<p>To configure this module, you need to go to <em>Settings / Users / Roles</em>,
|
<p>To configure this module, you need to go to <em>Settings / Users / Roles</em>,
|
||||||
and create a new role. From there, you can add groups to compose your role,
|
and create a new role. From there, you can add groups to compose your
|
||||||
and then associate users to it.</p>
|
role, and then associate users to it.</p>
|
||||||
<p>You can also define default roles for a new user by editing the user called
|
<p>You can also define default roles for a new user by editing the user
|
||||||
“Default User”.</p>
|
called “Default User”.</p>
|
||||||
<p>Roles:</p>
|
<p>Roles:</p>
|
||||||
<div class="figure align-center">
|
<p><img alt="image1" src="https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/roles.png" /></p>
|
||||||
<img alt="https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/roles.png" src="https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/roles.png" style="width: 80%;" />
|
|
||||||
</div>
|
|
||||||
<p>Add groups:</p>
|
<p>Add groups:</p>
|
||||||
<div class="figure align-center">
|
<p><img alt="image2" src="https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/role_groups.png" /></p>
|
||||||
<img alt="https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/role_groups.png" src="https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/role_groups.png" style="width: 80%;" />
|
|
||||||
</div>
|
|
||||||
<p>Add users (with dates or not):</p>
|
<p>Add users (with dates or not):</p>
|
||||||
<div class="figure align-center">
|
<p><img alt="image3" src="https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/role_users.png" /></p>
|
||||||
<img alt="https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/role_users.png" src="https://raw.githubusercontent.com/OCA/server-backend/16.0/base_user_role/static/description/role_users.png" style="width: 80%;" />
|
|
||||||
</div>
|
|
||||||
<p>Instead of creating roles from scratch, it is possible to create a role
|
<p>Instead of creating roles from scratch, it is possible to create a role
|
||||||
based on the groups of an existing user: select or open the user and choose
|
based on the groups of an existing user: select or open the user and
|
||||||
“Create role from user” in the action menu.</p>
|
choose “Create role from user” in the action menu.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="usage">
|
<div class="section" id="usage">
|
||||||
<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
|
<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
|
||||||
@@ -437,14 +435,14 @@ based on the groups of an existing user: select or open the user and choose
|
|||||||
<ol class="arabic simple">
|
<ol class="arabic simple">
|
||||||
<li>Go to Configuration / Users / Users choose user and set Roles:</li>
|
<li>Go to Configuration / Users / Users choose user and set Roles:</li>
|
||||||
</ol>
|
</ol>
|
||||||
<img alt="https://raw.githubusercontent.com/OCA/server-backend/base_user_role/static/description/user_form.png" src="https://raw.githubusercontent.com/OCA/server-backend/base_user_role/static/description/user_form.png" />
|
<p><img alt="image" src="https://raw.githubusercontent.com/OCA/server-backend/base_user_role/static/description/user_form.png" /></p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="bug-tracker">
|
<div class="section" id="bug-tracker">
|
||||||
<h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
|
<h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
|
||||||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-backend/issues">GitHub Issues</a>.
|
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-backend/issues">GitHub Issues</a>.
|
||||||
In case of trouble, please check there if your issue has already been reported.
|
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
|
If you spotted it first, help us to smash it by providing a detailed and welcomed
|
||||||
<a class="reference external" href="https://github.com/OCA/server-backend/issues/new?body=module:%20base_user_role%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
|
<a class="reference external" href="https://github.com/OCA/server-backend/issues/new?body=module:%20base_user_role%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
|
||||||
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="credits">
|
<div class="section" id="credits">
|
||||||
@@ -459,8 +457,10 @@ If you spotted it first, help us to smash it by providing a detailed and welcome
|
|||||||
<h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
|
<h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li>Sébastien Alix <<a class="reference external" href="mailto:sebastien.alix@camptocamp.com">sebastien.alix@camptocamp.com</a>></li>
|
<li>Sébastien Alix <<a class="reference external" href="mailto:sebastien.alix@camptocamp.com">sebastien.alix@camptocamp.com</a>></li>
|
||||||
<li>Duc, Dao Dong <<a class="reference external" href="mailto:duc.dd@komit-consulting.com">duc.dd@komit-consulting.com</a>> (<a class="reference external" href="https://komit-consulting.com">https://komit-consulting.com</a>)</li>
|
<li>Duc, Dao Dong <<a class="reference external" href="mailto:duc.dd@komit-consulting.com">duc.dd@komit-consulting.com</a>>
|
||||||
<li>Jean-Charles Drubay <<a class="reference external" href="mailto:jc@komit-consulting.com">jc@komit-consulting.com</a>> (<a class="reference external" href="https://komit-consulting.com">https://komit-consulting.com</a>)</li>
|
(<a class="reference external" href="https://komit-consulting.com">https://komit-consulting.com</a>)</li>
|
||||||
|
<li>Jean-Charles Drubay <<a class="reference external" href="mailto:jc@komit-consulting.com">jc@komit-consulting.com</a>>
|
||||||
|
(<a class="reference external" href="https://komit-consulting.com">https://komit-consulting.com</a>)</li>
|
||||||
<li>Alan Ramos <<a class="reference external" href="mailto:alan.ramos@jarsa.com.mx">alan.ramos@jarsa.com.mx</a>> (<a class="reference external" href="https://www.jarsa.com.mx">https://www.jarsa.com.mx</a>)</li>
|
<li>Alan Ramos <<a class="reference external" href="mailto:alan.ramos@jarsa.com.mx">alan.ramos@jarsa.com.mx</a>> (<a class="reference external" href="https://www.jarsa.com.mx">https://www.jarsa.com.mx</a>)</li>
|
||||||
<li>Harald Panten <<a class="reference external" href="mailto:harald.panten@sygel.es">harald.panten@sygel.es</a>></li>
|
<li>Harald Panten <<a class="reference external" href="mailto:harald.panten@sygel.es">harald.panten@sygel.es</a>></li>
|
||||||
<li>Kevin Khao <<a class="reference external" href="mailto:kevin.khao@akretion.com">kevin.khao@akretion.com</a>></li>
|
<li>Kevin Khao <<a class="reference external" href="mailto:kevin.khao@akretion.com">kevin.khao@akretion.com</a>></li>
|
||||||
@@ -468,14 +468,17 @@ If you spotted it first, help us to smash it by providing a detailed and welcome
|
|||||||
<li>Guillem Casassas <<a class="reference external" href="mailto:guillem.casassas@forgeflow.com">guillem.casassas@forgeflow.com</a>></li>
|
<li>Guillem Casassas <<a class="reference external" href="mailto:guillem.casassas@forgeflow.com">guillem.casassas@forgeflow.com</a>></li>
|
||||||
<li>Guillaume Pothier <<a class="reference external" href="mailto:gpothier@caligrafix.cl">gpothier@caligrafix.cl</a>></li>
|
<li>Guillaume Pothier <<a class="reference external" href="mailto:gpothier@caligrafix.cl">gpothier@caligrafix.cl</a>></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
<p>Do not contact contributors directly about support or help with
|
||||||
|
technical issues.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="other-credits">
|
<div class="section" id="other-credits">
|
||||||
<h2><a class="toc-backref" href="#toc-entry-7">Other credits</a></h2>
|
<h2><a class="toc-backref" href="#toc-entry-7">Other credits</a></h2>
|
||||||
<div class="section" id="images">
|
<div class="section" id="images">
|
||||||
<h3><a class="toc-backref" href="#toc-entry-8">Images</a></h3>
|
<h3><a class="toc-backref" href="#toc-entry-8">Images</a></h3>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li>Oxygen Team: <a class="reference external" href="http://www.iconarchive.com/show/oxygen-icons-by-oxygen-icons.org/Actions-user-group-new-icon.html">Icon</a> (LGPL)</li>
|
<li>Oxygen Team:
|
||||||
|
<a class="reference external" href="http://www.iconarchive.com/show/oxygen-icons-by-oxygen-icons.org/Actions-user-group-new-icon.html">Icon</a>
|
||||||
|
(LGPL)</li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -488,7 +491,7 @@ mission is to support the collaborative development of Odoo features and
|
|||||||
promote its widespread use.</p>
|
promote its widespread use.</p>
|
||||||
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainers</a>:</p>
|
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainers</a>:</p>
|
||||||
<p><a class="reference external image-reference" href="https://github.com/sebalix"><img alt="sebalix" src="https://github.com/sebalix.png?size=40px" /></a> <a class="reference external image-reference" href="https://github.com/jcdrubay"><img alt="jcdrubay" src="https://github.com/jcdrubay.png?size=40px" /></a> <a class="reference external image-reference" href="https://github.com/novawish"><img alt="novawish" src="https://github.com/novawish.png?size=40px" /></a></p>
|
<p><a class="reference external image-reference" href="https://github.com/sebalix"><img alt="sebalix" src="https://github.com/sebalix.png?size=40px" /></a> <a class="reference external image-reference" href="https://github.com/jcdrubay"><img alt="jcdrubay" src="https://github.com/jcdrubay.png?size=40px" /></a> <a class="reference external image-reference" href="https://github.com/novawish"><img alt="novawish" src="https://github.com/novawish.png?size=40px" /></a></p>
|
||||||
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-backend/tree/16.0/base_user_role">OCA/server-backend</a> project on GitHub.</p>
|
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-backend/tree/17.0/base_user_role">OCA/server-backend</a> project on GitHub.</p>
|
||||||
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
Reference in New Issue
Block a user