Browse Source

Merge pull request #90 from acsone/7.0-mis_builder-lmi-2

7.0 mis builder backport from 8.0
pull/156/head
Stéphane Bidoul (ACSONE) 9 years ago
parent
commit
d7b417a584
  1. 21
      .travis.yml
  2. 2
      account_chart_report/__openerp__.py
  3. 27
      mis_builder/__init__.py
  4. 172
      mis_builder/__openerp__.py
  5. 42
      mis_builder/migrations/7.0.0.2/pre-migration.py
  6. 26
      mis_builder/models/__init__.py
  7. 433
      mis_builder/models/aep.py
  8. 149
      mis_builder/models/aggregate.py
  9. 920
      mis_builder/models/mis_builder.py
  10. 28
      mis_builder/report/__init__.py
  11. 138
      mis_builder/report/mis_builder_xls.py
  12. 11
      mis_builder/security/ir.model.access.csv
  13. 13
      mis_builder/security/mis_builder_security.xml
  14. BIN
      mis_builder/static/description/ex_dashboard.png
  15. BIN
      mis_builder/static/description/ex_report.png
  16. BIN
      mis_builder/static/description/ex_report_template.png
  17. BIN
      mis_builder/static/description/icon.png
  18. 79
      mis_builder/static/description/icon.svg
  19. 75
      mis_builder/static/description/index.html
  20. 13
      mis_builder/static/src/css/custom.css
  21. BIN
      mis_builder/static/src/img/icon.png
  22. 48
      mis_builder/static/src/js/mis_builder.js
  23. 62
      mis_builder/static/src/xml/mis_widget.xml
  24. 29
      mis_builder/tests/__init__.py
  25. 2
      mis_builder/tests/mis.report.csv
  26. 2
      mis_builder/tests/mis.report.instance.csv
  27. 2
      mis_builder/tests/mis.report.instance.period.csv
  28. 2
      mis_builder/tests/mis.report.kpi.csv
  29. 2
      mis_builder/tests/mis.report.query.csv
  30. 83
      mis_builder/tests/test_mis_builder.py
  31. 192
      mis_builder/views/mis_builder.xml
  32. 25
      mis_builder/wizard/__init__.py
  33. 87
      mis_builder/wizard/mis_builder_dashboard.py
  34. 33
      mis_builder/wizard/mis_builder_dashboard.xml
  35. 23
      mis_builder_demo/__init__.py
  36. 103
      mis_builder_demo/__openerp__.py
  37. 3
      mis_builder_demo/mis.report.csv
  38. 3
      mis_builder_demo/mis.report.instance.csv
  39. 8
      mis_builder_demo/mis.report.instance.period.csv
  40. 10
      mis_builder_demo/mis.report.kpi.csv
  41. 3
      mis_builder_demo/mis.report.query.csv
  42. 3
      oca_dependencies.txt

21
.travis.yml

@ -1,8 +1,14 @@
sudo: false
cache: pip
addons:
apt:
sources:
- pov-wkhtmltopdf
packages:
- expect-dev # provides unbuffer utility
- python-lxml # because pip installation is slow
- wkhtmltopdf
language: python
@ -10,23 +16,24 @@ python:
- "2.7"
env:
- VERSION="7.0" ODOO_REPO="odoo/odoo"
- VERSION="7.0" ODOO_REPO="OCA/OCB"
- VERSION="7.0" LINT_CHECK="1"
- VERSION="7.0" ODOO_REPO="odoo/odoo" LINT_CHECK="0"
- VERSION="7.0" ODOO_REPO="OCA/OCB" LINT_CHECK="0"
virtualenv:
system_site_packages: true
before_install:
- "export DISPLAY=:99.0"
- "sh -e /etc/init.d/xvfb start"
install:
- git clone https://github.com/OCA/reporting-engine ${HOME}/reporting-engine -b ${VERSION}
- git clone https://github.com/OCA/maintainer-quality-tools.git ${HOME}/maintainer-quality-tools
- wget http://download.gna.org/wkhtmltopdf/0.12/0.12.1/wkhtmltox-0.12.1_linux-precise-amd64.deb
- sudo dpkg -i wkhtmltox-0.12.1_linux-precise-amd64.deb
- export PATH=${HOME}/maintainer-quality-tools/travis:${PATH}
- travis_install_nightly
script:
- travis_run_flake8
- travis_run_tests
after_success:
coveralls
- travis_after_tests_success

2
account_chart_report/__openerp__.py

@ -25,7 +25,7 @@
'name': 'Print chart of accounts',
'version': '1.0',
'category': 'Reports/pdf',
'description': """Print chart of accounts.
'description': r"""Print chart of accounts.
This module add the menu Accounting \ ChartsPrint chart of Accounts
and allow to print the selected chart of accounts.

27
mis_builder/__init__.py

@ -0,0 +1,27 @@
# -*- encoding: utf-8 -*-
##############################################################################
#
# mis_builder module for Odoo, Management Information System Builder
# Copyright (C) 2014-2015 ACSONE SA/NV (<http://acsone.eu>)
#
# This file is a part of mis_builder
#
# mis_builder is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License v3 or later
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# mis_builder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License v3 or later for more details.
#
# You should have received a copy of the GNU Affero General Public License
# v3 or later along with this program.
# If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
from . import models
from . import wizard
from . import report

172
mis_builder/__openerp__.py

@ -0,0 +1,172 @@
# -*- coding: utf-8 -*-
##############################################################################
#
# mis_builder module for Odoo, Management Information System Builder
# Copyright (C) 2014-2015 ACSONE SA/NV (<http://acsone.eu>)
#
# This file is a part of mis_builder
#
# mis_builder is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License v3 or later
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# mis_builder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License v3 or later for more details.
#
# You should have received a copy of the GNU Affero General Public License
# v3 or later along with this program.
# If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
{
'name': 'MIS Builder',
'version': '0.2',
'category': 'Reporting',
'summary': """
Build 'Management Information System' Reports and Dashboards
""",
'description': """
.. 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
===========
MIS Builder
===========
This module allows you to build Management Information Systems dashboards.
Such style of reports presents KPI in rows and time periods in columns.
Reports mainly fetch data from account moves, but can also combine data coming
from arbitrary Odoo models. Reports can be exported to PDF, Excel and they
can be added to Odoo dashboards.
Installation
============
There is no specific installation procedure for this module.
Configuration and Usage
=======================
To configure this module, you need to:
* Go to Accounting > Configuration > Financial Reports > MIS Report Templates
where you can create report templates by defining KPI's. KPI's constitute
the rows of your reports. Such report templates are time independent.
* Then in Accounting > Reporting > MIS Reports you can create report instance
by binding the templates to time period, hence defining the columns of your
reports.
* From the MIS Report view, you can preview the report, add it to and Odoo
dashboard, and export it to Excel.
Developer notes
===============
A typical extension is to provide a mechanism to filter reports on analytic
dimensions or operational units. To implement this, you can override
_get_additional_move_line_filter and _get_additional_filter to further
filter move lines or queries based on a user selection. A typical use case
could be to add an analytic account field on mis.report.instance, or even
on mis.report.instance.period if you want different columns to show different
analytic accounts.
Known issues / Roadmap
======================
* Add 'Fiscal Year' period type.
* Allow selecting accounts by type. This is currently possible by expressing
a query such as balp[][('account_id.user_type.code', '=', ...)].
This will work but would be more efficient if one could write balp[
user_type=...], as it would involve much less queries to the database.
* More tests should be added. The first part is creating test data, then it
will be easier. At the minimum, We need the following test data:
* one account charts with a few normal accounts and view accounts,
* two fiscal years,
* an opening entry in the second fiscal year,
* to test multi-company consolidation, we need a second company with it's own
account chart and two fiscal years, but without opening entry; we also need
a third company which is the parent of the other two and has a
consolidation chart of account.
Bug Tracker
===========
Bugs are tracked on `GitHub Issues
<https://github.com/OCA/account-financial-reporting/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 `here <https://github.com/OCA/account-financial-reporting
/issues/new?body=module:%20mis_builder%0Aversion:%208.0%0A%0A**Steps%20to%20
reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior
**>`_.
Credits
=======
Contributors
------------
* Stéphane Bidoul <stephane.bidoul@acsone.eu>
* Laetitia Gangloff <laetitia.gangloff@acsone.eu>
* Adrien Peiffer <adrien.peiffer@acsone.eu>
* Jordi Ballester <jordi.ballester@eficent.com>
Maintainer
----------
.. 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 http://odoo-community.org.
""",
'author': 'ACSONE SA/NV,'
'Odoo Community Association (OCA)',
'website': 'http://acsone.eu',
'depends': [
'account',
'report_xls', # OCA/reporting-engine
],
'data': [
'wizard/mis_builder_dashboard.xml',
'views/mis_builder.xml',
'security/ir.model.access.csv',
'security/mis_builder_security.xml',
],
'test': [
],
'demo': [
'tests/mis.report.kpi.csv',
'tests/mis.report.query.csv',
'tests/mis.report.csv',
'tests/mis.report.instance.period.csv',
'tests/mis.report.instance.csv',
],
'js': [
'static/src/js/*.js'
],
'css': [
'static/src/css/*.css'
],
'qweb': [
'static/src/xml/*.xml'
],
'installable': True,
'application': True,
'auto_install': False,
'license': 'AGPL-3',
}

42
mis_builder/migrations/7.0.0.2/pre-migration.py

@ -0,0 +1,42 @@
# -*- encoding: utf-8 -*-
##############################################################################
#
# mis_builder module for Odoo, Management Information System Builder
# Copyright (C) 2014-2015 ACSONE SA/NV (<http://acsone.eu>)
#
# This file is a part of mis_builder
#
# mis_builder is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License v3 or later
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# mis_builder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License v3 or later for more details.
#
# You should have received a copy of the GNU Affero General Public License
# v3 or later along with this program.
# If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
def migrate(cr, version):
if not version:
return
cr.execute("""
ALTER TABLE mis_report_instance
ADD COLUMN root_account INTEGER
""")
cr.execute("""
UPDATE mis_report_instance
SET root_account = (
SELECT id FROM account_account
WHERE parent_id IS NULL
AND company_id = mis_report_instance.company_id
LIMIT 1
)
""")

26
mis_builder/models/__init__.py

@ -0,0 +1,26 @@
# -*- encoding: utf-8 -*-
##############################################################################
#
# mis_builder module for Odoo, Management Information System Builder
# Copyright (C) 2014-2015 ACSONE SA/NV (<http://acsone.eu>)
#
# This file is a part of mis_builder
#
# mis_builder is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License v3 or later
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# mis_builder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License v3 or later for more details.
#
# You should have received a copy of the GNU Affero General Public License
# v3 or later along with this program.
# If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
from . import mis_builder
from . import aep

433
mis_builder/models/aep.py

@ -0,0 +1,433 @@
# -*- coding: utf-8 -*-
##############################################################################
#
# mis_builder module for Odoo, Management Information System Builder
# Copyright (C) 2014-2015 ACSONE SA/NV (<http://acsone.eu>)
#
# This file is a part of mis_builder
#
# mis_builder is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License v3 or later
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# mis_builder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License v3 or later for more details.
#
# You should have received a copy of the GNU Affero General Public License
# v3 or later along with this program.
# If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
import re
from collections import defaultdict
from openerp.exceptions import Warning
from openerp import pooler
from openerp.osv import expression
from openerp.tools.safe_eval import safe_eval
from openerp.tools.translate import _
MODE_VARIATION = 'p'
MODE_INITIAL = 'i'
MODE_END = 'e'
class AccountingExpressionProcessor(object):
""" Processor for accounting expressions.
Expressions of the form <field><mode>[accounts][optional move line domain]
are supported, where:
* field is bal, crd, deb
* mode is i (initial balance), e (ending balance),
p (moves over period)
* accounts is a list of accounts, possibly containing % wildcards
* an optional domain on move lines allowing filters on eg analytic
accounts or journal
Examples:
* bal[70]: variation of the balance of moves on account 70
over the period (it is the same as balp[70]);
* bali[70,60]: balance of accounts 70 and 60 at the start of period;
* bale[1%]: balance of accounts starting with 1 at end of period.
How to use:
* repeatedly invoke parse_expr() for each expression containing
accounting variables as described above; this lets the processor
group domains and modes and accounts;
* when all expressions have been parsed, invoke done_parsing()
to notify the processor that it can prepare to query (mainly
search all accounts - children, consolidation - that will need to
be queried;
* for each period, call do_queries(), then call replace_expr() for each
expression to replace accounting variables with their resulting value
for the given period.
How it works:
* by accumulating the expressions before hand, it ensures to do the
strict minimum number of queries to the database (for each period,
one query per domain and mode);
* it queries using the orm read_group which reduces to a query with
sum on debit and credit and group by on account_id (note: it seems
the orm then does one query per account to fetch the account
name...);
* additionally, one query per view/consolidation account is done to
discover the children accounts.
"""
ACC_RE = re.compile(r"(?P<field>\bbal|\bcrd|\bdeb)"
r"(?P<mode>[pise])?"
r"(?P<accounts>_[a-zA-Z0-9]+|\[.*?\])"
r"(?P<domain>\[.*?\])?")
def __init__(self, cursor):
self.pool = pooler.get_pool(cursor.dbname)
# before done_parsing: {(domain, mode): set(account_codes)}
# after done_parsing: {(domain, mode): list(account_ids)}
self._map_account_ids = defaultdict(set)
self._account_ids_by_code = defaultdict(set)
def _load_account_codes(self, cr, uid, account_codes, root_account,
context=None):
account_obj = self.pool['account.account']
exact_codes = set()
like_codes = set()
for account_code in account_codes:
if account_code in self._account_ids_by_code:
continue
if account_code is None:
# by convention the root account is keyed as
# None in _account_ids_by_code, so it is consistent
# with what _parse_match_object returns for an
# empty list of account codes, ie [None]
exact_codes.add(root_account.code)
elif '%' in account_code:
like_codes.add(account_code)
else:
exact_codes.add(account_code)
account_ids = account_obj.search(
cr, uid,
[('code', 'in', list(exact_codes)),
('parent_id', 'child_of', root_account.id)],
context=context)
for account in account_obj.browse(
cr, uid, account_ids, context=context):
if account.code == root_account.code:
code = None
else:
code = account.code
if account.type in ('view', 'consolidation'):
self._account_ids_by_code[code].update(
account_obj._get_children_and_consol(
cr, uid,
[account.id],
context=context))
else:
self._account_ids_by_code[code].add(account.id)
for like_code in like_codes:
for account_id in account_obj.\
search(cr, uid,
[('code', 'like', like_code),
('parent_id', 'child_of', root_account.id)],
context=context):
account = account_obj.browse(cr, uid, account_id,
context=context)
if account.type in ('view', 'consolidation'):
self._account_ids_by_code[like_code].update(
account_obj._get_children_and_consol(
cr, uid,
self.env.cr, self.env.uid,
[account.id],
context=context))
else:
self._account_ids_by_code[like_code].add(account.id)
def _parse_match_object(self, mo):
"""Split a match object corresponding to an accounting variable
Returns field, mode, [account codes], (domain expression).
"""
field, mode, account_codes, domain = mo.groups()
if not mode:
mode = MODE_VARIATION
elif mode == 's':
mode = MODE_END
if account_codes.startswith('_'):
account_codes = account_codes[1:]
else:
account_codes = account_codes[1:-1]
if account_codes.strip():
account_codes = [a.strip() for a in account_codes.split(',')]
else:
account_codes = [None]
domain = domain or '[]'
domain = tuple(safe_eval(domain))
return field, mode, account_codes, domain
def parse_expr(self, expr):
"""Parse an expression, extracting accounting variables.
Domains and accounts are extracted and stored in the map
so when all expressions have been parsed, we know which
account codes to query for each domain and mode.
"""
for mo in self.ACC_RE.finditer(expr):
_, mode, account_codes, domain = self._parse_match_object(mo)
key = (domain, mode)
self._map_account_ids[key].update(account_codes)
def done_parsing(self, cr, uid, root_account, context=None):
"""Load account codes and replace account codes by
account ids in map."""
for key, account_codes in self._map_account_ids.items():
self._load_account_codes(cr, uid, account_codes, root_account,
context=context)
account_ids = set()
for account_code in account_codes:
account_ids.update(self._account_ids_by_code[account_code])
self._map_account_ids[key] = list(account_ids)
@classmethod
def has_account_var(cls, expr):
"""Test if an string contains an accounting variable."""
return bool(cls.ACC_RE.search(expr))
def get_aml_domain_for_expr(self, cr, uid, expr,
date_from, date_to,
period_from, period_to,
target_move, context=None):
""" Get a domain on account.move.line for an expression.
Prerequisite: done_parsing() must have been invoked.
Returns a domain that can be used to search on account.move.line.
"""
aml_domains = []
date_domain_by_mode = {}
for mo in self.ACC_RE.finditer(expr):
field, mode, account_codes, domain = self._parse_match_object(mo)
aml_domain = list(domain)
account_ids = set()
for account_code in account_codes:
account_ids.update(self._account_ids_by_code[account_code])
aml_domain.append(('account_id', 'in', tuple(account_ids)))
if field == 'crd':
aml_domain.append(('credit', '>', 0))
elif field == 'deb':
aml_domain.append(('debit', '>', 0))
aml_domains.append(expression.normalize_domain(aml_domain))
if mode not in date_domain_by_mode:
date_domain_by_mode[mode] = \
self.get_aml_domain_for_dates(cr, uid,
date_from, date_to,
period_from, period_to,
mode, target_move,
context=context)
return expression.OR(aml_domains) + \
expression.OR(date_domain_by_mode.values())
def _period_has_moves(self, cr, uid, period, context=None):
move_model = self.pool['account.move']
return bool(move_model.search(cr, uid,
[('period_id', '=', period.id)],
limit=1, context=context))
def _get_previous_opening_period(self, cr, uid, period, company_id,
context=None):
period_model = self.pool['account.period']
period_ids = period_model.search(
cr, uid,
[('date_start', '<=', period.date_start),
('special', '=', True),
('company_id', '=', company_id)],
order="date_start desc",
limit=1,
context=context)
periods = period_model.browse(cr, uid, period_ids, context=context)
return periods and periods[0]
def _get_previous_normal_period(self, cr, uid, period, company_id,
context=None):
period_model = self.pool['account.period']
period_ids = period_model.search(
cr, uid,
[('date_start', '<', period.date_start),
('special', '=', False),
('company_id', '=', company_id)],
order="date_start desc",
limit=1,
context=context)
periods = period_model.browse(cr, uid, period_ids, context=context)
return periods and periods[0]
def _get_first_normal_period(self, cr, uid, company_id, context=None):
period_model = self.pool['account.period']
period_ids = period_model.search(
cr, uid,
[('special', '=', False),
('company_id', '=', company_id)],
order="date_start asc",
limit=1,
context=context)
periods = period_model.browse(cr, uid, period_ids, context=context)
return periods and periods[0]
def _get_period_ids_between(self, cr, uid, period_from, period_to,
company_id, context=None):
period_model = self.pool['account.period']
period_ids = period_model.search(
cr, uid,
[('date_start', '>=', period_from.date_start),
('date_stop', '<=', period_to.date_stop),
('special', '=', False),
('company_id', '=', company_id)],
context=context)
if period_from.special:
period_ids.append(period_from.id)
return period_ids
def _get_period_company_ids(self, cr, uid, period_from, period_to,
context=None):
period_model = self.pool['account.period']
period_ids = period_model.search(
cr, uid,
[('date_start', '>=', period_from.date_start),
('date_stop', '<=', period_to.date_stop),
('special', '=', False)],
context=context)
periods = period_model.browse(cr, uid, period_ids, context=context)
return set([p.company_id.id for p in periods])
def _get_period_ids_for_mode(self, cr, uid, period_from, period_to, mode,
context=None):
assert not period_from.special
assert not period_to.special
assert period_from.company_id == period_to.company_id
assert period_from.date_start <= period_to.date_start
period_ids = []
for company_id in self._get_period_company_ids(cr, uid,
period_from, period_to,
context=context):
if mode == MODE_VARIATION:
period_ids.extend(self._get_period_ids_between(
cr, uid,
period_from, period_to, company_id,
context=context))
else:
if mode == MODE_INITIAL:
period_to = self._get_previous_normal_period(
cr, uid,
period_from, company_id,
context=context)
# look for opening period with moves
opening_period = self._get_previous_opening_period(
cr, uid,
period_from, company_id,
context=context)
if opening_period and \
self._period_has_moves(cr, uid, opening_period,
context=context):
# found opening period with moves
if opening_period.date_start == period_from.date_start and\
mode == MODE_INITIAL:
# if the opening period has the same start date as
# period_from, then we'll find the initial balance
# in the initial period and that's it
period_ids.append(opening_period.id)
continue
period_from = opening_period
else:
# no opening period with moves,
# use very first normal period
period_from = self._get_first_normal_period(
cr, uid, company_id, context=context)
if period_to:
period_ids.extend(self._get_period_ids_between(
cr, uid,
period_from, period_to, company_id,
context=context))
return period_ids
def get_aml_domain_for_dates(self, cr, uid, date_from, date_to,
period_from, period_to,
mode,
target_move,
context=None):
if period_from and period_to:
period_ids = self._get_period_ids_for_mode(
cr, uid,
period_from, period_to, mode,
context=context)
domain = [('period_id', 'in', period_ids)]
else:
if mode == MODE_VARIATION:
domain = [('date', '>=', date_from), ('date', '<=', date_to)]
else:
raise Warning(_("Modes i and e are only applicable for "
"fiscal periods"))
if target_move == 'posted':
domain.append(('move_id.state', '=', 'posted'))
return expression.normalize_domain(domain)
def do_queries(self, cr, uid, date_from, date_to, period_from, period_to,
target_move, additional_move_line_filter=None,
context=None):
"""Query sums of debit and credit for all accounts and domains
used in expressions.
This method must be executed after done_parsing().
"""
aml_model = self.pool['account.move.line']
# {(domain, mode): {account_id: (debit, credit)}}
self._data = defaultdict(dict)
domain_by_mode = {}
for key in self._map_account_ids:
domain, mode = key
if mode not in domain_by_mode:
domain_by_mode[mode] = \
self.get_aml_domain_for_dates(cr, uid,
date_from, date_to,
period_from, period_to,
mode, target_move,
context=context)
domain = list(domain) + domain_by_mode[mode]
domain.append(('account_id', 'in', self._map_account_ids[key]))
if additional_move_line_filter:
domain.extend(additional_move_line_filter)
# fetch sum of debit/credit, grouped by account_id
accs = aml_model.read_group(cr, uid, domain,
['debit', 'credit', 'account_id'],
['account_id'],
context=context)
for acc in accs:
self._data[key][acc['account_id'][0]] = \
(acc['debit'] or 0.0, acc['credit'] or 0.0)
def replace_expr(self, expr):
"""Replace accounting variables in an expression by their amount.
Returns a new expression string.
This method must be executed after do_queries().
"""
def f(mo):
field, mode, account_codes, domain = self._parse_match_object(mo)
key = (domain, mode)
account_ids_data = self._data[key]
v = 0.0
for account_code in account_codes:
account_ids = self._account_ids_by_code[account_code]
for account_id in account_ids:
debit, credit = \
account_ids_data.get(account_id, (0.0, 0.0))
if field == 'bal':
v += debit - credit
elif field == 'deb':
v += debit
elif field == 'crd':
v += credit
return '(' + repr(v) + ')'
return self.ACC_RE.sub(f, expr)

149
mis_builder/models/aggregate.py

@ -0,0 +1,149 @@
# -*- coding: utf-8 -*-
##############################################################################
#
# mis_builder module for Odoo, Management Information System Builder
# Copyright (C) 2014-2015 ACSONE SA/NV (<http://acsone.eu>)
#
# This file is a part of mis_builder
#
# mis_builder is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License v3 or later
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# mis_builder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License v3 or later for more details.
#
# You should have received a copy of the GNU Affero General Public License
# v3 or later along with this program.
# If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
def _sum(l):
""" Same as stdlib sum but returns None instead of 0
in case of empty sequence.
>>> sum([1])
1
>>> _sum([1])
1
>>> sum([1, 2])
3
>>> _sum([1, 2])
3
>>> sum([])
0
>>> _sum([])
"""
if not l:
return None
return sum(l)
def _avg(l):
""" Arithmetic mean of a sequence. Returns None in case of empty sequence.
>>> _avg([1])
1.0
>>> _avg([1, 2])
1.5
>>> _avg([])
"""
if not l:
return None
return sum(l) / float(len(l))
def _min(*args):
""" Same as stdlib min but returns None instead of exception
in case of empty sequence.
>>> min(1, 2)
1
>>> _min(1, 2)
1
>>> min([1, 2])
1
>>> _min([1, 2])
1
>>> min(1)
Traceback (most recent call last):
File "<stdin>", line 1, in ?
TypeError: 'int' object is not iterable
>>> _min(1)
Traceback (most recent call last):
File "<stdin>", line 1, in ?
TypeError: 'int' object is not iterable
>>> min([1])
1
>>> _min([1])
1
>>> min()
Traceback (most recent call last):
File "<stdin>", line 1, in ?
TypeError: min expected 1 arguments, got 0
>>> _min()
Traceback (most recent call last):
File "<stdin>", line 1, in ?
TypeError: min expected 1 arguments, got 0
>>> min([])
Traceback (most recent call last):
File "<stdin>", line 1, in ?
ValueError: min() arg is an empty sequence
>>> _min([])
"""
if len(args) == 1 and not args[0]:
return None
return min(*args)
def _max(*args):
""" Same as stdlib max but returns None instead of exception
in case of empty sequence.
>>> max(1, 2)
2
>>> _max(1, 2)
2
>>> max([1, 2])
2
>>> _max([1, 2])
2
>>> max(1)
Traceback (most recent call last):
File "<stdin>", line 1, in ?
TypeError: 'int' object is not iterable
>>> _max(1)
Traceback (most recent call last):
File "<stdin>", line 1, in ?
TypeError: 'int' object is not iterable
>>> max([1])
1
>>> _max([1])
1
>>> max()
Traceback (most recent call last):
File "<stdin>", line 1, in ?
TypeError: max expected 1 arguments, got 0
>>> _max()
Traceback (most recent call last):
File "<stdin>", line 1, in ?
TypeError: max expected 1 arguments, got 0
>>> max([])
Traceback (most recent call last):
File "<stdin>", line 1, in ?
ValueError: max() arg is an empty sequence
>>> _max([])
"""
if len(args) == 1 and not args[0]:
return None
return max(*args)
if __name__ == "__main__":
import doctest
doctest.testmod()

920
mis_builder/models/mis_builder.py

@ -0,0 +1,920 @@
# -*- coding: utf-8 -*-
##############################################################################
#
# mis_builder module for Odoo, Management Information System Builder
# Copyright (C) 2014-2015 ACSONE SA/NV (<http://acsone.eu>)
#
# This file is a part of mis_builder
#
# mis_builder is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License v3 or later
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# mis_builder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License v3 or later for more details.
#
# You should have received a copy of the GNU Affero General Public License
# v3 or later along with this program.
# If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
import datetime
import dateutil
from dateutil import parser
import logging
import re
import time
import traceback
import pytz
from openerp.osv import orm, fields
from openerp import tools
from openerp.tools.safe_eval import safe_eval
from openerp.tools.translate import _
from .aep import AccountingExpressionProcessor as AEP
from .aggregate import _sum, _avg, _min, _max
_logger = logging.getLogger(__name__)
DATE_LENGTH = len(datetime.date.today().strftime(
tools.DEFAULT_SERVER_DATE_FORMAT))
DATETIME_LENGTH = len(datetime.datetime.now().strftime(
tools.DEFAULT_SERVER_DATETIME_FORMAT))
class AutoStruct(object):
def __init__(self, **kwargs):
for k, v in kwargs.items():
setattr(self, k, v)
def _get_selection_label(selection, value):
for v, l in selection:
if v == value:
return l
return ''
def _utc_midnight(d, tz_name, add_day=0):
d = d[:DATETIME_LENGTH]
if len(d) == DATE_LENGTH:
d += " 00:00:00"
d = datetime.datetime.strptime(d, tools.DEFAULT_SERVER_DATETIME_FORMAT)
utc_tz = pytz.timezone('UTC')
if add_day:
d = d + datetime.timedelta(days=add_day)
context_tz = pytz.timezone(tz_name)
local_timestamp = context_tz.localize(d, is_dst=False)
return local_timestamp.astimezone(utc_tz).strftime(
tools.DEFAULT_SERVER_DATETIME_FORMAT)
def _python_var(var_str):
return re.sub(r'\W|^(?=\d)', '_', var_str).lower()
def _is_valid_python_var(name):
return re.match("[_A-Za-z][_a-zA-Z0-9]*$", name)
class MisReportKpi(orm.Model):
""" A KPI is an element (ie a line) of a MIS report.
In addition to a name and description, it has an expression
to compute it based on queries defined in the MIS report.
It also has various informations defining how to render it
(numeric or percentage or a string, a suffix, divider) and
how to render comparison of two values of the KPI.
KPI's have a sequence and are ordered inside the MIS report.
"""
_name = 'mis.report.kpi'
_columns = {
'name': fields.char(size=32, required=True,
string='Name'),
'description': fields.char(required=True,
string='Description',
translate=True),
'expression': fields.char(required=True,
string='Expression'),
'default_css_style': fields.char(
string='Default CSS style'),
'css_style': fields.char(string='CSS style expression'),
'type': fields.selection([('num', _('Numeric')),
('pct', _('Percentage')),
('str', _('String'))],
required=True,
string='Type'),
'divider': fields.selection([('1e-6', _('µ')),
('1e-3', _('m')),
('1', _('1')),
('1e3', _('k')),
('1e6', _('M'))],
string='Factor'),
'dp': fields.integer(string='Rounding'),
'suffix': fields.char(size=16, string='Suffix'),
'compare_method': fields.selection([('diff', _('Difference')),
('pct', _('Percentage')),
('none', _('None'))],
required=True,
string='Comparison Method'),
'sequence': fields.integer(string='Sequence'),
'report_id': fields.many2one('mis.report', string='Report'),
}
_defaults = {
'type': 'num',
'divider': '1',
'dp': 0,
'compare_method': 'pct',
'sequence': 100,
}
_order = 'sequence, id'
def _check_name(self, cr, uid, ids, context=None):
for record_name in self.read(cr, uid, ids, ['name']):
if not _is_valid_python_var(record_name['name']):
return False
return True
_constraints = [
(_check_name, 'The name must be a valid python identifier', ['name']),
]
def onchange_name(self, cr, uid, ids, name, context=None):
res = {}
if name and not _is_valid_python_var(name):
res['warning'] = {
'title': 'Invalid name %s' % name,
'message': 'The name must be a valid python identifier'}
return res
def onchange_description(self, cr, uid, ids, description, name,
context=None):
""" construct name from description """
res = {}
if description and not name:
res = {'value': {'name': _python_var(description)}}
return res
def onchange_type(self, cr, uid, ids, kpi_type, context=None):
res = {}
if kpi_type == 'num':
res['value'] = {
'compare_method': 'pct',
'divider': '1',
'dp': 0
}
elif kpi_type == 'pct':
res['value'] = {
'compare_method': 'diff',
'divider': '1',
'dp': 0
}
elif kpi_type == 'str':
res['value'] = {
'compare_method': 'none',
'divider': '',
'dp': 0
}
return res
def render(self, cr, uid, lang_id, kpi, value, context=None):
if value is None:
return '#N/A'
if kpi.type == 'num':
return self._render_num(cr, uid, lang_id, value, kpi.divider,
kpi.dp, kpi.suffix, context=context)
elif kpi.type == 'pct':
return self._render_num(cr, uid, lang_id, value, 0.01,
kpi.dp, '%', context=context)
else:
return unicode(value)
def _render_comparison(self, cr, uid, lang_id, kpi, value, base_value,
average_value, average_base_value, context=None):
""" render the comparison of two KPI values, ready for display """
if value is None or base_value is None:
return ''
if kpi.type == 'pct':
return self._render_num(cr, uid, lang_id, value - base_value, 0.01,
kpi.dp, _('pp'), sign='+', context=context)
elif kpi.type == 'num':
if average_value:
value = value / float(average_value)
if average_base_value:
base_value = base_value / float(average_base_value)
if kpi.compare_method == 'diff':
return self._render_num(cr, uid, lang_id, value - base_value,
kpi.divider,
kpi.dp, kpi.suffix, sign='+',
context=context)
elif kpi.compare_method == 'pct':
if round(base_value, kpi.dp) != 0:
return self._render_num(
cr, uid, lang_id,
(value - base_value) / abs(base_value),
0.01, kpi.dp, '%', sign='+', context=context)
return ''
def _render_num(self, cr, uid, lang_id, value, divider,
dp, suffix, sign='-', context=None):
divider_label = _get_selection_label(
self._columns['divider'].selection, divider)
if divider_label == '1':
divider_label = ''
# format number following user language
value = round(value / float(divider or 1), dp) or 0
value = self.pool['res.lang'].format(
cr, uid, lang_id,
'%%%s.%df' % (sign, dp),
value,
grouping=True,
context=context)
value = u'%s\N{NO-BREAK SPACE}%s%s' % \
(value, divider_label, suffix or '')
value = value.replace('-', u'\N{NON-BREAKING HYPHEN}')
return value
class MisReportQuery(orm.Model):
""" A query to fetch arbitrary data for a MIS report.
A query works on a model and has a domain and list of fields to fetch.
At runtime, the domain is expanded with a "and" on the date/datetime field.
"""
_name = 'mis.report.query'
def _get_field_names(self, cr, uid, ids, name, args, context=None):
res = {}
for query in self.browse(cr, uid, ids, context=context):
field_names = []
for field in query.field_ids:
field_names.append(field.name)
res[query.id] = ', '.join(field_names)
return res
def onchange_field_ids(self, cr, uid, ids, field_ids, context=None):
# compute field_names
field_names = []
for field in self.pool.get('ir.model.fields').read(
cr, uid,
field_ids[0][2],
['name'],
context=context):
field_names.append(field['name'])
return {'value': {'field_names': ', '.join(field_names)}}
_columns = {
'name': fields.char(size=32, required=True,
string='Name'),
'model_id': fields.many2one('ir.model', required=True,
string='Model'),
'field_ids': fields.many2many('ir.model.fields', required=True,
string='Fields to fetch'),
'field_names': fields.function(_get_field_names, type='char',
string='Fetched fields name',
store={'mis.report.query':
(lambda self, cr, uid, ids, c={}:
ids, ['field_ids'], 20), }),
'aggregate': fields.selection([('sum', _('Sum')),
('avg', _('Average')),
('min', _('Min')),
('max', _('Max'))],
string='Aggregate'),
'date_field': fields.many2one('ir.model.fields', required=True,
string='Date field',
domain=[('ttype', 'in',
('date', 'datetime'))]),
'domain': fields.char(string='Domain'),
'report_id': fields.many2one('mis.report', string='Report',
ondelete='cascade'),
}
_order = 'name'
def _check_name(self, cr, uid, ids, context=None):
for record_name in self.read(cr, uid, ids, ['name']):
if not _is_valid_python_var(record_name['name']):
return False
return True
_constraints = [
(_check_name, 'The name must be a valid python identifier', ['name']),
]
class MisReport(orm.Model):
""" A MIS report template (without period information)
The MIS report holds:
* a list of explicit queries; the result of each query is
stored in a variable with same name as a query, containing as list
of data structures populated with attributes for each fields to fetch;
when queries have an aggregate method and no fields to group, it returns
a data structure with the aggregated fields
* a list of KPI to be evaluated based on the variables resulting
from the accounting data and queries (KPI expressions can references
queries and accounting expression - see AccoutingExpressionProcessor)
"""
_name = 'mis.report'
_columns = {
'name': fields.char(size=32, required=True,
string='Name', translate=True),
'description': fields.char(required=False,
string='Description', translate=True),
'query_ids': fields.one2many('mis.report.query', 'report_id',
string='Queries'),
'kpi_ids': fields.one2many('mis.report.kpi', 'report_id',
string='KPI\'s'),
}
# TODO: kpi name cannot be start with query name
def create(self, cr, uid, vals, context=None):
# TODO: explain this
if 'kpi_ids' in vals:
mis_report_kpi_obj = self.pool.get('mis.report.kpi')
for idx, line in enumerate(vals['kpi_ids']):
if line[0] == 0:
line[2]['sequence'] = idx + 1
else:
mis_report_kpi_obj.write(
cr, uid, [line[1]], {'sequence': idx + 1},
context=context)
return super(MisReport, self).create(cr, uid, vals, context=context)
def write(self, cr, uid, ids, vals, context=None):
# TODO: explain this
res = super(MisReport, self).write(
cr, uid, ids, vals, context=context)
mis_report_kpi_obj = self.pool.get('mis.report.kpi')
for report in self.browse(cr, uid, ids, context):
for idx, kpi in enumerate(report.kpi_ids):
mis_report_kpi_obj.write(
cr, uid, [kpi.id], {'sequence': idx + 1}, context=context)
return res
class MisReportInstancePeriod(orm.Model):
""" A MIS report instance has the logic to compute
a report template for a given date period.
Periods have a duration (day, week, fiscal period) and
are defined as an offset relative to a pivot date.
"""
def _get_dates(self, cr, uid, ids, field_names, arg, context=None):
if isinstance(ids, (int, long)):
ids = [ids]
res = {}
for c in self.browse(cr, uid, ids, context=context):
period_ids = None
valid = True
date_from = False
date_to = False
d = parser.parse(c.report_instance_id.pivot_date)
if c.type == 'd':
date_from = d + datetime.timedelta(days=c.offset)
date_to = date_from + datetime.timedelta(days=c.duration - 1)
date_from = date_from.strftime(
tools.DEFAULT_SERVER_DATE_FORMAT)
date_to = date_to.strftime(tools.DEFAULT_SERVER_DATE_FORMAT)
elif c.type == 'w':
date_from = d - datetime.timedelta(d.weekday())
date_from = date_from + datetime.timedelta(days=c.offset * 7)
date_to = date_from + datetime.timedelta(
days=(7 * c.duration) - 1)
date_from = date_from.strftime(
tools.DEFAULT_SERVER_DATE_FORMAT)
date_to = date_to.strftime(tools.DEFAULT_SERVER_DATE_FORMAT)
elif c.type == 'fp':
period_obj = self.pool['account.period']
current_period_ids = period_obj.search(
cr, uid,
[('special', '=', False),
('date_start', '<=', d),
('date_stop', '>=', d),
('company_id', '=', c.company_id.id)],
context=context)
if current_period_ids:
all_period_ids = period_obj.search(
cr, uid,
[('special', '=', False),
('company_id', '=', c.company_id.id)],
order='date_start',
context=context)
p = all_period_ids.index(current_period_ids[0]) + \
c.offset
if p >= 0 and p + c.duration <= len(all_period_ids):
period_ids = all_period_ids[p:p + c.duration]
periods = period_obj.browse(cr, uid, period_ids,
context=context)
date_from = periods[0].date_start
date_to = periods[-1].date_stop
res[c.id] = {
'date_from': date_from,
'date_to': date_to,
'period_from': period_ids and period_ids[0] or False,
'period_to': period_ids and period_ids[-1] or False,
'valid': valid,
}
return res
_name = 'mis.report.instance.period'
_columns = {
'name': fields.char(size=32, required=True,
string='Description', translate=True),
'type': fields.selection([('d', _('Day')),
('w', _('Week')),
('fp', _('Fiscal Period')),
# ('fy', _('Fiscal Year'))
],
required=True,
string='Period type'),
'offset': fields.integer(string='Offset',
help='Offset from current period'),
'duration': fields.integer(string='Duration',
help='Number of periods'),
'date_from': fields.function(_get_dates,
type='date',
multi="dates",
string="From"),
'date_to': fields.function(_get_dates,
type='date',
multi="dates",
string="To"),
'period_from': fields.function(_get_dates,
type='many2one', obj='account.period',
multi="dates", string="From period"),
'period_to': fields.function(_get_dates,
type='many2one', obj='account.period',
multi="dates", string="To period"),
'valid': fields.function(_get_dates,
type='boolean',
multi="dates",
string='Valid'),
'sequence': fields.integer(string='Sequence'),
'report_instance_id': fields.many2one('mis.report.instance',
string='Report Instance',
ondelete='cascade'),
'comparison_column_ids': fields.many2many(
'mis.report.instance.period',
'mis_report_instance_period_rel',
'period_id',
'compare_period_id',
string='Compare with'),
'company_id': fields.related('report_instance_id', 'company_id',
type="many2one", relation="res.company",
string="Company", readonly=True),
'normalize_factor': fields.integer(
string='Factor',
help='Factor to use to normalize the period (used in comparison'),
}
_defaults = {
'offset': -1,
'duration': 1,
'sequence': 100,
'normalize_factor': 1,
}
_order = 'sequence, id'
_sql_constraints = [
('duration', 'CHECK (duration>0)',
'Wrong duration, it must be positive!'),
('normalize_factor', 'CHECK (normalize_factor>0)',
'Wrong normalize factor, it must be positive!'),
('name_unique', 'unique(name, report_instance_id)',
'Period name should be unique by report'),
]
def _get_additional_move_line_filter(self, cr, uid, _id, context=None):
""" Prepare a filter to apply on all move lines
This filter is applied with a AND operator on all
accounting expression domains. This hook is intended
to be inherited, and is useful to implement filtering
on analytic dimensions or operational units.
Returns an Odoo domain expression (a python list)
compatible with account.move.line."""
return []
def _get_additional_query_filter(self, cr, uid, _id, query, context=None):
""" Prepare an additional filter to apply on the query
This filter is combined to the query domain with a AND
operator. This hook is intended
to be inherited, and is useful to implement filtering
on analytic dimensions or operational units.
Returns an Odoo domain expression (a python list)
compatible with the model of the query."""
return []
def drilldown(self, cr, uid, _id, expr, context=None):
this = self.browse(cr, uid, _id, context=context)
if AEP.has_account_var(expr):
aep = AEP(cr)
aep.parse_expr(expr)
aep.done_parsing(cr, uid, this.report_instance_id.root_account,
context=context)
domain = aep.get_aml_domain_for_expr(
cr, uid, expr,
this.date_from, this.date_to,
this.period_from, this.period_to,
this.report_instance_id.target_move,
context=context)
domain.extend(self._get_additional_move_line_filter(
cr, uid, _id, context=context))
return {
'name': expr + ' - ' + this.name,
'domain': domain,
'type': 'ir.actions.act_window',
'res_model': 'account.move.line',
'views': [[False, 'list'], [False, 'form']],
'view_type': 'list',
'view_mode': 'list',
'target': 'current',
}
else:
return False
def _fetch_queries(self, cr, uid, c, context):
res = {}
report = c.report_instance_id.report_id
for query in report.query_ids:
obj = self.pool[query.model_id.model]
eval_context = {
'time': time,
'datetime': datetime,
'dateutil': dateutil,
# deprecated
'uid': uid,
'context': context,
}
if not c.date_from or not c.date_to:
raise orm.except_orm(_('Error!'),
_('Please define From and To dates for '
'period %s.') % c.name)
domain = query.domain and \
safe_eval(query.domain, eval_context) or []
domain.extend(self._get_additional_query_filter(
cr, uid, c.id, query, context=context))
if query.date_field.ttype == 'date':
domain.extend([(query.date_field.name, '>=', c.date_from),
(query.date_field.name, '<=', c.date_to)])
else:
tz = context.get('tz', False) or 'UTC'
datetime_from = _utc_midnight(
c.date_from, tz)
datetime_to = _utc_midnight(
c.date_to, tz, add_day=1)
domain.extend([(query.date_field.name, '>=', datetime_from),
(query.date_field.name, '<', datetime_to)])
if obj._columns.get('company_id', False):
domain.extend(['|', ('company_id', '=', False),
('company_id', '=', c.company_id.id)])
field_names = [f.name for f in query.field_ids]
if not query.aggregate:
obj_ids = obj.search(cr, uid, domain, context=context)
data = obj.read(
cr, uid, obj_ids, field_names, context=context)
res[query.name] = [AutoStruct(**d) for d in data]
elif query.aggregate == 'sum':
data = obj.read_group(
cr, uid, domain, field_names, '', context=context)
s = AutoStruct(count=data[0]['_count'])
for field_name in field_names:
v = data[0][field_name]
setattr(s, field_name, v)
res[query.name] = s
else:
obj_ids = obj.search(cr, uid, domain, context=context)
data = obj.read(
cr, uid, obj_ids, field_names, context=context)
s = AutoStruct(count=len(data))
if query.aggregate == 'min':
agg = _min
elif query.aggregate == 'max':
agg = _max
elif query.aggregate == 'avg':
agg = _avg
for field_name in field_names:
setattr(s, field_name,
agg([d[field_name] for d in data]))
res[query.name] = s
return res
def _compute(self, cr, uid, lang_id, c, aep, context=None):
if context is None:
context = {}
kpi_obj = self.pool['mis.report.kpi']
res = {}
localdict = {
'registry': self.pool,
'sum': _sum,
'min': _min,
'max': _max,
'len': len,
'avg': _avg,
}
localdict.update(self._fetch_queries(cr, uid, c, context=context))
aep.do_queries(cr, uid, c.date_from, c.date_to,
c.period_from, c.period_to,
c.report_instance_id.target_move,
self._get_additional_move_line_filter(cr, uid, c.id,
context=context),
context=context)
compute_queue = c.report_instance_id.report_id.kpi_ids
recompute_queue = []
while True:
for kpi in compute_queue:
try:
kpi_val_comment = kpi.name + " = " + kpi.expression
kpi_eval_expression = aep.replace_expr(kpi.expression)
kpi_val = safe_eval(kpi_eval_expression, localdict)
except ZeroDivisionError:
kpi_val = None
kpi_val_rendered = '#DIV/0'
kpi_val_comment += '\n\n%s' % (traceback.format_exc(),)
except (NameError, ValueError):
recompute_queue.append(kpi)
kpi_val = None
kpi_val_rendered = '#ERR'
kpi_val_comment += '\n\n%s' % (traceback.format_exc(),)
except:
kpi_val = None
kpi_val_rendered = '#ERR'
kpi_val_comment += '\n\n%s' % (traceback.format_exc(),)
else:
kpi_val_rendered = kpi_obj.render(
cr, uid, lang_id, kpi, kpi_val, context=context)
localdict[kpi.name] = kpi_val
try:
kpi_style = None
if kpi.css_style:
kpi_style = safe_eval(kpi.css_style, localdict)
except:
_logger.warning("error evaluating css stype expression %s",
kpi.css_style, exc_info=True)
kpi_style = None
drilldown = (kpi_val is not None and
AEP.has_account_var(kpi.expression))
res[kpi.name] = {
'val': kpi_val,
'val_r': kpi_val_rendered,
'val_c': kpi_val_comment,
'style': kpi_style,
'default_style': kpi.default_css_style or None,
'suffix': kpi.suffix,
'dp': kpi.dp,
'is_percentage': kpi.type == 'pct',
'period_id': c.id,
'expr': kpi.expression,
'drilldown': drilldown,
}
if len(recompute_queue) == 0:
# nothing to recompute, we are done
break
if len(recompute_queue) == len(compute_queue):
# could not compute anything in this iteration
# (ie real Value errors or cyclic dependency)
# so we stop trying
break
# try again
compute_queue = recompute_queue
recompute_queue = []
return res
class MisReportInstance(orm.Model):
"""The MIS report instance combines everything to compute
a MIS report template for a set of periods."""
def _compute_pivot_date(self, cr, uid, ids, field_name, arg, context=None):
res = {}
for r in self.browse(cr, uid, ids, context=context):
if r.date:
res[r.id] = r.date
else:
res[r.id] = fields.date.context_today(self, cr, uid,
context=context)
return res
_name = 'mis.report.instance'
_columns = {
'name': fields.char(size=32, required=True,
string='Name', translate=True),
'description': fields.char(required=False,
string='Description', translate=True),
'date': fields.date(string='Base date',
help='Report base date '
'(leave empty to use current date)'),
'pivot_date': fields.function(_compute_pivot_date,
type='date',
string="Pivot date"),
'report_id': fields.many2one('mis.report',
required=True,
string='Report'),
'period_ids': fields.one2many('mis.report.instance.period',
'report_instance_id',
required=True,
string='Periods'),
'target_move': fields.selection([('posted', 'All Posted Entries'),
('all', 'All Entries'),
], 'Target Moves', required=True),
'company_id': fields.related('root_account', 'company_id',
type='many2one', relation='res.company',
string='Company', readonly=True,
store=True),
'root_account': fields.many2one('account.account',
domain='[("parent_id", "=", False)]',
string="Account chart",
required=True)
}
_defaults = {
'target_move': 'posted',
}
def create(self, cr, uid, vals, context=None):
if not vals:
return context.get('active_id', None)
# TODO: explain this
if 'period_ids' in vals:
mis_report_instance_period_obj = self.pool.get(
'mis.report.instance.period')
for idx, line in enumerate(vals['period_ids']):
if line[0] == 0:
line[2]['sequence'] = idx + 1
else:
mis_report_instance_period_obj.write(
cr, uid, [line[1]], {'sequence': idx + 1},
context=context)
return super(MisReportInstance, self).create(cr, uid, vals,
context=context)
def write(self, cr, uid, ids, vals, context=None):
# TODO: explain this
res = super(MisReportInstance, self).write(
cr, uid, ids, vals, context=context)
mis_report_instance_period_obj = self.pool.get(
'mis.report.instance.period')
for instance in self.browse(cr, uid, ids, context):
for idx, period in enumerate(instance.period_ids):
mis_report_instance_period_obj.write(
cr, uid, [period.id], {'sequence': idx + 1},
context=context)
return res
def preview(self, cr, uid, ids, context=None):
assert len(ids) == 1
view_id = self.pool['ir.model.data'].get_object_reference(
cr, uid, 'mis_builder',
'mis_report_instance_result_view_form')[1]
return {
'type': 'ir.actions.act_window',
'res_model': 'mis.report.instance',
'res_id': ids[0],
'view_mode': 'form',
'view_type': 'form',
'view_id': view_id,
'target': 'new',
}
def _format_date(self, cr, uid, lang_id, date, context=None):
# format date following user language
tformat = self.pool['res.lang'].read(
cr, uid, lang_id, ['date_format'])[0]['date_format']
date = datetime.datetime.strptime(date,
tools.DEFAULT_SERVER_DATE_FORMAT)
return date.strftime(tformat)
def compute(self, cr, uid, _id, context=None):
assert isinstance(_id, (int, long))
if context is None:
context = {}
r = self.browse(cr, uid, _id, context=context)
# prepare AccountingExpressionProcessor
aep = AEP(cr)
for kpi in r.report_id.kpi_ids:
aep.parse_expr(kpi.expression)
aep.done_parsing(cr, uid, r.root_account, context=context)
report_instance_period_obj = self.pool['mis.report.instance.period']
kpi_obj = self.pool.get('mis.report.kpi')
# fetch user language only once
# TODO: is this necessary?
lang = self.pool['res.users'].read(
cr, uid, uid, ['lang'], context=context)['lang']
if not lang:
lang = 'en_US'
lang_id = self.pool['res.lang'].search(
cr, uid, [('code', '=', lang)], context=context)
# compute kpi values for each period
kpi_values_by_period_ids = {}
for period in r.period_ids:
if not period.valid:
continue
kpi_values = report_instance_period_obj._compute(
cr, uid, lang_id, period, aep, context=context)
kpi_values_by_period_ids[period.id] = kpi_values
# prepare header and content
header = []
header.append({
'kpi_name': '',
'cols': []
})
content = []
rows_by_kpi_name = {}
for kpi in r.report_id.kpi_ids:
rows_by_kpi_name[kpi.name] = {
'kpi_name': kpi.description,
'cols': [],
'default_style': kpi.default_css_style
}
content.append(rows_by_kpi_name[kpi.name])
# populate header and content
for period in r.period_ids:
if not period.valid:
continue
# add the column header
if period.duration > 1 or period.type == 'w':
# from, to
if period.period_from and period.period_to:
date_from = period.period_from.name
date_to = period.period_to.name
else:
date_from = self._format_date(
cr, uid, lang_id, period.date_from)
date_to = self._format_date(
cr, uid, lang_id, period.date_to)
header_date = _('from %s to %s') % (date_from, date_to)
else:
# one period or one day
if period.period_from and period.period_to:
header_date = period.period_from.name
else:
header_date = self._format_date(
cr, uid, lang_id, period.date_from)
header[0]['cols'].append(dict(name=period.name, date=header_date))
# add kpi values
kpi_values = kpi_values_by_period_ids[period.id]
for kpi_name in kpi_values:
rows_by_kpi_name[kpi_name]['cols'].append(kpi_values[kpi_name])
# add comparison columns
for compare_col in period.comparison_column_ids:
compare_kpi_values = \
kpi_values_by_period_ids.get(compare_col.id)
if compare_kpi_values:
# add the comparison column header
header[0]['cols'].append(
dict(name=_('%s vs %s') % (period.name,
compare_col.name),
date=''))
# add comparison values
for kpi in r.report_id.kpi_ids:
rows_by_kpi_name[kpi.name]['cols'].append({
'val_r': kpi_obj._render_comparison(
cr,
uid,
lang_id,
kpi,
kpi_values[kpi.name]['val'],
compare_kpi_values[kpi.name]['val'],
period.normalize_factor,
compare_col.normalize_factor,
context=context)
})
return {'header': header,
'content': content}

28
mis_builder/report/__init__.py

@ -0,0 +1,28 @@
# -*- encoding: utf-8 -*-
##############################################################################
#
# mis_builder module for Odoo, Management Information System Builder
# Copyright (C) 2014-2015 ACSONE SA/NV (<http://acsone.eu>)
#
# This file is a part of mis_builder
#
# mis_builder is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License v3 or later
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# mis_builder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License v3 or later for more details.
#
# You should have received a copy of the GNU Affero General Public License
# v3 or later along with this program.
# If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
try:
from . import mis_builder_xls
except ImportError:
pass # this module is not installed

138
mis_builder/report/mis_builder_xls.py

@ -0,0 +1,138 @@
# -*- coding: utf-8 -*-
##############################################################################
#
# mis_builder module for Odoo, Management Information System Builder
# Copyright (C) 2014-2015 ACSONE SA/NV (<http://acsone.eu>)
#
# This file is a part of mis_builder
#
# mis_builder is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License v3 or later
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# mis_builder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License v3 or later for more details.
#
# You should have received a copy of the GNU Affero General Public License
# v3 or later along with this program.
# If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
import xlwt
from openerp.report import report_sxw
from openerp.addons.report_xls.report_xls import report_xls
import logging
_logger = logging.getLogger(__name__)
class mis_builder_xls_parser(report_sxw.rml_parse):
def __init__(self, cr, uid, name, context):
super(mis_builder_xls_parser, self).__init__(
cr, uid, name, context=context)
self.context = context
class mis_builder_xls(report_xls):
def __init__(self, name, table, rml=False, parser=False, header=True,
store=False):
super(mis_builder_xls, self).__init__(
name, table, rml, parser, header, store)
# Cell Styles
_xs = self.xls_styles
# header
rh_cell_format = _xs['bold'] + _xs['fill'] + \
_xs['borders_all'] + _xs['right']
self.rh_cell_style = xlwt.easyxf(rh_cell_format)
self.rh_cell_style_date = xlwt.easyxf(
rh_cell_format, num_format_str=report_xls.date_format)
# lines
self.mis_rh_cell_style = xlwt.easyxf(
_xs['borders_all'] + _xs['bold'] + _xs['fill'])
def generate_xls_report(self, _p, _xs, data, objects, wb):
report_name = objects[0].name
ws = wb.add_sheet(report_name[:31])
ws.panes_frozen = True
ws.remove_splits = True
ws.portrait = 0 # Landscape
ws.fit_width_to_pages = 1
row_pos = 0
# set print header/footer
ws.header_str = self.xls_headers['standard']
ws.footer_str = self.xls_footers['standard']
# Title
c_specs = [
('report_name', 1, 0, 'text', report_name),
]
row_data = self.xls_row_template(c_specs, ['report_name'])
row_pos = self.xls_write_row(
ws, row_pos, row_data, row_style=xlwt.easyxf(_xs['xls_title']))
row_pos += 1
# get the computed result of the report
data = self.pool.get('mis.report.instance').compute(
self.cr, self.uid, objects[0].id)
# Column headers
header_name_list = ['']
col_specs_template = {'': {'header': [1, 30, 'text', ''],
'header_date': [1, 1, 'text', '']}}
for col in data['header'][0]['cols']:
col_specs_template[col['name']] = {'header': [1, 30, 'text',
col['name']],
'header_date': [1, 1, 'text',
col['date']]}
header_name_list.append(col['name'])
c_specs = map(
lambda x: self.render(x, col_specs_template, 'header'),
header_name_list)
row_data = self.xls_row_template(c_specs, [x[0] for x in c_specs])
row_pos = self.xls_write_row(
ws, row_pos, row_data, row_style=self.rh_cell_style,
set_column_size=True)
c_specs = map(lambda x: self.render(
x, col_specs_template, 'header_date'), header_name_list)
row_data = self.xls_row_template(c_specs, [x[0] for x in c_specs])
row_pos = self.xls_write_row(
ws, row_pos, row_data, row_style=self.rh_cell_style_date)
ws.set_horz_split_pos(row_pos)
ws.set_vert_split_pos(1)
for line in data['content']:
col = 0
ws.write(row_pos, col, line['kpi_name'], self.mis_rh_cell_style)
for value in line['cols']:
col += 1
num_format_str = '#'
if value.get('dp'):
num_format_str += '.'
num_format_str += '0' * int(value['dp'])
if value.get('suffix'):
num_format_str = num_format_str + ' "%s"' % value['suffix']
kpi_cell_style = xlwt.easyxf(
_xs['borders_all'] + _xs['right'],
num_format_str=num_format_str)
if value.get('val'):
val = value['val']
if value.get('is_percentage'):
val = val / 0.01
ws.write(row_pos, col, val, kpi_cell_style)
else:
ws.write(row_pos, col, value['val_r'], kpi_cell_style)
row_pos += 1
mis_builder_xls('report.mis.report.instance.xls',
'mis.report.instance',
parser=mis_builder_xls_parser)

11
mis_builder/security/ir.model.access.csv

@ -0,0 +1,11 @@
"id","name","model_id:id","group_id:id","perm_read","perm_write","perm_create","perm_unlink"
manage_mis_report_kpi,manage_mis_report_kpi,model_mis_report_kpi,account.group_account_manager,1,1,1,1
access_mis_report_kpi,access_mis_report_kpi,model_mis_report_kpi,base.group_user,1,0,0,0
manage_mis_report_query,manage_mis_report_query,model_mis_report_query,account.group_account_manager,1,1,1,1
access_mis_report_query,access_mis_report_query,model_mis_report_query,base.group_user,1,0,0,0
manage_mis_report,manage_mis_report,model_mis_report,account.group_account_manager,1,1,1,1
access_mis_report,access_mis_report,model_mis_report,base.group_user,1,0,0,0
manage_mis_report_instance_period,manage_mis_report_instance_period,model_mis_report_instance_period,account.group_account_manager,1,1,1,1
access_mis_report_instance_period,access_mis_report_instance_period,model_mis_report_instance_period,base.group_user,1,0,0,0
manage_mis_report_instance,manage_mis_report_instance,model_mis_report_instance,account.group_account_manager,1,1,1,1
access_mis_report_instance,access_mis_report_instance,model_mis_report_instance,base.group_user,1,0,0,0

13
mis_builder/security/mis_builder_security.xml

@ -0,0 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<openerp>
<data noupdate="0">
<record id="mis_builder_multi_company_rule" model="ir.rule">
<field name="name">Mis Builder multi company</field>
<field name="model_id" ref="model_mis_report_instance"/>
<field name="global" eval="True"/>
<field name="domain_force">['|',('company_id','=',False),('company_id','child_of',[user.company_id.id])]</field>
</record>
</data>
</openerp>

BIN
mis_builder/static/description/ex_dashboard.png

After

Width: 749  |  Height: 391  |  Size: 34 KiB

BIN
mis_builder/static/description/ex_report.png

After

Width: 1111  |  Height: 560  |  Size: 81 KiB

BIN
mis_builder/static/description/ex_report_template.png

After

Width: 1174  |  Height: 654  |  Size: 98 KiB

BIN
mis_builder/static/description/icon.png

After

Width: 128  |  Height: 128  |  Size: 9.2 KiB

79
mis_builder/static/description/icon.svg
File diff suppressed because it is too large
View File

75
mis_builder/static/description/index.html

@ -0,0 +1,75 @@
<section id="addons-mis-builder">
<img src="https://img.shields.io/badge/licence-AGPL--3-blue.svg" alt="License: AGPL-3" />
<section id="mis-builder">
<h1>MIS Builder</h1>
<p>This module allows you to build Management Information Systems dashboards. Such style of reports presents KPI in rows and time periods in columns. Reports mainly fetch data from account moves, but can also combine data coming from arbitrary Odoo models. Reports can be exported to PDF, Excel and they can be added to Odoo dashboards.</p>
<section id="installation">
<h2>Installation</h2>
<p>There is no specific installation procedure for this module.</p>
</section>
<section id="configuration-and-usage">
<h2>Configuration and Usage</h2>
<p>To configure this module, you need to:</p>
<ul>
<li>Go to Accounting &gt; Configuration &gt; Financial Reports &gt; MIS Report Templates where you can create report templates by defining KPI's. KPI's constitute the rows of your reports. Such report templates are time independent.</li>
</ul>
<figure>
<img src="ex_report_template.png" alt="Sample report template" scale="80" />
</figure>
<ul>
<li>Then in Accounting &gt; Reporting &gt; MIS Reports you can create report instance by binding the templates to time period, hence defining the columns of your reports.</li>
</ul>
<figure>
<img src="ex_report.png" alt="Sample report configuration" />
</figure>
<ul>
<li>From the MIS Report view, you can preview the report, add it to and Odoo dashboard, and export it to PDF or Excel.</li>
</ul>
<figure>
<img src="ex_dashboard.png" alt="Sample dashboard view" />
</figure>
<p>For further information, please visit:</p>
<ul>
<li><a href="https://www.odoo.com/forum/help-1">https://www.odoo.com/forum/help-1</a></li>
</ul>
</section>
<section id="known-issues-roadmap">
<h2>Known issues / Roadmap</h2>
<ul>
<li>More tests should be added. The first part is creating test data, then it will be easier. At the minimum, We need the following test data:
<ul>
<li>one account charts with a few normal accounts and view accounts,</li>
<li>two fiscal years,</li>
<li>an opening entry in the second fiscal year,</li>
<li>to test multi-company consolidation, we need a second company with it's own account chart and two fiscal years, but without opening entry; we also need a third company which is the parent of the other two and has a consolidation chart of account.</li>
</ul>
</li>
</ul>
</section>
<section id="bug-tracker">
<h2>Bug Tracker</h2>
<p>Bugs are tracked on <a href="https://github.com/OCA/account-financial-reporting/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 feedback <a href="https://github.com/OCA/account-financial-reporting/issues/new?body=module:%20mis_builder%0Aversion:%208.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">here</a>.</p>
</section>
<section id="credits">
<h2>Credits</h2>
<section id="contributors">
<h3>Contributors</h3>
<ul>
<li>Stéphane Bidoul &lt;<a href="mailto:stephane.bidoul@acsone.eu">stephane.bidoul@acsone.eu</a>&gt;</li>
<li>Laetitia Gangloff &lt;<a href="mailto:laetitia.gangloff@acsone.eu">laetitia.gangloff@acsone.eu</a>&gt;</li>
<li>Adrien Peiffer &lt;<a href="mailto:adrien.peiffer@acsone.eu">adrien.peiffer@acsone.eu</a>&gt;</li>
</ul>
</section>
<section id="maintainer">
<h3>Maintainer</h3>
<a href="https://odoo-community.org">
<img src="https://odoo-community.org/logo.png" alt="Odoo Community Association" />
</a>
<p>This module is maintained by the OCA.</p>
<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>To contribute to this module, please visit <a href="http://odoo-community.org">http://odoo-community.org</a>.</p>
</section>
</section>
</section>
</section>

13
mis_builder/static/src/css/custom.css

@ -0,0 +1,13 @@
.openerp .mis_builder_ralign {
text-align: right;
}
.openerp .mis_builder a {
/* we don't want the link color, to respect user styles */
color: inherit;
}
.openerp .mis_builder a:hover {
/* underline links on hover to give a visual cue */
text-decoration: underline;
}

BIN
mis_builder/static/src/img/icon.png

After

Width: 128  |  Height: 128  |  Size: 9.2 KiB

48
mis_builder/static/src/js/mis_builder.js

@ -0,0 +1,48 @@
openerp.mis_builder = function(instance) {
instance.mis_builder.MisReport = instance.web.form.FormWidget.extend({
template: "mis_builder.MisReport",
init: function() {
this._super.apply(this, arguments);
this.mis_report_data = null;
},
start: function() {
this._super.apply(this, arguments);
var self = this;
new instance.web.Model("mis.report.instance").call(
"compute",
[self.getParent().dataset.context.active_id],
{'context': new instance.web.CompoundContext()}
).then(function(result){
self.mis_report_data = result;
self.renderElement();
});
},
events: {
"click a.mis_builder_drilldown": "drilldown",
},
drilldown: function(event) {
var self = this;
var drilldown = JSON.parse($(event.target).data("drilldown"));
if (drilldown) {
var period_id = JSON.parse($(event.target).data("period-id"));
var val_c = JSON.parse($(event.target).data("expr"));
new instance.web.Model("mis.report.instance.period").call(
"drilldown",
[period_id, val_c],
{'context': new instance.web.CompoundContext()}
).then(function(result) {
if (result) {
self.do_action(result);
}
});
}
},
});
instance.web.form.custom_widgets.add('mis_report', 'instance.mis_builder.MisReport');
}

62
mis_builder/static/src/xml/mis_widget.xml

@ -0,0 +1,62 @@
<template>
<t t-name="mis_builder.MisReport">
<p> </p>
<table t-if="widget.mis_report_data" class="oe_list_content mis_builder">
<thead>
<tr class="oe_list_header_columns">
<t t-foreach="widget.mis_report_data.header" t-as="h">
<th class="oe_list_header_char">
<div>
<t t-esc="h_value.kpi_name"/>
</div>
</th>
<th t-foreach="h_value.cols" t-as="col" class="oe_list_header_char mis_builder_ralign">
<div>
<t t-esc="col.name"/>
</div>
<div>
<t t-esc="col.date"/>
</div>
</th>
</t>
</tr>
</thead>
<tbody>
<tr t-foreach="widget.mis_report_data.content" t-as="c">
<td t-att="{'style': c_value.default_style}">
<div>
<t t-esc="c_value.kpi_name"/>
</div>
</td>
<t t-foreach="c_value.cols" t-as="value">
<td t-att="{'style': c_value.default_style}" class="mis_builder_ralign">
<div t-att="{'style': value_value.style, 'title': value_value.val_c}">
<t t-if="value_value.drilldown">
<a href="javascript:void(0)"
class="mis_builder_drilldown"
t-att-data-drilldown="JSON.stringify(value_value.drilldown)"
t-att-data-period-id="JSON.stringify(value_value.period_id)"
t-att-data-expr="JSON.stringify(value_value.expr)"
>
<t t-esc="value_value.val_r"/>
</a>
</t>
<t t-if="!value_value.drilldown">
<t t-esc="value_value.val_r"/>
</t>
</div>
</td>
</t>
</tr>
</tbody>
<tfoot>
<tr>
<td class="oe_list_footer" />
<t t-foreach="widget.mis_report_data.header" t-as="f">
<td t-foreach="f_value.cols" class="oe_list_footer" />
</t>
</tr>
</tfoot>
</table>
</t>
</template>

29
mis_builder/tests/__init__.py

@ -0,0 +1,29 @@
# -*- encoding: utf-8 -*-
##############################################################################
#
# mis_builder module for Odoo, Management Information System Builder
# Copyright (C) 2014-2015 ACSONE SA/NV (<http://acsone.eu>)
#
# This file is a part of mis_builder
#
# mis_builder is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License v3 or later
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# mis_builder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License v3 or later for more details.
#
# You should have received a copy of the GNU Affero General Public License
# v3 or later along with this program.
# If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
from . import test_mis_builder
checks = [
test_mis_builder,
]

2
mis_builder/tests/mis.report.csv

@ -0,0 +1,2 @@
"id","description","kpi_ids/id","name","query_ids/id"
"mis_report_test","","mis_report_kpi_test","Test report","mis_report_query_test"

2
mis_builder/tests/mis.report.instance.csv

@ -0,0 +1,2 @@
"id","date","description","name","period_ids/id","report_id/id","root_account/id"
"mis_report_instance_test","2014-07-31","","Test-report-instance without company","mis_report_instance_period_test","mis_report_test","account.chart0"

2
mis_builder/tests/mis.report.instance.period.csv

@ -0,0 +1,2 @@
"id","duration","name","offset","type","sequence"
"mis_report_instance_period_test","1","today","","Day",""

2
mis_builder/tests/mis.report.kpi.csv

@ -0,0 +1,2 @@
"id","compare_method","description","expression","divider","name","dp","sequence","type","suffix"
"mis_report_kpi_test","Percentage","total test","len(test)","","total_test","","1","Numeric",""

2
mis_builder/tests/mis.report.query.csv

@ -0,0 +1,2 @@
"id","date_field/id","domain","field_ids/id","model_id/id","name"
"mis_report_query_test","account.field_account_analytic_balance_date1","","account.field_account_analytic_balance_empty_acc","account.model_account_analytic_balance","test"

83
mis_builder/tests/test_mis_builder.py

@ -0,0 +1,83 @@
# -*- coding: utf-8 -*-
##############################################################################
#
# mis_builder module for Odoo, Management Information System Builder
# Copyright (C) 2014-2015 ACSONE SA/NV (<http://acsone.eu>)
#
# This file is a part of mis_builder
#
# mis_builder is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License v3 or later
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# mis_builder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License v3 or later for more details.
#
# You should have received a copy of the GNU Affero General Public License
# v3 or later along with this program.
# If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
import openerp.tests.common as common
from ..models import mis_builder
class test_mis_builder(common.TransactionCase):
def setUp(self):
super(test_mis_builder, self).setUp()
def test_datetime_conversion(self):
date_to_convert = '2014-07-05'
date_time_convert = mis_builder._utc_midnight(
date_to_convert, 'Europe/Brussels')
self.assertEqual(date_time_convert, '2014-07-04 22:00:00',
'The converted date time convert must contains hour')
date_time_convert = mis_builder._utc_midnight(
date_to_convert, 'Europe/Brussels', add_day=1)
self.assertEqual(date_time_convert, '2014-07-05 22:00:00',
'The converted date time convert must contains hour')
date_time_convert = mis_builder._utc_midnight(
date_to_convert, 'US/Pacific')
self.assertEqual(date_time_convert, '2014-07-05 07:00:00',
'The converted date time convert must contains hour')
date_time_convert = mis_builder._utc_midnight(
date_to_convert, 'US/Pacific', add_day=1)
self.assertEqual(date_time_convert, '2014-07-06 07:00:00',
'The converted date time convert must contains hour')
def test_fetch_query(self):
# create a report on a model without company_id field :
# account.analytic.balance
data = self.registry('mis.report.instance').compute(
self.cr, self.uid,
self.ref('mis_builder.mis_report_instance_test'))
self.assertDictContainsSubset(
{'content':
[{'kpi_name': u'total test',
'default_style': False,
'cols': [{'period_id': self.ref('mis_builder.'
'mis_report_instance_'
'period_test'),
'style': None,
'default_style': None,
'suffix': False,
'expr': u'len(test)',
'val_c': u'total_test = len(test)',
'val': 0,
'val_r': u'0\xa0',
'is_percentage': False,
'dp': 0,
'drilldown': False}]
}],
'header':
[{'kpi_name': '',
'cols': [{'date': '07/31/2014',
'name': u'today'}]
}],
}, data)

192
mis_builder/views/mis_builder.xml

@ -0,0 +1,192 @@
<?xml version="1.0" encoding="UTF-8"?>
<openerp>
<data>
<record model="ir.ui.view" id="mis_report_view_tree">
<field name="name">mis.report.view.tree</field>
<field name="model">mis.report</field>
<field name="arch" type="xml">
<tree string="MIS Reports">
<field name="name"/>
<field name="description"/>
</tree>
</field>
</record>
<record model="ir.ui.view" id="mis_report_view_form">
<field name="name">mis.report.view.form</field>
<field name="model">mis.report</field>
<field name="arch" type="xml">
<form string="MIS Report" version="7.0">
<sheet>
<group col="2">
<field name="name"/>
<field name="description"/>
<field name="query_ids">
<tree string="Queries" editable="bottom">
<field name="name"/>
<field name="model_id"/>
<field name="field_ids" domain="[('model_id', '=', model_id)]" widget="many2many_tags"/>
<field name="field_names"/>
<field name="aggregate"/>
<field name="date_field" domain="[('model_id', '=', model_id), ('ttype', 'in', ('date', 'datetime'))]"/>
<field name="domain"/>
</tree>
</field>
<field name="kpi_ids">
<tree string="KPI's" editable="bottom">
<field name="sequence" widget="handle"/>
<field name="description"/>
<field name="name"/>
<field name="expression"/>
<field name="type"/>
<field name="dp" attrs="{'invisible': [('type', '=', 'str')]}"/>
<field name="divider" attrs="{'invisible': [('type', '=', 'str')]}"/>
<field name="suffix"/>
<field name="compare_method" attrs="{'invisible': [('type', '=', 'str')]}"/>
<field name="default_css_style"/>
<field name="css_style"/>
</tree>
</field>
</group>
<group col="2" string="Legend (for expression)">
<group>
<label colspan="2" string="Expressions are of the form &lt;field&gt;&lt;mode&gt;[accounts][domain]"/>
<label colspan="2" string="Possible values for 'field' can be:"/>
<group>
<label colspan="2" string="* bal for balance (debit - credit)"/>
<label colspan="2" string="* crd for credit"/>
<label colspan="2" string="* deb for debit"/>
</group>
<label colspan="2" string="Possible values for 'mode' are:"/>
<group>
<label colspan="2" string="* nothing or p: variation over the period"/>
<label colspan="2" string="* i: at the beginning of the period"/>
<label colspan="2" string="* e: at the end of the period"/>
</group>
<label colspan="2" string="'accounts' is a comma-separated list of account codes, possibly containing %% wildcards"/>
<label colspan="2" string="'domain' is an optional filter on move lines (eg to filter on analytic accounts or journal)"/>
</group>
<group>
<label colspan="2" string="Examples"/>
<group>
<label colspan="2" string="* bal[70]: variation of the balance of account 70 over the period (it is the same as balp[70]);"/>
<label colspan="2" string="* bali[70,60]: initial balance of accounts 70 and 60;"/>
<label colspan="2" string="* bale[1%%]: balance of accounts starting with 1 at end of period."/>
</group>
</group>
</group>
</sheet>
</form>
</field>
</record>
<record model="ir.actions.act_window" id="mis_report_view_action">
<field name="name">MIS Report Templates</field>
<field name="view_id" ref="mis_report_view_tree"/>
<field name="res_model">mis.report</field>
<field name="view_type">form</field>
<field name="view_mode">tree,form</field>
</record>
<menuitem id="mis_report_view_menu" parent="account.menu_account_reports" name="MIS Report Templates" action="mis_report_view_action" sequence="21"/>
<record id="xls_export" model="ir.actions.report.xml">
<field name="name">MIS report instance XLS report</field>
<field name="model">mis.report.instance</field>
<field name="type">ir.actions.report.xml</field>
<field name="report_name">mis.report.instance.xls</field>
<field name="report_type">xls</field>
<field name="auto" eval="False"/>
</record>
<record model="ir.ui.view" id="mis_report_instance_result_view_form">
<field name="name">mis.report.instance.result.view.form</field>
<field name="model">mis.report.instance</field>
<field name="priority" eval="17"/>
<field name="arch" type="xml">
<form string="MIS Report Result" version="7.0">
<widget type="mis_report"></widget>
<button icon="gtk-execute" name="%(xls_export)d" string="Export" type="action" colspan="2"/>
</form>
</field>
</record>
<record model="ir.ui.view" id="mis_report_instance_view_tree">
<field name="name">mis.report.instance.view.tree</field>
<field name="model">mis.report.instance</field>
<field name="arch" type="xml">
<tree string="MIS Report Instances">
<field name="name"/>
<field name="description"/>
<field name="report_id"/>
<field name="target_move"/>
<field name="pivot_date"/>
<field name="company_id"/>
</tree>
</field>
</record>
<record model="ir.ui.view" id="mis_report_instance_view_form">
<field name="name">mis.report.instance.view.form</field>
<field name="model">mis.report.instance</field>
<field name="priority" eval="16"/>
<field name="arch" type="xml">
<form string="MIS Report Instance" version="7.0">
<sheet>
<div class="oe_title">
<div class="oe_edit_only">
<label for="name"/>
</div>
<h1>
<field name="name" placeholder="Name"/>
</h1>
</div>
<div class="oe_right oe_button_box" name="buttons">
<button type="object" name="preview" string="Preview" icon="gtk-print-preview" />
<button type="action" name="%(xls_export)d" string="Export" icon="gtk-execute" />
<button type="action" name="%(mis_report_instance_add_to_dashboard_action)d" string="Add to dashboard" icon="gtk-add" />
</div>
<group>
<field name="report_id"/>
<field name="description"/>
<field name="root_account"/>
<field name="company_id" groups="base.group_multi_company"/>
<field name="date"/>
<field name="target_move"/>
<field name="period_ids">
<tree string="KPI's" editable="bottom" colors="red:valid==False">
<field name="sequence" widget="handle"/>
<field name="name"/>
<field name="type"/>
<field name="offset"/>
<field name="duration"/>
<field name="normalize_factor"/>
<field name="date_from"/>
<field name="date_to"/>
<field name="period_from"/>
<field name="period_to"/>
<field name="valid" invisible="1"/>
<field name="report_instance_id" invisible="1"/>
<field name="id" invisible="1"/>
<field name="comparison_column_ids" domain="[('report_instance_id', '=', report_instance_id), ('id', '!=', id)]" widget="many2many_tags"/>
</tree>
</field>
</group>
</sheet>
</form>
</field>
</record>
<record model="ir.actions.act_window" id="mis_report_instance_view_action">
<field name="name">MIS Reports</field>
<field name="view_id" ref="mis_report_instance_view_tree"/>
<field name="res_model">mis.report.instance</field>
<field name="view_type">form</field>
<field name="view_mode">tree,form</field>
</record>
<menuitem id="mis_report_instance_view_menu" parent="account.menu_finance_reports" name="MIS Reports" action="mis_report_instance_view_action" sequence="101"/>
</data>
</openerp>

25
mis_builder/wizard/__init__.py

@ -0,0 +1,25 @@
# -*- encoding: utf-8 -*-
##############################################################################
#
# mis_builder module for Odoo, Management Information System Builder
# Copyright (C) 2014-2015 ACSONE SA/NV (<http://acsone.eu>)
#
# This file is a part of mis_builder
#
# mis_builder is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License v3 or later
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# mis_builder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License v3 or later for more details.
#
# You should have received a copy of the GNU Affero General Public License
# v3 or later along with this program.
# If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
from . import mis_builder_dashboard

87
mis_builder/wizard/mis_builder_dashboard.py

@ -0,0 +1,87 @@
# -*- coding: utf-8 -*-
##############################################################################
#
# mis_builder module for Odoo, Management Information System Builder
# Copyright (C) 2014-2015 ACSONE SA/NV (<http://acsone.eu>)
#
# This file is a part of mis_builder
#
# mis_builder is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License v3 or later
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# mis_builder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License v3 or later for more details.
#
# You should have received a copy of the GNU Affero General Public License
# v3 or later along with this program.
# If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
from openerp.osv import orm, fields
from lxml import etree
class add_mis_report_instance_dashboard(orm.TransientModel):
_name = "add.mis.report.instance.dashboard.wizard"
_columns = {'name': fields.char('Name', size=32, required=True),
'dashboard_id': fields.many2one(
'ir.actions.act_window',
string="Dashboard", required=True,
domain="[('res_model', '=', 'board.board')]"),
}
def default_get(self, cr, uid, fields, context=None):
if context is None:
context = {}
if context.get('active_id'):
res = super(add_mis_report_instance_dashboard, self).default_get(
cr, uid, fields, context=context)
# get report instance name
res['name'] = self.pool['mis.report.instance'].read(
cr, uid, context['active_id'], ['name'])['name']
return res
def action_add_to_dashboard(self, cr, uid, ids, context=None):
if context is None:
context = {}
assert 'active_id' in context, "active_id missing in context"
wizard_data = self.browse(cr, uid, ids, context=context)[0]
# create the act_window corresponding to this report
view_id = self.pool['ir.model.data'].get_object_reference(
cr, uid, 'mis_builder', 'mis_report_instance_result_view_form')[1]
report_result = self.pool['ir.actions.act_window'].create(
cr, uid,
{'name': 'mis.report.instance.result.view.action.%d'
% context['active_id'],
'res_model': 'mis.report.instance',
'res_id': context['active_id'],
'target': 'current',
'view_mode': 'form',
'view_id': view_id})
# add this result in the selected dashboard
last_customization = self.pool['ir.ui.view.custom'].search(
cr, uid,
[('user_id', '=', uid),
('ref_id', '=', wizard_data.dashboard_id.view_id.id)], limit=1)
arch = wizard_data.dashboard_id.view_id.arch
if last_customization:
arch = self.pool['ir.ui.view.custom'].read(
cr, uid, last_customization[0], ['arch'])['arch']
new_arch = etree.fromstring(arch)
column = new_arch.xpath("//column")[0]
column.append(etree.Element('action', {'context': str(context),
'name': str(report_result),
'string': wizard_data.name,
'view_mode': 'form'}))
self.pool['ir.ui.view.custom'].create(
cr, uid, {'user_id': uid,
'ref_id': wizard_data.dashboard_id.view_id.id,
'arch': etree.tostring(new_arch, pretty_print=True)})
return {'type': 'ir.actions.act_window_close', }

33
mis_builder/wizard/mis_builder_dashboard.xml

@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8"?>
<openerp>
<data>
<record model="ir.ui.view" id="mis_report_instance_add_to_dashboard_form_view">
<field name="name">add.mis.report.instance.dashboard.wizard.view</field>
<field name="model">add.mis.report.instance.dashboard.wizard</field>
<field name="arch" type="xml">
<form string="Add to dashboard" version="7.0">
<group>
<field name="name"/>
<field name="dashboard_id"/>
</group>
<footer>
<button name="action_add_to_dashboard" string="Add to dashboard" type="object" default_focus="1" class="oe_highlight"/>
or
<button string="Cancel" class="oe_link" special="cancel"/>
</footer>
</form>
</field>
</record>
<record model="ir.actions.act_window" id="mis_report_instance_add_to_dashboard_action">
<field name="name">Add to dashboard</field>
<field name="res_model">add.mis.report.instance.dashboard.wizard</field>
<field name="view_type">form</field>
<field name="view_mode">form</field>
<field name="view_id" ref="mis_report_instance_add_to_dashboard_form_view"/>
<field name="target">new</field>
</record>
</data>
</openerp>

23
mis_builder_demo/__init__.py

@ -0,0 +1,23 @@
# -*- encoding: utf-8 -*-
##############################################################################
#
# mis_builder module for OpenERP, Management Information System Builder
# Copyright (C) 2014 ACSONE SA/NV (<http://acsone.eu>)
#
# This file is a part of mis_builder
#
# mis_builder is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License v3 or later
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# mis_builder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License v3 or later for more details.
#
# You should have received a copy of the GNU Affero General Public License
# v3 or later along with this program.
# If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################

103
mis_builder_demo/__openerp__.py

@ -0,0 +1,103 @@
# -*- coding: utf-8 -*-
##############################################################################
#
# mis_builder module for OpenERP, Management Information System Builder
# Copyright (C) 2014 ACSONE SA/NV (<http://acsone.eu>)
#
# This file is a part of mis_builder
#
# mis_builder is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License v3 or later
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# mis_builder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License v3 or later for more details.
#
# You should have received a copy of the GNU Affero General Public License
# v3 or later along with this program.
# If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
{
'name': 'MIS Builder demo data',
'version': '0.1',
'category': 'Reporting',
'summary': """
Demo data for the mis_builder module
""",
'author': 'ACSONE SA/NV,'
'Odoo Community Association (OCA)',
'website': 'http://acsone.eu',
'description': """
.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
:alt: License: AGPL-3
MIS Builder demo data
=====================
This module adds some demo data for the mis_builder module.
Installation
============
There is no specific installation procedure for this module.
Bug Tracker
===========
Bugs are tracked on `GitHub Issues
<https://github.com/OCA/account-financial-reporting/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
`here <https://github.com/OCA/account-financial-reporting/issues`_.
Credits
=======
Contributors
------------
* Stéphane Bidoul <stephane.bidoul@acsone.eu>
* Laetitia Gangloff <laetitia.gangloff@acsone.eu>
* Adrien Peiffer <adrien.peiffer@acsone.eu>
Maintainer
----------
.. 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 http://odoo-community.org.
""",
'depends': [
'account_accountant',
'mis_builder',
'crm'
],
'data': [
],
'demo': [
'mis.report.kpi.csv',
'mis.report.query.csv',
'mis.report.csv',
'mis.report.instance.period.csv',
'mis.report.instance.csv',
],
'installable': True,
'application': False,
'auto_install': False,
'license': 'AGPL-3',
}

3
mis_builder_demo/mis.report.csv

@ -0,0 +1,3 @@
"id","description","kpi_ids/id","name","query_ids/id"
"mis_report","","mis_report_kpi_1,mis_report_kpi_2,mis_report_kpi_3,mis_report_kpi_4,mis_report_kpi_5","Demo margin report","mis_report_query"
"mis_report_phonecall","","mis_report_phonecall_kpi_1,mis_report_phonecall_kpi_2,mis_report_phonecall_kpi_3,mis_report_phonecall_kpi_4","Demo phonecall report","mis_report_phonecall_query"

3
mis_builder_demo/mis.report.instance.csv

@ -0,0 +1,3 @@
id,date,description,name,period_ids/id,report_id/id,root_account/id
mis_report_instance,,,Test-margin-report-instance,"mis_report_instance_period_1,mis_report_instance_period_2,mis_report_instance_period_3,mis_report_instance_period_4",mis_report,account.chart0
mis_report_phonecall_instance,,,Test phonecall report instance,"mis_report_phonecall_instance_period_1,mis_report_phonecall_instance_period_2,mis_report_phonecall_instance_period_3",mis_report_phonecall,account.chart0

8
mis_builder_demo/mis.report.instance.period.csv

@ -0,0 +1,8 @@
id,duration,name,offset,type,sequence
mis_report_instance_period_1,1,today,0,Day,1
mis_report_instance_period_2,1,yesterday,-1,Day,2
mis_report_instance_period_3,1,last week,-1,Week,3
mis_report_instance_period_4,1,last period,-1,Fiscal Period,4
mis_report_phonecall_instance_period_1,1,today,0,Day,1
mis_report_phonecall_instance_period_2,1,this period,0,Fiscal Period,2
mis_report_phonecall_instance_period_3,1,previous period,-1,Fiscal Period,3

10
mis_builder_demo/mis.report.kpi.csv

@ -0,0 +1,10 @@
id,compare_method,description,expression,divider,name,dp,sequence,type,suffix
mis_report_kpi_1,Percentage,CA,-bal[X2001],,ca,,1,Numeric,€
mis_report_kpi_2,Percentage,CAHT invoice,sum([s.amount_untaxed for s in inv]),,total_invoice,,2,Numeric,€
mis_report_kpi_3,Percentage,Cost,bal[X2110],,cost,,3,Numeric,€
mis_report_kpi_4,Percentage,Profit,ca - cost,,profit,,4,Numeric,€
mis_report_kpi_5,Difference,Margin,profit/ca,,margin,,5,Percentage,%
mis_report_phonecall_kpi_1,Percentage,Total phone call,len(phone),,total_phone_call,,1,Numeric,
mis_report_phonecall_kpi_2,Percentage,Average duration phone call,sum([p.duration for p in phone])/total_phone_call,,average_duration_phone_call,2,2,Numeric,
mis_report_phonecall_kpi_3,Percentage,Total converted phone call,sum([p.opportunity_id and 1 or 0 for p in phone]),,phone_call_convert,,3,Numeric,
mis_report_phonecall_kpi_4,Percentage,Average duration converted phone call,sum([p.opportunity_id and p.duration or 0 for p in phone]),,average_convert_duration_phone_c,2,4,Numeric,

3
mis_builder_demo/mis.report.query.csv

@ -0,0 +1,3 @@
"id","date_field/id","domain","field_ids/id","model_id/id","name"
"mis_report_query","account.field_account_invoice_date_invoice","","account.field_account_invoice_amount_untaxed","account.model_account_invoice","inv"
"mis_report_phonecall_query","crm.field_crm_phonecall_date","","crm.field_crm_phonecall_duration,crm.field_crm_phonecall_opportunity_id","crm.model_crm_phonecall","phone"

3
oca_dependencies.txt

@ -0,0 +1,3 @@
# list the OCA project dependencies, one per line
# add a github url if you need a forked version
reporting-engine
Loading…
Cancel
Save