Extract Data Source

• Feb 27, 2023
• 2 minutes to read

This tutorial shows how to add the DashboardExtractDataSource to an in-memory data source storage, and make it available to users.

1. In your application, add the SalesOverview.dat file to the App_Data folder from the C:\Users\Public\Documents\DevExpress Demos 24.2\Components\Data directory.

2. In the dashboard configuration file (for example, DashboardConfig.cs / DashboardConfig.vb), create a public method that returns the configured dashboard’s data source storage (DataSourceInMemoryStorage) and define the Extract Data Source.

   C#

   using DevExpress.DashboardCommon;
   
   public static DataSourceInMemoryStorage CreateDataSourceStorage() {
       DataSourceInMemoryStorage dataSourceStorage = new DataSourceInMemoryStorage();
   
       DashboardExtractDataSource extractDataSource = new DashboardExtractDataSource("Extract Data Source");
       extractDataSource.Name = "Extract Data Source";
       dataSourceStorage.RegisterDataSource("extractDataSource ", extractDataSource.SaveToXml());
   
       return dataSourceStorage;
   }
   

   VB.NET

   Imports DevExpress.DashboardCommon
   
   Public Shared Function CreateDataSourceStorage() As DataSourceInMemoryStorage
       Dim dataSourceStorage As New DataSourceInMemoryStorage()
   
       Dim extractDataSource As New DashboardExtractDataSource("Extract Data Source")
       extractDataSource.Name = "Extract Data Source"
       dataSourceStorage.RegisterDataSource("extractDataSource ", extractDataSource.SaveToXml())
   
       Return dataSourceStorage
   End Function
   

3. Call the DashboardConfigurator.SetDataSourceStorage method to configure the data source storage. Use the created CreateDataSourceStorage method as the SetDataSourceStorage parameter and handle the DashboardConfigurator.ConfigureDataConnection event to pass the connection parameters to the Extract Data Source.

   C#

   using System;
   using DevExpress.DashboardWeb;
   
   public static void RegisterService(RouteCollection routes) {
       routes.MapDashboardRoute("dashboardControl", "DefaultDashboard");
   
       // ...
   
       DashboardConfigurator.Default.SetDataSourceStorage(CreateDataSourceStorage());
   
       DashboardConfigurator.Default.ConfigureDataConnection += Default_ConfigureDataConnection;
   }
   private static void Default_ConfigureDataConnection(object sender, ConfigureDataConnectionWebEventArgs e) {
       if(e.DataSourceName.Contains("Extract Data Source")) {
           ExtractDataSourceConnectionParameters extractParams = new ExtractDataSourceConnectionParameters();
           extractParams.FileName = HostingEnvironment.MapPath(@"~/App_Data/SalesPersonExtract.dat");
           e.ConnectionParameters = extractParams;
       }
   }
   

   VB.NET

   Imports System
   Imports DevExpress.DashboardWeb
   Imports DevExpress.DataAccess.Json
   
   Public Shared Sub RegisterService(ByVal routes As RouteCollection)
       routes.MapDashboardRoute("dashboardControl", "DefaultDashboard")
   
       ' ...
   
       DashboardConfigurator.Default.SetDataSourceStorage(CreateDataSourceStorage())
   
       AddHandler DashboardConfigurator.Default.ConfigureDataConnection, AddressOf Default_ConfigureDataConnection
   End Sub
   Private Shared Sub Default_ConfigureDataConnection(ByVal sender As Object, ByVal e As ConfigureDataConnectionWebEventArgs)
       If e.DataSourceName.Contains("Extract Data Source") Then
           Dim extractParams As New ExtractDataSourceConnectionParameters()
           extractParams.FileName = HostingEnvironment.MapPath("~/App_Data/SalesPersonExtract.dat")
           e.ConnectionParameters = extractParams
       End If
   End Sub
   

The Extract Data Source is now available in the Web Dashboard:

Users can now bind dashboard items to data in the Web Dashboard’s UI.

Example

The example shows how to make a set of data sources available for users in the Web Dashboard application.

View Example: How to Register Data Sources for the ASP.NET MVC Dashboard Extension