Lesson 9: Creating a Parameter-Based Report
In Lesson 1 of this track, we created a page report that contains an order list report tab to show order lists of every month from 2015 to 2016. Now, the sales manager is asking for this same report but with different orders during a specified time. Instead of building a new report about orders in each order date, we can save the page report as a new one and then modify the dataset used by its report to meet the requirements.
Follow the tasks below to finish creating the report:
- Task 1: Create the Parameters
- Task 2: Modify the Report Dataset to Use Parameters
- Task 3: Preview and Test the Report
- In Designer, select File > Open to open the report OrderListbyDate.cls we have created in Lesson 1 in the JinfonetGourmetJava.cat catalog file.
- Select File > Save As to save the report as OrderListbyDate_Parameter.cls. Then we begin to modify this report instead of the former one.
- In the Data panel, select <New Parameter...> in the Parameters node.
- In the New Parameter dialog box, type pStartDate in the Name text box, keep the default Value Setting, select Date from the Value Type drop-down list, select Add to add a value row in the Value List box and type May 1, 2016 as the prompting value, and then type Please input start date: as the prompting text. Select OK to create the parameter.
- Repeat steps 3 to 4 to create another parameter with the following values:
- Parameter Name: pEndDate
- Value Setting: Type-in Parameter
- Value Type: Date
- Prompting Values: June 1, 2016
- Prompting Text: Please input end date:
In this task, we apply the parameters created above to filter the dataset the report applies. Then when we view the report, we can specify different parameter values to dynamically filter the report to get data in the time period we want.
- In the Data panel, select Dataset Filter on the toolbar.
- In the Dataset Filter dialog box, select Add Condition to add a filter line, select ORDER DATE from the field drop-down list, set >= as the operator, then select the ellipsis.
- In the Expressions dialog box, double-click the pStartDate parameter to use it as value of the filter condition.
Then close the Expressions dialog box.
- Select Add Condition to add another filter line. The relationship between the two filters is "And".
- Specify condition of the newly added filter as follows:
- Select OK to apply the settings.
You can also use parameters to filter queries to limit their data. However, in this task, we cannot set the filter on the report's query. If we do that, all datasets based on the query will be affected, meaning, Designer also applies the filter to the report that we created in Lesson 1.
After the steps above, users of this report can specify any date to get orders with the time they need by specifying the parameter values dynamically.
- Save the report and select the View tab to preview the report.
Designer recognizes that the query is based on the value of two parameters, and therefore prompts for them as follows:
- Specify the start date and end date in the combo boxes or select the calendar to select the date.
- Select Default to generate the report output based on the default values for the parameters. Designer displays the report as follows, which shows information for orders from May 1, 2016 8:00:00 AM to June 1, 2016 8:00:00 AM only.
If the report does not look correct, you can compare it to the final version of the report included in Designer. To do this, save and close your current catalog, and then open the JinfonetGourmetJava.cat catalog file in