Skip to main content

Central place to run reports live or async

Project description

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page