diff --git a/base_user_role_company/README.rst b/base_user_role_company/README.rst index d37c35f2..ab33ac01 100644 --- a/base_user_role_company/README.rst +++ b/base_user_role_company/README.rst @@ -17,26 +17,25 @@ User roles by company :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html :alt: License: AGPL-3 .. |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_company + :target: https://github.com/OCA/server-backend/tree/17.0/base_user_role_company :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-16-0/server-backend-16-0-base_user_role_company + :target: https://translation.odoo-community.org/projects/server-backend-17-0/server-backend-17-0-base_user_role_company :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=16.0 + :target: https://runboat.odoo-community.org/builds?repo=OCA/server-backend&target_branch=17.0 :alt: Try me on Runboat |badge1| |badge2| |badge3| |badge4| |badge5| Enable User Roles depending on the Companies selected. -A company specific Role will only be enabled -if it is set for **all** the currently selected companies. +A company specific Role will only be enabled if it is set for **all** +the currently selected companies. -For example, if a user is "Sales Manager" only for Company A, -it will see that role enabled only if Company A is selected. -If the user selects Company A and Company B, -then the "Sales Manager" role won't be enabled. +For example, if a user is "Sales Manager" only for Company A, it will +see that role enabled only if Company A is selected. If the user selects +Company A and Company B, then the "Sales Manager" role won't be enabled. **Table of contents** @@ -48,31 +47,40 @@ Configuration Roles are set on the User form. -The "Company" additional column allows to set a Role as only valid for specific companies. +The "Company" additional column allows to set a Role as only valid for +specific companies. -There is also a "Active Role" techincal field, only visible in developer mode. -It shows what roles are active, after applying the company selection rules. +There is also a "Active Role" techincal field, only visible in developer +mode. It shows what roles are active, after applying the company +selection rules. Usage ===== -Select the active companies from the web client widget, near the top right corner. -When doing so, the User's security Groups are recomputed, based on the Roles. +Select the active companies from the web client widget, near the top +right corner. When doing so, the User's security Groups are recomputed, +based on the Roles. -When the user changes the company selection, only the groups available to all active companies will be activated. +When the user changes the company selection, only the groups available +to all active companies will be activated. For example: -* A "SALES PERSON" and a "SALES MANAGER" roles are created. +- A "SALES PERSON" and a "SALES MANAGER" roles are created. -* A user is assigned to the roles: - * "SALES PERSON", with no specific company assigned (meaning all) - * "SALES MANAGER" only to "My Company (Chicago)" +- A user is assigned to the roles: -* When selecting active companies from the UI widget: - * If only "My Company (San Francisco)" is active, "SALES PERSON" will be active. - * If only "My Company (Chicago)" is active, "SALES PERSON" and "SALES MANAGER" will be active. - * If both "My Company (San Francisco)" and "My Company (Chicago)" is active, "SALES PERSON" will be active. + - "SALES PERSON", with no specific company assigned (meaning all) + - "SALES MANAGER" only to "My Company (Chicago)" + +- When selecting active companies from the UI widget: + + - If only "My Company (San Francisco)" is active, "SALES PERSON" + will be active. + - If only "My Company (Chicago)" is active, "SALES PERSON" and + "SALES MANAGER" will be active. + - If both "My Company (San Francisco)" and "My Company (Chicago)" is + active, "SALES PERSON" will be active. Bug Tracker =========== @@ -80,7 +88,7 @@ Bug Tracker Bugs are tracked on `GitHub 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 `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. @@ -88,21 +96,21 @@ Credits ======= Authors -~~~~~~~ +------- * Open Source Integrators Contributors -~~~~~~~~~~~~ +------------ -`Open Source Integrators `_ +`Open Source Integrators `__ - * Daniel Reis - * Chandresh Thakkar - * Urvisha Desai + - Daniel Reis + - Chandresh Thakkar + - Urvisha Desai Maintainers -~~~~~~~~~~~ +----------- This module is maintained by the OCA. @@ -114,6 +122,6 @@ 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. -This module is part of the `OCA/server-backend `_ project on GitHub. +This module is part of the `OCA/server-backend `_ project on GitHub. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/base_user_role_company/pyproject.toml b/base_user_role_company/pyproject.toml new file mode 100644 index 00000000..4231d0cc --- /dev/null +++ b/base_user_role_company/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/base_user_role_company/readme/CONFIGURE.rst b/base_user_role_company/readme/CONFIGURE.md similarity index 57% rename from base_user_role_company/readme/CONFIGURE.rst rename to base_user_role_company/readme/CONFIGURE.md index c50bf9fe..ae04da43 100644 --- a/base_user_role_company/readme/CONFIGURE.rst +++ b/base_user_role_company/readme/CONFIGURE.md @@ -1,6 +1,8 @@ Roles are set on the User form. -The "Company" additional column allows to set a Role as only valid for specific companies. +The "Company" additional column allows to set a Role as only valid for +specific companies. -There is also a "Active Role" techincal field, only visible in developer mode. -It shows what roles are active, after applying the company selection rules. +There is also a "Active Role" techincal field, only visible in developer +mode. It shows what roles are active, after applying the company +selection rules. diff --git a/base_user_role_company/readme/CONTRIBUTORS.md b/base_user_role_company/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..a3a565f2 --- /dev/null +++ b/base_user_role_company/readme/CONTRIBUTORS.md @@ -0,0 +1,5 @@ +[Open Source Integrators](http://opensourceintegrators.com) + +> - Daniel Reis \<\> +> - Chandresh Thakkar \<\> +> - Urvisha Desai \<\> diff --git a/base_user_role_company/readme/CONTRIBUTORS.rst b/base_user_role_company/readme/CONTRIBUTORS.rst deleted file mode 100644 index 3b275b35..00000000 --- a/base_user_role_company/readme/CONTRIBUTORS.rst +++ /dev/null @@ -1,5 +0,0 @@ -`Open Source Integrators `_ - - * Daniel Reis - * Chandresh Thakkar - * Urvisha Desai diff --git a/base_user_role_company/readme/DESCRIPTION.md b/base_user_role_company/readme/DESCRIPTION.md new file mode 100644 index 00000000..2f93eb4b --- /dev/null +++ b/base_user_role_company/readme/DESCRIPTION.md @@ -0,0 +1,8 @@ +Enable User Roles depending on the Companies selected. + +A company specific Role will only be enabled if it is set for **all** +the currently selected companies. + +For example, if a user is "Sales Manager" only for Company A, it will +see that role enabled only if Company A is selected. If the user selects +Company A and Company B, then the "Sales Manager" role won't be enabled. diff --git a/base_user_role_company/readme/DESCRIPTION.rst b/base_user_role_company/readme/DESCRIPTION.rst deleted file mode 100644 index 68507f1e..00000000 --- a/base_user_role_company/readme/DESCRIPTION.rst +++ /dev/null @@ -1,9 +0,0 @@ -Enable User Roles depending on the Companies selected. - -A company specific Role will only be enabled -if it is set for **all** the currently selected companies. - -For example, if a user is "Sales Manager" only for Company A, -it will see that role enabled only if Company A is selected. -If the user selects Company A and Company B, -then the "Sales Manager" role won't be enabled. diff --git a/base_user_role_company/readme/USAGE.md b/base_user_role_company/readme/USAGE.md new file mode 100644 index 00000000..37769b5d --- /dev/null +++ b/base_user_role_company/readme/USAGE.md @@ -0,0 +1,22 @@ +Select the active companies from the web client widget, near the top +right corner. When doing so, the User's security Groups are recomputed, +based on the Roles. + +When the user changes the company selection, only the groups available +to all active companies will be activated. + +For example: + +- A "SALES PERSON" and a "SALES MANAGER" roles are created. + +- A user is assigned to the roles: + - "SALES PERSON", with no specific company assigned (meaning all) + - "SALES MANAGER" only to "My Company (Chicago)" + +- When selecting active companies from the UI widget: + - If only "My Company (San Francisco)" is active, "SALES PERSON" will + be active. + - If only "My Company (Chicago)" is active, "SALES PERSON" and "SALES + MANAGER" will be active. + - If both "My Company (San Francisco)" and "My Company (Chicago)" is + active, "SALES PERSON" will be active. diff --git a/base_user_role_company/readme/USAGE.rst b/base_user_role_company/readme/USAGE.rst deleted file mode 100644 index 88dce6bc..00000000 --- a/base_user_role_company/readme/USAGE.rst +++ /dev/null @@ -1,17 +0,0 @@ -Select the active companies from the web client widget, near the top right corner. -When doing so, the User's security Groups are recomputed, based on the Roles. - -When the user changes the company selection, only the groups available to all active companies will be activated. - -For example: - -* A "SALES PERSON" and a "SALES MANAGER" roles are created. - -* A user is assigned to the roles: - * "SALES PERSON", with no specific company assigned (meaning all) - * "SALES MANAGER" only to "My Company (Chicago)" - -* When selecting active companies from the UI widget: - * If only "My Company (San Francisco)" is active, "SALES PERSON" will be active. - * If only "My Company (Chicago)" is active, "SALES PERSON" and "SALES MANAGER" will be active. - * If both "My Company (San Francisco)" and "My Company (Chicago)" is active, "SALES PERSON" will be active. diff --git a/base_user_role_company/static/description/index.html b/base_user_role_company/static/description/index.html index 7f7893cc..d0cea181 100644 --- a/base_user_role_company/static/description/index.html +++ b/base_user_role_company/static/description/index.html @@ -1,3 +1,4 @@ + @@ -368,14 +369,13 @@ ul.auto-toc { !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! source digest: sha256:412b244590f18253b21a2f15b15c2cbbc8ec3decfc64dbf12973646123cb3193 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

Beta License: AGPL-3 OCA/server-backend Translate me on Weblate Try me on Runboat

+

Beta License: AGPL-3 OCA/server-backend Translate me on Weblate Try me on Runboat

Enable User Roles depending on the Companies selected.

-

A company specific Role will only be enabled -if it is set for all the currently selected companies.

-

For example, if a user is “Sales Manager” only for Company A, -it will see that role enabled only if Company A is selected. -If the user selects Company A and Company B, -then the “Sales Manager” role won’t be enabled.

+

A company specific Role will only be enabled if it is set for all +the currently selected companies.

+

For example, if a user is “Sales Manager” only for Company A, it will +see that role enabled only if Company A is selected. If the user selects +Company A and Company B, then the “Sales Manager” role won’t be enabled.

Table of contents

    @@ -393,36 +393,35 @@ then the “Sales Manager” role won’t be enabled.

    Configuration

    Roles are set on the User form.

    -

    The “Company” additional column allows to set a Role as only valid for specific companies.

    -

    There is also a “Active Role” techincal field, only visible in developer mode. -It shows what roles are active, after applying the company selection rules.

    +

    The “Company” additional column allows to set a Role as only valid for +specific companies.

    +

    There is also a “Active Role” techincal field, only visible in developer +mode. It shows what roles are active, after applying the company +selection rules.

    Usage

    -

    Select the active companies from the web client widget, near the top right corner. -When doing so, the User’s security Groups are recomputed, based on the Roles.

    -

    When the user changes the company selection, only the groups available to all active companies will be activated.

    +

    Select the active companies from the web client widget, near the top +right corner. When doing so, the User’s security Groups are recomputed, +based on the Roles.

    +

    When the user changes the company selection, only the groups available +to all active companies will be activated.

    For example:

    • A “SALES PERSON” and a “SALES MANAGER” roles are created.
      • -
    • -
      A user is assigned to the roles:
      -
        +
      • A user is assigned to the roles:
        • “SALES PERSON”, with no specific company assigned (meaning all)
        • “SALES MANAGER” only to “My Company (Chicago)”
        -
      -
      • -
    • -
      When selecting active companies from the UI widget:
      -
        -
      • If only “My Company (San Francisco)” is active, “SALES PERSON” will be active.
        • -
      • If only “My Company (Chicago)” is active, “SALES PERSON” and “SALES MANAGER” will be active.
        • -
      • If both “My Company (San Francisco)” and “My Company (Chicago)” is active, “SALES PERSON” will be active.
        • +
      • When selecting active companies from the UI widget:
          +
        • If only “My Company (San Francisco)” is active, “SALES PERSON” +will be active.
          • +
        • If only “My Company (Chicago)” is active, “SALES PERSON” and +“SALES MANAGER” will be active.
          • +
        • If both “My Company (San Francisco)” and “My Company (Chicago)” is +active, “SALES PERSON” will be active.
        -
      -
    @@ -431,7 +430,7 @@ When doing so, the User’s security Groups are recomputed, based on the Roles.<

    Bugs are tracked on GitHub 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.

    +feedback.

    Do not contact contributors directly about support or help with technical issues.

@@ -460,7 +459,7 @@ If you spotted it first, help us to smash it by providing a detailed and welcome

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.

-

This module is part of the OCA/server-backend project on GitHub.

+

This module is part of the OCA/server-backend project on GitHub.

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