Telerik blogs

What does Telerik Embedded Web Report Designer do? Everything you need to build the reports you need in your applications. Here’s how.

The Progress Telerik Web Report Designer lets you embed reports inside a web-based application, without leaving the application where you’ll use that report.

A screenshot of the Web Report Designer. On the left is a panel with two tabs labelled Components and Explorer. Explorer tab is displayed showing a TreeView with multiple nodes. In the middle is a rectangular area divided into three horizontal sections. On the right is another panel divided into multiple sections with headings, dropdown lists and textboxes. Many of the sections in the panel have arrows, indicating they can be expanded.

Starting Your Report

The application developer will provide a way for you to open the Report Designer from your application. Once you’ve opened the designer you can modify an existing report that’s associated with the application or create a new report.

To start a new report, click on the hamburger menu in the upper left corner of the Report Designer (it’s labeled “Menu”), click the New Report menu choice, give your report a name in the Create a Report dialog and click the dialog’s Save button.

The report designer, with the Menu box in the top left corner selected and showing the menu dropped down with the menu’s choices. The New choice is selected.

To get to all the reports associated with your application, open the hamburger menu in the upper left corner of the report designer (the one labeled “Menu”) and select Assets Manager. Assets Manager will open, displaying a treeview on the left and a set of graphics on the right—both show the folders that your resources are organized into. Now, just drill down through the Reports folder to see all the reports associated with your application.

A composite graphic showing the designer hamburger menu with the Assets Manager choice highlighted. To the right of the screenshot of the menu is a screenshot of Assets Manager. The treeview on the left shows Recently User, Reports, Resources, and Shared Data Sources. On the right, those entries are repeated with graphics (e.g. a clock icon for the Recently User folder and folder icons for the other three entries)

If you want to pick up and carry on with a report you worked with earlier, just click the dropdown button by the name of the currently displayed report to get a list of recent reports.

The top left corner of the report designer menu. The Menu button is still visible but to its right is the name of a report. On the right of the report name is a dropdown arrow (this arrow is circled), A dropdown list showing two report names is displayed below the report name.

Whichever method you pick, once you’ve found the report you want to modify, just click on it to open it in the designer (if you used Asset Manager, you can close Asset Manager by clicking the X to the right of the Asset Manager label in the upper left corner).

For more on creating a report, see Creating Your Own Reports in Your Applications: Getting Started with the Telerik Web Report Designer.

Getting to Data

The developer who created your application will have set up one or more data sources for you to use in your report. To see those data sources, click on the Explorer tab in the panel on the left of the main designer window, just below the hamburger menu.

The top of the panel on the left side of the data source, showing two tabs. The right hand tab marked Explorer is selected (and circled). The tab shows a TreeView with the node named Shared Data Sources selected

The Shared Data Sources node from the TreeView showing the three dots to its right inside a circle. A single menu choice is displayed below it to its right that says Add Existing Shared Data Source.

In that tab, find the Shared Data Sources Option and click on the three dots to its right to show the Add the Existing Shared Data Source menu choice. That will give you a display of the data sources available for you to use (you can also create a new data source if you need to).

A new dialog labelled Browse for Folder. A panel on the left shows a single, selected choice named Shared Data Sources. The main area on the right shows two document icons labelled Northwind All Tables.sdsx and Northwind.sdsx. One of the document icons has been selected. In the bottom right corner of the dialog there are Save and Cancel buttons.

Once you’ve selected your data source, it will be added to the Shared Data Sources node in the Explorer tab.

The Explorer tab again. However, a new node has been added under the Shared Data Sources node. The new node is named Northwind All Tables1. Below it is a list of column/field names from tables in the Northwind database.

For more on creating a report, see Getting Started with Web Report Designer.

Adding Data and Headings

By default, your report page is divided into a header, a detail and a footer section. The detail section is the one you’ll use most because it’s repeated once for each row in your report. You can add fields from your data source to any of those sections, just by dragging a field from your data source in the designer’s Explorer tab and into one of your report’s sections.

A graphic of the Explorer TreeView on the left with a field named ProductName under the Northwind All Tables node highlight. A curved line leads from it to the right, up to a floating box containing the text ProductName and down to the middle section of the report area where a TextBox containing =[Fields.ProductName] appears in the report.

The report designer will create an appropriate control in the report to display your field’s data, based on the data type of the field (e.g., the designer will create a TextBox to display a text field or a PictureBox to display an image field).

A screenshot of the main window. The middle, detail section has had several fields added to it: A PictureBox with no label and three textboxes with the names of fields. The PictureBox is selected. On the right is the panel displaying information about the currently selected PictureBox.

Once you’ve added a control to your report, you can use the control’s properties (displayed in a panel on the right of the designer window) to set how your data is displayed.

For more on adding data to your report (including adding calculated fields and formatting the display) see Adding Data and Text to Your Report in the Telerik Web Report Designer.

Adding Group Headers and Subtotals

You can also group the data in your report both to help you find what you want and to calculate group subtotals. When you select a field to group your data, the report will automatically sort your data by that field and add a group header and footer for the group.

To identify your grouping field, first select the name of your report at the top the of Explorer tab.

The top of the Explorer tab in the panel on the right side of the report designer. The top item in the panel (ProductsByCategory) has been selected and circled.

Then switch to the panel to the right of the designer and expand the Data section.

The Properties panel from the right side of the report designer. The dropdown arrow beside the Data property has been expanded (and circled). In the expanded area, the Groups property has been circled. To its right the plus sign for the Groups property has also been circled.

Now click on the plus sign to the right of Groups header to display an Add New Item Dialog.

The Add New Item dialog with the Groupings section circled. The plus sign to the right of the Groupings section has also been circled

In this Add New item dialog, click on the plus sign to right of Groupings property to display another Add New Item dialog.

A simpler Add New Item dialog with a textbox labelled Expression at the top. To the right of the textbox are three dots which have been circled.

Click on the three dots to display the Edit Expression dialog and select your grouping field by double clicking on the field you want to use to group your data.

The Edit Expression dialog. In the list in the lower right, the Fields item has been selected. In the list in bottom middle the CategoryName field has been selected. The large textbox at the top of the dialog contains the text = Fields.CategoryName.

When you save your changes and return to your report, you’ll find a group header and footer added to your report.

A report showing two new sections added above and below the details section with the data fields. The section above the details section has been labelled ‘Group Header’ and the section below the Details section has been labelled ‘Group Footer’.

To add a label to your group header to display the group field’s value when the group changes, first drag a TextBox from the Components tab to the left of the designer window onto your group header.

Then, in the panel on the right, expand the Appearance section and click on the three dots to the right of the Value property to get to open the Edit Value dialog. In the Fields section of that dialog, double-click on the field you want to display in your TextBox.

A report with a group header and footer sections above and below the details section. A TextBox has been added to the group header. On the right side, in the properties panel, the Appearance section has been expanded to reveal the Value property (the dropdown arrow to the left of the Appearance section has been circled). The Value property, including the three dots to its right has also been circled.

To add a subtotal to your group footer, drag a TextBox from the Components tab to the group footer. In the panel on the right, expand the Appearances section and click on the three dots beside the Value textbox. In the fx Functions section of the resulting Edit Value dialog, double-click on one of the aggregation function (e.g., Sum or Average) and then, from the Fields section, double-click on the field you want to use in your subtotal.

The Edit Value dialog. In the list in the lower right, the fx Functions item has been expanded to display a list of categories. In that list, the Aggregates category has been selected. In the list in the middle bottom, a list of functions has been displayed. The box on the lower right shows that, in the list of aggregate functions, the Sum function has been selected. The large textbox at the top of the dialog contains the text = Sum()

For more on working with grouping see Adding Group Headers and Subtotals with the Embedded Web Report Designer.

Managing Your Data

You can also control what data is included in your report by adding a filter. You can use the filter to select the data in your report when you create it or to filter data while viewing your report.

To add a filter, first select your report at the top of the Explorer tab.

The top part of the panel on the right of the designer that’s displayed when the user selects the top line in the Explorer tab. The dropdown arrow to the left of the Data section has been circled and the section is expanded to reveal the Filter property (which is also circled). At the right end of the filter property is a plus sign which is also circled.

In the panel on the right, expand the Data section to show the Filters section. Click on the plus by the Filters property to display the Add New Item dialog and click on the three dots by the Display textbox.

The Add New Item dialog which has three entry components labeled Expression (a textbox), Operator (a dropdown list), and Value (a textbox). There are three dots to the right of both the Expression and Value textboxes

In the resulting Edit Expression dialog, click on the Fields item and then double-click on the field you want to use to filter your data. Click on the Save button to close this dialog.

The Edit Expression dialog. In the list on the lower right, the Fields item has been selected. In the list in the bottom middle, the UnitPrice field has been selected. The large textbox at the top, holds = Field.UnitPrice.

Back in the Add New Item dialog, select an operator from the Operator dropdown list and set a value in the Value textbox to finish creating your filter. The data in your report will now be filtered according to your filter’s settings.

The Add New Item dialog again. This time the Expression textbox contains = Field.UnitPrice, the Operator dropdown list has been set to GreaterThan, and the Value textbox has been set to 5.

You can also dynamically filter the data in your report while viewing the report by adding a parameter. Again, in the Explorer tab, select your report and, in the panel on the right, expand the Data section.

The top part of the panel on the right side of the designer. The dropdown arrow beside the Data section has been circled and the section expanded. Further down, the Report Parameters property has been circled. On the right of the property is a plus sign which is also circled.

Now click the plus sign to the right of the Report Parameters property to display its Add New Item dialog. In the dialog, set the Text property to something that describes the parameter, set the Type dropdown list to the type of data you’ll be using in your filter, set the Value property to some initial value, and check the Visible checkbox to have your parameter displayed when viewing your report.

The Add New Item dialog again, scrolled down to show the final entry. The Text textbox contains Unit Price; the Type dropdown list is set to Integer; The Value textbox has 5 in it; The Visible checkbox has been checked.

The final step is to modify a filter to use a report parameter. In the panel on the right, expand the Data section to reveal the Filters property, then expand the Filters property and double click the filter you want to modify. Click on the three dots to the right of the Value property and, in the Edit Expression dialog, click on the Report Parameters list to see the parameters you’ve created. There are two entries for every parameter—double-click on the value entry for the report parameter you want your filter to use to select that parameter.

The Edit Expression dialog. In the lower right list, the Report Parameters item has been selected. The list in the lower middle shows reportParameter1.Value and reportParameter2.Label. The box textbox on the lower right shows that reportParameter1.Value has been selected. The large textbox at the top of the dialog contains = Parameters.reportParameter1.Value.

Now, when you’re viewing your report, you’ll get a list of parameters on the right side of your report that you can use to dynamically filter the data displayed.

For more on working with filters see Filtering Your Report’s Data at Design Time and Run Time with the Embedded Web Report Designer.

Charts

To add one or more charts to your report, switch to the Components tab on the left of your designer and drag one of the charts into the details section of your report. This will start the chart configuration wizard that will let you select the chart’s data source, both of the values to be used to generate the graph, how you want any values to be summarized, and even the categories for grouping your data.

The report designer showing one section and the panels on both sides. In the panel on the left, the components tab is selected, and the Charts section is displayed. A curved line shows that the bar graph (represented by an icon floating over the designer) is being dragged onto the section in the designer. On the right, the properties window is showing a panel titled Configure Bar Chart.

You can add as many charts as you need to support making decisions in your application (sometimes you just need a lot of charts).

A column graph with multiple bars, color-coded to a list of products in a legend on the right. Across the bottom of the chart are the names of the categories that products are grouped by (e.g. Beverages, Condiments, Confections, etc.) with a marker on the X axis showing the start and end of each category.

The charts you add are also integrated with the rest of the report designer’s functionality. For example, you can use the Report Designer’s filters and parameters to let you pick the data you want to display in the chart while you’re viewing your report.

For more on adding charts, see Adding Charts to Reports in the Embedded Web Report Designer.

There’s lots more that you can do with the Embedded Web Report Designer, of course, but these are the basics for creating report you need with the information you want, embedded in the application where you need it. In other words: Everything you need to get started in creating your ideal report.

Embedded Reporting?

Progress Telerik Reporting provides all the tools you need to embed the rich, interactive reports your users need in order to analyze and understand their data right into your users’ applications (including letting your users export the results into more than 15 formats, either to distribute or integrate with other analysis tools). Telerik Reporting then lets you go further and empower your users with a fully functional Web Report Designer to create the reports they want without ever leaving the applications where they’ll use their reports.

You can leverage these easy-to-use tools in both any client-side web application environment (HTML5/JS, Angular, React, Vue or Blazor) and any .NET application (web or desktop: ASP.NET Core, ASP.NET MVC, ASP.NET AJAX, WinForms and UWP).

If you still have not tried it, you can start a free trial to take a closer look. A renowned support service and an array of resources will help you along the way.


Peter Vogel
About the Author

Peter Vogel

Peter Vogel is a system architect and principal in PH&V Information Services. PH&V provides full-stack consulting from UX design through object modeling to database design. Peter also writes courses and teaches for Learning Tree International.

Related Posts

Comments

Comments are disabled in preview mode.