[IMP] studio: update approval rules for v18

closes odoo/documentation#11200

Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
This commit is contained in:
xpl-odoo 2024-10-14 17:21:27 +02:00
parent 73638c012c
commit 868ecc61a5
5 changed files with 61 additions and 47 deletions

View File

@ -2,39 +2,47 @@
Approval rules Approval rules
============== ==============
Studio approval rules are used to automate approval processes for actions. They allow you to define Studio approval rules allow you to require the approval of one or several users before an action can
the criteria for when an approval is required before an action can be performed using a button. be performed using a button.
Configuration Configuration
============= =============
To add approval rules, proceed as follows: To add an approval rule:
#. :ref:`Open Studio <studio/access>` and switch to the required :doc:`view <views>`. #. :ref:`Open Studio <studio/access>` and switch to the required :doc:`view <views>`.
#. Select the button for which you want to add approval rules. #. Select the button to which the rule should be applied.
#. In the :guilabel:`Properties` tab on the left, enable the :guilabel:`Set approval rules` #. Click :icon:`fa-plus` :guilabel:`Add an approval step` in the :icon:`fa-server`
feature. :guilabel:`Properties` tab.
#. Specify the :guilabel:`Allowed Group` to limit the approval permission to a specific user #. Specify which users are responsible for approving the action by using one of the following fields
group. or both:
#. Select the :guilabel:`Responsible` user to create an activity for a specific user when approval
is requested from them.
#. Select the :guilabel:`Users to notify` via internal note.
#. Add a :guilabel:`Description` to be displayed in the :ref:`Approval dialog <approval-rules/use>`.
Optionally, you can also add conditions for the approval rule to be applied by clicking the - :guilabel:`Approvers` to specify one or several users;
:icon:`fa-filter` (:guilabel:`filter`) icon next to the :guilabel:`Allowed Group` field. - :guilabel:`Approver Group` to specify one user group.
To add another rule, click :guilabel:`Add an approval rule`. When there are multiple approval rules, .. note::
you can: An activity is created for all users set as :guilabel:`Approvers` when their approval is
requested.
- enable :guilabel:`Exclusive Approval` to require approvers to be different users; #. (*optional*) Select the :guilabel:`Users to Notify` via an internal note when the action is
- change the :guilabel:`Notification Order` of the approval rule so that the :guilabel:`Responsible` approved or rejected.
and :guilabel:`Users to notify` are only notified when the previous rule has been approved, and #. (*optional*) Add a :guilabel:`Description` to be displayed on the button.
their approval is required. If the approval rules have the same :guilabel:`Notification Order`,
all users are notified at the same time when the first approval is requested.
Click the :icon:`fa-trash` (:guilabel:`trash`) icon next to the :guilabel:`Allowed Group` field to .. tip::
delete the approval rule. You can specify under which condition(s) an approval step should be applied by clicking the
:icon:`fa-filter` (:guilabel:`filter`) icon next to the :guilabel:`Approvers` field.
To add another approval step, click :icon:`fa-plus` :guilabel:`Add an approval step`. When there are
multiple steps, you can:
- Enable :guilabel:`Exclusive Approval` on any step so that a user who approves a step cannot
approve another step for the same record.
- Change the :guilabel:`Approval Order` of the steps by selecting a number, `1` being the first
step, `2` the second step, and so on. A user responsible for a higher step can approve/reject
previous step(s) unless :guilabel:`Exclusive Approval` is selected.
Click the :icon:`fa-trash` (:guilabel:`trash`) icon next to the :guilabel:`Approvers` field to
remove an approval step.
.. tip:: .. tip::
You can create :ref:`user groups <access-rights/groups>` specifically for approvals. You can create :ref:`user groups <access-rights/groups>` specifically for approvals.
@ -44,36 +52,42 @@ delete the approval rule.
Use Use
=== ===
Once approval rules have been defined for a button: Once an approval rule has been defined for a button, a **user avatar** icon is displayed next to the
button's label for each approval step. Clicking an icon reveals the step(s).
- A **user avatar** icon is displayed next to the button's label for each approval rule that has .. image:: approval_rules/approval-button.png
been defined. :alt: Confirm button with two approval steps
.. image:: approval_rules/approvals-button.png .. note::
:alt: Confirm button with approval for purchase orders If an unauthorized user clicks the button, an error message is displayed and an activity is
created for the users specified in the :guilabel:`Approvers` field, if any.
- When an unauthorized user clicks the button, an error message is displayed in the top-right corner
and an activity is created for the user specified in the :guilabel:`Responsible` field.
- Only users from the group defined in the :guilabel:`Allowed Group` field are authorized to approve
or reject the action.
Authorized users can: Authorized users can:
- approve and perform the action by clicking the button; - Perform the action directly by clicking the button if it is the last/only approval step.
- approve the action and allow another user to perform it by clicking the **user avatar** icon next - Approve the action and let another user perform it - or move it to the next approval step - by
to the button's label, then clicking the :icon:`fa-check` (:guilabel:`Approve`) button in the clicking the **user avatar** icon next to the button's label, then clicking the :icon:`fa-check`
dialog that opens; (:guilabel:`approve`).
- reject the action by clicking the **user avatar** icon next to the button's label, then clicking - Reject the action by clicking the **user avatar** icon next to the button's label and then the
the :icon:`fa-times` (:guilabel:`Reject`) button in the dialog that opens. :icon:`fa-times` (:guilabel:`reject`) button.
- (only for users selected under the :guilabel:`Approvers` field) Delegate their approval rights to
one or several users for **all records** by:
.. image:: approval_rules/approvals-awaiting.png - Clicking the :icon:`oi-view-kanban` (:guilabel:`kanban view`) icon and then
:alt: Approval dialog :guilabel:`Delegate`.
- Selecting one or several :guilabel:`Approvers`, :guilabel:`Until` when they will have approval
rights (forever if left empty), and, optionally, the user(s) who should be notified via an
internal note using the :guilabel:`Notify to` field.
.. image:: approval_rules/delegate-dialog.png
:alt: Delegate to dialog
.. tip:: .. tip::
- The user who approved/rejected the action can revoke their decision by clicking the **user - A user who approves/rejects an action can revoke their decision by clicking the **user avatar**
avatar** icon next to the button's label, then clicking the :icon:`fa-undo` icon next to the button's label and then the :icon:`fa-undo` (:guilabel:`revoke`) button. They
(:guilabel:`Revoke`) button. can also revoke the decision of other users for steps with a lower :guilabel:`Approval Order`
unless :guilabel:`Exclusive Approval` is enabled.
- Approvals are tracked in the record's chatter. An approval entry is also created every time - Approvals are tracked in the record's chatter. An approval entry is also created every time
a Studio approval-related action is performed. To access the approval entries, :doc:`activate a Studio approval-related action is performed. To access approval entries, :doc:`activate the
the developer mode </applications/general/developer_mode>` and go to :menuselection:`Settings developer mode </applications/general/developer_mode>` and go to :menuselection:`Settings -->
--> Technical --> Studio Approval Entries`. Technical --> Studio Approval Entries`.

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.7 KiB