Running Reports
All reports run through the reporting module support the following inputs:
- Values for each of the parameters that the Report Definition requires. These values may be either fixed, or may be specified as compatible runtime expressions. Runtime expressions are currently limited to the following:
Name |
Description |
|---|---|
${now} |
The exact date/time that the report actually runs |
${start_of_today} |
The same as ${now}, except with the time set to midnight at the start of the day |
${end_of_today} |
The same as ${now}, except with the time set to the last millisecond of the day |
${start_of_last_month} |
Relative to ${now}, this is midnight on the first day of the preceeding month |
${end_of_last_month} |
Relative to ${now}, this is the last millisecond of the last day of the preceeding month |
${generatedBy} |
The user who requested that the report be run |
${generationDate} |
The date that the report was generated, usually the same as ${now} |
Any of the above expressions that return Dates can also contain date "arithmetic". For example, let's say you have a report that takes in 2 parameters named "startDate" and "endDate". If you want to run a Report that covers the previous week, you could specify: startDate = ${start_of_today-7d} and endDate = ${end_of_today-1d}. The arithmetic supports expressions in the format of either "+" or "-", followed by a number, followed by the units (either d (days), w (weeks), m (months), y (years), h (hours). You can also have multiple expressions together. So, you could have ${now-5d+2w-5m+6h} and this would evaluate to a particular date.