|
| 1 | +=================================== |
| 2 | +Account Financial Reports Block PDF |
| 3 | +=================================== |
| 4 | + |
| 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| |
| 24 | + |
| 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: |
| 33 | + |
| 34 | +Configuration |
| 35 | +============= |
| 36 | + |
| 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. |
| 41 | + |
| 42 | +- Find or create a system parameter called |
| 43 | + "forbidden.pdf.financial.reports". |
| 44 | + |
| 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: |
| 49 | + |
| 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 |
| 56 | + |
| 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). |
| 62 | + |
| 63 | +Keep in mind that all the PDF reports are blocked by default when this |
| 64 | +module is installed. |
| 65 | + |
| 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. |
| 70 | + |
| 71 | +Usage |
| 72 | +===== |
| 73 | + |
| 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. |
| 76 | + |
| 77 | +Bug Tracker |
| 78 | +=========== |
| 79 | + |
| 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**>`_. |
| 84 | + |
| 85 | +Do not contact contributors directly about support or help with technical issues. |
| 86 | + |
| 87 | +Credits |
| 88 | +======= |
| 89 | + |
| 90 | +Authors |
| 91 | +------- |
| 92 | + |
| 93 | +* Sygel |
| 94 | + |
| 95 | +Contributors |
| 96 | +------------ |
| 97 | + |
| 98 | +- `Sygel <https://www.sygel.es>`__: |
| 99 | + |
| 100 | + - Manuel Regidor |
| 101 | + - Valentín Vinagre |
| 102 | + |
| 103 | +Maintainers |
| 104 | +----------- |
| 105 | + |
| 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. |
| 107 | + |
| 108 | +You are welcome to contribute. |
0 commit comments