[13.0][ADD] report_dynamic - Lets Odoo users build reports #591

thomaspaulb · 2022-02-23T08:03:13Z

This new module allows Odoo users to create a report on any model without the need of a developer:

Report content is a sequence of Jinja-capable HTML template blocks.
Each block can be conditionally shown or hidden by evaluation of an Odoo domain or a Python expression.
Aliases can be defined as shorthand expressions to more complicated ones. As the original requirement was for generating contracts, it also includes a macro for automatic section numbering (1.1, 1.2, 1.2.1 etc).
For usage, the module adds a "More.." server action to generate the report from the record's form view.
Multiple templates can exists per each model, and a domain expression can be defined on each template to define on which records it should apply. If the server action is called on a record and multiple report templates match the record, a popup comes to let the user choose which template to use.

thomaspaulb · 2022-02-23T08:03:43Z

@Kiplangatdan Opened it slightly differently

Kiplangatdan · 2022-02-23T08:05:09Z

@thomaspaulb This is alright, it can be picked from here.

oca-clabot · 2022-02-24T18:02:48Z

Hey @thomaspaulb, thank you for your Pull Request.

It looks like some users haven't signed our Contributor License Agreement, yet.
You can read and sign our full Contributor License Agreement here: http://odoo-community.org/page/cla
Here is a list of the users:

douglas-tabut tabutdouglas@gmail.com (no github login found)

Appreciation of efforts,
OCA CLAbot

gurneyalex · 2022-02-28T08:47:40Z

CLA for @douglas-tabut is OK (checked manually, I'll look into why the clabot is not finding it)

thomaspaulb · 2022-02-28T10:36:58Z

@gurneyalex Thanks for checking!

gurneyalex · 2022-02-28T11:10:34Z

Depends on OCA/web#1822 which is not merged yet.

thomaspaulb · 2022-02-28T19:50:33Z

Now merged.

ntsirintanis · 2022-04-05T10:41:05Z

@thomaspaulb let's please set this to draft until we have something complete

gurneyalex · 2022-04-06T11:40:46Z

@thomaspaulb let's please set this to draft until we have something complete
@ntsirintanis done

elvise · 2022-05-02T16:21:43Z

@thomaspaulb great PR!

francesco-ooops · 2022-05-16T15:19:02Z

Hi @thomaspaulb , do you plan on working further on this one?
thanks!

thomaspaulb · 2022-05-16T15:32:38Z

@francesco-ooops Yes! There only two todo's left:

Find a better solution for the "preview record" selection widget, currently it's fields.Reference but it doesnt really work well
Automatically create/remove a "Create report" server action on any record type where we have dynamic reports enabled - we started on that but didn't finish yet.

Hey @ntsirintanis, this is on your plate but it looks like you didn't get to it yet - do you need more pointers on this one? If yes, reassign back to me, if no, let's plan some time to get this over the finish line.

elvise · 2022-05-27T09:39:48Z

@thomaspaulb great PR! any good news about these two points ?

elvise · 2022-05-27T09:42:39Z

@thomaspaulb could you also do a rebase? :)

ntsirintanis · 2022-05-30T07:18:15Z

I am going to continue on this when I manage to find some time.

ntsirintanis · 2022-06-01T14:56:18Z

TODO: One window action per model

ntsirintanis · 2022-06-02T13:49:36Z

TODO: provide search view, add column resource_ref in tree view, hide it when there is a template.

ntsirintanis · 2022-06-07T07:40:04Z

report_dynamic/models/report_dynamic.py

+    @api.model
+    def _selection_target_model(self):
+        models = self.env["ir.model"].search([])
+        return [(model.model, model.name) for model in models]


check here if there's an efficient way to present only those models that at least one active record exists in the db.

I think just simply get the distinct model ids or names from the report dynamic table first, and then use them as filter criteria in this search domain.

Of course you could also refactor this selection field to a many2one to ir.model which might make it a bit easier all in all but not sure if its worth it

yes, that's what I am attempting to do, to get non transient models with count > 0. Will resume working on this soon, most probably.

Yea in one step thats difficult, you could do that with sql but thats definitely not worth it:) if its two steps you can just unique them in python and the ones in report dynamic will be non transient anyway

Ah well maybe if you refactor to a many2one and then use read_group :)

Probably replacing the reference field with a many2one to ir.model, and another many2one to ir.model.model, will make this easier. Something to consider in the future.

I would start by filtering out non real models. Then you can add a TODO to improve it.

SELECT nspname AS schemaname,relname,reltuples FROM pg_class C LEFT JOIN pg_namespace N ON (N.oid = C.relnamespace) WHERE nspname NOT IN ('pg_catalog', 'information_schema') AND relkind='r' ORDER BY reltuples DESC;

the above takes the amount of tuples from the statistics (created by autovacuum) - but I consider only showing models with records pretty much an anti-feature. I'd want to be able to prepare a report even if I haven't created records already, and also installing some module using this to create a report would fail if the model doesn't have records

what about this?

ntsirintanis · 2022-06-08T10:32:54Z

I've run out of ideas of how to make this (functionally) better. If anyone's feels like doing some functional testing and bring forth also some ideas, please do so. I will start thinking about how to unit test everything here.

elvise · 2022-06-08T18:01:11Z

Hi @thomaspaulb and @ntsirintanis really thanks for this PR!!!

This is just my review from the UX point of view:

1 Create new Tab “Dynamic Placeholder” for all fields about this argument

2 Move the field “Preview Record” above

3 Enable/Disable expression Python (with the switch widget) when it’s disabled then hide the description

4 Archive in the first place as the standard

5 Why i need this list in the form when i can manage and create my sections directly from smart button ?
For my perspective when i tested this in runboat it’s more comfortable from smart button then from popup.
From smart button i have more space and more “air” because as the final user when i creating the new report i need stay there not 2 mins but maybe 1 hour or more.

POPUP

FORM

Please let me know your opinion of these points.

ntsirintanis · 2022-06-09T07:03:23Z

@elvise thanks a lot for taking the time to test this, and respond with some really meaningful feedback! I'll go through your points and implement them as needed.

elvise · 2022-06-19T12:53:40Z

3 Enable/Disable expression Python (with the switch widget) when it’s disabled then hide the description

@ntsirintanis I tested again, i think we need to add a new menu “Report” because right now its reachable only if you click in the name “Dynamic Reports”

RPReplay_Final1655643072.mov

@ntsirintanis what do you think ?

elvise · 2022-06-24T13:06:45Z

Hi @ntsirintanis do you already have some ideas on how to manage o2m fields such as "sale orde line"?

…view_resource_ref

Improvements

thomaspaulb · 2022-10-09T06:27:32Z

@ntsirintanis I did a lot of reshuffling of functionality, the module as a whole seems more logical to me. It still needs some love and testing though - I think I have broken the instant preview functionality that existed on individual sections, and although the PR description claims to include a domain expression can be defined on each template to define on which records it should apply, I don't see anywhere this domain is used.

ntsirintanis · 2022-10-11T07:58:49Z

report_dynamic/wizards/wizard_report_dynamic.py

+
+    template_id = fields.Many2one(
+        comodel_name="report.dynamic",
+        domain=lambda self: [


@thomaspaulb The idea is to make this domain computed. The "standard" part of the domain will be the requirements that the selected record is a template, with model_id == active_model. Then, we loop on all templates in the database for that model_id. In the computation of the domain we add the "standard" part, and OR every template.condition_domain_global. Then user can select only a template that it's computed domain selects all active_ids. Does this make sense?

Yeah, however implementationwise, the easiest is to make an invisible, computed field matching_template_ids on the wizard, and then on the XML of the form view, not on the Python field, add a domain of "id, in, matching_template_ids"

That works only when matching_template_ids is an (invisible) field on the form view too.

The only drawback of this method is it can get really slow when the number of matching records is > 10000 or something, in which case you would resort to OCA's web_domain_field instead. But for matching templates, I don't expect 10000 :-) just a handful max

hbrunn · 2022-10-15T22:10:50Z

report_dynamic/models/report_dynamic.py

+    @api.model
+    def _selection_target_model(self):
+        models = self.env["ir.model"].search([])
+        return [(model.model, model.name) for model in models]


SELECT nspname AS schemaname,relname,reltuples FROM pg_class C LEFT JOIN pg_namespace N ON (N.oid = C.relnamespace) WHERE nspname NOT IN ('pg_catalog', 'information_schema') AND relkind='r' ORDER BY reltuples DESC;

the above takes the amount of tuples from the statistics (created by autovacuum) - but I consider only showing models with records pretty much an anti-feature. I'd want to be able to prepare a report even if I haven't created records already, and also installing some module using this to create a report would fail if the model doesn't have records

hbrunn · 2022-10-15T22:15:45Z

report_dynamic/models/report_dynamic.py

+            [("model", "=", "ir.ui.view"), ("res_id", "=", self.wrapper_report_id.id)],
+            limit=1,
+        )
+        return "{}.{}".format(record.module, record.name)


you can use https://github.com/OCA/OCB/blob/13.0/odoo/addons/base/models/ir_ui_view.py#L235 here

but what happens if I want to use a template without xmlid?

Not answered question?

hbrunn · 2022-10-15T22:19:17Z

report_dynamic/models/report_dynamic.py

+    lock_date = fields.Date(readonly=True)
+    field_ids = fields.Many2many(
+        comodel_name="ir.model.fields",
+        relation="contextual_field_rel",


I'd suggest to start this with report_dynamic_...

what about this?

hbrunn · 2022-10-15T22:29:19Z

report_dynamic/wizards/wizard_lock_report.py

+    def action_lock_report(self):
+        """Lock the report on given date"""
+        self.ensure_one()
+        self.report_id.lock_date = self.lock_date


would it make sense to generate the report(s) at this point and attach them?

Maybe a TODO comment?

report_dynamic/README.rst

hbrunn · 2022-10-15T22:40:46Z

Multiple templates can exists per each model, and a domain expression can be defined on each template to define on which records it should apply. If the server action is called on a record and multiple report templates match the record, a popup comes to let the user choose which template to use.

that's not true, right? But adding this server action would be a nice usability thing

report_dynamic/README.rst

simahawk · 2022-10-17T07:46:21Z

report_dynamic/demo/demo.xml

@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo noupdate="1">


are you sure about using noupdate for demo data?

simahawk · 2022-10-17T07:50:21Z

report_dynamic/models/report_dynamic.py

+        if not model:
+            return res
+        try:
+            self.env[model].search_read([], limit=1)


can't we avoid reading here?

We can use
self.env[model].search_read([], limit=1, fields=['display_name'])

BUT

with reading all the fields we can be sure, we have access to any field, we can use in reporting. For current person at least.

So it can be fields arg added, or stay as it is with such a "check".

I still don't get what you are trying to achieve here and why you want to load ALL fields for ALL records.
If the current user is not able to read a field does not mean that users using the report won't be able to...

report_dynamic/models/report_dynamic_section.py

report_dynamic/tests/test_report_dynamic.py

report_dynamic/tests/test_report_dynamic_section.py

simahawk · 2022-10-17T07:59:29Z

report_dynamic/utils.py

@@ -0,0 +1,26 @@
+class Header:


Suggested change

class Header:

class Header:

__slots__ = ("value", "base_value", "child")

what about this?

thomaspaulb · 2022-10-21T14:12:29Z

Multiple templates can exists per each model, and a domain expression can be defined on each template to define on which records it should apply. If the server action is called on a record and multiple report templates match the record, a popup comes to let the user choose which template to use.

that's not true, right? But adding this server action would be a nice usability thing

It's sort of true - the popup was supposed to come only when multiple templates match, but currently it always comes and people have to choose the template.

elvise · 2022-11-16T09:52:14Z

@thomaspaulb just a gentle reminder :)

SkiBY · 2023-01-12T06:37:53Z

report_dynamic/demo/demo.xml

+<?xml version="1.0" encoding="utf-8" ?>
+<odoo noupdate="1">
+    <!-- template for demo_report_1 -->
+    <record id="demo_template_1" model="report.dynamic">


Don't know it is my problem only, but noupdate flag is ignored and second test fire up is blocked by _constrain_template_status

normally demo data is loaded only w/ -i. Anyway, my comment above is not blocking.

[IMP]Test Case type changed to SavepointCase

bealdav · 2023-01-12T12:49:09Z

Hi all, happy to see it works now. Thanks for that.
Maybe @simahawk can check ?

elvise · 2023-02-19T14:31:38Z

@simahawk gentle reminder :)

simahawk

There are a bunch of not answered comments.
Feel free to reply with "I add a TODO for later" if you don't have time and want to move fwd.
Regarding commits: do you need them all? I think you can squash all in one when done.
Other than this, LGTM.

simahawk · 2023-02-20T10:56:10Z

.pre-commit-config.yaml

@@ -105,7 +105,7 @@ repos:
    rev: 2.5.2
    hooks:
      - id: setuptools-odoo-make-default
-  - repo: https://gitlab.com/pycqa/flake8
+  - repo: https://github.com/pycqa/flake8


pls rebase after #726 is merged and trash this change

simahawk · 2023-02-20T10:57:03Z

report_dynamic/demo/demo.xml

+<?xml version="1.0" encoding="utf-8" ?>
+<odoo noupdate="1">
+    <!-- template for demo_report_1 -->
+    <record id="demo_template_1" model="report.dynamic">


normally demo data is loaded only w/ -i. Anyway, my comment above is not blocking.

simahawk · 2023-02-20T10:57:18Z

report_dynamic/models/report_dynamic.py

+    lock_date = fields.Date(readonly=True)
+    field_ids = fields.Many2many(
+        comodel_name="ir.model.fields",
+        relation="contextual_field_rel",


what about this?

simahawk · 2023-02-20T10:57:45Z

report_dynamic/models/report_dynamic.py

+    @api.model
+    def _selection_target_model(self):
+        models = self.env["ir.model"].search([])
+        return [(model.model, model.name) for model in models]


what about this?

simahawk · 2023-02-20T11:00:01Z

report_dynamic/models/report_dynamic.py

+        if not model:
+            return res
+        try:
+            self.env[model].search_read([], limit=1)


I still don't get what you are trying to achieve here and why you want to load ALL fields for ALL records.
If the current user is not able to read a field does not mean that users using the report won't be able to...

simahawk · 2023-02-20T11:00:49Z

report_dynamic/models/report_dynamic.py

+            [("model", "=", "ir.ui.view"), ("res_id", "=", self.wrapper_report_id.id)],
+            limit=1,
+        )
+        return "{}.{}".format(record.module, record.name)


Not answered question?

simahawk · 2023-02-20T11:01:16Z

report_dynamic/utils.py

@@ -0,0 +1,26 @@
+class Header:


what about this?

simahawk · 2023-02-20T11:01:36Z

report_dynamic/wizards/wizard_lock_report.py

+    def action_lock_report(self):
+        """Lock the report on given date"""
+        self.ensure_one()
+        self.report_id.lock_date = self.lock_date


Maybe a TODO comment?

elvise · 2023-04-16T14:21:56Z

@thomaspaulb what is your plan for this great PR?

github-actions · 2023-08-20T12:21:23Z

There hasn't been any activity on this pull request in the past 4 months, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 30 days.
If you want this PR to never become stale, please ask a PSC member to apply the "no stale" label.

gurneyalex marked this pull request as draft April 6, 2022 11:40

ntsirintanis force-pushed the 13.0-report_dynamic branch from 329cbed to df81c7c Compare May 30, 2022 07:17

ntsirintanis force-pushed the 13.0-report_dynamic branch 2 times, most recently from 523d968 to b88619c Compare June 2, 2022 08:47

ntsirintanis reviewed Jun 7, 2022

View reviewed changes

ntsirintanis force-pushed the 13.0-report_dynamic branch from 4eed04d to 8bf8845 Compare June 8, 2022 09:47

ntsirintanis force-pushed the 13.0-report_dynamic branch from 8bf8845 to 78b6052 Compare June 8, 2022 15:19

elvise mentioned this pull request Jun 11, 2022

[14.0][ADD] product_attribute_value_price_import module OCA/product-attribute#1079

Merged

thomaspaulb and others added 5 commits October 8, 2022 18:45

[FIX] model was not copied on new duplication

92d5799

[FIX] bug where resource_ref is used for previewing and should be pre…

18b3776

…view_resource_ref

[FIX] bring back sample record

ee68255

[FIX] almost all the tests

5fc1ba1

Merge pull request #7 from sunflowerit/13.0-report_dynamic-imp

4dbabd9

Improvements

thomaspaulb and others added 2 commits October 9, 2022 08:41

[UPD] correct attribution and maintainer

25722ae

[UPD] present display_name for sample record, increase test coverage

c51fe59

ntsirintanis force-pushed the 13.0-report_dynamic branch from 0b2662e to c51fe59 Compare October 10, 2022 10:23

ntsirintanis reviewed Oct 11, 2022

View reviewed changes

hbrunn reviewed Oct 15, 2022

View reviewed changes

report_dynamic/README.rst Show resolved Hide resolved

HviorForgeFlow requested review from simahawk and etobella October 17, 2022 07:41

simahawk reviewed Oct 17, 2022

View reviewed changes

[IMP]Test Case type changed to SavepointCase

cbd0e90

SkiBY reviewed Jan 12, 2023

View reviewed changes

SkiBY mentioned this pull request Jan 12, 2023

[IMP]Test Case type changed to SavepointCase sunflowerit/reporting-engine#8

Merged

Merge pull request #8 from SkiBY/13.0-report_dynamic

32785aa

[IMP]Test Case type changed to SavepointCase

simahawk requested changes Feb 20, 2023

View reviewed changes

github-actions bot added the stale PR/Issue without recent activity, it'll be soon closed automatically. label Aug 20, 2023

HviorForgeFlow added no stale Use this label to prevent the automated stale action from closing this PR/Issue. and removed stale PR/Issue without recent activity, it'll be soon closed automatically. labels Aug 21, 2023

		@@ -0,0 +1,70 @@
		<?xml version="1.0" encoding="utf-8" ?>
		<odoo noupdate="1">

	class Header:
	class Header:
	__slots__ = ("value", "base_value", "child")

[13.0][ADD] report_dynamic - Lets Odoo users build reports #591

Are you sure you want to change the base?

[13.0][ADD] report_dynamic - Lets Odoo users build reports #591

Conversation

thomaspaulb commented Feb 23, 2022 • edited Loading

thomaspaulb commented Feb 23, 2022

Kiplangatdan commented Feb 23, 2022

oca-clabot commented Feb 24, 2022

gurneyalex commented Feb 28, 2022

thomaspaulb commented Feb 28, 2022

gurneyalex commented Feb 28, 2022

thomaspaulb commented Feb 28, 2022

ntsirintanis commented Apr 5, 2022

gurneyalex commented Apr 6, 2022

elvise commented May 2, 2022

francesco-ooops commented May 16, 2022

thomaspaulb commented May 16, 2022

elvise commented May 27, 2022 • edited Loading

elvise commented May 27, 2022

ntsirintanis commented May 30, 2022

ntsirintanis commented Jun 1, 2022

ntsirintanis commented Jun 2, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hbrunn Oct 15, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ntsirintanis commented Jun 8, 2022

elvise commented Jun 8, 2022 • edited Loading

ntsirintanis commented Jun 9, 2022

elvise commented Jun 19, 2022

elvise commented Jun 24, 2022

thomaspaulb commented Oct 9, 2022

ntsirintanis Oct 11, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hbrunn Oct 15, 2022 • edited Loading

Choose a reason for hiding this comment

hbrunn Oct 15, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hbrunn commented Oct 15, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thomaspaulb commented Oct 21, 2022

elvise commented Nov 16, 2022

SkiBY Jan 12, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bealdav commented Jan 12, 2023

elvise commented Feb 19, 2023

simahawk left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elvise commented Apr 16, 2023

github-actions bot commented Aug 20, 2023

thomaspaulb commented Feb 23, 2022 •

edited

Loading

elvise commented May 27, 2022 •

edited

Loading

hbrunn Oct 15, 2022 •

edited

Loading

elvise commented Jun 8, 2022 •

edited

Loading

ntsirintanis Oct 11, 2022 •

edited

Loading

hbrunn Oct 15, 2022 •

edited

Loading

hbrunn Oct 15, 2022 •

edited

Loading

SkiBY Jan 12, 2023 •

edited

Loading

simahawk left a comment •

edited

Loading