From 45bac4f7aeb447a27aad6ab777f1c4058978d60e Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Thu, 18 Jun 2020 01:45:33 +0000 Subject: [PATCH] [UPD] README.rst --- base_changeset/README.rst | 173 ++++-- base_changeset/static/description/index.html | 550 +++++++++++++++++++ 2 files changed, 666 insertions(+), 57 deletions(-) create mode 100644 base_changeset/static/description/index.html diff --git a/base_changeset/README.rst b/base_changeset/README.rst index d7b1df849..bcd94b7d4 100644 --- a/base_changeset/README.rst +++ b/base_changeset/README.rst @@ -1,15 +1,54 @@ -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html - :alt: License: AGPL-3 +======================= +Track record changesets +======================= -================== -Record Changesets -================== +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png + :target: https://odoo-community.org/page/development-status + :alt: Alpha +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :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--tools-lightgray.png?logo=github + :target: https://github.com/OCA/server-tools/tree/13.0/base_changeset + :alt: OCA/server-tools +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-tools-13-0/server-tools-13-0-base_changeset + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/149/13.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| This module extends the functionality of records. It allows to create changesets that must be validated when a record is modified instead of direct modifications. Rules allow to configure which field must be validated. +What is a changeset +------------------- + +A changeset is a list of changes made on a record. + +Some of the changes may be 'Pending', some 'Accepted' or 'Rejected' according +to the changeset rules. The 'Pending' changes require an interaction by the +approver user: only when that change is approved, its value is written on +the record. + +.. IMPORTANT:: + This is an alpha version, the data model and design can change at any time without warning. + Only for development or testing purpose, do not use in production. + `More details on development status `_ + +**Table of contents** + +.. contents:: + :local: + Configuration ============= @@ -23,9 +62,14 @@ with the group ``Changesets Validations`` Changesets Rules ---------------- -The changesets rules can be configured in ``Sales > Configuration > -Record Changesets > Fields Rules``. For each record field, an -action can be defined: +The changesets rules can be configured in ``Configuration > +Record Changesets > Fields Rules``. + +* Configuration of rules + + .. image:: https://raw.githubusercontent.com/OCA/server-tools/13.0/base_changeset/base_changeset/static/src/img/rules.png + +For each record field, an action can be defined: * Auto: the changes made on this field are always applied * Validate: the changes made on this field must be manually confirmed by @@ -44,6 +88,7 @@ The supported fields are: * Datetime * Integer * Float +* Monetary * Boolean * Many2one @@ -56,31 +101,24 @@ If a field has no rule, it is written to the record without changeset. Usage ===== -General case ------------- +Changeset rules +--------------- -The first step is to create the changeset rules, once that done, writes on +The first step is to configure the changeset rules. Once that done, writes on records will be created as changesets. -Finding changesets ------------------- - -A menu lists all the changesets in ``Sales > Configuration > Record -Changesets > Changesets``. - -However, it is more convenient to access them directly from the -records. Pending changesets can be accessed directly from the top right -of the records' view. A new filter on the records shows the records -having at least one pending changeset. - Handling changesets ------------------- -A changeset shows the list of the changes made on a record. Some of the -changes may be 'Pending', some 'Accepted' or 'Rejected' according to the -changeset rules. The only changes that need an action from the user are -'Pending' changes. When a change is accepted, the value is written on -the user. +The list of all the changesets is in ``Configuration > Record +Changesets > Changesets``. + +By default, only the pending changesets (waiting for validation) are shown. +Remove the "Pending" filter to show all the changesets. + +* Changeset waiting for validation + + .. image:: https://raw.githubusercontent.com/OCA/server-tools/13.0/base_changeset/base_changeset/static/src/img/changeset.png The changes view shows the name of the record's field, the Origin value and the New value alongside the state of the change. By clicking on the @@ -90,6 +128,27 @@ links for relations can be clicked on. A button on a changeset allows to apply or reject all the changes at once. +Handling single changes +----------------------- + +Accessing the changesets gives the full overview of all the changes made. +However, it is more convenient to access the single changes directly from the +records. When there is a pending change for a field you get a badge with the +number of pending changes next to it like this: + +* Badge with the number of pending changes + + .. image:: https://raw.githubusercontent.com/OCA/server-tools/13.0/base_changeset/base_changeset/static/src/img/badge.png + +When you click on it: + +* Clicking the badge: red button to reject, green one to apply + + .. image:: https://raw.githubusercontent.com/OCA/server-tools/13.0/base_changeset/base_changeset/static/src/img/badge_click.png + +Click the red button to reject the change, click the green one to apply it. + + Custom source rules in your addon --------------------------------- @@ -109,61 +168,61 @@ The source is used for the application of the rules, allowing to have a different rule for a different source. It is also stored on the changeset for information. -Screenshot: ------------ - -* Configuration of rules - - .. image:: base_changeset/static/src/img/rules.png - -* Changeset waiting for validation - - .. image:: base_changeset/static/src/img/changeset.png - - -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/134/10.0 - Known issues / Roadmap ====================== * Only a subset of the type of fields is actually supported +* Multicompany not fully supported 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 smashing it by providing a detailed and welcomed feedback +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 smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= -Images ------- +Authors +~~~~~~~ -* Odoo Community Association: `Icon `_. +* Onestein +* Camptocamp Contributors ------------- +~~~~~~~~~~~~ * Guewen Baconnier * Denis Leemann * Yannick Vaucher +* Dennis Sluijk +* Andrea Stirpe -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - 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. -To contribute to this module, please visit https://odoo-community.org. +.. |maintainer-astirpe| image:: https://github.com/astirpe.png?size=40px + :target: https://github.com/astirpe + :alt: astirpe + +Current `maintainer `__: + +|maintainer-astirpe| + +This module is part of the `OCA/server-tools `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/base_changeset/static/description/index.html b/base_changeset/static/description/index.html new file mode 100644 index 000000000..daea65e4b --- /dev/null +++ b/base_changeset/static/description/index.html @@ -0,0 +1,550 @@ + + + + + + +Track record changesets + + + +
+

Track record changesets

+ + +

Alpha License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runbot

+

This module extends the functionality of records. It allows to create +changesets that must be validated when a record is modified instead of direct +modifications. Rules allow to configure which field must be validated.

+
+

What is a changeset

+

A changeset is a list of changes made on a record.

+

Some of the changes may be ‘Pending’, some ‘Accepted’ or ‘Rejected’ according +to the changeset rules. The ‘Pending’ changes require an interaction by the +approver user: only when that change is approved, its value is written on +the record.

+
+

Important

+

This is an alpha version, the data model and design can change at any time without warning. +Only for development or testing purpose, do not use in production. +More details on development status

+
+

Table of contents

+ + +
+
+

Access Rights

+

The changesets rules must be edited by users with the group Changesets +Configuration. The changesets can be applied or canceled only by users +with the group Changesets Validations

+
+
+

Changesets Rules

+

The changesets rules can be configured in Configuration > +Record Changesets > Fields Rules.

+
    +

  • Configuration of rules

    +https://raw.githubusercontent.com/OCA/server-tools/13.0/base_changeset/base_changeset/static/src/img/rules.png +
    • +
+

For each record field, an action can be defined:

+
    +
  • Auto: the changes made on this field are always applied
    • +
  • Validate: the changes made on this field must be manually confirmed by +a ‘Changesets User’ user
    • +
  • Never: the changes made on this field are always refused
    • +
+

In any case, all the changes made by the users are always applied +directly on the users, but a ‘validated’ changeset is created for the +history.

+

The supported fields are:

+
    +
  • Char
    • +
  • Text
    • +
  • Date
    • +
  • Datetime
    • +
  • Integer
    • +
  • Float
    • +
  • Monetary
    • +
  • Boolean
    • +
  • Many2one
    • +
+

Rules can be global (no source model) or configured by source model. +Rules by source model have the priority. If a field is not configured +for the source model, it will use the global rule (if existing).

+

If a field has no rule, it is written to the record without changeset.

+
+

Usage

+
+
+
+

Changeset rules

+

The first step is to configure the changeset rules. Once that done, writes on +records will be created as changesets.

+
+
+

Handling changesets

+

The list of all the changesets is in Configuration > Record +Changesets > Changesets.

+

By default, only the pending changesets (waiting for validation) are shown. +Remove the “Pending” filter to show all the changesets.

+
    +

  • Changeset waiting for validation

    +https://raw.githubusercontent.com/OCA/server-tools/13.0/base_changeset/base_changeset/static/src/img/changeset.png +
    • +
+

The changes view shows the name of the record’s field, the Origin value +and the New value alongside the state of the change. By clicking on the +change in some cases a more detailed view is displayed, for instance, +links for relations can be clicked on.

+

A button on a changeset allows to apply or reject all the changes at +once.

+
+
+

Handling single changes

+

Accessing the changesets gives the full overview of all the changes made. +However, it is more convenient to access the single changes directly from the +records. When there is a pending change for a field you get a badge with the +number of pending changes next to it like this:

+
    +

  • Badge with the number of pending changes

    +https://raw.githubusercontent.com/OCA/server-tools/13.0/base_changeset/base_changeset/static/src/img/badge.png +
    • +
+

When you click on it:

+
    +

  • Clicking the badge: red button to reject, green one to apply

    +https://raw.githubusercontent.com/OCA/server-tools/13.0/base_changeset/base_changeset/static/src/img/badge_click.png +
    • +
+

Click the red button to reject the change, click the green one to apply it.

+
+
+

Custom source rules in your addon

+

Addons wanting to create changeset with their own rules should pass the +following keys in the context when they write on the record:

+
    +
  • __changeset_rules_source_model: name of the model which asks for +the change
    • +
  • __changeset_rules_source_id: id of the record which asks for the +change
    • +
+

Also, they should extend the selection in +ChangesetFieldRule._domain_source_models to add their model (the +same that is passed in __changeset_rules_source_model).

+

The source is used for the application of the rules, allowing to have a +different rule for a different source. It is also stored on the changeset for +information.

+
+

Known issues / Roadmap

+
    +
  • Only a subset of the type of fields is actually supported
    • +
  • Multicompany not fully supported
    • +
+
+
+

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 smashing it by providing a detailed and welcomed +feedback.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Onestein
    • +
  • Camptocamp
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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.

+

Current maintainer:

+

astirpe

+

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

+

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

+
+
+
+
+ +