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

115 lines
4.2 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. ===========
  5. MIS Builder
  6. ===========
  7. This module allows you to build Management Information Systems dashboards.
  8. Such style of reports presents KPI in rows and time periods in columns.
  9. Reports mainly fetch data from account moves, but can also combine data coming
  10. from arbitrary Odoo models. Reports can be exported to PDF, Excel and they
  11. can be added to Odoo dashboards.
  12. Installation
  13. ============
  14. There is no specific installation procedure for this module.
  15. Configuration and Usage
  16. =======================
  17. To configure this module, you need to:
  18. * Go to Accounting > Configuration > Financial Reports > MIS Report Templates where
  19. you can create report templates by defining KPI's. KPI's constitute the rows of your
  20. reports. Such report templates are time independent.
  21. .. figure:: static/description/ex_report_template.png
  22. :scale: 80 %
  23. :alt: Sample report template
  24. * Then in Accounting > Reporting > MIS Reports you can create report instance by
  25. binding the templates to time period, hence defining the columns of your reports.
  26. .. figure:: static/description/ex_report.png
  27. :alt: Sample report configuration
  28. * From the MIS Report view, you can preview the report, add it to and Odoo dashboard,
  29. and export it to PDF or Excel.
  30. .. figure:: static/description/ex_dashboard.png
  31. :alt: Sample dashboard view
  32. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  33. :alt: Try me on Runbot
  34. :target: https://runbot.odoo-community.org/runbot/91/8.0
  35. For further information, please visit:
  36. * https://www.odoo.com/forum/help-1
  37. Developer notes
  38. ===============
  39. A typical extension is to provide a mechanism to filter reports on analytic dimensions
  40. or operational units. To implement this, you can override _get_additional_move_line_filter
  41. and _get_additional_filter to further filter move lines or queries based on a user
  42. selection. A typical use case could be to add an analytic account field on mis.report.instance,
  43. or even on mis.report.instance.period if you want different columns to show different
  44. analytic accounts.
  45. Known issues / Roadmap
  46. ======================
  47. * Add 'Fiscal Year' period type.
  48. * Allow selecting accounts by type. This is currently possible by expressing
  49. a query such as balp[][('account_id.user_type.code', '=', ...)]. This will work
  50. but would be more efficient if one could write balp[user_type=...], as it would
  51. involve much less queries to the database.
  52. * More tests should be added. The first part is creating test data, then it will be
  53. easier. At the minimum, We need the following test data:
  54. * one account charts with a few normal accounts and view accounts,
  55. * two fiscal years,
  56. * an opening entry in the second fiscal year,
  57. * to test multi-company consolidation, we need a second company with it's own
  58. account chart and two fiscal years, but without opening entry; we also need
  59. a third company which is the parent of the other two and has a consolidation
  60. chart of account.
  61. Bug Tracker
  62. ===========
  63. Bugs are tracked on `GitHub Issues <https://github.com/OCA/account-financial-reporting/issues>`_.
  64. In case of trouble, please check there if your issue has already been reported.
  65. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  66. `here <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**>`_.
  67. Credits
  68. =======
  69. Contributors
  70. ------------
  71. * Stéphane Bidoul <stephane.bidoul@acsone.eu>
  72. * Laetitia Gangloff <laetitia.gangloff@acsone.eu>
  73. * Adrien Peiffer <adrien.peiffer@acsone.eu>
  74. Maintainer
  75. ----------
  76. .. image:: https://odoo-community.org/logo.png
  77. :alt: Odoo Community Association
  78. :target: https://odoo-community.org
  79. This module is maintained by the OCA.
  80. OCA, or the Odoo Community Association, is a nonprofit organization whose
  81. mission is to support the collaborative development of Odoo features and
  82. promote its widespread use.
  83. To contribute to this module, please visit http://odoo-community.org.