.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

==========
User roles
==========

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:b3aa00f609d45dcd82a69b2a3e13b327096ab1d25883b543e3e45538e854d40c
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
    :target: https://odoo-community.org/page/development-status
    :alt: Production/Stable
.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
    :alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github
    :target: https://github.com/OCA/server-backend/tree/18.0/base_user_role
    :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-18-0/server-backend-18-0-base_user_role
    :alt: Translate me on Weblate
.. |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=18.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

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.

**Table of contents**

.. contents::
   :local:

Configuration
=============

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:

|image1|

Add groups:

|image2|

Add users (with dates or not):

|image3|

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.

.. |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
=====

To use this module, you need to:

1. Go to Configuration / Users / Users choose user and set Roles:

|image|

.. |image| image:: https://raw.githubusercontent.com/OCA/server-backend/base_user_role/static/description/user_form.png

Bug Tracker
===========

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.
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:%2018.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.

Credits
=======

Authors
-------

* ABF OSIELL

Contributors
------------

- 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.

Other credits
-------------

Images
~~~~~~

- Oxygen Team:
  `Icon <http://www.iconarchive.com/show/oxygen-icons-by-oxygen-icons.org/Actions-user-group-new-icon.html>`__
  (LGPL)

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

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.

.. |maintainer-sebalix| image:: https://github.com/sebalix.png?size=40px
    :target: https://github.com/sebalix
    :alt: sebalix
.. |maintainer-jcdrubay| image:: https://github.com/jcdrubay.png?size=40px
    :target: https://github.com/jcdrubay
    :alt: jcdrubay
.. |maintainer-novawish| image:: https://github.com/novawish.png?size=40px
    :target: https://github.com/novawish
    :alt: novawish

Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-sebalix| |maintainer-jcdrubay| |maintainer-novawish| 

This module is part of the `OCA/server-backend <https://github.com/OCA/server-backend/tree/18.0/base_user_role>`_ project on GitHub.

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