{date-filter}
Plugin: Reporting Plugin, from version 1.0
This filter will ensure that the specified 'prefix:key' value is a date, and that it matches the required criteria.
Description
This macro must be used in a reporter macro.
Usage
{date-filter:prefix:key|minValue=[date]|maxValue=[date]|format=[date format]|required=true/false}
Parameters
| Name | Required | Default | Description |
|---|---|---|---|
| [default]/key |  | The key chain value to filter on. | |
| minValue |  | This can either be a specific date, or a time period. If specified, the date being filtered must be greater than or equal to the specified date. If it is a specific date, it should also match the 'format' parameter, syntactically. If a time period is specified it will be relative to the current date/time. E.g. "-2m 6d" is "2 months and 6 days into the past". "2y 3w" is "2 years and 3 weeks into the future". | |
| maxValue | | This can be either a specific date, or a time period. If specified, the date must be less than or equal to the specified date value. If it is a specific date, it should match the 'format' parameter, syntactically. If a time period is specified it will be relative to the current date/time. E.g. "-2m 6d" is "2 months and 6 days into the past". "2y 3w" is "2 years and 3 weeks into the future". | |
| format | | If either minValue or maxValue are set to specific dates, this parameter must also be specified to inform the filter of the date format used in those parameters. It is ignored if a relative date ("-5d") is being used. This is a standard date format. E.g. "dd MMM, yyyy". | |
| required | | false
| If set to 'true', the key value must have a value of some sort - it may not be empty. |
Discussions