opReports 3.0 provides a flexible mechanism for scheduling both recurring and one-off reports.
This page documents the various ways of specifying when a report should be generated, and what time frame it should cover.
Business Hours Reporting
opReports can optionally limit the reporting to inside or outside of configurable business hours. This is set up using the properties from and to, which must be integers and which define the start and end of the time frame you are intested in. If no business hours are given then the default is unrestricted, i.e. from = 0 and to = 24.
If from is larger than to, then the meaning is inverted and the time outside of the given period is reported on.
Here are some examples:
| From | To | Explanation |
|---|---|---|
| 4 | 12 | early morning: from 04:00 to 12:00 noon |
| 9 | 15 | from 09:00 to 15:00 in the afternoon |
| 17 | 24 | evening: from 17:00 to midnight |
| 19 | 5 | late night plus early morning: from 19:00 to midnight and from midnight to 05:00 |
| 0 | 20 | from midnight to 20:00 |
| 18 | 17 | anytime but 17:00 to 18:00, ie. midnight to 17:00, 18:00 to midnight |
Recurring Reports
To define a recurring report schedule you have to provide a frequency property, which defines when the report is to be generated.
The start and end properties are also required, and define the reporting period.
Depending on the frequency, slightly different formats for start and end time of the report period are supported.
| Frequency | Format for Start and End | Explanation | Example |
|---|---|---|---|
| daily | HH:MM:SS HH:MM | 24:00 means the end of the day, and makes sense only as period end. 00:00 means the beginning of the day. Leading zeros can be omitted. | 14:15 23:45 |
| weekly | Wday HH:MM:SS Wday HH:MM | Wday is one of "Mon", "Tue" ... "Sun" (Case-insensitive). Monday is considered first, Sunday last. Start: Sun 14:00, End Wed 17:00 will cover sun, mon, tue, wed; Start: Fri 17:00, End Mon 09:00 will cover fri, sat, sun, mon. | Fri 14:45 |
| monthly | D HH:MM:SS | D is the day of the month, 1..31. -D counts from the end of the month; -1 is the last day of the month, -2 the second to last etc. | 4 17:00 -1 00:00 |
| yearly | M D HH:MM:SS | M is the month number, 1..12. D is the day number, 1..31. | 12 24 19:00 13 31 24:00 |
One-off, non-recurring Reports
For non-recurring reports, the start and end properties must fully describe a date and time for the reporting period.
All the formats described in Supported Time Formats are supported here, but relative formats (e.g. "now - 20 minutes") may lead to unexpected behaviour and should be avoided.
We recommend that you stick to one of the unambiguous formats like "30-mar-2014 16:31:53" or the ISO8601-style "2015-03-30T16:31:53".
Business hours reporting works as described above.