From 65e4a41a89dc59def9195398f1fce97f8d246b40 Mon Sep 17 00:00:00 2001 From: KKamaa Date: Fri, 15 Apr 2022 14:05:47 +0300 Subject: [PATCH] [FIX] readme sample --- report_async/README.rst | 137 ++++++++++++++++++ report_async/readme/CONTRIBUTORS.rst | 5 + report_async/readme/USAGE.rst | 9 ++ report_async/static/description/index.html | 12 +- report_async/static/description/sample.gif | Bin 0 -> 3309215 bytes .../static/src/js/components/action_menus.js | 4 +- .../src/js/report/action_manager_report.js | 5 +- 7 files changed, 167 insertions(+), 5 deletions(-) create mode 100644 report_async/static/description/sample.gif diff --git a/report_async/README.rst b/report_async/README.rst index e69de29bb..28d0fffd4 100644 --- a/report_async/README.rst +++ b/report_async/README.rst @@ -0,0 +1,137 @@ +============ +Report Async +============ + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github + :target: https://github.com/OCA/reporting-engine/tree/14.0/report_async + :alt: OCA/reporting-engine +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/reporting-engine-14-0/reporting-engine-14-0-report_async + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/143/14.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +The new menu "Report Center" is the central place to host your reports in one place. +From here, there are 2 ways to launch the report, + +1. Run Now - run report immediately as per normal. +2. Run Background - put the report execution to queue job. + +By using the queue job, option 2 is great for long running report. +The report file will be saved for later use, with the option to send report +by email as soon as it is ready. + +Notes: + +* Only user with Technical Feature rights can manage the report. +* Every internal user will have right to execute the report allowed for his/her groups. +* The files created are owned and viewable only by the person who run the report. +* Job queue manager can also see all jobs for each reports. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +Menu: Dashboard > Report Center + +As Technical Feature users, you can manage reports for Report Center. + +- **Report:** choose the report (a window action). Although the option show all window actions + it only make sense for window actions that launch reports. +- **Allow Async:** check this, if you want the report to run in background too, suitable for + report that return file as result, i.e., pdf/xlsx/csv/txt. +- **Email Notification:** if checked, once the background process is completed, email with link to download + report will be sent. +- **Groups:** select user groups allowed to use this report. If left blank, all user can use. + +As normal user, you can run your reports from Report Center + +- **Run Now button:** to run report immediately as per normal. +- **Run Background button:** to run report asynchronously. Fall back to run now, if not report that produce file. +- **Job Status:** show status of the latest run job. If job fail, exception error will also shown +- **Files:** show all files being produced by the job as run by the user. +- **Jobs:** show all jobs triggered by this report as run by the user. Only job queue manager have access to this button. + +As additional improvement, you can now generate reports async directly from the form view itself, +and not have to go into the "Report Center" specifically to do it. This can be done by pressing +*Print*, you will get a popup asking you if you want to run it Async, and then to verify the email +address that it should be sent to. See below sample: + +.. image:: https://raw.githubusercontent.com/OCA/reporting-engine/14.0/report_async/static/description/sample.gif + :width: 800 + :alt: How It Works + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Ecosoft + +Contributors +~~~~~~~~~~~~ + +* `Ecosoft `__: + + * Kitti U. + * Saran Lim. + * Tharathip Chaweewongphan + +* `Sunflower IT `__: + + * Tom Blauwendraat + * Kevin Kamau + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +.. |maintainer-kittiu| image:: https://github.com/kittiu.png?size=40px + :target: https://github.com/kittiu + :alt: kittiu + +Current `maintainer `__: + +|maintainer-kittiu| + +This module is part of the `OCA/reporting-engine `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/report_async/readme/CONTRIBUTORS.rst b/report_async/readme/CONTRIBUTORS.rst index d391cb73d..0f91c6253 100644 --- a/report_async/readme/CONTRIBUTORS.rst +++ b/report_async/readme/CONTRIBUTORS.rst @@ -3,3 +3,8 @@ * Kitti U. * Saran Lim. * Tharathip Chaweewongphan + +* `Sunflower IT `__: + + * Tom Blauwendraat + * Kevin Kamau diff --git a/report_async/readme/USAGE.rst b/report_async/readme/USAGE.rst index 9668d579d..43a2d6fc3 100644 --- a/report_async/readme/USAGE.rst +++ b/report_async/readme/USAGE.rst @@ -17,3 +17,12 @@ As normal user, you can run your reports from Report Center - **Job Status:** show status of the latest run job. If job fail, exception error will also shown - **Files:** show all files being produced by the job as run by the user. - **Jobs:** show all jobs triggered by this report as run by the user. Only job queue manager have access to this button. + +As additional improvement, you can now generate reports async directly from the form view itself, +and not have to go into the "Report Center" specifically to do it. This can be done by pressing +*Print*, you will get a popup asking you if you want to run it Async, and then to verify the email +address that it should be sent to. See below sample: + +.. image:: ../static/description/sample.gif + :width: 800 + :alt: How It Works diff --git a/report_async/static/description/index.html b/report_async/static/description/index.html index 7f653892b..9b31c5f08 100644 --- a/report_async/static/description/index.html +++ b/report_async/static/description/index.html @@ -3,7 +3,7 @@ - + Report Async