Skip to content

Commit b5f24a8

Browse files
Anxo82Anxo82
committed
[T-8768][MIG] account_financial_report_block_pdf
1 parent 7583438 commit b5f24a8

9 files changed

Lines changed: 591 additions & 53 deletions

File tree

‎account_financial_report_block_pdf/README.rst‎

Lines changed: 70 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,108 @@
1-
.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
2-
:target: http://www.gnu.org/licenses/agpl
3-
:alt: License: AGPL-3
4-
51
===================================
62
Account Financial Reports Block PDF
73
===================================
84

9-
This module allows to block the generation of financial reports in PDF format.
10-
It is possible to configure the list of financial reports that have to be blocked.
5+
..
6+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
7+
!! This file is generated by oca-gen-addon-readme !!
8+
!! changes will be overwritten. !!
9+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10+
!! source digest: sha256:242dd12a53539a8cec4ec373c14c65cb762d10e1f1d5bde4844c6c5019536419
11+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
12+
13+
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
14+
:target: https://odoo-community.org/page/development-status
15+
:alt: Beta
16+
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
17+
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
18+
:alt: License: AGPL-3
19+
.. |badge3| image:: https://img.shields.io/badge/github-sygel--technology%2Fsy--account--financial--reporting-lightgray.png?logo=github
20+
:target: https://github.com/sygel-technology/sy-account-financial-reporting/tree/18.0/account_financial_report_block_pdf
21+
:alt: sygel-technology/sy-account-financial-reporting
22+
23+
|badge1| |badge2| |badge3|
1124

25+
This module allows to block the generation of financial reports in PDF
26+
format. It is possible to configure the list of financial reports that
27+
have to be blocked.
28+
29+
**Table of contents**
30+
31+
.. contents::
32+
:local:
1233

1334
Configuration
1435
=============
1536

16-
To configure the list of financial reports that cannot be printed in PDF you need to:
37+
To configure the list of financial reports that cannot be printed in PDF
38+
you need to:
39+
40+
- Go to Settings > Technical > System Parameters.
1741

18-
* Go to Settings > Technical > System Parameters.
19-
* Find or create a system parameter called "forbidden.pdf.financial.reports".
20-
* Introduce the technical name of the wizard generator models that need to be blocked
21-
separated by commas. The link between the financial reports in the module
22-
account_financial_report and the technical name of their wizards is as follows:
42+
- Find or create a system parameter called
43+
"forbidden.pdf.financial.reports".
2344

24-
* General Ledger: general.ledger.report.wizard
25-
* Journal Ledger: journal.ledger.report.wizard
26-
* Trial Balance: trial.balance.report.wizard
27-
* Open Items: open.items.report.wizard
28-
* Aged Partner Balance: aged.partner.balance.report.wizard
29-
* VAT Report: vat.report.wizard
45+
- Introduce the technical name of the wizard generator models that need
46+
to be blocked separated by commas. The link between the financial
47+
reports in the module account_financial_report and the technical name
48+
of their wizards is as follows:
3049

31-
For instance, if the PDF generation of the General Ledger and Trial Balance reports have
32-
to be blocked, the "forbidden.pdf.financial.reports" system parameter should contain the
33-
value "general.ledger.report.wizard,trial.balance.report.wizard" (with no quotes).
50+
- General Ledger: general.ledger.report.wizard
51+
- Journal Ledger: journal.ledger.report.wizard
52+
- Trial Balance: trial.balance.report.wizard
53+
- Open Items: open.items.report.wizard
54+
- Aged Partner Balance: aged.partner.balance.report.wizard
55+
- VAT Report: vat.report.wizard
3456

35-
Keep in mind that all the PDF reports are blocked by default when this module is
36-
installed.
57+
For instance, if the PDF generation of the General Ledger and Trial
58+
Balance reports have to be blocked, the
59+
"forbidden.pdf.financial.reports" system parameter should contain the
60+
value "general.ledger.report.wizard,trial.balance.report.wizard" (with
61+
no quotes).
3762

38-
If a new report that inherits the abstract class account_financial_report_abstract_wizard
39-
is developed, its PDF report can also be blocked by adding the name of its own wizard
40-
in the "forbidden.pdf.financial.reports" system parameter list.
63+
Keep in mind that all the PDF reports are blocked by default when this
64+
module is installed.
4165

66+
If a new report that inherits the abstract class
67+
account_financial_report_abstract_wizard is developed, its PDF report
68+
can also be blocked by adding the name of its own wizard in the
69+
"forbidden.pdf.financial.reports" system parameter list.
4270

4371
Usage
4472
=====
4573

46-
When a user tries to generate the PDF file of a financial report whose PDF file have
47-
been blocked, an error message appears.
48-
74+
When a user tries to generate the PDF file of a financial report whose
75+
PDF file have been blocked, an error message appears.
4976

5077
Bug Tracker
5178
===========
5279

53-
Bugs and errors are managed in `issues of GitHub <https://github.com/sygel-technology/sy-account-financial-reporting/issues>`_.
54-
In case of problems, please check if your problem has already been
55-
reported. If you are the first to discover it, help us solving it by indicating
56-
a detailed description `here <https://github.com/sygel-technology/sy-account-financial-reporting/issues/new>`_.
80+
Bugs are tracked on `GitHub Issues <https://github.com/sygel-technology/sy-account-financial-reporting/issues>`_.
81+
In case of trouble, please check there if your issue has already been reported.
82+
If you spotted it first, help us to smash it by providing a detailed and welcomed
83+
`feedback <https://github.com/sygel-technology/sy-account-financial-reporting/issues/new?body=module:%20account_financial_report_block_pdf%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
5784

5885
Do not contact contributors directly about support or help with technical issues.
5986

60-
6187
Credits
6288
=======
6389

6490
Authors
65-
~~~~~~~
66-
67-
* Sygel, Odoo Community Association (OCA)
91+
-------
6892

93+
* Sygel
6994

7095
Contributors
71-
~~~~~~~~~~~~
72-
73-
* `Sygel <https://www.sygel.es>`__:
74-
75-
* Manuel Regidor <manuel.regidor@sygel.es>
76-
* Valentin Vinagre <valentin.vinagre@sygel.es>
77-
96+
------------
7897

79-
Maintainer
80-
~~~~~~~~~~
98+
- `Sygel <https://www.sygel.es>`__:
8199

82-
This module is maintained by Sygel.
100+
- Manuel Regidor
101+
- Valentín Vinagre
83102

84-
.. image:: https://www.sygel.es/logo.png
85-
:alt: Sygel
86-
:target: https://www.sygel.es
103+
Maintainers
104+
-----------
87105

88-
This module is part of the `Sygel/sy-account-financial-reporting <https://github.com/sygel-technology/sy-account-financial-reporting>`_.
106+
This module is part of the `sygel-technology/sy-account-financial-reporting <https://github.com/sygel-technology/sy-account-financial-reporting/tree/18.0/account_financial_report_block_pdf>`_ project on GitHub.
89107

90-
To contribute to this module, please visit https://github.com/sygel-technology/.
108+
You are welcome to contribute.

‎account_financial_report_block_pdf/__manifest__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
33
{
44
"name": "Account Financial Reports Block PDF",
5-
"version": "16.0.1.0.0",
5+
"version": "18.0.1.0.0",
66
"category": "Reporting",
77
"summary": "Block the generation of financial PDF reports",
88
"author": "Sygel," "Odoo Community Association (OCA)",

‎account_financial_report_block_pdf/readme/CONFIGURE.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
To configure the list of financial reports that cannot be printed in PDF you need to:
2+
3+
* Go to Settings > Technical > System Parameters.
4+
* Find or create a system parameter called "forbidden.pdf.financial.reports".
5+
* Introduce the technical name of the wizard generator models that need to be blocked
6+
separated by commas. The link between the financial reports in the module
7+
account_financial_report and the technical name of their wizards is as follows:
8+
9+
* General Ledger: general.ledger.report.wizard
10+
* Journal Ledger: journal.ledger.report.wizard
11+
* Trial Balance: trial.balance.report.wizard
12+
* Open Items: open.items.report.wizard
13+
* Aged Partner Balance: aged.partner.balance.report.wizard
14+
* VAT Report: vat.report.wizard
15+
16+
For instance, if the PDF generation of the General Ledger and Trial Balance reports have
17+
to be blocked, the "forbidden.pdf.financial.reports" system parameter should contain the
18+
value "general.ledger.report.wizard,trial.balance.report.wizard" (with no quotes).
19+
20+
Keep in mind that all the PDF reports are blocked by default when this module is
21+
installed.
22+
23+
If a new report that inherits the abstract class account_financial_report_abstract_wizard
24+
is developed, its PDF report can also be blocked by adding the name of its own wizard
25+
in the "forbidden.pdf.financial.reports" system parameter list.

‎account_financial_report_block_pdf/readme/CONTRIBUTORS.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- [Sygel](https://www.sygel.es):
2+
- Manuel Regidor
3+
- Valentín Vinagre

‎account_financial_report_block_pdf/readme/DESCRIPTION.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
This module allows to block the generation of financial reports in PDF format.
2+
It is possible to configure the list of financial reports that have to be blocked.

‎account_financial_report_block_pdf/readme/USAGE.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
When a user tries to generate the PDF file of a financial report whose PDF file have
2+
been blocked, an error message appears.

0 commit comments

Comments
 (0)