audrius/reporting-engine
1
0
Fork 1
mirror of https://github.com/OCA/reporting-engine.git synced 2025-02-16 16:30:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

[IMP] report_async: pre-commit auto fixes

Browse Source
This commit is contained in:
Sakthivel
2024-05-10 13:32:07 +05:30
committed by Atchuthan, Sodexis
parent ae6b4cc924
commit 21310d51a7
12 changed files with 133 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
report_async/readme/CONTRIBUTORS.md Normal file
View File

@@ -0,0 +1,7 @@
- [Ecosoft](http://ecosoft.co.th):
- Kitti U. \<<kittiu@ecosoft.co.th>\>
- Saran Lim. \<<saranl@ecosoft.co.th>\>
- Tharathip Chaweewongphan \<<tharathipc@ecosoft.co.th>\>
- Opensourceintegrators
- Daniel Reis \<<dreis@opensourceintegrators.com>\>
- Nikul Chaudhary \<<nchaudhary@opensourceintegrators.com>\>

10
report_async/readme/CONTRIBUTORS.rst
View File

@@ -1,10 +0,0 @@
* `Ecosoft <http://ecosoft.co.th>`__:
* Kitti U. <kittiu@ecosoft.co.th>
* Saran Lim. <saranl@ecosoft.co.th>
* Tharathip Chaweewongphan <tharathipc@ecosoft.co.th>
* Opensourceintegrators
* Daniel Reis <dreis@opensourceintegrators.com>
* Nikul Chaudhary <nchaudhary@opensourceintegrators.com>

18
report_async/readme/DESCRIPTION.md Normal file
View File

@@ -0,0 +1,18 @@
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.

16
report_async/readme/DESCRIPTION.rst
View File

@@ -1,16 +0,0 @@
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.

31
report_async/readme/USAGE.rst → report_async/readme/USAGE.md
View File

@@ -1,19 +1,26 @@
Menu: Dashboard > Report Center
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.
- **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.
- **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.