Report Date Parameter

Last modified: August 20, 2024

Introduction

A Report date parameter allows the end-user to specify a Date and time parameter for the data set that supplies the data for a Report grid. The parameter is used to filter the results in different ways so that the same report can display different sets of data.

For example, a report may show order data for a customer over a selected period, and the report date parameter can be used to specify which period should be selected.

You can add more fields to a report date parameter widget to make it easier for an end-user to select a date range. See Additional Report Date Parameter Fields, below, for more information.

The report date parameter is displayed in Structure mode with the data set parameter name shown between square brackets and colored blue. The From and To dates shown in blue are examples to indicate that these are date fields.

If you have a report date parameter widget on the page, you must also add a Report Button widget so that it is possible for the end-user to regenerate the report after specifying the parameter.

Report Date Parameter Properties

An example of report date parameter properties is represented in the image below:

Report date parameter properties consist of the following sections:

Common
Design Properties
General

Common Section

For more information on properties in this section, see the Common Section section in Properties Common in the Page Editor.

Design Properties Section

The Design Properties allow you to change spacing and alignment of the widget and hide it on phone, tablet, or desktop, if needed. Design properties may vary depending on the type of the widget. For example, for the text widget you can change its font weight, color, alignment, and letter case.

General Section

Parameter

Parameter is set to a data set parameter of type Date and time, the value of which is restricted by this widget. The corresponding data set must be used by one of the report widgets on the page.

Fields Per Row

Fields per row specifies how many date range fields can be placed beside each other in a row. There are always two rows available for data range fields. See Additional Report Date Parameter Fields, below, for more information.

From Caption

From specifies the text that is displayed against the from date selector, where the end-user can choose the start of the period for which data should be shown in the report.

To Caption

To specifies the text that is displayed against the to date selector, where the end-user can choose the end of the period for which data should be shown in the report.

Show From/To

Set Show from/to to Yes if the from and to field results should be shown on the report page.

Set this to No if the from and to field results should not be shown. In this case, the filter must be set using date range fields added to the report date parameter.

Min. Year

Min. year is the earliest year that the end-user can choose in the Year date range field.

The value in Min. year will not prevent an end-user from choosing an earlier date in the From or To fields of the report date parameter widget. It only applies to the year date range field.

Max. year

Max. year is the latest year that the end-user can choose in the Year date range field.

The value in Max. year will not prevent an end-user from choosing a later date in the From or To fields of the report date parameter widget. It only applies to the year date range field.

Additional Report Date Parameter Fields

You can add extra fields to allow the end-user to easily select date ranges without needing to enter both the From and To dates. For more information, see Date Range Field.