...
| Table of Contents |
|---|
Business Hours Reporting
| Info |
|---|
Some parts of the GUI refer to this feature as 'From Hours' and 'To Hours'. |
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.
...
| 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 |
Business Days Reporting
In opReports versions 3.0.8 and above you may also specify the desired Business Days, independent of any Business Hour selection. This is done using the opreports-cli parameter exclude (or the identically named schedule property). The value of this parameter must be day1-day2, with each day given in its 3-letter abbreviation, e.g. fri-sun.
All days between and including the two listed days will be excluded from the report. The week sorts Monday to Sunday and wraps: exclude=sun-mon covers Sunday and Monday, exclude=sat-tue covers Saturday, Sunday, Monday and Tuesday, exclude=tue-thu covers Tuesday, Wednesday and Thursday and exclude=mon-sun would exclude the whole week.
If necessary the exclude parameter can be used repeatedly and the exclusions will be joined.
Please note that in opReports versions before 3.1.4 only certain reports supported business days filtering.
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.
...