diff --git a/report_async/README.rst b/report_async/README.rst new file mode 100644 index 000000000..8b2719208 --- /dev/null +++ b/report_async/README.rst @@ -0,0 +1,123 @@ +============ +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. + +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 + +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/static/description/index.html b/report_async/static/description/index.html new file mode 100644 index 000000000..7f653892b --- /dev/null +++ b/report_async/static/description/index.html @@ -0,0 +1,464 @@ + + + + + + +Report Async + + + +
+

Report Async

+ + +

Beta License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runbot

+

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. +
  2. Run Background - put the report execution to queue job.
    3. +
+

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

+ +
+

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.
    • +
+
+
+

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

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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.

+

Current 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.

+
+
+
+ +