551 lines
18 KiB
HTML
551 lines
18 KiB
HTML
<?xml version="1.0" encoding="utf-8" ?>
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
|
||
<title>Track record changesets</title>
|
||
<style type="text/css">
|
||
|
||
/*
|
||
:Author: David Goodger (goodger@python.org)
|
||
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
|
||
:Copyright: This stylesheet has been placed in the public domain.
|
||
|
||
Default cascading style sheet for the HTML output of Docutils.
|
||
|
||
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
|
||
customize this style sheet.
|
||
*/
|
||
|
||
/* used to remove borders from tables and images */
|
||
.borderless, table.borderless td, table.borderless th {
|
||
border: 0 }
|
||
|
||
table.borderless td, table.borderless th {
|
||
/* Override padding for "table.docutils td" with "! important".
|
||
The right padding separates the table cells. */
|
||
padding: 0 0.5em 0 0 ! important }
|
||
|
||
.first {
|
||
/* Override more specific margin styles with "! important". */
|
||
margin-top: 0 ! important }
|
||
|
||
.last, .with-subtitle {
|
||
margin-bottom: 0 ! important }
|
||
|
||
.hidden {
|
||
display: none }
|
||
|
||
.subscript {
|
||
vertical-align: sub;
|
||
font-size: smaller }
|
||
|
||
.superscript {
|
||
vertical-align: super;
|
||
font-size: smaller }
|
||
|
||
a.toc-backref {
|
||
text-decoration: none ;
|
||
color: black }
|
||
|
||
blockquote.epigraph {
|
||
margin: 2em 5em ; }
|
||
|
||
dl.docutils dd {
|
||
margin-bottom: 0.5em }
|
||
|
||
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
||
overflow: hidden;
|
||
}
|
||
|
||
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
||
dl.docutils dt {
|
||
font-weight: bold }
|
||
*/
|
||
|
||
div.abstract {
|
||
margin: 2em 5em }
|
||
|
||
div.abstract p.topic-title {
|
||
font-weight: bold ;
|
||
text-align: center }
|
||
|
||
div.admonition, div.attention, div.caution, div.danger, div.error,
|
||
div.hint, div.important, div.note, div.tip, div.warning {
|
||
margin: 2em ;
|
||
border: medium outset ;
|
||
padding: 1em }
|
||
|
||
div.admonition p.admonition-title, div.hint p.admonition-title,
|
||
div.important p.admonition-title, div.note p.admonition-title,
|
||
div.tip p.admonition-title {
|
||
font-weight: bold ;
|
||
font-family: sans-serif }
|
||
|
||
div.attention p.admonition-title, div.caution p.admonition-title,
|
||
div.danger p.admonition-title, div.error p.admonition-title,
|
||
div.warning p.admonition-title, .code .error {
|
||
color: red ;
|
||
font-weight: bold ;
|
||
font-family: sans-serif }
|
||
|
||
/* Uncomment (and remove this text!) to get reduced vertical space in
|
||
compound paragraphs.
|
||
div.compound .compound-first, div.compound .compound-middle {
|
||
margin-bottom: 0.5em }
|
||
|
||
div.compound .compound-last, div.compound .compound-middle {
|
||
margin-top: 0.5em }
|
||
*/
|
||
|
||
div.dedication {
|
||
margin: 2em 5em ;
|
||
text-align: center ;
|
||
font-style: italic }
|
||
|
||
div.dedication p.topic-title {
|
||
font-weight: bold ;
|
||
font-style: normal }
|
||
|
||
div.figure {
|
||
margin-left: 2em ;
|
||
margin-right: 2em }
|
||
|
||
div.footer, div.header {
|
||
clear: both;
|
||
font-size: smaller }
|
||
|
||
div.line-block {
|
||
display: block ;
|
||
margin-top: 1em ;
|
||
margin-bottom: 1em }
|
||
|
||
div.line-block div.line-block {
|
||
margin-top: 0 ;
|
||
margin-bottom: 0 ;
|
||
margin-left: 1.5em }
|
||
|
||
div.sidebar {
|
||
margin: 0 0 0.5em 1em ;
|
||
border: medium outset ;
|
||
padding: 1em ;
|
||
background-color: #ffffee ;
|
||
width: 40% ;
|
||
float: right ;
|
||
clear: right }
|
||
|
||
div.sidebar p.rubric {
|
||
font-family: sans-serif ;
|
||
font-size: medium }
|
||
|
||
div.system-messages {
|
||
margin: 5em }
|
||
|
||
div.system-messages h1 {
|
||
color: red }
|
||
|
||
div.system-message {
|
||
border: medium outset ;
|
||
padding: 1em }
|
||
|
||
div.system-message p.system-message-title {
|
||
color: red ;
|
||
font-weight: bold }
|
||
|
||
div.topic {
|
||
margin: 2em }
|
||
|
||
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
||
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
||
margin-top: 0.4em }
|
||
|
||
h1.title {
|
||
text-align: center }
|
||
|
||
h2.subtitle {
|
||
text-align: center }
|
||
|
||
hr.docutils {
|
||
width: 75% }
|
||
|
||
img.align-left, .figure.align-left, object.align-left, table.align-left {
|
||
clear: left ;
|
||
float: left ;
|
||
margin-right: 1em }
|
||
|
||
img.align-right, .figure.align-right, object.align-right, table.align-right {
|
||
clear: right ;
|
||
float: right ;
|
||
margin-left: 1em }
|
||
|
||
img.align-center, .figure.align-center, object.align-center {
|
||
display: block;
|
||
margin-left: auto;
|
||
margin-right: auto;
|
||
}
|
||
|
||
table.align-center {
|
||
margin-left: auto;
|
||
margin-right: auto;
|
||
}
|
||
|
||
.align-left {
|
||
text-align: left }
|
||
|
||
.align-center {
|
||
clear: both ;
|
||
text-align: center }
|
||
|
||
.align-right {
|
||
text-align: right }
|
||
|
||
/* reset inner alignment in figures */
|
||
div.align-right {
|
||
text-align: inherit }
|
||
|
||
/* div.align-center * { */
|
||
/* text-align: left } */
|
||
|
||
.align-top {
|
||
vertical-align: top }
|
||
|
||
.align-middle {
|
||
vertical-align: middle }
|
||
|
||
.align-bottom {
|
||
vertical-align: bottom }
|
||
|
||
ol.simple, ul.simple {
|
||
margin-bottom: 1em }
|
||
|
||
ol.arabic {
|
||
list-style: decimal }
|
||
|
||
ol.loweralpha {
|
||
list-style: lower-alpha }
|
||
|
||
ol.upperalpha {
|
||
list-style: upper-alpha }
|
||
|
||
ol.lowerroman {
|
||
list-style: lower-roman }
|
||
|
||
ol.upperroman {
|
||
list-style: upper-roman }
|
||
|
||
p.attribution {
|
||
text-align: right ;
|
||
margin-left: 50% }
|
||
|
||
p.caption {
|
||
font-style: italic }
|
||
|
||
p.credits {
|
||
font-style: italic ;
|
||
font-size: smaller }
|
||
|
||
p.label {
|
||
white-space: nowrap }
|
||
|
||
p.rubric {
|
||
font-weight: bold ;
|
||
font-size: larger ;
|
||
color: maroon ;
|
||
text-align: center }
|
||
|
||
p.sidebar-title {
|
||
font-family: sans-serif ;
|
||
font-weight: bold ;
|
||
font-size: larger }
|
||
|
||
p.sidebar-subtitle {
|
||
font-family: sans-serif ;
|
||
font-weight: bold }
|
||
|
||
p.topic-title {
|
||
font-weight: bold }
|
||
|
||
pre.address {
|
||
margin-bottom: 0 ;
|
||
margin-top: 0 ;
|
||
font: inherit }
|
||
|
||
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
||
margin-left: 2em ;
|
||
margin-right: 2em }
|
||
|
||
pre.code .ln { color: grey; } /* line numbers */
|
||
pre.code, code { background-color: #eeeeee }
|
||
pre.code .comment, code .comment { color: #5C6576 }
|
||
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
|
||
pre.code .literal.string, code .literal.string { color: #0C5404 }
|
||
pre.code .name.builtin, code .name.builtin { color: #352B84 }
|
||
pre.code .deleted, code .deleted { background-color: #DEB0A1}
|
||
pre.code .inserted, code .inserted { background-color: #A3D289}
|
||
|
||
span.classifier {
|
||
font-family: sans-serif ;
|
||
font-style: oblique }
|
||
|
||
span.classifier-delimiter {
|
||
font-family: sans-serif ;
|
||
font-weight: bold }
|
||
|
||
span.interpreted {
|
||
font-family: sans-serif }
|
||
|
||
span.option {
|
||
white-space: nowrap }
|
||
|
||
span.pre {
|
||
white-space: pre }
|
||
|
||
span.problematic {
|
||
color: red }
|
||
|
||
span.section-subtitle {
|
||
/* font-size relative to parent (h1..h6 element) */
|
||
font-size: 80% }
|
||
|
||
table.citation {
|
||
border-left: solid 1px gray;
|
||
margin-left: 1px }
|
||
|
||
table.docinfo {
|
||
margin: 2em 4em }
|
||
|
||
table.docutils {
|
||
margin-top: 0.5em ;
|
||
margin-bottom: 0.5em }
|
||
|
||
table.footnote {
|
||
border-left: solid 1px black;
|
||
margin-left: 1px }
|
||
|
||
table.docutils td, table.docutils th,
|
||
table.docinfo td, table.docinfo th {
|
||
padding-left: 0.5em ;
|
||
padding-right: 0.5em ;
|
||
vertical-align: top }
|
||
|
||
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
||
font-weight: bold ;
|
||
text-align: left ;
|
||
white-space: nowrap ;
|
||
padding-left: 0 }
|
||
|
||
/* "booktabs" style (no vertical lines) */
|
||
table.docutils.booktabs {
|
||
border: 0px;
|
||
border-top: 2px solid;
|
||
border-bottom: 2px solid;
|
||
border-collapse: collapse;
|
||
}
|
||
table.docutils.booktabs * {
|
||
border: 0px;
|
||
}
|
||
table.docutils.booktabs th {
|
||
border-bottom: thin solid;
|
||
text-align: left;
|
||
}
|
||
|
||
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
||
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
||
font-size: 100% }
|
||
|
||
ul.auto-toc {
|
||
list-style-type: none }
|
||
|
||
</style>
|
||
</head>
|
||
<body>
|
||
<div class="document" id="track-record-changesets">
|
||
<h1 class="title">Track record changesets</h1>
|
||
|
||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||
!! This file is generated by oca-gen-addon-readme !!
|
||
!! changes will be overwritten. !!
|
||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-tools/tree/14.0/base_changeset"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-14-0/server-tools-14-0-base_changeset"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/149/14.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
|
||
<p>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.</p>
|
||
<div class="section" id="what-is-a-changeset">
|
||
<h1>What is a changeset</h1>
|
||
<p>A changeset is a list of changes made on a record.</p>
|
||
<p>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.</p>
|
||
<div class="admonition important">
|
||
<p class="first admonition-title">Important</p>
|
||
<p class="last">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.
|
||
<a class="reference external" href="https://odoo-community.org/page/development-status">More details on development status</a></p>
|
||
</div>
|
||
<p><strong>Table of contents</strong></p>
|
||
<div class="contents local topic" id="contents">
|
||
<ul class="simple">
|
||
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="configuration">
|
||
<h2><a class="toc-backref" href="#id1">Configuration</a></h2>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="access-rights">
|
||
<h1>Access Rights</h1>
|
||
<p>The changesets rules must be edited by users with the group <tt class="docutils literal">Changesets
|
||
Configuration</tt>. The changesets can be applied or canceled only by users
|
||
with the group <tt class="docutils literal">Changesets Validations</tt></p>
|
||
</div>
|
||
<div class="section" id="changesets-rules">
|
||
<h1>Changesets Rules</h1>
|
||
<p>The changesets rules can be configured in <tt class="docutils literal">Configuration >
|
||
Record Changesets > Fields Rules</tt>.</p>
|
||
<ul>
|
||
<li><p class="first">Configuration of rules</p>
|
||
<img alt="https://raw.githubusercontent.com/OCA/server-tools/14.0/base_changeset/static/src/img/rules.png" src="https://raw.githubusercontent.com/OCA/server-tools/14.0/base_changeset/static/src/img/rules.png" />
|
||
</li>
|
||
</ul>
|
||
<p>For each record field, an action can be defined:</p>
|
||
<ul class="simple">
|
||
<li>Auto: the changes made on this field are always applied</li>
|
||
<li>Validate: the changes made on this field must be manually confirmed by
|
||
a ‘Changesets User’ user</li>
|
||
<li>Never: the changes made on this field are always refused</li>
|
||
</ul>
|
||
<p>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.</p>
|
||
<p>The supported fields are:</p>
|
||
<ul class="simple">
|
||
<li>Char</li>
|
||
<li>Text</li>
|
||
<li>Date</li>
|
||
<li>Datetime</li>
|
||
<li>Integer</li>
|
||
<li>Float</li>
|
||
<li>Monetary</li>
|
||
<li>Boolean</li>
|
||
<li>Many2one</li>
|
||
</ul>
|
||
<p>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).</p>
|
||
<p>If a field has no rule, it is written to the record without changeset.</p>
|
||
<div class="section" id="usage">
|
||
<h2>Usage</h2>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="changeset-rules">
|
||
<h1>Changeset rules</h1>
|
||
<p>The first step is to configure the changeset rules. Once that done, writes on
|
||
records will be created as changesets.</p>
|
||
</div>
|
||
<div class="section" id="handling-changesets">
|
||
<h1>Handling changesets</h1>
|
||
<p>The list of all the changesets is in <tt class="docutils literal">Configuration > Record
|
||
Changesets > Changesets</tt>.</p>
|
||
<p>By default, only the pending changesets (waiting for validation) are shown.
|
||
Remove the “Pending” filter to show all the changesets.</p>
|
||
<ul>
|
||
<li><p class="first">Changeset waiting for validation</p>
|
||
<img alt="https://raw.githubusercontent.com/OCA/server-tools/14.0/base_changeset/static/src/img/changeset.png" src="https://raw.githubusercontent.com/OCA/server-tools/14.0/base_changeset/static/src/img/changeset.png" />
|
||
</li>
|
||
</ul>
|
||
<p>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.</p>
|
||
<p>A button on a changeset allows to apply or reject all the changes at
|
||
once.</p>
|
||
</div>
|
||
<div class="section" id="handling-single-changes">
|
||
<h1>Handling single changes</h1>
|
||
<p>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:</p>
|
||
<ul>
|
||
<li><p class="first">Badge with the number of pending changes</p>
|
||
<img alt="https://raw.githubusercontent.com/OCA/server-tools/14.0/base_changeset/static/src/img/badge.png" src="https://raw.githubusercontent.com/OCA/server-tools/14.0/base_changeset/static/src/img/badge.png" />
|
||
</li>
|
||
</ul>
|
||
<p>When you click on it:</p>
|
||
<ul>
|
||
<li><p class="first">Clicking the badge: red button to reject, green one to apply</p>
|
||
<img alt="https://raw.githubusercontent.com/OCA/server-tools/14.0/base_changeset/static/src/img/badge_click.png" src="https://raw.githubusercontent.com/OCA/server-tools/14.0/base_changeset/static/src/img/badge_click.png" />
|
||
</li>
|
||
</ul>
|
||
<p>Click the red button to reject the change, click the green one to apply it.</p>
|
||
</div>
|
||
<div class="section" id="custom-source-rules-in-your-addon">
|
||
<h1>Custom source rules in your addon</h1>
|
||
<p>Addons wanting to create changeset with their own rules should pass the
|
||
following keys in the context when they write on the record:</p>
|
||
<ul class="simple">
|
||
<li><tt class="docutils literal">__changeset_rules_source_model</tt>: name of the model which asks for
|
||
the change</li>
|
||
<li><tt class="docutils literal">__changeset_rules_source_id</tt>: id of the record which asks for the
|
||
change</li>
|
||
</ul>
|
||
<p>Also, they should extend the selection in
|
||
<tt class="docutils literal">ChangesetFieldRule._domain_source_models</tt> to add their model (the
|
||
same that is passed in <tt class="docutils literal">__changeset_rules_source_model</tt>).</p>
|
||
<p>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.</p>
|
||
<div class="section" id="known-issues-roadmap">
|
||
<h2>Known issues / Roadmap</h2>
|
||
<ul class="simple">
|
||
<li>Only a subset of the type of fields is actually supported</li>
|
||
<li>Multicompany not fully supported</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="bug-tracker">
|
||
<h2>Bug Tracker</h2>
|
||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
|
||
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
|
||
<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20base_changeset%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
|
||
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
||
</div>
|
||
<div class="section" id="credits">
|
||
<h2>Credits</h2>
|
||
<div class="section" id="authors">
|
||
<h3>Authors</h3>
|
||
<ul class="simple">
|
||
<li>Onestein</li>
|
||
<li>Camptocamp</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="contributors">
|
||
<h3>Contributors</h3>
|
||
<ul class="simple">
|
||
<li>Guewen Baconnier <<a class="reference external" href="mailto:guewen.baconnier@camptocamp.com">guewen.baconnier@camptocamp.com</a>></li>
|
||
<li>Denis Leemann <<a class="reference external" href="mailto:denis.leemann@camptocamp.com">denis.leemann@camptocamp.com</a>></li>
|
||
<li>Yannick Vaucher <<a class="reference external" href="mailto:yannick.vaucher@camptocamp.com">yannick.vaucher@camptocamp.com</a>></li>
|
||
<li>Dennis Sluijk <<a class="reference external" href="mailto:d.sluijk@onestein.nl">d.sluijk@onestein.nl</a>></li>
|
||
<li>Andrea Stirpe <<a class="reference external" href="mailto:a.stirpe@onestein.nl">a.stirpe@onestein.nl</a>></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="maintainers">
|
||
<h3>Maintainers</h3>
|
||
<p>This module is maintained by the OCA.</p>
|
||
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
|
||
<p>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.</p>
|
||
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
|
||
<p><a class="reference external" href="https://github.com/astirpe"><img alt="astirpe" src="https://github.com/astirpe.png?size=40px" /></a></p>
|
||
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/14.0/base_changeset">OCA/server-tools</a> project on GitHub.</p>
|
||
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</body>
|
||
</html>
|