From c96dd93556554d03bf7010791ca5b74394b0429c Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Fri, 15 May 2020 11:08:02 +0000 Subject: [PATCH] [UPD] README.rst --- report_async/README.rst | 119 +++++++++++++++++++++ report_async/static/description/index.html | 108 ++++++++++--------- 2 files changed, 174 insertions(+), 53 deletions(-) create mode 100644 report_async/README.rst diff --git a/report_async/README.rst b/report_async/README.rst new file mode 100644 index 00000000..43ce15a6 --- /dev/null +++ b/report_async/README.rst @@ -0,0 +1,119 @@ +============ +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/12.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-12-0/reporting-engine-12-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/12.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 +~~~~~~~~~~~~ + +* Kitti U. + +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 index caa67a63..2a72761e 100644 --- a/report_async/static/description/index.html +++ b/report_async/static/description/index.html @@ -3,8 +3,8 @@ - -Scheduled Asynchronous Export + +Report Async -
-

Scheduled Asynchronous Export

+
+

Report Async

-

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

-

Add a new Automation feature: Scheduled Exports. -Based on an export list and a domain, an email is sent every X -hours/days/weeks/months to a selection of users.

+

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

-
-

Configuration

-

The configuration of a scheduled export is based on export lists.

-

To create an export list:

-
    -
  • open the list view of the model to export
    • -
  • select at least one record, and open “Action → Export”
    • -
  • select the fields to export and save using “Save fields list”.
    • -
-

To configure a scheduled export:

+
+

Usage

+

Menu: Dashboard > Report Center

+

As Technical Feature users, you can manage reports for Report Center.

    -
  • open “Settings → Technical → Automation → Scheduled Exports”
    • -
  • create a scheduled export by filling the form
    • +
  • 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.
-

A Scheduled Action named “Send Scheduled Exports” checks every hour -if Scheduled Exports have to be executed.

-
-
-

Usage

-

When the configuration of a Scheduled Export is done, their execution -is automatic.

-

Users will receive an email containing a link to download the exported file at -the specified frequency. The attachments stay in the database for 7 days by -default (it can be changed with the system parameter attachment.ttl.

-
-
-

Known issues / Roadmap

+

As normal user, you can run your reports from Report Center

    -
  • We could configure a custom TTL (time-to-live) for each scheduled export
    • +
  • 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. +

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.

+feedback.

Do not contact contributors directly about support or help with technical issues.

-

Credits

+

Credits

-

Authors

+

Authors

    -
  • Camptocamp
    • +
  • Ecosoft
-

Contributors

+

Contributors

-

Maintainers

+

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:

-

guewen

-

This module is part of the OCA/queue project on GitHub.

+

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.