You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

96 lines
2.9 KiB

  1. ==================
  2. Partner Changesets
  3. ==================
  4. Configuration
  5. =============
  6. Access Rights
  7. -------------
  8. The changesets rules must be edited by users with the group ``Changesets
  9. Configuration``. The changesets can be applied or canceled only by users
  10. with the group ``Changesets Validations``
  11. Changesets Rules
  12. ----------------
  13. The changesets rules can be configured in ``Sales > Configuration >
  14. Partner Changesets > Fields Rules``. For each partner field, an
  15. action can be defined:
  16. * Auto: the changes made on this field are always applied
  17. * Validate: the changes made on this field must be manually confirmed by
  18. a 'Changesets User' user
  19. * Never: the changes made on this field are always refused
  20. In any case, all the changes made by the users are always applied
  21. directly on the users, but a 'validated' changeset is created for the
  22. history.
  23. The supported fields are:
  24. * Char
  25. * Text
  26. * Date
  27. * Datetime
  28. * Integer
  29. * Float
  30. * Boolean
  31. * Many2one
  32. Rules can be global (no source model) or configured by source model.
  33. Rules by source model have the priority. If a field is not configured
  34. for the source model, it will use the global rule (if existing).
  35. If a field has no rule, it is written to the partner without changeset.
  36. Usage
  37. =====
  38. General case
  39. ------------
  40. The first step is to create the changeset rules, once that done,
  41. Addons wanting to create changeset with their own rules should pass the
  42. following keys in the context when they write on the partner:
  43. * ``__changeset_rules_source_model``: name of the model which asks for
  44. the change
  45. * ``__changeset_rules_source_id``: id of the record which asks for the
  46. change
  47. Also, they should extend the selection in
  48. ``ChangesetFieldRule._domain_source_models`` to add their model (the
  49. same that is passed in ``__changeset_rules_source_model``).
  50. The source is used for the application of the rules, it is also stored
  51. on the changeset for information.
  52. Finding changesets
  53. ------------------
  54. A menu shows all the changesets in ``Sales > Configuration > Partner
  55. Changesets > Changesets``.
  56. However, it is more convenient to access them directly from the
  57. partners. Pending changesets can be accessed directly from the top right
  58. of the partners' view. A new filter on the partners shows the partners
  59. having at least one pending changeset.
  60. Handling changesets
  61. -------------------
  62. A changeset shows the list of the changes made on a partner. Some of the
  63. changes may be 'Pending', some 'Accepted' or 'Rejected' according to the
  64. changeset rules. The only changes that need an action from the user are
  65. 'Pending' changes. When a change is accepted, the value is written on
  66. the user.
  67. The changes view shows the name of the partner's field, the Origin value
  68. and the New value alongside the state of the change. By clicking on the
  69. change in some cases a more detailed view is displayed, for instance,
  70. links for relations can be clicked on.
  71. A button on a changeset allows to apply or reject all the changes at
  72. once.