Flectra/mis-builder
1
0
Fork 0
mirror of https://gitlab.com/flectra-community/mis-builder.git synced 2024-12-24 13:21:47 +00:00
Code Issues Projects Releases Wiki Activity
a6f8c9c307
mis-builder/mis_builder_budget/static/description/index.html

539 lines
18 KiB
HTML
Raw Normal View History

Automatic Update form OCA2FC Migrator
2021-03-23 19:36:01 +00:00
<?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>MIS Builder Budget</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="mis-builder-budget">
<h1 class="title">MIS Builder Budget</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="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.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/mis-builder/tree/11.0/mis_builder_budget"><img alt="OCA/mis-builder" src="https://img.shields.io/badge/github-OCA%2Fmis--builder-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/mis-builder-11-0/mis-builder-11-0-mis_builder_budget"><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/248/11.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>Create budgets for MIS reports.</p>
<p>This module lets you create budgets for any MIS report. Several budgets can be
created for a given report template (ie one budget per year). Budget figures
are provided by KPI or by GL account, with different time periods. A budget can
then be selected as a data source for a MIS report column, and the report will
show the budgeted values for each KPI, adjusted for the period of the column.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="id16">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id17">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#changelog" id="id18">Changelog</a><ul>
<li><a class="reference internal" href="#id1" id="id19">11.0.3.5.0 (2020-03-28)</a></li>
<li><a class="reference internal" href="#id3" id="id20">11.0.3.4.0 (2019-10-26)</a></li>
<li><a class="reference internal" href="#id5" id="id21">11.0.3.3.0 (2019-01-13)</a></li>
<li><a class="reference internal" href="#id7" id="id22">11.0.3.2.1 (2018-06-30)</a></li>
<li><a class="reference internal" href="#id9" id="id23">11.0.3.2.0 (2018-05-02)</a></li>
<li><a class="reference internal" href="#id11" id="id24">11.0.3.1.1 (2018-02-04)</a></li>
<li><a class="reference internal" href="#id13" id="id25">10.0.3.1.0 (2017-11-14)</a></li>
<li><a class="reference internal" href="#id15" id="id26">10.0.1.1.1 (2017-10-01)</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bug-tracker" id="id27">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id28">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id29">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id30">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id31">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id16">Usage</a></h1>
<p>There are two ways to use this module: create budgets by KPI or budgets by
GL accounts. Currently, the two methods cannot be combined in the same budget.</p>
<p><strong>Budget by KPIs</strong></p>
<p>To use this this mode, you first need to flag at least some KPI in a MIS report
to be budgetable. You also need to configure the accumulation method on the KPI
according to their type.</p>
<p>The accumulation method determines how budgeted values spanning over a
time period are transformed to match the reporting period.</p>
<ul class="simple">
<li>Sum: values of shorter period are added, values of longest or partially overlapping
periods are adjusted pro-rata temporis (eg monetary amount such as revenue).</li>
<li>Average: values of included period are averaged with a pro-rata temporis weight.
Typically used for values that do not accumulate over time (eg a number of employees).</li>
</ul>
<p>When KPI are configured, you need to create a budget, using the MIS Budget (by
KPIs) menu, then click on the budget items button to create or import the
budgeted amounts for all your KPI and time periods.</p>
<p><strong>Budget by GL accounts</strong></p>
<p>You can also create budgets by GL accounts. In this case, the budget is
populated with one line per GL account (and optionally analytic account and/or
tags) and time period.</p>
<p><strong>Add budget columns to report instances</strong></p>
<p>Finally, a column (aka period) must be added to a MIS report instance,
selecting your newly created budget as a data source. The data will be adjusted
to the reporting period when displayed. Columns can be compared by adding a
column of type “comparison” or “sum”.</p>
</div>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#id17">Known issues / Roadmap</a></h1>
<p>The mis_builder <a class="reference external" href="https://github.com/OCA/mis-builder/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement">roadmap</a>
and <a class="reference external" href="https://github.com/OCA/mis-builder/issues?q=is%3Aopen+is%3Aissue+label%3Abug">known issues</a> can
be found on GitHub.</p>
</div>
<div class="section" id="changelog">
<h1><a class="toc-backref" href="#id18">Changelog</a></h1>
<div class="section" id="id1">
<h2><a class="toc-backref" href="#id19">11.0.3.5.0 (2020-03-28)</a></h2>
<p><strong>Features</strong></p>
<ul class="simple">
<li>Budget by GL account: allow budgeting by GL account in addition to the
existing mechanism to budget by KPI. Budget items have a begin and end
date, and when reporting a pro-rata temporis adjustment is made to match
the reporting period. (<a class="reference external" href="https://github.com/OCA/mis-builder/issues/259">#259</a>)</li>
</ul>
</div>
<div class="section" id="id3">
<h2><a class="toc-backref" href="#id20">11.0.3.4.0 (2019-10-26)</a></h2>
<p><strong>Bugfixes</strong></p>
<ul class="simple">
<li>Consider analytic tags too when detecting overlapping budget items.
Previously only analytic account was considered, and this overlap detection
mechanism was overlooked when analytic tags were added to budget items. (<a class="reference external" href="https://github.com/oca/mis-builder/issues/241">#241</a>)</li>
</ul>
</div>
<div class="section" id="id5">
<h2><a class="toc-backref" href="#id21">11.0.3.3.0 (2019-01-13)</a></h2>
<p><strong>Features</strong></p>
<ul class="simple">
<li>Support analytic filters. (<a class="reference external" href="https://github.com/oca/mis-builder/issues/15">#15</a>)</li>
</ul>
</div>
<div class="section" id="id7">
<h2><a class="toc-backref" href="#id22">11.0.3.2.1 (2018-06-30)</a></h2>
<ul class="simple">
<li>[IMP] Support analytic tags in budget items
(<a class="reference external" href="https://github.com/OCA/mis-builder/pull/100">#100</a>)</li>
</ul>
</div>
<div class="section" id="id9">
<h2><a class="toc-backref" href="#id23">11.0.3.2.0 (2018-05-02)</a></h2>
<ul class="simple">
<li>[FIX] #NAME error in out-of-order computation of non
budgetable items in budget columns
(<a class="reference external" href="https://github.com/OCA/mis-builder/pull/69">#68</a>)</li>
</ul>
</div>
<div class="section" id="id11">
<h2><a class="toc-backref" href="#id24">11.0.3.1.1 (2018-02-04)</a></h2>
<p>Migration to Odoo 11. No new feature.
(<a class="reference external" href="https://github.com/OCA/mis-builder/pull/67">#67</a>)</p>
</div>
<div class="section" id="id13">
<h2><a class="toc-backref" href="#id25">10.0.3.1.0 (2017-11-14)</a></h2>
<p>New features:</p>
<ul class="simple">
<li>[ADD] multi-company record rule for MIS Budgets
(<a class="reference external" href="https://github.com/OCA/mis-builder/issues/27">#27</a>)</li>
</ul>
</div>
<div class="section" id="id15">
<h2><a class="toc-backref" href="#id26">10.0.1.1.1 (2017-10-01)</a></h2>
<p>First version.</p>
</div>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id27">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/mis-builder/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/mis-builder/issues/new?body=module:%20mis_builder_budget%0Aversion:%2011.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">
<h1><a class="toc-backref" href="#id28">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id29">Authors</a></h2>
<ul class="simple">
<li>ACSONE SA/NV</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id30">Contributors</a></h2>
<ul class="simple">
<li>Stéphane Bidoul &lt;<a class="reference external" href="mailto:stephane.bidoul&#64;acsone.eu">stephane.bidoul&#64;acsone.eu</a>&gt;</li>
<li>Adrien Peiffer &lt;<a class="reference external" href="mailto:adrien.peiffer&#64;acsone.eu">adrien.peiffer&#64;acsone.eu</a>&gt;</li>
<li>Benjamin Willig &lt;<a class="reference external" href="mailto:benjamin.willig&#64;acsone.eu">benjamin.willig&#64;acsone.eu</a>&gt;</li>
<li>Artem Kostyuk &lt;<a class="reference external" href="mailto:a.kostyuk&#64;mobilunity.com">a.kostyuk&#64;mobilunity.com</a>&gt;</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id31">Maintainers</a></h2>
<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/sbidoul"><img alt="sbidoul" src="https://github.com/sbidoul.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/mis-builder/tree/11.0/mis_builder_budget">OCA/mis-builder</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>
</body>
</html>
Reference in New Issue Copy Permalink