OCA reporting engine fork for dev and update.
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.

96 lines
3.4 KiB

  1. ==============
  2. Report Context
  3. ==============
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github
  15. :target: https://github.com/OCA/reporting-engine/tree/12.0/report_context
  16. :alt: OCA/reporting-engine
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/reporting-engine-12-0/reporting-engine-12-0-report_context
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/143/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module adds a context variable to reports. A possible use for this
  25. context could be hiding some fields or many other configuration options.
  26. **Table of contents**
  27. .. contents::
  28. :local:
  29. Usage
  30. =====
  31. To configure this module, you need to:
  32. * Enter Odoo in debug mode.
  33. * To add a specific context to a report, you should go to Settings ->
  34. Reporting -> Reporting and look for the report you want to edit on the
  35. list. You will see that now they contain a new field called Context Value
  36. , where you will be able to add all the desired context parameters.
  37. * Go to Settings -> Parameters -> System Parameters. On the system
  38. parameters list, look for report.default.context, which is a Python
  39. dictionary variable where you can add a context that will be common for
  40. all reports.
  41. It can also be added on the developer side using::
  42. <record id="model_name.report_id" model="ir.actions.report">
  43. <field name="context">YOUR CONTEXT HERE</field>
  44. </record>
  45. Bug Tracker
  46. ===========
  47. Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_.
  48. In case of trouble, please check there if your issue has already been reported.
  49. If you spotted it first, help us smashing it by providing a detailed and welcomed
  50. `feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_context%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  51. Do not contact contributors directly about support or help with technical issues.
  52. Credits
  53. =======
  54. Authors
  55. ~~~~~~~
  56. * Creu Blanca
  57. Contributors
  58. ~~~~~~~~~~~~
  59. * Jaime Arroyo <jaime.arroyo@creublanca.es>
  60. Maintainers
  61. ~~~~~~~~~~~
  62. This module is maintained by the OCA.
  63. .. image:: https://odoo-community.org/logo.png
  64. :alt: Odoo Community Association
  65. :target: https://odoo-community.org
  66. OCA, or the Odoo Community Association, is a nonprofit organization whose
  67. mission is to support the collaborative development of Odoo features and
  68. promote its widespread use.
  69. This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/12.0/report_context>`_ project on GitHub.
  70. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.