Introduction
When you create a dashboard report, it requires configuration to display data to the user the way you want it to.
This example configures a Customer Oder Dashboard. It starts with an existing created report and applies the following updates:
- Add a pie chart for the top ordered products.
- Add and configure a summary report of orders for each customer.
- Add a header to the dashboard report.
- Apply style formatting to different parts of the report.
Prerequisites
- The dashboard report file must already exist.
- The queries for the report fields must already be configured in the entity.
|
Quick Steps |
| 1 |
Open the report file |
| 2 |
Add a layout |
| 3 |
Enter the layout details, then click OK |
| 4 |
Add a pie chart to the layout |
| 5 |
Enter the details, then click Next |
| 6 |
Click the Add New Series icon |
| 7 |
Enter the details, then click Finish |
| 8 |
Add a summary report to the layout |
| 9 |
Enter the Data Source, then click Next |
| 10 |
Add the Report Fields, then click Finish |
| 11 |
Make the Customer ID a parent group |
| 12 |
Make the Order ID a child group |
| 13 |
Set an aggregate function for total orders per customer |
| 14 |
Set an aggregate function for total amount of each value |
| 15 |
Apply style formatting to the aggregate function for Total Orders |
| 16 |
Apply style formatting to the aggregate function for Total Order Value |
| 17 |
Add a report header to the layout |
| 18 |
Add a heading to the header |
| 19 |
Configure the heading |
| 20 |
Add a heading to the dashboard report header |
| 21 |
Configure the heading |
| 22 |
Save the report |
Detailed Steps
Step 1. Open the report file.
Open the dashboard report file rptCustomerOrderDashboard to do further configurations.
Step 2. Add a layout.
This example uses a layout to configure the report.
Step 3. Enter the layout details, then click OK.
This example's layout will contain three rows and one column.
Step 4. Add a pie chart to the layout.
This example adds a pie chart to the layout's top row to display data in a graphical format.
Step 5. Enter the details, then click Next.
The important chart properties are:
- ID: Programmatic ID of the chart.
- Chart Name: Display name of the chart.
- Query ID: Query the chart is based on. It must exist in the entity before you can enter it here.
- Chart Type: Determines how the chart displays data. This example is a pie chart.
- Width: Width of the chart in pixels.
- Height: Height of the chart in pixels.
The query TopOrderedProducts is configured in entProduct.
Step 6. Click the Add New Series icon.
Step 7. Enter the details, then click Finish.
Enter the X Value Member and Y Value Member to determine how the chart displays the query data.
Step 8. Add a summary report to the layout.
This example adds a summary report to the layout's bottom row.
Step 9. Enter the Data Source, then click Next.
This identifies the query the report is based on. The query comes from the entity and must exist there before it can be used here.
You can manually enter the query or you can use the Browse button to select from your project's available queries.
The query CustomerOrderSummary is configured initially when you create the dashboard report.
Step 10. Add the Report Fields, then click Finish.
Select the fields you want the report to have and click the Add icon to add them to the report file.
Step 11. Make the Customer ID a parent group.
A group organizes a report dataset to provide different views. A parent group is the highest level group among other multiple groups.
To make a field a parent group, select it, click the More icon, and select Parent Group.
Enter the Query Field and click OK.
Step 12. Make the Order ID a child group.
A child group organizes the data that is a level below the parent group.
To make a field a child group, select the parent field, click the More icon, and select Child Group. Enter the Query Field and include the footer. Click OK.
Enter the Query Field and click OK.
Step 13. Set an aggregate function for total orders per customer.
Select the field and click the Set Aggregation icon.
Enter the Summary Field, select the aggregate function, and click OK. Options are:
- Sum: Returns the sum of all values.
- Min: Returns the lowest value.
- Max: Returns the highest value.
- Count: Returns the total number of records.
- Avg: Returns the average value.
- CountDistinct: Returns the total number of unique records.
This option uses the CountDistinct function to display the orders for each customer.
Step 14. Set an aggregate function for total amount of each value.
This example uses the Sum function to display the total amount of orders for each customer.
This option uses the Sum function to display the Total Order Value.
Step 15. Apply style formatting to the aggregate function for Total Orders.
Select the sfwReportAggregate for Total Orders. Open the style editor and configure the text display settings.
Select the Style option from the dropdown list. Open the Typography section. Select the desired style properties and click the Apply Style button.
Step 16. Apply style formatting to the aggregate function for Total Order Value.
Select the sfwReportAggregate for Total Amount. Open the Style Editor tab and select the desired style properties as shown in the above step.
Step 17. Add a report header to the layout.
This example adds a header to the layout's middle row to act as a title for the summary report.
Step 18. Add a heading to the header.
Drag and drop the heading to display the summary report title text.
Step 19. Configure the heading.
Apply any desired style settings and update the caption to the text you want to use.
Step 20. Add a heading to the dashboard report header.
Drag and drop the heading to display the dashboard report title text.
Step 21. Configure the heading.
Similarly, add the desired heading control in the Report Header. Edit the heading caption to give a suitable title for a dashboard report. Also, you can apply the desired style properties from the Style Editor tab.
Step 22. Save the report.
Click the Save icon to save the report file.
Then, run the Preview. You can open the Reports screen and view your report right away.
When you have previewed your report, it should look something like this. The dashboard displays the pie chart and summary report with your formatting and headers. You can either download the report or print it.
What are the improvements over S3 Version 6?
Previously, a report schema .xsd and layout .rdlc was required and it had to be configured before creating a Report. Now, with Xelence, the process to configure the dashboard report is made simple with minimum configurations and various types of reports are available based on the business requirements.
Related Articles
Create a Dashboard Report
This post is part of the Reports topic. Click here to open Reports Overview
This post is also part of Controls and Buttons topic. Click here to open Forms Toolbox Controls
#Xelence
#Reports
#ControlsandButtons