This blog provides show notes for our July 28, 2021, webinar, “Report Parameters – Deep Dive into Dynamic and Interactive Reports”. The webinar was presented by Syncfusion developer Shanmugapriya Ranganathan. A recording of the webinar is embedded below. The Q&A portion of the webinar is provided at the end of this blog.
Introduction to report parameters
A parameter is a placeholder value such as a string, number, boolean, or date that can be dynamically changed when visualizing the paginated reports in Report Viewer.
You can replace any static values as expressions and show them based on conditions without editing the report. When you view a report with parameters, the report viewer allows you to interactively specify values. This helps in What-if analysis and eliminates the static values in order to build dynamic reports.
Difference between filters and report parameters
|Filters are basically configured using a column in a data set, it returns results that satisfy the conditions.||Parameters are configured using static values, expressions or you can bind data from a dataset column|
|It is used to visualize a subset of the data by restricting it to one or more values.||Replaces static or hard-coded values in your report.|
|The filter value cannot be dynamically applied when visualizing the report.||The user can input values dynamically when visualizing the report.|
They are specific to data-region report
items or data sets and cannot be used
anywhere in the report.
|Use in any expressions, data sets, data source, anywhere in your report to replace constant values.|
Types of report parameters
Report Parameters are categorized into various types based on how it’s used.
Populates a list of values from the data set column or query. This is a recommended mechanism in real-time. Here the ProductCategories retrieves values from a dataset column.
Used to provide user inputs at run-time through a textbox, checkbox, or date picker. Here the StartDate allows selecting value from a date picker. The selected value is used in textbox value or in data set query to filter data.
One parameter value is displayed depending on the value selected in another parameter. Changing a value in ProductCategory parameter updates the Product Subcategory values.
Allow users to select multiple values from the parameter list. The Product Subcategory provides a check box option to choose multiple values.
Common uses for report parameters
Some of the most common ways to use parameters are to filter report data, link related reports together, and change report presentation.
Filter report data
- Use parameters in data set queries to filter data before retrieval. After getting all data, based on the selected parameter value you can filter and display it in a table or subreports.
- Add parameter expression in data source to change database connections and in dataset queries to fetch data specific to logged-in users.
- Used in the shared dataset, to return different data for each user by restricting changes in the query.
- Users can input the values to the parameter at runtime to customize the appearance of the paginated report. For example, using the start and end date parameter in query returns sales records between a date range.
Link related reports
- Relate main reports to drill through reports, to subreports by sending parameter values to child reports. Design each report to provide a different view or level of detail for related information.
- Multiple reports can use the same report definition and produces different output by sending parameter values. Uses the same report definition to show different salespersons.
- Add a sub-report item in the main report that invokes the same child report with different parameters to compare two employee information.
Control the report appearance
- Helps you to input values to customize the appearance of a report. For example, add the Boolean parameter to indicate whether to expand or collapse all row groups in a table.
- Used in data query and all properties such as language, text, numeric formats and more, to narrow down report output based on a user choice.
- Used anywhere in your reports such as in conditional format expressions like styles, appearance related properties, queries, expressions, calculated fields, and custom codes to build a more interactive and dynamic paginated report.
- Replaces any constant values in the report to modify the value without editing the report and thus perform a what-if analysis.
You can generate various types of day-to-day interactive business reports using report parameters. This webinar covered the basics of report parameters, and it will be helpful for you to build dynamic and interactive paginated reports. I hope you enjoyed this webinar and that you’ll keep an eye out for future Bold Reports webinars.
Look at our demo samples and documentation site to learn more. If you have any questions, please post them in the comments section. You can also contact us through our contact page or, if you already have an account, you can log in to ask your support question.
Bold Reports offers a 15-day free trial that does not require a credit card. We invite you to sign up and experience Bold Reports for yourself. Give it a try and let us know what you think!
Recommended resources (related links):
Sample : js-report-viewer-app
Q1: Is it possible to change the culture of the date-time parameter?
Yes, changing the locale property allows you to localize the date parameter.(https://help.boldreports.com/report-viewer-sdk/angular-reporting/report-viewer/localization/)
Q2: Is it possible to input values from a custom parameter panel?
Yes, it is possible to hide the Report Viewer’s parameters pane and use your own user interface to get values and pass them to the Report Viewer. (https://help.boldreports.com/report-viewer-sdk/angular-reporting/report-viewer/toolbar-customization/)
Q3: Is it possible to use custom elements for report parameters instead of default ones?
Q4: Can we provide parameter values at runtime?
Q5: Is it possible to have a custom validation message for the runtime selected parameter values?
The viewReportClick event invokes every time when submitting the parameter values after selection. Using that, you can show custom validation messages.