Scheduled Reporting
Donate to this project
Development Project Status: Completed
This project will enable reports normally run through the Reporting|Reports workspace to be scheduled to run automatically using the Quartz scheduling support.
This will be configured via the Administration|Organisation workspace, using a "Job Configuration: Reporting" configuration archetype.
This will use cron-like syntax to specify the day/time when the job should be run.
It will also include fields to determine how the report will be output, i.e. to:
- file
- printer
File Output
When file output is selected, the following fields specify the location and type of the output file:
- directory
- file type (.csv, .pdf)
- file name. If no extension is provided, the file type determines the extension
If the report template has a File Name Format, this will be used to generate the file name. This can be used to append a date/time to the file name for example.
If the file exists, it will be overwritten.
Print Output
When print output is selected, the following fields specify the printer location:
- location. The practice location. This is constrained to those locations specified by the report document template.
The interactive flag specified by the template's Document Template Printer will be ignored.
Email Output
When email output is selected, the following fields apply:
- from - the from email address. Defaults to the email address of the current user
- to - the email address to mail to. Defaults to the email address of the current user
- file type (.csv, .pdf)
- file name. If no extension is provided, the file type determines the extension
If the report template has a File Name Format, this will be used to generate the file name. This can be used to append a date/time to the file name for example.
Report Parameters
Available report parameters will be determined from the report.
Values for these parameters will be configurable, but the values must be string constants. Up to 5 parameters will be supported.
Dynamic parameter values, evaluated via an expression, can be handled as a separate project.
Permissions
The Run As configuration determines the user that the report is run as. This user must have appropriate permissions to execute the report.
Logging
On completion/failure of the job, a system message will be sent to the Run As user.
JIRA: OVPMS-1964
Comments
Re: Scheduled Reporting
Tim - looks good. Get me a costing and I will get the money. From the above spec, the file names are fixed (ie no file name id format & timestamp). That is perfectly OK by me provided that if the file already exists, it will be overwritten. ie scheduleDG.csv always contains the latest schedule dump.
Regards, Tim G
Re: Scheduled Reporting
Hi,
I would really like to use this feature. I run a lot of reports on a schedule and to have them automatically sent to me would be great.
Could they be emailed rather than printed?
Could I set up multiple scheduled reports on the same report? ie Report: Product Sales emailed to me weekly with the product name %surgery fee% and Report: Product Sales emailed to me fortnightly with the product name %consultation%? I use the information in different ways.
If we get this item to fully funded, would it be able to be included in 2.0?
Greta
Re: Scheduled Reporting
I've updated the spec to include email support.
You can define multiple schedules for the same report, each with different parameters, so your scenario is supported.
If funded, it likely won't make it into 1.9 which is due in August, so would be available in the subsequent release (1.10 or 2.0)
Re: Scheduled Reporting
That is awesome Tim. Thank you for doing it all so quickly.
My boss is away at the moment, so I can't donate to this project until he gets back. I'm sure he will though.
Greta
Re: Scheduled Reporting
We've donated 50%
Re: Scheduled Reporting
Thanks for starting the funding off for this project Greta and Sam.
Re: Scheduled Reporting
This has now been fully funded thanks to one of our generous members.