diff --git a/mis_builder/README.rst b/mis_builder/README.rst new file mode 100644 index 00000000..99a2dbcd --- /dev/null +++ b/mis_builder/README.rst @@ -0,0 +1,92 @@ +.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg + :alt: License: AGPL-3 + +Module name +=========== + +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. + +.. figure:: static/description/ex_report_template.png + :scale: 80 % + :alt: Sample report template + +* 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. + +.. figure:: static/description/ex_report.png + :alt: Sample report configuration + +* From the MIS Report view, you can preview the report, add it to and Odoo dashboard, + and export it to PDF or Excel. + +.. figure:: static/description/ex_dashboard.png + :alt: Sample dashboard view + +For further information, please visit: + +* https://www.odoo.com/forum/help-1 + +Known issues / Roadmap +====================== + +* 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 `_. +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 `_. + +Credits +======= + +Contributors +------------ + +* Stéphane Bidoul +* Laetitia Gangloff +* Adrien Peiffer + +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. diff --git a/mis_builder/static/description/ex_dashboard.png b/mis_builder/static/description/ex_dashboard.png new file mode 100644 index 00000000..6c2d5b4f Binary files /dev/null and b/mis_builder/static/description/ex_dashboard.png differ diff --git a/mis_builder/static/description/ex_report.png b/mis_builder/static/description/ex_report.png new file mode 100644 index 00000000..03b882a8 Binary files /dev/null and b/mis_builder/static/description/ex_report.png differ diff --git a/mis_builder/static/description/ex_report_template.png b/mis_builder/static/description/ex_report_template.png new file mode 100644 index 00000000..f6070b87 Binary files /dev/null and b/mis_builder/static/description/ex_report_template.png differ diff --git a/mis_builder/static/description/icon.png b/mis_builder/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/mis_builder/static/description/icon.png differ diff --git a/mis_builder/static/description/icon.svg b/mis_builder/static/description/icon.svg new file mode 100644 index 00000000..a7a26d09 --- /dev/null +++ b/mis_builder/static/description/icon.svg @@ -0,0 +1,79 @@ + + + + + + + + image/svg+xml + + + + + + + + + + +