|
| 1 | +============ |
| 2 | +Report Async |
| 3 | +============ |
| 4 | + |
| 5 | +.. |
| 6 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 7 | + !! This file is generated by oca-gen-addon-readme !! |
| 8 | + !! changes will be overwritten. !! |
| 9 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 10 | + !! source digest: sha256:49866d2b712288add9819deb8ff6dc8aa180a52463a72789350974bbf10e17ae |
| 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-OCA%2Freporting--engine-lightgray.png?logo=github |
| 20 | + :target: https://github.com/OCA/reporting-engine/tree/17.0/report_async |
| 21 | + :alt: OCA/reporting-engine |
| 22 | +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png |
| 23 | + :target: https://translation.odoo-community.org/projects/reporting-engine-17-0/reporting-engine-17-0-report_async |
| 24 | + :alt: Translate me on Weblate |
| 25 | +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png |
| 26 | + :target: https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&target_branch=17.0 |
| 27 | + :alt: Try me on Runboat |
| 28 | + |
| 29 | +|badge1| |badge2| |badge3| |badge4| |badge5| |
| 30 | + |
| 31 | +The new menu "Report Center" is the central place to host your reports |
| 32 | +in one place. From here, there are 2 ways to launch the report, |
| 33 | + |
| 34 | +1. Run Now - run report immediately as per normal. |
| 35 | +2. Run Background - put the report execution to queue job. |
| 36 | + |
| 37 | +By using the queue job, option 2 is great for long running report. The |
| 38 | +report file will be saved for later use, with the option to send report |
| 39 | +by email as soon as it is ready. |
| 40 | + |
| 41 | +Notes: |
| 42 | + |
| 43 | +- Only user with Technical Feature rights can manage the report. |
| 44 | +- Every internal user will have right to execute the report allowed for |
| 45 | + his/her groups. |
| 46 | +- The files created are owned and viewable only by the person who run |
| 47 | + the report. |
| 48 | +- Job queue manager can also see all jobs for each reports. |
| 49 | + |
| 50 | +**Table of contents** |
| 51 | + |
| 52 | +.. contents:: |
| 53 | + :local: |
| 54 | + |
| 55 | +Usage |
| 56 | +===== |
| 57 | + |
| 58 | +Menu: Dashboard > Report Center |
| 59 | + |
| 60 | +As Technical Feature users, you can manage reports for Report Center. |
| 61 | + |
| 62 | +- **Report:** choose the report (a window action). Although the option |
| 63 | + show all window actions it only make sense for window actions that |
| 64 | + launch reports. |
| 65 | +- **Allow Async:** check this, if you want the report to run in |
| 66 | + background too, suitable for report that return file as result, i.e., |
| 67 | + pdf/xlsx/csv/txt. |
| 68 | +- **Email Notification:** if checked, once the background process is |
| 69 | + completed, email with link to download report will be sent. |
| 70 | +- **Groups:** select user groups allowed to use this report. If left |
| 71 | + blank, all user can use. |
| 72 | + |
| 73 | +As normal user, you can run your reports from Report Center |
| 74 | + |
| 75 | +- **Run Now button:** to run report immediately as per normal. |
| 76 | +- **Run Background button:** to run report asynchronously. Fall back to |
| 77 | + run now, if not report that produce file. |
| 78 | +- **Job Status:** show status of the latest run job. If job fail, |
| 79 | + exception error will also shown |
| 80 | +- **Files:** show all files being produced by the job as run by the |
| 81 | + user. |
| 82 | +- **Jobs:** show all jobs triggered by this report as run by the user. |
| 83 | + Only job queue manager have access to this button. |
| 84 | + |
| 85 | +Bug Tracker |
| 86 | +=========== |
| 87 | + |
| 88 | +Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_. |
| 89 | +In case of trouble, please check there if your issue has already been reported. |
| 90 | +If you spotted it first, help us to smash it by providing a detailed and welcomed |
| 91 | +`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_async%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. |
| 92 | + |
| 93 | +Do not contact contributors directly about support or help with technical issues. |
| 94 | + |
| 95 | +Credits |
| 96 | +======= |
| 97 | + |
| 98 | +Authors |
| 99 | +------- |
| 100 | + |
| 101 | +* Ecosoft |
| 102 | + |
| 103 | +Contributors |
| 104 | +------------ |
| 105 | + |
| 106 | +- `Ecosoft <http://ecosoft.co.th>`__: |
| 107 | + |
| 108 | + |
| 109 | + |
| 110 | + - Tharathip Chaweewongphan < [email protected]> |
| 111 | + |
| 112 | +- Opensourceintegrators |
| 113 | + |
| 114 | + |
| 115 | + - Nikul Chaudhary < [email protected]> |
| 116 | + |
| 117 | +Maintainers |
| 118 | +----------- |
| 119 | + |
| 120 | +This module is maintained by the OCA. |
| 121 | + |
| 122 | +.. image:: https://odoo-community.org/logo.png |
| 123 | + :alt: Odoo Community Association |
| 124 | + :target: https://odoo-community.org |
| 125 | + |
| 126 | +OCA, or the Odoo Community Association, is a nonprofit organization whose |
| 127 | +mission is to support the collaborative development of Odoo features and |
| 128 | +promote its widespread use. |
| 129 | + |
| 130 | +.. |maintainer-kittiu| image:: https://github.com/kittiu.png?size=40px |
| 131 | + :target: https://github.com/kittiu |
| 132 | + :alt: kittiu |
| 133 | + |
| 134 | +Current `maintainer <https://odoo-community.org/page/maintainer-role>`__: |
| 135 | + |
| 136 | +|maintainer-kittiu| |
| 137 | + |
| 138 | +This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/17.0/report_async>`_ project on GitHub. |
| 139 | + |
| 140 | +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. |
0 commit comments